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