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"
47 #ifdef HAVE_LCD_BITMAP
48 #include "scrollbar.h"
49 #include "peakmeter.h"
54 #if defined(HAVE_USBSTACK) && defined(USB_ENABLE_HID)
55 #include "usbstack/usb_hid.h"
59 #define PREFIX(_x_) sim_ ## _x_
65 static unsigned char pluginbuf
[PLUGIN_BUFFER_SIZE
];
66 void *sim_plugin_load(char *plugin
, void **pd
);
67 void sim_plugin_close(void *pd
);
68 void sim_lcd_ex_init(unsigned long (*getpixel
)(int, int));
69 void sim_lcd_ex_update_rect(int x
, int y
, int width
, int height
);
71 #define sim_plugin_close(x)
72 extern unsigned char pluginbuf
[];
76 /* for actual plugins only, not for codecs */
77 static bool plugin_loaded
= false;
78 static int plugin_size
= 0;
79 static bool (*pfn_tsr_exit
)(bool reenter
) = NULL
; /* TSR exit callback */
80 static char current_plugin
[MAX_PATH
];
82 char *plugin_get_current_filename(void);
84 static const struct plugin_api rockbox_api
= {
87 #ifdef HAVE_LCD_CONTRAST
97 #ifdef HAVE_LCD_CHARCELLS
99 lcd_get_locked_pattern
,
107 &lcd_framebuffer
[0][0],
118 lcd_mono_bitmap_part
,
131 lcd_bitmap_transparent_part
,
132 lcd_bitmap_transparent
,
135 #if defined(TOSHIBA_GIGABEAT_F) || defined(SANSA_E200) || defined(SANSA_C200) \
136 || defined(IRIVER_H10) || defined(COWON_D2) || defined(PHILIPS_HDD1630) \
137 || defined(SANSA_FUZE) || defined(SANSA_E200V2) || defined(TOSHIBA_GIGABEAT_S)
140 #endif /* MEMORYSIZE > 2 */
141 #elif (LCD_DEPTH < 4) && !defined(SIMULATOR)
144 #endif /* LCD_DEPTH */
145 #if defined(HAVE_LCD_MODES) && (HAVE_LCD_MODES & LCD_MODE_PAL256)
147 lcd_pal256_update_pal
,
150 lcd_puts_scroll_style
,
151 #ifdef HAVE_LCD_INVERT
152 lcd_set_invert_display
,
153 #endif /* HAVE_LCD_INVERT */
154 #if defined(HAVE_LCD_MODES)
157 #if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
158 lcd_activation_set_hook
,
169 #endif /* HAVE_LCD_BITMAP */
174 backlight_set_timeout
,
175 #ifdef HAVE_BACKLIGHT_BRIGHTNESS
176 backlight_set_brightness
,
177 #endif /* HAVE_BACKLIGHT_BRIGHTNESS */
180 backlight_set_timeout_plugged
,
186 #ifdef HAVE_REMOTE_LCD
188 lcd_remote_set_contrast
,
189 lcd_remote_clear_display
,
191 lcd_remote_puts_scroll
,
192 lcd_remote_stop_scroll
,
193 lcd_remote_set_drawmode
,
194 lcd_remote_get_drawmode
,
196 lcd_remote_getstringsize
,
197 lcd_remote_drawpixel
,
203 lcd_remote_mono_bitmap_part
,
204 lcd_remote_mono_bitmap
,
206 lcd_remote_puts_style
,
207 lcd_remote_puts_scroll_style
,
208 &lcd_remote_framebuffer
[0][0],
210 lcd_remote_update_rect
,
213 remote_backlight_off
,
214 remote_backlight_set_timeout
,
216 remote_backlight_set_timeout_plugged
,
218 #endif /* HAVE_REMOTE_LCD */
220 {&screens
[SCREEN_MAIN
], &screens
[SCREEN_REMOTE
]},
222 {&screens
[SCREEN_MAIN
]},
224 #if defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1)
225 lcd_remote_set_foreground
,
226 lcd_remote_get_foreground
,
227 lcd_remote_set_background
,
228 lcd_remote_get_background
,
229 lcd_remote_bitmap_part
,
232 viewport_set_defaults
,
233 viewportmanager_set_statusbar
,
237 gui_synclist_set_nb_items
,
238 gui_synclist_set_icon_callback
,
239 gui_synclist_get_nb_items
,
240 gui_synclist_get_sel_pos
,
242 gui_synclist_select_item
,
243 gui_synclist_add_item
,
244 gui_synclist_del_item
,
245 gui_synclist_limit_scroll
,
246 gui_synclist_do_button
,
247 gui_synclist_set_title
,
249 simplelist_info_init
,
250 simplelist_show_list
,
256 #ifdef HAVE_BUTTON_DATA
261 #ifdef HAS_BUTTON_HOLD
264 #ifdef HAVE_TOUCHSCREEN
265 touchscreen_set_mode
,
268 #ifdef HAVE_BUTTON_LIGHT
269 buttonlight_set_timeout
,
272 #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
273 buttonlight_set_brightness
,
274 #endif /* HAVE_BUTTONLIGHT_BRIGHTNESS */
275 #endif /* HAVE_BUTTON_LIGHT */
278 (open_func
)PREFIX(open
),
280 (read_func
)PREFIX(read
),
282 (creat_func
)PREFIX(creat
),
283 (write_func
)PREFIX(write
),
294 #if USING_STORAGE_CALLBACK
295 register_storage_idle_func
,
296 unregister_storage_idle_func
,
297 #endif /* USING_STORAGE_CALLBACK */
299 create_numbered_filename
,
318 default_event_handler
,
319 default_event_handler_ex
,
323 #if (CONFIG_CODEC == SWCODEC)
325 #ifdef HAVE_PRIORITY_SCHEDULING
333 reset_poweroff_timer
,
338 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
339 #ifdef CPU_BOOST_LOGGING
344 #endif /* HAVE_ADJUSTABLE_CPU_FREQ */
345 #endif /* !SIMULATOR */
346 #ifdef HAVE_SCHEDULER_BOOSTCTRL
362 #if CONFIG_CODEC == SWCODEC
363 queue_enable_queue_send
,
370 #if defined(HAVE_USBSTACK) && defined(USB_ENABLE_HID)
376 __cyg_profile_func_enter
,
377 __cyg_profile_func_exit
,
381 /* special simulator hooks */
382 #if defined(HAVE_LCD_BITMAP) && LCD_DEPTH < 8
384 sim_lcd_ex_update_rect
,
388 /* strings and memory */
431 #if CONFIG_CODEC != SWCODEC
435 #if CONFIG_CODEC == SWCODEC
436 &audio_master_sampr_list
[0],
445 pcm_get_bytes_waiting
,
449 #ifdef HAVE_RECORDING
456 pcm_calculate_rec_peaks
,
457 audio_set_recording_gain
,
458 #endif /* HAVE_RECORDING */
459 #if INPUT_SRC_CAPS != 0
460 audio_set_output_source
,
461 audio_set_input_source
,
470 #endif /* CONFIG_CODEC == SWCODEC */
472 /* playback control */
478 playlist_remove_all_tracks
,
480 playlist_insert_track
,
481 playlist_insert_directory
,
493 audio_flush_and_reload_tracks
,
495 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
496 mpeg_get_last_header
,
498 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F) || \
499 (CONFIG_CODEC == SWCODEC)
503 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
504 /* MAS communication */
509 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
516 #endif /* !SIMULATOR && CONFIG_CODEC != SWCODEC */
522 gui_syncstatusbar_draw
,
531 #ifdef HAVE_LCD_COLOR
535 /* action handling */
538 #ifdef HAVE_TOUCHSCREEN
539 action_get_touchscreen_press
,
552 # if CONFIG_CHARGING >= CHARGING_MONITOR
556 #ifdef HAVE_USB_POWER
571 plugin_get_audio_buffer
,
573 plugin_get_current_filename
,
574 #ifdef PLUGIN_USE_IRAM
577 #if defined(DEBUG) || defined(SIMULATOR)
580 #ifdef ROCKBOX_HAS_LOGF
586 #if CONFIG_CODEC == SWCODEC
587 codec_thread_do_callback
,
596 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
597 peak_meter_scale_value
,
598 peak_meter_set_use_dbfs
,
599 peak_meter_get_use_dbfs
,
601 #ifdef HAVE_LCD_BITMAP
608 screen_dump_set_hook
,
615 #ifdef HAVE_WHEEL_POSITION
620 #ifdef IRIVER_H100_SERIES
621 /* Routines for the iriver_flash -plugin. */
622 detect_original_firmware
,
623 detect_flashed_ramimage
,
624 detect_flashed_romimage
,
627 #if (CONFIG_CODEC == SWCODEC)
640 buf_request_buffer_handle
,
647 tagcache_search_set_uniqbuf
,
648 tagcache_search_add_filter
,
651 tagcache_search_finish
,
652 tagcache_get_numeric
,
653 #ifdef HAVE_TC_RAMCACHE
659 search_albumart_files
,
662 #ifdef HAVE_SEMAPHORE_OBJECTS
669 /* new stuff at the end, sort into place next time
670 the API gets incompatible */
671 #if CONFIG_CODEC == SWCODEC
672 dsp_flush_limiter_buffer
,
676 int plugin_load(const char* plugin
, const void* parameter
)
680 struct plugin_header
*hdr
;
681 struct viewport plugin_vp
[NB_SCREENS
];
684 #else /* !SIMULATOR */
690 #endif /* !SIMULATOR */
693 fb_data
* old_backdrop
;
696 if (pfn_tsr_exit
!= NULL
) /* if we have a resident old plugin: */
698 if (pfn_tsr_exit(!strcmp(current_plugin
, plugin
)) == false )
700 /* not allowing another plugin to load */
704 plugin_loaded
= false;
707 splash(0, ID2P(LANG_WAIT
));
708 strcpy(current_plugin
, plugin
);
711 hdr
= sim_plugin_load((char *)plugin
, &pd
);
713 splashf(HZ
*2, str(LANG_PLUGIN_CANT_OPEN
), plugin
);
717 || hdr
->magic
!= PLUGIN_MAGIC
718 || hdr
->target_id
!= TARGET_ID
) {
719 sim_plugin_close(pd
);
720 splash(HZ
*2, str(LANG_PLUGIN_WRONG_MODEL
));
723 if (hdr
->api_version
> PLUGIN_API_VERSION
724 || hdr
->api_version
< PLUGIN_MIN_API_VERSION
) {
725 sim_plugin_close(pd
);
726 splash(HZ
*2, str(LANG_PLUGIN_WRONG_VERSION
));
730 fd
= open(plugin
, O_RDONLY
);
732 splashf(HZ
*2, str(LANG_PLUGIN_CANT_OPEN
), plugin
);
736 /* Make sure COP cache is flushed and invalidated before loading */
737 my_core
= switch_core(CURRENT_CORE
^ 1);
738 cpucache_invalidate();
739 switch_core(my_core
);
742 readsize
= read(fd
, pluginbuf
, PLUGIN_BUFFER_SIZE
);
746 splashf(HZ
*2, str(LANG_READ_FAILED
), plugin
);
749 hdr
= (struct plugin_header
*)pluginbuf
;
751 if ((unsigned)readsize
<= sizeof(struct plugin_header
)
752 || hdr
->magic
!= PLUGIN_MAGIC
753 || hdr
->target_id
!= TARGET_ID
754 || hdr
->load_addr
!= pluginbuf
755 || hdr
->end_addr
> pluginbuf
+ PLUGIN_BUFFER_SIZE
) {
756 splash(HZ
*2, str(LANG_PLUGIN_WRONG_MODEL
));
759 if (hdr
->api_version
> PLUGIN_API_VERSION
760 || hdr
->api_version
< PLUGIN_MIN_API_VERSION
) {
761 splash(HZ
*2, str(LANG_PLUGIN_WRONG_VERSION
));
764 plugin_size
= hdr
->end_addr
- pluginbuf
;
766 /* zero out bss area only, above guards end of pluginbuf */
767 if (plugin_size
> readsize
)
768 memset(pluginbuf
+ readsize
, 0, plugin_size
- readsize
);
771 *(hdr
->api
) = &rockbox_api
;
772 plugin_loaded
= true;
775 #if defined HAVE_LCD_BITMAP && LCD_DEPTH > 1
776 old_backdrop
= lcd_get_backdrop();
781 #ifdef HAVE_REMOTE_LCD
782 lcd_remote_clear_display();
786 oldbars
= viewportmanager_set_statusbar(VP_SB_HIDE_ALL
);
789 viewport_set_fullscreen(&plugin_vp
[i
], i
);
791 viewport_set_current_vp(plugin_vp
);
793 cpucache_invalidate();
795 #ifdef HAVE_TOUCHSCREEN
796 touchscreen_set_mode(TOUCHSCREEN_BUTTON
);
799 rc
= hdr
->entry_point(parameter
);
801 /* Go back to the global setting in case the plugin changed it */
802 #ifdef HAVE_TOUCHSCREEN
803 touchscreen_set_mode(global_settings
.touch_mode
);
806 viewportmanager_set_statusbar(oldbars
);
808 button_clear_queue();
810 #ifdef HAVE_LCD_BITMAP
811 lcd_setfont(FONT_UI
);
813 lcd_set_backdrop(old_backdrop
);
814 #ifdef HAVE_LCD_COLOR
815 lcd_set_drawinfo(DRMODE_SOLID
, global_settings
.fg_color
,
816 global_settings
.bg_color
);
818 lcd_set_drawinfo(DRMODE_SOLID
, LCD_DEFAULT_FG
, LCD_DEFAULT_BG
);
820 #else /* LCD_DEPTH == 1 */
821 lcd_set_drawmode(DRMODE_SOLID
);
822 #endif /* LCD_DEPTH */
823 #endif /* HAVE_LCD_BITMAP */
826 #ifdef HAVE_REMOTE_LCD
827 #if LCD_REMOTE_DEPTH > 1
828 lcd_remote_set_drawinfo(DRMODE_SOLID
, LCD_REMOTE_DEFAULT_FG
,
829 LCD_REMOTE_DEFAULT_BG
);
831 lcd_remote_set_drawmode(DRMODE_SOLID
);
835 if (rc
!= PLUGIN_GOTO_WPS
)
837 send_event(GUI_EVENT_REFRESH
, NULL
);
840 viewportmanager_set_statusbar(oldbars
);
841 viewport_set_current_vp(NULL
);
842 if (pfn_tsr_exit
== NULL
)
843 plugin_loaded
= false;
845 sim_plugin_close(pd
);
847 if (rc
== PLUGIN_ERROR
)
848 splash(HZ
*2, str(LANG_PLUGIN_ERROR
));
853 /* Returns a pointer to the portion of the plugin buffer that is not already
854 being used. If no plugin is loaded, returns the entire plugin buffer */
855 void* plugin_get_buffer(size_t *buffer_size
)
861 if (plugin_size
>= PLUGIN_BUFFER_SIZE
)
864 *buffer_size
= PLUGIN_BUFFER_SIZE
-plugin_size
;
865 buffer_pos
= plugin_size
;
869 *buffer_size
= PLUGIN_BUFFER_SIZE
;
873 return &pluginbuf
[buffer_pos
];
876 /* Returns a pointer to the mp3 buffer.
877 Playback gets stopped, to avoid conflicts.
878 Talk buffer is stolen as well.
880 void* plugin_get_audio_buffer(size_t *buffer_size
)
882 #if CONFIG_CODEC == SWCODEC
883 return audio_get_buffer(true, buffer_size
);
886 talk_buffer_steal(); /* we use the mp3 buffer, need to tell */
887 *buffer_size
= audiobufend
- audiobuf
;
892 #ifdef PLUGIN_USE_IRAM
893 /* Initializes plugin IRAM */
894 void plugin_iram_init(char *iramstart
, char *iramcopy
, size_t iram_size
,
895 char *iedata
, size_t iedata_size
)
897 /* We need to stop audio playback in order to use codec IRAM */
899 memcpy(iramstart
, iramcopy
, iram_size
);
900 memset(iedata
, 0, iedata_size
);
901 memset(iramcopy
, 0, iram_size
);
903 /* writeback cleared iedata and iramcopy areas */
907 #endif /* PLUGIN_USE_IRAM */
909 /* The plugin wants to stay resident after leaving its main function, e.g.
910 runs from timer or own thread. The callback is registered to later
911 instruct it to free its resources before a new plugin gets loaded. */
912 void plugin_tsr(bool (*exit_callback
)(bool))
914 pfn_tsr_exit
= exit_callback
; /* remember the callback for later */
917 char *plugin_get_current_filename(void)
919 return current_plugin
;