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