Use size_t type for the buffer_size parameter to formatter functions, static two...
[Rockbox.git] / apps / settings.h
blob0dd21a33eb9ffed8e6632fd9cb38591bbdba8509
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2002 by wavey@wavey.org
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 /** Setting values defines **/
44 /* name of directory where configuration, fonts and other data
45 * files are stored */
46 #ifdef __PCTOOL__
47 #define ROCKBOX_DIR "."
48 #define ROCKBOX_DIR_LEN 1
49 #else
50 #define ROCKBOX_DIR "/.rockbox"
51 #define ROCKBOX_DIR_LEN 9
52 #endif
54 #define FONT_DIR ROCKBOX_DIR "/fonts"
55 #define LANG_DIR ROCKBOX_DIR "/langs"
56 #define WPS_DIR ROCKBOX_DIR "/wps"
57 #define THEME_DIR ROCKBOX_DIR "/themes"
58 #define ICON_DIR ROCKBOX_DIR "/icons"
60 #define PLUGIN_DIR ROCKBOX_DIR "/rocks"
61 #define PLUGIN_GAMES_DIR PLUGIN_DIR "/games"
62 #define PLUGIN_APPS_DIR PLUGIN_DIR "/apps"
63 #define PLUGIN_DEMOS_DIR PLUGIN_DIR "/demos"
64 #define VIEWERS_DIR PLUGIN_DIR "/viewers"
66 #define BACKDROP_DIR ROCKBOX_DIR "/backdrops"
67 #define REC_BASE_DIR "/"
68 #define EQS_DIR ROCKBOX_DIR "/eqs"
69 #define CODECS_DIR ROCKBOX_DIR "/codecs"
70 #define RECPRESETS_DIR ROCKBOX_DIR "/recpresets"
71 #define FMPRESET_PATH ROCKBOX_DIR "/fmpresets"
73 #define VIEWERS_CONFIG ROCKBOX_DIR "/viewers.config"
74 #define CONFIGFILE ROCKBOX_DIR "/config.cfg"
75 #define FIXEDSETTINGSFILE ROCKBOX_DIR "/fixed.cfg"
77 #define MAX_FILENAME 32
80 #define BOOKMARK_NO 0
81 #define BOOKMARK_YES 1
82 #define BOOKMARK_ASK 2
83 #define BOOKMARK_UNIQUE_ONLY 2
84 #define BOOKMARK_RECENT_ONLY_YES 3
85 #define BOOKMARK_RECENT_ONLY_ASK 4
86 #define FF_REWIND_1000 0
87 #define FF_REWIND_2000 1
88 #define FF_REWIND_3000 2
89 #define FF_REWIND_4000 3
90 #define FF_REWIND_5000 4
91 #define FF_REWIND_6000 5
92 #define FF_REWIND_8000 6
93 #define FF_REWIND_10000 7
94 #define FF_REWIND_15000 8
95 #define FF_REWIND_20000 9
96 #define FF_REWIND_25000 10
97 #define FF_REWIND_30000 11
98 #define FF_REWIND_45000 12
99 #define FF_REWIND_60000 13
101 #define TRIG_MODE_OFF 0
102 #define TRIG_MODE_NOREARM 1
103 #define TRIG_MODE_REARM 2
105 #define TRIG_DURATION_COUNT 13
106 extern const char * const trig_durations[TRIG_DURATION_COUNT];
108 #define CROSSFADE_ENABLE_SHUFFLE 1
109 #define CROSSFADE_ENABLE_TRACKSKIP 2
110 #define CROSSFADE_ENABLE_SHUFFLE_AND_TRACKSKIP 3
111 #define CROSSFADE_ENABLE_ALWAYS 4
113 #define FOLDER_ADVANCE_OFF 0
114 #define FOLDER_ADVANCE_NEXT 1
115 #define FOLDER_ADVANCE_RANDOM 2
117 /* system defines */
118 #ifndef TARGET_TREE
120 #ifndef HAVE_LCD_COLOR
121 #define DEFAULT_CONTRAST_SETTING 40
122 #endif
124 #if defined HAVE_LCD_CHARCELLS
125 #define MIN_CONTRAST_SETTING 5
126 #define MAX_CONTRAST_SETTING 31
127 #else
128 #define MIN_CONTRAST_SETTING 5
129 #define MAX_CONTRAST_SETTING 63
130 #endif
132 /* As it was */
133 #ifdef HAVE_REMOTE_LCD
134 #ifndef DEFAULT_REMOTE_CONTRAST_SETTING
135 /* May be defined in config file if driver code needs the value */
136 #define DEFAULT_REMOTE_CONTRAST_SETTING 42
137 #endif
138 #define MIN_REMOTE_CONTRAST_SETTING MIN_CONTRAST_SETTING
139 #define MAX_REMOTE_CONTRAST_SETTING MAX_CONTRAST_SETTING
140 #endif
142 #endif /* !TARGET_TREE */
144 #if !defined(HAVE_LCD_COLOR)
145 #define HAVE_LCD_CONTRAST
146 #endif
148 /* repeat mode options */
149 enum
151 REPEAT_OFF,
152 REPEAT_ALL,
153 REPEAT_ONE,
154 REPEAT_SHUFFLE,
155 #ifdef AB_REPEAT_ENABLE
156 REPEAT_AB,
157 #endif
158 NUM_REPEAT_MODES
161 /* dir filter options */
162 /* Note: Any new filter modes need to be added before NUM_FILTER_MODES.
163 * Any new rockbox browse filter modes (accessible through the menu)
164 * must be added after NUM_FILTER_MODES. */
165 enum { SHOW_ALL, SHOW_SUPPORTED, SHOW_MUSIC, SHOW_PLAYLIST, SHOW_ID3DB,
166 NUM_FILTER_MODES,
167 SHOW_WPS, SHOW_RWPS, SHOW_FMR, SHOW_CFG, SHOW_LNG, SHOW_MOD, SHOW_FONT, SHOW_PLUGINS};
169 /* recursive dir insert options */
170 enum { RECURSE_OFF, RECURSE_ON, RECURSE_ASK };
172 /* replaygain types */
173 enum { REPLAYGAIN_TRACK = 0, REPLAYGAIN_ALBUM, REPLAYGAIN_SHUFFLE };
175 /* show path types */
176 enum { SHOW_PATH_OFF = 0, SHOW_PATH_CURRENT, SHOW_PATH_FULL };
178 /* Alarm settings */
179 #ifdef HAVE_RTC_ALARM
180 enum { ALARM_START_WPS = 0,
181 #if CONFIG_TUNER
182 ALARM_START_FM,
183 #endif
184 #ifdef HAVE_RECORDING
185 ALARM_START_REC,
186 #endif
187 ALARM_START_COUNT
189 #if CONFIG_TUNER && defined(HAVE_RECORDING)
190 #define ALARM_SETTING_TEXT "wps,fm,rec"
191 #elif CONFIG_TUNER
192 #define ALARM_SETTING_TEXT "wps,fm"
193 #elif defined(HAVE_RECORDING)
194 #define ALARM_SETTING_TEXT "wps,rec"
195 #endif
197 #endif /* HAVE_RTC_ALARM */
198 /** virtual pointer stuff.. move to another .h maybe? **/
199 /* These define "virtual pointers", which could either be a literal string,
200 or a mean a string ID if the pointer is in a certain range.
201 This helps to save space for menus and options. */
203 #define VIRT_SIZE 0xFFFF /* more than enough for our string ID range */
204 #ifdef SIMULATOR
205 /* a space which is defined in stubs.c */
206 extern unsigned char vp_dummy[VIRT_SIZE];
207 #define VIRT_PTR vp_dummy
208 #else
209 /* a location where we won't store strings, 0 is the fastest */
210 #define VIRT_PTR ((unsigned char*)0)
211 #endif
213 /* form a "virtual pointer" out of a language ID */
214 #define ID2P(id) (VIRT_PTR + id)
216 /* resolve a pointer which could be a virtualized ID or a literal */
217 #define P2STR(p) (char *)((p>=VIRT_PTR && p<=VIRT_PTR+VIRT_SIZE) ? str(p-VIRT_PTR) : p)
219 /* get the string ID from a virtual pointer, -1 if not virtual */
220 #define P2ID(p) ((p>=VIRT_PTR && p<=VIRT_PTR+VIRT_SIZE) ? p-VIRT_PTR : -1)
222 /* !defined(HAVE_LCD_COLOR) implies HAVE_LCD_CONTRAST with default 40.
223 Explicitly define HAVE_LCD_CONTRAST in config file for newer ports for
224 simplicity. */
228 /** function prototypes **/
230 /* argument bits for settings_load() */
231 #define SETTINGS_RTC 1 /* only the settings from the RTC nonvolatile RAM */
232 #define SETTINGS_HD 2 /* only the settings from the disk sector */
233 #define SETTINGS_ALL 3 /* both */
234 void settings_load(int which);
235 bool settings_load_config(const char* file, bool apply);
237 void status_save( void );
238 int settings_save(void);
239 /* defines for the options paramater */
240 enum {
241 SETTINGS_SAVE_CHANGED = 0,
242 SETTINGS_SAVE_ALL,
243 SETTINGS_SAVE_THEME,
244 #ifdef HAVE_RECORDING
245 SETTINGS_SAVE_RECPRESETS,
246 #endif
248 bool settings_save_config(int options);
250 void settings_reset(void);
251 void sound_settings_apply(void);
252 void settings_apply(void);
253 void settings_apply_pm_range(void);
254 void settings_display(void);
256 enum optiontype { INT, BOOL };
258 struct opt_items {
259 unsigned const char* string;
260 long voice_id;
262 const struct settings_list* find_setting(void* variable, int *id);
263 bool cfg_int_to_string(int setting_id, int val, char* buf, int buf_len);
264 void talk_setting(void *global_settings_variable);
265 bool set_sound(const unsigned char * string,
266 int* variable, int setting);
267 bool set_bool_options(const char* string, bool* variable,
268 const char* yes_str, int yes_voice,
269 const char* no_str, int no_voice,
270 void (*function)(bool));
272 bool set_bool(const char* string, bool* variable );
273 bool set_option(const char* string, void* variable, enum optiontype type,
274 const struct opt_items* options, int numoptions, void (*function)(int));
275 bool set_int(const unsigned char* string, const char* unit, int voice_unit,
276 int* variable,
277 void (*function)(int), int step, int min, int max,
278 void (*formatter)(char*, size_t, int, const char*) );
279 /* use this one if you need to create a lang from the value (i.e with TALK_ID()) */
280 bool set_int_ex(const unsigned char* string, const char* unit, int voice_unit,
281 int* variable,
282 void (*function)(int), int step, int min, int max,
283 void (*formatter)(char*, size_t, int, const char*),
284 long (*get_talk_id)(int));
286 /* the following are either not in setting.c or shouldnt be */
287 bool set_time_screen(const char* string, struct tm *tm);
288 int read_line(int fd, char* buffer, int buffer_size);
289 void set_file(char* filename, char* setting, int maxlen);
292 /** global_settings and global_status struct definitions **/
294 struct system_status
296 int resume_index; /* index in playlist (-1 for no active resume) */
297 int resume_first_index; /* index of first track in playlist */
298 uint32_t resume_offset; /* byte offset in mp3 file */
299 int resume_seed; /* shuffle seed (-1=no resume shuffle 0=sorted
300 >0=shuffled) */
301 int runtime; /* current runtime since last charge */
302 int topruntime; /* top known runtime */
303 #ifdef HAVE_DIRCACHE
304 int dircache_size; /* directory cache structure last size, 22 bits */
305 #endif
306 #if CONFIG_TUNER
307 int last_frequency; /* Last frequency for resuming, in FREQ_STEP units,
308 relative to MIN_FREQ */
309 #endif
310 char last_screen;
311 int viewer_icon_count;
314 struct user_settings
316 /* audio settings */
318 int volume; /* audio output volume: 0-100 0=off 100=max */
319 int balance; /* stereo balance: 0-100 0=left 50=bal 100=right */
320 int bass; /* bass eq: 0-100 0=off 100=max */
321 int treble; /* treble eq: 0-100 0=low 100=high */
322 int loudness; /* loudness eq: 0-100 0=off 100=max */
323 int avc; /* auto volume correct: 0=off, 1=20ms, 2=2s 3=4s 4=8s */
324 int channel_config; /* Stereo, Mono, Custom, Mono left, Mono right, Karaoke */
325 int stereo_width; /* 0-255% */
326 int mdb_strength; /* 0-127dB */
327 int mdb_harmonics; /* 0-100% */
328 int mdb_center; /* 20-300Hz */
329 int mdb_shape; /* 50-300Hz */
330 bool mdb_enable; /* true/false */
331 bool superbass; /* true/false */
333 #if CONFIG_CODEC == SWCODEC
334 int crossfade; /* Enable crossfade (0=off,1=shuffle,2=trackskip,3=shuff&trackskip,4=always) */
335 int crossfade_fade_in_delay; /* Fade in delay (0-15s) */
336 int crossfade_fade_out_delay; /* Fade out delay (0-15s) */
337 int crossfade_fade_in_duration; /* Fade in duration (0-15s) */
338 int crossfade_fade_out_duration; /* Fade out duration (0-15s) */
339 int crossfade_fade_out_mixmode; /* Fade out mode (0=crossfade,1=mix) */
340 #endif
341 #ifdef HAVE_RECORDING
342 #if CONFIG_CODEC == SWCODEC
343 int rec_format; /* record format index */
344 #else
345 int rec_quality; /* 0-7 */
346 #endif /* CONFIG_CODEC == SWCODEC */
347 int rec_source; /* 0=mic, 1=line, 2=S/PDIF, 2 or 3=FM Radio */
348 int rec_frequency; /* 0 = 44.1kHz (depends on target)
349 1 = 48kHz
350 2 = 32kHz
351 3 = 22.05kHz
352 4 = 24kHz
353 5 = 16kHz */
354 int rec_channels; /* 0=Stereo, 1=Mono */
355 int rec_mic_gain; /* depends on target */
356 int rec_left_gain; /* depends on target */
357 int rec_right_gain; /* depands on target */
358 bool rec_editable; /* true means that the bit reservoir is off */
360 /* note: timesplit setting is not saved */
361 int rec_timesplit; /* 0 = off,
362 1 = 00:05, 2 = 00:10, 3 = 00:15, 4 = 00:30
363 5 = 01:00, 6 = 02:00, 7 = 04:00, 8 = 06:00
364 9 = 08:00, 10= 10:00, 11= 12:00, 12= 18:00,
365 13= 24:00 */
366 int rec_sizesplit; /* 0 = off,
367 1 = 5MB, 2 = 10MB, 3 = 15MB, 4 = 32MB
368 5 = 64MB, 6 = 75MB, 7 = 100MB, 8 = 128MB
369 9 = 256MB, 10= 512MB, 11= 650MB, 12= 700MB,
370 13= 1GB, 14 = 1.5GB 15 = 1.75MB*/
371 int rec_split_type; /* split/stop */
372 int rec_split_method; /* time/filesize */
374 int rec_prerecord_time; /* In seconds, 0-30, 0 means OFF */
375 char rec_directory[MAX_FILENAME+1];
376 int cliplight; /* 0 = off
377 1 = main lcd
378 2 = main and remote lcd
379 3 = remote lcd */
381 int rec_start_thres; /* negative: db, positive: % range -87 .. 100 */
382 int rec_start_duration; /* index of trig_durations */
383 int rec_stop_thres; /* negative: db, positive: % */
384 int rec_stop_postrec; /* negative: db, positive: % range -87 .. 100 */
385 int rec_stop_gap; /* index of trig_durations */
386 int rec_trigger_mode; /* see TRIG_MODE_XXX constants */
387 int rec_trigger_type; /* what to do when trigger released */
389 #ifdef HAVE_AGC
390 int rec_agc_preset_mic; /* AGC mic preset modes:
391 0 = Off
392 1 = Safety (clip)
393 2 = Live (slow)
394 3 = DJ-Set (slow)
395 4 = Medium
396 5 = Voice (fast) */
397 int rec_agc_preset_line; /* AGC line-in preset modes:
398 0 = Off
399 1 = Safety (clip)
400 2 = Live (slow)
401 3 = DJ-Set (slow)
402 4 = Medium
403 5 = Voice (fast) */
404 int rec_agc_maxgain_mic; /* AGC maximum mic gain */
405 int rec_agc_maxgain_line; /* AGC maximum line-in gain */
406 int rec_agc_cliptime; /* 0.2, 0.4, 0.6, 0.8, 1s */
407 #endif
408 #endif /* HAVE_RECORDING */
409 /* device settings */
411 #ifdef HAVE_LCD_CONTRAST
412 int contrast; /* lcd contrast */
413 #endif
414 bool invert; /* invert display */
415 bool invert_cursor; /* invert the current file in dir browser and menu
416 instead of using the default cursor */
417 bool flip_display; /* turn display (and button layout) by 180 degrees */
418 int poweroff; /* power off timer */
419 int backlight_timeout; /* backlight off timeout: 0-18 0=never,
420 1=always,
421 then according to timeout_values[] */
422 int backlight_timeout_plugged;
423 #ifdef HAVE_BACKLIGHT_PWM_FADING
424 int backlight_fade_in; /* backlight fade in timing: 0..3 */
425 int backlight_fade_out; /* backlight fade in timing: 0..7 */
426 #endif
427 int battery_capacity; /* in mAh */
428 int battery_type; /* for units which can take multiple types (Ondio). */
430 #ifdef HAVE_SPDIF_POWER
431 bool spdif_enable; /* S/PDIF power on/off */
432 #endif
434 #if CONFIG_TUNER
435 unsigned char fmr_file[MAX_FILENAME+1]; /* last fmr preset */
436 #endif
437 unsigned char font_file[MAX_FILENAME+1]; /* last font */
438 unsigned char wps_file[MAX_FILENAME+1]; /* last wps */
439 unsigned char lang_file[MAX_FILENAME+1]; /* last language */
441 /* misc options */
443 int repeat_mode; /* 0=off 1=repeat all 2=repeat one 3=shuffle 4=ab */
444 int dirfilter; /* 0=display all, 1=only supported, 2=only music,
445 3=dirs+playlists, 4=ID3 database */
446 bool sort_case; /* dir sort order: 0=case insensitive, 1=sensitive */
447 int show_filename_ext; /* show filename extensions in file browser?
448 0 = no, 1 = yes, 2 = only unknown 0 */
449 int volume_type; /* how volume is displayed: 0=graphic, 1=percent */
450 int battery_display; /* how battery is displayed: 0=graphic, 1=percent */
451 int timeformat; /* time format: 0=24 hour clock, 1=12 hour clock */
452 bool playlist_shuffle;
453 bool play_selected; /* Plays selected file even in shuffle mode */
454 int ff_rewind_min_step; /* FF/Rewind minimum step size */
455 int ff_rewind_accel; /* FF/Rewind acceleration (in seconds per doubling) */
457 #ifndef HAVE_FLASH_STORAGE
458 int disk_spindown; /* time until disk spindown, in seconds (0=off) */
459 int buffer_margin; /* MP3 buffer watermark margin, in seconds */
460 #endif
462 int peak_meter_release; /* units per read out */
463 int peak_meter_hold; /* hold time for peak meter in 1/100 s */
464 int peak_meter_clip_hold; /* hold time for clips */
465 bool peak_meter_dbfs; /* show linear or dbfs values */
466 int peak_meter_min; /* range minimum */
467 int peak_meter_max; /* range maximum */
468 bool car_adapter_mode; /* 0=off 1=on */
470 /* show status bar */
471 bool statusbar; /* 0=hide, 1=show */
473 /* show button bar */
474 bool buttonbar; /* 0=hide, 1=show */
476 /* show scroll bar */
477 bool scrollbar; /* 0=hide, 1=show */
479 /* goto current song when exiting WPS */
480 bool browse_current; /* 1=goto current song,
481 0=goto previous location */
484 int scroll_speed; /* long texts scrolling speed: 1-30 */
485 int bidir_limit; /* bidir scroll length limit */
486 int scroll_delay; /* delay (in 1/10s) before starting scroll */
487 int scroll_step; /* pixels to advance per update */
488 #ifdef HAVE_REMOTE_LCD
489 int remote_scroll_speed; /* long texts scrolling speed: 1-30 */
490 int remote_scroll_delay; /* delay (in 1/10s) before starting scroll */
491 int remote_scroll_step; /* pixels to advance per update */
492 int remote_bidir_limit; /* bidir scroll length limit */
493 #endif
495 #ifdef HAVE_LCD_BITMAP
496 bool offset_out_of_view;
497 int screen_scroll_step;
498 #endif
500 /* auto bookmark settings */
501 int autoloadbookmark; /* auto load option: 0=off, 1=ask, 2=on */
502 int autocreatebookmark; /* auto create option: 0=off, 1=ask, 2=on */
503 int usemrb; /* use MRB list: 0=No, 1=Yes*/
504 #ifdef HAVE_LCD_CHARCELLS
505 int jump_scroll; /* Fast jump when scrolling */
506 int jump_scroll_delay; /* Delay between jump scroll screens */
507 #endif
508 bool fade_on_stop; /* fade on pause/unpause/stop */
509 bool caption_backlight; /* turn on backlight at end and start of track */
511 #if CONFIG_TUNER
512 int fm_freq_step; /* Frequency step for manual tuning, in kHz */
513 bool fm_force_mono; /* Forces Mono mode if true */
514 bool fm_full_range; /* Enables full 10MHz-160MHz range if true, else
515 only 88MHz-108MHz */
516 #endif
518 int max_files_in_dir; /* Max entries in directory (file browser) */
519 int max_files_in_playlist; /* Max entries in playlist */
520 bool show_icons; /* 0=hide 1=show */
521 int recursive_dir_insert; /* should directories be inserted recursively */
523 bool line_in; /* false=off, true=active */
525 bool id3_v1_first; /* true = ID3V1 has prio over ID3V2 tag */
527 /* playlist viewer settings */
528 bool playlist_viewer_icons; /* display icons on viewer */
529 bool playlist_viewer_indices; /* display playlist indices on viewer */
530 int playlist_viewer_track_display; /* how to display tracks in viewer */
532 /* voice UI settings */
533 bool talk_menu; /* enable voice UI */
534 int talk_dir; /* voiced directories mode: 0=off 1=number 2=spell */
535 bool talk_dir_clip; /* use directory .talk clips */
536 int talk_file; /* voice file mode: 0=off, 1=number, 2=spell */
537 bool talk_file_clip; /* use file .talk clips */
539 /* file browser sorting */
540 int sort_file; /* 0=alpha, 1=date, 2=date (new first), 3=type */
541 int sort_dir; /* 0=alpha, 1=date (old first), 2=date (new first) */
543 #ifdef HAVE_REMOTE_LCD
544 /* remote lcd */
545 int remote_contrast; /* lcd contrast: 0-63 0=low 63=high */
546 bool remote_invert; /* invert display */
547 bool remote_flip_display; /* turn display (and button layout) by 180 degrees */
548 int remote_backlight_timeout; /* backlight off timeout: 0-18 0=never,
549 1=always,
550 then according to timeout_values[] */
551 int remote_backlight_timeout_plugged;
552 bool remote_caption_backlight; /* turn on backlight at end and start of track */
553 #ifdef HAS_REMOTE_BUTTON_HOLD
554 int remote_backlight_on_button_hold; /* what to do with remote backlight when hold
555 switch is on */
556 #endif
557 #ifdef HAVE_REMOTE_LCD_TICKING
558 bool remote_reduce_ticking; /* 0=normal operation,
559 1=EMI reduce on with cost more CPU. */
560 #endif
561 #endif /* HAVE_REMOTE_LCD */
563 int next_folder; /* move to next folder */
564 bool runtimedb; /* runtime database active? */
566 #if CONFIG_CODEC == SWCODEC
567 bool replaygain; /* enable replaygain */
568 bool replaygain_noclip; /* scale to prevent clips */
569 int replaygain_type; /* 0=track gain, 1=album gain, 2=track gain if
570 shuffle is on, album gain otherwise */
571 int replaygain_preamp; /* scale replaygained tracks by this */
572 int beep; /* system beep volume when changing tracks etc. */
574 /* Crossfeed settings */
575 bool crossfeed; /* enable crossfeed */
576 unsigned int crossfeed_direct_gain; /* - dB x 10 */
577 unsigned int crossfeed_cross_gain; /* - dB x 10 */
578 unsigned int crossfeed_hf_attenuation; /* - dB x 10 */
579 unsigned int crossfeed_hf_cutoff; /* Frequency in Hz */
580 #endif
581 #ifdef HAVE_DIRCACHE
582 bool dircache; /* enable directory cache */
583 #endif
584 #ifdef HAVE_TAGCACHE
585 #ifdef HAVE_TC_RAMCACHE
586 bool tagcache_ram; /* load tagcache to ram? */
587 #endif
588 bool tagcache_autoupdate; /* automatically keep tagcache in sync? */
589 #endif
590 int default_codepage; /* set default codepage for tag conversion */
591 #ifdef HAVE_REMOTE_LCD
592 unsigned char rwps_file[MAX_FILENAME+1]; /* last remote-wps */
593 #endif
594 #ifdef HAVE_BACKLIGHT_BRIGHTNESS
595 int brightness; /* iriver h300: backlight PWM value: 2..15
596 (0 and 1 are black) */
597 #endif
599 #if CONFIG_CODEC == SWCODEC
600 bool eq_enabled; /* Enable equalizer */
601 unsigned int eq_precut; /* dB */
603 /* Order is important here, must be cutoff, q, then gain for each band.
604 See dsp_eq_update_data in dsp.c for why. */
606 /* Band 0 settings */
607 int eq_band0_cutoff; /* Hz */
608 int eq_band0_q;
609 int eq_band0_gain; /* +/- dB */
611 /* Band 1 settings */
612 int eq_band1_cutoff; /* Hz */
613 int eq_band1_q;
614 int eq_band1_gain; /* +/- dB */
616 /* Band 2 settings */
617 int eq_band2_cutoff; /* Hz */
618 int eq_band2_q;
619 int eq_band2_gain; /* +/- dB */
621 /* Band 3 settings */
622 int eq_band3_cutoff; /* Hz */
623 int eq_band3_q;
624 int eq_band3_gain; /* +/- dB */
626 /* Band 4 settings */
627 int eq_band4_cutoff; /* Hz */
628 int eq_band4_q;
629 int eq_band4_gain; /* +/- dB */
631 bool dithering_enabled;
632 #endif
634 #if LCD_DEPTH > 1
635 unsigned char backdrop_file[MAX_FILENAME+1]; /* backdrop bitmap file */
636 #endif
638 bool warnon_erase_dynplaylist; /* warn when erasing dynamic playlist */
639 bool scroll_paginated; /* 0=dont 1=do */
640 #ifdef HAVE_LCD_COLOR
641 int bg_color; /* background color native format */
642 int fg_color; /* foreground color native format */
643 #endif
644 bool party_mode; /* party mode - unstoppable music */
646 #ifdef HAVE_BACKLIGHT
647 bool bl_filter_first_keypress; /* filter first keypress when dark? */
648 #ifdef HAVE_REMOTE_LCD
649 bool remote_bl_filter_first_keypress; /* filter first remote keypress when remote dark? */
650 #endif
651 #ifdef HAS_BUTTON_HOLD
652 int backlight_on_button_hold; /* what to do with backlight when hold
653 switch is on */
654 #endif
655 #ifdef HAVE_LCD_SLEEP
656 int lcd_sleep_after_backlight_off; /* when to put lcd to sleep after backlight
657 has turned off */
658 #endif
659 #endif /* HAVE_BACKLIGHT */
661 #ifdef HAVE_LCD_BITMAP
662 unsigned char kbd_file[MAX_FILENAME+1]; /* last keyboard */
663 #endif
665 #ifdef HAVE_USB_POWER
666 #if CONFIG_CHARGING
667 bool usb_charging;
668 #endif
669 #endif
671 #ifdef HAVE_WM8758
672 bool eq_hw_enabled; /* Enable hardware equalizer */
674 int eq_hw_band0_cutoff;
675 int eq_hw_band0_gain;
677 int eq_hw_band1_center;
678 int eq_hw_band1_bandwidth;
679 int eq_hw_band1_gain;
681 int eq_hw_band2_center;
682 int eq_hw_band2_bandwidth;
683 int eq_hw_band2_gain;
685 int eq_hw_band3_center;
686 int eq_hw_band3_bandwidth;
687 int eq_hw_band3_gain;
689 int eq_hw_band4_cutoff;
690 int eq_hw_band4_gain;
691 #endif
692 bool hold_lr_for_scroll_in_list; /* hold L/R scrolls the list left/right */
693 int show_path_in_browser; /* 0=off, 1=current directory, 2=full path */
695 #ifdef HAVE_HEADPHONE_DETECTION
696 int unplug_mode; /* pause on headphone unplug */
697 int unplug_rw; /* time in s to rewind when pausing */
698 bool unplug_autoresume; /* disable auto-resume if no phones */
699 #endif
700 #if CONFIG_TUNER
701 int fm_region;
702 #endif
703 bool audioscrobbler; /* Audioscrobbler logging */
705 /* If values are just added to the end, no need to bump plugin API
706 version. */
707 /* new stuff to be added at the end */
709 #if defined(HAVE_RECORDING) && CONFIG_CODEC == SWCODEC
710 /* Encoder Settings Start - keep these together */
711 struct mp3_enc_config mp3_enc_config;
712 #if 0 /* These currently contain no members but their places in line
713 should be held */
714 struct aiff_enc_config aiff_enc_config;
715 struct wav_enc_config wav_enc_config;
716 struct wavpack_enc_config wavpack_enc_config;
717 #endif
718 /* Encoder Settings End */
719 #endif /* CONFIG_CODEC == SWCODEC */
720 bool cuesheet;
721 int start_in_screen;
722 #if defined(HAVE_RTC_ALARM) && \
723 (defined(HAVE_RECORDING) || CONFIG_TUNER)
724 int alarm_wake_up_screen;
725 #endif
726 /* customizable icons */
727 #ifdef HAVE_LCD_BITMAP
728 unsigned char icon_file[MAX_FILENAME+1];
729 unsigned char viewers_icon_file[MAX_FILENAME+1];
730 #endif
731 #ifdef HAVE_REMOTE_LCD
732 unsigned char remote_icon_file[MAX_FILENAME+1];
733 unsigned char remote_viewers_icon_file[MAX_FILENAME+1];
734 #endif
735 #ifdef HAVE_LCD_COLOR
736 unsigned char colors_file[MAX_FILENAME+1];
737 #endif
738 #ifdef HAVE_BUTTON_LIGHT
739 int button_light_timeout;
740 #endif
741 #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
742 int buttonlight_brightness;
743 #endif
744 #ifndef HAVE_SCROLLWHEEL
745 int list_accel_start_delay; /* ms before we start increaseing step size */
746 int list_accel_wait; /* ms between increases */
747 #endif
750 /** global variables **/
751 extern long lasttime;
752 /* global settings */
753 extern struct user_settings global_settings;
754 /* global status */
755 extern struct system_status global_status;
757 #endif /* __SETTINGS_H__ */