apps/settings.h

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