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 class CustomPlaylist;
42 
43 namespace Playlist
44 {
49  class Handler :
50  public QObject
51  {
52  Q_OBJECT
53  PIMPL(Handler)
54  SINGLETON_QOBJECT(Handler)
55 
56  public:
57 
61  enum class PlaylistIndex : uint8_t
62  {
63  Current=0,
64  Active
65  };
66 
67  signals:
73 
79  void sig_current_track_changed(int track_idx, int playlist_idx);
80 
86 
91  void sig_playlist_name_changed(int idx);
92 
97 
98 
99  void sig_current_playlist_changed(int idx);
100 
101  void sig_track_deletion_requested(const MetaDataList& v_md, Library::TrackDeletionMode deletion_mode);
102 
103 
104  public:
105 
106  void shutdown();
107 
112  void clear_playlist(int pl_idx);
113 
118  void play_next(const MetaDataList& v_md);
119 
126  void insert_tracks(const MetaDataList& v_md, int idx, int pl_idx);
127 
128 
134  void append_tracks(const MetaDataList& v_md, int pl_idx);
135 
142  void move_rows(const IndexSet& indexes, int tgt_idx, int pl_idx);
143 
144 
150  void remove_rows(const IndexSet& indexes, int pl_idx);
151 
152 
158  void change_track(int track_idx, int pl_idx);
159 
160 
165  int active_index() const;
166  PlaylistConstPtr active_playlist() const;
167 
168 
169  int current_index() const;
170  void set_current_index(int pl_idx);
171 
172 
178  PlaylistConstPtr playlist(int pl_idx) const;
179 
180 
185  void delete_playlist(int pl_idx);
186 
191  int close_playlist(int pl_idx);
192 
193 
198  void reset_playlist(int pl_idx);
199 
204  QString request_new_playlist_name() const;
205 
206 
212  DBInterface::SaveAsAnswer save_playlist(int pl_idx);
213 
214 
222  DBInterface::SaveAsAnswer save_playlist_as(int pl_idx, const QString& name, bool force_override);
223 
224 
231  DBInterface::SaveAsAnswer rename_playlist(int pl_idx, const QString& name);
232 
233 
239  void save_playlist_to_file(int pl_idx, const QString& filename, bool relative);
240 
241 
242 
251  int create_playlist(const MetaDataList& v_md, const QString& name=QString(), bool temporary=true, Playlist::Type type=Playlist::Type::Std);
252 
261  int create_playlist(const QStringList& path_list, const QString& name=QString(), bool temporary=true, Playlist::Type type=Playlist::Type::Std);
262 
272  int create_playlist(const QString& dir, const QString& name=QString(), bool temporary=true, Playlist::Type type=Playlist::Type::Std);
273 
274 
280  int create_playlist(const CustomPlaylist& pl);
281 
282 
288  int create_empty_playlist(bool override_current=false);
289 
290  int create_empty_playlist(const QString& name);
291 
292 
293  void delete_tracks(int pl_idx, const IndexSet& rows, Library::TrackDeletionMode deletion_mode);
294 
295  public slots:
300  int load_old_playlists();
301 
302 
303  private slots:
304 
308  void played();
309 
313  void paused();
314 
318  void stopped();
319 
323  void previous();
324 
328  void next();
329 
330  void wake_up();
331 
332 
336  void playstate_changed(PlayState state);
337 
338  void www_track_finished(const MetaData& md);
339 
340 
341 
342  private:
343  // adds a new playlist, creates it, if name is not in the list of playlists. If name already exists,
344  // this function returns the index
345  int add_new_playlist(const QString& name, bool editable, Playlist::Type type=Playlist::Type::Std);
346 
347  // raw creation of playlists
348  PlaylistPtr new_playlist(Playlist::Type type, int idx, QString name="");
349 
350 
356  int exists(const QString& name) const;
357 
358 
364  PlaylistPtr active_playlist();
365 
372  PlaylistPtr playlist(int pl_idx, PlaylistPtr fallback) const;
373 
374 
380  void emit_cur_track_changed();
381 
386  void set_active_idx(int pl_idx);
387  };
388 }
389 
390 #endif /* PLAYLISTHANDLER_H_ */
void insert_tracks(const MetaDataList &v_md, int idx, int pl_idx)
insert tracks into a playlist at a given index
DBInterface::SaveAsAnswer rename_playlist(int pl_idx, const QString &name)
rename playlist
void save_playlist_to_file(int pl_idx, const QString &filename, bool relative)
save a playlist to file
void sig_current_track_changed(int track_idx, int playlist_idx)
emitted when current track index has changed
int create_empty_playlist(bool override_current=false)
create a new empty playlist
void delete_playlist(int pl_idx)
delete the given playlist from database
Global handler for playlists.
Definition: PlaylistHandler.h:49
TrackDeletionMode
The TrackDeletionMode enum.
Definition: LibraryNamespaces.h:35
void remove_rows(const IndexSet &indexes, int pl_idx)
remove rows from playlist
PlayState
The PlayState enum.
Definition: PlayState.h:28
The MetaData class.
Definition: MetaData.h:44
int close_playlist(int pl_idx)
close playlist
int active_index() const
get active playlist index
The MetaDataList class.
Definition: MetaDataList.h:37
void play_next(const MetaDataList &v_md)
insert tracks to active playlist after current playback position
void sig_playlist_name_changed(int idx)
emitted when playlist name has changed
void sig_playlist_created(PlaylistPtr pl)
emitted when new playlist has been created
PlaylistIndex
The PlaylistIndex enum.
Definition: PlaylistHandler.h:61
int load_old_playlists()
load playlists of last session from database
DBInterface::SaveAsAnswer save_playlist_as(int pl_idx, const QString &name, bool force_override)
Save playlist under new name.
PlaylistConstPtr playlist(int pl_idx) const
get specific playlist at given index
void change_track(int track_idx, int pl_idx)
change the track in a given playlist
A set structure. Inherited from std::set with some useful methods. For integer and String this set is...
Definition: Set.h:35
std::shared_ptr< const Playlist::Base > PlaylistConstPtr
PlaylistConstPtr read only Playlist Pointer.
Definition: PlaylistFwd.h:45
void append_tracks(const MetaDataList &v_md, int pl_idx)
append tracks at a given playlist index
void clear_playlist(int pl_idx)
clears the current visible playlist
void sig_new_playlist_added(PlaylistPtr pl)
emitted when new playlist has been added
int create_playlist(const MetaDataList &v_md, const QString &name=QString(), bool temporary=true, Playlist::Type type=Playlist::Type::Std)
create a new playlist
The CustomPlaylist class.
Definition: CustomPlaylist.h:31
QString request_new_playlist_name() const
Request a new name for the playlist (usually new %1 is returned)
void reset_playlist(int pl_idx)
reload playlist from db
void sig_saved_playlists_changed()
emitted when saved playlists have changed
std::shared_ptr< Playlist::Base > PlaylistPtr
PlaylistPtr Playlist Pointer (only used internally)
Definition: PlaylistFwd.h:38
Definition: AbstractPlaylist.h:32
DBInterface::SaveAsAnswer save_playlist(int pl_idx)
save playlist to database, overwrite old one
void move_rows(const IndexSet &indexes, int tgt_idx, int pl_idx)
move rows within playlist