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