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"
49 #ifdef HAVE_LCD_BITMAP
50 #include "scrollbar.h"
51 #include "peakmeter.h"
57 #include "usbstack/usb_hid.h"
61 #define PREFIX(_x_) sim_ ## _x_
66 #if defined(HAVE_PLUGIN_CHECK_OPEN_CLOSE) && (MAX_OPEN_FILES>32)
67 #warning "MAX_OPEN_FILES>32, disabling plugin file open/close checking"
68 #undef HAVE_PLUGIN_CHECK_OPEN_CLOSE
71 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
72 static unsigned int open_files
;
76 static unsigned char pluginbuf
[PLUGIN_BUFFER_SIZE
];
77 void *sim_plugin_load(char *plugin
, void **pd
);
78 void sim_plugin_close(void *pd
);
79 void sim_lcd_ex_init(unsigned long (*getpixel
)(int, int));
80 void sim_lcd_ex_update_rect(int x
, int y
, int width
, int height
);
82 #define sim_plugin_close(x)
83 extern unsigned char pluginbuf
[];
87 /* for actual plugins only, not for codecs */
88 static bool plugin_loaded
= false;
89 static int plugin_size
= 0;
90 static bool (*pfn_tsr_exit
)(bool reenter
) = NULL
; /* TSR exit callback */
91 static char current_plugin
[MAX_PATH
];
93 char *plugin_get_current_filename(void);
95 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
96 /* Some wrappers used to monitor open and close and detect leaks*/
97 static int open_wrapper(const char* pathname
, int flags
);
98 static int close_wrapper(int fd
);
99 static int creat_wrapper(const char *pathname
);
102 static const struct plugin_api rockbox_api
= {
105 #ifdef HAVE_LCD_CONTRAST
115 #ifdef HAVE_LCD_CHARCELLS
117 lcd_get_locked_pattern
,
125 &lcd_framebuffer
[0][0],
136 lcd_mono_bitmap_part
,
149 lcd_bitmap_transparent_part
,
150 lcd_bitmap_transparent
,
153 #if defined(TOSHIBA_GIGABEAT_F) || defined(SANSA_E200) || defined(SANSA_C200) \
154 || defined(IRIVER_H10) || defined(COWON_D2) || defined(PHILIPS_HDD1630) \
155 || defined(SANSA_FUZE) || defined(SANSA_E200V2) || defined(SANSA_FUZEV2) \
156 || defined(TOSHIBA_GIGABEAT_S)
159 #endif /* MEMORYSIZE > 2 */
160 #elif (LCD_DEPTH < 4) && !defined(SIMULATOR)
163 #endif /* LCD_DEPTH */
164 #if defined(HAVE_LCD_MODES) && (HAVE_LCD_MODES & LCD_MODE_PAL256)
166 lcd_pal256_update_pal
,
169 lcd_puts_scroll_style
,
170 #ifdef HAVE_LCD_INVERT
171 lcd_set_invert_display
,
172 #endif /* HAVE_LCD_INVERT */
173 #if defined(HAVE_LCD_MODES)
176 #if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
187 #endif /* HAVE_LCD_BITMAP */
192 backlight_set_timeout
,
193 #ifdef HAVE_BACKLIGHT_BRIGHTNESS
194 backlight_set_brightness
,
195 #endif /* HAVE_BACKLIGHT_BRIGHTNESS */
198 backlight_set_timeout_plugged
,
204 #ifdef HAVE_REMOTE_LCD
206 lcd_remote_set_contrast
,
207 lcd_remote_clear_display
,
209 lcd_remote_puts_scroll
,
210 lcd_remote_stop_scroll
,
211 lcd_remote_set_drawmode
,
212 lcd_remote_get_drawmode
,
214 lcd_remote_getstringsize
,
215 lcd_remote_drawpixel
,
221 lcd_remote_mono_bitmap_part
,
222 lcd_remote_mono_bitmap
,
224 lcd_remote_puts_style
,
225 lcd_remote_puts_scroll_style
,
226 &lcd_remote_framebuffer
[0][0],
228 lcd_remote_update_rect
,
231 remote_backlight_off
,
232 remote_backlight_set_timeout
,
234 remote_backlight_set_timeout_plugged
,
236 #endif /* HAVE_REMOTE_LCD */
238 {&screens
[SCREEN_MAIN
], &screens
[SCREEN_REMOTE
]},
240 {&screens
[SCREEN_MAIN
]},
242 #if defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1)
243 lcd_remote_set_foreground
,
244 lcd_remote_get_foreground
,
245 lcd_remote_set_background
,
246 lcd_remote_get_background
,
247 lcd_remote_bitmap_part
,
250 viewport_set_defaults
,
251 #ifdef HAVE_LCD_BITMAP
252 viewportmanager_theme_enable
,
253 viewportmanager_theme_undo
,
258 gui_synclist_set_nb_items
,
259 gui_synclist_set_icon_callback
,
260 gui_synclist_get_nb_items
,
261 gui_synclist_get_sel_pos
,
263 gui_synclist_select_item
,
264 gui_synclist_add_item
,
265 gui_synclist_del_item
,
266 gui_synclist_limit_scroll
,
267 gui_synclist_do_button
,
268 gui_synclist_set_title
,
270 simplelist_info_init
,
271 simplelist_show_list
,
277 #ifdef HAVE_BUTTON_DATA
283 #ifdef HAS_BUTTON_HOLD
286 #ifdef HAVE_TOUCHSCREEN
287 touchscreen_set_mode
,
290 #ifdef HAVE_BUTTON_LIGHT
291 buttonlight_set_timeout
,
294 #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
295 buttonlight_set_brightness
,
296 #endif /* HAVE_BUTTONLIGHT_BRIGHTNESS */
297 #endif /* HAVE_BUTTON_LIGHT */
301 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
302 (open_func
)open_wrapper
,
305 (open_func
)PREFIX(open
),
308 (read_func
)PREFIX(read
),
310 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
311 (creat_func
)creat_wrapper
,
313 (creat_func
)PREFIX(creat
),
315 (write_func
)PREFIX(write
),
326 #if USING_STORAGE_CALLBACK
327 register_storage_idle_func
,
328 unregister_storage_idle_func
,
329 #endif /* USING_STORAGE_CALLBACK */
331 create_numbered_filename
,
351 default_event_handler
,
352 default_event_handler_ex
,
356 #if (CONFIG_CODEC == SWCODEC)
358 #ifdef HAVE_PRIORITY_SCHEDULING
366 reset_poweroff_timer
,
371 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
372 #ifdef CPU_BOOST_LOGGING
377 #endif /* HAVE_ADJUSTABLE_CPU_FREQ */
378 #endif /* !SIMULATOR */
379 #ifdef HAVE_SCHEDULER_BOOSTCTRL
395 #if CONFIG_CODEC == SWCODEC
396 queue_enable_queue_send
,
403 #ifdef USB_ENABLE_HID
409 __cyg_profile_func_enter
,
410 __cyg_profile_func_exit
,
417 /* special simulator hooks */
418 #if defined(HAVE_LCD_BITMAP) && LCD_DEPTH < 8
420 sim_lcd_ex_update_rect
,
424 /* strings and memory */
470 #if CONFIG_CODEC != SWCODEC
474 #if CONFIG_CODEC == SWCODEC
475 &audio_master_sampr_list
[0],
484 pcm_get_bytes_waiting
,
490 #ifdef HAVE_RECORDING
497 pcm_calculate_rec_peaks
,
498 audio_set_recording_gain
,
499 #endif /* HAVE_RECORDING */
500 #if INPUT_SRC_CAPS != 0
501 audio_set_output_source
,
502 audio_set_input_source
,
511 #endif /* CONFIG_CODEC == SWCODEC */
513 /* playback control */
519 playlist_remove_all_tracks
,
521 playlist_insert_track
,
522 playlist_insert_directory
,
534 audio_flush_and_reload_tracks
,
536 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
537 mpeg_get_last_header
,
539 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F) || \
540 (CONFIG_CODEC == SWCODEC)
544 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
545 /* MAS communication */
550 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
557 #endif /* !SIMULATOR && CONFIG_CODEC != SWCODEC */
563 gui_syncstatusbar_draw
,
572 #ifdef HAVE_LCD_COLOR
576 /* action handling */
579 #ifdef HAVE_TOUCHSCREEN
580 action_get_touchscreen_press
,
593 # if CONFIG_CHARGING >= CHARGING_MONITOR
597 #ifdef HAVE_USB_POWER
602 #if !defined(SIMULATOR) || defined(__MINGW32__) || defined(__CYGWIN__)
615 plugin_get_audio_buffer
,
617 plugin_get_current_filename
,
618 #ifdef PLUGIN_USE_IRAM
621 #if defined(DEBUG) || defined(SIMULATOR)
624 #ifdef ROCKBOX_HAS_LOGF
630 #if CONFIG_CODEC == SWCODEC
631 codec_thread_do_callback
,
640 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
641 peak_meter_scale_value
,
642 peak_meter_set_use_dbfs
,
643 peak_meter_get_use_dbfs
,
645 #ifdef HAVE_LCD_BITMAP
652 screen_dump_set_hook
,
659 #ifdef HAVE_WHEEL_POSITION
664 #ifdef IRIVER_H100_SERIES
665 /* Routines for the iriver_flash -plugin. */
666 detect_original_firmware
,
667 detect_flashed_ramimage
,
668 detect_flashed_romimage
,
671 #if (CONFIG_CODEC == SWCODEC)
684 buf_request_buffer_handle
,
691 tagcache_search_set_uniqbuf
,
692 tagcache_search_add_filter
,
695 tagcache_search_finish
,
696 tagcache_get_numeric
,
697 #ifdef HAVE_TC_RAMCACHE
703 search_albumart_files
,
706 #ifdef HAVE_SEMAPHORE_OBJECTS
713 /* new stuff at the end, sort into place next time
714 the API gets incompatible */
716 #ifdef HAVE_LCD_BITMAP
721 int plugin_load(const char* plugin
, const void* parameter
)
724 struct plugin_header
*hdr
;
727 #else /* !SIMULATOR */
733 #endif /* !SIMULATOR */
736 fb_data
* old_backdrop
;
739 if (pfn_tsr_exit
!= NULL
) /* if we have a resident old plugin: */
741 if (pfn_tsr_exit(!strcmp(current_plugin
, plugin
)) == false )
743 /* not allowing another plugin to load */
747 plugin_loaded
= false;
750 splash(0, ID2P(LANG_WAIT
));
751 strcpy(current_plugin
, plugin
);
754 hdr
= sim_plugin_load((char *)plugin
, &pd
);
756 splashf(HZ
*2, str(LANG_PLUGIN_CANT_OPEN
), plugin
);
760 || hdr
->magic
!= PLUGIN_MAGIC
761 || hdr
->target_id
!= TARGET_ID
) {
762 sim_plugin_close(pd
);
763 splash(HZ
*2, str(LANG_PLUGIN_WRONG_MODEL
));
766 if (hdr
->api_version
> PLUGIN_API_VERSION
767 || hdr
->api_version
< PLUGIN_MIN_API_VERSION
) {
768 sim_plugin_close(pd
);
769 splash(HZ
*2, str(LANG_PLUGIN_WRONG_VERSION
));
773 fd
= open(plugin
, O_RDONLY
);
775 splashf(HZ
*2, str(LANG_PLUGIN_CANT_OPEN
), plugin
);
779 /* Make sure COP cache is flushed and invalidated before loading */
780 my_core
= switch_core(CURRENT_CORE
^ 1);
781 cpucache_invalidate();
782 switch_core(my_core
);
785 readsize
= read(fd
, pluginbuf
, PLUGIN_BUFFER_SIZE
);
789 splashf(HZ
*2, str(LANG_READ_FAILED
), plugin
);
792 hdr
= (struct plugin_header
*)pluginbuf
;
794 if ((unsigned)readsize
<= sizeof(struct plugin_header
)
795 || hdr
->magic
!= PLUGIN_MAGIC
796 || hdr
->target_id
!= TARGET_ID
797 || hdr
->load_addr
!= pluginbuf
798 || hdr
->end_addr
> pluginbuf
+ PLUGIN_BUFFER_SIZE
) {
799 splash(HZ
*2, str(LANG_PLUGIN_WRONG_MODEL
));
802 if (hdr
->api_version
> PLUGIN_API_VERSION
803 || hdr
->api_version
< PLUGIN_MIN_API_VERSION
) {
804 splash(HZ
*2, str(LANG_PLUGIN_WRONG_VERSION
));
807 plugin_size
= hdr
->end_addr
- pluginbuf
;
809 /* zero out bss area only, above guards end of pluginbuf */
810 if (plugin_size
> readsize
)
811 memset(pluginbuf
+ readsize
, 0, plugin_size
- readsize
);
814 *(hdr
->api
) = &rockbox_api
;
815 plugin_loaded
= true;
818 #if defined HAVE_LCD_BITMAP && LCD_DEPTH > 1
819 old_backdrop
= lcd_get_backdrop();
824 #ifdef HAVE_REMOTE_LCD
825 lcd_remote_clear_display();
830 viewportmanager_theme_enable(i
, false, NULL
);
832 cpucache_invalidate();
834 #ifdef HAVE_TOUCHSCREEN
835 touchscreen_set_mode(TOUCHSCREEN_BUTTON
);
838 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
842 rc
= hdr
->entry_point(parameter
);
844 /* Go back to the global setting in case the plugin changed it */
845 #ifdef HAVE_TOUCHSCREEN
846 touchscreen_set_mode(global_settings
.touch_mode
);
849 button_clear_queue();
851 #ifdef HAVE_LCD_BITMAP
852 lcd_setfont(FONT_UI
);
854 lcd_set_backdrop(old_backdrop
);
855 #ifdef HAVE_LCD_COLOR
856 lcd_set_drawinfo(DRMODE_SOLID
, global_settings
.fg_color
,
857 global_settings
.bg_color
);
859 lcd_set_drawinfo(DRMODE_SOLID
, LCD_DEFAULT_FG
, LCD_DEFAULT_BG
);
861 #else /* LCD_DEPTH == 1 */
862 lcd_set_drawmode(DRMODE_SOLID
);
863 #endif /* LCD_DEPTH */
864 #endif /* HAVE_LCD_BITMAP */
867 #ifdef HAVE_REMOTE_LCD
868 #if LCD_REMOTE_DEPTH > 1
869 lcd_remote_set_drawinfo(DRMODE_SOLID
, LCD_REMOTE_DEFAULT_FG
,
870 LCD_REMOTE_DEFAULT_BG
);
872 lcd_remote_set_drawmode(DRMODE_SOLID
);
877 #ifdef HAVE_LCD_REMOTE
878 lcd_remote_clear_display();
882 viewportmanager_theme_undo(i
, false);
884 if (pfn_tsr_exit
== NULL
)
885 plugin_loaded
= false;
887 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
888 if(open_files
!= 0 && !plugin_loaded
)
891 logf("Plugin '%s' leaks file handles", plugin
);
893 static const char *lines
[] =
894 { ID2P(LANG_PLUGIN_ERROR
),
895 "#leak-file-handles" };
896 static const struct text_message message
={ lines
, 2 };
897 button_clear_queue(); /* Empty the keyboard buffer */
898 gui_syncyesno_run(&message
, NULL
, NULL
);
900 for(fd
=0; fd
< MAX_OPEN_FILES
; fd
++)
901 if(open_files
& (1<<fd
))
906 sim_plugin_close(pd
);
908 if (rc
== PLUGIN_ERROR
)
909 splash(HZ
*2, str(LANG_PLUGIN_ERROR
));
914 /* Returns a pointer to the portion of the plugin buffer that is not already
915 being used. If no plugin is loaded, returns the entire plugin buffer */
916 void* plugin_get_buffer(size_t *buffer_size
)
922 if (plugin_size
>= PLUGIN_BUFFER_SIZE
)
925 *buffer_size
= PLUGIN_BUFFER_SIZE
-plugin_size
;
926 buffer_pos
= plugin_size
;
930 *buffer_size
= PLUGIN_BUFFER_SIZE
;
934 return &pluginbuf
[buffer_pos
];
937 /* Returns a pointer to the mp3 buffer.
938 Playback gets stopped, to avoid conflicts.
939 Talk buffer is stolen as well.
941 void* plugin_get_audio_buffer(size_t *buffer_size
)
943 #if CONFIG_CODEC == SWCODEC
944 return audio_get_buffer(true, buffer_size
);
947 talk_buffer_steal(); /* we use the mp3 buffer, need to tell */
948 *buffer_size
= audiobufend
- audiobuf
;
953 #ifdef PLUGIN_USE_IRAM
954 /* Initializes plugin IRAM */
955 void plugin_iram_init(char *iramstart
, char *iramcopy
, size_t iram_size
,
956 char *iedata
, size_t iedata_size
)
958 /* We need to stop audio playback in order to use codec IRAM */
960 memcpy(iramstart
, iramcopy
, iram_size
);
961 memset(iedata
, 0, iedata_size
);
962 memset(iramcopy
, 0, iram_size
);
964 /* writeback cleared iedata and iramcopy areas */
968 #endif /* PLUGIN_USE_IRAM */
970 /* The plugin wants to stay resident after leaving its main function, e.g.
971 runs from timer or own thread. The callback is registered to later
972 instruct it to free its resources before a new plugin gets loaded. */
973 void plugin_tsr(bool (*exit_callback
)(bool))
975 pfn_tsr_exit
= exit_callback
; /* remember the callback for later */
978 char *plugin_get_current_filename(void)
980 return current_plugin
;
983 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
984 static int open_wrapper(const char* pathname
, int flags
)
986 int fd
= PREFIX(open
)(pathname
,flags
);
994 static int close_wrapper(int fd
)
996 if((~open_files
) & (1<<fd
))
998 logf("double close from plugin");
1001 open_files
&= (~(1<<fd
));
1003 return PREFIX(close
)(fd
);
1006 static int creat_wrapper(const char *pathname
)
1008 int fd
= PREFIX(creat
)(pathname
);
1011 open_files
|= (1<<fd
);
1015 #endif /* HAVE_PLUGIN_CHECK_OPEN_CLOSE */