Sayonara Player
SettingKey.h
1 /* SettingKey.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  // clazy:excludeall=non-pod-global-static
22 
23 #ifndef SETTINGKEY_H
24 #define SETTINGKEY_H
25 
26 #include "Utils/typedefs.h"
27 
28 enum class SettingKey : unsigned short
29 {
30  LFM_Active=0,
31  LFM_ScrobbleTimeSec,
32  LFM_Login,
33  LFM_Username,
34  LFM_Password,
35  LFM_Corrections,
36  LFM_ShowErrors,
37  LFM_SessionKey,
38 
39  Eq_Last,
40  Eq_List,
41  Eq_Gauss,
42 
43  Lib_Show,
44  Lib_Path,
45  Lib_ColsTitle,
46  Lib_ColsArtist,
47  Lib_ColsAlbum,
48  Lib_ColSizeTitle,
49  Lib_ColSizeArtist,
50  Lib_ColSizeAlbum,
51  Lib_LiveSearch,
52  Lib_Sorting,
53  Lib_CurPlugin,
54  Lib_SplitterStateArtist,
55  Lib_SplitterStateTrack,
56  Lib_SplitterStateGenre,
57  Lib_SplitterStateDate,
58  Lib_OldWidth,
59  Lib_DC_DoNothing,
60  Lib_DC_PlayIfStopped,
61  Lib_DC_PlayImmediately,
62  Lib_DD_DoNothing,
63  Lib_DD_PlayIfStoppedAndEmpty,
64  Lib_FontSize,
65  Lib_FontBold,
66  Lib_SearchMode,
67  Lib_AutoUpdate,
68  Lib_ShowAlbumArtists,
69  Lib_ShowAlbumCovers,
70  Lib_CoverZoom,
71  Lib_CoverShowUtils,
72  Lib_CoverShowArtist,
73  Lib_CoverOrigPMCache,
74  Lib_CoverScaledPMCache,
75  Lib_GenreTree,
76  Lib_LastIndex,
77  Lib_AllLibraries, // deprecated
78  Lib_UseViewClearButton,
79  Lib_ShowFilterExtBar,
80 
81  Dir_ShowTracks,
82  Dir_SplitterDirFile,
83  Dir_SplitterTracks,
84 
85  Player_Version,
86  Player_Language,
87  Player_FontName,
88  Player_FontSize,
89  Player_Style,
90  Player_ControlStyle,
91  Player_Size,
92  Player_Pos,
93  Player_Fullscreen,
94  Player_Maximized,
95  Player_ShownPlugin,
96  Player_OneInstance,
97  Player_Min2Tray,
98  Player_StartInTray,
99  Player_ShowTrayIcon,
100  Player_514Fix,
101  Player_NotifyNewVersion,
102  Player_SplitterState,
103  Player_Shortcuts,
104  Player_SplitterControls,
105  Player_PrivId,
106  Player_PublicId,
107 
108  PL_Playlist,
109  PL_LoadSavedPlaylists,
110  PL_LoadTemporaryPlaylists,
111  PL_LoadLastTrack,
112  PL_RememberTime,
113  PL_StartPlaying,
114  PL_LastTrack,
115  PL_LastTrackBeforeStop,
116  PL_LastPlaylist,
117  PL_Mode,
118  PL_ShowNumbers,
119  PL_EntryLook,
120  PL_FontSize,
121  PL_ShowClearButton,
122  PL_RememberTrackAfterStop,
123  PL_ShowCovers,
124  PL_ShowRating,
125 
126  Notification_Show,
127  Notification_Timeout,
128  Notification_Name,
129 
130  Engine_Name,
131  Engine_Vol,
132  Engine_Mute,
133  AudioConvert_NumberThreads,
134  AudioConvert_PreferredConverter,
135  AudioConvert_QualityLameVBR,
136  AudioConvert_QualityLameCBR,
137  AudioConvert_QualityOgg,
138  Engine_CovertTargetPath,
139  Engine_SpectrumBins,
140  Engine_ShowSpectrum,
141  Engine_ShowLevel,
142  Engine_CurTrackPos_s,
143  Engine_CrossFaderActive,
144  Engine_CrossFaderTime,
145  Engine_Pitch,
146  Engine_PreservePitch,
147  Engine_Speed,
148  Engine_SpeedActive,
149  Engine_Sink,
150  Engine_BufferSizeMS,
151 
152  Engine_SR_Active,
153  Engine_SR_Warning,
154  Engine_SR_Path,
155  Engine_SR_SessionPath,
156  Engine_SR_SessionPathTemplate,
157  Engine_SR_AutoRecord,
158 
159  Spectrum_Style,
160  Level_Style,
161 
162  Broadcast_Active,
163  Broadcast_Prompt,
164  Broadcast_Port,
165 
166  MP3enc_found,
167  Pitch_found,
168  Player_Quit,
169 
170  Remote_Active,
171  Remote_Port,
172 
173  Stream_NewTab,
174  Stream_ShowHistory,
175  Stream_SearchWindowSize,
176 
177  Lyrics_Zoom,
178  Lyrics_Server,
179 
180  Cover_Server,
181  Cover_FetchFromWWW,
182  Cover_SaveToDB,
183  Cover_StartSearch,
184  Cover_SaveToLibrary,
185  Cover_SaveToSayonaraDir,
186  Cover_TemplatePath,
187  Icon_Theme,
188  Icon_ForceInDarkTheme,
189 
190  Proxy_Active,
191  Proxy_Username,
192  Proxy_Password,
193  Proxy_Hostname,
194  Proxy_Port,
195  Proxy_SavePw,
196 
197  Logger_Level,
198  Settings_Revision,
199 
200  Num_Setting_Keys
201 };
202 
203 
204 
205 class QString;
206 class QStringList;
207 class QPoint;
208 class QSize;
209 class QByteArray;
210 
211 class EQ_Setting;
212 struct RawShortcutMap;
213 
214 namespace Playlist
215 {
216  class Mode;
217 }
218 
219 namespace Library
220 {
221  class Sortings;
222  class Info;
223 }
224 
225 template<typename DataType, SettingKey keyIndex>
227 {
228  public:
229  using Data=DataType;
230  const static SettingKey key=keyIndex;
231 
232  private:
233  SettingIdentifier()=delete;
235 };
236 
237 
238 #define INST_ABSTR(ns, type, settingkey) \
239  namespace ns { \
240  using settingkey = SettingIdentifier<type, SettingKey:: settingkey>; \
241  }
242 
243 #define INST(type, settingkey) INST_ABSTR(Set, type, settingkey)
244 #define INST_NO_DB(type, settingkey) INST_ABSTR(SetNoDB, type, settingkey)
245 
250  INST(bool, LFM_Active) /* is lastFM active? */
251  INST(int, LFM_ScrobbleTimeSec) /* time in sec when to scrobble */
252  INST(StringPair, LFM_Login) /* deprecated: 2-Tupel, username, password */
253  INST(QString, LFM_Username) /* username*/
254  INST(QString, LFM_Password) /* encrypted password */
255 
256  INST(bool, LFM_Corrections) /* propose lfm corrections */
257  INST(bool, LFM_ShowErrors) /* get error message, if there are lfm problems */
258  INST(QString, LFM_SessionKey) /* lfm session key */
259 
260  INST(int, Eq_Last) /* last equalizer index */
261  INST(QList<EQ_Setting>, Eq_List) /* All equalizers */
262  INST(bool, Eq_Gauss) /* do curve, when changing eq setting */
263 
264  INST(bool, Lib_Show) /* show library */
265  INST(QString, Lib_Path) // deprecated
266  INST(BoolList, Lib_ColsTitle) /* shown columns tracks */
267  INST(BoolList, Lib_ColsArtist) /* shown columns artist */
268  INST(BoolList, Lib_ColsAlbum) /* shown columns albums */
269  INST(IntList, Lib_ColSizeArtist) /* Column Sizes for Artist */
270  INST(IntList, Lib_ColSizeAlbum) /* Column Sizes for Albums */
271  INST(IntList, Lib_ColSizeTitle) /* Column Sizes for Tracks */
272  INST(bool, Lib_LiveSearch) /* library live search */
273  INST(::Library::Sortings, Lib_Sorting) /* how to sort in lib */
274  INST(QString, Lib_CurPlugin) /* Current shown library plugin */
275  INST(QByteArray, Lib_SplitterStateArtist) /* Splitter state between artists and albums */
276  INST(QByteArray, Lib_SplitterStateTrack) /* Splitter state between artists and tracks */
277  INST(QByteArray, Lib_SplitterStateGenre) /* Splitter state between tracks and genres */
278  INST(QByteArray, Lib_SplitterStateDate) /* Splitter state between tracks and genres */
279  INST(int, Lib_OldWidth) /* Old library width when hiding library */
280  INST(bool, Lib_DC_DoNothing) /* when double clicked, create playlist and do nothing*/
281  INST(bool, Lib_DC_PlayIfStopped) /* when double clicked, play if stopped */
282  INST(bool, Lib_DC_PlayImmediately) /* when double clicked, play immediately */
283  INST(bool, Lib_DD_DoNothing) /* when drag dropped, insert tracks and do nothing */
284  INST(bool, Lib_DD_PlayIfStoppedAndEmpty) /* when drag dropped, play if playlist is empty and stopped */
285  INST(int, Lib_FontSize) /* current library font size */
286  INST(bool, Lib_FontBold) /* current library font weight */
287  INST(int, Lib_SearchMode) /* Search mode in library. See */
288  INST(bool, Lib_AutoUpdate) /* Automatic update of library */
289  INST(bool, Lib_ShowAlbumArtists) /* Show album artists instead of artists */
290  INST(bool, Lib_ShowAlbumCovers) /* Show album cover view */
291  INST(int, Lib_CoverZoom) /* Zoom of album cover view */
292  INST(int, Lib_CoverOrigPMCache) /* Original sized pixmap cache */
293  INST(int, Lib_CoverScaledPMCache) /* Scaled sized pixmap cache */
294  INST(bool, Lib_CoverShowUtils) /* Show utils bar in cover view */
295  INST(bool, Lib_CoverShowArtist) /* Show artist name in cover view */
296  INST(bool, Lib_GenreTree) /* Show tree view of genres */
297  INST(QList<::Library::Info>, Lib_AllLibraries) // deprecated
298  INST(int, Lib_LastIndex) /* Last selected library */
299  INST(bool, Lib_UseViewClearButton) /* Show clear button in single view */
300  INST(bool, Lib_ShowFilterExtBar) /* Show the file extension filter bar in track view */
301 
302  INST(bool, Dir_ShowTracks) /* show tracks panel in directory view */
303  INST(QByteArray, Dir_SplitterDirFile) /* Splitter state between dirs and files */
304  INST(QByteArray, Dir_SplitterTracks) /* Splitter between upper and track view */
305 
306 
307  INST(QString, Player_Version) /* Version string of player */
308  INST(QString, Player_Language) /* language of player */
309  INST(int, Player_Style) /* dark or native: native = 0, dark = 1 */
310  INST(int, Player_ControlStyle) /* Big cover or not */
311  INST(QString, Player_FontName) /* current font name */
312  INST(int, Player_FontSize) /* current font size */
313  INST(QSize, Player_Size) /* player size */
314  INST(QPoint, Player_Pos) /* player position */
315  INST(bool, Player_Fullscreen) /* player fullscreen */
316  INST(bool, Player_Maximized) /* player maximized */
317  INST(QString, Player_ShownPlugin) /* current shown plugin in player, empty if none */
318  INST(bool, Player_OneInstance) /* only one Sayonara instance is allowed */
319  INST(bool, Player_Min2Tray) /* minimize Sayonara to tray */
320  INST(bool, Player_ShowTrayIcon) /* Show/hide the tray icon */
321  INST(bool, Player_StartInTray) /* start in tray */
322  INST(bool, Player_514Fix) /* https://bugs.archlinux.org/task/59451 */
323  INST(bool, Player_NotifyNewVersion) /* check for new version on startup */
324  INST(QByteArray, Player_SplitterState) /* spliter state between playlist and library */
325  INST(RawShortcutMap, Player_Shortcuts) /* player shortcuts */
326  INST(QByteArray, Player_SplitterControls) /* Splitter state between controls and playlist */
327  INST(QByteArray, Player_PrivId) /* Unique identifier */
328  INST(QByteArray, Player_PublicId) /* Unique identifier */
329 
330  INST(QStringList, PL_Playlist) /* old playlist: list of integers in case of library tracks, if no library track, filepath */
331  INST(bool, PL_LoadSavedPlaylists) /* load saved playlists on startup */
332  INST(bool, PL_LoadTemporaryPlaylists) /* load temporary playlists on startup */
333  INST(bool, PL_LoadLastTrack) /* load last track on startup */
334  INST(bool, PL_RememberTime) /* remember time of last track */
335  INST(bool, PL_StartPlaying) /* start playing immediately when opening Sayonara */
336  INST(int, PL_LastTrack) /* last track idx in playlist */
337  INST(int, PL_LastTrackBeforeStop) /* last track before stop */
338  INST(int, PL_LastPlaylist) /* last Playlist id, where LastTrack has been played */
339  INST(QString, PL_EntryLook) /* formatting of playlist entry */
340  INST(int, PL_FontSize) /* current playlist font size */
341  INST(bool, PL_ShowClearButton) /* show clear button in playlist */
342  INST(Playlist::Mode, PL_Mode) /* playlist mode: rep1, repAll, shuffle... */
343  INST(bool, PL_ShowNumbers) /* show numbers in playlist */
344  INST(bool, PL_RememberTrackAfterStop) /* when stop button is pressed, remember last track index */
345  INST(bool, PL_ShowCovers) /* Show covers in Playlist */
346  INST(bool, PL_ShowRating) /* Show rating in playlist */
347 
348  INST(bool, Notification_Show) /* show notifications */
349  INST(int, Notification_Timeout) /* notification timeout */
350  INST(QString, Notification_Name) /* type of notifications: libnotify or empty for native baloons :( */
351 
352  INST(int, AudioConvert_NumberThreads) /* Number of threads */
353  INST(QString, AudioConvert_PreferredConverter) /* Preferred Converter: ogg, lame cbr, lame vbr */
354  INST(int, AudioConvert_QualityLameVBR) /* Lame Quality for variable bitrate 1-10 */
355  INST(int, AudioConvert_QualityLameCBR) /* 64 - 320 */
356  INST(int, AudioConvert_QualityOgg) /* 1 - 10 */
357 
358  INST(QString, Engine_Name) /* Deprecated: Engine name */
359  INST(int, Engine_Vol) /* Volume */
360  INST(bool, Engine_Mute) /* Muted/unmuted */
361  INST(int, Engine_CurTrackPos_s) /* position of track (used to load old position) */
362  INST(QString, Engine_CovertTargetPath) /* last convert path */
363  INST(int, Engine_SpectrumBins) /* number of spectrum bins */
364  INST(bool, Engine_ShowSpectrum) /* show spectrum */
365  INST(bool, Engine_ShowLevel) /* show level */
366  INST(bool, Engine_CrossFaderActive) /* crossfader, but not gapless active */
367  INST(int, Engine_CrossFaderTime) /* crossfader overlap time */
368  INST(int, Engine_Pitch) /* hertz of a */
369  INST(bool, Engine_SpeedActive) /* is speed control active? */
370  INST(float, Engine_Speed) /* if yes, set speed */
371  INST(bool, Engine_PreservePitch) /* if yes, should pitch be preserved? */
372  INST(QString, Engine_Sink) /* Alsa, pulseaudio */
373  INST(int, Engine_BufferSizeMS) /* Buffer size for streaming */
374 
375  INST(bool, Engine_SR_Active) /* Streamripper active */
376  INST(bool, Engine_SR_Warning) /* streamripper warnings */
377  INST(QString, Engine_SR_Path) /* streamripper paths */
378  INST(bool, Engine_SR_SessionPath) /* create streamripper session path? */
379  INST(QString, Engine_SR_SessionPathTemplate) /* streamripper session path template*/
380  INST(bool, Engine_SR_AutoRecord) /* streamripper automatic recording */
381 
382  INST(int, Spectrum_Style) /* index of spectrum style */
383  INST(int, Level_Style) /* index of level style */
384  INST(bool, Broadcast_Active) /* is broadcast active? */
385  INST(bool, Broadcast_Prompt) /* prompt when new connection arrives? */
386  INST(int, Broadcast_Port) /* broadcast port */
387 
388  INST(bool, Remote_Active) /* Remote control activated */
389  INST(int, Remote_Port) /* Remote control port */
390 
391  INST(bool, Stream_NewTab) /* Open Streams in new tab */
392  INST(bool, Stream_ShowHistory) /* Show history when playing streams */
393  INST(QSize, Stream_SearchWindowSize)
394 
395  INST(int, Lyrics_Zoom) /* Zoom factor in lyrics window */
396  INST(QString, Lyrics_Server) /* Lyrics server */
397 
398  INST(QStringList, Cover_Server) /* Cover server */
399  INST(bool, Cover_FetchFromWWW) /* Fetch covers from www */
400  INST(bool, Cover_SaveToDB) /* Save covers to DB */
401  INST(bool, Cover_StartSearch) /* start alternative cover search automatically */
402  INST(bool, Cover_SaveToLibrary) /* Save covers in library */
403  INST(bool, Cover_SaveToSayonaraDir) /* Save covers in library */
404  INST(QString, Cover_TemplatePath) /* Name of cover file in library */
405  INST(QString, Icon_Theme) /* Current icon theme */
406  INST(bool, Icon_ForceInDarkTheme) /* Current icon theme */
407 
408  INST(bool, Proxy_Active) /* Is proxy server active */
409  INST(QString, Proxy_Username) /* Proxy Username */
410  INST(QString, Proxy_Password) /* Proxy Password */
411  INST(QString, Proxy_Hostname) /* Proxy Hostname/IP Address */
412  INST(int, Proxy_Port) /* Proxy Port 3128 */
413  INST(bool, Proxy_SavePw) /* Should password be saved */
414 
415  INST(int, Settings_Revision) /* Version number of settings */
416 
417  INST(int, Logger_Level) /* Also log development: */
418 
419  INST_NO_DB(bool, MP3enc_found)
420  INST_NO_DB(bool, Pitch_found)
421  INST_NO_DB(bool, Player_Quit)
422 
423 #endif // SETTINGKEY_H
The Mode class.
Definition: PlaylistMode.h:32
INST(bool, LFM_Active) INST(int
Set namespace defines the setting: Which key and which type.
The Sortings class.
Definition: Sorting.h:33
The EQ_Setting class. Container for Equalizer configurations.
Definition: EqualizerPresets.h:32
Definition: typedefs.h:31
An interface class needed when implementing a library plugin.
Definition: CachingThread.h:29
The RawShortcutMap struct consisting of a specifier writable into database and a shortcut. This class is used for converting a shortcut map into its database representation.
Definition: RawShortcutMap.h:35
Definition: AbstractPlaylist.h:32
Definition: SettingKey.h:226
Definition: org_mpris_media_player2_adaptor.h:20