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