apps/plugin.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 Björn Stenberg
  11  *
  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.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21 #ifndef _PLUGIN_H_
  22 #define _PLUGIN_H_
  23
  24 /* instruct simulator code to not redefine any symbols when compiling plugins.
  25    (the PLUGIN macro is defined in apps/plugins/Makefile) */
  26 #ifdef PLUGIN
  27 #define NO_REDEFINES_PLEASE
  28 #endif
  29
  30 #ifndef MEM
  31 #define MEM 2
  32 #endif
  33
  34 #include <stdbool.h>
  35 #include <inttypes.h>
  36 #include <sys/types.h>
  37 #include <stdarg.h>
  38 #include <stdio.h>
  39 #include <stdlib.h>
  40 #include <string.h>
  41 #include "string-extra.h"
  42 #include "gcc_extensions.h"
  43
  44 char* strncpy(char *, const char *, size_t);
  45 void* plugin_get_buffer(size_t *buffer_size);
  46
  47 #ifndef __PCTOOL__
  48 #include "config.h"
  49 #include "system.h"
  50 #include "dir.h"
  51 #include "general.h"
  52 #include "kernel.h"
  53 #include "thread.h"
  54 #include "button.h"
  55 #include "action.h"
  56 #include "load_code.h"
  57 #include "usb.h"
  58 #include "font.h"
  59 #include "lcd.h"
  60 #include "metadata.h"
  61 #include "sound.h"
  62 #include "mpeg.h"
  63 #include "audio.h"
  64 #include "mp3_playback.h"
  65 #include "talk.h"
  66 #ifdef RB_PROFILE
  67 #include "profile.h"
  68 #endif
  69 #include "misc.h"
  70 #include "filefuncs.h"
  71 #if (CONFIG_CODEC == SWCODEC)
  72 #include "dsp.h"
  73 #include "codecs.h"
  74 #include "playback.h"
  75 #include "codec_thread.h"
  76 #ifdef HAVE_RECORDING
  77 #include "recording.h"
  78 #endif
  79 #else
  80 #include "mas35xx.h"
  81 #endif /* CONFIG_CODEC == SWCODEC */
  82 #include "settings.h"
  83 #include "timer.h"
  84 #include "playlist.h"
  85 #ifdef HAVE_LCD_BITMAP
  86 #include "screendump.h"
  87 #include "scrollbar.h"
  88 #include "jpeg_load.h"
  89 #include "../recorder/bmp.h"
  90 #endif
  91 #include "statusbar.h"
  92 #include "menu.h"
  93 #include "rbunicode.h"
  94 #include "list.h"
  95 #include "tree.h"
  96 #include "color_picker.h"
  97 #include "buffering.h"
  98 #include "tagcache.h"
  99 #include "viewport.h"
 100 #include "ata_idle_notify.h"
 101 #include "settings_list.h"
 102 #include "timefuncs.h"
 103 #include "crc32.h"
 104
 105 #ifdef HAVE_ALBUMART
 106 #include "albumart.h"
 107 #endif
 108
 109 #ifdef HAVE_REMOTE_LCD
 110 #include "lcd-remote.h"
 111 #endif
 112
 113 #include "yesno.h"
 114
 115 #include "filetypes.h"
 116
 117 #ifdef USB_ENABLE_HID
 118 #include "usbstack/usb_hid_usage_tables.h"
 119 #endif
 120
 121
 122 /* on some platforms strcmp() seems to be a tricky define which
 123  * breaks if we write down strcmp's prototype */
 124 #undef strcmp
 125
 126 #ifdef PLUGIN
 127
 128 #if defined(DEBUG) || defined(SIMULATOR)
 129 #undef DEBUGF
 130 #define DEBUGF  rb->debugf
 131 #undef LDEBUGF
 132 #define LDEBUGF rb->debugf
 133 #else
 134 #undef DEBUGF
 135 #define DEBUGF(...) do { } while(0)
 136 #undef LDEBUGF
 137 #define LDEBUGF(...) do { } while(0)
 138 #endif
 139
 140 #ifdef ROCKBOX_HAS_LOGF
 141 #undef LOGF
 142 #define LOGF rb->logf
 143 #else
 144 #define LOGF(...)
 145 #endif
 146
 147 #endif
 148
 149 #define PLUGIN_MAGIC 0x526F634B /* RocK */
 150
 151 /* increase this every time the api struct changes */
 152 #define PLUGIN_API_VERSION 196
 153
 154 /* update this to latest version if a change to the api struct breaks
 155    backwards compatibility (and please take the opportunity to sort in any
 156    new function which are "waiting" at the end of the function table) */
 157 #define PLUGIN_MIN_API_VERSION 196
 158
 159 /* plugin return codes */
 160 /* internal returns start at 0x100 to make exit(1..255) work */
 161 #define INTERNAL_PLUGIN_RETVAL_START 0x100
 162 enum plugin_status {
 163     PLUGIN_OK = 0, /* PLUGIN_OK == EXIT_SUCCESS */
 164     /* 1...255 reserved for exit() */
 165     PLUGIN_USB_CONNECTED = INTERNAL_PLUGIN_RETVAL_START,
 166     PLUGIN_POWEROFF,
 167     PLUGIN_GOTO_WPS,
 168     PLUGIN_ERROR = -1,
 169 };
 170
 171 /* NOTE: To support backwards compatibility, only add new functions at
 172          the end of the structure.  Every time you add a new function,
 173          remember to increase PLUGIN_API_VERSION.  If you make changes to the
 174          existing APIs then also update PLUGIN_MIN_API_VERSION to current
 175          version
 176  */
 177 struct plugin_api {
 178
 179     /* lcd */
 180
 181 #ifdef HAVE_LCD_CONTRAST
 182     void (*lcd_set_contrast)(int x);
 183 #endif
 184     void (*lcd_update)(void);
 185     void (*lcd_clear_display)(void);
 186     int  (*lcd_getstringsize)(const unsigned char *str, int *w, int *h);
 187     void (*lcd_putsxy)(int x, int y, const unsigned char *string);
 188     void (*lcd_putsxyf)(int x, int y, const unsigned char *fmt, ...);
 189     void (*lcd_puts)(int x, int y, const unsigned char *string);
 190     void (*lcd_putsf)(int x, int y, const unsigned char *fmt, ...);
 191     void (*lcd_puts_scroll)(int x, int y, const unsigned char* string);
 192     void (*lcd_stop_scroll)(void);
 193 #ifdef HAVE_LCD_CHARCELLS
 194     void (*lcd_define_pattern)(unsigned long ucs, const char *pattern);
 195     unsigned long (*lcd_get_locked_pattern)(void);
 196     void (*lcd_unlock_pattern)(unsigned long ucs);
 197     void (*lcd_putc)(int x, int y, unsigned long ucs);
 198     void (*lcd_put_cursor)(int x, int y, unsigned long ucs);
 199     void (*lcd_remove_cursor)(void);
 200     void (*lcd_icon)(int icon, bool enable);
 201     void (*lcd_double_height)(bool on);
 202 #else /* HAVE_LCD_BITMAP */
 203     fb_data* lcd_framebuffer;
 204     void (*lcd_update_rect)(int x, int y, int width, int height);
 205     void (*lcd_set_drawmode)(int mode);
 206     int  (*lcd_get_drawmode)(void);
 207     void (*lcd_setfont)(int font);
 208     void (*lcd_drawpixel)(int x, int y);
 209     void (*lcd_drawline)(int x1, int y1, int x2, int y2);
 210     void (*lcd_hline)(int x1, int x2, int y);
 211     void (*lcd_vline)(int x, int y1, int y2);
 212     void (*lcd_drawrect)(int x, int y, int width, int height);
 213     void (*lcd_fillrect)(int x, int y, int width, int height);
 214     void (*lcd_mono_bitmap_part)(const unsigned char *src, int src_x, int src_y,
 215                                  int stride, int x, int y, int width, int height);
 216     void (*lcd_mono_bitmap)(const unsigned char *src, int x, int y,
 217                             int width, int height);
 218 #if LCD_DEPTH > 1
 219     void     (*lcd_set_foreground)(unsigned foreground);
 220     unsigned (*lcd_get_foreground)(void);
 221     void     (*lcd_set_background)(unsigned foreground);
 222     unsigned (*lcd_get_background)(void);
 223     void (*lcd_bitmap_part)(const fb_data *src, int src_x, int src_y,
 224                             int stride, int x, int y, int width, int height);
 225     void (*lcd_bitmap)(const fb_data *src, int x, int y, int width,
 226                        int height);
 227     fb_data* (*lcd_get_backdrop)(void);
 228     void (*lcd_set_backdrop)(fb_data* backdrop);
 229 #endif
 230 #if LCD_DEPTH == 16
 231     void (*lcd_bitmap_transparent_part)(const fb_data *src,
 232             int src_x, int src_y, int stride,
 233             int x, int y, int width, int height);
 234     void (*lcd_bitmap_transparent)(const fb_data *src, int x, int y,
 235             int width, int height);
 236 #if MEMORYSIZE > 2
 237     void (*lcd_blit_yuv)(unsigned char * const src[3],
 238                          int src_x, int src_y, int stride,
 239                          int x, int y, int width, int height);
 240 #if defined(TOSHIBA_GIGABEAT_F) || defined(SANSA_E200) || defined(SANSA_C200) \
 241     || defined(IRIVER_H10) || defined(COWON_D2) || defined(PHILIPS_HDD1630) \
 242     || defined(SANSA_FUZE) || defined(SANSA_E200V2) || defined(SANSA_FUZEV2) \
 243     || defined(TOSHIBA_GIGABEAT_S)
 244     void (*lcd_yuv_set_options)(unsigned options);
 245 #endif
 246 #endif /* MEMORYSIZE > 2 */
 247 #elif (LCD_DEPTH < 4) && (CONFIG_PLATFORM & PLATFORM_NATIVE)
 248     void (*lcd_blit_mono)(const unsigned char *data, int x, int by, int width,
 249                           int bheight, int stride);
 250     void (*lcd_blit_grey_phase)(unsigned char *values, unsigned char *phases,
 251                                 int bx, int by, int bwidth, int bheight,
 252                                 int stride);
 253 #endif /* LCD_DEPTH */
 254 #if defined(HAVE_LCD_MODES) && (HAVE_LCD_MODES & LCD_MODE_PAL256)
 255     void (*lcd_blit_pal256)(unsigned char *src, int src_x, int src_y, int x, int y,
 256                             int width, int height);
 257     void (*lcd_pal256_update_pal)(fb_data *palette);
 258 #endif
 259     void (*lcd_puts_style)(int x, int y, const unsigned char *str, int style);
 260     void (*lcd_puts_scroll_style)(int x, int y, const unsigned char* string,
 261                                   int style);
 262 #ifdef HAVE_LCD_INVERT
 263     void (*lcd_set_invert_display)(bool yesno);
 264 #endif /* HAVE_LCD_INVERT */
 265 #if defined(HAVE_LCD_MODES)
 266     void (*lcd_set_mode)(int mode);
 267 #endif
 268
 269 #if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
 270     struct event_queue *button_queue;
 271 #endif
 272     unsigned short *(*bidi_l2v)( const unsigned char *str, int orientation );
 273 #ifdef HAVE_LCD_BITMAP
 274     bool (*is_diacritic)(const unsigned short char_code, bool *is_rtl);
 275 #endif
 276     const unsigned char *(*font_get_bits)( struct font *pf, unsigned short char_code );
 277     int (*font_load)(struct font*, const char *path);
 278     struct font* (*font_get)(int font);
 279     int  (*font_getstringsize)(const unsigned char *str, int *w, int *h,
 280                                int fontnumber);
 281     int (*font_get_width)(struct font* pf, unsigned short char_code);
 282     void (*screen_clear_area)(struct screen * display, int xstart, int ystart,
 283                               int width, int height);
 284     void (*gui_scrollbar_draw)(struct screen * screen, int x, int y,
 285                                int width, int height, int items,
 286                                int min_shown, int max_shown,
 287                                unsigned flags);
 288 #endif  /* HAVE_LCD_BITMAP */
 289     const char* (*get_codepage_name)(int cp);
 290
 291     /* backlight */
 292     /* The backlight_* functions must be present in the API regardless whether
 293      * HAVE_BACKLIGHT is defined or not. The reason is that the stock Ondio has
 294      * no backlight but can be modded to have backlight (it's prepared on the
 295      * PCB). This makes backlight an all-target feature API wise, and keeps API
 296      * compatible between stock and modded Ondio.
 297      * For OLED targets like the Sansa Clip, the backlight_* functions control
 298      * the display enable, which has essentially the same effect. */
 299     void (*backlight_on)(void);
 300     void (*backlight_off)(void);
 301     void (*backlight_set_timeout)(int index);
 302 #ifdef HAVE_BACKLIGHT_BRIGHTNESS
 303     void (*backlight_set_brightness)(int val);
 304 #endif /* HAVE_BACKLIGHT_BRIGHTNESS */
 305
 306 #if CONFIG_CHARGING
 307     void (*backlight_set_timeout_plugged)(int index);
 308 #endif
 309     bool (*is_backlight_on)(bool ignore_always_off);
 310     void (*splash)(int ticks, const char *str);
 311     void (*splashf)(int ticks, const char *fmt, ...) ATTRIBUTE_PRINTF(2, 3);
 312
 313 #ifdef HAVE_REMOTE_LCD
 314     /* remote lcd */
 315     void (*lcd_remote_set_contrast)(int x);
 316     void (*lcd_remote_clear_display)(void);
 317     void (*lcd_remote_puts)(int x, int y, const unsigned char *string);
 318     void (*lcd_remote_puts_scroll)(int x, int y, const unsigned char* string);
 319     void (*lcd_remote_stop_scroll)(void);
 320     void (*lcd_remote_set_drawmode)(int mode);
 321     int  (*lcd_remote_get_drawmode)(void);
 322     void (*lcd_remote_setfont)(int font);
 323     int  (*lcd_remote_getstringsize)(const unsigned char *str, int *w, int *h);
 324     void (*lcd_remote_drawpixel)(int x, int y);
 325     void (*lcd_remote_drawline)(int x1, int y1, int x2, int y2);
 326     void (*lcd_remote_hline)(int x1, int x2, int y);
 327     void (*lcd_remote_vline)(int x, int y1, int y2);
 328     void (*lcd_remote_drawrect)(int x, int y, int nx, int ny);
 329     void (*lcd_remote_fillrect)(int x, int y, int nx, int ny);
 330     void (*lcd_remote_mono_bitmap_part)(const unsigned char *src, int src_x,
 331                                         int src_y, int stride, int x, int y,
 332                                         int width, int height);
 333     void (*lcd_remote_mono_bitmap)(const unsigned char *src, int x, int y,
 334                                    int width, int height);
 335     void (*lcd_remote_putsxy)(int x, int y, const unsigned char *string);
 336     void (*lcd_remote_puts_style)(int x, int y, const unsigned char *str, int style);
 337     void (*lcd_remote_puts_scroll_style)(int x, int y, const unsigned char* string,
 338                                          int style);
 339     fb_remote_data* lcd_remote_framebuffer;
 340     void (*lcd_remote_update)(void);
 341     void (*lcd_remote_update_rect)(int x, int y, int width, int height);
 342
 343     void (*remote_backlight_on)(void);
 344     void (*remote_backlight_off)(void);
 345     void (*remote_backlight_set_timeout)(int index);
 346 #if CONFIG_CHARGING
 347     void (*remote_backlight_set_timeout_plugged)(int index);
 348 #endif
 349 #endif /* HAVE_REMOTE_LCD */
 350     struct screen* screens[NB_SCREENS];
 351 #if defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1)
 352     void     (*lcd_remote_set_foreground)(unsigned foreground);
 353     unsigned (*lcd_remote_get_foreground)(void);
 354     void     (*lcd_remote_set_background)(unsigned background);
 355     unsigned (*lcd_remote_get_background)(void);
 356     void (*lcd_remote_bitmap_part)(const fb_remote_data *src,
 357                                    int src_x, int src_y, int stride,
 358                                    int x, int y, int width, int height);
 359     void (*lcd_remote_bitmap)(const fb_remote_data *src, int x, int y,
 360                               int width, int height);
 361 #endif
 362     void (*viewport_set_defaults)(struct viewport *vp,
 363                                   const enum screen_type screen);
 364 #ifdef HAVE_LCD_BITMAP
 365     void (*viewportmanager_theme_enable)(enum screen_type screen, bool enable,
 366                                          struct viewport *viewport);
 367     void (*viewportmanager_theme_undo)(enum screen_type screen, bool force_redraw);
 368 #endif
 369     /* list */
 370     void (*gui_synclist_init)(struct gui_synclist * lists,
 371             list_get_name callback_get_item_name, void * data,
 372             bool scroll_all,int selected_size,
 373             struct viewport parent[NB_SCREENS]);
 374     void (*gui_synclist_set_nb_items)(struct gui_synclist * lists, int nb_items);
 375     void (*gui_synclist_set_icon_callback)(struct gui_synclist * lists,
 376                                            list_get_icon icon_callback);
 377     int (*gui_synclist_get_nb_items)(struct gui_synclist * lists);
 378     int  (*gui_synclist_get_sel_pos)(struct gui_synclist * lists);
 379     void (*gui_synclist_draw)(struct gui_synclist * lists);
 380     void (*gui_synclist_select_item)(struct gui_synclist * lists,
 381                                      int item_number);
 382     void (*gui_synclist_add_item)(struct gui_synclist * lists);
 383     void (*gui_synclist_del_item)(struct gui_synclist * lists);
 384     void (*gui_synclist_limit_scroll)(struct gui_synclist * lists, bool scroll);
 385     bool (*gui_synclist_do_button)(struct gui_synclist * lists,
 386                                    int *action, enum list_wrap wrap);
 387     void (*gui_synclist_set_title)(struct gui_synclist *lists, char* title,
 388                                    enum themable_icons icon);
 389     enum yesno_res (*gui_syncyesno_run)(const struct text_message * main_message,
 390                                         const struct text_message * yes_message,
 391                                         const struct text_message * no_message);
 392     void (*simplelist_info_init)(struct simplelist_info *info, char* title,
 393                                  int count, void* data);
 394     bool (*simplelist_show_list)(struct simplelist_info *info);
 395
 396     /* button */
 397     long (*button_get)(bool block);
 398     long (*button_get_w_tmo)(int ticks);
 399     int (*button_status)(void);
 400 #ifdef HAVE_BUTTON_DATA
 401     intptr_t (*button_get_data)(void);
 402     int (*button_status_wdata)(int *pdata);
 403 #endif
 404     void (*button_clear_queue)(void);
 405     int (*button_queue_count)(void);
 406 #ifdef HAS_BUTTON_HOLD
 407     bool (*button_hold)(void);
 408 #endif
 409 #ifdef HAVE_TOUCHSCREEN
 410     void (*touchscreen_set_mode)(enum touchscreen_mode);
 411 #endif
 412 #ifdef HAVE_BUTTON_LIGHT
 413     void (*buttonlight_set_timeout)(int value);
 414     void (*buttonlight_off)(void);
 415     void (*buttonlight_on)(void);
 416 #ifdef HAVE_BUTTONLIGHT_BRIGHTNESS
 417     void (*buttonlight_set_brightness)(int val);
 418 #endif /* HAVE_BUTTONLIGHT_BRIGHTNESS */
 419 #endif /* HAVE_BUTTON_LIGHT */
 420
 421     /* file */
 422     int (*open_utf8)(const char* pathname, int flags);
 423     int (*open)(const char* pathname, int flags, ...);
 424     int (*close)(int fd);
 425     ssize_t (*read)(int fd, void* buf, size_t count);
 426     off_t (*lseek)(int fd, off_t offset, int whence);
 427     int (*creat)(const char *pathname, mode_t mode);
 428     ssize_t (*write)(int fd, const void* buf, size_t count);
 429     int (*remove)(const char* pathname);
 430     int (*rename)(const char* path, const char* newname);
 431     int (*ftruncate)(int fd, off_t length);
 432     off_t (*filesize)(int fd);
 433     int (*fdprintf)(int fd, const char *fmt, ...) ATTRIBUTE_PRINTF(2, 3);
 434     int (*read_line)(int fd, char* buffer, int buffer_size);
 435     bool (*settings_parseline)(char* line, char** name, char** value);
 436     void (*storage_sleep)(void);
 437     void (*storage_spin)(void);
 438     void (*storage_spindown)(int seconds);
 439 #if USING_STORAGE_CALLBACK
 440     void (*register_storage_idle_func)(void (*function)(void *data));
 441     void (*unregister_storage_idle_func)(void (*function)(void *data), bool run);
 442 #endif /* USING_STORAGE_CALLBACK */
 443     void (*reload_directory)(void);
 444     char *(*create_numbered_filename)(char *buffer, const char *path,
 445                                       const char *prefix, const char *suffix,
 446                                       int numberlen IF_CNFN_NUM_(, int *num));
 447     bool (*file_exists)(const char *file);
 448     char* (*strip_extension)(char* buffer, int buffer_size, const char *filename);
 449     unsigned (*crc_32)(const void *src, unsigned len, unsigned crc32);
 450
 451
 452     /* dir */
 453     DIR* (*opendir)(const char* name);
 454     int (*closedir)(DIR* dir);
 455     struct dirent* (*readdir)(DIR* dir);
 456     int (*mkdir)(const char *name);
 457     int (*rmdir)(const char *name);
 458     bool (*dir_exists)(const char *path);
 459     struct dirinfo (*dir_get_info)(DIR* parent, struct dirent *entry);
 460
 461     /* kernel/ system */
 462 #if defined(CPU_ARM) && CONFIG_PLATFORM & PLATFORM_NATIVE
 463     void (*__div0)(void);
 464 #endif
 465     unsigned (*sleep)(unsigned ticks);
 466     void (*yield)(void);
 467     volatile long* current_tick;
 468     long (*default_event_handler)(long event);
 469     long (*default_event_handler_ex)(long event,
 470             void (*callback)(void *), void *parameter);
 471     unsigned int (*create_thread)(void (*function)(void), void* stack,
 472                                   size_t stack_size, unsigned flags,
 473                                   const char *name
 474                                   IF_PRIO(, int priority)
 475                                   IF_COP(, unsigned int core));
 476     void (*thread_exit)(void);
 477     void (*thread_wait)(unsigned int thread_id);
 478 #if CONFIG_CODEC == SWCODEC
 479     void (*thread_thaw)(unsigned int thread_id);
 480 #ifdef HAVE_PRIORITY_SCHEDULING
 481     int (*thread_set_priority)(unsigned int thread_id, int priority);
 482 #endif
 483     void (*mutex_init)(struct mutex *m);
 484     void (*mutex_lock)(struct mutex *m);
 485     void (*mutex_unlock)(struct mutex *m);
 486 #endif
 487
 488     void (*reset_poweroff_timer)(void);
 489 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
 490     int (*system_memory_guard)(int newmode);
 491     long *cpu_frequency;
 492 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
 493 #ifdef CPU_BOOST_LOGGING
 494     void (*cpu_boost_)(bool on_off,char*location,int line);
 495 #else
 496     void (*cpu_boost)(bool on_off);
 497 #endif
 498 #endif /* HAVE_ADJUSTABLE_CPU_FREQ */
 499 #endif /* PLATFORM_NATIVE */
 500 #ifdef HAVE_SCHEDULER_BOOSTCTRL
 501     void (*trigger_cpu_boost)(void);
 502     void (*cancel_cpu_boost)(void);
 503 #endif
 504
 505     void (*cpucache_flush)(void);
 506     void (*cpucache_invalidate)(void);
 507
 508     /* load code api for overlay */
 509     void* (*lc_open)(const char *filename, unsigned char *buf, size_t buf_size);
 510     void* (*lc_open_from_mem)(void* addr, size_t blob_size);
 511     void* (*lc_get_header)(void *handle);
 512     void  (*lc_close)(void *handle);
 513
 514     bool (*timer_register)(int reg_prio, void (*unregister_callback)(void),
 515                            long cycles, void (*timer_callback)(void)
 516                            IF_COP(, int core));
 517     void (*timer_unregister)(void);
 518     bool (*timer_set_period)(long count);
 519
 520     void (*queue_init)(struct event_queue *q, bool register_queue);
 521     void (*queue_delete)(struct event_queue *q);
 522     void (*queue_post)(struct event_queue *q, long id, intptr_t data);
 523     void (*queue_wait_w_tmo)(struct event_queue *q, struct queue_event *ev,
 524             int ticks);
 525 #if CONFIG_CODEC == SWCODEC
 526     void (*queue_enable_queue_send)(struct event_queue *q,
 527                                     struct queue_sender_list *send,
 528                                     unsigned int thread_id);
 529     bool (*queue_empty)(const struct event_queue *q);
 530     void (*queue_wait)(struct event_queue *q, struct queue_event *ev);
 531     intptr_t (*queue_send)(struct event_queue *q, long id,
 532                            intptr_t data);
 533     void (*queue_reply)(struct event_queue *q, intptr_t retval);
 534 #endif /* CONFIG_CODEC == SWCODEC */
 535
 536     void (*usb_acknowledge)(long id);
 537 #ifdef USB_ENABLE_HID
 538     void (*usb_hid_send)(usage_page_t usage_page, int id);
 539 #endif
 540 #ifdef RB_PROFILE
 541     void (*profile_thread)(void);
 542     void (*profstop)(void);
 543     void (*profile_func_enter)(void *this_fn, void *call_site);
 544     void (*profile_func_exit)(void *this_fn, void *call_site);
 545 #endif
 546     /* event api */
 547     bool (*add_event)(unsigned short id, bool oneshot, void (*handler)(void *data));
 548     void (*remove_event)(unsigned short id, void (*handler)(void *data));
 549     void (*send_event)(unsigned short id, void *data);
 550
 551 #if (CONFIG_PLATFORM & PLATFORM_HOSTED)
 552     /* special simulator hooks */
 553 #if defined(HAVE_LCD_BITMAP) && LCD_DEPTH < 8
 554     void (*sim_lcd_ex_init)(unsigned long (*getpixel)(int, int));
 555     void (*sim_lcd_ex_update_rect)(int x, int y, int width, int height);
 556 #endif
 557 #endif
 558
 559     /* strings and memory */
 560     int (*snprintf)(char *buf, size_t size, const char *fmt, ...)
 561                     ATTRIBUTE_PRINTF(3, 4);
 562     int (*vsnprintf)(char *buf, size_t size, const char *fmt, va_list ap);
 563     char* (*strcpy)(char *dst, const char *src);
 564     size_t (*strlcpy)(char *dst, const char *src, size_t length);
 565     size_t (*strlen)(const char *str);
 566     char * (*strrchr)(const char *s, int c);
 567     int (*strcmp)(const char *, const char *);
 568     int (*strncmp)(const char *, const char *, size_t);
 569     int (*strcasecmp)(const char *, const char *);
 570     int (*strncasecmp)(const char *s1, const char *s2, size_t n);
 571     void* (*memset)(void *dst, int c, size_t length);
 572     void* (*memcpy)(void *out, const void *in, size_t n);
 573     void* (*memmove)(void *out, const void *in, size_t n);
 574 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
 575     const unsigned char *_rbctype_;
 576 #endif
 577     int (*atoi)(const char *str);
 578     char *(*strchr)(const char *s, int c);
 579     char *(*strcat)(char *s1, const char *s2);
 580     size_t (*strlcat)(char *dst, const char *src, size_t length);
 581     void *(*memchr)(const void *s1, int c, size_t n);
 582     int (*memcmp)(const void *s1, const void *s2, size_t n);
 583     char *(*strcasestr) (const char* phaystack, const char* pneedle);
 584     char* (*strtok_r)(char *ptr, const char *sep, char **end);
 585     /* unicode stuff */
 586     const unsigned char* (*utf8decode)(const unsigned char *utf8, unsigned short *ucs);
 587     unsigned char* (*iso_decode)(const unsigned char *iso, unsigned char *utf8, int cp, int count);
 588     unsigned char* (*utf16LEdecode)(const unsigned char *utf16, unsigned char *utf8, int count);
 589     unsigned char* (*utf16BEdecode)(const unsigned char *utf16, unsigned char *utf8, int count);
 590     unsigned char* (*utf8encode)(unsigned long ucs, unsigned char *utf8);
 591     unsigned long (*utf8length)(const unsigned char *utf8);
 592     int (*utf8seek)(const unsigned char* utf8, int offset);
 593
 594     /* sound */
 595     void (*sound_set)(int setting, int value);
 596     int (*sound_default)(int setting);
 597     int (*sound_min)(int setting);
 598     int (*sound_max)(int setting);
 599     const char * (*sound_unit)(int setting);
 600     int (*sound_val2phys)(int setting, int value);
 601 #ifdef AUDIOHW_HAVE_EQ
 602     int (*sound_enum_hw_eq_band_setting)(unsigned int band,
 603                                          unsigned int band_setting);
 604 #endif /* AUDIOHW_HAVE_EQ */
 605 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
 606     void (*mp3_play_data)(const unsigned char* start, int size,
 607                           void (*get_more)(unsigned char** start, size_t* size));
 608     void (*mp3_play_pause)(bool play);
 609     void (*mp3_play_stop)(void);
 610     bool (*mp3_is_playing)(void);
 611 #if CONFIG_CODEC != SWCODEC
 612     void (*bitswap)(unsigned char *data, int length);
 613 #endif
 614 #endif /* PLATFORM_NATIVE */
 615 #if CONFIG_CODEC == SWCODEC
 616     const unsigned long *audio_master_sampr_list;
 617     const unsigned long *hw_freq_sampr;
 618     void (*pcm_apply_settings)(void);
 619     void (*pcm_play_data)(pcm_play_callback_type get_more,
 620             unsigned char* start, size_t size);
 621     void (*pcm_play_stop)(void);
 622     void (*pcm_set_frequency)(unsigned int frequency);
 623     bool (*pcm_is_playing)(void);
 624     bool (*pcm_is_paused)(void);
 625     void (*pcm_play_pause)(bool play);
 626     size_t (*pcm_get_bytes_waiting)(void);
 627     void (*pcm_calculate_peaks)(int *left, int *right);
 628     const void* (*pcm_get_peak_buffer)(int *count);
 629     void (*pcm_play_lock)(void);
 630     void (*pcm_play_unlock)(void);
 631     void (*pcmbuf_beep)(unsigned int frequency,
 632                         size_t duration,
 633                         int amplitude);
 634 #ifdef HAVE_RECORDING
 635     const unsigned long *rec_freq_sampr;
 636     void (*pcm_init_recording)(void);
 637     void (*pcm_close_recording)(void);
 638     void (*pcm_record_data)(pcm_rec_callback_type more_ready,
 639                             void *start, size_t size);
 640     void (*pcm_stop_recording)(void);
 641     void (*pcm_calculate_rec_peaks)(int *left, int *right);
 642     void (*audio_set_recording_gain)(int left, int right, int type);
 643 #endif /* HAVE_RECORDING */
 644 #if INPUT_SRC_CAPS != 0
 645     void (*audio_set_output_source)(int monitor);
 646     void (*audio_set_input_source)(int source, unsigned flags);
 647 #endif
 648     void (*dsp_set_crossfeed)(bool enable);
 649     void (*dsp_set_eq)(bool enable);
 650     void (*dsp_dither_enable)(bool enable);
 651     intptr_t (*dsp_configure)(struct dsp_config *dsp, int setting,
 652                               intptr_t value);
 653     int (*dsp_process)(struct dsp_config *dsp, char *dest,
 654                        const char *src[], int count);
 655     int (*dsp_input_count)(struct dsp_config *dsp, int count);
 656     int (*dsp_output_count)(struct dsp_config *dsp, int count);
 657 #endif /* CONFIG_CODEC == SWCODC */
 658
 659     /* playback control */
 660     int (*playlist_amount)(void);
 661     int (*playlist_resume)(void);
 662     void (*playlist_start)(int start_index, int offset);
 663     int (*playlist_add)(const char *filename);
 664     void (*playlist_sync)(struct playlist_info* playlist);
 665     int (*playlist_remove_all_tracks)(struct playlist_info *playlist);
 666     int (*playlist_create)(const char *dir, const char *file);
 667     int (*playlist_insert_track)(struct playlist_info* playlist,
 668             const char *filename, int position, bool queue, bool sync);
 669     int (*playlist_insert_directory)(struct playlist_info* playlist,
 670                               const char *dirname, int position, bool queue,
 671                               bool recurse);
 672     int (*playlist_shuffle)(int random_seed, int start_index);
 673     void (*audio_play)(long offset);
 674     void (*audio_stop)(void);
 675     void (*audio_pause)(void);
 676     void (*audio_resume)(void);
 677     void (*audio_next)(void);
 678     void (*audio_prev)(void);
 679     void (*audio_ff_rewind)(long newtime);
 680     struct mp3entry* (*audio_next_track)(void);
 681     int (*audio_status)(void);
 682     struct mp3entry* (*audio_current_track)(void);
 683     void (*audio_flush_and_reload_tracks)(void);
 684     int (*audio_get_file_pos)(void);
 685 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
 686     unsigned long (*mpeg_get_last_header)(void);
 687 #endif
 688 #if ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F) || \
 689      (CONFIG_CODEC == SWCODEC)) && defined (HAVE_PITCHSCREEN)
 690     void (*sound_set_pitch)(int32_t pitch);
 691 #endif
 692
 693     /* MAS communication */
 694 #if !defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)
 695     int (*mas_readmem)(int bank, int addr, unsigned long* dest, int len);
 696     int (*mas_writemem)(int bank, int addr, const unsigned long* src, int len);
 697     int (*mas_readreg)(int reg);
 698     int (*mas_writereg)(int reg, unsigned int val);
 699 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
 700     int (*mas_codec_writereg)(int reg, unsigned int val);
 701     int (*mas_codec_readreg)(int reg);
 702     void (*i2c_begin)(void);
 703     void (*i2c_end)(void);
 704     int  (*i2c_write)(int address, const unsigned char* buf, int count );
 705 #endif
 706 #endif
 707
 708     /* menu */
 709     int (*do_menu)(const struct menu_item_ex *menu, int *start_selected,
 710                    struct viewport parent[NB_SCREENS], bool hide_theme);
 711
 712     /* scroll bar */
 713     struct gui_syncstatusbar *statusbars;
 714     void (*gui_syncstatusbar_draw)(struct gui_syncstatusbar * bars, bool force_redraw);
 715
 716     /* options */
 717     const struct settings_list* (*get_settings_list)(int*count);
 718     const struct settings_list* (*find_setting)(const void* variable, int *id);
 719     bool (*option_screen)(const struct settings_list *setting,
 720                           struct viewport parent[NB_SCREENS],
 721                           bool use_temp_var, unsigned char* option_title);
 722     bool (*set_option)(const char* string, const void* variable,
 723                        enum optiontype type, const struct opt_items* options,
 724                        int numoptions, void (*function)(int));
 725     bool (*set_bool_options)(const char* string, const bool* variable,
 726                              const char* yes_str, int yes_voice,
 727                              const char* no_str, int no_voice,
 728                              void (*function)(bool));
 729     bool (*set_int)(const unsigned char* string, const char* unit, int voice_unit,
 730                     const int* variable, void (*function)(int), int step,
 731                     int min, int max,
 732                     const char* (*formatter)(char*, size_t, int, const char*) );
 733     bool (*set_bool)(const char* string, const bool* variable );
 734
 735 #ifdef HAVE_LCD_COLOR
 736     bool (*set_color)(struct screen *display, char *title,
 737                       unsigned *color, unsigned banned_color);
 738 #endif
 739     /* action handling */
 740     int (*get_custom_action)(int context,int timeout,
 741                           const struct button_mapping* (*get_context_map)(int));
 742     int (*get_action)(int context, int timeout);
 743 #ifdef HAVE_TOUCHSCREEN
 744     int (*action_get_touchscreen_press)(short *x, short *y);
 745 #endif
 746     bool (*action_userabort)(int timeout);
 747
 748     /* power */
 749     int (*battery_level)(void);
 750     bool (*battery_level_safe)(void);
 751     int (*battery_time)(void);
 752 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
 753     unsigned int (*battery_voltage)(void);
 754 #endif
 755 #if CONFIG_CHARGING
 756     bool (*charger_inserted)(void);
 757 # if CONFIG_CHARGING >= CHARGING_MONITOR
 758     bool (*charging_state)(void);
 759 # endif
 760 #endif
 761 #ifdef HAVE_USB_POWER
 762     bool (*usb_powered)(void);
 763 #endif
 764
 765     /* misc */
 766 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
 767     int* __errno;
 768 #endif
 769     void (*srand)(unsigned int seed);
 770     int  (*rand)(void);
 771     void (*qsort)(void *base, size_t nmemb, size_t size,
 772                   int(*compar)(const void *, const void *));
 773     int (*kbd_input)(char* buffer, int buflen);
 774     struct tm* (*get_time)(void);
 775     int  (*set_time)(const struct tm *tm);
 776 #if CONFIG_RTC
 777     time_t (*mktime)(struct tm *t);
 778 #endif
 779     void* (*plugin_get_buffer)(size_t *buffer_size);
 780     void* (*plugin_get_audio_buffer)(size_t *buffer_size);
 781     void (*plugin_tsr)(bool (*exit_callback)(bool reenter));
 782     char* (*plugin_get_current_filename)(void);
 783 #if defined(DEBUG) || defined(SIMULATOR)
 784     void (*debugf)(const char *fmt, ...) ATTRIBUTE_PRINTF(1, 2);
 785 #endif
 786 #ifdef ROCKBOX_HAS_LOGF
 787     void (*logf)(const char *fmt, ...) ATTRIBUTE_PRINTF(1, 2);
 788 #endif
 789     struct user_settings* global_settings;
 790     struct system_status *global_status;
 791     void (*talk_disable)(bool disable);
 792 #if CONFIG_CODEC == SWCODEC
 793     void (*codec_thread_do_callback)(void (*fn)(void),
 794                                      unsigned int *audio_thread_id);
 795     int (*codec_load_file)(const char* codec, struct codec_api *api);
 796     const char *(*get_codec_filename)(int cod_spec);
 797     void ** (*find_array_ptr)(void **arr, void *ptr);
 798     int (*remove_array_ptr)(void **arr, void *ptr);
 799     int (*round_value_to_list32)(unsigned long value,
 800                                  const unsigned long list[],
 801                                  int count,
 802                                  bool signd);
 803 #endif /* CONFIG_CODEC == SWCODEC */
 804     bool (*get_metadata)(struct mp3entry* id3, int fd, const char* trackname);
 805     bool (*mp3info)(struct mp3entry *entry, const char *filename);
 806     int (*count_mp3_frames)(int fd, int startpos, int filesize,
 807                             void (*progressfunc)(int));
 808     int (*create_xing_header)(int fd, long startpos, long filesize,
 809             unsigned char *buf, unsigned long num_frames,
 810             unsigned long rec_time, unsigned long header_template,
 811             void (*progressfunc)(int), bool generate_toc);
 812     unsigned long (*find_next_frame)(int fd, long *offset,
 813             long max_offset, unsigned long last_header);
 814
 815 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
 816     unsigned short (*peak_meter_scale_value)(unsigned short val,
 817                                              int meterwidth);
 818     void (*peak_meter_set_use_dbfs)(bool use);
 819     bool (*peak_meter_get_use_dbfs)(void);
 820 #endif
 821 #ifdef HAVE_LCD_BITMAP
 822     int (*read_bmp_file)(const char* filename, struct bitmap *bm, int maxsize,
 823                          int format, const struct custom_format *cformat);
 824     int (*read_bmp_fd)(int fd, struct bitmap *bm, int maxsize,
 825                        int format, const struct custom_format *cformat);
 826 #ifdef HAVE_JPEG
 827     int (*read_jpeg_file)(const char* filename, struct bitmap *bm, int maxsize,
 828                           int format, const struct custom_format *cformat);
 829     int (*read_jpeg_fd)(int fd, struct bitmap *bm, int maxsize,
 830                         int format, const struct custom_format *cformat);
 831 #endif
 832     void (*screen_dump_set_hook)(void (*hook)(int fh));
 833 #endif
 834     int (*show_logo)(void);
 835     struct tree_context* (*tree_get_context)(void);
 836     void (*set_current_file)(const char* path);
 837     void (*set_dirfilter)(int l_dirfilter);
 838
 839 #ifdef HAVE_WHEEL_POSITION
 840     int (*wheel_status)(void);
 841     void (*wheel_send_events)(bool send);
 842 #endif
 843
 844 #ifdef IRIVER_H100_SERIES
 845     /* Routines for the iriver_flash -plugin. */
 846     bool (*detect_original_firmware)(void);
 847     bool (*detect_flashed_ramimage)(void);
 848     bool (*detect_flashed_romimage)(void);
 849 #endif
 850
 851     void (*led)(bool on);
 852
 853 #if (CONFIG_CODEC == SWCODEC)
 854     /* buffering API */
 855     int (*bufopen)(const char *file, size_t offset, enum data_type type,
 856                    void *user_data);
 857     int (*bufalloc)(const void *src, size_t size, enum data_type type);
 858     bool (*bufclose)(int handle_id);
 859     int (*bufseek)(int handle_id, size_t newpos);
 860     int (*bufadvance)(int handle_id, off_t offset);
 861     ssize_t (*bufread)(int handle_id, size_t size, void *dest);
 862     ssize_t (*bufgetdata)(int handle_id, size_t size, void **data);
 863     ssize_t (*bufgettail)(int handle_id, size_t size, void **data);
 864     ssize_t (*bufcuttail)(int handle_id, size_t size);
 865
 866     ssize_t (*buf_get_offset)(int handle_id, void *ptr);
 867     ssize_t (*buf_handle_offset)(int handle_id);
 868     void (*buf_request_buffer_handle)(int handle_id);
 869     void (*buf_set_base_handle)(int handle_id);
 870     size_t (*buf_used)(void);
 871 #endif
 872
 873 #ifdef HAVE_TAGCACHE
 874     bool (*tagcache_search)(struct tagcache_search *tcs, int tag);
 875     void (*tagcache_search_set_uniqbuf)(struct tagcache_search *tcs,
 876            void *buffer, long length);
 877     bool (*tagcache_search_add_filter)(struct tagcache_search *tcs,
 878                                     int tag, int seek);
 879     bool (*tagcache_get_next)(struct tagcache_search *tcs);
 880     bool (*tagcache_retrieve)(struct tagcache_search *tcs, int idxid,
 881                            int tag, char *buf, long size);
 882     void (*tagcache_search_finish)(struct tagcache_search *tcs);
 883     long (*tagcache_get_numeric)(const struct tagcache_search *tcs, int tag);
 884 #if defined(HAVE_TC_RAMCACHE) && defined(HAVE_DIRCACHE)
 885     bool (*tagcache_fill_tags)(struct mp3entry *id3, const char *filename);
 886 #endif
 887 #endif
 888
 889 #ifdef HAVE_ALBUMART
 890     bool (*search_albumart_files)(const struct mp3entry *id3, const char *size_string,
 891                                   char *buf, int buflen);
 892 #endif
 893
 894 #ifdef HAVE_SEMAPHORE_OBJECTS
 895     void (*semaphore_init)(struct semaphore *s, int max, int start);
 896     void (*semaphore_wait)(struct semaphore *s);
 897     void (*semaphore_release)(struct semaphore *s);
 898 #endif
 899
 900     const char *rbversion;
 901
 902     /* new stuff at the end, sort into place next time
 903        the API gets incompatible */
 904     int (*filetype_get_attr)(const char* file);
 905 };
 906
 907 /* plugin header */
 908 struct plugin_header {
 909     struct lc_header lc_hdr; /* must be the first */
 910     enum plugin_status(*entry_point)(const void*);
 911     const struct plugin_api **api;
 912 };
 913
 914 #ifdef PLUGIN
 915 #if (CONFIG_PLATFORM & PLATFORM_NATIVE)
 916 extern unsigned char plugin_start_addr[];
 917 extern unsigned char plugin_end_addr[];
 918 #define PLUGIN_HEADER \
 919         const struct plugin_api *rb DATA_ATTR; \
 920         const struct plugin_header __header \
 921         __attribute__ ((section (".header")))= { \
 922         { PLUGIN_MAGIC, TARGET_ID, PLUGIN_API_VERSION, \
 923         plugin_start_addr, plugin_end_addr }, plugin__start, &rb };
 924 #else /* PLATFORM_HOSTED */
 925 #define PLUGIN_HEADER \
 926         const struct plugin_api *rb DATA_ATTR; \
 927         const struct plugin_header __header \
 928         __attribute__((visibility("default"))) = { \
 929         { PLUGIN_MAGIC, TARGET_ID, PLUGIN_API_VERSION, NULL, NULL }, \
 930         plugin__start, &rb };
 931 #endif /* CONFIG_PLATFORM */
 932 #endif /* PLUGIN */
 933
 934 int plugin_load(const char* plugin, const void* parameter);
 935 void* plugin_get_audio_buffer(size_t *buffer_size);
 936
 937 /* plugin_tsr,
 938     callback returns true to allow the new plugin to load,
 939     reenter means the currently running plugin is being reloaded */
 940 void plugin_tsr(bool (*exit_callback)(bool reenter));
 941
 942 /* defined by the plugin */
 943 extern const struct plugin_api *rb;
 944 enum plugin_status plugin__start(const void* parameter)
 945     NO_PROF_ATTR;
 946
 947 #endif /* __PCTOOL__ */
 948 #endif