1# Copyright 2006-2009 Scott Horowitz <stonecrest@gmail.com>
2# Copyright 2009-2014 Jonathan Ballet <jon@multani.info>
3#
4# This file is part of Sonata.
5#
6# Sonata is free software: you can redistribute it and/or modify
7# it under the terms of the GNU General Public License as published by
8# the Free Software Foundation, either version 3 of the License, or
9# (at your option) any later version.
10#
11# Sonata is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the GNU General Public License
17# along with Sonata.  If not, see <http://www.gnu.org/licenses/>.
18
19"""
20This module contains various constant definitions that any other
21module can import without risk of cyclic imports.
22
23Most of the constants are enum-like, that is, they provide symbolic
24names for a set of values.
25
26XXX Should some of these be moved to be private in some module, or
27into config?
28
29Example usage:
30from consts import consts
31...
32if view == consts.VIEW_ALBUM: ...
33"""
34
35ART_LOCAL = 0
36ART_LOCAL_REMOTE = 1
37VIEW_FILESYSTEM = 0
38VIEW_ARTIST = 1
39VIEW_GENRE = 2
40VIEW_ALBUM = 3
41LYRIC_TIMEOUT = 10
42NOTIFICATION_WIDTH_MAX = 500
43NOTIFICATION_WIDTH_MIN = 350
44FULLSCREEN_COVER_SIZE = 500
45ART_LOCATION_HOMECOVERS = 0      # ~/.covers/[artist]-[album].jpg
46ART_LOCATION_COVER = 1           # file_dir/cover.jpg
47ART_LOCATION_ALBUM = 2           # file_dir/album.jpg
48ART_LOCATION_FOLDER = 3          # file_dir/folder.jpg
49ART_LOCATION_CUSTOM = 4          # file_dir/[custom]
50ART_LOCATION_SINGLE = 6
51ART_LOCATION_MISC = 7
52ART_LOCATIONS_MISC = ['front.jpg', '.folder.jpg',
53                      '.folder.png', 'AlbumArt.jpg',
54                      'AlbumArtSmall.jpg']
55LYRICS_LOCATION_HOME = 0         # ~/.lyrics/[artist]-[song].txt
56LYRICS_LOCATION_PATH = 1         # file_dir/[artist]-[song].txt
57LYRICS_LOCATION_HOME_ALT = 2     # ~/.lyrics/[artist] - [song].txt
58LYRICS_LOCATION_PATH_ALT = 3     # file_dir/[artist] - [song].txt
59LIB_COVER_SIZE = 32
60COVERS_TYPE_STANDARD = 0
61COVERS_TYPE_STYLIZED = 1
62LIB_LEVEL_GENRE = 0
63LIB_LEVEL_ARTIST = 1
64LIB_LEVEL_ALBUM = 2
65LIB_LEVEL_SONG = 3
66NUM_ARTISTS_FOR_VA = 2
67PREV_TRACK_RESTART = 5
68
69# the names of the plug-ins that will be enabled by default
70DEFAULT_PLUGINS = [
71    'playlists',
72    'streams',
73    'lyricwiki',
74    'localmpd',
75]
76