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