Split into separate libraries

src/player/CMakeLists.txt

@@ -0,0 +1,42 @@
+set(PLAYER_SOURCES
+  playerinterface.cpp
+  player.cpp
+)
+
+set(PLAYER_HEADERS
+  playerinterface.h
+  player.h
+)
+
+qt_wrap_cpp(PLAYER_SOURCES ${PLAYER_HEADERS})
+
+add_library(strawberry_player STATIC ${PLAYER_SOURCES})
+
+target_include_directories(strawberry_player PRIVATE
+  ${CMAKE_CURRENT_SOURCE_DIR}
+  ${CMAKE_CURRENT_BINARY_DIR}
+  ${CMAKE_SOURCE_DIR}/src
+  ${CMAKE_BINARY_DIR}/src
+)
+
+target_link_libraries(strawberry_player PRIVATE
+  PkgConfig::GLIB
+  PkgConfig::GOBJECT
+  PkgConfig::GSTREAMER
+  PkgConfig::GSTREAMER_BASE
+  PkgConfig::GSTREAMER_AUDIO
+  PkgConfig::GSTREAMER_APP
+  PkgConfig::GSTREAMER_TAG
+  PkgConfig::GSTREAMER_PBUTILS
+  Qt${QT_VERSION_MAJOR}::Core
+  Qt${QT_VERSION_MAJOR}::Network
+  Qt${QT_VERSION_MAJOR}::Sql
+  Qt${QT_VERSION_MAJOR}::Gui
+  Qt${QT_VERSION_MAJOR}::Widgets
+  strawberry_core
+  strawberry_engine
+  strawberry_collection
+  strawberry_playlist
+  strawberry_equalizer
+  strawberry_analyzer
+)

src/player/player.h

