Update the discussion of themeing in the manual, and put a note in the wps tags appen...
[kugel-rb.git] / apps / plugin.c
blobe4480deed17559e2ceffce3dcabb1678213650ab
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
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 ****************************************************************************/
21 #include "plugin.h"
22 #include <ctype.h>
23 #include <string.h>
24 #include <stdlib.h>
25 #include "debug.h"
26 #include "i2c.h"
27 #include "lang.h"
28 #include "led.h"
29 #include "keyboard.h"
30 #include "buffer.h"
31 #include "backlight.h"
32 #include "sound_menu.h"
33 #include "mp3data.h"
34 #include "powermgmt.h"
35 #include "splash.h"
36 #include "logf.h"
37 #include "option_select.h"
38 #include "talk.h"
39 #include "version.h"
40 #include "storage.h"
41 #include "pcmbuf.h"
42 #include "errno.h"
43 #include "diacritic.h"
45 #if CONFIG_CHARGING
46 #include "power.h"
47 #endif
49 #ifdef HAVE_LCD_BITMAP
50 #include "scrollbar.h"
51 #include "peakmeter.h"
52 #include "bmp.h"
53 #include "bidi.h"
54 #endif
56 #ifdef USB_ENABLE_HID
57 #include "usbstack/usb_hid.h"
58 #endif
60 #ifdef SIMULATOR
61 #define PREFIX(_x_) sim_ ## _x_
62 #else
63 #define PREFIX
64 #endif
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
69 #endif
71 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
72 static unsigned int open_files;
73 #endif
75 #ifdef SIMULATOR
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);
81 #else
82 #define sim_plugin_close(x)
83 extern unsigned char pluginbuf[];
84 #include "bitswap.h"
85 #endif
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);
100 #endif
102 static const struct plugin_api rockbox_api = {
104 /* lcd */
105 #ifdef HAVE_LCD_CONTRAST
106 lcd_set_contrast,
107 #endif
108 lcd_update,
109 lcd_clear_display,
110 lcd_getstringsize,
111 lcd_putsxy,
112 lcd_puts,
113 lcd_puts_scroll,
114 lcd_stop_scroll,
115 #ifdef HAVE_LCD_CHARCELLS
116 lcd_define_pattern,
117 lcd_get_locked_pattern,
118 lcd_unlock_pattern,
119 lcd_putc,
120 lcd_put_cursor,
121 lcd_remove_cursor,
122 lcd_icon,
123 lcd_double_height,
124 #else
125 &lcd_framebuffer[0][0],
126 lcd_update_rect,
127 lcd_set_drawmode,
128 lcd_get_drawmode,
129 lcd_setfont,
130 lcd_drawpixel,
131 lcd_drawline,
132 lcd_hline,
133 lcd_vline,
134 lcd_drawrect,
135 lcd_fillrect,
136 lcd_mono_bitmap_part,
137 lcd_mono_bitmap,
138 #if LCD_DEPTH > 1
139 lcd_set_foreground,
140 lcd_get_foreground,
141 lcd_set_background,
142 lcd_get_background,
143 lcd_bitmap_part,
144 lcd_bitmap,
145 lcd_get_backdrop,
146 lcd_set_backdrop,
147 #endif
148 #if LCD_DEPTH == 16
149 lcd_bitmap_transparent_part,
150 lcd_bitmap_transparent,
151 #if MEMORYSIZE > 2
152 lcd_blit_yuv,
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)
157 lcd_yuv_set_options,
158 #endif
159 #endif /* MEMORYSIZE > 2 */
160 #elif (LCD_DEPTH < 4) && !defined(SIMULATOR)
161 lcd_blit_mono,
162 lcd_blit_grey_phase,
163 #endif /* LCD_DEPTH */
164 #if defined(HAVE_LCD_MODES) && (HAVE_LCD_MODES & LCD_MODE_PAL256)
165 lcd_blit_pal256,
166 lcd_pal256_update_pal,
167 #endif
168 lcd_puts_style,
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)
174 lcd_set_mode,
175 #endif
176 #if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
177 &button_queue,
178 #endif
179 bidi_l2v,
180 font_get_bits,
181 font_load,
182 font_get,
183 font_getstringsize,
184 font_get_width,
185 screen_clear_area,
186 gui_scrollbar_draw,
187 #endif /* HAVE_LCD_BITMAP */
188 get_codepage_name,
190 backlight_on,
191 backlight_off,
192 backlight_set_timeout,
193 #ifdef HAVE_BACKLIGHT_BRIGHTNESS
194 backlight_set_brightness,
195 #endif /* HAVE_BACKLIGHT_BRIGHTNESS */
197 #if CONFIG_CHARGING
198 backlight_set_timeout_plugged,
199 #endif
200 is_backlight_on,
201 splash,
202 splashf,
204 #ifdef HAVE_REMOTE_LCD
205 /* remote lcd */
206 lcd_remote_set_contrast,
207 lcd_remote_clear_display,
208 lcd_remote_puts,
209 lcd_remote_puts_scroll,
210 lcd_remote_stop_scroll,
211 lcd_remote_set_drawmode,
212 lcd_remote_get_drawmode,
213 lcd_remote_setfont,
214 lcd_remote_getstringsize,
215 lcd_remote_drawpixel,
216 lcd_remote_drawline,
217 lcd_remote_hline,
218 lcd_remote_vline,
219 lcd_remote_drawrect,
220 lcd_remote_fillrect,
221 lcd_remote_mono_bitmap_part,
222 lcd_remote_mono_bitmap,
223 lcd_remote_putsxy,
224 lcd_remote_puts_style,
225 lcd_remote_puts_scroll_style,
226 &lcd_remote_framebuffer[0][0],
227 lcd_remote_update,
228 lcd_remote_update_rect,
230 remote_backlight_on,
231 remote_backlight_off,
232 remote_backlight_set_timeout,
233 #if CONFIG_CHARGING
234 remote_backlight_set_timeout_plugged,
235 #endif
236 #endif /* HAVE_REMOTE_LCD */
237 #if NB_SCREENS == 2
238 {&screens[SCREEN_MAIN], &screens[SCREEN_REMOTE]},
239 #else
240 {&screens[SCREEN_MAIN]},
241 #endif
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,
248 lcd_remote_bitmap,
249 #endif
250 viewport_set_defaults,
251 #ifdef HAVE_LCD_BITMAP
252 viewportmanager_theme_enable,
253 viewportmanager_theme_undo,
254 #endif
256 /* list */
257 gui_synclist_init,
258 gui_synclist_set_nb_items,
259 gui_synclist_set_icon_callback,
260 gui_synclist_get_nb_items,
261 gui_synclist_get_sel_pos,
262 gui_synclist_draw,
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,
269 gui_syncyesno_run,
270 simplelist_info_init,
271 simplelist_show_list,
273 /* button */
274 button_get,
275 button_get_w_tmo,
276 button_status,
277 #ifdef HAVE_BUTTON_DATA
278 button_get_data,
279 button_status_wdata,
280 #endif
281 button_clear_queue,
282 button_queue_count,
283 #ifdef HAS_BUTTON_HOLD
284 button_hold,
285 #endif
286 #ifdef HAVE_TOUCHSCREEN
287 touchscreen_set_mode,
288 #endif
290 #ifdef HAVE_BUTTON_LIGHT
291 buttonlight_set_timeout,
292 buttonlight_off,
293 buttonlight_on,
294 #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
295 buttonlight_set_brightness,
296 #endif /* HAVE_BUTTONLIGHT_BRIGHTNESS */
297 #endif /* HAVE_BUTTON_LIGHT */
299 /* file */
300 open_utf8,
301 (open_func)open_wrapper,
302 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
303 close_wrapper,
304 #else
305 PREFIX(close),
306 #endif
307 (read_func)PREFIX(read),
308 PREFIX(lseek),
309 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
310 (creat_func)creat_wrapper,
311 #else
312 (creat_func)PREFIX(creat),
313 #endif
314 (write_func)PREFIX(write),
315 PREFIX(remove),
316 PREFIX(rename),
317 PREFIX(ftruncate),
318 PREFIX(filesize),
319 fdprintf,
320 read_line,
321 settings_parseline,
322 storage_sleep,
323 storage_spin,
324 storage_spindown,
325 #if USING_STORAGE_CALLBACK
326 register_storage_idle_func,
327 unregister_storage_idle_func,
328 #endif /* USING_STORAGE_CALLBACK */
329 reload_directory,
330 create_numbered_filename,
331 file_exists,
332 strip_extension,
333 crc_32,
335 /* dir */
336 opendir,
337 closedir,
338 readdir,
339 mkdir,
340 rmdir,
341 dir_exists,
343 /* kernel/ system */
344 #ifdef CPU_ARM
345 __div0,
346 #endif
347 PREFIX(sleep),
348 yield,
349 &current_tick,
350 default_event_handler,
351 default_event_handler_ex,
352 create_thread,
353 thread_exit,
354 thread_wait,
355 #if (CONFIG_CODEC == SWCODEC)
356 thread_thaw,
357 #ifdef HAVE_PRIORITY_SCHEDULING
358 thread_set_priority,
359 #endif
360 mutex_init,
361 mutex_lock,
362 mutex_unlock,
363 #endif
365 reset_poweroff_timer,
366 #ifndef SIMULATOR
367 system_memory_guard,
368 &cpu_frequency,
370 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
371 #ifdef CPU_BOOST_LOGGING
372 cpu_boost_,
373 #else
374 cpu_boost,
375 #endif
376 #endif /* HAVE_ADJUSTABLE_CPU_FREQ */
377 #endif /* !SIMULATOR */
378 #ifdef HAVE_SCHEDULER_BOOSTCTRL
379 trigger_cpu_boost,
380 cancel_cpu_boost,
381 #endif
382 #if NUM_CORES > 1
383 cpucache_flush,
384 cpucache_invalidate,
385 #endif
386 timer_register,
387 timer_unregister,
388 timer_set_period,
390 queue_init,
391 queue_delete,
392 queue_post,
393 queue_wait_w_tmo,
394 #if CONFIG_CODEC == SWCODEC
395 queue_enable_queue_send,
396 queue_empty,
397 queue_wait,
398 queue_send,
399 queue_reply,
400 #endif
401 usb_acknowledge,
402 #ifdef USB_ENABLE_HID
403 usb_hid_send,
404 #endif
405 #ifdef RB_PROFILE
406 profile_thread,
407 profstop,
408 __cyg_profile_func_enter,
409 __cyg_profile_func_exit,
410 #endif
411 add_event,
412 remove_event,
413 send_event,
415 #ifdef SIMULATOR
416 /* special simulator hooks */
417 #if defined(HAVE_LCD_BITMAP) && LCD_DEPTH < 8
418 sim_lcd_ex_init,
419 sim_lcd_ex_update_rect,
420 #endif
421 #endif
423 /* strings and memory */
424 snprintf,
425 vsnprintf,
426 strcpy,
427 strlcpy,
428 strlen,
429 strrchr,
430 strcmp,
431 strncmp,
432 strcasecmp,
433 strncasecmp,
434 memset,
435 memcpy,
436 memmove,
437 _ctype_,
438 atoi,
439 strchr,
440 strcat,
441 strlcat,
442 memchr,
443 memcmp,
444 strcasestr,
445 strtok_r,
446 /* unicode stuff */
447 utf8decode,
448 iso_decode,
449 utf16LEdecode,
450 utf16BEdecode,
451 utf8encode,
452 utf8length,
453 utf8seek,
455 /* sound */
456 sound_set,
457 sound_default,
458 sound_min,
459 sound_max,
460 sound_unit,
461 sound_val2phys,
462 #ifndef SIMULATOR
463 mp3_play_data,
464 mp3_play_pause,
465 mp3_play_stop,
466 mp3_is_playing,
467 #if CONFIG_CODEC != SWCODEC
468 bitswap,
469 #endif
470 #endif
471 #if CONFIG_CODEC == SWCODEC
472 &audio_master_sampr_list[0],
473 &hw_freq_sampr[0],
474 pcm_apply_settings,
475 pcm_play_data,
476 pcm_play_stop,
477 pcm_set_frequency,
478 pcm_is_playing,
479 pcm_is_paused,
480 pcm_play_pause,
481 pcm_get_bytes_waiting,
482 pcm_calculate_peaks,
483 pcm_get_peak_buffer,
484 pcm_play_lock,
485 pcm_play_unlock,
486 pcmbuf_beep,
487 #ifdef HAVE_RECORDING
488 &rec_freq_sampr[0],
489 pcm_init_recording,
490 pcm_close_recording,
491 pcm_record_data,
492 pcm_record_more,
493 pcm_stop_recording,
494 pcm_calculate_rec_peaks,
495 audio_set_recording_gain,
496 #endif /* HAVE_RECORDING */
497 #if INPUT_SRC_CAPS != 0
498 audio_set_output_source,
499 audio_set_input_source,
500 #endif
501 dsp_set_crossfeed,
502 dsp_set_eq,
503 dsp_dither_enable,
504 dsp_configure,
505 dsp_process,
506 dsp_input_count,
507 dsp_output_count,
508 #endif /* CONFIG_CODEC == SWCODEC */
510 /* playback control */
511 playlist_amount,
512 playlist_resume,
513 playlist_start,
514 playlist_add,
515 playlist_sync,
516 playlist_remove_all_tracks,
517 playlist_create,
518 playlist_insert_track,
519 playlist_insert_directory,
520 playlist_shuffle,
521 PREFIX(audio_play),
522 audio_stop,
523 audio_pause,
524 audio_resume,
525 audio_next,
526 audio_prev,
527 audio_ff_rewind,
528 audio_next_track,
529 audio_status,
530 audio_current_track,
531 audio_flush_and_reload_tracks,
532 audio_get_file_pos,
533 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
534 mpeg_get_last_header,
535 #endif
536 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F) || \
537 (CONFIG_CODEC == SWCODEC)
538 sound_set_pitch,
539 #endif
541 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
542 /* MAS communication */
543 mas_readmem,
544 mas_writemem,
545 mas_readreg,
546 mas_writereg,
547 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
548 mas_codec_writereg,
549 mas_codec_readreg,
550 i2c_begin,
551 i2c_end,
552 i2c_write,
553 #endif
554 #endif /* !SIMULATOR && CONFIG_CODEC != SWCODEC */
556 /* menu */
557 do_menu,
558 /* statusbars */
559 &statusbars,
560 gui_syncstatusbar_draw,
561 /* options */
562 get_settings_list,
563 find_setting,
564 option_screen,
565 set_option,
566 set_bool_options,
567 set_int,
568 set_bool,
569 #ifdef HAVE_LCD_COLOR
570 set_color,
571 #endif
573 /* action handling */
574 get_custom_action,
575 get_action,
576 #ifdef HAVE_TOUCHSCREEN
577 action_get_touchscreen_press,
578 #endif
579 action_userabort,
581 /* power */
582 battery_level,
583 battery_level_safe,
584 battery_time,
585 #ifndef SIMULATOR
586 battery_voltage,
587 #endif
588 #if CONFIG_CHARGING
589 charger_inserted,
590 # if CONFIG_CHARGING >= CHARGING_MONITOR
591 charging_state,
592 # endif
593 #endif
594 #ifdef HAVE_USB_POWER
595 usb_powered,
596 #endif
598 /* misc */
599 #if !defined(SIMULATOR) || defined(__MINGW32__) || defined(__CYGWIN__)
600 &errno,
601 #endif
602 srand,
603 rand,
604 (qsort_func)qsort,
605 kbd_input,
606 get_time,
607 set_time,
608 #if CONFIG_RTC
609 mktime,
610 #endif
611 plugin_get_buffer,
612 plugin_get_audio_buffer,
613 plugin_tsr,
614 plugin_get_current_filename,
615 #ifdef PLUGIN_USE_IRAM
616 plugin_iram_init,
617 #endif
618 #if defined(DEBUG) || defined(SIMULATOR)
619 debugf,
620 #endif
621 #ifdef ROCKBOX_HAS_LOGF
622 _logf,
623 #endif
624 &global_settings,
625 &global_status,
626 talk_disable,
627 #if CONFIG_CODEC == SWCODEC
628 codec_thread_do_callback,
629 codec_load_file,
630 get_codec_filename,
631 #endif
632 get_metadata,
633 mp3info,
634 count_mp3_frames,
635 create_xing_header,
636 find_next_frame,
637 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
638 peak_meter_scale_value,
639 peak_meter_set_use_dbfs,
640 peak_meter_get_use_dbfs,
641 #endif
642 #ifdef HAVE_LCD_BITMAP
643 read_bmp_file,
644 read_bmp_fd,
645 #ifdef HAVE_JPEG
646 read_jpeg_file,
647 read_jpeg_fd,
648 #endif
649 screen_dump_set_hook,
650 #endif
651 show_logo,
652 tree_get_context,
653 set_current_file,
654 set_dirfilter,
656 #ifdef HAVE_WHEEL_POSITION
657 wheel_status,
658 wheel_send_events,
659 #endif
661 #ifdef IRIVER_H100_SERIES
662 /* Routines for the iriver_flash -plugin. */
663 detect_original_firmware,
664 detect_flashed_ramimage,
665 detect_flashed_romimage,
666 #endif
667 led,
668 #if (CONFIG_CODEC == SWCODEC)
669 bufopen,
670 bufalloc,
671 bufclose,
672 bufseek,
673 bufadvance,
674 bufread,
675 bufgetdata,
676 bufgettail,
677 bufcuttail,
679 buf_get_offset,
680 buf_handle_offset,
681 buf_request_buffer_handle,
682 buf_set_base_handle,
683 buf_used,
684 #endif
686 #ifdef HAVE_TAGCACHE
687 tagcache_search,
688 tagcache_search_set_uniqbuf,
689 tagcache_search_add_filter,
690 tagcache_get_next,
691 tagcache_retrieve,
692 tagcache_search_finish,
693 tagcache_get_numeric,
694 #ifdef HAVE_TC_RAMCACHE
695 tagcache_fill_tags,
696 #endif
697 #endif
699 #ifdef HAVE_ALBUMART
700 search_albumart_files,
701 #endif
703 #ifdef HAVE_SEMAPHORE_OBJECTS
704 semaphore_init,
705 semaphore_wait,
706 semaphore_release,
707 #endif
709 appsversion,
710 /* new stuff at the end, sort into place next time
711 the API gets incompatible */
713 #ifdef HAVE_LCD_BITMAP
714 is_diacritic,
715 #endif
718 int plugin_load(const char* plugin, const void* parameter)
720 int rc, i;
721 struct plugin_header *hdr;
722 #ifdef SIMULATOR
723 void *pd;
724 #else /* !SIMULATOR */
725 int fd;
726 ssize_t readsize;
727 #if NUM_CORES > 1
728 unsigned my_core;
729 #endif
730 #endif /* !SIMULATOR */
732 #if LCD_DEPTH > 1
733 fb_data* old_backdrop;
734 #endif
736 if (pfn_tsr_exit != NULL) /* if we have a resident old plugin: */
738 if (pfn_tsr_exit(!strcmp(current_plugin, plugin)) == false )
740 /* not allowing another plugin to load */
741 return PLUGIN_OK;
743 pfn_tsr_exit = NULL;
744 plugin_loaded = false;
747 splash(0, ID2P(LANG_WAIT));
748 strcpy(current_plugin, plugin);
750 #ifdef SIMULATOR
751 hdr = sim_plugin_load((char *)plugin, &pd);
752 if (pd == NULL) {
753 splashf(HZ*2, str(LANG_PLUGIN_CANT_OPEN), plugin);
754 return -1;
756 if (hdr == NULL
757 || hdr->magic != PLUGIN_MAGIC
758 || hdr->target_id != TARGET_ID) {
759 sim_plugin_close(pd);
760 splash(HZ*2, str(LANG_PLUGIN_WRONG_MODEL));
761 return -1;
763 if (hdr->api_version > PLUGIN_API_VERSION
764 || hdr->api_version < PLUGIN_MIN_API_VERSION) {
765 sim_plugin_close(pd);
766 splash(HZ*2, str(LANG_PLUGIN_WRONG_VERSION));
767 return -1;
769 #else
770 fd = open(plugin, O_RDONLY);
771 if (fd < 0) {
772 splashf(HZ*2, str(LANG_PLUGIN_CANT_OPEN), plugin);
773 return fd;
775 #if NUM_CORES > 1
776 /* Make sure COP cache is flushed and invalidated before loading */
777 my_core = switch_core(CURRENT_CORE ^ 1);
778 cpucache_invalidate();
779 switch_core(my_core);
780 #endif
782 readsize = read(fd, pluginbuf, PLUGIN_BUFFER_SIZE);
783 close(fd);
785 if (readsize < 0) {
786 splashf(HZ*2, str(LANG_READ_FAILED), plugin);
787 return -1;
789 hdr = (struct plugin_header *)pluginbuf;
791 if ((unsigned)readsize <= sizeof(struct plugin_header)
792 || hdr->magic != PLUGIN_MAGIC
793 || hdr->target_id != TARGET_ID
794 || hdr->load_addr != pluginbuf
795 || hdr->end_addr > pluginbuf + PLUGIN_BUFFER_SIZE) {
796 splash(HZ*2, str(LANG_PLUGIN_WRONG_MODEL));
797 return -1;
799 if (hdr->api_version > PLUGIN_API_VERSION
800 || hdr->api_version < PLUGIN_MIN_API_VERSION) {
801 splash(HZ*2, str(LANG_PLUGIN_WRONG_VERSION));
802 return -1;
804 plugin_size = hdr->end_addr - pluginbuf;
806 /* zero out bss area only, above guards end of pluginbuf */
807 if (plugin_size > readsize)
808 memset(pluginbuf + readsize, 0, plugin_size - readsize);
809 #endif
811 *(hdr->api) = &rockbox_api;
812 plugin_loaded = true;
815 #if defined HAVE_LCD_BITMAP && LCD_DEPTH > 1
816 old_backdrop = lcd_get_backdrop();
817 #endif
818 lcd_clear_display();
819 lcd_update();
821 #ifdef HAVE_REMOTE_LCD
822 lcd_remote_clear_display();
823 lcd_remote_update();
824 #endif
826 FOR_NB_SCREENS(i)
827 viewportmanager_theme_enable(i, false, NULL);
829 cpucache_invalidate();
831 #ifdef HAVE_TOUCHSCREEN
832 touchscreen_set_mode(TOUCHSCREEN_BUTTON);
833 #endif
835 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
836 open_files = 0;
837 #endif
839 rc = hdr->entry_point(parameter);
841 /* Go back to the global setting in case the plugin changed it */
842 #ifdef HAVE_TOUCHSCREEN
843 touchscreen_set_mode(global_settings.touch_mode);
844 #endif
846 button_clear_queue();
848 #ifdef HAVE_LCD_BITMAP
849 lcd_setfont(FONT_UI);
850 #if LCD_DEPTH > 1
851 lcd_set_backdrop(old_backdrop);
852 #ifdef HAVE_LCD_COLOR
853 lcd_set_drawinfo(DRMODE_SOLID, global_settings.fg_color,
854 global_settings.bg_color);
855 #else
856 lcd_set_drawinfo(DRMODE_SOLID, LCD_DEFAULT_FG, LCD_DEFAULT_BG);
857 #endif
858 #else /* LCD_DEPTH == 1 */
859 lcd_set_drawmode(DRMODE_SOLID);
860 #endif /* LCD_DEPTH */
861 #endif /* HAVE_LCD_BITMAP */
864 #ifdef HAVE_REMOTE_LCD
865 #if LCD_REMOTE_DEPTH > 1
866 lcd_remote_set_drawinfo(DRMODE_SOLID, LCD_REMOTE_DEFAULT_FG,
867 LCD_REMOTE_DEFAULT_BG);
868 #else
869 lcd_remote_set_drawmode(DRMODE_SOLID);
870 #endif
871 #endif
873 lcd_clear_display();
874 #ifdef HAVE_LCD_REMOTE
875 lcd_remote_clear_display();
876 #endif
878 FOR_NB_SCREENS(i)
879 viewportmanager_theme_undo(i, false);
881 if (pfn_tsr_exit == NULL)
882 plugin_loaded = false;
884 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
885 if(open_files != 0 && !plugin_loaded)
887 int fd;
888 logf("Plugin '%s' leaks file handles", plugin);
890 static const char *lines[] =
891 { ID2P(LANG_PLUGIN_ERROR),
892 "#leak-file-handles" };
893 static const struct text_message message={ lines, 2 };
894 button_clear_queue(); /* Empty the keyboard buffer */
895 gui_syncyesno_run(&message, NULL, NULL);
897 for(fd=0; fd < MAX_OPEN_FILES; fd++)
898 if(open_files & (1<<fd))
899 close_wrapper(fd);
901 #endif
903 sim_plugin_close(pd);
905 if (rc == PLUGIN_ERROR)
906 splash(HZ*2, str(LANG_PLUGIN_ERROR));
908 return rc;
911 /* Returns a pointer to the portion of the plugin buffer that is not already
912 being used. If no plugin is loaded, returns the entire plugin buffer */
913 void* plugin_get_buffer(size_t *buffer_size)
915 int buffer_pos;
917 if (plugin_loaded)
919 if (plugin_size >= PLUGIN_BUFFER_SIZE)
920 return NULL;
922 *buffer_size = PLUGIN_BUFFER_SIZE-plugin_size;
923 buffer_pos = plugin_size;
925 else
927 *buffer_size = PLUGIN_BUFFER_SIZE;
928 buffer_pos = 0;
931 return &pluginbuf[buffer_pos];
934 /* Returns a pointer to the mp3 buffer.
935 Playback gets stopped, to avoid conflicts.
936 Talk buffer is stolen as well.
938 void* plugin_get_audio_buffer(size_t *buffer_size)
940 #if CONFIG_CODEC == SWCODEC
941 return audio_get_buffer(true, buffer_size);
942 #else
943 audio_stop();
944 talk_buffer_steal(); /* we use the mp3 buffer, need to tell */
945 *buffer_size = audiobufend - audiobuf;
946 return audiobuf;
947 #endif
950 #ifdef PLUGIN_USE_IRAM
951 /* Initializes plugin IRAM */
952 void plugin_iram_init(char *iramstart, char *iramcopy, size_t iram_size,
953 char *iedata, size_t iedata_size)
955 /* We need to stop audio playback in order to use codec IRAM */
956 audio_hard_stop();
957 memcpy(iramstart, iramcopy, iram_size);
958 memset(iedata, 0, iedata_size);
959 memset(iramcopy, 0, iram_size);
960 #if NUM_CORES > 1
961 /* writeback cleared iedata and iramcopy areas */
962 cpucache_flush();
963 #endif
965 #endif /* PLUGIN_USE_IRAM */
967 /* The plugin wants to stay resident after leaving its main function, e.g.
968 runs from timer or own thread. The callback is registered to later
969 instruct it to free its resources before a new plugin gets loaded. */
970 void plugin_tsr(bool (*exit_callback)(bool))
972 pfn_tsr_exit = exit_callback; /* remember the callback for later */
975 char *plugin_get_current_filename(void)
977 return current_plugin;
980 static int open_wrapper(const char* pathname, int flags, ...)
982 /* we don't have an 'open' function. it's a define. and we need
983 * the real file_open, hence PREFIX() doesn't work here */
984 int fd;
985 #ifdef SIMULATOR
986 if (flags & O_CREAT)
988 va_list ap;
989 va_start(ap, flags);
990 fd = sim_open(pathname, flags, va_arg(ap, unsigned int));
991 va_end(ap);
993 else
994 fd = sim_open(pathname, flags);
995 #else
996 fd = file_open(pathname,flags);
997 #endif
999 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
1000 if(fd >= 0)
1001 open_files |= 1<<fd;
1002 #endif
1003 return fd;
1006 #ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
1007 static int close_wrapper(int fd)
1009 if((~open_files) & (1<<fd))
1011 logf("double close from plugin");
1013 if(fd >= 0)
1014 open_files &= (~(1<<fd));
1016 return PREFIX(close)(fd);
1019 static int creat_wrapper(const char *pathname, mode_t mode)
1021 int fd = PREFIX(creat)(pathname, mode);
1023 if(fd >= 0)
1024 open_files |= (1<<fd);
1026 return fd;
1028 #endif /* HAVE_PLUGIN_CHECK_OPEN_CLOSE */