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 /* Some wrappers used to monitor open and close and detect leaks*/
96 static int open_wrapper(const char* pathname
, int flags
, ...);
97 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
98 static int close_wrapper(int fd
);
99 static int creat_wrapper(const char *pathname
, mode_t mode
);
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 (open_func
)open_wrapper
,
302 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
307 (read_func
)PREFIX(read
),
309 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
310 (creat_func
)creat_wrapper
,
312 (creat_func
)PREFIX(creat
),
314 (write_func
)PREFIX(write
),
325 #if USING_STORAGE_CALLBACK
326 register_storage_idle_func
,
327 unregister_storage_idle_func
,
328 #endif /* USING_STORAGE_CALLBACK */
330 create_numbered_filename
,
350 default_event_handler
,
351 default_event_handler_ex
,
355 #if (CONFIG_CODEC == SWCODEC)
357 #ifdef HAVE_PRIORITY_SCHEDULING
365 reset_poweroff_timer
,
370 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
371 #ifdef CPU_BOOST_LOGGING
376 #endif /* HAVE_ADJUSTABLE_CPU_FREQ */
377 #endif /* !SIMULATOR */
378 #ifdef HAVE_SCHEDULER_BOOSTCTRL
394 #if CONFIG_CODEC == SWCODEC
395 queue_enable_queue_send
,
402 #ifdef USB_ENABLE_HID
408 __cyg_profile_func_enter
,
409 __cyg_profile_func_exit
,
416 /* special simulator hooks */
417 #if defined(HAVE_LCD_BITMAP) && LCD_DEPTH < 8
419 sim_lcd_ex_update_rect
,
423 /* strings and memory */
469 #if CONFIG_CODEC != SWCODEC
473 #if CONFIG_CODEC == SWCODEC
474 &audio_master_sampr_list
[0],
483 pcm_get_bytes_waiting
,
489 #ifdef HAVE_RECORDING
496 pcm_calculate_rec_peaks
,
497 audio_set_recording_gain
,
498 #endif /* HAVE_RECORDING */
499 #if INPUT_SRC_CAPS != 0
500 audio_set_output_source
,
501 audio_set_input_source
,
510 #endif /* CONFIG_CODEC == SWCODEC */
512 /* playback control */
518 playlist_remove_all_tracks
,
520 playlist_insert_track
,
521 playlist_insert_directory
,
533 audio_flush_and_reload_tracks
,
535 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
536 mpeg_get_last_header
,
538 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F) || \
539 (CONFIG_CODEC == SWCODEC)
543 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
544 /* MAS communication */
549 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
556 #endif /* !SIMULATOR && CONFIG_CODEC != SWCODEC */
562 gui_syncstatusbar_draw
,
571 #ifdef HAVE_LCD_COLOR
575 /* action handling */
578 #ifdef HAVE_TOUCHSCREEN
579 action_get_touchscreen_press
,
592 # if CONFIG_CHARGING >= CHARGING_MONITOR
596 #ifdef HAVE_USB_POWER
601 #if !defined(SIMULATOR)
614 plugin_get_audio_buffer
,
616 plugin_get_current_filename
,
617 #ifdef PLUGIN_USE_IRAM
620 #if defined(DEBUG) || defined(SIMULATOR)
623 #ifdef ROCKBOX_HAS_LOGF
629 #if CONFIG_CODEC == SWCODEC
630 codec_thread_do_callback
,
639 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
640 peak_meter_scale_value
,
641 peak_meter_set_use_dbfs
,
642 peak_meter_get_use_dbfs
,
644 #ifdef HAVE_LCD_BITMAP
651 screen_dump_set_hook
,
658 #ifdef HAVE_WHEEL_POSITION
663 #ifdef IRIVER_H100_SERIES
664 /* Routines for the iriver_flash -plugin. */
665 detect_original_firmware
,
666 detect_flashed_ramimage
,
667 detect_flashed_romimage
,
670 #if (CONFIG_CODEC == SWCODEC)
683 buf_request_buffer_handle
,
690 tagcache_search_set_uniqbuf
,
691 tagcache_search_add_filter
,
694 tagcache_search_finish
,
695 tagcache_get_numeric
,
696 #ifdef HAVE_TC_RAMCACHE
702 search_albumart_files
,
705 #ifdef HAVE_SEMAPHORE_OBJECTS
712 /* new stuff at the end, sort into place next time
713 the API gets incompatible */
715 #ifdef HAVE_LCD_BITMAP
719 #if (CONFIG_CODEC == SWCODEC) && defined(HAVE_RECORDING) && \
720 (defined(HAVE_LINE_IN) || defined(HAVE_MIC_IN))
721 round_value_to_list32
,
726 int plugin_load(const char* plugin
, const void* parameter
)
729 struct plugin_header
*hdr
;
732 #else /* !SIMULATOR */
738 #endif /* !SIMULATOR */
741 fb_data
* old_backdrop
;
744 if (pfn_tsr_exit
!= NULL
) /* if we have a resident old plugin: */
746 if (pfn_tsr_exit(!strcmp(current_plugin
, plugin
)) == false )
748 /* not allowing another plugin to load */
752 plugin_loaded
= false;
755 splash(0, ID2P(LANG_WAIT
));
756 strcpy(current_plugin
, plugin
);
759 hdr
= sim_plugin_load((char *)plugin
, &pd
);
761 splashf(HZ
*2, str(LANG_PLUGIN_CANT_OPEN
), plugin
);
765 || hdr
->magic
!= PLUGIN_MAGIC
766 || hdr
->target_id
!= TARGET_ID
) {
767 sim_plugin_close(pd
);
768 splash(HZ
*2, str(LANG_PLUGIN_WRONG_MODEL
));
771 if (hdr
->api_version
> PLUGIN_API_VERSION
772 || hdr
->api_version
< PLUGIN_MIN_API_VERSION
) {
773 sim_plugin_close(pd
);
774 splash(HZ
*2, str(LANG_PLUGIN_WRONG_VERSION
));
778 fd
= open(plugin
, O_RDONLY
);
780 splashf(HZ
*2, str(LANG_PLUGIN_CANT_OPEN
), plugin
);
784 /* Make sure COP cache is flushed and invalidated before loading */
785 my_core
= switch_core(CURRENT_CORE
^ 1);
786 cpucache_invalidate();
787 switch_core(my_core
);
790 readsize
= read(fd
, pluginbuf
, PLUGIN_BUFFER_SIZE
);
794 splashf(HZ
*2, str(LANG_READ_FAILED
), plugin
);
797 hdr
= (struct plugin_header
*)pluginbuf
;
799 if ((unsigned)readsize
<= sizeof(struct plugin_header
)
800 || hdr
->magic
!= PLUGIN_MAGIC
801 || hdr
->target_id
!= TARGET_ID
802 || hdr
->load_addr
!= pluginbuf
803 || hdr
->end_addr
> pluginbuf
+ PLUGIN_BUFFER_SIZE
) {
804 splash(HZ
*2, str(LANG_PLUGIN_WRONG_MODEL
));
807 if (hdr
->api_version
> PLUGIN_API_VERSION
808 || hdr
->api_version
< PLUGIN_MIN_API_VERSION
) {
809 splash(HZ
*2, str(LANG_PLUGIN_WRONG_VERSION
));
812 plugin_size
= hdr
->end_addr
- pluginbuf
;
814 /* zero out bss area only, above guards end of pluginbuf */
815 if (plugin_size
> readsize
)
816 memset(pluginbuf
+ readsize
, 0, plugin_size
- readsize
);
819 *(hdr
->api
) = &rockbox_api
;
820 plugin_loaded
= true;
823 #if defined HAVE_LCD_BITMAP && LCD_DEPTH > 1
824 old_backdrop
= lcd_get_backdrop();
829 #ifdef HAVE_REMOTE_LCD
830 lcd_remote_clear_display();
835 viewportmanager_theme_enable(i
, false, NULL
);
837 cpucache_invalidate();
839 #ifdef HAVE_TOUCHSCREEN
840 touchscreen_set_mode(TOUCHSCREEN_BUTTON
);
843 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
847 rc
= hdr
->entry_point(parameter
);
849 /* Go back to the global setting in case the plugin changed it */
850 #ifdef HAVE_TOUCHSCREEN
851 touchscreen_set_mode(global_settings
.touch_mode
);
854 button_clear_queue();
856 #ifdef HAVE_LCD_BITMAP
857 lcd_setfont(FONT_UI
);
859 lcd_set_backdrop(old_backdrop
);
860 #ifdef HAVE_LCD_COLOR
861 lcd_set_drawinfo(DRMODE_SOLID
, global_settings
.fg_color
,
862 global_settings
.bg_color
);
864 lcd_set_drawinfo(DRMODE_SOLID
, LCD_DEFAULT_FG
, LCD_DEFAULT_BG
);
866 #else /* LCD_DEPTH == 1 */
867 lcd_set_drawmode(DRMODE_SOLID
);
868 #endif /* LCD_DEPTH */
869 #endif /* HAVE_LCD_BITMAP */
872 #ifdef HAVE_REMOTE_LCD
873 #if LCD_REMOTE_DEPTH > 1
874 lcd_remote_set_drawinfo(DRMODE_SOLID
, LCD_REMOTE_DEFAULT_FG
,
875 LCD_REMOTE_DEFAULT_BG
);
877 lcd_remote_set_drawmode(DRMODE_SOLID
);
882 #ifdef HAVE_LCD_REMOTE
883 lcd_remote_clear_display();
887 viewportmanager_theme_undo(i
, false);
889 if (pfn_tsr_exit
== NULL
)
890 plugin_loaded
= false;
892 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
893 if(open_files
!= 0 && !plugin_loaded
)
896 logf("Plugin '%s' leaks file handles", plugin
);
898 static const char *lines
[] =
899 { ID2P(LANG_PLUGIN_ERROR
),
900 "#leak-file-handles" };
901 static const struct text_message message
={ lines
, 2 };
902 button_clear_queue(); /* Empty the keyboard buffer */
903 gui_syncyesno_run(&message
, NULL
, NULL
);
905 for(fd
=0; fd
< MAX_OPEN_FILES
; fd
++)
906 if(open_files
& (1<<fd
))
911 sim_plugin_close(pd
);
913 if (rc
== PLUGIN_ERROR
)
914 splash(HZ
*2, str(LANG_PLUGIN_ERROR
));
919 /* Returns a pointer to the portion of the plugin buffer that is not already
920 being used. If no plugin is loaded, returns the entire plugin buffer */
921 void* plugin_get_buffer(size_t *buffer_size
)
927 if (plugin_size
>= PLUGIN_BUFFER_SIZE
)
930 *buffer_size
= PLUGIN_BUFFER_SIZE
-plugin_size
;
931 buffer_pos
= plugin_size
;
935 *buffer_size
= PLUGIN_BUFFER_SIZE
;
939 return &pluginbuf
[buffer_pos
];
942 /* Returns a pointer to the mp3 buffer.
943 Playback gets stopped, to avoid conflicts.
944 Talk buffer is stolen as well.
946 void* plugin_get_audio_buffer(size_t *buffer_size
)
948 #if CONFIG_CODEC == SWCODEC
949 return audio_get_buffer(true, buffer_size
);
952 talk_buffer_steal(); /* we use the mp3 buffer, need to tell */
953 *buffer_size
= audiobufend
- audiobuf
;
958 #ifdef PLUGIN_USE_IRAM
959 /* Initializes plugin IRAM */
960 void plugin_iram_init(char *iramstart
, char *iramcopy
, size_t iram_size
,
961 char *iedata
, size_t iedata_size
)
963 /* We need to stop audio playback in order to use codec IRAM */
965 memcpy(iramstart
, iramcopy
, iram_size
);
966 memset(iedata
, 0, iedata_size
);
967 memset(iramcopy
, 0, iram_size
);
969 /* writeback cleared iedata and iramcopy areas */
973 #endif /* PLUGIN_USE_IRAM */
975 /* The plugin wants to stay resident after leaving its main function, e.g.
976 runs from timer or own thread. The callback is registered to later
977 instruct it to free its resources before a new plugin gets loaded. */
978 void plugin_tsr(bool (*exit_callback
)(bool))
980 pfn_tsr_exit
= exit_callback
; /* remember the callback for later */
983 char *plugin_get_current_filename(void)
985 return current_plugin
;
988 static int open_wrapper(const char* pathname
, int flags
, ...)
990 /* we don't have an 'open' function. it's a define. and we need
991 * the real file_open, hence PREFIX() doesn't work here */
998 fd
= sim_open(pathname
, flags
, va_arg(ap
, unsigned int));
1002 fd
= sim_open(pathname
, flags
);
1004 fd
= file_open(pathname
,flags
);
1007 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
1009 open_files
|= 1<<fd
;
1014 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
1015 static int close_wrapper(int fd
)
1017 if((~open_files
) & (1<<fd
))
1019 logf("double close from plugin");
1022 open_files
&= (~(1<<fd
));
1024 return PREFIX(close
)(fd
);
1027 static int creat_wrapper(const char *pathname
, mode_t mode
)
1029 int fd
= PREFIX(creat
)(pathname
, mode
);
1032 open_files
|= (1<<fd
);
1036 #endif /* HAVE_PLUGIN_CHECK_OPEN_CLOSE */