Update installation document a bit to catch up with recent changes. Add notes about...
[Rockbox.git] / apps / settings.h
blobd3fd0683b74fdf9cb0757b3e9802a002b7b51031
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2002 by Stuart Martin
12 * All files in this archive are subject to the GNU General Public License.
13 * See the file COPYING in the source tree root for full license agreement.
15 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
16 * KIND, either express or implied.
18 ****************************************************************************/
20 #ifndef __SETTINGS_H__
21 #define __SETTINGS_H__
23 #include <stdbool.h>
24 #include "inttypes.h"
25 #include "config.h"
26 #include "file.h"
27 #include "dircache.h"
28 #include "timefuncs.h"
29 #include "tagcache.h"
30 #ifndef __PCTOOL__
31 #include "button.h"
32 #endif
34 #if CONFIG_CODEC == SWCODEC
35 #include "audio.h"
36 #endif
38 #ifdef HAVE_BACKLIGHT_BRIGHTNESS
39 #include "backlight.h" /* for [MIN|MAX]_BRIGHTNESS_SETTING */
40 #endif
42 struct opt_items {
43 unsigned const char* string;
44 int32_t voice_id;
47 /** Setting values defines **/
49 /* name of directory where configuration, fonts and other data
50 * files are stored */
51 #ifdef __PCTOOL__
52 #define ROCKBOX_DIR "."
53 #define ROCKBOX_DIR_LEN 1
54 #else
55 #define ROCKBOX_DIR "/.rockbox"
56 #define ROCKBOX_DIR_LEN 9
57 #endif
59 #define FONT_DIR ROCKBOX_DIR "/fonts"
60 #define LANG_DIR ROCKBOX_DIR "/langs"
61 #define WPS_DIR ROCKBOX_DIR "/wps"
62 #define THEME_DIR ROCKBOX_DIR "/themes"
63 #define ICON_DIR ROCKBOX_DIR "/icons"
65 #define PLUGIN_DIR ROCKBOX_DIR "/rocks"
66 #define PLUGIN_GAMES_DIR PLUGIN_DIR "/games"
67 #define PLUGIN_APPS_DIR PLUGIN_DIR "/apps"
68 #define PLUGIN_DEMOS_DIR PLUGIN_DIR "/demos"
69 #define VIEWERS_DIR PLUGIN_DIR "/viewers"
71 #define BACKDROP_DIR ROCKBOX_DIR "/backdrops"
72 #define REC_BASE_DIR "/"
73 #define EQS_DIR ROCKBOX_DIR "/eqs"
74 #define CODECS_DIR ROCKBOX_DIR "/codecs"
75 #define RECPRESETS_DIR ROCKBOX_DIR "/recpresets"
76 #define FMPRESET_PATH ROCKBOX_DIR "/fmpresets"
77 #define PLAYLIST_CATALOG_DEFAULT_DIR "/Playlists"
79 #define VIEWERS_CONFIG ROCKBOX_DIR "/viewers.config"
80 #define CONFIGFILE ROCKBOX_DIR "/config.cfg"
81 #define FIXEDSETTINGSFILE ROCKBOX_DIR "/fixed.cfg"
83 #define MAX_FILENAME 32
86 #define BOOKMARK_NO 0
87 #define BOOKMARK_YES 1
88 #define BOOKMARK_ASK 2
89 #define BOOKMARK_UNIQUE_ONLY 2
90 #define BOOKMARK_RECENT_ONLY_YES 3
91 #define BOOKMARK_RECENT_ONLY_ASK 4
93 #define TRIG_MODE_OFF 0
94 #define TRIG_MODE_NOREARM 1
95 #define TRIG_MODE_REARM 2
97 #define TRIG_DURATION_COUNT 13
98 extern const struct opt_items trig_durations[TRIG_DURATION_COUNT];
100 #define CROSSFADE_ENABLE_SHUFFLE 1
101 #define CROSSFADE_ENABLE_TRACKSKIP 2
102 #define CROSSFADE_ENABLE_SHUFFLE_AND_TRACKSKIP 3
103 #define CROSSFADE_ENABLE_ALWAYS 4
105 #define FOLDER_ADVANCE_OFF 0
106 #define FOLDER_ADVANCE_NEXT 1
107 #define FOLDER_ADVANCE_RANDOM 2
109 /* repeat mode options */
110 enum
112 REPEAT_OFF,
113 REPEAT_ALL,
114 REPEAT_ONE,
115 REPEAT_SHUFFLE,
116 #ifdef AB_REPEAT_ENABLE
117 REPEAT_AB,
118 #endif
119 NUM_REPEAT_MODES
122 /* dir filter options */
123 /* Note: Any new filter modes need to be added before NUM_FILTER_MODES.
124 * Any new rockbox browse filter modes (accessible through the menu)
125 * must be added after NUM_FILTER_MODES. */
126 enum { SHOW_ALL, SHOW_SUPPORTED, SHOW_MUSIC, SHOW_PLAYLIST, SHOW_ID3DB,
127 NUM_FILTER_MODES,
128 SHOW_WPS, SHOW_RWPS, SHOW_FMR, SHOW_CFG, SHOW_LNG, SHOW_MOD, SHOW_FONT, SHOW_PLUGINS};
130 /* recursive dir insert options */
131 enum { RECURSE_OFF, RECURSE_ON, RECURSE_ASK };
133 /* replaygain types */
134 enum { REPLAYGAIN_TRACK = 0, REPLAYGAIN_ALBUM, REPLAYGAIN_SHUFFLE };
136 /* show path types */
137 enum { SHOW_PATH_OFF = 0, SHOW_PATH_CURRENT, SHOW_PATH_FULL };
139 /* Alarm settings */
140 #ifdef HAVE_RTC_ALARM
141 enum { ALARM_START_WPS = 0,
142 #if CONFIG_TUNER
143 ALARM_START_FM,
144 #endif
145 #ifdef HAVE_RECORDING
146 ALARM_START_REC,
147 #endif
148 ALARM_START_COUNT
150 #if CONFIG_TUNER && defined(HAVE_RECORDING)
151 #define ALARM_SETTING_TEXT "wps,fm,rec"
152 #elif CONFIG_TUNER
153 #define ALARM_SETTING_TEXT "wps,fm"
154 #elif defined(HAVE_RECORDING)
155 #define ALARM_SETTING_TEXT "wps,rec"
156 #endif
158 #endif /* HAVE_RTC_ALARM */
159 /** virtual pointer stuff.. move to another .h maybe? **/
160 /* These define "virtual pointers", which could either be a literal string,
161 or a mean a string ID if the pointer is in a certain range.
162 This helps to save space for menus and options. */
164 #define VIRT_SIZE 0xFFFF /* more than enough for our string ID range */
165 #ifdef SIMULATOR
166 /* a space which is defined in stubs.c */
167 extern unsigned char vp_dummy[VIRT_SIZE];
168 #define VIRT_PTR vp_dummy
169 #elif CONFIG_CPU==DM320
170 /* the DM320 has IRAM at 0, so we use 0xffff bytes right after that */
171 #define VIRT_PTR ((unsigned char*)0x4000)
172 #else
173 /* a location where we won't store strings, 0 is the fastest */
174 #define VIRT_PTR ((unsigned char*)0)
175 #endif
177 /* form a "virtual pointer" out of a language ID */
178 #define ID2P(id) (VIRT_PTR + id)
180 /* resolve a pointer which could be a virtualized ID or a literal */
181 #define P2STR(p) (char *)((p>=VIRT_PTR && p<=VIRT_PTR+VIRT_SIZE) ? str(p-VIRT_PTR) : p)
183 /* get the string ID from a virtual pointer, -1 if not virtual */
184 #define P2ID(p) ((p>=VIRT_PTR && p<=VIRT_PTR+VIRT_SIZE) ? p-VIRT_PTR : -1)
186 /* !defined(HAVE_LCD_COLOR) implies HAVE_LCD_CONTRAST with default 40.
187 Explicitly define HAVE_LCD_CONTRAST in config file for newer ports for
188 simplicity. */
192 /** function prototypes **/
194 /* argument bits for settings_load() */
195 #define SETTINGS_RTC 1 /* only the settings from the RTC nonvolatile RAM */
196 #define SETTINGS_HD 2 /* only the settings from the disk sector */
197 #define SETTINGS_ALL 3 /* both */
198 void settings_load(int which);
199 bool settings_load_config(const char* file, bool apply);
201 void status_save(void);
202 int settings_save(void);
203 /* defines for the options paramater */
204 enum {
205 SETTINGS_SAVE_CHANGED = 0,
206 SETTINGS_SAVE_ALL,
207 SETTINGS_SAVE_THEME,
208 SETTINGS_SAVE_SOUND,
209 #ifdef HAVE_RECORDING
210 SETTINGS_SAVE_RECPRESETS,
211 #endif
212 #if CONFIG_CODEC == SWCODEC
213 SETTINGS_SAVE_EQPRESET,
214 #endif
216 bool settings_save_config(int options);
218 void settings_reset(void);
219 void sound_settings_apply(void);
220 void settings_apply(bool read_disk);
221 void settings_apply_pm_range(void);
222 void settings_display(void);
224 enum optiontype { INT, BOOL };
226 const struct settings_list* find_setting(const void* variable, int *id);
227 bool cfg_int_to_string(int setting_id, int val, char* buf, int buf_len);
228 bool set_bool_options(const char* string, const bool* variable,
229 const char* yes_str, int yes_voice,
230 const char* no_str, int no_voice,
231 void (*function)(bool));
233 bool set_bool(const char* string, const bool* variable);
234 bool set_int(const unsigned char* string, const char* unit, int voice_unit,
235 const int* variable,
236 void (*function)(int), int step, int min, int max,
237 void (*formatter)(char*, size_t, int, const char*) );
239 /* use this one if you need to create a lang from the value (i.e with TALK_ID()) */
240 bool set_int_ex(const unsigned char* string, const char* unit, int voice_unit,
241 const int* variable,
242 void (*function)(int), int step, int min, int max,
243 void (*formatter)(char*, size_t, int, const char*),
244 int32_t (*get_talk_id)(int, int));
246 void set_file(const char* filename, char* setting, int maxlen);
248 bool set_option(const char* string, const void* variable, enum optiontype type,
249 const struct opt_items* options, int numoptions, void (*function)(int));
253 /** global_settings and global_status struct definitions **/
255 struct system_status
257 int resume_index; /* index in playlist (-1 for no active resume) */
258 int resume_first_index; /* index of first track in playlist */
259 uint32_t resume_offset; /* byte offset in mp3 file */
260 int resume_seed; /* shuffle seed (-1=no resume shuffle 0=sorted
261 >0=shuffled) */
262 int runtime; /* current runtime since last charge */
263 int topruntime; /* top known runtime */
264 #ifdef HAVE_DIRCACHE
265 int dircache_size; /* directory cache structure last size, 22 bits */
266 #endif
267 #if CONFIG_TUNER
268 int last_frequency; /* Last frequency for resuming, in FREQ_STEP units,
269 relative to MIN_FREQ */
270 int statusbar_forced; /* fix the bug where the statusbar would stay shown
271 if powered off inside the fm screen...
272 for some reason the screen doesnt use global_settings.statusbar
273 obviously a better fix is to fix the screen... so remove this
274 when that happens */
275 #endif
276 char last_screen;
277 int viewer_icon_count;
280 struct user_settings
282 /* audio settings */
284 int volume; /* audio output volume in decibels range depends on the dac */
285 int balance; /* stereo balance: 0-100 0=left 50=bal 100=right */
286 int bass; /* bass boost/cut in decibels */
287 int treble; /* treble boost/cut in decibels */
288 int channel_config; /* Stereo, Mono, Custom, Mono left, Mono right, Karaoke */
289 int stereo_width; /* 0-255% */
291 #if CONFIG_CODEC != SWCODEC
292 int loudness; /* loudness eq: 0-100 0=off 100=max */
293 int avc; /* auto volume correct: 0=off, 1=20ms, 2=2s 3=4s 4=8s */
294 int mdb_strength; /* 0-127dB */
295 int mdb_harmonics; /* 0-100% */
296 int mdb_center; /* 20-300Hz */
297 int mdb_shape; /* 50-300Hz */
298 bool mdb_enable; /* true/false */
299 bool superbass; /* true/false */
300 #endif
302 #ifdef HAVE_WM8758
303 int bass_cutoff;
304 int treble_cutoff;
305 #endif
307 #if CONFIG_CODEC == SWCODEC
308 int crossfade; /* Enable crossfade (0=off,1=shuffle,2=trackskip,3=shuff&trackskip,4=always) */
309 int crossfade_fade_in_delay; /* Fade in delay (0-15s) */
310 int crossfade_fade_out_delay; /* Fade out delay (0-15s) */
311 int crossfade_fade_in_duration; /* Fade in duration (0-15s) */
312 int crossfade_fade_out_duration; /* Fade out duration (0-15s) */
313 int crossfade_fade_out_mixmode; /* Fade out mode (0=crossfade,1=mix) */
314 #endif
315 #ifdef HAVE_RECORDING
316 #if CONFIG_CODEC == SWCODEC
317 int rec_format; /* record format index */
318 #else
319 int rec_quality; /* 0-7 */
320 #endif /* CONFIG_CODEC == SWCODEC */
321 int rec_source; /* 0=mic, 1=line, 2=S/PDIF, 2 or 3=FM Radio */
322 int rec_frequency; /* 0 = 44.1kHz (depends on target)
323 1 = 48kHz
324 2 = 32kHz
325 3 = 22.05kHz
326 4 = 24kHz
327 5 = 16kHz */
328 int rec_channels; /* 0=Stereo, 1=Mono */
329 int rec_mic_gain; /* depends on target */
330 int rec_left_gain; /* depends on target */
331 int rec_right_gain; /* depands on target */
332 bool rec_editable; /* true means that the bit reservoir is off */
334 /* note: timesplit setting is not saved */
335 int rec_timesplit; /* 0 = off,
336 1 = 00:05, 2 = 00:10, 3 = 00:15, 4 = 00:30
337 5 = 01:00, 6 = 02:00, 7 = 04:00, 8 = 06:00
338 9 = 08:00, 10= 10:00, 11= 12:00, 12= 18:00,
339 13= 24:00 */
340 int rec_sizesplit; /* 0 = off,
341 1 = 5MB, 2 = 10MB, 3 = 15MB, 4 = 32MB
342 5 = 64MB, 6 = 75MB, 7 = 100MB, 8 = 128MB
343 9 = 256MB, 10= 512MB, 11= 650MB, 12= 700MB,
344 13= 1GB, 14 = 1.5GB 15 = 1.75MB*/
345 int rec_split_type; /* split/stop */
346 int rec_split_method; /* time/filesize */
348 int rec_prerecord_time; /* In seconds, 0-30, 0 means OFF */
349 char rec_directory[MAX_FILENAME+1];
350 int cliplight; /* 0 = off
351 1 = main lcd
352 2 = main and remote lcd
353 3 = remote lcd */
355 int rec_start_thres; /* negative: db, positive: % range -87 .. 100 */
356 int rec_start_duration; /* index of trig_durations */
357 int rec_stop_thres; /* negative: db, positive: % */
358 int rec_stop_postrec; /* negative: db, positive: % range -87 .. 100 */
359 int rec_stop_gap; /* index of trig_durations */
360 int rec_trigger_mode; /* see TRIG_MODE_XXX constants */
361 int rec_trigger_type; /* what to do when trigger released */
363 #ifdef HAVE_AGC
364 int rec_agc_preset_mic; /* AGC mic preset modes:
365 0 = Off
366 1 = Safety (clip)
367 2 = Live (slow)
368 3 = DJ-Set (slow)
369 4 = Medium
370 5 = Voice (fast) */
371 int rec_agc_preset_line; /* AGC line-in preset modes:
372 0 = Off
373 1 = Safety (clip)
374 2 = Live (slow)
375 3 = DJ-Set (slow)
376 4 = Medium
377 5 = Voice (fast) */
378 int rec_agc_maxgain_mic; /* AGC maximum mic gain */
379 int rec_agc_maxgain_line; /* AGC maximum line-in gain */
380 int rec_agc_cliptime; /* 0.2, 0.4, 0.6, 0.8, 1s */
381 #endif
382 #endif /* HAVE_RECORDING */
383 /* device settings */
385 #ifdef HAVE_LCD_CONTRAST
386 int contrast; /* lcd contrast */
387 #endif
388 bool invert; /* invert display */
389 int cursor_style; /* style of the selection cursor */
390 bool flip_display; /* turn display (and button layout) by 180 degrees */
391 int poweroff; /* power off timer */
392 int backlight_timeout; /* backlight off timeout: 0-18 0=never,
393 1=always,
394 then according to timeout_values[] */
395 #if CONFIG_CHARGING
396 int backlight_timeout_plugged;
397 #endif
399 #ifdef HAVE_BACKLIGHT_PWM_FADING
400 int backlight_fade_in; /* backlight fade in timing: 0..3 */
401 int backlight_fade_out; /* backlight fade in timing: 0..7 */
402 #endif
403 #ifdef HAVE_BACKLIGHT_BRIGHTNESS
404 int brightness;
405 #endif
406 int battery_capacity; /* in mAh */
407 #if BATTERY_TYPES_COUNT > 1
408 int battery_type; /* for units which can take multiple types (Ondio). */
409 #endif
410 #ifdef HAVE_SPDIF_POWER
411 bool spdif_enable; /* S/PDIF power on/off */
412 #endif
414 #if CONFIG_TUNER
415 unsigned char fmr_file[MAX_FILENAME+1]; /* last fmr preset */
416 #endif
417 #ifdef HAVE_LCD_BITMAP
418 unsigned char font_file[MAX_FILENAME+1]; /* last font */
419 #endif
420 unsigned char wps_file[MAX_FILENAME+1]; /* last wps */
421 unsigned char lang_file[MAX_FILENAME+1]; /* last language */
423 /* misc options */
425 int repeat_mode; /* 0=off 1=repeat all 2=repeat one 3=shuffle 4=ab */
426 int dirfilter; /* 0=display all, 1=only supported, 2=only music,
427 3=dirs+playlists, 4=ID3 database */
428 bool sort_case; /* dir sort order: 0=case insensitive, 1=sensitive */
429 int show_filename_ext; /* show filename extensions in file browser?
430 0 = no, 1 = yes, 2 = only unknown 0 */
431 int volume_type; /* how volume is displayed: 0=graphic, 1=percent */
432 int battery_display; /* how battery is displayed: 0=graphic, 1=percent */
433 int timeformat; /* time format: 0=24 hour clock, 1=12 hour clock */
434 bool playlist_shuffle;
435 bool play_selected; /* Plays selected file even in shuffle mode */
436 int ff_rewind_min_step; /* FF/Rewind minimum step size */
437 int ff_rewind_accel; /* FF/Rewind acceleration (in seconds per doubling) */
439 #ifndef HAVE_FLASH_STORAGE
440 int disk_spindown; /* time until disk spindown, in seconds (0=off) */
441 int buffer_margin; /* MP3 buffer watermark margin, in seconds */
442 #endif
444 int peak_meter_release; /* units per read out */
445 int peak_meter_hold; /* hold time for peak meter in 1/100 s */
446 int peak_meter_clip_hold; /* hold time for clips */
447 bool peak_meter_dbfs; /* show linear or dbfs values */
448 int peak_meter_min; /* range minimum */
449 int peak_meter_max; /* range maximum */
450 #ifdef HAVE_RECORDING
451 bool peak_meter_clipcounter; /* clipping count indicator */
452 #endif
453 bool car_adapter_mode; /* 0=off 1=on */
455 /* show status bar */
456 bool statusbar; /* 0=hide, 1=show */
458 #if CONFIG_KEYPAD == RECORDER_PAD
459 /* show button bar */
460 bool buttonbar; /* 0=hide, 1=show */
461 #endif
463 /* show scroll bar */
464 bool scrollbar; /* 0=hide, 1=show */
466 /* goto current song when exiting WPS */
467 bool browse_current; /* 1=goto current song,
468 0=goto previous location */
471 int scroll_speed; /* long texts scrolling speed: 1-30 */
472 int bidir_limit; /* bidir scroll length limit */
473 int scroll_delay; /* delay (in 1/10s) before starting scroll */
474 int scroll_step; /* pixels to advance per update */
475 #ifdef HAVE_REMOTE_LCD
476 int remote_scroll_speed; /* long texts scrolling speed: 1-30 */
477 int remote_scroll_delay; /* delay (in 1/10s) before starting scroll */
478 int remote_scroll_step; /* pixels to advance per update */
479 int remote_bidir_limit; /* bidir scroll length limit */
480 #endif
482 #ifdef HAVE_LCD_BITMAP
483 bool offset_out_of_view;
484 int screen_scroll_step;
485 #endif
487 /* auto bookmark settings */
488 int autoloadbookmark; /* auto load option: 0=off, 1=ask, 2=on */
489 int autocreatebookmark; /* auto create option: 0=off, 1=ask, 2=on */
490 int usemrb; /* use MRB list: 0=No, 1=Yes*/
491 #ifdef HAVE_LCD_CHARCELLS
492 int jump_scroll; /* Fast jump when scrolling */
493 int jump_scroll_delay; /* Delay between jump scroll screens */
494 #endif
495 bool fade_on_stop; /* fade on pause/unpause/stop */
496 bool caption_backlight; /* turn on backlight at end and start of track */
498 #if CONFIG_TUNER
499 int fm_freq_step; /* Frequency step for manual tuning, in kHz */
500 bool fm_force_mono; /* Forces Mono mode if true */
501 bool fm_full_range; /* Enables full 10MHz-160MHz range if true, else
502 only 88MHz-108MHz */
503 #endif
505 int max_files_in_dir; /* Max entries in directory (file browser) */
506 int max_files_in_playlist; /* Max entries in playlist */
507 bool show_icons; /* 0=hide 1=show */
508 int recursive_dir_insert; /* should directories be inserted recursively */
510 #if CONFIG_CODEC == MAS3507D
511 bool line_in; /* false=off, true=active */
512 #endif
514 /* playlist viewer settings */
515 bool playlist_viewer_icons; /* display icons on viewer */
516 bool playlist_viewer_indices; /* display playlist indices on viewer */
517 int playlist_viewer_track_display; /* how to display tracks in viewer */
519 /* voice UI settings */
520 bool talk_menu; /* enable voice UI */
521 int talk_dir; /* voiced directories mode: 0=off 1=number 2=spell */
522 bool talk_dir_clip; /* use directory .talk clips */
523 int talk_file; /* voice file mode: 0=off, 1=number, 2=spell */
524 bool talk_file_clip; /* use file .talk clips */
525 bool talk_filetype; /* say file type */
526 bool talk_battery_level;
528 /* file browser sorting */
529 int sort_file; /* 0=alpha, 1=date, 2=date (new first), 3=type */
530 int sort_dir; /* 0=alpha, 1=date (old first), 2=date (new first) */
532 #ifdef HAVE_REMOTE_LCD
533 /* remote lcd */
534 int remote_contrast; /* lcd contrast: 0-63 0=low 63=high */
535 bool remote_invert; /* invert display */
536 bool remote_flip_display; /* turn display (and button layout) by 180 degrees */
537 int remote_backlight_timeout; /* backlight off timeout: 0-18 0=never,
538 1=always,
539 then according to timeout_values[] */
540 int remote_backlight_timeout_plugged;
541 bool remote_caption_backlight; /* turn on backlight at end and start of track */
542 #ifdef HAS_REMOTE_BUTTON_HOLD
543 int remote_backlight_on_button_hold; /* what to do with remote backlight when hold
544 switch is on */
545 #endif
546 #ifdef HAVE_REMOTE_LCD_TICKING
547 bool remote_reduce_ticking; /* 0=normal operation,
548 1=EMI reduce on with cost more CPU. */
549 #endif
550 #endif /* HAVE_REMOTE_LCD */
552 int next_folder; /* move to next folder */
553 bool runtimedb; /* runtime database active? */
555 #if CONFIG_CODEC == SWCODEC
556 bool replaygain; /* enable replaygain */
557 bool replaygain_noclip; /* scale to prevent clips */
558 int replaygain_type; /* 0=track gain, 1=album gain, 2=track gain if
559 shuffle is on, album gain otherwise */
560 int replaygain_preamp; /* scale replaygained tracks by this */
561 int beep; /* system beep volume when changing tracks etc. */
563 /* Crossfeed settings */
564 bool crossfeed; /* enable crossfeed */
565 unsigned int crossfeed_direct_gain; /* dB x 10 */
566 unsigned int crossfeed_cross_gain; /* dB x 10 */
567 unsigned int crossfeed_hf_attenuation; /* dB x 10 */
568 unsigned int crossfeed_hf_cutoff; /* Frequency in Hz */
569 #endif
570 #ifdef HAVE_DIRCACHE
571 bool dircache; /* enable directory cache */
572 #endif
573 #ifdef HAVE_TAGCACHE
574 #ifdef HAVE_TC_RAMCACHE
575 bool tagcache_ram; /* load tagcache to ram? */
576 #endif
577 bool tagcache_autoupdate; /* automatically keep tagcache in sync? */
578 #endif
579 int default_codepage; /* set default codepage for tag conversion */
580 #ifdef HAVE_REMOTE_LCD
581 unsigned char rwps_file[MAX_FILENAME+1]; /* last remote-wps */
582 #endif
584 #if CONFIG_CODEC == SWCODEC
585 bool eq_enabled; /* Enable equalizer */
586 unsigned int eq_precut; /* dB */
588 /* Order is important here, must be cutoff, q, then gain for each band.
589 See dsp_eq_update_data in dsp.c for why. */
591 /* Band 0 settings */
592 int eq_band0_cutoff; /* Hz */
593 int eq_band0_q;
594 int eq_band0_gain; /* +/- dB */
596 /* Band 1 settings */
597 int eq_band1_cutoff; /* Hz */
598 int eq_band1_q;
599 int eq_band1_gain; /* +/- dB */
601 /* Band 2 settings */
602 int eq_band2_cutoff; /* Hz */
603 int eq_band2_q;
604 int eq_band2_gain; /* +/- dB */
606 /* Band 3 settings */
607 int eq_band3_cutoff; /* Hz */
608 int eq_band3_q;
609 int eq_band3_gain; /* +/- dB */
611 /* Band 4 settings */
612 int eq_band4_cutoff; /* Hz */
613 int eq_band4_q;
614 int eq_band4_gain; /* +/- dB */
616 bool dithering_enabled;
617 #endif
620 #if LCD_DEPTH > 1
621 unsigned char backdrop_file[MAX_FILENAME+1]; /* backdrop bitmap file */
622 #endif
624 bool warnon_erase_dynplaylist; /* warn when erasing dynamic playlist */
625 bool scroll_paginated; /* 0=dont 1=do */
626 #ifdef HAVE_LCD_COLOR
627 int bg_color; /* background color native format */
628 int fg_color; /* foreground color native format */
629 int lss_color; /* background color for the selector or start color for the gradient */
630 int lse_color; /* end color for the selector gradient */
631 int lst_color; /* color of the text for the selector */
632 #endif
633 bool party_mode; /* party mode - unstoppable music */
635 #ifdef HAVE_BACKLIGHT
636 bool bl_filter_first_keypress; /* filter first keypress when dark? */
637 #ifdef HAVE_REMOTE_LCD
638 bool remote_bl_filter_first_keypress; /* filter first remote keypress when remote dark? */
639 #endif
640 #ifdef HAS_BUTTON_HOLD
641 int backlight_on_button_hold; /* what to do with backlight when hold
642 switch is on */
643 #endif
644 #ifdef HAVE_LCD_SLEEP
645 int lcd_sleep_after_backlight_off; /* when to put lcd to sleep after backlight
646 has turned off */
647 #endif
648 #endif /* HAVE_BACKLIGHT */
650 #ifdef HAVE_LCD_BITMAP
651 unsigned char kbd_file[MAX_FILENAME+1]; /* last keyboard */
652 #endif
654 #ifdef HAVE_USB_POWER
655 #if CONFIG_CHARGING
656 bool usb_charging;
657 #endif
658 #endif
660 bool hold_lr_for_scroll_in_list; /* hold L/R scrolls the list left/right */
661 #ifdef HAVE_LCD_BITMAP
662 int show_path_in_browser; /* 0=off, 1=current directory, 2=full path */
663 #endif
665 #ifdef HAVE_HEADPHONE_DETECTION
666 int unplug_mode; /* pause on headphone unplug */
667 int unplug_rw; /* time in s to rewind when pausing */
668 bool unplug_autoresume; /* disable auto-resume if no phones */
669 #endif
670 #if CONFIG_TUNER
671 int fm_region;
672 #endif
673 bool audioscrobbler; /* Audioscrobbler logging */
675 /* If values are just added to the end, no need to bump plugin API
676 version. */
677 /* new stuff to be added at the end */
679 #if defined(HAVE_RECORDING) && CONFIG_CODEC == SWCODEC
680 /* Encoder Settings Start - keep these together */
681 struct mp3_enc_config mp3_enc_config;
682 #if 0 /* These currently contain no members but their places in line
683 should be held */
684 struct aiff_enc_config aiff_enc_config;
685 struct wav_enc_config wav_enc_config;
686 struct wavpack_enc_config wavpack_enc_config;
687 #endif
688 /* Encoder Settings End */
689 #endif /* CONFIG_CODEC == SWCODEC */
690 bool cuesheet;
691 int start_in_screen;
692 #if defined(HAVE_RTC_ALARM) && \
693 (defined(HAVE_RECORDING) || CONFIG_TUNER)
694 int alarm_wake_up_screen;
695 #endif
696 /* customizable icons */
697 #ifdef HAVE_LCD_BITMAP
698 unsigned char icon_file[MAX_FILENAME+1];
699 unsigned char viewers_icon_file[MAX_FILENAME+1];
700 #endif
701 #ifdef HAVE_REMOTE_LCD
702 unsigned char remote_icon_file[MAX_FILENAME+1];
703 unsigned char remote_viewers_icon_file[MAX_FILENAME+1];
704 #endif
705 #ifdef HAVE_LCD_COLOR
706 unsigned char colors_file[MAX_FILENAME+1];
707 #endif
708 #ifdef HAVE_BUTTON_LIGHT
709 int buttonlight_timeout;
710 #endif
711 #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
712 int buttonlight_brightness;
713 #endif
714 #ifndef HAVE_SCROLLWHEEL
715 int list_accel_start_delay; /* ms before we start increaseing step size */
716 int list_accel_wait; /* ms between increases */
717 #endif
718 #ifdef HAVE_USBSTACK
719 int usb_stack_mode; /* device or host */
720 unsigned char usb_stack_device_driver[32]; /* usb device driver to load */
721 #endif
722 #if CONFIG_CODEC == SWCODEC
723 int keyclick; /* keyclick volume */
724 int keyclick_repeats; /* keyclick on repeats */
725 #endif
726 unsigned char playlist_catalog_dir[MAX_FILENAME+1];
729 /** global variables **/
730 extern long lasttime;
731 /* global settings */
732 extern struct user_settings global_settings;
733 /* global status */
734 extern struct system_status global_status;
736 #endif /* __SETTINGS_H__ */