Sayonara Player
PlaylistHandler.h
1 /* Playlist.h */
2 
3 /* Copyright (C) 2011-2019 Lucio Carreras
4  *
5  * This file is part of sayonara player
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11 
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16 
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 
22 /*
23  * Playlist.h
24  *
25  * Created on: Apr 6, 2011
26  * Author: Lucio Carreras
27  */
28 
29 #ifndef PLAYLISTHANDLER_H_
30 #define PLAYLISTHANDLER_H_
31 
32 #include "PlaylistDBInterface.h"
33 
34 #include "Components/PlayManager/PlayState.h"
35 
36 #include "Utils/Pimpl.h"
37 #include "Utils/Singleton.h"
38 #include "Utils/Playlist/PlaylistFwd.h"
39 #include "Utils/Library/LibraryNamespaces.h"
40 
41 #include <QObject>
42 
43 class CustomPlaylist;
44 
45 namespace Playlist
46 {
51  class Handler :
52  public QObject
53  {
54  Q_OBJECT
55  PIMPL(Handler)
56  SINGLETON_QOBJECT(Handler)
57 
58  public:
59 
63  enum class PlaylistIndex : uint8_t
64  {
65  Current=0,
66  Active
67  };
68 
69  signals:
74  void sig_playlist_created(PlaylistPtr pl);
75 
81  void sig_current_track_changed(int track_idx, int playlist_idx);
82 
87  void sig_new_playlist_added(PlaylistPtr pl);
88 
93  void sig_playlist_name_changed(int idx);
94 
99  void sig_current_playlist_changed(int idx);
100  void sig_active_playlist_changed(int idx);
101 
108 
109  void sig_find_track_requested(TrackID track_id);
110 
111 
112  public:
113 
118  void shutdown();
119 
124  void clear_playlist(int pl_idx);
125 
130  void play_next(const MetaDataList& v_md);
131  void play_next(const QStringList& paths);
132 
139  void insert_tracks(const MetaDataList& v_md, int idx, int pl_idx);
140  void insert_tracks(const QStringList& paths, int idx, int pl_idx);
141 
142 
148  void append_tracks(const MetaDataList& v_md, int pl_idx);
149  void append_tracks(const QStringList& paths, int pl_idx);
150 
157  void move_rows(const IndexSet& indexes, int tgt_idx, int pl_idx);
158 
159 
165  void remove_rows(const IndexSet& indexes, int pl_idx);
166 
167 
173  void change_track(int track_idx, int pl_idx);
174 
175 
180  int active_index() const;
181  PlaylistConstPtr active_playlist() const;
182 
183 
184  int current_index() const;
185  void set_current_index(int pl_idx);
186 
191  int count() const;
192 
193 
199  PlaylistConstPtr playlist(int pl_idx) const;
200 
201 
206  void delete_playlist(int pl_idx);
207 
212  int close_playlist(int pl_idx);
213 
214 
219  void reset_playlist(int pl_idx);
220 
228  QString request_new_playlist_name(const QString& prefix=QString()) const;
229 
230 
236  Util::SaveAsAnswer save_playlist(int pl_idx);
237 
238 
246  Util::SaveAsAnswer save_playlist_as(int pl_idx, const QString& name, bool force_override);
247 
248 
255  Util::SaveAsAnswer rename_playlist(int pl_idx, const QString& name);
256 
257 
263  void save_playlist_to_file(int pl_idx, const QString& filename, bool relative);
264 
273  int create_playlist(const MetaDataList& v_md, const QString& name=QString(), bool temporary=true, PlaylistType type=PlaylistType::Std);
274 
283  int create_playlist(const QStringList& path_list, const QString& name=QString(), bool temporary=true, PlaylistType type=PlaylistType::Std);
284 
294  int create_playlist(const QString& dir, const QString& name=QString(), bool temporary=true, PlaylistType type=PlaylistType::Std);
295 
296 
302  int create_playlist(const CustomPlaylist& pl);
303 
304 
310  int create_empty_playlist(bool override_current=false);
311  int create_empty_playlist(const QString& name);
312 
313 
314  void delete_tracks(int pl_idx, const IndexSet& rows, Library::TrackDeletionMode deletion_mode);
315 
316  public slots:
321  int load_old_playlists();
322 
323 
324  private slots:
325 
329  void played();
330 
334  void stopped();
335 
339  void previous();
340 
344  void next();
345 
346  void wake_up();
347 
348 
352  void playstate_changed(PlayState state);
353 
354  void www_track_finished(const MetaData& md);
355 
356  void current_track_changed(int index);
357  void playlist_stopped();
358 
359  void playlist_renamed(int id, const QString& old_name, const QString& new_name);
360  void playlist_deleted(int id);
361 
366  void filescanner_progress_changed(const QString& current_file);
367  void files_scanned();
368 
369  private:
377  int add_new_playlist(const QString& name, bool editable, PlaylistType type=PlaylistType::Std);
378 
386  PlaylistPtr new_playlist(PlaylistType type, QString name);
387 
388 
394  int exists(const QString& name) const;
395 
396 
402  PlaylistPtr active_playlist();
403 
410  PlaylistPtr playlist(int pl_idx, PlaylistPtr fallback) const;
411 
412 
418  void emit_cur_track_changed();
419 
424  void set_active_idx(int playlist_index);
425 
434  void create_filescanner(int playlist_index, const QStringList& paths, int target_row_idx);
435  };
436 }
437 
438 #endif /* PLAYLISTHANDLER_H_ */
Playlist::Handler::clear_playlist
void clear_playlist(int pl_idx)
clears the current visible playlist
PlayState
PlayState
The PlayState enum.
Definition: PlayState.h:28
Playlist::Handler::request_new_playlist_name
QString request_new_playlist_name(const QString &prefix=QString()) const
Request a new name for the playlist (usually New %1 is returned). If the prefix differs,...
Playlist::Handler::sig_new_playlist_added
void sig_new_playlist_added(PlaylistPtr pl)
emitted when new playlist has been added
Playlist::Handler::insert_tracks
void insert_tracks(const MetaDataList &v_md, int idx, int pl_idx)
insert tracks into a playlist at a given index
Playlist::Handler::rename_playlist
Util::SaveAsAnswer rename_playlist(int pl_idx, const QString &name)
rename playlist
Playlist::Handler::sig_playlist_name_changed
void sig_playlist_name_changed(int idx)
emitted when playlist name has changed
Playlist::Handler::PlaylistIndex
PlaylistIndex
The PlaylistIndex enum.
Definition: PlaylistHandler.h:63
MetaDataList
The MetaDataList class.
Definition: MetaDataList.h:37
Playlist::Handler::playlist
PlaylistConstPtr playlist(int pl_idx) const
get specific playlist at given index
Util::Set
A set structure. Inherited from std::set with some useful methods. For integer and String this set is...
Definition: Set.h:35
Playlist::Handler::shutdown
void shutdown()
Call this before the program stops. Singletons and Destructors don't work out so well.
Playlist::Handler::save_playlist_as
Util::SaveAsAnswer save_playlist_as(int pl_idx, const QString &name, bool force_override)
Save playlist under new name.
Playlist::Handler::create_playlist
int create_playlist(const MetaDataList &v_md, const QString &name=QString(), bool temporary=true, PlaylistType type=PlaylistType::Std)
create a new playlist
Playlist::Handler::sig_playlist_created
void sig_playlist_created(PlaylistPtr pl)
emitted when new playlist has been created
Playlist::Handler::sig_track_deletion_requested
void sig_track_deletion_requested(const MetaDataList &v_md, Library::TrackDeletionMode deletion_mode)
emitted when a track deletion was triggered over the Ui
CustomPlaylist
The CustomPlaylist class.
Definition: CustomPlaylist.h:31
Playlist::Handler::sig_current_playlist_changed
void sig_current_playlist_changed(int idx)
emitted when tracks were added/removed or have changed
Library::TrackDeletionMode
TrackDeletionMode
The TrackDeletionMode enum.
Definition: LibraryNamespaces.h:36
Playlist::Handler
Global handler for playlists.
Definition: PlaylistHandler.h:51
Playlist::Handler::change_track
void change_track(int track_idx, int pl_idx)
change the track in a given playlist
Playlist::Handler::save_playlist
Util::SaveAsAnswer save_playlist(int pl_idx)
save playlist to database, overwrite old one
MetaData
The MetaData class.
Definition: MetaData.h:44
Playlist::Handler::play_next
void play_next(const MetaDataList &v_md)
insert tracks to active playlist after current playback position
Playlist::Handler::append_tracks
void append_tracks(const MetaDataList &v_md, int pl_idx)
append tracks at a given playlist index
Playlist::Handler::sig_current_track_changed
void sig_current_track_changed(int track_idx, int playlist_idx)
emitted when current track index has changed
Playlist::Handler::save_playlist_to_file
void save_playlist_to_file(int pl_idx, const QString &filename, bool relative)
save a playlist to file
Playlist::Handler::load_old_playlists
int load_old_playlists()
load playlists of last session from database
Playlist::Handler::reset_playlist
void reset_playlist(int pl_idx)
reload playlist from db
Playlist::Handler::delete_playlist
void delete_playlist(int pl_idx)
delete the given playlist from database
Playlist::Handler::close_playlist
int close_playlist(int pl_idx)
close playlist
Playlist::Handler::active_index
int active_index() const
get active playlist index
Playlist::Handler::move_rows
void move_rows(const IndexSet &indexes, int tgt_idx, int pl_idx)
move rows within playlist
Playlist::Handler::count
int count() const
Returns number of playlists.
Playlist::Handler::remove_rows
void remove_rows(const IndexSet &indexes, int pl_idx)
remove rows from playlist
Playlist::Handler::create_empty_playlist
int create_empty_playlist(bool override_current=false)
create a new empty playlist