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 ****************************************************************************/
32 #include "backlight.h"
33 #include "sound_menu.h"
35 #include "powermgmt.h"
38 #include "option_select.h"
44 #include "diacritic.h"
50 #ifdef HAVE_LCD_BITMAP
51 #include "scrollbar.h"
52 #include "peakmeter.h"
58 #include "usbstack/usb_hid.h"
62 #define PREFIX(_x_) sim_ ## _x_
67 #if defined(HAVE_PLUGIN_CHECK_OPEN_CLOSE) && (MAX_OPEN_FILES>32)
68 #warning "MAX_OPEN_FILES>32, disabling plugin file open/close checking"
69 #undef HAVE_PLUGIN_CHECK_OPEN_CLOSE
72 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
73 static unsigned int open_files
;
77 static unsigned char pluginbuf
[PLUGIN_BUFFER_SIZE
];
78 void *sim_plugin_load(char *plugin
, void **pd
);
79 void sim_plugin_close(void *pd
);
80 void sim_lcd_ex_init(unsigned long (*getpixel
)(int, int));
81 void sim_lcd_ex_update_rect(int x
, int y
, int width
, int height
);
83 #define sim_plugin_close(x)
84 extern unsigned char pluginbuf
[];
88 /* for actual plugins only, not for codecs */
89 static bool plugin_loaded
= false;
90 static int plugin_size
= 0;
91 static bool (*pfn_tsr_exit
)(bool reenter
) = NULL
; /* TSR exit callback */
92 static char current_plugin
[MAX_PATH
];
94 char *plugin_get_current_filename(void);
96 /* Some wrappers used to monitor open and close and detect leaks*/
97 static int open_wrapper(const char* pathname
, int flags
, ...);
98 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
99 static int close_wrapper(int fd
);
100 static int creat_wrapper(const char *pathname
, mode_t mode
);
103 static const struct plugin_api rockbox_api
= {
106 #ifdef HAVE_LCD_CONTRAST
116 #ifdef HAVE_LCD_CHARCELLS
118 lcd_get_locked_pattern
,
126 &lcd_framebuffer
[0][0],
137 lcd_mono_bitmap_part
,
150 lcd_bitmap_transparent_part
,
151 lcd_bitmap_transparent
,
154 #if defined(TOSHIBA_GIGABEAT_F) || defined(SANSA_E200) || defined(SANSA_C200) \
155 || defined(IRIVER_H10) || defined(COWON_D2) || defined(PHILIPS_HDD1630) \
156 || defined(SANSA_FUZE) || defined(SANSA_E200V2) || defined(SANSA_FUZEV2) \
157 || defined(TOSHIBA_GIGABEAT_S)
160 #endif /* MEMORYSIZE > 2 */
161 #elif (LCD_DEPTH < 4) && !defined(SIMULATOR)
164 #endif /* LCD_DEPTH */
165 #if defined(HAVE_LCD_MODES) && (HAVE_LCD_MODES & LCD_MODE_PAL256)
167 lcd_pal256_update_pal
,
170 lcd_puts_scroll_style
,
171 #ifdef HAVE_LCD_INVERT
172 lcd_set_invert_display
,
173 #endif /* HAVE_LCD_INVERT */
174 #if defined(HAVE_LCD_MODES)
177 #if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
188 #endif /* HAVE_LCD_BITMAP */
193 backlight_set_timeout
,
194 #ifdef HAVE_BACKLIGHT_BRIGHTNESS
195 backlight_set_brightness
,
196 #endif /* HAVE_BACKLIGHT_BRIGHTNESS */
199 backlight_set_timeout_plugged
,
205 #ifdef HAVE_REMOTE_LCD
207 lcd_remote_set_contrast
,
208 lcd_remote_clear_display
,
210 lcd_remote_puts_scroll
,
211 lcd_remote_stop_scroll
,
212 lcd_remote_set_drawmode
,
213 lcd_remote_get_drawmode
,
215 lcd_remote_getstringsize
,
216 lcd_remote_drawpixel
,
222 lcd_remote_mono_bitmap_part
,
223 lcd_remote_mono_bitmap
,
225 lcd_remote_puts_style
,
226 lcd_remote_puts_scroll_style
,
227 &lcd_remote_framebuffer
[0][0],
229 lcd_remote_update_rect
,
232 remote_backlight_off
,
233 remote_backlight_set_timeout
,
235 remote_backlight_set_timeout_plugged
,
237 #endif /* HAVE_REMOTE_LCD */
239 {&screens
[SCREEN_MAIN
], &screens
[SCREEN_REMOTE
]},
241 {&screens
[SCREEN_MAIN
]},
243 #if defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1)
244 lcd_remote_set_foreground
,
245 lcd_remote_get_foreground
,
246 lcd_remote_set_background
,
247 lcd_remote_get_background
,
248 lcd_remote_bitmap_part
,
251 viewport_set_defaults
,
252 #ifdef HAVE_LCD_BITMAP
253 viewportmanager_theme_enable
,
254 viewportmanager_theme_undo
,
259 gui_synclist_set_nb_items
,
260 gui_synclist_set_icon_callback
,
261 gui_synclist_get_nb_items
,
262 gui_synclist_get_sel_pos
,
264 gui_synclist_select_item
,
265 gui_synclist_add_item
,
266 gui_synclist_del_item
,
267 gui_synclist_limit_scroll
,
268 gui_synclist_do_button
,
269 gui_synclist_set_title
,
271 simplelist_info_init
,
272 simplelist_show_list
,
278 #ifdef HAVE_BUTTON_DATA
284 #ifdef HAS_BUTTON_HOLD
287 #ifdef HAVE_TOUCHSCREEN
288 touchscreen_set_mode
,
291 #ifdef HAVE_BUTTON_LIGHT
292 buttonlight_set_timeout
,
295 #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
296 buttonlight_set_brightness
,
297 #endif /* HAVE_BUTTONLIGHT_BRIGHTNESS */
298 #endif /* HAVE_BUTTON_LIGHT */
302 (open_func
)open_wrapper
,
303 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
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 */
468 #if CONFIG_CODEC != SWCODEC
472 #if CONFIG_CODEC == SWCODEC
473 &audio_master_sampr_list
[0],
482 pcm_get_bytes_waiting
,
488 #ifdef HAVE_RECORDING
495 pcm_calculate_rec_peaks
,
496 audio_set_recording_gain
,
497 #endif /* HAVE_RECORDING */
498 #if INPUT_SRC_CAPS != 0
499 audio_set_output_source
,
500 audio_set_input_source
,
509 #endif /* CONFIG_CODEC == SWCODEC */
511 /* playback control */
517 playlist_remove_all_tracks
,
519 playlist_insert_track
,
520 playlist_insert_directory
,
532 audio_flush_and_reload_tracks
,
534 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
535 mpeg_get_last_header
,
537 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F) || \
538 (CONFIG_CODEC == SWCODEC)
542 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
543 /* MAS communication */
548 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
555 #endif /* !SIMULATOR && CONFIG_CODEC != SWCODEC */
561 gui_syncstatusbar_draw
,
570 #ifdef HAVE_LCD_COLOR
574 /* action handling */
577 #ifdef HAVE_TOUCHSCREEN
578 action_get_touchscreen_press
,
591 # if CONFIG_CHARGING >= CHARGING_MONITOR
595 #ifdef HAVE_USB_POWER
600 #if !defined(SIMULATOR) || defined(__MINGW32__) || defined(__CYGWIN__)
613 plugin_get_audio_buffer
,
615 plugin_get_current_filename
,
616 #ifdef PLUGIN_USE_IRAM
619 #if defined(DEBUG) || defined(SIMULATOR)
622 #ifdef ROCKBOX_HAS_LOGF
628 #if CONFIG_CODEC == SWCODEC
629 codec_thread_do_callback
,
638 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
639 peak_meter_scale_value
,
640 peak_meter_set_use_dbfs
,
641 peak_meter_get_use_dbfs
,
643 #ifdef HAVE_LCD_BITMAP
650 screen_dump_set_hook
,
657 #ifdef HAVE_WHEEL_POSITION
662 #ifdef IRIVER_H100_SERIES
663 /* Routines for the iriver_flash -plugin. */
664 detect_original_firmware
,
665 detect_flashed_ramimage
,
666 detect_flashed_romimage
,
669 #if (CONFIG_CODEC == SWCODEC)
682 buf_request_buffer_handle
,
689 tagcache_search_set_uniqbuf
,
690 tagcache_search_add_filter
,
693 tagcache_search_finish
,
694 tagcache_get_numeric
,
695 #ifdef HAVE_TC_RAMCACHE
701 search_albumart_files
,
704 #ifdef HAVE_SEMAPHORE_OBJECTS
711 /* new stuff at the end, sort into place next time
712 the API gets incompatible */
714 #ifdef HAVE_LCD_BITMAP
719 int plugin_load(const char* plugin
, const void* parameter
)
722 struct plugin_header
*hdr
;
725 #else /* !SIMULATOR */
731 #endif /* !SIMULATOR */
734 fb_data
* old_backdrop
;
737 if (pfn_tsr_exit
!= NULL
) /* if we have a resident old plugin: */
739 if (pfn_tsr_exit(!strcmp(current_plugin
, plugin
)) == false )
741 /* not allowing another plugin to load */
745 plugin_loaded
= false;
748 splash(0, ID2P(LANG_WAIT
));
749 strcpy(current_plugin
, plugin
);
752 hdr
= sim_plugin_load((char *)plugin
, &pd
);
754 splashf(HZ
*2, str(LANG_PLUGIN_CANT_OPEN
), plugin
);
758 || hdr
->magic
!= PLUGIN_MAGIC
759 || hdr
->target_id
!= TARGET_ID
) {
760 sim_plugin_close(pd
);
761 splash(HZ
*2, str(LANG_PLUGIN_WRONG_MODEL
));
764 if (hdr
->api_version
> PLUGIN_API_VERSION
765 || hdr
->api_version
< PLUGIN_MIN_API_VERSION
) {
766 sim_plugin_close(pd
);
767 splash(HZ
*2, str(LANG_PLUGIN_WRONG_VERSION
));
771 fd
= open(plugin
, O_RDONLY
);
773 splashf(HZ
*2, str(LANG_PLUGIN_CANT_OPEN
), plugin
);
777 /* Make sure COP cache is flushed and invalidated before loading */
778 my_core
= switch_core(CURRENT_CORE
^ 1);
779 cpucache_invalidate();
780 switch_core(my_core
);
783 readsize
= read(fd
, pluginbuf
, PLUGIN_BUFFER_SIZE
);
787 splashf(HZ
*2, str(LANG_READ_FAILED
), plugin
);
790 hdr
= (struct plugin_header
*)pluginbuf
;
792 if ((unsigned)readsize
<= sizeof(struct plugin_header
)
793 || hdr
->magic
!= PLUGIN_MAGIC
794 || hdr
->target_id
!= TARGET_ID
795 || hdr
->load_addr
!= pluginbuf
796 || hdr
->end_addr
> pluginbuf
+ PLUGIN_BUFFER_SIZE
) {
797 splash(HZ
*2, str(LANG_PLUGIN_WRONG_MODEL
));
800 if (hdr
->api_version
> PLUGIN_API_VERSION
801 || hdr
->api_version
< PLUGIN_MIN_API_VERSION
) {
802 splash(HZ
*2, str(LANG_PLUGIN_WRONG_VERSION
));
805 plugin_size
= hdr
->end_addr
- pluginbuf
;
807 /* zero out bss area only, above guards end of pluginbuf */
808 if (plugin_size
> readsize
)
809 memset(pluginbuf
+ readsize
, 0, plugin_size
- readsize
);
812 *(hdr
->api
) = &rockbox_api
;
813 plugin_loaded
= true;
816 #if defined HAVE_LCD_BITMAP && LCD_DEPTH > 1
817 old_backdrop
= lcd_get_backdrop();
822 #ifdef HAVE_REMOTE_LCD
823 lcd_remote_clear_display();
828 viewportmanager_theme_enable(i
, false, NULL
);
830 cpucache_invalidate();
832 #ifdef HAVE_TOUCHSCREEN
833 touchscreen_set_mode(TOUCHSCREEN_BUTTON
);
836 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
840 rc
= hdr
->entry_point(parameter
);
842 /* Go back to the global setting in case the plugin changed it */
843 #ifdef HAVE_TOUCHSCREEN
844 touchscreen_set_mode(global_settings
.touch_mode
);
847 button_clear_queue();
849 #ifdef HAVE_LCD_BITMAP
850 lcd_setfont(FONT_UI
);
852 lcd_set_backdrop(old_backdrop
);
853 #ifdef HAVE_LCD_COLOR
854 lcd_set_drawinfo(DRMODE_SOLID
, global_settings
.fg_color
,
855 global_settings
.bg_color
);
857 lcd_set_drawinfo(DRMODE_SOLID
, LCD_DEFAULT_FG
, LCD_DEFAULT_BG
);
859 #else /* LCD_DEPTH == 1 */
860 lcd_set_drawmode(DRMODE_SOLID
);
861 #endif /* LCD_DEPTH */
862 #endif /* HAVE_LCD_BITMAP */
865 #ifdef HAVE_REMOTE_LCD
866 #if LCD_REMOTE_DEPTH > 1
867 lcd_remote_set_drawinfo(DRMODE_SOLID
, LCD_REMOTE_DEFAULT_FG
,
868 LCD_REMOTE_DEFAULT_BG
);
870 lcd_remote_set_drawmode(DRMODE_SOLID
);
875 #ifdef HAVE_LCD_REMOTE
876 lcd_remote_clear_display();
880 viewportmanager_theme_undo(i
, false);
882 if (pfn_tsr_exit
== NULL
)
883 plugin_loaded
= false;
885 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
886 if(open_files
!= 0 && !plugin_loaded
)
889 logf("Plugin '%s' leaks file handles", plugin
);
891 static const char *lines
[] =
892 { ID2P(LANG_PLUGIN_ERROR
),
893 "#leak-file-handles" };
894 static const struct text_message message
={ lines
, 2 };
895 button_clear_queue(); /* Empty the keyboard buffer */
896 gui_syncyesno_run(&message
, NULL
, NULL
);
898 for(fd
=0; fd
< MAX_OPEN_FILES
; fd
++)
899 if(open_files
& (1<<fd
))
904 sim_plugin_close(pd
);
906 if (rc
== PLUGIN_ERROR
)
907 splash(HZ
*2, str(LANG_PLUGIN_ERROR
));
912 /* Returns a pointer to the portion of the plugin buffer that is not already
913 being used. If no plugin is loaded, returns the entire plugin buffer */
914 void* plugin_get_buffer(size_t *buffer_size
)
920 if (plugin_size
>= PLUGIN_BUFFER_SIZE
)
923 *buffer_size
= PLUGIN_BUFFER_SIZE
-plugin_size
;
924 buffer_pos
= plugin_size
;
928 *buffer_size
= PLUGIN_BUFFER_SIZE
;
932 return &pluginbuf
[buffer_pos
];
935 /* Returns a pointer to the mp3 buffer.
936 Playback gets stopped, to avoid conflicts.
937 Talk buffer is stolen as well.
939 void* plugin_get_audio_buffer(size_t *buffer_size
)
941 #if CONFIG_CODEC == SWCODEC
942 return audio_get_buffer(true, buffer_size
);
945 talk_buffer_steal(); /* we use the mp3 buffer, need to tell */
946 *buffer_size
= audiobufend
- audiobuf
;
951 #ifdef PLUGIN_USE_IRAM
952 /* Initializes plugin IRAM */
953 void plugin_iram_init(char *iramstart
, char *iramcopy
, size_t iram_size
,
954 char *iedata
, size_t iedata_size
)
956 /* We need to stop audio playback in order to use codec IRAM */
958 memcpy(iramstart
, iramcopy
, iram_size
);
959 memset(iedata
, 0, iedata_size
);
960 memset(iramcopy
, 0, iram_size
);
962 /* writeback cleared iedata and iramcopy areas */
966 #endif /* PLUGIN_USE_IRAM */
968 /* The plugin wants to stay resident after leaving its main function, e.g.
969 runs from timer or own thread. The callback is registered to later
970 instruct it to free its resources before a new plugin gets loaded. */
971 void plugin_tsr(bool (*exit_callback
)(bool))
973 pfn_tsr_exit
= exit_callback
; /* remember the callback for later */
976 char *plugin_get_current_filename(void)
978 return current_plugin
;
981 static int open_wrapper(const char* pathname
, int flags
, ...)
983 /* we don't have an 'open' function. it's a define. and we need
984 * the real file_open, hence PREFIX() doesn't work here */
992 fd
= sim_open(pathname
, flags
, va_arg(ap
, mode_t
));
996 fd
= sim_open(pathname
, flags
);
998 fd
= file_open(pathname
,flags
);
1001 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
1003 open_files
|= 1<<fd
;
1008 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
1009 static int close_wrapper(int fd
)
1011 if((~open_files
) & (1<<fd
))
1013 logf("double close from plugin");
1016 open_files
&= (~(1<<fd
));
1018 return PREFIX(close
)(fd
);
1021 static int creat_wrapper(const char *pathname
, mode_t mode
)
1023 int fd
= PREFIX(creat
)(pathname
, mode
);
1026 open_files
|= (1<<fd
);
1030 #endif /* HAVE_PLUGIN_CHECK_OPEN_CLOSE */