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