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