/*************************************************************************** * __________ __ ___. * 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 #include "inttypes.h" #include "config.h" #include "audiohw.h" /* for the AUDIOHW_* defines */ #include "statusbar.h" /* for the statusbar values */ #include "quickscreen.h" #include "button.h" #include "audio.h" #include "dsp_proc_settings.h" struct opt_items { unsigned const char* string; int32_t voice_id; }; /** Setting values defines **/ #define MAX_FILENAME 32 #define MAX_PATHNAME 80 /* The values are assigned to the enums so that they correspond to */ /* setting values in settings_list.c */ /* Shared by all bookmark parameters */ enum { BOOKMARK_NO = 0, BOOKMARK_YES = 1, }; /* Auto create bookmark */ enum { BOOKMARK_ASK = 2, BOOKMARK_RECENT_ONLY_YES = 3, BOOKMARK_RECENT_ONLY_ASK = 4, }; /* Most recent bookmark */ enum { BOOKMARK_ONE_PER_PLAYLIST = 2, BOOKMARK_ONE_PER_TRACK = 3, }; enum { TRIG_MODE_OFF = 0, TRIG_MODE_NOREARM, TRIG_MODE_REARM }; enum { TRIG_TYPE_STOP = 0, TRIG_TYPE_PAUSE, TRIG_TYPE_NEW_FILE }; #ifdef HAVE_CROSSFADE enum { CROSSFADE_ENABLE_OFF = 0, CROSSFADE_ENABLE_AUTOSKIP, CROSSFADE_ENABLE_MANSKIP, CROSSFADE_ENABLE_SHUFFLE, CROSSFADE_ENABLE_SHUFFLE_OR_MANSKIP, CROSSFADE_ENABLE_ALWAYS, }; #endif enum { FOLDER_ADVANCE_OFF = 0, FOLDER_ADVANCE_NEXT, FOLDER_ADVANCE_RANDOM, }; /* repeat mode options */ enum { REPEAT_OFF = 0, REPEAT_ALL, REPEAT_ONE, REPEAT_SHUFFLE, #ifdef AB_REPEAT_ENABLE REPEAT_AB, #endif NUM_REPEAT_MODES }; /* single mode options */ enum { SINGLE_MODE_OFF = 0, SINGLE_MODE_TRACK, SINGLE_MODE_ALBUM, SINGLE_MODE_ALBUM_ARTIST, SINGLE_MODE_ARTIST, SINGLE_MODE_COMPOSER, SINGLE_MODE_GROUPING, SINGLE_MODE_GENRE }; enum { QUEUE_HIDE = 0, QUEUE_SHOW_AT_TOPLEVEL, QUEUE_SHOW_IN_SUBMENU }; #ifdef HAVE_ALBUMART enum { AA_OFF = 0, AA_PREFER_EMBEDDED, AA_PREFER_IMAGE_FILE }; #endif /* 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_FMS, SHOW_RFMS, SHOW_SBS, SHOW_RSBS, SHOW_FMR, SHOW_CFG, SHOW_LNG, SHOW_MOD, SHOW_FONT, SHOW_PLUGINS, SHOW_M3U}; /* 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 */ enum { SORT_INTERPRET_AS_DIGIT, SORT_INTERPRET_AS_NUMBER }; /* recursive dir insert options */ enum { RECURSE_OFF, RECURSE_ON, RECURSE_ASK }; /* show path types */ enum { SHOW_PATH_OFF = 0, SHOW_PATH_CURRENT, SHOW_PATH_FULL }; /* scrollbar visibility/position */ enum { SCROLLBAR_OFF = 0, SCROLLBAR_LEFT, SCROLLBAR_RIGHT }; /* autoresume settings */ enum { AUTORESUME_NEXTTRACK_NEVER = 0, AUTORESUME_NEXTTRACK_ALWAYS, AUTORESUME_NEXTTRACK_CUSTOM}; /* 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 */ /* Keyclick stuff */ /* Not really a setting but several files should stay synced */ #define KEYCLICK_DURATION 2 /** 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 */ #if defined(CPU_S5L870X) /* the S5L870X has IRAM at 0, so we use 0xffff bytes right after that */ #define VIRT_PTR ((unsigned char*)0x40000) #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 list_separator_height; /* -1=auto (== 1 currently), 0=disabled, X=height in pixels */ int list_separator_color; #endif /* goto current song when exiting WPS */ bool browse_current; /* 1=goto current song, 0=goto previous location */ bool scroll_paginated; /* 0=dont 1=do */ bool list_wraparound; /* wrap around to opposite end of list when scrolling */ int list_order; /* order for numeric lists (ascending or descending) */ 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 */ /* 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 */ bool autoupdatebookmark;/* auto update option */ int usemrb; /* use MRB list: 0=No, 1=Yes, 2=One per playlist, 3=One per playlist and track */ #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? */ bool autoresume_enable; /* enable auto-resume feature? */ int autoresume_automatic; /* resume next track? 0=never, 1=always, 2=custom */ unsigned char autoresume_paths[MAX_PATHNAME+1]; /* colon-separated list */ bool runtimedb; /* runtime database active? */ unsigned char tagcache_scan_paths[MAX_PATHNAME+1]; unsigned char tagcache_db_path[MAX_PATHNAME+1]; #endif /* HAVE_TAGCACHE */ #if LCD_DEPTH > 1 unsigned char backdrop_file[MAX_PATHNAME+1]; /* backdrop bitmap file */ #endif #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 */ unsigned char colors_file[MAX_FILENAME+1]; #endif /* playlist/playback settings */ int repeat_mode; /* 0=off 1=repeat all 2=repeat one 3=shuffle 4=ab */ int next_folder; /* move to next folder */ bool constrain_next_folder; /* whether next_folder is constrained to directories within start_directory */ int recursive_dir_insert; /* should directories be inserted recursively */ bool playlist_reload_after_save; /* reload and resume playlist after saving */ bool fade_on_stop; /* fade on pause/unpause/stop */ bool playlist_shuffle; bool warnon_erase_dynplaylist; /* warn when erasing dynamic playlist */ bool keep_current_track_on_replace_playlist; bool show_shuffled_adding_options; /* whether to display options for adding shuffled tracks to dynamic playlist */ int show_queue_options; /* how and whether to display options to queue tracks */ #ifdef HAVE_ALBUMART int album_art; /* switch off album art display or choose preferred source */ #endif bool rewind_across_tracks; /* 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; int talk_mixer_amp; /* Relative volume of voices, MIX_AMP_MPUTE->MIX_AMP_UNITY */ /* file browser sorting */ bool sort_case; /* dir sort order: 0=case insensitive, 1=sensitive */ int sort_dir; /* 0=alpha, 1=date (old first), 2=date (new first) */ int sort_file; /* 0=alpha, 1=date, 2=date (new first), 3=type */ int interpret_numbers; /* true=strnatcmp, false=strcmp */ /* power settings */ int poweroff; /* idle power off timer */ #if BATTERY_CAPACITY_INC > 0 int battery_capacity; /* in mAh */ #endif #if BATTERY_TYPES_COUNT > 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 #ifdef HAVE_USB_CHARGING_ENABLE int usb_charging; #endif /* device settings */ #ifdef HAVE_LCD_CONTRAST int contrast; /* lcd contrast */ #endif #ifdef HAVE_LCD_INVERT bool invert; /* invert display */ #endif #ifdef HAVE_LCD_FLIP bool flip_display; /* turn display (and button layout) by 180 degrees */ #endif int cursor_style; /* style of the selection cursor */ int screen_scroll_step; int show_path_in_browser; /* 0=off, 1=current directory, 2=full path */ bool offset_out_of_view; unsigned char icon_file[MAX_FILENAME+1]; unsigned char viewers_icon_file[MAX_FILENAME+1]; unsigned char font_file[MAX_FILENAME+1]; /* last font */ int glyphs_to_cache; /* default font allocation size in glyphs */ #ifdef HAVE_REMOTE_LCD unsigned char remote_font_file[MAX_FILENAME+1]; /* last font */ #endif unsigned char kbd_file[MAX_FILENAME+1]; /* last keyboard */ int backlight_timeout; /* backlight off timeout: -1=never, 0=always, or time in seconds */ bool caption_backlight; /* turn on backlight at end and start of track */ bool bl_filter_first_keypress; /* filter first keypress when dark? */ #if CONFIG_CHARGING int backlight_timeout_plugged; #endif #ifndef HAS_BUTTON_HOLD bool bt_selective_softlock_actions; int bt_selective_softlock_actions_mask; #endif #ifdef HAVE_BACKLIGHT bool bl_selective_actions; /* backlight disable on some actions */ int bl_selective_actions_mask;/* mask of actions that will not enable backlight */ #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: -1=never, 0=always, or time in seconds */ #endif #endif /* HAVE_BACKLIGHT */ #if defined(HAVE_BACKLIGHT_FADING_INT_SETTING) int backlight_fade_in; /* backlight fade in timing: 0..3 */ int backlight_fade_out; /* backlight fade in timing: 0..7 */ #elif defined(HAVE_BACKLIGHT_FADING_BOOL_SETTING) bool backlight_fade_in; bool backlight_fade_out; #endif #ifdef HAVE_BACKLIGHT_BRIGHTNESS int brightness; #endif #ifdef HAVE_REMOTE_LCD /* remote lcd */ int remote_contrast; /* lcd contrast: 0-63 0=low 63=high */ int remote_backlight_timeout; /* backlight off timeout: -1=never, 0=always, or time in seconds */ int remote_backlight_timeout_plugged; 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 */ bool remote_invert; /* invert display */ bool remote_flip_display; /* turn display (and button layout) by 180 degrees */ bool remote_caption_backlight; /* turn on backlight at end and start of track */ bool remote_bl_filter_first_keypress; /* filter first remote keypress when remote dark? */ unsigned char remote_icon_file[MAX_FILENAME+1]; unsigned char remote_viewers_icon_file[MAX_FILENAME+1]; #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 */ #ifdef HAVE_BUTTON_LIGHT int buttonlight_timeout; #endif #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS int buttonlight_brightness; #endif #ifdef IPOD_ACCESSORY_PROTOCOL int serial_bitrate; /* 0=auto 1=9600 2=19200 3=38400 4=57600 */ #endif #ifdef HAVE_ACCESSORY_SUPPLY bool accessory_supply; /* 0=off 1=on, accessory power supply for iPod */ #endif #ifdef HAVE_LINEOUT_POWEROFF bool lineout_active; #endif #ifdef HAVE_SPEAKER int speaker_mode; /* 0: off, 1: on, 2: auto (only if headphone detection) */ #endif /* HAVE_SPEAKER */ bool prevent_skip; #ifdef HAVE_TOUCHSCREEN int touch_mode; struct touchscreen_parameter ts_calibration_data; #endif #ifdef HAVE_PITCHCONTROL /* pitch screen settings */ bool pitch_mode_semitone; bool pitch_mode_timestretch; #endif /* If values are just added to the end, no need to bump plugin API version. */ /* new stuff to be added at the end */ #ifdef USB_ENABLE_HID bool usb_hid; int usb_keypad_mode; #endif #if defined(USB_ENABLE_STORAGE) && defined(HAVE_MULTIDRIVE) bool usb_skip_first_drive; #endif unsigned char ui_vp_config[64]; /* viewport string for the lists */ #ifdef HAVE_REMOTE_LCD unsigned char remote_ui_vp_config[64]; /* viewport string for the remote lists */ #endif struct compressor_settings compressor_settings; int sleeptimer_duration; /* In minutes; 0=off */ bool sleeptimer_on_startup; bool keypress_restarts_sleeptimer; bool show_shutdown_message; /* toggle whether display lights up and displays message when shutting down */ #ifdef HAVE_MORSE_INPUT bool morse_input; /* text input method setting */ #endif #ifdef HAVE_HOTKEY /* hotkey assignments - acceptable values are in hotkey_action enum in onplay.h */ int hotkey_wps; int hotkey_tree; #endif /* When resuming playback (after a stop), rewind this number of seconds */ int resume_rewind; #ifdef AUDIOHW_HAVE_DEPTH_3D int depth_3d; #endif #ifdef AUDIOHW_HAVE_FILTER_ROLL_OFF int roll_off; #endif #ifdef AUDIOHW_HAVE_POWER_MODE int power_mode; #endif #ifdef AUDIOHW_HAVE_EQ /** Hardware EQ tone controls **/ struct hw_eq_band { /* Maintain the order of members or sound_menu has to be changed */ int gain; #ifdef AUDIOHW_HAVE_EQ_FREQUENCY int frequency; #endif #ifdef AUDIOHW_HAVE_EQ_WIDTH int width; #endif } hw_eq_bands[AUDIOHW_EQ_BAND_NUM]; #endif /* AUDIOHW_HAVE_EQ */ #ifdef HAVE_HARDWARE_CLICK bool keyclick_hardware; /* hardware piezo keyclick */ #endif char start_directory[MAX_PATHNAME+1]; /* Has the root been customized from the .cfg file? false = no, true = loaded from cfg */ bool root_menu_customized; #ifdef HAVE_QUICKSCREEN bool shortcuts_replaces_qs; #endif #ifdef HAVE_PLAY_FREQ int play_frequency; /* core audio output frequency selection */ #endif int volume_limit; /* maximum volume limit */ #ifdef HAVE_PERCEPTUAL_VOLUME int volume_adjust_mode; int volume_adjust_norm_steps; #endif int surround_enabled; int surround_balance; int surround_fx1; int surround_fx2; bool surround_method2; int surround_mix; int pbe; int pbe_precut; int afr_enabled; #if defined(DX50) || defined(DX90) int governor; #endif #if defined(DX50) || defined(DX90) || (defined(HAVE_USB_POWER) && !defined(USB_NONE) && !defined(SIMULATOR)) int usb_mode; #endif #if defined(BUTTON_REC) || \ (CONFIG_KEYPAD == GIGABEAT_PAD) || \ (CONFIG_KEYPAD == IPOD_4G_PAD) || \ (CONFIG_KEYPAD == IRIVER_H10_PAD) bool clear_settings_on_hold; #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__ */