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