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