Nyaaori/rockbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
rockbox/apps/plugin.c
Michael Sevakis 7d1a47cf13 Rewrite filesystem code (WIP) 
This patch redoes the filesystem code from the FAT driver up to the
clipboard code in onplay.c.

Not every aspect of this is finished therefore it is still "WIP". I
don't wish to do too much at once (haha!). What is left to do is get
dircache back in the sim and find an implementation for the dircache
indicies in the tagcache and playlist code or do something else that
has the same benefit. Leaving these out for now does not make anything
unusable. All the basics are done.

Phone app code should probably get vetted (and app path handling
just plain rewritten as environment expansions); the SDL app and
Android run well.

Main things addressed:
1) Thread safety: There is none right now in the trunk code. Most of
what currently works is luck when multiple threads are involved or
multiple descriptors to the same file are open.

2) POSIX compliance: Many of the functions behave nothing like their
counterparts on a host system. This leads to inconsistent code or very
different behavior from native to hosted. One huge offender was
rename(). Going point by point would fill a book.

3) Actual running RAM usage: Many targets will use less RAM and less
stack space (some more RAM because I upped the number of cache buffers
for large memory). There's very little memory lying fallow in rarely-used
areas (see 'Key core changes' below). Also, all targets may open the same
number of directory streams whereas before those with less than 8MB RAM
were limited to 8, not 12 implying those targets will save slightly
less.

4) Performance: The test_disk plugin shows markedly improved performance,
particularly in the area of (uncached) directory scanning, due partly to
more optimal directory reading and to a better sector cache algorithm.
Uncached times tend to be better while there is a bit of a slowdown in
dircache due to it being a bit heavier of an implementation. It's not
noticeable by a human as far as I can say.

Key core changes:
1) Files and directories share core code and data structures.

2) The filesystem code knows which descriptors refer to same file.
This ensures that changes from one stream are appropriately reflected
in every open descriptor for that file (fileobj_mgr.c).

3) File and directory cache buffers are borrowed from the main sector
cache. This means that when they are not in use by a file, they are not
wasted, but used for the cache. Most of the time, only a few of them
are needed. It also means that adding more file and directory handles
is less expensive. All one must do in ensure a large enough cache to
borrow from.

4) Relative path components are supported and the namespace is unified.
It does not support full relative paths to an implied current directory;
what is does support is use of "." and "..". Adding the former would
not be very difficult. The namespace is unified in the sense that
volumes may be specified several times along with relative parts, e.g.:
"/<0>/foo/../../<1>/bar" :<=> "/<1>/bar".

5) Stack usage is down due to sharing of data, static allocation and
less duplication of strings on the stack. This requires more
serialization than I would like but since the number of threads is
limited to a low number, the tradoff in favor of the stack seems
reasonable.

6) Separates and heirarchicalizes (sic) the SIM and APP filesystem
code. SIM path and volume handling is just like the target. Some
aspects of the APP file code get more straightforward (e.g. no path
hashing is needed).

Dircache:
Deserves its own section. Dircache is new but pays homage to the old.
The old one was not compatible and so it, since it got redone, does
all the stuff it always should have done such as:

1) It may be update and used at any time during the build process.
No longer has one to wait for it to finish building to do basic file
management (create, remove, rename, etc.).

2) It does not need to be either fully scanned or completely disabled;
it can be incomplete (i.e. overfilled, missing paths), still be
of benefit and be correct.

3) Handles mounting and dismounting of individual volumes which means
a full rebuild is not needed just because you pop a new SD card in the
slot. Now, because it reuses its freed entry data, may rebuild only
that volume.

4) Much more fundamental to the file code. When it is built, it is
the keeper of the master file list whether enabled or not ("disabled"
is just a state of the cache). Its must always to ready to be started
and bind all streams opened prior to being enabled.

5) Maintains any short filenames in OEM format which means that it does
not need to be rebuilt when changing the default codepage.

Miscellaneous Compatibility:
1) Update any other code that would otherwise not work such as the
hotswap mounting code in various card drivers.

2) File management: Clipboard needed updating because of the behavioral
changes. Still needs a little more work on some finer points.

3) Remove now-obsolete functionality such as the mutex's "no preempt"
flag (which was only for the prior FAT driver).

4) struct dirinfo uses time_t rather than raw FAT directory entry
time fields. I plan to follow up on genericizing everything there
(i.e. no FAT attributes).

