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