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