5) unicode.c needed some redoing so that the file code does not try
try to load codepages during a scan, which is actually a problem with
the current code. The default codepage, if any is required, is now
kept in RAM separarately (bufalloced) from codepages specified to
iso_decode() (which must not be bufalloced because the conversion
may be done by playback threads).

Brings with it some additional reusable core code:
1) Revised file functions: Reusable code that does things such as
safe path concatenation and parsing without buffer limitations or
data duplication. Variants that copy or alter the input path may be
based off these.

To do:
1) Put dircache functionality back in the sim. Treating it internally
as a different kind of file system seems the best approach at this
time.

2) Restore use of dircache indexes in the playlist and database or
something effectively the same. Since the cache doesn't have to be
complete in order to be used, not getting a hit on the cache doesn't
unambiguously say if the path exists or not.

Change-Id: Ia30f3082a136253e3a0eae0784e3091d138915c8
Reviewed-on: http://gerrit.rockbox.org/566
Reviewed-by: Michael Sevakis <jethead71@rockbox.org>
Tested: Michael Sevakis <jethead71@rockbox.org>
2014-08-30 03:48:23 +02:00

1045 lines
24 KiB
C
Raw Blame History

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2002 Björn Stenberg
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#define DIRFUNCTIONS_DEFINED
#define FILEFUNCTIONS_DEFINED
#include "plugin.h"
#include <ctype.h>
#include <string.h>
#include <stdlib.h>
#include "debug.h"
#include "i2c.h"
#include "lang.h"
#include "led.h"
#include "keyboard.h"
#include "backlight.h"
#include "sound_menu.h"
#include "mp3data.h"
#include "powermgmt.h"
#include "splash.h"
#include "logf.h"
#include "option_select.h"
#include "talk.h"
#include "version.h"
#include "storage.h"
#include "pcmbuf.h"
#include "errno.h"
#include "diacritic.h"
#include "pathfuncs.h"
#include "load_code.h"
#include "file.h"
#if CONFIG_CHARGING
#include "power.h"
#endif
#ifdef HAVE_LCD_BITMAP
#include "scrollbar.h"
#include "peakmeter.h"
#include "bmp.h"
#include "bidi.h"
#endif
#ifdef USB_ENABLE_HID
#include "usbstack/usb_hid.h"
#endif
#define WRAPPER(_x_) _x_ ## _wrapper
#if (CONFIG_PLATFORM & PLATFORM_HOSTED)
static unsigned char pluginbuf[PLUGIN_BUFFER_SIZE];
void sim_lcd_ex_init(unsigned long (*getpixel)(int, int));
void sim_lcd_ex_update_rect(int x, int y, int width, int height);
#else
extern unsigned char pluginbuf[];
#include "bitswap.h"
#endif
/* for actual plugins only, not for codecs */
static int plugin_size = 0;
static bool (*pfn_tsr_exit)(bool reenter) = NULL; /* TSR exit callback */
static char current_plugin[MAX_PATH];
/* NULL if no plugin is loaded, otherwise the handle that lc_open() returned */
static void *current_plugin_handle;
char *plugin_get_current_filename(void);
static void* plugin_get_audio_buffer(size_t *buffer_size);
static void plugin_release_audio_buffer(void);
static void plugin_tsr(bool (*exit_callback)(bool));
#ifdef HAVE_PLUGIN_CHECK_OPEN_CLOSE
/* File handle leak prophylaxis */
#include "bitarray.h"
#include "file_internal.h" /* for MAX_OPEN_FILES */
#define PCOC_WRAPPER(_x_) WRAPPER(_x_)
BITARRAY_TYPE_DECLARE(plugin_check_open_close_bitmap_t, open_files_bitmap,
MAX_OPEN_FILES)
static plugin_check_open_close_bitmap_t open_files_bitmap;
static void plugin_check_open_close__enter(void)
{
if (!current_plugin_handle)
open_files_bitmap_clear(&open_files_bitmap);
}
static void plugin_check_open_close__open(int fildes)
{
if (fildes >= 0)
open_files_bitmap_set_bit(&open_files_bitmap, fildes);
}
static void plugin_check_open_close__close(int fildes)
{
if (fildes < 0)
return;
if (!open_files_bitmap_test_bit(&open_files_bitmap, fildes))
{
logf("double close from plugin");
}
open_files_bitmap_clear_bit(&open_files_bitmap, fildes);
}
static int WRAPPER(open)(const char *path, int oflag, ...)
{
int fildes = FS_PREFIX(open)(path, oflag __OPEN_MODE_ARG);
plugin_check_open_close__open(fildes);
return fildes;
}
static int WRAPPER(creat)(const char *path, mode_t mode)
{
int fildes = FS_PREFIX(creat)(path __CREAT_MODE_ARG);
plugin_check_open_close__open(fildes);
return fildes;
(void)mode;
}
static int WRAPPER(close)(int fildes)
{
int rc = FS_PREFIX(close)(fildes);
if (rc >= 0)
plugin_check_open_close__close(fildes);
return rc;
}
static void plugin_check_open_close__exit(void)
{
if (current_plugin_handle)
return;
if (open_files_bitmap_is_clear(&open_files_bitmap))
return;
logf("Plugin '%s' leaks file handles", plugin);
static const char *lines[] =
{ ID2P(LANG_PLUGIN_ERROR), "#leak-file-handles" };
static const struct text_message message = { lines, 2 };
button_clear_queue(); /* Empty the keyboard buffer */
gui_syncyesno_run(&message, NULL, NULL);
FOR_EACH_BITARRAY_SET_BIT(&open_files_bitmap, fildes)
WRAPPER(close)(fildes);
}
#else /* !HAVE_PLUGIN_CHECK_OPEN_CLOSE */
#define PCOC_WRAPPER(_x_) FS_PREFIX(_x_)
#define plugin_check_open_close__enter()
#define plugin_check_open_close__exit()
#endif /* HAVE_PLUGIN_CHECK_OPEN_CLOSE */
static const struct plugin_api rockbox_api = {
/* lcd */
#ifdef HAVE_LCD_CONTRAST
lcd_set_contrast,
#endif
lcd_update,
lcd_clear_display,
lcd_getstringsize,
lcd_putsxy,
lcd_putsxyf,
lcd_puts,
lcd_putsf,
lcd_puts_scroll,
lcd_scroll_stop,
#ifdef HAVE_LCD_CHARCELLS
lcd_define_pattern,
lcd_get_locked_pattern,
lcd_unlock_pattern,
lcd_putc,
lcd_put_cursor,
lcd_remove_cursor,
lcd_icon,
lcd_double_height,
#else
&lcd_static_framebuffer[0][0],
lcd_set_viewport,
lcd_set_framebuffer,
lcd_bmp_part,
lcd_update_rect,
lcd_set_drawmode,
lcd_get_drawmode,
screen_helper_setfont,
lcd_drawpixel,
lcd_drawline,
lcd_hline,
lcd_vline,
lcd_drawrect,
lcd_fillrect,
lcd_mono_bitmap_part,
lcd_mono_bitmap,
#if LCD_DEPTH > 1
lcd_set_foreground,
lcd_get_foreground,
lcd_set_background,
lcd_get_background,
lcd_bitmap_part,
lcd_bitmap,
lcd_get_backdrop,
lcd_set_backdrop,
#endif
#if LCD_DEPTH >= 16
lcd_bitmap_transparent_part,
lcd_bitmap_transparent,
#if MEMORYSIZE > 2
lcd_blit_yuv,
#if defined(TOSHIBA_GIGABEAT_F) || defined(SANSA_E200) || defined(SANSA_C200) \
|| defined(IRIVER_H10) || defined(COWON_D2) || defined(PHILIPS_HDD1630) \
|| defined(SANSA_FUZE) || defined(SANSA_E200V2) || defined(SANSA_FUZEV2) \
|| defined(TOSHIBA_GIGABEAT_S) || defined(PHILIPS_SA9200)
lcd_yuv_set_options,
#endif
#endif /* MEMORYSIZE > 2 */
#elif (LCD_DEPTH < 4) && (CONFIG_PLATFORM & PLATFORM_NATIVE)
lcd_blit_mono,
lcd_blit_grey_phase,
#endif /* LCD_DEPTH */
#if defined(HAVE_LCD_MODES) && (HAVE_LCD_MODES & LCD_MODE_PAL256)
lcd_blit_pal256,
lcd_pal256_update_pal,
#endif
#ifdef HAVE_LCD_INVERT
lcd_set_invert_display,
#endif /* HAVE_LCD_INVERT */
#if defined(HAVE_LCD_MODES)
lcd_set_mode,
#endif
#if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
&button_queue,
#endif
bidi_l2v,
#ifdef HAVE_LCD_BITMAP
is_diacritic,
#endif
font_get_bits,
font_load,
font_unload,
font_get,
font_getstringsize,
font_get_width,
screen_clear_area,
gui_scrollbar_draw,
#endif /* HAVE_LCD_BITMAP */
get_codepage_name,
backlight_on,
backlight_off,
backlight_set_timeout,
#ifdef HAVE_BACKLIGHT_BRIGHTNESS
backlight_set_brightness,
#endif /* HAVE_BACKLIGHT_BRIGHTNESS */
#if CONFIG_CHARGING
backlight_set_timeout_plugged,
#endif
is_backlight_on,
splash,
splashf,
#ifdef HAVE_REMOTE_LCD
/* remote lcd */
lcd_remote_set_contrast,
lcd_remote_clear_display,
lcd_remote_puts,
lcd_remote_puts_scroll,
lcd_remote_scroll_stop,
lcd_remote_set_drawmode,
lcd_remote_get_drawmode,
lcd_remote_setfont,
lcd_remote_getstringsize,
lcd_remote_drawpixel,
lcd_remote_drawline,
lcd_remote_hline,
lcd_remote_vline,
lcd_remote_drawrect,
lcd_remote_fillrect,
lcd_remote_mono_bitmap_part,
lcd_remote_mono_bitmap,
lcd_remote_putsxy,
&lcd_remote_static_framebuffer[0][0],
lcd_remote_update,
lcd_remote_update_rect,
remote_backlight_on,
remote_backlight_off,
remote_backlight_set_timeout,
#if CONFIG_CHARGING
remote_backlight_set_timeout_plugged,
#endif
#endif /* HAVE_REMOTE_LCD */
#if NB_SCREENS == 2
{&screens[SCREEN_MAIN], &screens[SCREEN_REMOTE]},
#else
{&screens[SCREEN_MAIN]},
#endif
#if defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1)
lcd_remote_set_foreground,
lcd_remote_get_foreground,
lcd_remote_set_background,
lcd_remote_get_background,
lcd_remote_bitmap_part,
lcd_remote_bitmap,
#endif
viewport_set_defaults,
#ifdef HAVE_LCD_BITMAP
viewportmanager_theme_enable,
viewportmanager_theme_undo,
viewport_set_fullscreen,
#endif
/* list */
gui_synclist_init,
gui_synclist_set_nb_items,
gui_synclist_set_icon_callback,
gui_synclist_get_nb_items,
gui_synclist_get_sel_pos,
gui_synclist_draw,
gui_synclist_select_item,
gui_synclist_add_item,
gui_synclist_del_item,
gui_synclist_limit_scroll,
gui_synclist_do_button,
gui_synclist_set_title,
gui_syncyesno_run,
simplelist_info_init,
simplelist_show_list,
/* button */
button_get,
button_get_w_tmo,
button_status,
#ifdef HAVE_BUTTON_DATA
button_get_data,
button_status_wdata,
#endif
button_clear_queue,
button_queue_count,
#ifdef HAS_BUTTON_HOLD
button_hold,
#endif
#ifdef HAVE_TOUCHSCREEN
touchscreen_set_mode,
touchscreen_get_mode,
#endif
#ifdef HAVE_BUTTON_LIGHT
buttonlight_set_timeout,
buttonlight_off,
buttonlight_on,
#ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
buttonlight_set_brightness,
#endif /* HAVE_BUTTONLIGHT_BRIGHTNESS */
#endif /* HAVE_BUTTON_LIGHT */
/* file */
open_utf8,
PCOC_WRAPPER(open),
PCOC_WRAPPER(creat),
PCOC_WRAPPER(close),
FS_PREFIX(read),
FS_PREFIX(lseek),
FS_PREFIX(write),
FS_PREFIX(remove),
FS_PREFIX(rename),
FS_PREFIX(ftruncate),
FS_PREFIX(filesize),
fdprintf,
read_line,
settings_parseline,
storage_sleep,
storage_spin,
storage_spindown,
#if USING_STORAGE_CALLBACK
register_storage_idle_func,
unregister_storage_idle_func,
#endif /* USING_STORAGE_CALLBACK */
reload_directory,
create_numbered_filename,
FS_PREFIX(file_exists),
strip_extension,
crc_32,
filetype_get_attr,
/* dir */
FS_PREFIX(opendir),
FS_PREFIX(closedir),
FS_PREFIX(readdir),
FS_PREFIX(mkdir),
FS_PREFIX(rmdir),
FS_PREFIX(dir_exists),
dir_get_info,
/* browsing */
browse_context_init,
rockbox_browse,
/* kernel/ system */
#if defined(CPU_ARM) && CONFIG_PLATFORM & PLATFORM_NATIVE
__div0,
#endif
sleep,
yield,
&current_tick,
default_event_handler,
default_event_handler_ex,
create_thread,
thread_self,
thread_exit,
thread_wait,
#if (CONFIG_CODEC == SWCODEC)
thread_thaw,
#ifdef HAVE_PRIORITY_SCHEDULING
thread_set_priority,
#endif
mutex_init,
mutex_lock,
mutex_unlock,
#endif
reset_poweroff_timer,
#if (CONFIG_PLATFORM & PLATFORM_NATIVE)
system_memory_guard,
&cpu_frequency,
#ifdef HAVE_ADJUSTABLE_CPU_FREQ
#ifdef CPU_BOOST_LOGGING
cpu_boost_,
#else
cpu_boost,
#endif
#endif /* HAVE_ADJUSTABLE_CPU_FREQ */
#endif /* PLATFORM_NATIVE */
#ifdef HAVE_SCHEDULER_BOOSTCTRL
trigger_cpu_boost,
cancel_cpu_boost,
#endif
commit_dcache,
commit_discard_dcache,
commit_discard_idcache,
lc_open,
lc_open_from_mem,
lc_get_header,
lc_close,
timer_register,
timer_unregister,
timer_set_period,
queue_init,
queue_delete,
queue_post,
queue_wait_w_tmo,
#if CONFIG_CODEC == SWCODEC
queue_enable_queue_send,
queue_empty,
queue_wait,
queue_send,
queue_reply,
#endif
usb_acknowledge,
#ifdef USB_ENABLE_HID
usb_hid_send,
#endif
#ifdef RB_PROFILE
profile_thread,
profstop,
__cyg_profile_func_enter,
__cyg_profile_func_exit,
#endif
add_event,
remove_event,
send_event,
#if (CONFIG_PLATFORM & PLATFORM_HOSTED)
/* special simulator hooks */
#if defined(HAVE_LCD_BITMAP) && LCD_DEPTH < 8
sim_lcd_ex_init,
sim_lcd_ex_update_rect,
#endif
#endif
/* strings and memory */
snprintf,
vsnprintf,
strcpy,
strlcpy,
strlen,
strrchr,
strcmp,
strncmp,
strcasecmp,
strncasecmp,
memset,
memcpy,
memmove,
#if (CONFIG_PLATFORM & PLATFORM_NATIVE)
_ctype_,
#endif
atoi,
strchr,
strcat,
strlcat,
memchr,
memcmp,
strcasestr,
strtok_r,
/* unicode stuff */
utf8decode,
iso_decode,
utf16LEdecode,
utf16BEdecode,
utf8encode,
utf8length,
utf8seek,
/* the buflib memory management library */
buflib_init,
buflib_available,
buflib_alloc,
buflib_alloc_ex,
buflib_alloc_maximum,
buflib_buffer_in,
buflib_buffer_out,
buflib_free,
buflib_shrink,
buflib_get_data,
buflib_get_name,
/* sound */
sound_set,
sound_default,
sound_min,
sound_max,
sound_unit,
sound_val2phys,
#ifdef AUDIOHW_HAVE_EQ
sound_enum_hw_eq_band_setting,
#endif
#if (CONFIG_PLATFORM & PLATFORM_NATIVE)
mp3_play_data,
mp3_play_pause,
mp3_play_stop,
mp3_is_playing,
#if CONFIG_CODEC != SWCODEC
bitswap,
#endif
#endif
#if CONFIG_CODEC == SWCODEC
&audio_master_sampr_list[0],
&hw_freq_sampr[0],
pcm_apply_settings,
pcm_play_data,
pcm_play_stop,
pcm_set_frequency,
pcm_is_playing,
pcm_is_paused,
pcm_play_pause,
pcm_get_bytes_waiting,
pcm_calculate_peaks,
pcm_get_peak_buffer,
pcm_play_lock,
pcm_play_unlock,
beep_play,
#ifdef HAVE_RECORDING
&rec_freq_sampr[0],
pcm_init_recording,
pcm_close_recording,
pcm_record_data,
pcm_stop_recording,
pcm_calculate_rec_peaks,
audio_set_recording_gain,
#endif /* HAVE_RECORDING */
#if INPUT_SRC_CAPS != 0
audio_set_output_source,
audio_set_input_source,
#endif
dsp_set_crossfeed_type ,
dsp_eq_enable,
dsp_dither_enable,
#ifdef HAVE_PITCHCONTROL
dsp_set_timestretch,
#endif
dsp_configure,
dsp_get_config,
dsp_process,
mixer_channel_status,
mixer_channel_get_buffer,
mixer_channel_calculate_peaks,
mixer_channel_play_data,
mixer_channel_play_pause,
mixer_channel_stop,
mixer_channel_set_amplitude,
mixer_channel_get_bytes_waiting,
mixer_channel_set_buffer_hook,
mixer_set_frequency,
mixer_get_frequency,
system_sound_play,
keyclick_click,
#endif /* CONFIG_CODEC == SWCODEC */
/* playback control */
playlist_amount,
playlist_resume,
playlist_resume_track,
playlist_start,
playlist_add,
playlist_sync,
playlist_remove_all_tracks,
playlist_create,
playlist_insert_track,
playlist_insert_directory,
playlist_shuffle,
audio_play,
audio_stop,
audio_pause,
audio_resume,
audio_next,
audio_prev,
audio_ff_rewind,
audio_next_track,
audio_status,
audio_current_track,
audio_flush_and_reload_tracks,
audio_get_file_pos,
#if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
mpeg_get_last_header,
#endif
#if ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F) || \
(CONFIG_CODEC == SWCODEC)) && defined (HAVE_PITCHCONTROL)
sound_set_pitch,
#endif
#if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
/* MAS communication */
mas_readmem,
mas_writemem,
mas_readreg,
mas_writereg,
#if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
mas_codec_writereg,
mas_codec_readreg,
i2c_begin,
i2c_end,
i2c_write,
#endif
#endif /* !SIMULATOR && CONFIG_CODEC != SWCODEC */
/* menu */
do_menu,
/* statusbars */
&statusbars,
gui_syncstatusbar_draw,
/* options */
get_settings_list,
find_setting,
option_screen,
set_option,
set_bool_options,
set_int,
set_bool,
#ifdef HAVE_LCD_COLOR
set_color,
#endif
/* action handling */
get_custom_action,
get_action,
#ifdef HAVE_TOUCHSCREEN
action_get_touchscreen_press,
#endif
action_userabort,
/* power */
battery_level,
battery_level_safe,
battery_time,
battery_voltage,
#if CONFIG_CHARGING
charger_inserted,
# if CONFIG_CHARGING >= CHARGING_MONITOR
charging_state,
# endif
#endif
#ifdef HAVE_USB_POWER
usb_powered,
#endif
/* misc */
#if (CONFIG_PLATFORM & PLATFORM_NATIVE)
__errno,
#endif
srand,
rand,
(void *)qsort,
kbd_input,
get_time,
set_time,
gmtime_r,
#if CONFIG_RTC
mktime,
#endif
plugin_get_buffer,
plugin_get_audio_buffer, /* defined in plugin.c */
plugin_release_audio_buffer, /* defined in plugin.c */
plugin_tsr, /* defined in plugin.c */
plugin_get_current_filename,
#if defined(DEBUG) || defined(SIMULATOR)
debugf,
#endif
#ifdef ROCKBOX_HAS_LOGF
_logf,
#endif
&global_settings,
&global_status,
talk_disable,
#if CONFIG_CODEC == SWCODEC
codec_thread_do_callback,
codec_load_file,
codec_run_proc,
codec_close,
get_codec_filename,
find_array_ptr,
remove_array_ptr,
round_value_to_list32,
#endif /* CONFIG_CODEC == SWCODEC */
get_metadata,
mp3info,
count_mp3_frames,
create_xing_header,
find_next_frame,
#if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
peak_meter_scale_value,
peak_meter_set_use_dbfs,
peak_meter_get_use_dbfs,
#endif
#ifdef HAVE_LCD_BITMAP
read_bmp_file,
read_bmp_fd,
#ifdef HAVE_JPEG
read_jpeg_file,
read_jpeg_fd,
#endif
screen_dump_set_hook,
#endif
show_logo,
tree_get_context,
tree_get_entries,
tree_get_entry_at,
set_current_file,
set_dirfilter,
#ifdef HAVE_WHEEL_POSITION
wheel_status,
wheel_send_events,
#endif
#ifdef IRIVER_H100_SERIES
/* Routines for the iriver_flash -plugin. */
detect_original_firmware,
detect_flashed_ramimage,
detect_flashed_romimage,
#endif
led,
#if (CONFIG_CODEC == SWCODEC)
bufopen,
bufalloc,
bufclose,
bufseek,
bufadvance,
bufread,
bufgetdata,
bufgettail,
bufcuttail,
buf_handle_offset,
buf_set_base_handle,
buf_used,
#endif
#ifdef HAVE_TAGCACHE
tagcache_search,
tagcache_search_set_uniqbuf,
tagcache_search_add_filter,
tagcache_get_next,
tagcache_retrieve,
tagcache_search_finish,
tagcache_get_numeric,
#if defined(HAVE_TC_RAMCACHE) && defined(HAVE_DIRCACHE)
tagcache_fill_tags,
#endif
#endif
#ifdef HAVE_ALBUMART
search_albumart_files,
#endif
#ifdef HAVE_SEMAPHORE_OBJECTS
semaphore_init,
semaphore_wait,
semaphore_release,
#endif
rbversion,
root_menu_get_options,
root_menu_set_default,
root_menu_write_to_cfg,
root_menu_load_from_cfg,
settings_save,
/* new stuff at the end, sort into place next time
the API gets incompatible */
};
static int plugin_buffer_handle;
int plugin_load(const char* plugin, const void* parameter)
{
struct plugin_header *p_hdr;
struct lc_header *hdr;
if (current_plugin_handle && pfn_tsr_exit)
{ /* if we have a resident old plugin and a callback */
if (pfn_tsr_exit(!strcmp(current_plugin, plugin)) == false )
{
/* not allowing another plugin to load */
return PLUGIN_OK;
}
lc_close(current_plugin_handle);
current_plugin_handle = pfn_tsr_exit = NULL;
if (plugin_buffer_handle > 0)
plugin_buffer_handle = core_free(plugin_buffer_handle);
}
splash(0, ID2P(LANG_WAIT));
strcpy(current_plugin, plugin);
current_plugin_handle = lc_open(plugin, pluginbuf, PLUGIN_BUFFER_SIZE);
if (current_plugin_handle == NULL) {
splashf(HZ*2, str(LANG_PLUGIN_CANT_OPEN), plugin);
return -1;
}
p_hdr = lc_get_header(current_plugin_handle);
hdr = p_hdr ? &p_hdr->lc_hdr : NULL;
if (hdr == NULL
|| hdr->magic != PLUGIN_MAGIC
|| hdr->target_id != TARGET_ID
#if (CONFIG_PLATFORM & PLATFORM_NATIVE)
|| hdr->load_addr != pluginbuf
|| hdr->end_addr > pluginbuf + PLUGIN_BUFFER_SIZE
#endif
)
{
lc_close(current_plugin_handle);
splash(HZ*2, str(LANG_PLUGIN_WRONG_MODEL));
return -1;
}
if (hdr->api_version > PLUGIN_API_VERSION
|| hdr->api_version < PLUGIN_MIN_API_VERSION)
{
lc_close(current_plugin_handle);
splash(HZ*2, str(LANG_PLUGIN_WRONG_VERSION));
return -1;
}
#if (CONFIG_PLATFORM & PLATFORM_NATIVE)
plugin_size = hdr->end_addr - pluginbuf;
#else
plugin_size = 0;
#endif
*(p_hdr->api) = &rockbox_api;
lcd_clear_display();
lcd_update();
#ifdef HAVE_REMOTE_LCD
lcd_remote_clear_display();
lcd_remote_update();
#endif
push_current_activity(ACTIVITY_PLUGIN);
/* some plugins assume the entry cache doesn't move and save pointers to it
* they should be fixed properly instead of this lock */
tree_lock_cache(tree_get_context());
FOR_NB_SCREENS(i)
viewportmanager_theme_enable(i, false, NULL);
#ifdef HAVE_TOUCHSCREEN
touchscreen_set_mode(TOUCHSCREEN_BUTTON);
#endif
/* allow voice to back off if the plugin needs lots of memory */
talk_buffer_set_policy(TALK_BUFFER_LOOSE);
plugin_check_open_close__enter();
int rc = p_hdr->entry_point(parameter);
tree_unlock_cache(tree_get_context());
pop_current_activity();
if (!pfn_tsr_exit)
{ /* close handle if plugin is no tsr one */
lc_close(current_plugin_handle);
current_plugin_handle = NULL;
if (plugin_buffer_handle > 0)
plugin_buffer_handle = core_free(plugin_buffer_handle);
}
talk_buffer_set_policy(TALK_BUFFER_DEFAULT);
/* Go back to the global setting in case the plugin changed it */
#ifdef HAVE_TOUCHSCREEN
touchscreen_set_mode(global_settings.touch_mode);
#endif
#ifdef HAVE_LCD_BITMAP
screen_helper_setfont(FONT_UI);
#if LCD_DEPTH > 1
#ifdef HAVE_LCD_COLOR
lcd_set_drawinfo(DRMODE_SOLID, global_settings.fg_color,
global_settings.bg_color);
#else
lcd_set_drawinfo(DRMODE_SOLID, LCD_DEFAULT_FG, LCD_DEFAULT_BG);
#endif
#else /* LCD_DEPTH == 1 */
lcd_set_drawmode(DRMODE_SOLID);
#endif /* LCD_DEPTH */
#endif /* HAVE_LCD_BITMAP */
#ifdef HAVE_REMOTE_LCD
#if LCD_REMOTE_DEPTH > 1
lcd_remote_set_drawinfo(DRMODE_SOLID, LCD_REMOTE_DEFAULT_FG,
LCD_REMOTE_DEFAULT_BG);
#else
lcd_remote_set_drawmode(DRMODE_SOLID);
#endif
#endif
lcd_clear_display();
#ifdef HAVE_REMOTE_LCD
lcd_remote_clear_display();
#endif
FOR_NB_SCREENS(i)
viewportmanager_theme_undo(i, true);
plugin_check_open_close__exit();
if (rc == PLUGIN_ERROR)
splash(HZ*2, str(LANG_PLUGIN_ERROR));
return rc;
}
/* Returns a pointer to the portion of the plugin buffer that is not already
being used. If no plugin is loaded, returns the entire plugin buffer */
void* plugin_get_buffer(size_t *buffer_size)
{
int buffer_pos;
if (current_plugin_handle)
{
if (plugin_size >= PLUGIN_BUFFER_SIZE)
return NULL;
*buffer_size = PLUGIN_BUFFER_SIZE-plugin_size;
buffer_pos = plugin_size;
}
else
{
*buffer_size = PLUGIN_BUFFER_SIZE;
buffer_pos = 0;
}
return &pluginbuf[buffer_pos];
}
/* Returns a pointer to the mp3 buffer.
Playback gets stopped, to avoid conflicts.
Talk buffer is stolen as well.
*/
static void* plugin_get_audio_buffer(size_t *buffer_size)
{
/* dummy ops with no callbacks, needed because by
* default buflib buffers can be moved around which must be avoided */
static struct buflib_callbacks dummy_ops;
plugin_buffer_handle = core_alloc_maximum("plugin audio buf", buffer_size,
&dummy_ops);
return core_get_data(plugin_buffer_handle);
}
static void plugin_release_audio_buffer(void)
{
if (plugin_buffer_handle > 0)
plugin_buffer_handle = core_free(plugin_buffer_handle);
}
/* The plugin wants to stay resident after leaving its main function, e.g.
runs from timer or own thread. The callback is registered to later
instruct it to free its resources before a new plugin gets loaded. */
static void plugin_tsr(bool (*exit_callback)(bool))
{
pfn_tsr_exit = exit_callback; /* remember the callback for later */
}
char *plugin_get_current_filename(void)
{
return current_plugin;
}
Reference in a new issue View git blame Copy permalink