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 "Utils/Library/LibraryNamespaces.h"
26 #include "Utils/Library/Filter.h"
27 #include "Utils/Library/Sorting.h"
28 #include "Utils/Settings/SayonaraClass.h"
29 #include "Utils/Pimpl.h"
30 
31 #include <QFile>
32 
33 #define prepare_tracks_for_playlist_files static_cast<void (AbstractLibrary::*) (const QStringList&)>(&AbstractLibrary::psl_prepare_tracks_for_playlist)
34 #define prepare_tracks_for_playlist_idxs static_cast<void (AbstractLibrary::*) (const IdxList&)>(&AbstractLibrary::psl_prepare_tracks_for_playlist)
35 
36 class Genre;
37 class ExtensionSet;
38 
40  public QObject,
41  public SayonaraClass
42 {
43  Q_OBJECT
44  PIMPL(AbstractLibrary)
45 
46 public:
47 
48  explicit AbstractLibrary(QObject *parent=nullptr);
49  virtual ~AbstractLibrary();
50 
51  Library::Sortings sortorder() const;
52  Library::Filter filter() const;
53  // calls fetch_by_filter and emits
54  void change_filter(Library::Filter, bool force=false);
55 
56 
57  const MetaDataList& tracks() const;
58  const AlbumList& albums() const;
59  const ArtistList& artists() const;
64  const MetaDataList& current_tracks() const;
65 
66  const Util::Set<TrackID>& selected_tracks() const;
67  const Util::Set<AlbumId>& selected_albums() const;
68  const Util::Set<ArtistId>& selected_artists() const;
69 
70  // emits new tracks, very similar to psl_selected_albums_changed
71  void change_current_disc(Disc disc);
72 
73  bool is_loaded() const;
74 
75  void set_extensions(const ExtensionSet& extensions);
76  ExtensionSet extensions() const;
77 
78 signals:
79  void sig_track_mime_data_available();
80  void sig_all_tracks_loaded();
81  void sig_all_albums_loaded();
82  void sig_all_artists_loaded();
83 
84  void sig_reloading_library(const QString& message, int progress);
85  void sig_reloading_library_finished();
86 
87  void sig_delete_answer(QString);
88  void sig_import_dialog_requested();
89 
90 
91 public slots:
92 
93  virtual void load();
94 
95  virtual void reload_library(bool clear_first, Library::ReloadQuality quality)=0;
96 
97  /* Clears all filters and searchstrings and fetches everything again */
98  virtual void refetch();
99 
100 
101  /* refetches everything from database as it is, keeping selected elements,
102  the user won't recognize anything at all */
103  virtual void refresh();
104 
105 
106  /* selection changed */
107  virtual void selected_artists_changed(const IndexSet& indexes);
108  virtual void selected_albums_changed(const IndexSet& indexes, bool ignore_artists=false);
109  virtual void selected_tracks_changed(const IndexSet& indexes);
110 
111  // Those two functions are identical (1) calls (2)
112  virtual void prepare_current_tracks_for_playlist(bool new_playlist);
113  virtual void prepare_fetched_tracks_for_playlist(bool new_playlist);
114  void prepare_tracks_for_playlist(const QStringList& file_paths, bool new_playlist);
115 
116 
117  /* append tracks after current played track in playlist */
118  virtual void play_next_fetched_tracks();
119  virtual void play_next_current_tracks();
120 
121 
122  /* append tracks after last track in playlist */
123  virtual void append_fetched_tracks();
124  virtual void append_current_tracks();
125 
126  /* triggered by tagedit */
127  virtual void metadata_id3_changed(const MetaDataList&, const MetaDataList&);
128 
129  /* a searchfilter has been entered, nothing is emitted */
130  virtual void fetch_by_filter(Library::Filter filter, bool force);
131  virtual void fetch_tracks_by_paths(const QStringList& paths);
132 
133  virtual void delete_tracks(const MetaDataList& v_md, Library::TrackDeletionMode mode)=0;
134  virtual void delete_tracks_by_idx(const IndexSet& indexes, Library::TrackDeletionMode mode);
135 
136  virtual void delete_fetched_tracks(Library::TrackDeletionMode mode);
137  virtual void delete_current_tracks(Library::TrackDeletionMode mode);
138  virtual void delete_all_tracks();
139 
140  virtual void insert_tracks(const MetaDataList& v_md);
141  virtual void import_files(const QStringList& files);
142 
143  /* write new rating to database */
144  virtual void change_album_rating(int idx, Rating rating);
145 
146  virtual void change_track_sortorder(Library::SortOrder s);
147  virtual void change_album_sortorder(Library::SortOrder s);
148  virtual void change_artist_sortorder(Library::SortOrder s);
149 
150  /* Check for current selected artist if out of date and
151  * fetch new data */
152  virtual void refresh_artist()=0;
153  virtual void refresh_albums()=0;
154  virtual void refresh_tracks()=0;
155 
156 protected:
157  /* Emit 3 signals with shown artists, shown album, shown tracks */
158  virtual void emit_stuff();
159 
160  virtual void get_all_artists(ArtistList& artists)=0;
161  virtual void get_all_artists_by_searchstring(Library::Filter filter, ArtistList& artists)=0;
162 
163  virtual void get_all_albums(AlbumList& albums)=0;
164  virtual void get_all_albums_by_artist(IdList artist_ids, AlbumList& albums, Library::Filter filter)=0;
165  virtual void get_all_albums_by_searchstring(Library::Filter filter, AlbumList& albums)=0;
166 
167  virtual void get_all_tracks(MetaDataList& v_md)=0;
168  virtual void get_all_tracks(const QStringList& paths, MetaDataList& v_md)=0;
169  virtual void get_all_tracks_by_artist(IdList artist_ids, MetaDataList& v_md, Library::Filter filter)=0;
170  virtual void get_all_tracks_by_album(IdList album_ids, MetaDataList& v_md, Library::Filter filter)=0;
171  virtual void get_all_tracks_by_searchstring(Library::Filter filter, MetaDataList& v_md)=0;
172 
173  virtual void get_album_by_id(AlbumId album_id, Album& album)=0;
174  virtual void get_artist_by_id(ArtistId artist_id, Artist& artist)=0;
175 
176  virtual void update_track(const MetaData& md)=0;
177  virtual void update_tracks(const MetaDataList& v_md);
178  virtual void update_album(const Album& album)=0;
179 
180  void prepare_tracks();
181  void prepare_albums();
182  void prepare_artists();
183 
184 
185 private:
186  void tag_edit_commit();
187  void set_playlist_action_after_double_click();
188 
189  void change_track_selection(const IndexSet& indexes);
190  void change_artist_selection(const IndexSet& indexes);
191  void change_album_selection(const IndexSet& indexes, bool ignore_artists=false);
192 };
193 
194 #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:33
The MetaData class.
Definition: MetaData.h:44
Definition: AbstractLibrary.h:39
The Filter class.
Definition: Filter.h:39
Definition: ExtensionSet.h:6
The MetaDataList class.
Definition: MetaDataList.h:37
A set structure. Inherited from std::set with some useful methods. For integer and String this set is...
Definition: Set.h:35
The AlbumList class.
Definition: Album.h:89
const MetaDataList & current_tracks() const
current selected tracks
ArtistList.
Definition: Artist.h:70
Definition: Genre.h:30
The Album class.
Definition: Album.h:39
The Artist class.
Definition: Artist.h:36
Definition: org_mpris_media_player2_adaptor.h:20