Adds manual section for limiter preamp
[kugel-rb.git] / apps / settings.h
blobbd28b994018e074c11f38e404eb1d1c411126ce5
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2002 by Stuart Martin
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
22 #ifndef __SETTINGS_H__
23 #define __SETTINGS_H__
25 #include <stdbool.h>
26 #include <stddef.h>
27 #include "inttypes.h"
28 #include "config.h"
29 #include "statusbar.h" /* for the statusbar values */
30 #include "button.h"
31 #if CONFIG_CODEC == SWCODEC
32 #include "audio.h"
33 #endif
35 struct opt_items {
36 unsigned const char* string;
37 int32_t voice_id;
40 /** Setting values defines **/
42 /* name of directory where configuration, fonts and other data
43 * files are stored */
44 #ifdef __PCTOOL__
45 #undef ROCKBOX_DIR
46 #undef ROCKBOX_DIR_LEN
47 #undef WPS_DIR
48 #define ROCKBOX_DIR "."
49 #define ROCKBOX_DIR_LEN 1
50 #else
52 /* ROCKBOX_DIR is now defined in autoconf.h for flexible build types */
53 #ifndef ROCKBOX_DIR
54 #error ROCKBOX_DIR not defined (should be in autoconf.h)
55 #endif
56 #define ROCKBOX_DIR_LEN sizeof(ROCKBOX_DIR)
57 #endif
60 #define FONT_DIR ROCKBOX_DIR "/fonts"
61 #define LANG_DIR ROCKBOX_DIR "/langs"
62 #define WPS_DIR ROCKBOX_DIR "/wps"
63 #define THEME_DIR ROCKBOX_DIR "/themes"
64 #define ICON_DIR ROCKBOX_DIR "/icons"
66 #define PLUGIN_DIR ROCKBOX_DIR "/rocks"
67 #define PLUGIN_GAMES_DIR PLUGIN_DIR "/games"
68 #define PLUGIN_APPS_DIR PLUGIN_DIR "/apps"
69 #define PLUGIN_DEMOS_DIR PLUGIN_DIR "/demos"
70 #define VIEWERS_DIR PLUGIN_DIR "/viewers"
72 #define BACKDROP_DIR ROCKBOX_DIR "/backdrops"
73 #define REC_BASE_DIR "/"
74 #define EQS_DIR ROCKBOX_DIR "/eqs"
75 #define CODECS_DIR ROCKBOX_DIR "/codecs"
76 #define RECPRESETS_DIR ROCKBOX_DIR "/recpresets"
77 #define FMPRESET_PATH ROCKBOX_DIR "/fmpresets"
78 #define PLAYLIST_CATALOG_DEFAULT_DIR "/Playlists"
80 #define VIEWERS_CONFIG ROCKBOX_DIR "/viewers.config"
81 #define CONFIGFILE ROCKBOX_DIR "/config.cfg"
82 #define FIXEDSETTINGSFILE ROCKBOX_DIR "/fixed.cfg"
84 #define MAX_FILENAME 32
87 enum {
88 BOOKMARK_NO = 0,
89 BOOKMARK_YES,
90 BOOKMARK_ASK,
91 BOOKMARK_UNIQUE_ONLY = 2,
92 BOOKMARK_RECENT_ONLY_YES,
93 BOOKMARK_RECENT_ONLY_ASK,
96 enum
98 TRIG_MODE_OFF = 0,
99 TRIG_MODE_NOREARM,
100 TRIG_MODE_REARM
103 enum
105 TRIG_TYPE_STOP = 0,
106 TRIG_TYPE_PAUSE,
107 TRIG_TYPE_NEW_FILE
110 enum {
111 CROSSFADE_ENABLE_OFF = 0,
112 CROSSFADE_ENABLE_SHUFFLE,
113 CROSSFADE_ENABLE_TRACKSKIP,
114 CROSSFADE_ENABLE_SHUFFLE_AND_TRACKSKIP,
115 CROSSFADE_ENABLE_ALWAYS,
118 enum {
119 FOLDER_ADVANCE_OFF = 0,
120 FOLDER_ADVANCE_NEXT,
121 FOLDER_ADVANCE_RANDOM,
124 /* repeat mode options */
125 enum
127 REPEAT_OFF = 0,
128 REPEAT_ALL,
129 REPEAT_ONE,
130 REPEAT_SHUFFLE,
131 #ifdef AB_REPEAT_ENABLE
132 REPEAT_AB,
133 #endif
134 NUM_REPEAT_MODES
138 /* dir filter options */
139 /* Note: Any new filter modes need to be added before NUM_FILTER_MODES.
140 * Any new rockbox browse filter modes (accessible through the menu)
141 * must be added after NUM_FILTER_MODES. */
142 enum { SHOW_ALL, SHOW_SUPPORTED, SHOW_MUSIC, SHOW_PLAYLIST, SHOW_ID3DB,
143 NUM_FILTER_MODES,
144 SHOW_WPS, SHOW_RWPS, SHOW_FMR, SHOW_CFG, SHOW_LNG, SHOW_MOD, SHOW_FONT, SHOW_PLUGINS};
146 /* file and dir sort options */
147 enum { SORT_ALPHA, SORT_DATE, SORT_DATE_REVERSED, SORT_TYPE, /* available as settings */
148 SORT_ALPHA_REVERSED, SORT_TYPE_REVERSED }; /* internal use only */
149 enum { SORT_INTERPRET_AS_DIGIT, SORT_INTERPRET_AS_NUMBER };
151 /* recursive dir insert options */
152 enum { RECURSE_OFF, RECURSE_ON, RECURSE_ASK };
154 /* replaygain types */
155 enum { REPLAYGAIN_TRACK = 0, REPLAYGAIN_ALBUM, REPLAYGAIN_SHUFFLE, REPLAYGAIN_OFF };
157 /* show path types */
158 enum { SHOW_PATH_OFF = 0, SHOW_PATH_CURRENT, SHOW_PATH_FULL };
160 /* scrollbar visibility/position */
161 enum { SCROLLBAR_OFF = 0, SCROLLBAR_LEFT, SCROLLBAR_RIGHT };
163 /* Alarm settings */
164 #ifdef HAVE_RTC_ALARM
165 enum { ALARM_START_WPS = 0,
166 #if CONFIG_TUNER
167 ALARM_START_FM,
168 #endif
169 #ifdef HAVE_RECORDING
170 ALARM_START_REC,
171 #endif
172 ALARM_START_COUNT
174 #if CONFIG_TUNER && defined(HAVE_RECORDING)
175 #define ALARM_SETTING_TEXT "wps,fm,rec"
176 #elif CONFIG_TUNER
177 #define ALARM_SETTING_TEXT "wps,fm"
178 #elif defined(HAVE_RECORDING)
179 #define ALARM_SETTING_TEXT "wps,rec"
180 #endif
182 #endif /* HAVE_RTC_ALARM */
184 /* Keyclick stuff */
186 /* Not really a setting but several files should stay synced */
187 #define KEYCLICK_DURATION 2
189 /** virtual pointer stuff.. move to another .h maybe? **/
190 /* These define "virtual pointers", which could either be a literal string,
191 or a mean a string ID if the pointer is in a certain range.
192 This helps to save space for menus and options. */
194 #define VIRT_SIZE 0xFFFF /* more than enough for our string ID range */
195 #if CONFIG_CPU==DM320
196 /* the DM320 has IRAM at 0, so we use 0xffff bytes right after that */
197 #define VIRT_PTR ((unsigned char*)0x4000)
198 #else
199 /* a location where we won't store strings, 0 is the fastest */
200 #define VIRT_PTR ((unsigned char*)0)
201 #endif
203 /* form a "virtual pointer" out of a language ID */
204 #define ID2P(id) (VIRT_PTR + id)
206 /* resolve a pointer which could be a virtualized ID or a literal */
207 #define P2STR(p) (char *)((p>=VIRT_PTR && p<VIRT_PTR+VIRT_SIZE) ? str(p-VIRT_PTR) : p)
209 /* get the string ID from a virtual pointer, -1 if not virtual */
210 #define P2ID(p) ((p>=VIRT_PTR && p<VIRT_PTR+VIRT_SIZE) ? p-VIRT_PTR : -1)
212 /* !defined(HAVE_LCD_COLOR) implies HAVE_LCD_CONTRAST with default 40.
213 Explicitly define HAVE_LCD_CONTRAST in config file for newer ports for
214 simplicity. */
218 /** function prototypes **/
220 /* argument bits for settings_load() */
221 #define SETTINGS_RTC (BIT_N(0)) /* only the settings from the RTC nonvolatile RAM */
222 #define SETTINGS_HD (BIT_N(1)) /* only the settings from the disk sector */
223 #define SETTINGS_ALL (SETTINGS_RTC|SETTINGS_HD) /* both */
224 void settings_load(int which);
225 bool settings_load_config(const char* file, bool apply);
227 void status_save(void);
228 int settings_save(void);
229 /* defines for the options paramater */
230 enum {
231 SETTINGS_SAVE_CHANGED = 0,
232 SETTINGS_SAVE_ALL,
233 SETTINGS_SAVE_THEME,
234 SETTINGS_SAVE_SOUND,
235 #ifdef HAVE_RECORDING
236 SETTINGS_SAVE_RECPRESETS,
237 #endif
238 #if CONFIG_CODEC == SWCODEC
239 SETTINGS_SAVE_EQPRESET,
240 #endif
242 bool settings_save_config(int options);
244 struct settings_list;
245 void reset_setting(const struct settings_list *setting, void *var);
246 void settings_reset(void);
247 void sound_settings_apply(void);
249 /* call this after loading a .wps/.rwps pr other skin files, so that the
250 * skin buffer is reset properly
252 void settings_apply_skins(void);
254 void settings_apply(bool read_disk);
255 void settings_apply_pm_range(void);
256 void settings_display(void);
258 enum optiontype { INT, BOOL };
260 const struct settings_list* find_setting(const void* variable, int *id);
261 bool cfg_int_to_string(int setting_id, int val, char* buf, int buf_len);
262 bool cfg_to_string(int setting_id, char* buf, int buf_len);
263 bool set_bool_options(const char* string, const bool* variable,
264 const char* yes_str, int yes_voice,
265 const char* no_str, int no_voice,
266 void (*function)(bool));
268 bool set_bool(const char* string, const bool* variable);
269 bool set_int(const unsigned char* string, const char* unit, int voice_unit,
270 const int* variable,
271 void (*function)(int), int step, int min, int max,
272 const char* (*formatter)(char*, size_t, int, const char*) );
274 /* use this one if you need to create a lang from the value (i.e with TALK_ID()) */
275 bool set_int_ex(const unsigned char* string, const char* unit, int voice_unit,
276 const int* variable,
277 void (*function)(int), int step, int min, int max,
278 const char* (*formatter)(char*, size_t, int, const char*),
279 int32_t (*get_talk_id)(int, int));
281 void set_file(const char* filename, char* setting, int maxlen);
283 bool set_option(const char* string, const void* variable, enum optiontype type,
284 const struct opt_items* options, int numoptions, void (*function)(int));
288 /** global_settings and global_status struct definitions **/
290 struct system_status
292 int resume_index; /* index in playlist (-1 for no active resume) */
293 uint32_t resume_offset; /* byte offset in mp3 file */
294 int runtime; /* current runtime since last charge */
295 int topruntime; /* top known runtime */
296 #ifdef HAVE_DIRCACHE
297 int dircache_size; /* directory cache structure last size, 22 bits */
298 #endif
299 #if CONFIG_TUNER
300 int last_frequency; /* Last frequency for resuming, in FREQ_STEP units,
301 relative to MIN_FREQ */
302 #endif
303 signed char last_screen;
304 int viewer_icon_count;
307 struct user_settings
309 /* audio settings */
311 int volume; /* audio output volume in decibels range depends on the dac */
312 int balance; /* stereo balance: 0-100 0=left 50=bal 100=right */
313 int bass; /* bass boost/cut in decibels */
314 int treble; /* treble boost/cut in decibels */
315 int channel_config; /* Stereo, Mono, Custom, Mono left, Mono right, Karaoke */
316 int stereo_width; /* 0-255% */
318 #if CONFIG_CODEC != SWCODEC
319 int loudness; /* loudness eq: 0-100 0=off 100=max */
320 int avc; /* auto volume correct: 0=off, 1=20ms, 2=2s 3=4s 4=8s */
321 int mdb_strength; /* 0-127dB */
322 int mdb_harmonics; /* 0-100% */
323 int mdb_center; /* 20-300Hz */
324 int mdb_shape; /* 50-300Hz */
325 bool mdb_enable; /* true/false */
326 bool superbass; /* true/false */
327 #endif
329 #ifdef HAVE_WM8758
330 int bass_cutoff;
331 int treble_cutoff;
332 #endif
334 #if CONFIG_CODEC == SWCODEC
335 /* Crossfade */
336 int crossfade; /* Enable crossfade (0=off, 1=shuffle, 2=trackskip,
337 3=shuff&trackskip, 4=always) */
338 int crossfade_fade_in_delay; /* Fade in delay (0-15s) */
339 int crossfade_fade_out_delay; /* Fade out delay (0-15s) */
340 int crossfade_fade_in_duration; /* Fade in duration (0-15s) */
341 int crossfade_fade_out_duration; /* Fade out duration (0-15s) */
342 int crossfade_fade_out_mixmode; /* Fade out mode (0=crossfade,1=mix) */
344 /* Replaygain */
345 bool replaygain_noclip; /* scale to prevent clips */
346 int replaygain_type; /* 0=track gain, 1=album gain, 2=track gain if
347 shuffle is on, album gain otherwise, 4=off */
348 int replaygain_preamp; /* scale replaygained tracks by this */
350 /* Crossfeed */
351 bool crossfeed; /* enable crossfeed */
352 unsigned int crossfeed_direct_gain; /* dB x 10 */
353 unsigned int crossfeed_cross_gain; /* dB x 10 */
354 unsigned int crossfeed_hf_attenuation; /* dB x 10 */
355 unsigned int crossfeed_hf_cutoff; /* Frequency in Hz */
357 /* EQ */
358 bool eq_enabled; /* Enable equalizer */
359 unsigned int eq_precut; /* dB */
361 /* Order is important here, must be cutoff, q, then gain for each band.
362 See dsp_set_eq_coefs in dsp.c for why. */
364 /* Band 0 settings */
365 int eq_band0_cutoff; /* Hz */
366 int eq_band0_q;
367 int eq_band0_gain; /* +/- dB */
369 /* Band 1 settings */
370 int eq_band1_cutoff; /* Hz */
371 int eq_band1_q;
372 int eq_band1_gain; /* +/- dB */
374 /* Band 2 settings */
375 int eq_band2_cutoff; /* Hz */
376 int eq_band2_q;
377 int eq_band2_gain; /* +/- dB */
379 /* Band 3 settings */
380 int eq_band3_cutoff; /* Hz */
381 int eq_band3_q;
382 int eq_band3_gain; /* +/- dB */
384 /* Band 4 settings */
385 int eq_band4_cutoff; /* Hz */
386 int eq_band4_q;
387 int eq_band4_gain; /* +/- dB */
389 /* Misc. swcodec */
390 int beep; /* system beep volume when changing tracks etc. */
391 int keyclick; /* keyclick volume */
392 int keyclick_repeats; /* keyclick on repeats */
393 bool dithering_enabled;
394 bool timestretch_enabled;
395 #endif /* CONFIG_CODEC == SWCODEC */
397 #ifdef HAVE_RECORDING
398 #if CONFIG_CODEC == SWCODEC
399 int rec_format; /* record format index */
400 int rec_mono_mode; /* how to create mono: L, R, L+R */
402 /* Encoder Settings Start - keep these together */
403 struct mp3_enc_config mp3_enc_config;
404 #if 0 /* These currently contain no members but their places in line
405 should be held */
406 struct aiff_enc_config aiff_enc_config;
407 struct wav_enc_config wav_enc_config;
408 struct wavpack_enc_config wavpack_enc_config;
409 #endif
410 /* Encoder Settings End */
412 #else
413 int rec_quality; /* 0-7 */
414 #endif /* CONFIG_CODEC == SWCODEC */
415 int rec_source; /* 0=mic, 1=line, 2=S/PDIF, 2 or 3=FM Radio */
416 int rec_frequency; /* 0 = 44.1kHz (depends on target)
417 1 = 48kHz
418 2 = 32kHz
419 3 = 22.05kHz
420 4 = 24kHz
421 5 = 16kHz */
422 int rec_channels; /* 0=Stereo, 1=Mono */
424 int rec_mic_gain; /* depends on target */
425 int rec_left_gain; /* depends on target */
426 int rec_right_gain; /* depends on target */
427 bool peak_meter_clipcounter; /* clipping count indicator */
428 bool rec_editable; /* true means that the bit reservoir is off */
430 /* note: timesplit setting is not saved */
431 int rec_timesplit; /* 0 = off,
432 1 = 00:05, 2 = 00:10, 3 = 00:15, 4 = 00:30
433 5 = 01:00, 6 = 02:00, 7 = 04:00, 8 = 06:00
434 9 = 08:00, 10= 10:00, 11= 12:00, 12= 18:00,
435 13= 24:00 */
436 int rec_sizesplit; /* 0 = off,
437 1 = 5MB, 2 = 10MB, 3 = 15MB, 4 = 32MB
438 5 = 64MB, 6 = 75MB, 7 = 100MB, 8 = 128MB
439 9 = 256MB, 10= 512MB, 11= 650MB, 12= 700MB,
440 13= 1GB, 14 = 1.5GB 15 = 1.75MB*/
441 int rec_split_type; /* split/stop */
442 int rec_split_method; /* time/filesize */
444 int rec_prerecord_time; /* In seconds, 0-30, 0 means OFF */
445 char rec_directory[MAX_FILENAME+1];
446 int cliplight; /* 0 = off
447 1 = main lcd
448 2 = main and remote lcd
449 3 = remote lcd */
451 int rec_start_thres_db;
452 int rec_start_thres_linear;
453 int rec_start_duration; /* index of trig_durations */
454 int rec_stop_thres_db;
455 int rec_stop_thres_linear;
456 int rec_stop_postrec;
457 int rec_stop_gap; /* index of trig_durations */
458 int rec_trigger_mode; /* see TRIG_MODE_XXX constants */
459 int rec_trigger_type; /* what to do when trigger released */
461 #ifdef HAVE_AGC
462 int rec_agc_preset_mic; /* AGC mic preset modes:
463 0 = Off
464 1 = Safety (clip)
465 2 = Live (slow)
466 3 = DJ-Set (slow)
467 4 = Medium
468 5 = Voice (fast) */
469 int rec_agc_preset_line; /* AGC line-in preset modes:
470 0 = Off
471 1 = Safety (clip)
472 2 = Live (slow)
473 3 = DJ-Set (slow)
474 4 = Medium
475 5 = Voice (fast) */
476 int rec_agc_maxgain_mic; /* AGC maximum mic gain */
477 int rec_agc_maxgain_line; /* AGC maximum line-in gain */
478 int rec_agc_cliptime; /* 0.2, 0.4, 0.6, 0.8, 1s */
479 #endif
480 #endif /* HAVE_RECORDING */
482 #if CONFIG_TUNER
483 int fm_region;
484 bool fm_force_mono; /* Forces Mono mode if true */
485 unsigned char fmr_file[MAX_FILENAME+1]; /* last fmr preset */
486 #endif
488 /* misc options */
489 #ifndef HAVE_WHEEL_ACCELERATION
490 int list_accel_start_delay; /* ms before we start increaseing step size */
491 int list_accel_wait; /* ms between increases */
492 #endif
494 #ifdef HAVE_TOUCHPAD_SENSITIVITY_SETTING
495 int touchpad_sensitivity;
496 #endif
498 #ifdef HAVE_HEADPHONE_DETECTION
499 int unplug_mode; /* pause on headphone unplug */
500 int unplug_rw; /* time in s to rewind when pausing */
501 bool unplug_autoresume; /* disable auto-resume if no phones */
502 #endif
504 #ifdef HAVE_QUICKSCREEN
505 /* these are split because settings_list cant handle arrays */
506 int qs_item_left;
507 int qs_item_right;
508 int qs_item_bottom;
509 #endif
511 #if CONFIG_RTC
512 int timeformat; /* time format: 0=24 hour clock, 1=12 hour clock */
513 #endif
515 #ifdef HAVE_DISK_STORAGE
516 int disk_spindown; /* time until disk spindown, in seconds (0=off) */
517 int buffer_margin; /* audio buffer watermark margin, in seconds */
518 #endif
520 int dirfilter; /* 0=display all, 1=only supported, 2=only music,
521 3=dirs+playlists, 4=ID3 database */
522 int show_filename_ext; /* show filename extensions in file browser?
523 0 = no, 1 = yes, 2 = only unknown 0 */
524 int default_codepage; /* set default codepage for tag conversion */
525 bool hold_lr_for_scroll_in_list; /* hold L/R scrolls the list left/right */
526 bool play_selected; /* Plays selected file even in shuffle mode */
527 bool party_mode; /* party mode - unstoppable music */
528 bool audioscrobbler; /* Audioscrobbler logging */
529 bool cuesheet;
530 bool car_adapter_mode; /* 0=off 1=on */
531 int start_in_screen;
532 #if defined(HAVE_RTC_ALARM) && \
533 (defined(HAVE_RECORDING) || CONFIG_TUNER)
534 int alarm_wake_up_screen;
535 #endif
536 int ff_rewind_min_step; /* FF/Rewind minimum step size */
537 int ff_rewind_accel; /* FF/Rewind acceleration (in seconds per doubling) */
539 int peak_meter_release; /* units per read out */
540 int peak_meter_hold; /* hold time for peak meter in 1/100 s */
541 int peak_meter_clip_hold; /* hold time for clips */
542 bool peak_meter_dbfs; /* show linear or dbfs values */
543 int peak_meter_min; /* range minimum */
544 int peak_meter_max; /* range maximum */
546 unsigned char wps_file[MAX_FILENAME+1]; /* last wps */
547 unsigned char lang_file[MAX_FILENAME+1]; /* last language */
548 unsigned char playlist_catalog_dir[MAX_FILENAME+1];
549 int skip_length; /* skip length */
550 int max_files_in_dir; /* Max entries in directory (file browser) */
551 int max_files_in_playlist; /* Max entries in playlist */
552 int volume_type; /* how volume is displayed: 0=graphic, 1=percent */
553 int battery_display; /* how battery is displayed: 0=graphic, 1=percent */
554 bool show_icons; /* 0=hide 1=show */
555 enum statusbar_values statusbar; /* STATUSBAR_* enum values */
556 #ifdef HAVE_REMOTE_LCD
557 enum statusbar_values remote_statusbar;
558 #endif
560 #if CONFIG_KEYPAD == RECORDER_PAD
561 bool buttonbar; /* 0=hide, 1=show */
562 #endif
564 #ifdef HAVE_LCD_BITMAP
565 int scrollbar; /* SCROLLBAR_* enum values */
566 int scrollbar_width;
567 #endif
569 /* goto current song when exiting WPS */
570 bool browse_current; /* 1=goto current song,
571 0=goto previous location */
572 bool scroll_paginated; /* 0=dont 1=do */
573 int scroll_speed; /* long texts scrolling speed: 1-30 */
574 int bidir_limit; /* bidir scroll length limit */
575 int scroll_delay; /* delay (in 1/10s) before starting scroll */
576 int scroll_step; /* pixels to advance per update */
578 /* auto bookmark settings */
579 int autoloadbookmark; /* auto load option: 0=off, 1=ask, 2=on */
580 int autocreatebookmark; /* auto create option: 0=off, 1=ask, 2=on */
581 int usemrb; /* use MRB list: 0=No, 1=Yes*/
583 #ifdef HAVE_DIRCACHE
584 bool dircache; /* enable directory cache */
585 #endif
586 #ifdef HAVE_TAGCACHE
587 #ifdef HAVE_TC_RAMCACHE
588 bool tagcache_ram; /* load tagcache to ram? */
589 #endif
590 bool tagcache_autoupdate; /* automatically keep tagcache in sync? */
591 bool runtimedb; /* runtime database active? */
592 #endif /* HAVE_TAGCACHE */
594 #if LCD_DEPTH > 1
595 unsigned char backdrop_file[MAX_FILENAME+1]; /* backdrop bitmap file */
596 #endif
598 #ifdef HAVE_LCD_COLOR
599 int bg_color; /* background color native format */
600 int fg_color; /* foreground color native format */
601 int lss_color; /* background color for the selector or start color for the gradient */
602 int lse_color; /* end color for the selector gradient */
603 int lst_color; /* color of the text for the selector */
604 unsigned char colors_file[MAX_FILENAME+1];
605 #endif
607 /* playlist/playback settings */
608 int repeat_mode; /* 0=off 1=repeat all 2=repeat one 3=shuffle 4=ab */
609 int next_folder; /* move to next folder */
610 int recursive_dir_insert; /* should directories be inserted recursively */
611 bool fade_on_stop; /* fade on pause/unpause/stop */
612 bool playlist_shuffle;
613 bool warnon_erase_dynplaylist; /* warn when erasing dynamic playlist */
615 /* playlist viewer settings */
616 bool playlist_viewer_icons; /* display icons on viewer */
617 bool playlist_viewer_indices; /* display playlist indices on viewer */
618 int playlist_viewer_track_display; /* how to display tracks in viewer */
620 /* voice UI settings */
621 bool talk_menu; /* enable voice UI */
622 int talk_dir; /* voiced directories mode: 0=off 1=number 2=spell */
623 bool talk_dir_clip; /* use directory .talk clips */
624 int talk_file; /* voice file mode: 0=off, 1=number, 2=spell */
625 bool talk_file_clip; /* use file .talk clips */
626 bool talk_filetype; /* say file type */
627 bool talk_battery_level;
629 /* file browser sorting */
630 bool sort_case; /* dir sort order: 0=case insensitive, 1=sensitive */
631 int sort_dir; /* 0=alpha, 1=date (old first), 2=date (new first) */
632 int sort_file; /* 0=alpha, 1=date, 2=date (new first), 3=type */
633 int interpret_numbers; /* true=strnatcmp, false=strcmp */
635 /* power settings */
636 int poweroff; /* idle power off timer */
637 int battery_capacity; /* in mAh */
639 #if BATTERY_TYPES_COUNT > 1
640 int battery_type; /* for units which can take multiple types (Ondio). */
641 #endif
642 #ifdef HAVE_SPDIF_POWER
643 bool spdif_enable; /* S/PDIF power on/off */
644 #endif
645 #ifdef HAVE_USB_CHARGING_ENABLE
646 bool usb_charging;
647 #endif
649 /* device settings */
650 #ifdef HAVE_LCD_CONTRAST
651 int contrast; /* lcd contrast */
652 #endif
654 #ifdef HAVE_LCD_BITMAP
655 #ifdef HAVE_LCD_INVERT
656 bool invert; /* invert display */
657 #endif
658 #ifdef HAVE_LCD_FLIP
659 bool flip_display; /* turn display (and button layout) by 180 degrees */
660 #endif
661 int cursor_style; /* style of the selection cursor */
662 int screen_scroll_step;
663 int show_path_in_browser; /* 0=off, 1=current directory, 2=full path */
664 bool offset_out_of_view;
665 unsigned char icon_file[MAX_FILENAME+1];
666 unsigned char viewers_icon_file[MAX_FILENAME+1];
667 unsigned char font_file[MAX_FILENAME+1]; /* last font */
668 unsigned char kbd_file[MAX_FILENAME+1]; /* last keyboard */
669 #endif /* HAVE_LCD_BITMAP */
671 #ifdef HAVE_LCD_CHARCELLS
672 int jump_scroll; /* Fast jump when scrolling */
673 int jump_scroll_delay; /* Delay between jump scroll screens */
674 #endif
676 int backlight_timeout; /* backlight off timeout: 0-18 0=never,
677 1=always,
678 then according to timeout_values[] */
679 bool caption_backlight; /* turn on backlight at end and start of track */
680 bool bl_filter_first_keypress; /* filter first keypress when dark? */
681 #if CONFIG_CHARGING
682 int backlight_timeout_plugged;
683 #endif
684 #ifdef HAVE_BACKLIGHT
685 #ifdef HAS_BUTTON_HOLD
686 int backlight_on_button_hold; /* what to do with backlight when hold
687 switch is on */
688 #endif
689 #ifdef HAVE_LCD_SLEEP_SETTING
690 int lcd_sleep_after_backlight_off; /* when to put lcd to sleep after backlight
691 has turned off */
692 #endif
693 #endif
694 #if defined(HAVE_BACKLIGHT_FADING_INT_SETTING)
695 int backlight_fade_in; /* backlight fade in timing: 0..3 */
696 int backlight_fade_out; /* backlight fade in timing: 0..7 */
697 #elif defined(HAVE_BACKLIGHT_FADING_BOOL_SETTING)
698 bool backlight_fade_in;
699 bool backlight_fade_out;
700 #endif
701 #ifdef HAVE_BACKLIGHT_BRIGHTNESS
702 int brightness;
703 #endif
705 #ifdef HAVE_REMOTE_LCD
706 /* remote lcd */
707 int remote_contrast; /* lcd contrast: 0-63 0=low 63=high */
708 int remote_backlight_timeout; /* backlight off timeout: 0-18 0=never,
709 1=always, then according to timeout_values[] */
710 int remote_backlight_timeout_plugged;
711 int remote_scroll_speed; /* long texts scrolling speed: 1-30 */
712 int remote_scroll_delay; /* delay (in 1/10s) before starting scroll */
713 int remote_scroll_step; /* pixels to advance per update */
714 int remote_bidir_limit; /* bidir scroll length limit */
715 bool remote_invert; /* invert display */
716 bool remote_flip_display; /* turn display (and button layout) by 180 degrees */
717 bool remote_caption_backlight; /* turn on backlight at end and start of track */
718 bool remote_bl_filter_first_keypress; /* filter first remote keypress when remote dark? */
719 unsigned char remote_icon_file[MAX_FILENAME+1];
720 unsigned char remote_viewers_icon_file[MAX_FILENAME+1];
721 unsigned char rwps_file[MAX_FILENAME+1]; /* last remote-wps */
722 #ifdef HAS_REMOTE_BUTTON_HOLD
723 int remote_backlight_on_button_hold; /* what to do with remote backlight when hold
724 switch is on */
725 #endif
726 #ifdef HAVE_REMOTE_LCD_TICKING
727 bool remote_reduce_ticking; /* 0=normal operation,
728 1=EMI reduce on with cost more CPU. */
729 #endif
730 #endif /* HAVE_REMOTE_LCD */
732 #if CONFIG_CODEC == MAS3507D
733 bool line_in; /* false=off, true=active */
734 #endif
736 #ifdef HAVE_BUTTON_LIGHT
737 int buttonlight_timeout;
738 #endif
739 #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
740 int buttonlight_brightness;
741 #endif
743 #ifdef IPOD_ACCESSORY_PROTOCOL
744 int serial_bitrate; /* 0=auto 1=9600 2=19200 3=38400 4=57600 */
745 #endif
746 #ifdef HAVE_ACCESSORY_SUPPLY
747 bool accessory_supply; /* 0=off 1=on, accessory power supply for iPod */
748 #endif
750 #ifdef HAVE_SPEAKER
751 bool speaker_enabled;
752 #endif
753 bool prevent_skip;
755 #ifdef HAVE_TOUCHSCREEN
756 int touch_mode;
757 struct touchscreen_parameter ts_calibration_data;
758 #endif
760 #ifdef HAVE_PITCHSCREEN
761 /* pitch screen settings */
762 bool pitch_mode_semitone;
763 #if CONFIG_CODEC == SWCODEC
764 bool pitch_mode_timestretch;
765 #endif
766 #endif
767 /* If values are just added to the end, no need to bump plugin API
768 version. */
769 /* new stuff to be added at the end */
771 #ifdef HAVE_LCD_BITMAP
772 unsigned char ui_vp_config[64]; /* viewport string for the lists */
773 #ifdef HAVE_REMOTE_LCD
774 unsigned char remote_ui_vp_config[64]; /* viewport string for the remote lists */
775 #endif
776 #endif
778 #if CONFIG_CODEC == SWCODEC
779 int limiter_level;
780 #endif
784 /** global variables **/
785 extern long lasttime;
786 /* global settings */
787 extern struct user_settings global_settings;
788 /* global status */
789 extern struct system_status global_status;
791 #endif /* __SETTINGS_H__ */