1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2002 Björn Stenberg
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.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
31 #include "backlight.h"
32 #include "sound_menu.h"
34 #include "powermgmt.h"
37 #include "option_select.h"
43 #include "diacritic.h"
44 #include "filefuncs.h"
45 #include "load_code.h"
51 #ifdef HAVE_LCD_BITMAP
52 #include "scrollbar.h"
53 #include "peakmeter.h"
59 #include "usbstack/usb_hid.h"
62 #if defined (SIMULATOR)
63 #define PREFIX(_x_) sim_ ## _x_
64 #elif defined (APPLICATION)
65 #define PREFIX(_x_) app_ ## _x_
70 #if defined (APPLICATION)
71 /* For symmetry reasons (we want app_ and sim_ to behave similarly), some
72 * wrappers are needed */
73 static int app_close(int fd
)
78 static ssize_t
app_read(int fd
, void *buf
, size_t count
)
80 return read(fd
,buf
,count
);
83 static off_t
app_lseek(int fd
, off_t offset
, int whence
)
85 return lseek(fd
,offset
,whence
);
88 static ssize_t
app_write(int fd
, const void *buf
, size_t count
)
90 return write(fd
,buf
,count
);
93 static int app_ftruncate(int fd
, off_t length
)
95 return ftruncate(fd
,length
);
98 static off_t
app_filesize(int fd
)
103 static int app_closedir(DIR *dirp
)
105 return closedir(dirp
);
108 static struct dirent
*app_readdir(DIR *dirp
)
110 return readdir(dirp
);
114 #if defined(HAVE_PLUGIN_CHECK_OPEN_CLOSE) && (MAX_OPEN_FILES>32)
115 #warning "MAX_OPEN_FILES>32, disabling plugin file open/close checking"
116 #undef HAVE_PLUGIN_CHECK_OPEN_CLOSE
119 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
120 static unsigned int open_files
;
123 #if (CONFIG_PLATFORM & PLATFORM_HOSTED)
124 static unsigned char pluginbuf
[PLUGIN_BUFFER_SIZE
];
125 void sim_lcd_ex_init(unsigned long (*getpixel
)(int, int));
126 void sim_lcd_ex_update_rect(int x
, int y
, int width
, int height
);
128 extern unsigned char pluginbuf
[];
132 /* for actual plugins only, not for codecs */
133 static int plugin_size
= 0;
134 static bool (*pfn_tsr_exit
)(bool reenter
) = NULL
; /* TSR exit callback */
135 static char current_plugin
[MAX_PATH
];
136 /* NULL if no plugin is loaded, otherwise the handle that lc_open() returned */
137 static void *current_plugin_handle
;
139 char *plugin_get_current_filename(void);
141 /* Some wrappers used to monitor open and close and detect leaks*/
142 static int open_wrapper(const char* pathname
, int flags
, ...);
143 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
144 static int close_wrapper(int fd
);
145 static int creat_wrapper(const char *pathname
, mode_t mode
);
148 static const struct plugin_api rockbox_api
= {
151 #ifdef HAVE_LCD_CONTRAST
163 #ifdef HAVE_LCD_CHARCELLS
165 lcd_get_locked_pattern
,
173 &lcd_framebuffer
[0][0],
184 lcd_mono_bitmap_part
,
197 lcd_bitmap_transparent_part
,
198 lcd_bitmap_transparent
,
201 #if defined(TOSHIBA_GIGABEAT_F) || defined(SANSA_E200) || defined(SANSA_C200) \
202 || defined(IRIVER_H10) || defined(COWON_D2) || defined(PHILIPS_HDD1630) \
203 || defined(SANSA_FUZE) || defined(SANSA_E200V2) || defined(SANSA_FUZEV2) \
204 || defined(TOSHIBA_GIGABEAT_S) || defined(PHILIPS_SA9200)
207 #endif /* MEMORYSIZE > 2 */
208 #elif (LCD_DEPTH < 4) && (CONFIG_PLATFORM & PLATFORM_NATIVE)
211 #endif /* LCD_DEPTH */
212 #if defined(HAVE_LCD_MODES) && (HAVE_LCD_MODES & LCD_MODE_PAL256)
214 lcd_pal256_update_pal
,
217 lcd_puts_scroll_style
,
218 #ifdef HAVE_LCD_INVERT
219 lcd_set_invert_display
,
220 #endif /* HAVE_LCD_INVERT */
221 #if defined(HAVE_LCD_MODES)
224 #if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
228 #ifdef HAVE_LCD_BITMAP
238 #endif /* HAVE_LCD_BITMAP */
243 backlight_set_timeout
,
244 #ifdef HAVE_BACKLIGHT_BRIGHTNESS
245 backlight_set_brightness
,
246 #endif /* HAVE_BACKLIGHT_BRIGHTNESS */
249 backlight_set_timeout_plugged
,
255 #ifdef HAVE_REMOTE_LCD
257 lcd_remote_set_contrast
,
258 lcd_remote_clear_display
,
260 lcd_remote_puts_scroll
,
261 lcd_remote_stop_scroll
,
262 lcd_remote_set_drawmode
,
263 lcd_remote_get_drawmode
,
265 lcd_remote_getstringsize
,
266 lcd_remote_drawpixel
,
272 lcd_remote_mono_bitmap_part
,
273 lcd_remote_mono_bitmap
,
275 lcd_remote_puts_style
,
276 lcd_remote_puts_scroll_style
,
277 &lcd_remote_framebuffer
[0][0],
279 lcd_remote_update_rect
,
282 remote_backlight_off
,
283 remote_backlight_set_timeout
,
285 remote_backlight_set_timeout_plugged
,
287 #endif /* HAVE_REMOTE_LCD */
289 {&screens
[SCREEN_MAIN
], &screens
[SCREEN_REMOTE
]},
291 {&screens
[SCREEN_MAIN
]},
293 #if defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1)
294 lcd_remote_set_foreground
,
295 lcd_remote_get_foreground
,
296 lcd_remote_set_background
,
297 lcd_remote_get_background
,
298 lcd_remote_bitmap_part
,
301 viewport_set_defaults
,
302 #ifdef HAVE_LCD_BITMAP
303 viewportmanager_theme_enable
,
304 viewportmanager_theme_undo
,
309 gui_synclist_set_nb_items
,
310 gui_synclist_set_icon_callback
,
311 gui_synclist_get_nb_items
,
312 gui_synclist_get_sel_pos
,
314 gui_synclist_select_item
,
315 gui_synclist_add_item
,
316 gui_synclist_del_item
,
317 gui_synclist_limit_scroll
,
318 gui_synclist_do_button
,
319 gui_synclist_set_title
,
321 simplelist_info_init
,
322 simplelist_show_list
,
328 #ifdef HAVE_BUTTON_DATA
334 #ifdef HAS_BUTTON_HOLD
337 #ifdef HAVE_TOUCHSCREEN
338 touchscreen_set_mode
,
341 #ifdef HAVE_BUTTON_LIGHT
342 buttonlight_set_timeout
,
345 #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
346 buttonlight_set_brightness
,
347 #endif /* HAVE_BUTTONLIGHT_BRIGHTNESS */
348 #endif /* HAVE_BUTTON_LIGHT */
352 (open_func
)open_wrapper
,
353 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
358 (read_func
)PREFIX(read
),
360 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
361 (creat_func
)creat_wrapper
,
365 (write_func
)PREFIX(write
),
376 #if USING_STORAGE_CALLBACK
377 register_storage_idle_func
,
378 unregister_storage_idle_func
,
379 #endif /* USING_STORAGE_CALLBACK */
381 create_numbered_filename
,
388 (opendir_func
)PREFIX(opendir
),
389 (closedir_func
)PREFIX(closedir
),
390 (readdir_func
)PREFIX(readdir
),
401 #if defined(CPU_ARM) && CONFIG_PLATFORM & PLATFORM_NATIVE
407 default_event_handler
,
408 default_event_handler_ex
,
412 #if (CONFIG_CODEC == SWCODEC)
414 #ifdef HAVE_PRIORITY_SCHEDULING
422 reset_poweroff_timer
,
423 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
427 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
428 #ifdef CPU_BOOST_LOGGING
433 #endif /* HAVE_ADJUSTABLE_CPU_FREQ */
434 #endif /* PLATFORM_NATIVE */
435 #ifdef HAVE_SCHEDULER_BOOSTCTRL
456 #if CONFIG_CODEC == SWCODEC
457 queue_enable_queue_send
,
464 #ifdef USB_ENABLE_HID
470 __cyg_profile_func_enter
,
471 __cyg_profile_func_exit
,
477 #if (CONFIG_PLATFORM & PLATFORM_HOSTED)
478 /* special simulator hooks */
479 #if defined(HAVE_LCD_BITMAP) && LCD_DEPTH < 8
481 sim_lcd_ex_update_rect
,
485 /* strings and memory */
499 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
526 #ifdef AUDIOHW_HAVE_EQ
527 sound_enum_hw_eq_band_setting
,
529 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
534 #if CONFIG_CODEC != SWCODEC
538 #if CONFIG_CODEC == SWCODEC
539 &audio_master_sampr_list
[0],
548 pcm_get_bytes_waiting
,
554 #ifdef HAVE_RECORDING
560 pcm_calculate_rec_peaks
,
561 audio_set_recording_gain
,
562 #endif /* HAVE_RECORDING */
563 #if INPUT_SRC_CAPS != 0
564 audio_set_output_source
,
565 audio_set_input_source
,
574 #endif /* CONFIG_CODEC == SWCODEC */
576 /* playback control */
582 playlist_remove_all_tracks
,
584 playlist_insert_track
,
585 playlist_insert_directory
,
597 audio_flush_and_reload_tracks
,
599 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
600 mpeg_get_last_header
,
602 #if ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F) || \
603 (CONFIG_CODEC == SWCODEC)) && defined (HAVE_PITCHSCREEN)
607 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
608 /* MAS communication */
613 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
620 #endif /* !SIMULATOR && CONFIG_CODEC != SWCODEC */
626 gui_syncstatusbar_draw
,
636 #ifdef HAVE_LCD_COLOR
640 /* action handling */
643 #ifdef HAVE_TOUCHSCREEN
644 action_get_touchscreen_press
,
652 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
657 # if CONFIG_CHARGING >= CHARGING_MONITOR
661 #ifdef HAVE_USB_POWER
666 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
679 plugin_get_audio_buffer
,
681 plugin_get_current_filename
,
682 #if defined(DEBUG) || defined(SIMULATOR)
685 #ifdef ROCKBOX_HAS_LOGF
691 #if CONFIG_CODEC == SWCODEC
692 codec_thread_do_callback
,
697 round_value_to_list32
,
698 #endif /* CONFIG_CODEC == SWCODEC */
704 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
705 peak_meter_scale_value
,
706 peak_meter_set_use_dbfs
,
707 peak_meter_get_use_dbfs
,
709 #ifdef HAVE_LCD_BITMAP
716 screen_dump_set_hook
,
723 #ifdef HAVE_WHEEL_POSITION
728 #ifdef IRIVER_H100_SERIES
729 /* Routines for the iriver_flash -plugin. */
730 detect_original_firmware
,
731 detect_flashed_ramimage
,
732 detect_flashed_romimage
,
735 #if (CONFIG_CODEC == SWCODEC)
748 buf_request_buffer_handle
,
755 tagcache_search_set_uniqbuf
,
756 tagcache_search_add_filter
,
759 tagcache_search_finish
,
760 tagcache_get_numeric
,
761 #if defined(HAVE_TC_RAMCACHE) && defined(HAVE_DIRCACHE)
767 search_albumart_files
,
770 #ifdef HAVE_SEMAPHORE_OBJECTS
778 /* new stuff at the end, sort into place next time
779 the API gets incompatible */
782 int plugin_load(const char* plugin
, const void* parameter
)
785 struct plugin_header
*p_hdr
;
786 struct lc_header
*hdr
;
789 fb_data
* old_backdrop
;
792 if (current_plugin_handle
&& pfn_tsr_exit
)
793 { /* if we have a resident old plugin and a callback */
794 if (pfn_tsr_exit(!strcmp(current_plugin
, plugin
)) == false )
796 /* not allowing another plugin to load */
799 lc_close(current_plugin_handle
);
800 current_plugin_handle
= pfn_tsr_exit
= NULL
;
803 splash(0, ID2P(LANG_WAIT
));
804 strcpy(current_plugin
, plugin
);
806 current_plugin_handle
= lc_open(plugin
, pluginbuf
, PLUGIN_BUFFER_SIZE
);
807 if (current_plugin_handle
== NULL
) {
808 splashf(HZ
*2, str(LANG_PLUGIN_CANT_OPEN
), plugin
);
812 p_hdr
= lc_get_header(current_plugin_handle
);
814 hdr
= p_hdr
? &p_hdr
->lc_hdr
: NULL
;
818 || hdr
->magic
!= PLUGIN_MAGIC
819 || hdr
->target_id
!= TARGET_ID
820 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
821 || hdr
->load_addr
!= pluginbuf
822 || hdr
->end_addr
> pluginbuf
+ PLUGIN_BUFFER_SIZE
826 lc_close(current_plugin_handle
);
827 splash(HZ
*2, str(LANG_PLUGIN_WRONG_MODEL
));
830 if (hdr
->api_version
> PLUGIN_API_VERSION
831 || hdr
->api_version
< PLUGIN_MIN_API_VERSION
)
833 lc_close(current_plugin_handle
);
834 splash(HZ
*2, str(LANG_PLUGIN_WRONG_VERSION
));
837 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
838 plugin_size
= hdr
->end_addr
- pluginbuf
;
843 *(p_hdr
->api
) = &rockbox_api
;
845 #if defined HAVE_LCD_BITMAP && LCD_DEPTH > 1
846 old_backdrop
= lcd_get_backdrop();
851 #ifdef HAVE_REMOTE_LCD
852 lcd_remote_clear_display();
857 viewportmanager_theme_enable(i
, false, NULL
);
859 #ifdef HAVE_TOUCHSCREEN
860 touchscreen_set_mode(TOUCHSCREEN_BUTTON
);
863 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
867 rc
= p_hdr
->entry_point(parameter
);
870 { /* close handle if plugin is no tsr one */
871 lc_close(current_plugin_handle
);
872 current_plugin_handle
= NULL
;
875 /* Go back to the global setting in case the plugin changed it */
876 #ifdef HAVE_TOUCHSCREEN
877 touchscreen_set_mode(global_settings
.touch_mode
);
880 #ifdef HAVE_LCD_BITMAP
881 lcd_setfont(FONT_UI
);
883 lcd_set_backdrop(old_backdrop
);
884 #ifdef HAVE_LCD_COLOR
885 lcd_set_drawinfo(DRMODE_SOLID
, global_settings
.fg_color
,
886 global_settings
.bg_color
);
888 lcd_set_drawinfo(DRMODE_SOLID
, LCD_DEFAULT_FG
, LCD_DEFAULT_BG
);
890 #else /* LCD_DEPTH == 1 */
891 lcd_set_drawmode(DRMODE_SOLID
);
892 #endif /* LCD_DEPTH */
893 #endif /* HAVE_LCD_BITMAP */
896 #ifdef HAVE_REMOTE_LCD
897 #if LCD_REMOTE_DEPTH > 1
898 lcd_remote_set_drawinfo(DRMODE_SOLID
, LCD_REMOTE_DEFAULT_FG
,
899 LCD_REMOTE_DEFAULT_BG
);
901 lcd_remote_set_drawmode(DRMODE_SOLID
);
906 #ifdef HAVE_REMOTE_LCD
907 lcd_remote_clear_display();
911 viewportmanager_theme_undo(i
, false);
913 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
914 if(open_files
!= 0 && !current_plugin_handle
)
917 logf("Plugin '%s' leaks file handles", plugin
);
919 static const char *lines
[] =
920 { ID2P(LANG_PLUGIN_ERROR
),
921 "#leak-file-handles" };
922 static const struct text_message message
={ lines
, 2 };
923 button_clear_queue(); /* Empty the keyboard buffer */
924 gui_syncyesno_run(&message
, NULL
, NULL
);
926 for(fd
=0; fd
< MAX_OPEN_FILES
; fd
++)
927 if(open_files
& (1<<fd
))
932 if (rc
== PLUGIN_ERROR
)
933 splash(HZ
*2, str(LANG_PLUGIN_ERROR
));
938 /* Returns a pointer to the portion of the plugin buffer that is not already
939 being used. If no plugin is loaded, returns the entire plugin buffer */
940 void* plugin_get_buffer(size_t *buffer_size
)
944 if (current_plugin_handle
)
946 if (plugin_size
>= PLUGIN_BUFFER_SIZE
)
949 *buffer_size
= PLUGIN_BUFFER_SIZE
-plugin_size
;
950 buffer_pos
= plugin_size
;
954 *buffer_size
= PLUGIN_BUFFER_SIZE
;
958 return &pluginbuf
[buffer_pos
];
961 /* Returns a pointer to the mp3 buffer.
962 Playback gets stopped, to avoid conflicts.
963 Talk buffer is stolen as well.
965 void* plugin_get_audio_buffer(size_t *buffer_size
)
967 #if CONFIG_CODEC == SWCODEC
968 return audio_get_buffer(true, buffer_size
);
971 talk_buffer_steal(); /* we use the mp3 buffer, need to tell */
972 *buffer_size
= audiobufend
- audiobuf
;
977 /* The plugin wants to stay resident after leaving its main function, e.g.
978 runs from timer or own thread. The callback is registered to later
979 instruct it to free its resources before a new plugin gets loaded. */
980 void plugin_tsr(bool (*exit_callback
)(bool))
982 pfn_tsr_exit
= exit_callback
; /* remember the callback for later */
985 char *plugin_get_current_filename(void)
987 return current_plugin
;
990 static int open_wrapper(const char* pathname
, int flags
, ...)
992 /* we don't have an 'open' function. it's a define. and we need
993 * the real file_open, hence PREFIX() doesn't work here */
995 #if (CONFIG_PLATFORM & PLATFORM_HOSTED)
1000 fd
= open(pathname
, flags
, va_arg(ap
, unsigned int));
1004 fd
= open(pathname
, flags
);
1006 fd
= file_open(pathname
,flags
);
1009 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
1011 open_files
|= 1<<fd
;
1016 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
1017 static int close_wrapper(int fd
)
1019 if((~open_files
) & (1<<fd
))
1021 logf("double close from plugin");
1024 open_files
&= (~(1<<fd
));
1026 return PREFIX(close
)(fd
);
1029 static int creat_wrapper(const char *pathname
, mode_t mode
)
1031 int fd
= PREFIX(creat
)(pathname
, mode
);
1034 open_files
|= (1<<fd
);
1038 #endif /* HAVE_PLUGIN_CHECK_OPEN_CLOSE */