@@ -0,0 +1,172 @@
+/*
+ * Strawberry Music Player
+ * This file was part of Clementine.
+ * Copyright 2010, David Sansome <me@davidsansome.com>
+ * Copyright 2018-2021, Jonas Kvinge <jonas@jkvinge.net>
+ *
+ * Strawberry is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Strawberry is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Strawberry.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef PLAYER_H
+#define PLAYER_H
+
+#include "config.h"
+
+#include <QtGlobal>
+#include <QObject>
+#include <QMap>
+#include <QDateTime>
+#include <QString>
+#include <QUrl>
+
+#include "includes/shared_ptr.h"
+#include "core/urlhandler.h"
+#include "core/enginemetadata.h"
+#include "engine/enginebase.h"
+#include "playlist/playlist.h"
+#include "playlist/playlistitem.h"
+#include "constants/behavioursettings.h"
+#include "playerinterface.h"
+
+class QTimer;
+class Song;
+class TaskManager;
+class UrlHandlers;
+class PlaylistManager;
+class AnalyzerContainer;
+class Equalizer;
+
+class Player : public PlayerInterface {
+  Q_OBJECT
+
+ public:
+  explicit Player(const SharedPtr<TaskManager> task_manager, const SharedPtr<UrlHandlers> url_handlers, const SharedPtr<PlaylistManager> playlist_manager, QObject *parent = nullptr);
+
+  void Init();
+
+  SharedPtr<EngineBase> engine() const override { return engine_; }
+  EngineBase::State GetState() const override { return last_state_; }
+  uint GetVolume() const override;
+
+  PlaylistItemPtr GetCurrentItem() const override { return current_item_; }
+  PlaylistItemPtr GetItemAt(const int pos) const override;
+
+  bool PreviousWouldRestartTrack() const;
+
+  void SetAnalyzer(AnalyzerContainer *analyzer) { analyzer_ = analyzer; }
+  void SetEqualizer(SharedPtr<Equalizer> equalizer) { equalizer_ = equalizer; }
+
+ public Q_SLOTS:
+  void ReloadSettings() override;
+
+  void LoadVolume() override;
+  void SaveVolume() override;
+  void SavePlaybackStatus() override;
+  void PlaylistsLoaded() override;
+
+  void PlayAt(const int index, const bool pause, const quint64 offset_nanosec, EngineBase::TrackChangeFlags change, const Playlist::AutoScroll autoscroll, const bool reshuffle, const bool force_inform = false) override;
+  void PlayPause(const quint64 offset_nanosec = 0, const Playlist::AutoScroll autoscroll = Playlist::AutoScroll::Always) override;
+  void PlayPauseHelper() override { PlayPause(play_offset_nanosec_); }
+  void RestartOrPrevious() override;
+  void Next() override;
+  void Previous() override;
+  void PlayPlaylist(const QString &playlist_name) override;
+  void SetVolumeFromSlider(const int value) override;
+  void SetVolumeFromEngine(const uint volume) override;
+  void SetVolume(const uint volume) override;
+  void VolumeUp() override;
+  void VolumeDown() override;
+  void SeekTo(const quint64 seconds) override;
+  void SeekForward() override;
+  void SeekBackward() override;
+
+  void CurrentMetadataChanged(const Song &metadata) override;
+
+  void Mute() override;
+  void Pause() override;
+  void Stop(const bool stop_after = false) override;
+  void StopAfterCurrent();
+  void Play(const quint64 offset_nanosec = 0) override;
+  void PlayWithPause(const quint64 offset_nanosec) override;
+  void PlayHelper() override { Play(); }
+  void ShowOSD() override;
+  void TogglePrettyOSD();
+
+  void HandleAuthentication();
+
+ private Q_SLOTS:
+  void UrlHandlerRegistered(UrlHandler *url_handler) const;
+
+  void EngineStateChanged(const EngineBase::State);
+  void EngineMetadataReceived(const EngineMetadata &engine_metadata);
+  void TrackAboutToEnd();
+  void TrackEnded();
+  // Play the next item on the playlist - disregarding radio stations like last.fm that might have more tracks.
+  void NextItem(const EngineBase::TrackChangeFlags change, const Playlist::AutoScroll autoscroll);
+  void PreviousItem(const EngineBase::TrackChangeFlags change);
+
+  void NextInternal(const EngineBase::TrackChangeFlags, const Playlist::AutoScroll autoscroll);
+  void PlayPlaylistInternal(const EngineBase::TrackChangeFlags, const Playlist::AutoScroll autoscroll, const QString &playlist_name);
+
+  void FatalError();
+  void ValidSongRequested(const QUrl&);
+  void InvalidSongRequested(const QUrl&);
+
+  void HandleLoadResult(const UrlHandler::LoadResult &result);
+
+ private:
+  void ResumePlayback();
+
+  // Returns true if we were supposed to stop after this track.
+  bool HandleStopAfter(const Playlist::AutoScroll autoscroll);
+
+  void UnPause();
+
+ private:
+  const SharedPtr<TaskManager> task_manager_;
+  const SharedPtr<UrlHandlers> url_handlers_;
+  const SharedPtr<PlaylistManager> playlist_manager_;
+  SharedPtr<EngineBase> engine_;
+  AnalyzerContainer *analyzer_;
+  SharedPtr<Equalizer> equalizer_;
+  QTimer *timer_save_volume_;
+
+  bool playlists_loaded_;
+  bool play_requested_;
+
+  PlaylistItemPtr current_item_;
+
+  bool pause_;
+  EngineBase::TrackChangeFlags stream_change_type_;
+  Playlist::AutoScroll autoscroll_;
+  EngineBase::State last_state_;
+  int nb_errors_received_;
+
+  QList<QUrl> loading_async_;
+  uint volume_;
+  uint volume_before_mute_;
+  QDateTime last_pressed_previous_;
+
+  bool continue_on_error_;
+  bool greyout_;
+  BehaviourSettings::PreviousBehaviour menu_previousmode_;
+  int seek_step_sec_;
+  uint volume_increment_;
+
+  QDateTime pause_time_;
+  quint64 play_offset_nanosec_;
+};
+
+#endif  // PLAYER_H

src/player/playerinterface.cpp

@@ -0,0 +1,24 @@
+/*
+ * Strawberry Music Player
+ * This file was part of Clementine.
+ * Copyright 2010, David Sansome <me@davidsansome.com>
+ * Copyright 2018-2021, Jonas Kvinge <jonas@jkvinge.net>
+ *
+ * Strawberry is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Strawberry is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Strawberry.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include "playerinterface.h"
+
+PlayerInterface::PlayerInterface(QObject *parent) : QObject(parent) {}

src/player/playerinterface.h

@@ -0,0 +1,117 @@
+/*
+ * Strawberry Music Player
+ * This file was part of Clementine.
+ * Copyright 2010, David Sansome <me@davidsansome.com>
+ * Copyright 2018-2021, Jonas Kvinge <jonas@jkvinge.net>
+ *
+ * Strawberry is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Strawberry is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Strawberry.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef PLAYERINTERFACE_H
+#define PLAYERINTERFACE_H
+
+#include "config.h"
+
+#include <QObject>
+#include <QString>
+#include <QUrl>
+
+#include "includes/shared_ptr.h"
+#include "engine/enginebase.h"
+#include "playlist/playlist.h"
+#include "playlist/playlistitem.h"
+
+class QTimer;
+class Song;
+
+class PlayerInterface : public QObject {
+  Q_OBJECT
+
+ public:
+  explicit PlayerInterface(QObject *parent = nullptr);
+
+  virtual SharedPtr<EngineBase> engine() const = 0;
+  virtual EngineBase::State GetState() const = 0;
+  virtual uint GetVolume() const = 0;
+
+  virtual PlaylistItemPtr GetCurrentItem() const = 0;
+  virtual PlaylistItemPtr GetItemAt(const int pos) const = 0;
+
+ public Q_SLOTS:
+  virtual void ReloadSettings() = 0;
+  virtual void LoadVolume() = 0;
+  virtual void SaveVolume() = 0;
+  virtual void SavePlaybackStatus() = 0;
+
+  virtual void PlaylistsLoaded() = 0;
+
+  // Manual track change to the specified track
+  virtual void PlayAt(const int index, const bool pause, const quint64 offset_nanosec, EngineBase::TrackChangeFlags change, const Playlist::AutoScroll autoscroll, const bool reshuffle, const bool force_inform = false) = 0;
+
+  // If there's currently a song playing, pause it, otherwise play the track that was playing last, or the first one on the playlist
+  virtual void PlayPause(const quint64 offset_nanosec = 0, const Playlist::AutoScroll autoscroll = Playlist::AutoScroll::Always) = 0;
+  virtual void PlayPauseHelper() = 0;
+  virtual void RestartOrPrevious() = 0;
+
+  // Skips this track.  Might load more of the current radio station.
+  virtual void Next() = 0;
+  virtual void Previous() = 0;
+  virtual void PlayPlaylist(const QString &playlist_name) = 0;
+  virtual void SetVolumeFromEngine(const uint volume) = 0;
+  virtual void SetVolumeFromSlider(const int value) = 0;
+  virtual void SetVolume(const uint volume) = 0;
+  virtual void VolumeUp() = 0;
+  virtual void VolumeDown() = 0;
+  virtual void SeekTo(const quint64 seconds) = 0;
+  // Moves the position of the currently playing song five seconds forward.
+  virtual void SeekForward() = 0;
+  // Moves the position of the currently playing song five seconds backwards.
+  virtual void SeekBackward() = 0;
+
+  virtual void CurrentMetadataChanged(const Song &metadata) = 0;
+
+  virtual void Mute() = 0;
+  virtual void Pause() = 0;
+  virtual void Stop(const bool stop_after = false) = 0;
+  virtual void Play(const quint64 offset_nanosec = 0) = 0;
+  virtual void PlayWithPause(const quint64 offset_nanosec) = 0;
+  virtual void PlayHelper() = 0;
+  virtual void ShowOSD() = 0;
+
+ Q_SIGNALS:
+  void Playing();
+  void Paused();
+  // Emitted only when playback is manually resumed
+  void Resumed();
+  void Stopped();
+  void Error(const QString &message = QString());
+  void PlaylistFinished();
+  void VolumeEnabled(const bool volume_enabled);
+  void VolumeChanged(const uint volume);
+  void TrackSkipped(PlaylistItemPtr old_track);
+  // Emitted when there's a manual change to the current's track position.
+  void Seeked(const qint64 microseconds);
+
+  // Emitted when Player has processed a request to play another song.
+  // This contains the URL of the song and a flag saying whether it was able to play the song.
+  void SongChangeRequestProcessed(const QUrl &url, const bool valid);
+
+  // The toggle parameter is true when user requests to toggle visibility for Pretty OSD
+  void ForceShowOSD(const Song &song, const bool toggle);
+
+  void Authenticated();
+};
+
+#endif  // PLAYERINTERFACE_H