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