Rockbox as an application: add get_user_file_path().
[kugel-rb.git] / apps / settings.h
blob7deb2def41380940b4cbdebef1121f0feb3eea41
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 "audiohw.h" /* for the AUDIOHW_* defines */
30 #include "statusbar.h" /* for the statusbar values */
31 #include "quickscreen.h"
32 #include "button.h"
33 #if CONFIG_CODEC == SWCODEC
34 #include "audio.h"
35 #endif
36 #include "rbpaths.h"
38 struct opt_items {
39 unsigned const char* string;
40 int32_t voice_id;
43 /** Setting values defines **/
44 #define MAX_FILENAME 32
47 enum {
48 BOOKMARK_NO = 0,
49 BOOKMARK_YES,
50 BOOKMARK_ASK,
51 BOOKMARK_UNIQUE_ONLY = 2,
52 BOOKMARK_RECENT_ONLY_YES,
53 BOOKMARK_RECENT_ONLY_ASK,
56 enum
58 TRIG_MODE_OFF = 0,
59 TRIG_MODE_NOREARM,
60 TRIG_MODE_REARM
63 enum
65 TRIG_TYPE_STOP = 0,
66 TRIG_TYPE_PAUSE,
67 TRIG_TYPE_NEW_FILE
70 #ifdef HAVE_CROSSFADE
71 enum {
72 CROSSFADE_ENABLE_OFF = 0,
73 CROSSFADE_ENABLE_AUTOSKIP,
74 CROSSFADE_ENABLE_MANSKIP,
75 CROSSFADE_ENABLE_SHUFFLE,
76 CROSSFADE_ENABLE_SHUFFLE_OR_MANSKIP,
77 CROSSFADE_ENABLE_ALWAYS,
79 #endif
81 enum {
82 FOLDER_ADVANCE_OFF = 0,
83 FOLDER_ADVANCE_NEXT,
84 FOLDER_ADVANCE_RANDOM,
87 /* repeat mode options */
88 enum
90 REPEAT_OFF = 0,
91 REPEAT_ALL,
92 REPEAT_ONE,
93 REPEAT_SHUFFLE,
94 #ifdef AB_REPEAT_ENABLE
95 REPEAT_AB,
96 #endif
97 NUM_REPEAT_MODES
101 /* dir filter options */
102 /* Note: Any new filter modes need to be added before NUM_FILTER_MODES.
103 * Any new rockbox browse filter modes (accessible through the menu)
104 * must be added after NUM_FILTER_MODES. */
105 enum { SHOW_ALL, SHOW_SUPPORTED, SHOW_MUSIC, SHOW_PLAYLIST, SHOW_ID3DB,
106 NUM_FILTER_MODES,
107 SHOW_WPS, SHOW_RWPS, SHOW_FMS, SHOW_RFMS, SHOW_SBS, SHOW_RSBS, SHOW_FMR, SHOW_CFG,
108 SHOW_LNG, SHOW_MOD, SHOW_FONT, SHOW_PLUGINS};
110 /* file and dir sort options */
111 enum { SORT_ALPHA, SORT_DATE, SORT_DATE_REVERSED, SORT_TYPE, /* available as settings */
112 SORT_ALPHA_REVERSED, SORT_TYPE_REVERSED }; /* internal use only */
113 enum { SORT_INTERPRET_AS_DIGIT, SORT_INTERPRET_AS_NUMBER };
115 /* recursive dir insert options */
116 enum { RECURSE_OFF, RECURSE_ON, RECURSE_ASK };
118 /* replaygain types */
119 enum { REPLAYGAIN_TRACK = 0, REPLAYGAIN_ALBUM, REPLAYGAIN_SHUFFLE, REPLAYGAIN_OFF };
121 /* show path types */
122 enum { SHOW_PATH_OFF = 0, SHOW_PATH_CURRENT, SHOW_PATH_FULL };
124 /* scrollbar visibility/position */
125 enum { SCROLLBAR_OFF = 0, SCROLLBAR_LEFT, SCROLLBAR_RIGHT };
127 /* Alarm settings */
128 #ifdef HAVE_RTC_ALARM
129 enum { ALARM_START_WPS = 0,
130 #if CONFIG_TUNER
131 ALARM_START_FM,
132 #endif
133 #ifdef HAVE_RECORDING
134 ALARM_START_REC,
135 #endif
136 ALARM_START_COUNT
138 #if CONFIG_TUNER && defined(HAVE_RECORDING)
139 #define ALARM_SETTING_TEXT "wps,fm,rec"
140 #elif CONFIG_TUNER
141 #define ALARM_SETTING_TEXT "wps,fm"
142 #elif defined(HAVE_RECORDING)
143 #define ALARM_SETTING_TEXT "wps,rec"
144 #endif
146 #endif /* HAVE_RTC_ALARM */
148 /* Keyclick stuff */
150 /* Not really a setting but several files should stay synced */
151 #define KEYCLICK_DURATION 2
153 /** virtual pointer stuff.. move to another .h maybe? **/
154 /* These define "virtual pointers", which could either be a literal string,
155 or a mean a string ID if the pointer is in a certain range.
156 This helps to save space for menus and options. */
158 #define VIRT_SIZE 0xFFFF /* more than enough for our string ID range */
159 #if defined(CPU_S5L870X)
160 /* the S5L870X has IRAM at 0, so we use 0xffff bytes right after that */
161 #define VIRT_PTR ((unsigned char*)0x40000)
162 #elif CONFIG_CPU==DM320
163 /* the DM320 has IRAM at 0, so we use 0xffff bytes right after that */
164 #define VIRT_PTR ((unsigned char*)0x4000)
165 #else
166 /* a location where we won't store strings, 0 is the fastest */
167 #define VIRT_PTR ((unsigned char*)0)
168 #endif
170 /* form a "virtual pointer" out of a language ID */
171 #define ID2P(id) (VIRT_PTR + id)
173 /* resolve a pointer which could be a virtualized ID or a literal */
174 #define P2STR(p) (char *)((p>=VIRT_PTR && p<VIRT_PTR+VIRT_SIZE) ? str(p-VIRT_PTR) : p)
176 /* get the string ID from a virtual pointer, -1 if not virtual */
177 #define P2ID(p) ((p>=VIRT_PTR && p<VIRT_PTR+VIRT_SIZE) ? p-VIRT_PTR : -1)
179 /* !defined(HAVE_LCD_COLOR) implies HAVE_LCD_CONTRAST with default 40.
180 Explicitly define HAVE_LCD_CONTRAST in config file for newer ports for
181 simplicity. */
185 /** function prototypes **/
187 /* argument bits for settings_load() */
188 #define SETTINGS_RTC (BIT_N(0)) /* only the settings from the RTC nonvolatile RAM */
189 #define SETTINGS_HD (BIT_N(1)) /* only the settings from the disk sector */
190 #define SETTINGS_ALL (SETTINGS_RTC|SETTINGS_HD) /* both */
191 void settings_load(int which);
192 bool settings_load_config(const char* file, bool apply);
194 void status_save(void);
195 int settings_save(void);
196 /* defines for the options paramater */
197 enum {
198 SETTINGS_SAVE_CHANGED = 0,
199 SETTINGS_SAVE_ALL,
200 SETTINGS_SAVE_THEME,
201 SETTINGS_SAVE_SOUND,
202 #ifdef HAVE_RECORDING
203 SETTINGS_SAVE_RECPRESETS,
204 #endif
205 #if CONFIG_CODEC == SWCODEC
206 SETTINGS_SAVE_EQPRESET,
207 #endif
209 bool settings_save_config(int options);
211 struct settings_list;
212 void reset_setting(const struct settings_list *setting, void *var);
213 void settings_reset(void);
214 void sound_settings_apply(void);
216 /* call this after loading a .wps/.rwps pr other skin files, so that the
217 * skin buffer is reset properly
219 void settings_apply_skins(void);
220 void theme_init_buffer(void);
222 void settings_apply(bool read_disk);
223 void settings_apply_pm_range(void);
224 void settings_display(void);
226 enum optiontype { INT, BOOL };
228 const struct settings_list* find_setting(const void* variable, int *id);
229 bool cfg_int_to_string(int setting_id, int val, char* buf, int buf_len);
230 bool cfg_to_string(int setting_id, char* buf, int buf_len);
231 bool set_bool_options(const char* string, const bool* variable,
232 const char* yes_str, int yes_voice,
233 const char* no_str, int no_voice,
234 void (*function)(bool));
236 bool set_bool(const char* string, const bool* variable);
237 bool set_int(const unsigned char* string, const char* unit, int voice_unit,
238 const int* variable,
239 void (*function)(int), int step, int min, int max,
240 const char* (*formatter)(char*, size_t, int, const char*) );
242 /* use this one if you need to create a lang from the value (i.e with TALK_ID()) */
243 bool set_int_ex(const unsigned char* string, const char* unit, int voice_unit,
244 const int* variable,
245 void (*function)(int), int step, int min, int max,
246 const char* (*formatter)(char*, size_t, int, const char*),
247 int32_t (*get_talk_id)(int, int));
249 void set_file(const char* filename, char* setting, const int maxlen);
251 bool set_option(const char* string, const void* variable, enum optiontype type,
252 const struct opt_items* options, int numoptions, void (*function)(int));
256 /** global_settings and global_status struct definitions **/
258 struct system_status
260 int resume_index; /* index in playlist (-1 for no active resume) */
261 uint32_t resume_offset; /* byte offset in mp3 file */
262 int runtime; /* current runtime since last charge */
263 int topruntime; /* top known runtime */
264 #ifdef HAVE_DIRCACHE
265 int dircache_size; /* directory cache structure last size, 22 bits */
266 #endif
267 #if CONFIG_TUNER
268 int last_frequency; /* Last frequency for resuming, in FREQ_STEP units,
269 relative to MIN_FREQ */
270 #endif
271 signed char last_screen;
272 int viewer_icon_count;
273 int last_volume_change; /* tick the last volume change happened. skins use this */
276 struct user_settings
278 /* audio settings */
280 int volume; /* audio output volume in decibels range depends on the dac */
281 int balance; /* stereo balance: 0-100 0=left 50=bal 100=right */
282 int bass; /* bass boost/cut in decibels */
283 int treble; /* treble boost/cut in decibels */
284 int channel_config; /* Stereo, Mono, Custom, Mono left, Mono right, Karaoke */
285 int stereo_width; /* 0-255% */
287 #if CONFIG_CODEC != SWCODEC
288 int loudness; /* loudness eq: 0-100 0=off 100=max */
289 int avc; /* auto volume correct: 0=off, 1=20ms, 2=2s 3=4s 4=8s */
290 int mdb_strength; /* 0-127dB */
291 int mdb_harmonics; /* 0-100% */
292 int mdb_center; /* 20-300Hz */
293 int mdb_shape; /* 50-300Hz */
294 bool mdb_enable; /* true/false */
295 bool superbass; /* true/false */
296 #endif
298 #ifdef AUDIOHW_HAVE_BASS_CUTOFF
299 int bass_cutoff;
300 #endif
301 #ifdef AUDIOHW_HAVE_TREBLE_CUTOFF
302 int treble_cutoff;
303 #endif
305 #if CONFIG_CODEC == SWCODEC
306 #ifdef HAVE_CROSSFADE
307 /* Crossfade */
308 int crossfade; /* Enable crossfade (0=off, 1=shuffle, 2=trackskip,
309 3=shuff&trackskip, 4=always) */
310 int crossfade_fade_in_delay; /* Fade in delay (0-15s) */
311 int crossfade_fade_out_delay; /* Fade out delay (0-15s) */
312 int crossfade_fade_in_duration; /* Fade in duration (0-15s) */
313 int crossfade_fade_out_duration; /* Fade out duration (0-15s) */
314 int crossfade_fade_out_mixmode; /* Fade out mode (0=crossfade,1=mix) */
315 #endif
317 /* Replaygain */
318 bool replaygain_noclip; /* scale to prevent clips */
319 int replaygain_type; /* 0=track gain, 1=album gain, 2=track gain if
320 shuffle is on, album gain otherwise, 4=off */
321 int replaygain_preamp; /* scale replaygained tracks by this */
323 /* Crossfeed */
324 bool crossfeed; /* enable crossfeed */
325 unsigned int crossfeed_direct_gain; /* dB x 10 */
326 unsigned int crossfeed_cross_gain; /* dB x 10 */
327 unsigned int crossfeed_hf_attenuation; /* dB x 10 */
328 unsigned int crossfeed_hf_cutoff; /* Frequency in Hz */
330 /* EQ */
331 bool eq_enabled; /* Enable equalizer */
332 unsigned int eq_precut; /* dB */
334 /* Order is important here, must be cutoff, q, then gain for each band.
335 See dsp_set_eq_coefs in dsp.c for why. */
337 /* Band 0 settings */
338 int eq_band0_cutoff; /* Hz */
339 int eq_band0_q;
340 int eq_band0_gain; /* +/- dB */
342 /* Band 1 settings */
343 int eq_band1_cutoff; /* Hz */
344 int eq_band1_q;
345 int eq_band1_gain; /* +/- dB */
347 /* Band 2 settings */
348 int eq_band2_cutoff; /* Hz */
349 int eq_band2_q;
350 int eq_band2_gain; /* +/- dB */
352 /* Band 3 settings */
353 int eq_band3_cutoff; /* Hz */
354 int eq_band3_q;
355 int eq_band3_gain; /* +/- dB */
357 /* Band 4 settings */
358 int eq_band4_cutoff; /* Hz */
359 int eq_band4_q;
360 int eq_band4_gain; /* +/- dB */
362 /* Misc. swcodec */
363 int beep; /* system beep volume when changing tracks etc. */
364 int keyclick; /* keyclick volume */
365 int keyclick_repeats; /* keyclick on repeats */
366 bool dithering_enabled;
367 bool timestretch_enabled;
368 #endif /* CONFIG_CODEC == SWCODEC */
370 #ifdef HAVE_RECORDING
371 #if CONFIG_CODEC == SWCODEC
372 int rec_format; /* record format index */
373 int rec_mono_mode; /* how to create mono: L, R, L+R */
375 /* Encoder Settings Start - keep these together */
376 struct mp3_enc_config mp3_enc_config;
377 #if 0 /* These currently contain no members but their places in line
378 should be held */
379 struct aiff_enc_config aiff_enc_config;
380 struct wav_enc_config wav_enc_config;
381 struct wavpack_enc_config wavpack_enc_config;
382 #endif
383 /* Encoder Settings End */
385 #else
386 int rec_quality; /* 0-7 */
387 #endif /* CONFIG_CODEC == SWCODEC */
388 int rec_source; /* 0=mic, 1=line, 2=S/PDIF, 2 or 3=FM Radio */
389 int rec_frequency; /* 0 = 44.1kHz (depends on target)
390 1 = 48kHz
391 2 = 32kHz
392 3 = 22.05kHz
393 4 = 24kHz
394 5 = 16kHz */
395 int rec_channels; /* 0=Stereo, 1=Mono */
397 int rec_mic_gain; /* depends on target */
398 int rec_left_gain; /* depends on target */
399 int rec_right_gain; /* depends on target */
400 bool peak_meter_clipcounter; /* clipping count indicator */
401 bool rec_editable; /* true means that the bit reservoir is off */
403 /* note: timesplit setting is not saved */
404 int rec_timesplit; /* 0 = off,
405 1 = 00:05, 2 = 00:10, 3 = 00:15, 4 = 00:30
406 5 = 01:00, 6 = 02:00, 7 = 04:00, 8 = 06:00
407 9 = 08:00, 10= 10:00, 11= 12:00, 12= 18:00,
408 13= 24:00 */
409 int rec_sizesplit; /* 0 = off,
410 1 = 5MB, 2 = 10MB, 3 = 15MB, 4 = 32MB
411 5 = 64MB, 6 = 75MB, 7 = 100MB, 8 = 128MB
412 9 = 256MB, 10= 512MB, 11= 650MB, 12= 700MB,
413 13= 1GB, 14 = 1.5GB 15 = 1.75MB*/
414 int rec_split_type; /* split/stop */
415 int rec_split_method; /* time/filesize */
417 int rec_prerecord_time; /* In seconds, 0-30, 0 means OFF */
418 char rec_directory[MAX_FILENAME+1];
419 int cliplight; /* 0 = off
420 1 = main lcd
421 2 = main and remote lcd
422 3 = remote lcd */
424 int rec_start_thres_db;
425 int rec_start_thres_linear;
426 int rec_start_duration; /* index of trig_durations */
427 int rec_stop_thres_db;
428 int rec_stop_thres_linear;
429 int rec_stop_postrec;
430 int rec_stop_gap; /* index of trig_durations */
431 int rec_trigger_mode; /* see TRIG_MODE_XXX constants */
432 int rec_trigger_type; /* what to do when trigger released */
433 #ifdef HAVE_RECORDING_HISTOGRAM
434 int rec_histogram_interval; /* recording peakmeter histogram */
435 #endif
437 #ifdef HAVE_AGC
438 int rec_agc_preset_mic; /* AGC mic preset modes:
439 0 = Off
440 1 = Safety (clip)
441 2 = Live (slow)
442 3 = DJ-Set (slow)
443 4 = Medium
444 5 = Voice (fast) */
445 int rec_agc_preset_line; /* AGC line-in preset modes:
446 0 = Off
447 1 = Safety (clip)
448 2 = Live (slow)
449 3 = DJ-Set (slow)
450 4 = Medium
451 5 = Voice (fast) */
452 int rec_agc_maxgain_mic; /* AGC maximum mic gain */
453 int rec_agc_maxgain_line; /* AGC maximum line-in gain */
454 int rec_agc_cliptime; /* 0.2, 0.4, 0.6, 0.8, 1s */
455 #endif
456 #endif /* HAVE_RECORDING */
458 #if CONFIG_TUNER
459 int fm_region;
460 bool fm_force_mono; /* Forces Mono mode if true */
461 unsigned char fmr_file[MAX_FILENAME+1]; /* last fmr preset */
462 unsigned char fms_file[MAX_FILENAME+1]; /* last fms */
463 #ifdef HAVE_REMOTE_LCD
464 unsigned char rfms_file[MAX_FILENAME+1]; /* last remote-fms */
465 #endif
466 #endif /* CONFIG_TUNER */
468 /* misc options */
469 #ifndef HAVE_WHEEL_ACCELERATION
470 int list_accel_start_delay; /* ms before we start increaseing step size */
471 int list_accel_wait; /* ms between increases */
472 #endif
474 #ifdef HAVE_TOUCHPAD_SENSITIVITY_SETTING
475 int touchpad_sensitivity;
476 #endif
478 #ifdef HAVE_HEADPHONE_DETECTION
479 int unplug_mode; /* pause on headphone unplug */
480 int unplug_rw; /* time in s to rewind when pausing */
481 bool unplug_autoresume; /* disable auto-resume if no phones */
482 #endif
484 #ifdef HAVE_QUICKSCREEN
485 int qs_items[QUICKSCREEN_ITEM_COUNT];
486 #endif
488 #if CONFIG_RTC
489 int timeformat; /* time format: 0=24 hour clock, 1=12 hour clock */
490 #endif
492 #ifdef HAVE_DISK_STORAGE
493 int disk_spindown; /* time until disk spindown, in seconds (0=off) */
494 int buffer_margin; /* audio buffer watermark margin, in seconds */
495 #endif
497 int dirfilter; /* 0=display all, 1=only supported, 2=only music,
498 3=dirs+playlists, 4=ID3 database */
499 int show_filename_ext; /* show filename extensions in file browser?
500 0 = no, 1 = yes, 2 = only unknown 0 */
501 int default_codepage; /* set default codepage for tag conversion */
502 bool hold_lr_for_scroll_in_list; /* hold L/R scrolls the list left/right */
503 bool play_selected; /* Plays selected file even in shuffle mode */
504 bool party_mode; /* party mode - unstoppable music */
505 bool audioscrobbler; /* Audioscrobbler logging */
506 bool cuesheet;
507 bool car_adapter_mode; /* 0=off 1=on */
508 int start_in_screen;
509 #if defined(HAVE_RTC_ALARM) && \
510 (defined(HAVE_RECORDING) || CONFIG_TUNER)
511 int alarm_wake_up_screen;
512 #endif
513 int ff_rewind_min_step; /* FF/Rewind minimum step size */
514 int ff_rewind_accel; /* FF/Rewind acceleration (in seconds per doubling) */
516 int peak_meter_release; /* units per read out */
517 int peak_meter_hold; /* hold time for peak meter in 1/100 s */
518 int peak_meter_clip_hold; /* hold time for clips */
519 bool peak_meter_dbfs; /* show linear or dbfs values */
520 int peak_meter_min; /* range minimum */
521 int peak_meter_max; /* range maximum */
523 unsigned char wps_file[MAX_FILENAME+1]; /* last wps */
524 #ifdef HAVE_LCD_BITMAP
525 unsigned char sbs_file[MAX_FILENAME+1]; /* last statusbar skin */
526 #endif
527 #ifdef HAVE_REMOTE_LCD
528 unsigned char rwps_file[MAX_FILENAME+1]; /* last remote-wps */
529 unsigned char rsbs_file[MAX_FILENAME+1]; /* last remote statusbar skin */
530 #endif
531 unsigned char lang_file[MAX_FILENAME+1]; /* last language */
532 unsigned char playlist_catalog_dir[MAX_FILENAME+1];
533 int skip_length; /* skip length */
534 int max_files_in_dir; /* Max entries in directory (file browser) */
535 int max_files_in_playlist; /* Max entries in playlist */
536 int volume_type; /* how volume is displayed: 0=graphic, 1=percent */
537 int battery_display; /* how battery is displayed: 0=graphic, 1=percent */
538 bool show_icons; /* 0=hide 1=show */
539 int statusbar; /* STATUSBAR_* enum values */
540 #ifdef HAVE_REMOTE_LCD
541 int remote_statusbar;
542 #endif
544 #if CONFIG_KEYPAD == RECORDER_PAD
545 bool buttonbar; /* 0=hide, 1=show */
546 #endif
548 #ifdef HAVE_LCD_BITMAP
549 int scrollbar; /* SCROLLBAR_* enum values */
550 int scrollbar_width;
551 #endif
553 /* goto current song when exiting WPS */
554 bool browse_current; /* 1=goto current song,
555 0=goto previous location */
556 bool scroll_paginated; /* 0=dont 1=do */
557 int scroll_speed; /* long texts scrolling speed: 1-30 */
558 int bidir_limit; /* bidir scroll length limit */
559 int scroll_delay; /* delay (in 1/10s) before starting scroll */
560 int scroll_step; /* pixels to advance per update */
562 /* auto bookmark settings */
563 int autoloadbookmark; /* auto load option: 0=off, 1=ask, 2=on */
564 int autocreatebookmark; /* auto create option: 0=off, 1=ask, 2=on */
565 bool autoupdatebookmark;/* auto update option */
566 int usemrb; /* use MRB list: 0=No, 1=Yes, 2=One per playlist */
568 #ifdef HAVE_DIRCACHE
569 bool dircache; /* enable directory cache */
570 #endif
571 #ifdef HAVE_TAGCACHE
572 #ifdef HAVE_TC_RAMCACHE
573 bool tagcache_ram; /* load tagcache to ram? */
574 #endif
575 bool tagcache_autoupdate; /* automatically keep tagcache in sync? */
576 bool runtimedb; /* runtime database active? */
577 #endif /* HAVE_TAGCACHE */
579 #if LCD_DEPTH > 1
580 unsigned char backdrop_file[MAX_FILENAME+1]; /* backdrop bitmap file */
581 #endif
583 #ifdef HAVE_LCD_COLOR
584 int bg_color; /* background color native format */
585 int fg_color; /* foreground color native format */
586 int lss_color; /* background color for the selector or start color for the gradient */
587 int lse_color; /* end color for the selector gradient */
588 int lst_color; /* color of the text for the selector */
589 unsigned char colors_file[MAX_FILENAME+1];
590 #endif
592 /* playlist/playback settings */
593 int repeat_mode; /* 0=off 1=repeat all 2=repeat one 3=shuffle 4=ab */
594 int next_folder; /* move to next folder */
595 int recursive_dir_insert; /* should directories be inserted recursively */
596 bool fade_on_stop; /* fade on pause/unpause/stop */
597 bool playlist_shuffle;
598 bool warnon_erase_dynplaylist; /* warn when erasing dynamic playlist */
600 /* playlist viewer settings */
601 bool playlist_viewer_icons; /* display icons on viewer */
602 bool playlist_viewer_indices; /* display playlist indices on viewer */
603 int playlist_viewer_track_display; /* how to display tracks in viewer */
605 /* voice UI settings */
606 bool talk_menu; /* enable voice UI */
607 int talk_dir; /* voiced directories mode: 0=off 1=number 2=spell */
608 bool talk_dir_clip; /* use directory .talk clips */
609 int talk_file; /* voice file mode: 0=off, 1=number, 2=spell */
610 bool talk_file_clip; /* use file .talk clips */
611 bool talk_filetype; /* say file type */
612 bool talk_battery_level;
614 /* file browser sorting */
615 bool sort_case; /* dir sort order: 0=case insensitive, 1=sensitive */
616 int sort_dir; /* 0=alpha, 1=date (old first), 2=date (new first) */
617 int sort_file; /* 0=alpha, 1=date, 2=date (new first), 3=type */
618 int interpret_numbers; /* true=strnatcmp, false=strcmp */
620 /* power settings */
621 int poweroff; /* idle power off timer */
622 int battery_capacity; /* in mAh */
624 #if BATTERY_TYPES_COUNT > 1
625 int battery_type; /* for units which can take multiple types (Ondio). */
626 #endif
627 #ifdef HAVE_SPDIF_POWER
628 bool spdif_enable; /* S/PDIF power on/off */
629 #endif
630 #ifdef HAVE_USB_CHARGING_ENABLE
631 int usb_charging;
632 #endif
634 /* device settings */
635 #ifdef HAVE_LCD_CONTRAST
636 int contrast; /* lcd contrast */
637 #endif
639 #ifdef HAVE_LCD_BITMAP
640 #ifdef HAVE_LCD_INVERT
641 bool invert; /* invert display */
642 #endif
643 #ifdef HAVE_LCD_FLIP
644 bool flip_display; /* turn display (and button layout) by 180 degrees */
645 #endif
646 int cursor_style; /* style of the selection cursor */
647 int screen_scroll_step;
648 int show_path_in_browser; /* 0=off, 1=current directory, 2=full path */
649 bool offset_out_of_view;
650 unsigned char icon_file[MAX_FILENAME+1];
651 unsigned char viewers_icon_file[MAX_FILENAME+1];
652 unsigned char font_file[MAX_FILENAME+1]; /* last font */
653 #ifdef HAVE_REMOTE_LCD
654 unsigned char remote_font_file[MAX_FILENAME+1]; /* last font */
655 #endif
656 unsigned char kbd_file[MAX_FILENAME+1]; /* last keyboard */
657 #endif /* HAVE_LCD_BITMAP */
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 #ifdef HAS_REMOTE_BUTTON_HOLD
704 int remote_backlight_on_button_hold; /* what to do with remote backlight when hold
705 switch is on */
706 #endif
707 #ifdef HAVE_REMOTE_LCD_TICKING
708 bool remote_reduce_ticking; /* 0=normal operation,
709 1=EMI reduce on with cost more CPU. */
710 #endif
711 #endif /* HAVE_REMOTE_LCD */
713 #if CONFIG_CODEC == MAS3507D
714 bool line_in; /* false=off, true=active */
715 #endif
717 #ifdef HAVE_BUTTON_LIGHT
718 int buttonlight_timeout;
719 #endif
720 #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
721 int buttonlight_brightness;
722 #endif
724 #ifdef IPOD_ACCESSORY_PROTOCOL
725 int serial_bitrate; /* 0=auto 1=9600 2=19200 3=38400 4=57600 */
726 #endif
727 #ifdef HAVE_ACCESSORY_SUPPLY
728 bool accessory_supply; /* 0=off 1=on, accessory power supply for iPod */
729 #endif
730 #ifdef HAVE_LINEOUT_POWEROFF
731 bool lineout_active;
732 #endif
734 #ifdef HAVE_SPEAKER
735 bool speaker_enabled;
736 #endif
737 bool prevent_skip;
739 #ifdef HAVE_TOUCHSCREEN
740 int touch_mode;
741 struct touchscreen_parameter ts_calibration_data;
742 #endif
744 #ifdef HAVE_PITCHSCREEN
745 /* pitch screen settings */
746 bool pitch_mode_semitone;
747 #if CONFIG_CODEC == SWCODEC
748 bool pitch_mode_timestretch;
749 #endif
750 #endif
751 /* If values are just added to the end, no need to bump plugin API
752 version. */
753 /* new stuff to be added at the end */
755 #ifdef USB_ENABLE_HID
756 bool usb_hid;
757 int usb_keypad_mode;
758 #endif
760 #ifdef HAVE_LCD_BITMAP
761 unsigned char ui_vp_config[64]; /* viewport string for the lists */
762 #ifdef HAVE_REMOTE_LCD
763 unsigned char remote_ui_vp_config[64]; /* viewport string for the remote lists */
764 #endif
765 #endif
767 #if CONFIG_CODEC == SWCODEC
768 int compressor_threshold;
769 int compressor_makeup_gain;
770 int compressor_ratio;
771 int compressor_knee;
772 int compressor_release_time;
773 #endif
775 #ifdef HAVE_MORSE_INPUT
776 bool morse_input; /* text input method setting */
777 #endif
779 #ifdef HAVE_HOTKEY
780 /* hotkey assignments - acceptable values are in
781 hotkey_action enum in onplay.h */
782 int hotkey_wps;
783 int hotkey_tree;
784 #endif
786 #if CONFIG_CODEC == SWCODEC
787 /* When resuming playback (after a stop), rewind this number of seconds */
788 int resume_rewind;
789 #endif
791 #ifdef AUDIOHW_HAVE_DEPTH_3D
792 int depth_3d;
793 #endif
795 #ifdef AUDIOHW_HAVE_EQ
796 /** Hardware EQ tone controls **/
797 struct hw_eq_band
799 /* Maintain the order of members or sound_menu has to be changed */
800 int gain;
801 #ifdef AUDIOHW_HAVE_EQ_FREQUENCY
802 int frequency;
803 #endif
804 #ifdef AUDIOHW_HAVE_EQ_WIDTH
805 int width;
806 #endif
807 } hw_eq_bands[AUDIOHW_EQ_BAND_NUM];
808 #endif /* AUDIOHW_HAVE_EQ */
811 /** global variables **/
812 extern long lasttime;
813 /* global settings */
814 extern struct user_settings global_settings;
815 /* global status */
816 extern struct system_status global_status;
818 #endif /* __SETTINGS_H__ */