blob: 00a00e9a2806d4ce4c69317a64731fba2b4f9a4c [file] [log] [blame]
// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_SYSTEM_MEDIA_CONTROLS_LINUX_SYSTEM_MEDIA_CONTROLS_LINUX_H_
#define COMPONENTS_SYSTEM_MEDIA_CONTROLS_LINUX_SYSTEM_MEDIA_CONTROLS_LINUX_H_
#include <string>
#include "base/component_export.h"
#include "base/containers/flat_map.h"
#include "base/containers/flat_set.h"
#include "base/memory/scoped_refptr.h"
#include "base/observer_list.h"
#include "base/timer/timer.h"
#include "components/dbus/properties/types.h"
#include "components/system_media_controls/system_media_controls.h"
#include "dbus/bus.h"
#include "dbus/exported_object.h"
class DbusProperties;
namespace dbus {
class MethodCall;
} // namespace dbus
namespace system_media_controls {
class SystemMediaControlsObserver;
namespace internal {
COMPONENT_EXPORT(SYSTEM_MEDIA_CONTROLS)
extern const char kMprisAPIServiceNamePrefix[];
COMPONENT_EXPORT(SYSTEM_MEDIA_CONTROLS) extern const char kMprisAPIObjectPath[];
COMPONENT_EXPORT(SYSTEM_MEDIA_CONTROLS)
extern const char kMprisAPIInterfaceName[];
COMPONENT_EXPORT(SYSTEM_MEDIA_CONTROLS)
extern const char kMprisAPIPlayerInterfaceName[];
// A D-Bus service conforming to the MPRIS spec:
// https://specifications.freedesktop.org/mpris-spec/latest/
class COMPONENT_EXPORT(SYSTEM_MEDIA_CONTROLS) SystemMediaControlsLinux
: public SystemMediaControls {
public:
SystemMediaControlsLinux();
~SystemMediaControlsLinux() override;
static SystemMediaControlsLinux* GetInstance();
// Starts the DBus service.
void StartService();
// SystemMediaControls implementation.
void AddObserver(SystemMediaControlsObserver* observer) override;
void RemoveObserver(SystemMediaControlsObserver* observer) override;
void SetEnabled(bool enabled) override {}
void SetIsNextEnabled(bool value) override;
void SetIsPreviousEnabled(bool value) override;
void SetIsPlayPauseEnabled(bool value) override;
void SetIsStopEnabled(bool value) override {}
void SetPlaybackStatus(PlaybackStatus value) override;
void SetTitle(const base::string16& value) override;
void SetArtist(const base::string16& value) override;
void SetAlbum(const base::string16& value) override;
void SetThumbnail(const SkBitmap& bitmap) override {}
void ClearThumbnail() override {}
void ClearMetadata() override;
void UpdateDisplay() override {}
// Returns the generated service name.
std::string GetServiceName() const;
// Used for testing with a mock DBus Bus.
void SetBusForTesting(scoped_refptr<dbus::Bus> bus) { bus_ = bus; }
private:
void InitializeProperties();
void InitializeDbusInterface();
void OnExported(const std::string& interface_name,
const std::string& method_name,
bool success);
void OnInitialized(bool success);
void OnOwnership(const std::string& service_name, bool success);
// org.mpris.MediaPlayer2.Player interface.
void Next(dbus::MethodCall* method_call,
dbus::ExportedObject::ResponseSender response_sender);
void Previous(dbus::MethodCall* method_call,
dbus::ExportedObject::ResponseSender response_sender);
void Pause(dbus::MethodCall* method_call,
dbus::ExportedObject::ResponseSender response_sender);
void PlayPause(dbus::MethodCall* method_call,
dbus::ExportedObject::ResponseSender response_sender);
void Stop(dbus::MethodCall* method_call,
dbus::ExportedObject::ResponseSender response_sender);
void Play(dbus::MethodCall* method_call,
dbus::ExportedObject::ResponseSender response_sender);
// Used for API methods we don't support.
void DoNothing(dbus::MethodCall* method_call,
dbus::ExportedObject::ResponseSender response_sender);
// Sets a value on the Metadata property map and sends a PropertiesChanged
// signal if necessary.
void SetMetadataPropertyInternal(const std::string& property_name,
DbusVariant&& new_value);
std::unique_ptr<DbusProperties> properties_;
scoped_refptr<dbus::Bus> bus_;
dbus::ExportedObject* exported_object_;
// The generated service name given to |bus_| when requesting ownership.
const std::string service_name_;
base::RepeatingCallback<void(bool)> barrier_;
// True if we have started creating the DBus service.
bool started_ = false;
// True if we have finished creating the DBus service and received ownership.
bool service_ready_ = false;
base::ObserverList<SystemMediaControlsObserver> observers_;
DISALLOW_COPY_AND_ASSIGN(SystemMediaControlsLinux);
};
} // namespace internal
} // namespace system_media_controls
#endif // COMPONENTS_SYSTEM_MEDIA_CONTROLS_LINUX_SYSTEM_MEDIA_CONTROLS_LINUX_H_