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
,
387 (opendir_func
)PREFIX(opendir
),
388 (closedir_func
)PREFIX(closedir
),
389 (readdir_func
)PREFIX(readdir
),
396 #if defined(CPU_ARM) && CONFIG_PLATFORM & PLATFORM_NATIVE
402 default_event_handler
,
403 default_event_handler_ex
,
407 #if (CONFIG_CODEC == SWCODEC)
409 #ifdef HAVE_PRIORITY_SCHEDULING
417 reset_poweroff_timer
,
418 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
422 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
423 #ifdef CPU_BOOST_LOGGING
428 #endif /* HAVE_ADJUSTABLE_CPU_FREQ */
429 #endif /* PLATFORM_NATIVE */
430 #ifdef HAVE_SCHEDULER_BOOSTCTRL
451 #if CONFIG_CODEC == SWCODEC
452 queue_enable_queue_send
,
459 #ifdef USB_ENABLE_HID
465 __cyg_profile_func_enter
,
466 __cyg_profile_func_exit
,
472 #if (CONFIG_PLATFORM & PLATFORM_HOSTED)
473 /* special simulator hooks */
474 #if defined(HAVE_LCD_BITMAP) && LCD_DEPTH < 8
476 sim_lcd_ex_update_rect
,
480 /* strings and memory */
494 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
521 #ifdef AUDIOHW_HAVE_EQ
522 sound_enum_hw_eq_band_setting
,
524 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
529 #if CONFIG_CODEC != SWCODEC
533 #if CONFIG_CODEC == SWCODEC
534 &audio_master_sampr_list
[0],
543 pcm_get_bytes_waiting
,
549 #ifdef HAVE_RECORDING
555 pcm_calculate_rec_peaks
,
556 audio_set_recording_gain
,
557 #endif /* HAVE_RECORDING */
558 #if INPUT_SRC_CAPS != 0
559 audio_set_output_source
,
560 audio_set_input_source
,
569 #endif /* CONFIG_CODEC == SWCODEC */
571 /* playback control */
577 playlist_remove_all_tracks
,
579 playlist_insert_track
,
580 playlist_insert_directory
,
592 audio_flush_and_reload_tracks
,
594 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
595 mpeg_get_last_header
,
597 #if ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F) || \
598 (CONFIG_CODEC == SWCODEC)) && defined (HAVE_PITCHSCREEN)
602 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
603 /* MAS communication */
608 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
615 #endif /* !SIMULATOR && CONFIG_CODEC != SWCODEC */
621 gui_syncstatusbar_draw
,
631 #ifdef HAVE_LCD_COLOR
635 /* action handling */
638 #ifdef HAVE_TOUCHSCREEN
639 action_get_touchscreen_press
,
647 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
652 # if CONFIG_CHARGING >= CHARGING_MONITOR
656 #ifdef HAVE_USB_POWER
661 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
674 plugin_get_audio_buffer
,
676 plugin_get_current_filename
,
677 #if defined(DEBUG) || defined(SIMULATOR)
680 #ifdef ROCKBOX_HAS_LOGF
686 #if CONFIG_CODEC == SWCODEC
687 codec_thread_do_callback
,
692 round_value_to_list32
,
693 #endif /* CONFIG_CODEC == SWCODEC */
699 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
700 peak_meter_scale_value
,
701 peak_meter_set_use_dbfs
,
702 peak_meter_get_use_dbfs
,
704 #ifdef HAVE_LCD_BITMAP
711 screen_dump_set_hook
,
718 #ifdef HAVE_WHEEL_POSITION
723 #ifdef IRIVER_H100_SERIES
724 /* Routines for the iriver_flash -plugin. */
725 detect_original_firmware
,
726 detect_flashed_ramimage
,
727 detect_flashed_romimage
,
730 #if (CONFIG_CODEC == SWCODEC)
743 buf_request_buffer_handle
,
750 tagcache_search_set_uniqbuf
,
751 tagcache_search_add_filter
,
754 tagcache_search_finish
,
755 tagcache_get_numeric
,
756 #if defined(HAVE_TC_RAMCACHE) && defined(HAVE_DIRCACHE)
762 search_albumart_files
,
765 #ifdef HAVE_SEMAPHORE_OBJECTS
773 /* new stuff at the end, sort into place next time
774 the API gets incompatible */
778 int plugin_load(const char* plugin
, const void* parameter
)
781 struct plugin_header
*p_hdr
;
782 struct lc_header
*hdr
;
785 fb_data
* old_backdrop
;
788 if (current_plugin_handle
&& pfn_tsr_exit
)
789 { /* if we have a resident old plugin and a callback */
790 if (pfn_tsr_exit(!strcmp(current_plugin
, plugin
)) == false )
792 /* not allowing another plugin to load */
795 lc_close(current_plugin_handle
);
796 current_plugin_handle
= pfn_tsr_exit
= NULL
;
799 splash(0, ID2P(LANG_WAIT
));
800 strcpy(current_plugin
, plugin
);
802 current_plugin_handle
= lc_open(plugin
, pluginbuf
, PLUGIN_BUFFER_SIZE
);
803 if (current_plugin_handle
== NULL
) {
804 splashf(HZ
*2, str(LANG_PLUGIN_CANT_OPEN
), plugin
);
808 p_hdr
= lc_get_header(current_plugin_handle
);
810 hdr
= p_hdr
? &p_hdr
->lc_hdr
: NULL
;
814 || hdr
->magic
!= PLUGIN_MAGIC
815 || hdr
->target_id
!= TARGET_ID
816 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
817 || hdr
->load_addr
!= pluginbuf
818 || hdr
->end_addr
> pluginbuf
+ PLUGIN_BUFFER_SIZE
822 lc_close(current_plugin_handle
);
823 splash(HZ
*2, str(LANG_PLUGIN_WRONG_MODEL
));
826 if (hdr
->api_version
> PLUGIN_API_VERSION
827 || hdr
->api_version
< PLUGIN_MIN_API_VERSION
)
829 lc_close(current_plugin_handle
);
830 splash(HZ
*2, str(LANG_PLUGIN_WRONG_VERSION
));
833 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
834 plugin_size
= hdr
->end_addr
- pluginbuf
;
839 *(p_hdr
->api
) = &rockbox_api
;
841 #if defined HAVE_LCD_BITMAP && LCD_DEPTH > 1
842 old_backdrop
= lcd_get_backdrop();
847 #ifdef HAVE_REMOTE_LCD
848 lcd_remote_clear_display();
853 viewportmanager_theme_enable(i
, false, NULL
);
855 #ifdef HAVE_TOUCHSCREEN
856 touchscreen_set_mode(TOUCHSCREEN_BUTTON
);
859 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
863 rc
= p_hdr
->entry_point(parameter
);
866 { /* close handle if plugin is no tsr one */
867 lc_close(current_plugin_handle
);
868 current_plugin_handle
= NULL
;
871 /* Go back to the global setting in case the plugin changed it */
872 #ifdef HAVE_TOUCHSCREEN
873 touchscreen_set_mode(global_settings
.touch_mode
);
876 #ifdef HAVE_LCD_BITMAP
877 lcd_setfont(FONT_UI
);
879 lcd_set_backdrop(old_backdrop
);
880 #ifdef HAVE_LCD_COLOR
881 lcd_set_drawinfo(DRMODE_SOLID
, global_settings
.fg_color
,
882 global_settings
.bg_color
);
884 lcd_set_drawinfo(DRMODE_SOLID
, LCD_DEFAULT_FG
, LCD_DEFAULT_BG
);
886 #else /* LCD_DEPTH == 1 */
887 lcd_set_drawmode(DRMODE_SOLID
);
888 #endif /* LCD_DEPTH */
889 #endif /* HAVE_LCD_BITMAP */
892 #ifdef HAVE_REMOTE_LCD
893 #if LCD_REMOTE_DEPTH > 1
894 lcd_remote_set_drawinfo(DRMODE_SOLID
, LCD_REMOTE_DEFAULT_FG
,
895 LCD_REMOTE_DEFAULT_BG
);
897 lcd_remote_set_drawmode(DRMODE_SOLID
);
902 #ifdef HAVE_REMOTE_LCD
903 lcd_remote_clear_display();
907 viewportmanager_theme_undo(i
, false);
909 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
910 if(open_files
!= 0 && !current_plugin_handle
)
913 logf("Plugin '%s' leaks file handles", plugin
);
915 static const char *lines
[] =
916 { ID2P(LANG_PLUGIN_ERROR
),
917 "#leak-file-handles" };
918 static const struct text_message message
={ lines
, 2 };
919 button_clear_queue(); /* Empty the keyboard buffer */
920 gui_syncyesno_run(&message
, NULL
, NULL
);
922 for(fd
=0; fd
< MAX_OPEN_FILES
; fd
++)
923 if(open_files
& (1<<fd
))
928 if (rc
== PLUGIN_ERROR
)
929 splash(HZ
*2, str(LANG_PLUGIN_ERROR
));
934 /* Returns a pointer to the portion of the plugin buffer that is not already
935 being used. If no plugin is loaded, returns the entire plugin buffer */
936 void* plugin_get_buffer(size_t *buffer_size
)
940 if (current_plugin_handle
)
942 if (plugin_size
>= PLUGIN_BUFFER_SIZE
)
945 *buffer_size
= PLUGIN_BUFFER_SIZE
-plugin_size
;
946 buffer_pos
= plugin_size
;
950 *buffer_size
= PLUGIN_BUFFER_SIZE
;
954 return &pluginbuf
[buffer_pos
];
957 /* Returns a pointer to the mp3 buffer.
958 Playback gets stopped, to avoid conflicts.
959 Talk buffer is stolen as well.
961 void* plugin_get_audio_buffer(size_t *buffer_size
)
963 #if CONFIG_CODEC == SWCODEC
964 return audio_get_buffer(true, buffer_size
);
967 talk_buffer_steal(); /* we use the mp3 buffer, need to tell */
968 *buffer_size
= audiobufend
- audiobuf
;
973 /* The plugin wants to stay resident after leaving its main function, e.g.
974 runs from timer or own thread. The callback is registered to later
975 instruct it to free its resources before a new plugin gets loaded. */
976 void plugin_tsr(bool (*exit_callback
)(bool))
978 pfn_tsr_exit
= exit_callback
; /* remember the callback for later */
981 char *plugin_get_current_filename(void)
983 return current_plugin
;
986 static int open_wrapper(const char* pathname
, int flags
, ...)
988 /* we don't have an 'open' function. it's a define. and we need
989 * the real file_open, hence PREFIX() doesn't work here */
991 #if (CONFIG_PLATFORM & PLATFORM_HOSTED)
996 fd
= open(pathname
, flags
, va_arg(ap
, unsigned int));
1000 fd
= open(pathname
, flags
);
1002 fd
= file_open(pathname
,flags
);
1005 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
1007 open_files
|= 1<<fd
;
1012 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
1013 static int close_wrapper(int fd
)
1015 if((~open_files
) & (1<<fd
))
1017 logf("double close from plugin");
1020 open_files
&= (~(1<<fd
));
1022 return PREFIX(close
)(fd
);
1025 static int creat_wrapper(const char *pathname
, mode_t mode
)
1027 int fd
= PREFIX(creat
)(pathname
, mode
);
1030 open_files
|= (1<<fd
);
1034 #endif /* HAVE_PLUGIN_CHECK_OPEN_CLOSE */