/*************************************************************************** * __________ __ ___. * Open \______ \ ____ ____ | | _\_ |__ _______ ___ * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ / * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < < * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \ * \/ \/ \/ \/ \/ * $Id$ * * Copyright (C) 2002 by Stuart Martin * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY * KIND, either express or implied. * ****************************************************************************/ #ifndef __SETTINGS_H__ #define __SETTINGS_H__ #include #include "inttypes.h" #include "config.h" #include "file.h" #include "dircache.h" #include "timefuncs.h" #include "tagcache.h" #ifndef __PCTOOL__ #include "button.h" #endif #if CONFIG_CODEC == SWCODEC #include "audio.h" #endif #ifdef HAVE_BACKLIGHT_BRIGHTNESS #include "backlight.h" /* for [MIN|MAX]_BRIGHTNESS_SETTING */ #endif struct opt_items { unsigned const char* string; int32_t voice_id; }; /** Setting values defines **/ /* name of directory where configuration, fonts and other data * files are stored */ #ifdef __PCTOOL__ #undef ROCKBOX_DIR #undef ROCKBOX_DIR_LEN #undef WPS_DIR #define ROCKBOX_DIR "." #define ROCKBOX_DIR_LEN 1 #else #define ROCKBOX_DIR "/.rockbox" #define ROCKBOX_DIR_LEN 9 #endif #define FONT_DIR ROCKBOX_DIR "/fonts" #define LANG_DIR ROCKBOX_DIR "/langs" #define WPS_DIR ROCKBOX_DIR "/wps" #define THEME_DIR ROCKBOX_DIR "/themes" #define ICON_DIR ROCKBOX_DIR "/icons" #define PLUGIN_DIR ROCKBOX_DIR "/rocks" #define PLUGIN_GAMES_DIR PLUGIN_DIR "/games" #define PLUGIN_APPS_DIR PLUGIN_DIR "/apps" #define PLUGIN_DEMOS_DIR PLUGIN_DIR "/demos" #define VIEWERS_DIR PLUGIN_DIR "/viewers" #define BACKDROP_DIR ROCKBOX_DIR "/backdrops" #define REC_BASE_DIR "/" #define EQS_DIR ROCKBOX_DIR "/eqs" #define CODECS_DIR ROCKBOX_DIR "/codecs" #define RECPRESETS_DIR ROCKBOX_DIR "/recpresets" #define FMPRESET_PATH ROCKBOX_DIR "/fmpresets" #define PLAYLIST_CATALOG_DEFAULT_DIR "/Playlists" #define VIEWERS_CONFIG ROCKBOX_DIR "/viewers.config" #define CONFIGFILE ROCKBOX_DIR "/config.cfg" #define FIXEDSETTINGSFILE ROCKBOX_DIR "/fixed.cfg" #define MAX_FILENAME 32 #define BOOKMARK_NO 0 #define BOOKMARK_YES 1 #define BOOKMARK_ASK 2 #define BOOKMARK_UNIQUE_ONLY 2 #define BOOKMARK_RECENT_ONLY_YES 3 #define BOOKMARK_RECENT_ONLY_ASK 4 enum { TRIG_MODE_OFF = 0, TRIG_MODE_NOREARM, TRIG_MODE_REARM }; enum { TRIG_TYPE_STOP = 0, TRIG_TYPE_PAUSE, TRIG_TYPE_NEW_FILE }; #define CROSSFADE_ENABLE_SHUFFLE 1 #define CROSSFADE_ENABLE_TRACKSKIP 2 #define CROSSFADE_ENABLE_SHUFFLE_AND_TRACKSKIP 3 #define CROSSFADE_ENABLE_ALWAYS 4 #define FOLDER_ADVANCE_OFF 0 #define FOLDER_ADVANCE_NEXT 1 #define FOLDER_ADVANCE_RANDOM 2 /* repeat mode options */ enum { REPEAT_OFF, REPEAT_ALL, REPEAT_ONE, REPEAT_SHUFFLE, #ifdef AB_REPEAT_ENABLE REPEAT_AB, #endif NUM_REPEAT_MODES }; /* dir filter options */ /* Note: Any new filter modes need to be added before NUM_FILTER_MODES. * Any new rockbox browse filter modes (accessible through the menu) * must be added after NUM_FILTER_MODES. */ enum { SHOW_ALL, SHOW_SUPPORTED, SHOW_MUSIC, SHOW_PLAYLIST, SHOW_ID3DB, NUM_FILTER_MODES, SHOW_WPS, SHOW_RWPS, SHOW_FMR, SHOW_CFG, SHOW_LNG, SHOW_MOD, SHOW_FONT, SHOW_PLUGINS}; /* file and dir sort options */ enum { SORT_ALPHA, SORT_DATE, SORT_DATE_REVERSED, SORT_TYPE, /* available as settings */ SORT_ALPHA_REVERSED, SORT_TYPE_REVERSED }; /* internal use only */ /* recursive dir insert options */ enum { RECURSE_OFF, RECURSE_ON, RECURSE_ASK }; /* replaygain types */ enum { REPLAYGAIN_TRACK = 0, REPLAYGAIN_ALBUM, REPLAYGAIN_SHUFFLE }; /* show path types */ enum { SHOW_PATH_OFF = 0, SHOW_PATH_CURRENT, SHOW_PATH_FULL }; /* Alarm settings */ #ifdef HAVE_RTC_ALARM enum { ALARM_START_WPS = 0, #if CONFIG_TUNER ALARM_START_FM, #endif #ifdef HAVE_RECORDING ALARM_START_REC, #endif ALARM_START_COUNT }; #if CONFIG_TUNER && defined(HAVE_RECORDING) #define ALARM_SETTING_TEXT "wps,fm,rec" #elif CONFIG_TUNER #define ALARM_SETTING_TEXT "wps,fm" #elif defined(HAVE_RECORDING) #define ALARM_SETTING_TEXT "wps,rec" #endif #endif /* HAVE_RTC_ALARM */ /** virtual pointer stuff.. move to another .h maybe? **/ /* These define "virtual pointers", which could either be a literal string, or a mean a string ID if the pointer is in a certain range. This helps to save space for menus and options. */ #define VIRT_SIZE 0xFFFF /* more than enough for our string ID range */ #ifdef SIMULATOR /* a space which is defined in stubs.c */ extern unsigned char vp_dummy[VIRT_SIZE]; #define VIRT_PTR vp_dummy #elif CONFIG_CPU==DM320 /* the DM320 has IRAM at 0, so we use 0xffff bytes right after that */ #define VIRT_PTR ((unsigned char*)0x4000) #else /* a location where we won't store strings, 0 is the fastest */ #define VIRT_PTR ((unsigned char*)0) #endif /* form a "virtual pointer" out of a language ID */ #define ID2P(id) (VIRT_PTR + id) /* resolve a pointer which could be a virtualized ID or a literal */ #define P2STR(p) (char *)((p>=VIRT_PTR && p=VIRT_PTR && p 1 int battery_type; /* for units which can take multiple types (Ondio). */ #endif #ifdef HAVE_SPDIF_POWER bool spdif_enable; /* S/PDIF power on/off */ #endif #if CONFIG_TUNER unsigned char fmr_file[MAX_FILENAME+1]; /* last fmr preset */ #endif #ifdef HAVE_LCD_BITMAP unsigned char font_file[MAX_FILENAME+1]; /* last font */ #endif unsigned char wps_file[MAX_FILENAME+1]; /* last wps */ unsigned char lang_file[MAX_FILENAME+1]; /* last language */ /* misc options */ int repeat_mode; /* 0=off 1=repeat all 2=repeat one 3=shuffle 4=ab */ int dirfilter; /* 0=display all, 1=only supported, 2=only music, 3=dirs+playlists, 4=ID3 database */ bool sort_case; /* dir sort order: 0=case insensitive, 1=sensitive */ int show_filename_ext; /* show filename extensions in file browser? 0 = no, 1 = yes, 2 = only unknown 0 */ int volume_type; /* how volume is displayed: 0=graphic, 1=percent */ int battery_display; /* how battery is displayed: 0=graphic, 1=percent */ int timeformat; /* time format: 0=24 hour clock, 1=12 hour clock */ bool playlist_shuffle; bool play_selected; /* Plays selected file even in shuffle mode */ int ff_rewind_min_step; /* FF/Rewind minimum step size */ int ff_rewind_accel; /* FF/Rewind acceleration (in seconds per doubling) */ #ifdef HAVE_DISK_STORAGE int disk_spindown; /* time until disk spindown, in seconds (0=off) */ int buffer_margin; /* MP3 buffer watermark margin, in seconds */ #endif int peak_meter_release; /* units per read out */ int peak_meter_hold; /* hold time for peak meter in 1/100 s */ int peak_meter_clip_hold; /* hold time for clips */ bool peak_meter_dbfs; /* show linear or dbfs values */ int peak_meter_min; /* range minimum */ int peak_meter_max; /* range maximum */ #ifdef HAVE_RECORDING bool peak_meter_clipcounter; /* clipping count indicator */ #endif bool car_adapter_mode; /* 0=off 1=on */ #ifdef HAVE_ACCESSORY_SUPPLY bool accessory_supply; /* 0=off 1=on, accessory power supply for iPod */ #endif /* show status bar */ bool statusbar; /* 0=hide, 1=show */ #if CONFIG_KEYPAD == RECORDER_PAD /* show button bar */ bool buttonbar; /* 0=hide, 1=show */ #endif /* show scroll bar */ bool scrollbar; /* 0=hide, 1=show */ /* goto current song when exiting WPS */ bool browse_current; /* 1=goto current song, 0=goto previous location */ int scroll_speed; /* long texts scrolling speed: 1-30 */ int bidir_limit; /* bidir scroll length limit */ int scroll_delay; /* delay (in 1/10s) before starting scroll */ int scroll_step; /* pixels to advance per update */ #ifdef HAVE_REMOTE_LCD int remote_scroll_speed; /* long texts scrolling speed: 1-30 */ int remote_scroll_delay; /* delay (in 1/10s) before starting scroll */ int remote_scroll_step; /* pixels to advance per update */ int remote_bidir_limit; /* bidir scroll length limit */ #endif #ifdef HAVE_LCD_BITMAP bool offset_out_of_view; int screen_scroll_step; #endif /* auto bookmark settings */ int autoloadbookmark; /* auto load option: 0=off, 1=ask, 2=on */ int autocreatebookmark; /* auto create option: 0=off, 1=ask, 2=on */ int usemrb; /* use MRB list: 0=No, 1=Yes*/ #ifdef HAVE_LCD_CHARCELLS int jump_scroll; /* Fast jump when scrolling */ int jump_scroll_delay; /* Delay between jump scroll screens */ #endif bool fade_on_stop; /* fade on pause/unpause/stop */ bool caption_backlight; /* turn on backlight at end and start of track */ #if CONFIG_TUNER int fm_freq_step; /* Frequency step for manual tuning, in kHz */ bool fm_force_mono; /* Forces Mono mode if true */ bool fm_full_range; /* Enables full 10MHz-160MHz range if true, else only 88MHz-108MHz */ #endif int max_files_in_dir; /* Max entries in directory (file browser) */ int max_files_in_playlist; /* Max entries in playlist */ bool show_icons; /* 0=hide 1=show */ int recursive_dir_insert; /* should directories be inserted recursively */ #if CONFIG_CODEC == MAS3507D bool line_in; /* false=off, true=active */ #endif /* playlist viewer settings */ bool playlist_viewer_icons; /* display icons on viewer */ bool playlist_viewer_indices; /* display playlist indices on viewer */ int playlist_viewer_track_display; /* how to display tracks in viewer */ /* voice UI settings */ bool talk_menu; /* enable voice UI */ int talk_dir; /* voiced directories mode: 0=off 1=number 2=spell */ bool talk_dir_clip; /* use directory .talk clips */ int talk_file; /* voice file mode: 0=off, 1=number, 2=spell */ bool talk_file_clip; /* use file .talk clips */ bool talk_filetype; /* say file type */ bool talk_battery_level; /* file browser sorting */ int sort_file; /* 0=alpha, 1=date, 2=date (new first), 3=type */ int sort_dir; /* 0=alpha, 1=date (old first), 2=date (new first) */ #ifdef HAVE_REMOTE_LCD /* remote lcd */ int remote_contrast; /* lcd contrast: 0-63 0=low 63=high */ bool remote_invert; /* invert display */ bool remote_flip_display; /* turn display (and button layout) by 180 degrees */ int remote_backlight_timeout; /* backlight off timeout: 0-18 0=never, 1=always, then according to timeout_values[] */ int remote_backlight_timeout_plugged; bool remote_caption_backlight; /* turn on backlight at end and start of track */ #ifdef HAS_REMOTE_BUTTON_HOLD int remote_backlight_on_button_hold; /* what to do with remote backlight when hold switch is on */ #endif #ifdef HAVE_REMOTE_LCD_TICKING bool remote_reduce_ticking; /* 0=normal operation, 1=EMI reduce on with cost more CPU. */ #endif #endif /* HAVE_REMOTE_LCD */ int next_folder; /* move to next folder */ bool runtimedb; /* runtime database active? */ #if CONFIG_CODEC == SWCODEC bool replaygain; /* enable replaygain */ bool replaygain_noclip; /* scale to prevent clips */ int replaygain_type; /* 0=track gain, 1=album gain, 2=track gain if shuffle is on, album gain otherwise */ int replaygain_preamp; /* scale replaygained tracks by this */ int beep; /* system beep volume when changing tracks etc. */ /* Crossfeed settings */ bool crossfeed; /* enable crossfeed */ unsigned int crossfeed_direct_gain; /* dB x 10 */ unsigned int crossfeed_cross_gain; /* dB x 10 */ unsigned int crossfeed_hf_attenuation; /* dB x 10 */ unsigned int crossfeed_hf_cutoff; /* Frequency in Hz */ #endif #ifdef HAVE_DIRCACHE bool dircache; /* enable directory cache */ #endif #ifdef HAVE_TAGCACHE #ifdef HAVE_TC_RAMCACHE bool tagcache_ram; /* load tagcache to ram? */ #endif bool tagcache_autoupdate; /* automatically keep tagcache in sync? */ #endif int default_codepage; /* set default codepage for tag conversion */ #ifdef HAVE_REMOTE_LCD unsigned char rwps_file[MAX_FILENAME+1]; /* last remote-wps */ #endif #if CONFIG_CODEC == SWCODEC bool eq_enabled; /* Enable equalizer */ unsigned int eq_precut; /* dB */ /* Order is important here, must be cutoff, q, then gain for each band. See dsp_eq_update_data in dsp.c for why. */ /* Band 0 settings */ int eq_band0_cutoff; /* Hz */ int eq_band0_q; int eq_band0_gain; /* +/- dB */ /* Band 1 settings */ int eq_band1_cutoff; /* Hz */ int eq_band1_q; int eq_band1_gain; /* +/- dB */ /* Band 2 settings */ int eq_band2_cutoff; /* Hz */ int eq_band2_q; int eq_band2_gain; /* +/- dB */ /* Band 3 settings */ int eq_band3_cutoff; /* Hz */ int eq_band3_q; int eq_band3_gain; /* +/- dB */ /* Band 4 settings */ int eq_band4_cutoff; /* Hz */ int eq_band4_q; int eq_band4_gain; /* +/- dB */ bool dithering_enabled; #endif #if LCD_DEPTH > 1 unsigned char backdrop_file[MAX_FILENAME+1]; /* backdrop bitmap file */ #endif bool warnon_erase_dynplaylist; /* warn when erasing dynamic playlist */ bool scroll_paginated; /* 0=dont 1=do */ #ifdef HAVE_LCD_COLOR int bg_color; /* background color native format */ int fg_color; /* foreground color native format */ int lss_color; /* background color for the selector or start color for the gradient */ int lse_color; /* end color for the selector gradient */ int lst_color; /* color of the text for the selector */ #endif bool party_mode; /* party mode - unstoppable music */ #ifdef HAVE_BACKLIGHT bool bl_filter_first_keypress; /* filter first keypress when dark? */ #ifdef HAVE_REMOTE_LCD bool remote_bl_filter_first_keypress; /* filter first remote keypress when remote dark? */ #endif #ifdef HAS_BUTTON_HOLD int backlight_on_button_hold; /* what to do with backlight when hold switch is on */ #endif #ifdef HAVE_LCD_SLEEP_SETTING int lcd_sleep_after_backlight_off; /* when to put lcd to sleep after backlight has turned off */ #endif #endif /* HAVE_BACKLIGHT */ #ifdef HAVE_LCD_BITMAP unsigned char kbd_file[MAX_FILENAME+1]; /* last keyboard */ #endif #ifdef HAVE_USB_POWER #if CONFIG_CHARGING bool usb_charging; #endif #endif bool hold_lr_for_scroll_in_list; /* hold L/R scrolls the list left/right */ #ifdef HAVE_LCD_BITMAP int show_path_in_browser; /* 0=off, 1=current directory, 2=full path */ #endif #ifdef HAVE_HEADPHONE_DETECTION int unplug_mode; /* pause on headphone unplug */ int unplug_rw; /* time in s to rewind when pausing */ bool unplug_autoresume; /* disable auto-resume if no phones */ #endif #if CONFIG_TUNER int fm_region; #endif bool audioscrobbler; /* Audioscrobbler logging */ /* If values are just added to the end, no need to bump plugin API version. */ /* new stuff to be added at the end */ #if defined(HAVE_RECORDING) && CONFIG_CODEC == SWCODEC /* Encoder Settings Start - keep these together */ struct mp3_enc_config mp3_enc_config; #if 0 /* These currently contain no members but their places in line should be held */ struct aiff_enc_config aiff_enc_config; struct wav_enc_config wav_enc_config; struct wavpack_enc_config wavpack_enc_config; #endif /* Encoder Settings End */ #endif /* CONFIG_CODEC == SWCODEC */ bool cuesheet; int start_in_screen; #if defined(HAVE_RTC_ALARM) && \ (defined(HAVE_RECORDING) || CONFIG_TUNER) int alarm_wake_up_screen; #endif /* customizable icons */ #ifdef HAVE_LCD_BITMAP unsigned char icon_file[MAX_FILENAME+1]; unsigned char viewers_icon_file[MAX_FILENAME+1]; #endif #ifdef HAVE_REMOTE_LCD unsigned char remote_icon_file[MAX_FILENAME+1]; unsigned char remote_viewers_icon_file[MAX_FILENAME+1]; #endif #ifdef HAVE_LCD_COLOR unsigned char colors_file[MAX_FILENAME+1]; #endif #ifdef HAVE_BUTTON_LIGHT int buttonlight_timeout; #endif #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS int buttonlight_brightness; #endif #ifndef HAVE_SCROLLWHEEL int list_accel_start_delay; /* ms before we start increaseing step size */ int list_accel_wait; /* ms between increases */ #endif #ifdef HAVE_USBSTACK int usb_stack_mode; /* device or host */ unsigned char usb_stack_device_driver[32]; /* usb device driver to load */ #endif #if CONFIG_CODEC == SWCODEC int keyclick; /* keyclick volume */ int keyclick_repeats; /* keyclick on repeats */ #endif unsigned char playlist_catalog_dir[MAX_FILENAME+1]; int skip_length; /* skip length */ #ifdef HAVE_TOUCHPAD_SENSITIVITY_SETTING int touchpad_sensitivity; #endif #ifdef HAVE_QUICKSCREEN /* these are split because settings_list cant handle arrays */ int qs_item_left; int qs_item_right; int qs_item_bottom; #endif }; /** global variables **/ extern long lasttime; /* global settings */ extern struct user_settings global_settings; /* global status */ extern struct system_status global_status; #endif /* __SETTINGS_H__ */