apps/settings.h

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