Sayonara Player
AbstractLibrary.h
1 /* AbstractLibrary.h */
2 
3 /* Copyright (C) 2011-2017 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 #ifndef ABSTRACTLIBRARY_H
22 #define ABSTRACTLIBRARY_H
23 
24 
25 #include "Helper/Library/LibraryNamespaces.h"
26 #include "Helper/Library/Filter.h"
27 #include "Helper/Settings/SayonaraClass.h"
28 #include "Helper/typedefs.h"
29 #include "Helper/Pimpl.h"
30 
31 #include "Helper/MetaData/Artist.h"
32 #include "Helper/MetaData/Album.h"
33 #include "Helper/MetaData/MetaDataList.h"
34 
35 #include "Helper/Library/Sorting.h"
36 
37 #include <QFile>
38 
39 #define prepare_tracks_for_playlist_files static_cast<void (AbstractLibrary::*) (const QStringList&)>(&AbstractLibrary::psl_prepare_tracks_for_playlist)
40 #define prepare_tracks_for_playlist_idxs static_cast<void (AbstractLibrary::*) (const IdxList&)>(&AbstractLibrary::psl_prepare_tracks_for_playlist)
41 
42 
43 class PlaylistHandler;
44 class AbstractLibrary : public QObject, protected SayonaraClass
45 {
46  Q_OBJECT
47  PIMPL(AbstractLibrary)
48 
49 public:
50 
51  explicit AbstractLibrary(QObject *parent=nullptr);
52  virtual ~AbstractLibrary();
53 
54 signals:
55  void sig_track_mime_data_available(const MetaDataList&);
56  void sig_all_tracks_loaded (const MetaDataList&);
57  void sig_all_albums_loaded(const AlbumList&);
58  void sig_all_artists_loaded(const ArtistList&);
59 
60  void sig_reloading_library(const QString& message, int progress);
61  void sig_reloading_library_finished();
62 
63  void sig_delete_answer(QString);
64  void sig_import_dialog_requested();
65 
66 
67 public slots:
68 
69  virtual void load();
70 
71  virtual void psl_reload_library(bool clear_first, Library::ReloadQuality quality)=0;
72 
73  /* Clears all filters and searchstrings and fetches everything again */
74  virtual void refetch();
75 
76 
77  /* refetches everything from database as it is, keeping selected elements,
78  the user won't recognize anything at all */
79  virtual void refresh();
80 
81 
82  /* selection changed */
83  virtual void psl_selected_artists_changed(const SP::Set<int>& idx_lst);
84  virtual void psl_selected_albums_changed(const SP::Set<int>& idx_lst);
85  virtual void psl_selected_tracks_changed(const SP::Set<int>& idx_lst);
86 
87 
88  // [albums|artist|track[s]] double clicked -> send tracks to playlist
89  virtual void psl_prepare_album_for_playlist(int idx, bool new_playlist);
90  virtual void psl_prepare_artist_for_playlist(int idx, bool new_playlist);
91 
92 
93  // Those two functions are identical (1) calls (2)
94  virtual void psl_prepare_tracks_for_playlist(bool new_playlist);
95  virtual void psl_prepare_tracks_for_playlist(const SP::Set<int>& indexes, bool new_playlist);
96  virtual void psl_prepare_tracks_for_playlist(const QStringList& file_paths, bool new_playlist);
97 
98 
99  /* append tracks after current played track in playlist */
100  virtual void psl_play_next_all_tracks();
101  virtual void psl_play_next_tracks(const SP::Set<int>& idx_lst);
102 
103 
104  /* append tracks after last track in playlist */
105  virtual void psl_append_all_tracks();
106  virtual void psl_append_tracks(const SP::Set<int>& idx_lst);
107 
108  /* triggered by tagedit */
109  virtual void psl_metadata_id3_changed(const MetaDataList&, const MetaDataList&);
110 
111  // calls fetch_by_filter and emits
112  virtual void psl_filter_changed(const Library::Filter&, bool force=false);
113 
114 
115  /* a searchfilter has been entered, nothing is emitted */
116  virtual void fetch_by_filter(const Library::Filter& filter, bool force);
117 
118  virtual void delete_tracks(const MetaDataList& v_md, Library::TrackDeletionMode mode)=0;
119  virtual void delete_tracks_by_idx(const SP::Set<int>& indexes, Library::TrackDeletionMode mode);
120  virtual void delete_all_tracks();
121  virtual void delete_current_tracks(Library::TrackDeletionMode mode);
122 
123  virtual void insert_tracks(const MetaDataList& v_md);
124  virtual void import_files(const QStringList& files);
125 
126  /* write new rating to database */
127  virtual void change_track_rating(int idx, int rating);
128  virtual void change_album_rating(int idx, int rating);
129 
130  virtual void add_genre(const SP::Set<ID> ids, const QString& genre);
131  virtual void delete_genre(const QString& genre);
132  virtual void rename_genre(const QString& genre, const QString& new_name);
133 
134  /* Check for current selected artist if out of date and
135  * fetch new data */
136  virtual void refresh_artist()=0;
137  virtual void refresh_albums()=0;
138  virtual void refresh_tracks()=0;
139 
140 
141 protected slots:
142  virtual void _sl_sortorder_changed();
143 
144 
145 protected:
146 
147  PlaylistHandler* _playlist=nullptr;
148 
149  MetaDataList _vec_md;
150  AlbumList _vec_albums;
151  ArtistList _vec_artists;
152 
153  // contains ID for artists, albums, tracks
154  SP::Set<ArtistID> _selected_artists;
155  SP::Set<AlbumID> _selected_albums;
156  SP::Set<TrackID> _selected_tracks;
157 
158  Library::Filter _filter;
159  Library::Sortings _sortorder;
160 
161 
162  /* Emit 3 signals with shown artists, shown album, shown tracks */
163  virtual void emit_stuff();
164 
165 
166  virtual void get_all_artists(ArtistList& artists, Library::Sortings so)=0;
167  virtual void get_all_artists_by_searchstring(Library::Filter filter, ArtistList& artists, Library::Sortings so)=0;
168 
169  virtual void get_all_albums(AlbumList& albums, Library::Sortings so)=0;
170  virtual void get_all_albums_by_artist(IDList artist_ids, AlbumList& albums, Library::Filter filter, Library::Sortings so)=0;
171  virtual void get_all_albums_by_searchstring(Library::Filter filter, AlbumList& albums, Library::Sortings so)=0;
172 
173 
174  virtual void get_all_tracks(MetaDataList& v_md, Library::Sortings so)=0;
175  virtual void get_all_tracks(const QStringList& paths, MetaDataList& v_md)=0;
176  virtual void get_all_tracks_by_artist(IDList artist_ids, MetaDataList& v_md, Library::Filter filter, Library::Sortings so)=0;
177  virtual void get_all_tracks_by_album(IDList album_ids, MetaDataList& v_md, Library::Filter filter, Library::Sortings so)=0;
178  virtual void get_all_tracks_by_searchstring(Library::Filter filter, MetaDataList& v_md, Library::Sortings so)=0;
179 
180  virtual void get_album_by_id(int album_id, Album& album)=0;
181  virtual void get_artist_by_id(int artist_id, Artist& artist)=0;
182 
183  virtual void update_track(const MetaData& md)=0;
184  virtual void update_tracks(const MetaDataList& v_md);
185  virtual void update_album(const Album& album)=0;
186 
187 
188 private:
189  void set_playlist_action_after_double_click();
190 
191 // virtual void restore_artist_selection();
192  void restore_track_selection();
193  void restore_album_selection();
194 
195  MetaDataList change_track_selection(const SP::Set<int>& idx_list);
196  void change_artist_selection(const SP::Set<int>& idx_list);
197  void change_album_selection(const SP::Set<int>& idx_list);
198 };
199 
200 #endif // ABSTRACTLIBRARY_H
TrackDeletionMode
The TrackDeletionMode enum.
Definition: LibraryNamespaces.h:35
The SayonaraClass class provides access to Settings and notifications.
Definition: SayonaraClass.h:29
ReloadQuality
The ReloadQuality enum.
Definition: LibraryNamespaces.h:46
The Sortings class.
Definition: Sorting.h:34
The MetaData class.
Definition: MetaData.h:55
Definition: AbstractLibrary.h:44
The Filter class.
Definition: Filter.h:43
Definition: MetaDataList.h:39
The AlbumList class.
Definition: Album.h:78
ArtistList.
Definition: Artist.h:60
The Album class.
Definition: Album.h:38
Global handler for playlists.
Definition: PlaylistHandler.h:57
The Artist class.
Definition: Artist.h:33
A set structure. Inherited from std::set with some useful methods. For integer and String this set is...
Definition: AbstractPlaylist.h:37