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_offset; /* byte offset in mp3 file */
 266     int runtime;       /* current runtime since last charge */
 267     int topruntime;    /* top known runtime */
 268 #ifdef HAVE_DIRCACHE
 269     int dircache_size;      /* directory cache structure last size, 22 bits */
 270 #endif
 271 #if CONFIG_TUNER
 272     int last_frequency;  /* Last frequency for resuming, in FREQ_STEP units,
 273                             relative to MIN_FREQ */
 274 #endif
 275     signed char last_screen;
 276     int  viewer_icon_count;
 277     int last_volume_change; /* tick the last volume change happened. skins use this */
 278 #ifdef HAVE_LCD_BITMAP
 279     int font_id[NB_SCREENS]; /* font id of the settings font for each screen */
 280 #endif
 281 };
 282
 283 struct user_settings
 284 {
 285     /* audio settings */
 286
 287     int volume;     /* audio output volume in decibels range depends on the dac */
 288     int balance;    /* stereo balance:          0-100 0=left  50=bal 100=right  */
 289     int bass;       /* bass boost/cut in decibels                               */
 290     int treble;     /* treble boost/cut in decibels                             */
 291     int channel_config; /* Stereo, Mono, Custom, Mono left, Mono right, Karaoke */
 292     int stereo_width; /* 0-255% */
 293
 294 #if CONFIG_CODEC != SWCODEC
 295     int  loudness;      /* loudness eq:          0-100 0=off   100=max         */
 296     int  avc;           /* auto volume correct:  0=off, 1=20ms, 2=2s 3=4s 4=8s */
 297     int  mdb_strength;  /* 0-127dB */
 298     int  mdb_harmonics; /* 0-100% */
 299     int  mdb_center;    /* 20-300Hz */
 300     int  mdb_shape;     /* 50-300Hz */
 301     bool mdb_enable;    /* true/false */
 302     bool superbass;     /* true/false */
 303 #endif
 304
 305 #ifdef AUDIOHW_HAVE_BASS_CUTOFF
 306     int bass_cutoff;
 307 #endif
 308 #ifdef AUDIOHW_HAVE_TREBLE_CUTOFF
 309     int treble_cutoff;
 310 #endif
 311
 312 #if CONFIG_CODEC == SWCODEC
 313 #ifdef HAVE_CROSSFADE
 314     /* Crossfade */
 315     int crossfade;     /* Enable crossfade (0=off, 1=shuffle, 2=trackskip,
 316                                             3=shuff&trackskip, 4=always) */
 317     int crossfade_fade_in_delay;      /* Fade in delay (0-15s)             */
 318     int crossfade_fade_out_delay;     /* Fade out delay (0-15s)            */
 319     int crossfade_fade_in_duration;   /* Fade in duration (0-15s)          */
 320     int crossfade_fade_out_duration;  /* Fade out duration (0-15s)         */
 321     int crossfade_fade_out_mixmode;   /* Fade out mode (0=crossfade,1=mix) */
 322 #endif
 323
 324     /* Replaygain */
 325     struct replaygain_settings replaygain_settings;
 326
 327     /* Crossfeed */
 328     int crossfeed;                              /* crossfeed type */
 329     unsigned int crossfeed_direct_gain;         /* dB x 10 */
 330     unsigned int crossfeed_cross_gain;          /* dB x 10 */
 331     unsigned int crossfeed_hf_attenuation;      /* dB x 10 */
 332     unsigned int crossfeed_hf_cutoff;           /* Frequency in Hz */
 333
 334     /* EQ */
 335     bool eq_enabled;            /* Enable equalizer */
 336     unsigned int eq_precut;     /* dB */
 337     struct eq_band_setting eq_band_settings[EQ_NUM_BANDS]; /* for each band */
 338
 339     /* Misc. swcodec */
 340     int  beep;              /* system beep volume when changing tracks etc. */
 341     int  keyclick;          /* keyclick volume */
 342     int  keyclick_repeats;  /* keyclick on repeats */
 343     bool dithering_enabled;
 344 #ifdef HAVE_PITCHCONTROL
 345     bool timestretch_enabled;
 346 #endif
 347 #endif /* CONFIG_CODEC == SWCODEC */
 348
 349 #ifdef HAVE_RECORDING
 350 #if CONFIG_CODEC == SWCODEC
 351     int rec_format;    /* record format index */
 352     int rec_mono_mode; /* how to create mono: L, R, L+R */
 353
 354     /* Encoder Settings Start - keep these together */
 355     struct mp3_enc_config     mp3_enc_config;
 356 #if 0 /* These currently contain no members but their places in line
 357          should be held */
 358     struct aiff_enc_config    aiff_enc_config;
 359     struct wav_enc_config     wav_enc_config;
 360     struct wavpack_enc_config wavpack_enc_config;
 361 #endif
 362     /* Encoder Settings End */
 363
 364 #else
 365     int rec_quality;   /* 0-7 */
 366 #endif  /* CONFIG_CODEC == SWCODEC */
 367     int rec_source;    /* 0=mic, 1=line, 2=S/PDIF, 2 or 3=FM Radio */
 368     int rec_frequency; /* 0 = 44.1kHz (depends on target)
 369                           1 = 48kHz
 370                           2 = 32kHz
 371                           3 = 22.05kHz
 372                           4 = 24kHz
 373                           5 = 16kHz */
 374     int rec_channels;  /* 0=Stereo, 1=Mono */
 375
 376     int rec_mic_gain;   /* depends on target */
 377     int rec_left_gain;  /* depends on target */
 378     int rec_right_gain; /* depends on target */
 379     bool peak_meter_clipcounter; /* clipping count indicator */
 380     bool rec_editable; /* true means that the bit reservoir is off */
 381
 382     /* note: timesplit setting is not saved */
 383     int rec_timesplit; /* 0 = off,
 384                           1 = 00:05, 2 = 00:10, 3 = 00:15, 4 = 00:30
 385                           5 = 01:00, 6 = 02:00, 7 = 04:00, 8 = 06:00
 386                           9 = 08:00, 10= 10:00, 11= 12:00, 12= 18:00,
 387                           13= 24:00 */
 388     int rec_sizesplit; /* 0 = off,
 389                           1 = 5MB, 2 = 10MB, 3 = 15MB, 4 = 32MB
 390                           5 = 64MB, 6 = 75MB, 7 = 100MB, 8 = 128MB
 391                           9 = 256MB, 10= 512MB, 11= 650MB, 12= 700MB,
 392                           13= 1GB, 14 = 1.5GB 15 = 1.75MB*/
 393     int rec_split_type; /* split/stop */
 394     int rec_split_method; /* time/filesize */
 395
 396     int rec_prerecord_time; /* In seconds, 0-30, 0 means OFF */
 397     char rec_directory[MAX_PATHNAME+1];
 398     int cliplight; /* 0 = off
 399                       1 = main lcd
 400                       2 = main and remote lcd
 401                       3 = remote lcd */
 402
 403     int rec_start_thres_db;
 404     int rec_start_thres_linear;
 405     int rec_start_duration; /* index of trig_durations */
 406     int rec_stop_thres_db;
 407     int rec_stop_thres_linear;
 408     int rec_stop_postrec;
 409     int rec_stop_gap;       /* index of trig_durations */
 410     int rec_trigger_mode;   /* see TRIG_MODE_XXX constants */
 411     int rec_trigger_type;   /* what to do when trigger released */
 412 #ifdef HAVE_HISTOGRAM
 413     int histogram_interval; /* recording peakmeter histogram */
 414 #endif
 415
 416 #ifdef HAVE_AGC
 417     int rec_agc_preset_mic; /* AGC mic preset modes:
 418                              0 = Off
 419                              1 = Safety (clip)
 420                              2 = Live (slow)
 421                              3 = DJ-Set (slow)
 422                              4 = Medium
 423                              5 = Voice (fast) */
 424     int rec_agc_preset_line; /* AGC line-in preset modes:
 425                               0 = Off
 426                               1 = Safety (clip)
 427                               2 = Live (slow)
 428                               3 = DJ-Set (slow)
 429                               4 = Medium
 430                               5 = Voice (fast) */
 431     int rec_agc_maxgain_mic;  /* AGC maximum mic gain */
 432     int rec_agc_maxgain_line; /* AGC maximum line-in gain */
 433     int rec_agc_cliptime;     /* 0.2, 0.4, 0.6, 0.8, 1s */
 434 #endif
 435 #endif /* HAVE_RECORDING */
 436
 437 #if CONFIG_TUNER
 438     int fm_region;
 439     bool fm_force_mono;  /* Forces Mono mode if true */
 440     unsigned char fmr_file[MAX_FILENAME+1]; /* last fmr preset */
 441     unsigned char fms_file[MAX_FILENAME+1];  /* last fms */
 442 #ifdef HAVE_REMOTE_LCD
 443     unsigned char rfms_file[MAX_FILENAME+1];  /* last remote-fms */
 444 #endif
 445 #endif /* CONFIG_TUNER */
 446
 447     /* misc options */
 448 #ifndef HAVE_WHEEL_ACCELERATION
 449     int list_accel_start_delay; /* ms before we start increaseing step size */
 450     int list_accel_wait; /* ms between increases */
 451 #endif
 452
 453 #ifdef HAVE_TOUCHPAD_SENSITIVITY_SETTING
 454     int touchpad_sensitivity;
 455 #endif
 456
 457     int  pause_rewind; /* time in s to rewind when pausing */
 458 #ifdef HAVE_HEADPHONE_DETECTION
 459     int  unplug_mode; /* pause on headphone unplug */
 460     bool unplug_autoresume; /* disable auto-resume if no phones */
 461 #endif
 462
 463 #ifdef HAVE_QUICKSCREEN
 464     int qs_items[QUICKSCREEN_ITEM_COUNT];
 465 #endif
 466
 467 #if CONFIG_RTC
 468     int timeformat;    /* time format: 0=24 hour clock, 1=12 hour clock */
 469 #endif
 470
 471 #ifdef HAVE_DISK_STORAGE
 472     int disk_spindown; /* time until disk spindown, in seconds (0=off) */
 473     int buffer_margin; /* audio buffer watermark margin, in seconds */
 474 #endif
 475
 476     int dirfilter;     /* 0=display all, 1=only supported, 2=only music,
 477                           3=dirs+playlists, 4=ID3 database */
 478     int show_filename_ext; /* show filename extensions in file browser?
 479                               0 = no, 1 = yes, 2 = only unknown 0 */
 480     int default_codepage;   /* set default codepage for tag conversion */
 481     bool hold_lr_for_scroll_in_list; /* hold L/R scrolls the list left/right */
 482     bool play_selected; /* Plays selected file even in shuffle mode */
 483     bool party_mode;    /* party mode - unstoppable music */
 484     bool audioscrobbler; /* Audioscrobbler logging  */
 485     bool cuesheet;
 486     bool car_adapter_mode; /* 0=off 1=on */
 487     int start_in_screen;
 488 #if defined(HAVE_RTC_ALARM) && \
 489     (defined(HAVE_RECORDING) || CONFIG_TUNER)
 490     int alarm_wake_up_screen;
 491 #endif
 492     int ff_rewind_min_step; /* FF/Rewind minimum step size */
 493     int ff_rewind_accel; /* FF/Rewind acceleration (in seconds per doubling) */
 494
 495     int peak_meter_release;   /* units per read out */
 496     int peak_meter_hold;      /* hold time for peak meter in 1/100 s */
 497     int peak_meter_clip_hold; /* hold time for clips */
 498     bool peak_meter_dbfs;     /* show linear or dbfs values */
 499     int peak_meter_min; /* range minimum */
 500     int peak_meter_max; /* range maximum */
 501
 502     unsigned char wps_file[MAX_FILENAME+1];  /* last wps */
 503 #ifdef HAVE_LCD_BITMAP
 504     unsigned char sbs_file[MAX_FILENAME+1];  /* last statusbar skin */
 505 #endif
 506 #ifdef HAVE_REMOTE_LCD
 507     unsigned char rwps_file[MAX_FILENAME+1];  /* last remote-wps */
 508     unsigned char rsbs_file[MAX_FILENAME+1];  /* last remote statusbar skin */
 509 #endif
 510     unsigned char lang_file[MAX_FILENAME+1]; /* last language */
 511     unsigned char playlist_catalog_dir[MAX_PATHNAME+1];
 512     int skip_length; /* skip length */
 513     int max_files_in_dir; /* Max entries in directory (file browser) */
 514     int max_files_in_playlist; /* Max entries in playlist */
 515     int volume_type;   /* how volume is displayed: 0=graphic, 1=percent */
 516     int battery_display; /* how battery is displayed: 0=graphic, 1=percent */
 517     bool show_icons;   /* 0=hide 1=show */
 518     int statusbar;    /* STATUSBAR_* enum values */
 519 #ifdef HAVE_REMOTE_LCD
 520     int remote_statusbar;
 521 #endif
 522
 523 #if CONFIG_KEYPAD == RECORDER_PAD
 524     bool buttonbar;    /* 0=hide, 1=show */
 525 #endif
 526
 527 #ifdef HAVE_LCD_BITMAP
 528     int scrollbar;    /* SCROLLBAR_* enum values */
 529     int scrollbar_width;
 530 #endif
 531
 532 #ifdef HAVE_TOUCHSCREEN
 533     int list_line_padding;
 534 #endif
 535
 536     /* goto current song when exiting WPS */
 537     bool browse_current; /* 1=goto current song,
 538                             0=goto previous location */
 539     bool scroll_paginated; /* 0=dont 1=do */
 540     int  scroll_speed;     /* long texts scrolling speed: 1-30 */
 541     int  bidir_limit;      /* bidir scroll length limit */
 542     int  scroll_delay;     /* delay (in 1/10s) before starting scroll */
 543     int  scroll_step;      /* pixels to advance per update */
 544
 545     /* auto bookmark settings */
 546     int autoloadbookmark;   /* auto load option: 0=off, 1=ask, 2=on */
 547     int autocreatebookmark; /* auto create option: 0=off, 1=ask, 2=on */
 548     bool autoupdatebookmark;/* auto update option */
 549     int usemrb;             /* use MRB list: 0=No, 1=Yes, 2=One per playlist */
 550
 551 #ifdef HAVE_DIRCACHE
 552     bool dircache;          /* enable directory cache */
 553 #endif
 554 #ifdef HAVE_TAGCACHE
 555 #ifdef HAVE_TC_RAMCACHE
 556     bool tagcache_ram;        /* load tagcache to ram? */
 557 #endif
 558     bool tagcache_autoupdate; /* automatically keep tagcache in sync? */
 559     bool autoresume_enable;   /* enable auto-resume feature? */
 560     int autoresume_automatic; /* resume next track? 0=never, 1=always,
 561                                  2=custom */
 562     unsigned char autoresume_paths[MAX_PATHNAME+1]; /* colon-separated list */
 563     bool runtimedb;           /* runtime database active? */
 564     unsigned char tagcache_scan_paths[MAX_PATHNAME+1];
 565 #endif /* HAVE_TAGCACHE */
 566
 567 #if LCD_DEPTH > 1
 568     unsigned char backdrop_file[MAX_PATHNAME+1];  /* backdrop bitmap file */
 569 #endif
 570
 571 #ifdef HAVE_LCD_COLOR
 572     int bg_color; /* background color native format */
 573     int fg_color; /* foreground color native format */
 574     int lss_color; /* background color for the selector or start color for the gradient */
 575     int lse_color; /* end color for the selector gradient */
 576     int lst_color; /* color of the text for the selector */
 577     unsigned char colors_file[MAX_FILENAME+1];
 578 #endif
 579
 580     /* playlist/playback settings */
 581     int  repeat_mode; /* 0=off 1=repeat all 2=repeat one 3=shuffle 4=ab */
 582     int  next_folder; /* move to next folder */
 583     bool constrain_next_folder; /* whether next_folder is constrained to
 584                                    directories within start_directory */
 585     int  recursive_dir_insert; /* should directories be inserted recursively */
 586     bool fade_on_stop; /* fade on pause/unpause/stop */
 587     bool playlist_shuffle;
 588     bool warnon_erase_dynplaylist; /* warn when erasing dynamic playlist */
 589
 590     /* playlist viewer settings */
 591     bool playlist_viewer_icons; /* display icons on viewer */
 592     bool playlist_viewer_indices; /* display playlist indices on viewer */
 593     int playlist_viewer_track_display; /* how to display tracks in viewer */
 594
 595     /* voice UI settings */
 596     bool talk_menu; /* enable voice UI */
 597     int talk_dir; /* voiced directories mode: 0=off 1=number 2=spell */
 598     bool talk_dir_clip; /* use directory .talk clips */
 599     int talk_file; /* voice file mode: 0=off, 1=number, 2=spell */
 600     bool talk_file_clip; /* use file .talk clips */
 601     bool talk_filetype; /* say file type */
 602     bool talk_battery_level;
 603
 604     /* file browser sorting */
 605     bool sort_case; /* dir sort order: 0=case insensitive, 1=sensitive */
 606     int sort_dir;   /* 0=alpha, 1=date (old first), 2=date (new first) */
 607     int sort_file;  /* 0=alpha, 1=date, 2=date (new first), 3=type */
 608     int interpret_numbers; /* true=strnatcmp, false=strcmp */
 609
 610     /* power settings */
 611     int poweroff;   /* idle power off timer */
 612 #if BATTERY_CAPACITY_DEFAULT > 0
 613     int battery_capacity; /* in mAh */
 614 #endif
 615
 616 #if BATTERY_TYPES_COUNT > 1
 617     int battery_type;  /* for units which can take multiple types (Ondio). */
 618 #endif
 619 #ifdef HAVE_SPDIF_POWER
 620     bool spdif_enable; /* S/PDIF power on/off */
 621 #endif
 622 #ifdef HAVE_USB_CHARGING_ENABLE
 623     int usb_charging;
 624 #endif
 625
 626     /* device settings */
 627 #ifdef HAVE_LCD_CONTRAST
 628     int contrast;   /* lcd contrast */
 629 #endif
 630
 631 #ifdef HAVE_LCD_BITMAP
 632 #ifdef HAVE_LCD_INVERT
 633     bool invert;    /* invert display */
 634 #endif
 635 #ifdef HAVE_LCD_FLIP
 636     bool flip_display; /* turn display (and button layout) by 180 degrees */
 637 #endif
 638     int  cursor_style; /* style of the selection cursor */
 639     int  screen_scroll_step;
 640     int  show_path_in_browser; /* 0=off, 1=current directory, 2=full path */
 641     bool offset_out_of_view;
 642     unsigned char icon_file[MAX_FILENAME+1];
 643     unsigned char viewers_icon_file[MAX_FILENAME+1];
 644     unsigned char font_file[MAX_FILENAME+1]; /* last font */
 645     int glyphs_to_cache; /* default font allocation size in glyphs */
 646 #ifdef HAVE_REMOTE_LCD
 647     unsigned char remote_font_file[MAX_FILENAME+1]; /* last font */
 648 #endif
 649     unsigned char kbd_file[MAX_FILENAME+1];  /* last keyboard */
 650 #endif /* HAVE_LCD_BITMAP */
 651     int  backlight_timeout;  /* backlight off timeout:  0-18 0=never,
 652                                1=always,
 653                                then according to timeout_values[] */
 654     bool caption_backlight; /* turn on backlight at end and start of track */
 655     bool bl_filter_first_keypress;   /* filter first keypress when dark? */
 656 #if CONFIG_CHARGING
 657     int backlight_timeout_plugged;
 658 #endif
 659 #ifdef HAVE_BACKLIGHT
 660 #ifdef HAS_BUTTON_HOLD
 661     int backlight_on_button_hold; /* what to do with backlight when hold
 662                                      switch is on */
 663 #endif
 664 #ifdef HAVE_LCD_SLEEP_SETTING
 665     int lcd_sleep_after_backlight_off; /* when to put lcd to sleep after backlight
 666                                           has turned off */
 667 #endif
 668 #endif
 669 #if defined(HAVE_BACKLIGHT_FADING_INT_SETTING)
 670     int backlight_fade_in;  /* backlight fade in timing: 0..3 */
 671     int backlight_fade_out; /* backlight fade in timing: 0..7 */
 672 #elif defined(HAVE_BACKLIGHT_FADING_BOOL_SETTING)
 673     bool backlight_fade_in;
 674     bool backlight_fade_out;
 675 #endif
 676 #ifdef HAVE_BACKLIGHT_BRIGHTNESS
 677     int brightness;
 678 #endif
 679
 680 #ifdef HAVE_REMOTE_LCD
 681     /* remote lcd */
 682     int  remote_contrast;          /* lcd contrast:       0-63 0=low 63=high */
 683     int  remote_backlight_timeout; /* backlight off timeout:  0-18 0=never,
 684                                    1=always, then according to timeout_values[] */
 685     int  remote_backlight_timeout_plugged;
 686     int  remote_scroll_speed;      /* long texts scrolling speed: 1-30 */
 687     int  remote_scroll_delay;      /* delay (in 1/10s) before starting scroll */
 688     int  remote_scroll_step;       /* pixels to advance per update */
 689     int  remote_bidir_limit;       /* bidir scroll length limit */
 690     bool remote_invert;            /* invert display */
 691     bool remote_flip_display;      /* turn display (and button layout) by 180 degrees */
 692     bool remote_caption_backlight; /* turn on backlight at end and start of track */
 693     bool remote_bl_filter_first_keypress; /* filter first remote keypress when remote dark? */
 694     unsigned char remote_icon_file[MAX_FILENAME+1];
 695     unsigned char remote_viewers_icon_file[MAX_FILENAME+1];
 696 #ifdef HAS_REMOTE_BUTTON_HOLD
 697     int remote_backlight_on_button_hold; /* what to do with remote backlight when hold
 698                                             switch is on */
 699 #endif
 700 #ifdef HAVE_REMOTE_LCD_TICKING
 701     bool remote_reduce_ticking; /* 0=normal operation,
 702                                    1=EMI reduce on with cost more CPU. */
 703 #endif
 704 #endif /* HAVE_REMOTE_LCD */
 705
 706 #if CONFIG_CODEC == MAS3507D
 707     bool line_in;       /* false=off, true=active */
 708 #endif
 709
 710 #ifdef HAVE_BUTTON_LIGHT
 711     int buttonlight_timeout;
 712 #endif
 713 #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
 714     int buttonlight_brightness;
 715 #endif
 716
 717 #ifdef IPOD_ACCESSORY_PROTOCOL
 718     int serial_bitrate; /* 0=auto 1=9600 2=19200 3=38400 4=57600 */
 719 #endif
 720 #ifdef HAVE_ACCESSORY_SUPPLY
 721     bool accessory_supply; /* 0=off 1=on, accessory power supply for iPod */
 722 #endif
 723 #ifdef HAVE_LINEOUT_POWEROFF
 724     bool lineout_active;
 725 #endif
 726
 727 #ifdef HAVE_SPEAKER
 728     bool speaker_enabled;
 729 #endif
 730     bool prevent_skip;
 731
 732 #ifdef HAVE_TOUCHSCREEN
 733     int touch_mode;
 734     struct touchscreen_parameter ts_calibration_data;
 735 #endif
 736
 737 #ifdef HAVE_PITCHCONTROL
 738     /* pitch screen settings */
 739     bool pitch_mode_semitone;
 740 #if CONFIG_CODEC == SWCODEC
 741     bool pitch_mode_timestretch;
 742 #endif
 743 #endif
 744     /* If values are just added to the end, no need to bump plugin API
 745        version. */
 746     /* new stuff to be added at the end */
 747
 748 #ifdef USB_ENABLE_HID
 749     bool usb_hid;
 750     int usb_keypad_mode;
 751 #endif
 752
 753 #if defined(USB_ENABLE_STORAGE) && defined(HAVE_MULTIDRIVE)
 754     bool usb_skip_first_drive;
 755 #endif
 756
 757 #ifdef HAVE_LCD_BITMAP
 758     unsigned char ui_vp_config[64]; /* viewport string for the lists */
 759 #ifdef HAVE_REMOTE_LCD
 760     unsigned char remote_ui_vp_config[64]; /* viewport string for the remote lists */
 761 #endif
 762 #endif
 763
 764 #if CONFIG_CODEC == SWCODEC
 765     struct compressor_settings compressor_settings;
 766 #endif
 767
 768     int sleeptimer_duration; /* In minutes; 0=off */
 769     bool sleeptimer_on_startup;
 770     bool keypress_restarts_sleeptimer;
 771
 772 #ifdef HAVE_MORSE_INPUT
 773     bool morse_input; /* text input method setting */
 774 #endif
 775
 776 #ifdef HAVE_HOTKEY
 777     /* hotkey assignments - acceptable values are in
 778        hotkey_action enum in onplay.h */
 779     int hotkey_wps;
 780     int hotkey_tree;
 781 #endif
 782
 783 #if CONFIG_CODEC == SWCODEC
 784     /* When resuming playback (after a stop), rewind this number of seconds */
 785     int resume_rewind;
 786 #endif
 787
 788 #ifdef AUDIOHW_HAVE_DEPTH_3D
 789     int depth_3d;
 790 #endif
 791
 792 #ifdef AUDIOHW_HAVE_EQ
 793     /** Hardware EQ tone controls **/
 794     struct hw_eq_band
 795     {
 796         /* Maintain the order of members or sound_menu has to be changed */
 797         int gain;
 798 #ifdef AUDIOHW_HAVE_EQ_FREQUENCY
 799         int frequency;
 800 #endif
 801 #ifdef AUDIOHW_HAVE_EQ_WIDTH
 802         int width;
 803 #endif
 804     } hw_eq_bands[AUDIOHW_EQ_BAND_NUM];
 805 #endif /* AUDIOHW_HAVE_EQ */
 806
 807 #ifdef HAVE_HARDWARE_CLICK
 808 #if CONFIG_CODEC == SWCODEC
 809     bool keyclick_hardware; /* hardware piezo keyclick */
 810 #endif
 811 #endif
 812
 813     char start_directory[MAX_PATHNAME+1];
 814     /* Has the root been customized from the .cfg file? false = no, true = loaded from cfg */
 815     bool root_menu_customized;
 816 #ifdef HAVE_QUICKSCREEN
 817     bool shortcuts_replaces_qs;
 818 #endif
 819 };
 820
 821 /** global variables **/
 822 extern long lasttime;
 823 /* global settings */
 824 extern struct user_settings global_settings;
 825 /* global status */
 826 extern struct system_status global_status;
 827
 828 #endif /* __SETTINGS_H__ */