1 # Auto generated documentation by Rockbox plugin API generator v2
2 # Made by Maurus Cuelenaere
4 # Open \______ \ ____ ____ | | _\_ |__ _______ ___
5 # Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
6 # Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
7 # Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
11 # Generated from http://svn.rockbox.org/viewvc.cgi/trunk/apps/plugin.h
14 # \group memory and strings
15 # \conditions defined(HAVE_BACKLIGHT)
19 # \see func1 func2 [S[apps/plugin.c]]
29 char *strcasestr (const char* phaystack, const char* pneedle)
30 \group strings and memory
36 bool action_userabort(int timeout)
37 \group action handling
42 size_t align_buffer(void **start, size_t size, size_t align)
44 \conditions (CONFIG_CODEC == SWCODEC)
51 const char *appsversion
52 \return version of the plugin API
57 \description Give the disk some rest
63 void ata_spindown(int seconds)
68 int atoi(const char *str)
69 \group strings and memory
72 \description he atoi() function converts the initial portion of a string pointed to by str to int
74 struct mp3entry* audio_current_track(void)
75 \group playback control
76 \return the mp3entry struct of the currently playing track
78 \see [S[firmware/export/id3.h]]
80 void audio_ff_rewind(long newtime)
81 \group playback control
85 void audio_flush_and_reload_tracks(void)
86 \group playback control
89 int audio_get_file_pos(void)
90 \group playback control
94 bool audio_has_changed_track(void)
95 \group playback control
100 \group playback control
103 struct mp3entry* audio_next_track(void)
104 \group playback control
105 \return the mp3entry struct of the upcoming track
107 \see [S[firmware/export/id3.h]]
109 void audio_pause(void)
110 \group playback control
113 void audio_prev(void)
114 \group playback control
117 void audio_resume(void)
118 \group playback control
121 void audio_set_input_source(int source, unsigned flags)
123 \conditions (CONFIG_CODEC == SWCODEC) && (INPUT_SRC_CAPS != 0)
128 void audio_set_output_source(int monitor)
130 \conditions (CONFIG_CODEC == SWCODEC) && (INPUT_SRC_CAPS != 0)
134 void audio_set_recording_gain(int left, int right, int type)
136 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING))
142 int audio_status(void)
143 \group playback control
147 void audio_stop(void)
148 \group playback control
151 void backlight_off(void)
153 \description Turns the backlight off
155 void backlight_on(void)
157 \description Turns the backlight on
159 void backlight_set_brightness(int val)
161 \conditions (defined(HAVE_BACKLIGHT_BRIGHTNESS))
165 void backlight_set_timeout(int index)
167 \param index 0 : backlight always off%BR%1 : no time out%BR%2 : 1s%BR%3 : 2s%BR%4 : 3s%BR%5 : 4s%BR%6 : 5s%BR%7 : 6s%BR%8 : 7s%BR%9 : 8s%BR%10 : 9s%BR%11 : 10s%BR%12 : 15s%BR%13 : 20s%BR%14 : 25s%BR%15 : 30s%BR%16 : 45s%BR%17 : 60s%BR%18 : 90s%BR%other : backlight always off
168 \description Set the backlight timeout
170 void backlight_set_timeout_plugged(int index)
171 \conditions (CONFIG_CHARGING)
175 int battery_level(void)
177 \return battery level in percent
178 \description On the simulator, battery_level is always 75
180 bool battery_level_safe(void)
185 int battery_time(void)
190 unsigned int battery_voltage(void)
192 \conditions (!defined(SIMULATOR))
196 unsigned short *bidi_l2v( const unsigned char *str, int orientation )
197 \conditions !defined(HAVE_LCD_CHARCELLS)
203 void bitswap(unsigned char *data, int length)
205 \conditions (!defined(SIMULATOR)) && (CONFIG_CODEC != SWCODEC)
208 \description Swap the bits for each element of array =data= of size =length=
210 int bufadvance(int handle_id, off_t offset)
212 \conditions ((CONFIG_CODEC == SWCODEC))
218 int bufalloc(const void *src, size_t size, enum data_type type)
220 \conditions ((CONFIG_CODEC == SWCODEC))
227 bool bufclose(int handle_id)
229 \conditions ((CONFIG_CODEC == SWCODEC))
234 ssize_t bufcuttail(int handle_id, size_t size)
236 \conditions ((CONFIG_CODEC == SWCODEC))
242 ssize_t bufgetdata(int handle_id, size_t size, void **data)
244 \conditions ((CONFIG_CODEC == SWCODEC))
251 ssize_t bufgettail(int handle_id, size_t size, void **data)
253 \conditions ((CONFIG_CODEC == SWCODEC))
260 int bufopen(const char *file, size_t offset, enum data_type type)
262 \conditions ((CONFIG_CODEC == SWCODEC))
269 ssize_t bufread(int handle_id, size_t size, void *dest)
271 \conditions ((CONFIG_CODEC == SWCODEC))
278 int bufseek(int handle_id, size_t newpos)
280 \conditions ((CONFIG_CODEC == SWCODEC))
286 ssize_t buf_get_offset(int handle_id, void *ptr)
287 \conditions ((CONFIG_CODEC == SWCODEC))
293 ssize_t buf_handle_offset(int handle_id)
294 \conditions ((CONFIG_CODEC == SWCODEC))
299 void buf_request_buffer_handle(int handle_id)
300 \conditions ((CONFIG_CODEC == SWCODEC))
304 void buf_set_base_handle(int handle_id)
305 \conditions ((CONFIG_CODEC == SWCODEC))
309 size_t buf_used(void)
310 \conditions ((CONFIG_CODEC == SWCODEC))
314 void buttonlight_off(void)
316 \conditions (defined(HAVE_BUTTON_LIGHT))
319 void buttonlight_on(void)
321 \conditions (defined(HAVE_BUTTON_LIGHT))
324 void buttonlight_set_brightness(int val)
326 \conditions (defined(HAVE_BUTTON_LIGHT)) && (defined(HAVE_BUTTONLIGHT_BRIGHTNESS))
330 void buttonlight_set_timeout(int value)
332 \conditions (defined(HAVE_BUTTON_LIGHT))
336 void button_clear_queue(void)
338 \description Empty the button queue
340 long button_get(bool block)
342 \param block If is set TRUE, button_get won't return until a key is pressed
343 \return a bitmask for which keys were pressed
346 intptr_t button_get_data(void)
348 \conditions (defined(HAVE_BUTTON_DATA))
352 long button_get_w_tmo(int ticks)
355 \return a bitmask for which keys were pressed; if no key was pressed, return BUTTON_NONE
356 \description Wait for a key press for =ticks= ticks. (there are HZ ticks per second)
358 bool button_hold(void)
360 \conditions (defined(HAS_BUTTON_HOLD))
364 struct event_queue *button_queue
365 \conditions !defined(HAVE_LCD_CHARCELLS) )) && (defined(HAVE_LCD_ENABLE
369 int button_queue_count(void)
374 int button_status(void)
376 \return a bitmask for which keys are currently pressed
379 void cancel_cpu_boost(void)
380 \conditions (defined(HAVE_SCHEDULER_BOOSTCTRL))
381 \description Unboosts the CPU for the current thread
383 const unsigned char *font_get_bits( struct font *pf, unsigned short char_code )
384 \conditions !defined(HAVE_LCD_CHARCELLS)
390 const unsigned char* utf8decode(const unsigned char *utf8, unsigned short *ucs)
397 const unsigned char *_ctype_
398 \group strings and memory
402 bool charger_inserted(void)
404 \conditions (CONFIG_CHARGING)
408 bool charging_state(void)
410 \conditions (CONFIG_CHARGING) && (CONFIG_CHARGING == CHARGING_MONITOR)
414 int closedir(DIR* dir)
418 \description The closedir() function closes the directory stream associated with =dir=. The directory stream descriptor dir is not available after this call.
420 int codec_load_file(const char* codec, struct codec_api *api)
422 \conditions (CONFIG_CODEC == SWCODEC)
428 int count_mp3_frames(int fd, int startpos, int filesize, void (*progressfunc)(int))
437 void cpu_boost(bool on_off)
438 \conditions (!defined(SIMULATOR)) && (defined(HAVE_ADJUSTABLE_CPU_FREQ)) && !defined(CPU_BOOST_LOGGING)
440 \description Boosts the CPU if =on_off= is true, otherwise it unboosts the CPU
442 void cpu_boost_(bool on_off,char*location,int line)
443 \conditions (!defined(SIMULATOR)) && (defined(HAVE_ADJUSTABLE_CPU_FREQ)) && (defined(CPU_BOOST_LOGGING))
450 \conditions (!defined(SIMULATOR))
451 \return the current cpu frequency
454 char *create_numbered_filename(char *buffer, const char *path, const char *prefix, const char *suffix, int numberlen IF_CNFN_NUM_(, int *num))
465 struct thread_entry* create_thread(void (*function)(void), void* stack, size_t stack_size, unsigned flags, const char *name IF_PRIO(, int priority) IF_COP(, unsigned int core))
466 \group kernel/ system
474 \return its ID if context area could be allocated, else return -1
475 \description Creates a thread
476 \see [W[RockboxKernel#struct_thread_entry_create_threa]]
478 int create_xing_header(int fd, long startpos, long filesize, unsigned char *buf, unsigned long num_frames, unsigned long rec_time, unsigned long header_template, void (*progressfunc)(int), bool generate_toc)
486 \param header_template
492 volatile long* current_tick
493 \group kernel/ system
497 void debugf(const char *fmt, ...) ATTRIBUTE_PRINTF(1, 2)
499 \conditions (defined(DEBUG) || defined(SIMULATOR))
501 \description Prints =fmt= in a printf-like fashion to STDERR
503 long default_event_handler(long event)
504 \group kernel/ system
506 \return SYS_USB_CONNECTED and call usb_screen() if =event= equals to SYS_USB_CONNECTED, else do nothing and return 0
509 long default_event_handler_ex(long event, void (*callback)(void *), void *parameter)
510 \group kernel/ system
517 bool detect_flashed_ramimage(void)
518 \group Routines for the iriver_flash -plugin.
519 \conditions (defined(IRIVER_H100_SERIES))
523 bool detect_flashed_romimage(void)
524 \group Routines for the iriver_flash -plugin.
525 \conditions (defined(IRIVER_H100_SERIES))
529 bool detect_original_firmware(void)
530 \group Routines for the iriver_flash -plugin.
531 \conditions (defined(IRIVER_H100_SERIES))
535 bool dir_exists(const char *path)
541 int do_menu(const struct menu_item_ex *menu, int *start_selected, struct viewport parent[NB_SCREENS], bool hide_bars)
544 \param start_selected
545 \param parent[NB_SCREENS]
550 intptr_t dsp_configure(struct dsp_config *dsp, int setting, intptr_t value)
552 \conditions (CONFIG_CODEC == SWCODEC)
559 void dsp_dither_enable(bool enable)
561 \conditions (CONFIG_CODEC == SWCODEC)
565 int dsp_process(struct dsp_config *dsp, char *dest, const char *src[], int count)
567 \conditions (CONFIG_CODEC == SWCODEC)
575 void dsp_set_crossfeed(bool enable)
577 \conditions (CONFIG_CODEC == SWCODEC)
581 void dsp_set_eq(bool enable)
583 \conditions (CONFIG_CODEC == SWCODEC)
587 void event_init(struct event *e, unsigned int flags)
588 \conditions (defined(HAVE_EVENT_OBJECTS))
593 void event_set_state(struct event *e, unsigned int state)
594 \conditions (defined(HAVE_EVENT_OBJECTS))
599 void event_wait(struct event *e, unsigned int for_state)
600 \conditions (defined(HAVE_EVENT_OBJECTS))
605 int fdprintf(int fd, const char *fmt, ...) ATTRIBUTE_PRINTF(2, 3)
609 \return number of characters writen to =fd= or a negative value upon error
610 \description Write a formated string in the =fd=
612 bool file_exists(const char *file)
618 bool find_albumart(const struct mp3entry *id3, char *buf, int buflen)
619 \conditions (defined(HAVE_ALBUMART))
626 unsigned long find_next_frame(int fd, long *offset, long max_offset, unsigned long last_header)
635 void flush_icache(void)
636 \conditions (defined(CACHE_FUNCTIONS_AS_CALL))
639 struct font* font_get(int font)
640 \conditions !defined(HAVE_LCD_CHARCELLS)
642 \return the font structure for =font=
643 \description If the requested font isn't loaded/compiled-in, decrement the font number and try again.
644 \see [S[firmware/export/font.h]]
646 int font_getstringsize(const unsigned char *str, int *w, int *h, int fontnumber)
647 \conditions !defined(HAVE_LCD_CHARCELLS)
655 int font_get_width(struct font* pf, unsigned short char_code)
656 \conditions !defined(HAVE_LCD_CHARCELLS)
662 struct font* font_load(const char *path)
663 \conditions !defined(HAVE_LCD_CHARCELLS)
666 \description Load font =path= and returns a struct font pointer for it
667 \see [S[firmware/export/font.h]]
669 int get_action(int context, int timeout)
670 \group action handling
676 const char *get_codec_filename(int cod_spec)
678 \conditions (CONFIG_CODEC == SWCODEC)
683 int get_custom_action(int context,int timeout, const struct button_mapping* (*get_context_map)(int))
684 \group action handling
687 \param get_context_map
691 bool get_metadata(struct mp3entry* id3, int fd, const char* trackname)
693 \conditions (CONFIG_CODEC == SWCODEC)
700 struct tm* get_time(void)
704 \see [S[firmware/include/time.h]]
706 struct user_settings* global_settings
708 \return the global_settings struct
710 \see [S[apps/settings.h]]
712 struct system_status *global_status
714 \return the global_status struct
716 \see [S[apps/settings.h]]
718 void gui_scrollbar_draw(struct screen * screen, int x, int y, int width, int height, int items, int min_shown, int max_shown, unsigned flags)
719 \conditions !defined(HAVE_LCD_CHARCELLS)
731 void gui_synclist_add_item(struct gui_synclist * lists)
736 void gui_synclist_del_item(struct gui_synclist * lists)
741 bool gui_synclist_do_button(struct gui_synclist * lists, unsigned *action, enum list_wrap wrap)
749 void gui_synclist_draw(struct gui_synclist * lists)
754 int gui_synclist_get_nb_items(struct gui_synclist * lists)
760 int gui_synclist_get_sel_pos(struct gui_synclist * lists)
766 void gui_synclist_init(struct gui_synclist * lists, list_get_name callback_get_item_name, void * data, bool scroll_all,int selected_size, struct viewport parent[NB_SCREENS])
769 \param callback_get_item_name
773 \param parent[NB_SCREENS]
776 void gui_synclist_limit_scroll(struct gui_synclist * lists, bool scroll)
782 void gui_synclist_select_item(struct gui_synclist * lists, int item_number)
788 void gui_synclist_set_icon_callback(struct gui_synclist * lists, list_get_icon icon_callback)
794 void gui_synclist_set_nb_items(struct gui_synclist * lists, int nb_items)
800 void gui_synclist_set_title(struct gui_synclist *lists, char* title, int icon)
807 void gui_syncstatusbar_draw(struct gui_syncstatusbar * bars, bool force_redraw)
810 \param force_redraw refreshes =bars= if true
811 \description Draws an initialized statusbar =bars= on the screen and refreshs it if =force_redraw= is true.
812 \see [S[apps/gui/statusbar.h]]
814 enum yesno_res gui_syncyesno_run(const struct text_message * main_message, const struct text_message * yes_message, const struct text_message * no_message)
823 \group MAS communication
824 \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)) && ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F))
828 \group MAS communication
829 \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)) && ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F))
832 int i2c_write(int address, const unsigned char* buf, int count )
833 \group MAS communication
834 \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)) && ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F))
841 void invalidate_icache(void)
842 \conditions (defined(CACHE_FUNCTIONS_AS_CALL))
845 unsigned char* iso_decode(const unsigned char *iso, unsigned char *utf8, int cp, int count)
854 bool is_backlight_on(bool ignore_always_off)
855 \param ignore_always_off
859 int kbd_input(char* buffer, int buflen)
863 \return FALSE upon success
864 \description Prompt for a string to be stored in =buffer= which is of length =buflen=
866 void lcd_bitmap(const fb_data *src, int x, int y, int width, int height)
868 \conditions !defined(HAVE_LCD_CHARCELLS) && (LCD_DEPTH > 1)
874 \description Put a bitmap at given XY coordinates. Element src[i] is the binary representation of column number i of the bitmap read from bottom to top.
876 void lcd_bitmap_part(const fb_data *src, int src_x, int src_y, int stride, int x, int y, int width, int height)
878 \conditions !defined(HAVE_LCD_CHARCELLS) && (LCD_DEPTH > 1)
889 void lcd_bitmap_transparent(const fb_data *src, int x, int y, int width, int height)
891 \conditions !defined(HAVE_LCD_CHARCELLS) && (LCD_DEPTH == 16)
899 void lcd_bitmap_transparent_part(const fb_data *src, int src_x, int src_y, int stride, int x, int y, int width, int height)
901 \conditions !defined(HAVE_LCD_CHARCELLS) && (LCD_DEPTH == 16)
912 void lcd_blit_grey_phase(unsigned char *values, unsigned char *phases, int bx, int by, int bwidth, int bheight, int stride)
914 \conditions !defined(HAVE_LCD_CHARCELLS) )) && ((LCD_DEPTH < 4) && !defined(SIMULATOR
924 void lcd_blit_mono(const unsigned char *data, int x, int by, int width, int bheight, int stride)
926 \conditions !defined(HAVE_LCD_CHARCELLS) )) && ((LCD_DEPTH < 4) && !defined(SIMULATOR
935 void lcd_blit_yuv(unsigned char * const src[3], int src_x, int src_y, int stride, int x, int y, int width, int height)
937 \conditions !defined(HAVE_LCD_CHARCELLS) && (LCD_DEPTH == 16)
948 void lcd_clear_display(void)
950 \description Clears the LCD and the framebuffer
952 void lcd_define_pattern(unsigned long ucs, const char *pattern)
954 \conditions (defined(HAVE_LCD_CHARCELLS))
956 \param pattern is a 8x8 pixelbitmap
957 \description Define a custom pattern for index =ucs=
959 void lcd_double_height(bool on)
961 \conditions (defined(HAVE_LCD_CHARCELLS))
965 void lcd_drawline(int x1, int y1, int x2, int y2)
967 \conditions !defined(HAVE_LCD_CHARCELLS)
968 \param x1 X top coordinate
969 \param y1 Y top coordinate
970 \param x2 X bottom coordinate
971 \param y2 Y bottom coordinate
972 \description Draws a line at (=x1=, =y1=) -> (=x2=, =y2=) within current drawing mode
974 void lcd_drawpixel(int x, int y)
976 \conditions !defined(HAVE_LCD_CHARCELLS)
979 \description Draws a pixel at (=x=, =y=) within current drawing mode
981 void lcd_drawrect(int x, int y, int width, int height)
983 \conditions !defined(HAVE_LCD_CHARCELLS)
988 \description Draws a rectangle at (=x=, =y=) -> (=x= + =width=, =y= + =height=) within current drawing mode
990 void lcd_fillrect(int x, int y, int width, int height)
992 \conditions !defined(HAVE_LCD_CHARCELLS)
997 \description Draws a filled rectangle at (=x=, =y=) -> (=x= + =width=, =y= + =height=) within current drawing mode
999 fb_data* lcd_framebuffer
1001 \conditions !defined(HAVE_LCD_CHARCELLS)
1003 \description Pointer to the framebuffer
1004 \see [S[firmware/export/lcd.h]]
1006 int lcd_getstringsize(const unsigned char *str, int *w, int *h)
1011 \return Success or not
1012 \description Stores the width and height of the string in =w= and =h=
1014 fb_data* lcd_get_backdrop(void)
1016 \conditions !defined(HAVE_LCD_CHARCELLS) && (LCD_DEPTH > 1)
1017 \return Pointer to framebuffer data
1018 \description Gets the current backdrop
1019 \see lcd_framebuffer
1021 unsigned lcd_get_background(void)
1023 \conditions !defined(HAVE_LCD_CHARCELLS) && (LCD_DEPTH > 1)
1027 int lcd_get_drawmode(void)
1029 \conditions !defined(HAVE_LCD_CHARCELLS)
1030 \return current LCD drawing mode
1033 unsigned lcd_get_foreground(void)
1035 \conditions !defined(HAVE_LCD_CHARCELLS) && (LCD_DEPTH > 1)
1039 unsigned long lcd_get_locked_pattern(void)
1041 \conditions (defined(HAVE_LCD_CHARCELLS))
1043 \description Get a locked pattern index
1044 \see [S[firmware/drivers/lcd-player.c]]
1046 void lcd_hline(int x1, int x2, int y)
1048 \conditions !defined(HAVE_LCD_CHARCELLS)
1049 \param x1 X start coordinate
1050 \param x2 X end coordinate
1051 \param y Y coordinate
1052 \description Draws a horizontal line at (=x1=, =y=) -> (=x2=, =y=) within current drawing mode
1054 void lcd_icon(int icon, bool enable)
1056 \conditions (defined(HAVE_LCD_CHARCELLS))
1060 \see [S[firmware/drivers/lcd-player.c]]
1062 void lcd_mono_bitmap(const unsigned char *src, int x, int y, int width, int height)
1064 \conditions !defined(HAVE_LCD_CHARCELLS)
1072 void lcd_mono_bitmap_part(const unsigned char *src, int src_x, int src_y, int stride, int x, int y, int width, int height)
1074 \conditions !defined(HAVE_LCD_CHARCELLS)
1085 void lcd_putc(int x, int y, unsigned long ucs)
1087 \conditions (defined(HAVE_LCD_CHARCELLS))
1091 \description Put character =ucs= at coordinates (=x=, =y=)
1093 void lcd_puts(int x, int y, const unsigned char *string)
1098 \description Puts string on the LCD at row =x= and column =y=
1100 void lcd_putsxy(int x, int y, const unsigned char *string)
1102 \param x X coordinate
1103 \param y Y coordinate
1105 \description Puts string on the LCD at position (=x=, =y=)
1107 void lcd_puts_scroll(int x, int y, const unsigned char* string)
1112 \description Puts scrolling string on the LCD at row =x= and column =y=. The scrolling style is STYLE_DEFAULT.
1114 void lcd_puts_scroll_style(int x, int y, const unsigned char* string, int style)
1116 \conditions !defined(HAVE_LCD_CHARCELLS)
1121 \description Same as lcd_puts_style, but with scrolling is enabled
1124 void lcd_puts_style(int x, int y, const unsigned char *str, int style)
1126 \conditions !defined(HAVE_LCD_CHARCELLS)
1130 \param style can be STYLE_DEFAULT for black text display or STYLE_INVERT for white text display
1131 \description Put a string at row =x= and column =y=
1133 void lcd_put_cursor(int x, int y, unsigned long ucs)
1135 \conditions (defined(HAVE_LCD_CHARCELLS))
1139 \description Put cursor at coordinates (=x=, =y=)
1140 \see [S[firmware/export/lcd.h]]
1142 void lcd_remote_bitmap(const fb_remote_data *src, int x, int y, int width, int height)
1143 \conditions (defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1))
1151 void lcd_remote_bitmap_part(const fb_remote_data *src, int src_x, int src_y, int stride, int x, int y, int width, int height)
1152 \conditions (defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1))
1163 void lcd_remote_clear_display(void)
1165 \conditions (defined(HAVE_REMOTE_LCD))
1168 void lcd_remote_drawline(int x1, int y1, int x2, int y2)
1170 \conditions (defined(HAVE_REMOTE_LCD))
1171 \param x1 X top coordinate
1172 \param y1 Y top coordinate
1173 \param x2 X bottom coordinate
1174 \param y2 Y bottom coordinate
1175 \description Draws a line at (=x1=, =y1=) -> (=x2=, =y2=) within current drawing mode
1177 void lcd_remote_drawpixel(int x, int y)
1179 \conditions (defined(HAVE_REMOTE_LCD))
1182 \description Draws a pixel at (=x=, =y=) within current drawing mode
1184 void lcd_remote_drawrect(int x, int y, int nx, int ny)
1186 \conditions (defined(HAVE_REMOTE_LCD))
1193 void lcd_remote_fillrect(int x, int y, int nx, int ny)
1195 \conditions (defined(HAVE_REMOTE_LCD))
1202 fb_remote_data* lcd_remote_framebuffer
1204 \conditions (defined(HAVE_REMOTE_LCD))
1208 int lcd_remote_getstringsize(const unsigned char *str, int *w, int *h)
1210 \conditions (defined(HAVE_REMOTE_LCD))
1214 \return Success or not
1215 \description Stores the width and height of the string in =w= and =h=
1217 unsigned lcd_remote_get_background(void)
1218 \conditions (defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1))
1222 int lcd_remote_get_drawmode(void)
1224 \conditions (defined(HAVE_REMOTE_LCD))
1228 unsigned lcd_remote_get_foreground(void)
1229 \conditions (defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1))
1233 void lcd_remote_hline(int x1, int x2, int y)
1235 \conditions (defined(HAVE_REMOTE_LCD))
1241 void lcd_remote_mono_bitmap(const unsigned char *src, int x, int y, int width, int height)
1243 \conditions (defined(HAVE_REMOTE_LCD))
1251 void lcd_remote_mono_bitmap_part(const unsigned char *src, int src_x, int src_y, int stride, int x, int y, int width, int height)
1253 \conditions (defined(HAVE_REMOTE_LCD))
1264 void lcd_remote_puts(int x, int y, const unsigned char *string)
1266 \conditions (defined(HAVE_REMOTE_LCD))
1272 void lcd_remote_putsxy(int x, int y, const unsigned char *string)
1274 \conditions (defined(HAVE_REMOTE_LCD))
1280 void lcd_remote_puts_scroll(int x, int y, const unsigned char* string)
1282 \conditions (defined(HAVE_REMOTE_LCD))
1288 void lcd_remote_puts_scroll_style(int x, int y, const unsigned char* string, int style)
1290 \conditions (defined(HAVE_REMOTE_LCD))
1297 void lcd_remote_puts_style(int x, int y, const unsigned char *str, int style)
1299 \conditions (defined(HAVE_REMOTE_LCD))
1306 void lcd_remote_setfont(int font)
1308 \conditions (defined(HAVE_REMOTE_LCD))
1310 \description Set default font
1312 void lcd_remote_set_background(unsigned background)
1313 \conditions (defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1))
1317 void lcd_remote_set_contrast(int x)
1319 \conditions (defined(HAVE_REMOTE_LCD))
1323 void lcd_remote_set_drawmode(int mode)
1325 \conditions (defined(HAVE_REMOTE_LCD))
1329 void lcd_remote_set_foreground(unsigned foreground)
1330 \conditions (defined(HAVE_REMOTE_LCD) && (LCD_REMOTE_DEPTH > 1))
1334 void lcd_remote_stop_scroll(void)
1336 \conditions (defined(HAVE_REMOTE_LCD))
1337 \description Stop all scrolling lines on the screen
1339 void lcd_remote_update(void)
1341 \conditions (defined(HAVE_REMOTE_LCD))
1344 void lcd_remote_update_rect(int x, int y, int width, int height)
1346 \conditions (defined(HAVE_REMOTE_LCD))
1353 void lcd_remote_vline(int x, int y1, int y2)
1355 \conditions (defined(HAVE_REMOTE_LCD))
1361 void lcd_remove_cursor(void)
1363 \conditions (defined(HAVE_LCD_CHARCELLS))
1364 \description Remove the cursor from the screen
1366 void lcd_setfont(int font)
1368 \conditions !defined(HAVE_LCD_CHARCELLS)
1370 \description Set default font
1372 void lcd_set_backdrop(fb_data* backdrop)
1374 \conditions !defined(HAVE_LCD_CHARCELLS) && (LCD_DEPTH > 1)
1375 \param backdrop Pointer to backdrop image
1376 \description Set the backdrop to =backdrop=
1377 \see lcd_framebuffer
1379 void lcd_set_background(unsigned foreground)
1381 \conditions !defined(HAVE_LCD_CHARCELLS) && (LCD_DEPTH > 1)
1385 void lcd_set_contrast(int x)
1387 \param x Should be between =MIN_CONTRAST_SETTING= and =MAX_CONTRAST_SETTING=
1388 \description Sets LCD contrast to value =x=
1390 void lcd_set_drawmode(int mode)
1392 \conditions !defined(HAVE_LCD_CHARCELLS)
1396 void lcd_set_enable_hook(void (*enable_hook)(void))
1397 \conditions !defined(HAVE_LCD_CHARCELLS) && defined(HAVE_LCD_ENABLE) && defined(HAVE_LCD_COLOR)
1401 void lcd_set_foreground(unsigned foreground)
1403 \conditions !defined(HAVE_LCD_CHARCELLS) && (LCD_DEPTH > 1)
1407 void lcd_set_invert_display(bool yesno)
1409 \conditions !defined(HAVE_LCD_CHARCELLS) )) && (defined(HAVE_LCD_INVERT
1413 void lcd_stop_scroll(void)
1415 \description Stop all scrolling lines on the screen
1417 void lcd_unlock_pattern(unsigned long ucs)
1419 \conditions (defined(HAVE_LCD_CHARCELLS))
1421 \description Unlock pattern of index =ucs=
1423 void lcd_update(void)
1425 \description Pushes LCD framebuffer changes to the LCD
1427 void lcd_update_rect(int x, int y, int width, int height)
1429 \conditions !defined(HAVE_LCD_CHARCELLS)
1430 \param x measured in pixels
1431 \param y measured in pixels
1432 \param width measured in pixels
1433 \param height measured in pixels
1434 \description Pushes LCD framebuffer changes to the LCD within rectangle (=x=, =y=) -> (=x= + =width=, =y= + =height=). Notice that the smallest vertical resolution in updates that the hardware supports is 8 pixels.
1436 void lcd_vline(int x, int y1, int y2)
1438 \conditions !defined(HAVE_LCD_CHARCELLS)
1439 \param x X coordinate
1440 \param y1 Y start coordinate
1441 \param y2 Y end coordinate
1442 \description Draws a vertical line at (=x=, =y1=) -> (=x=, =y2=) within current drawing mode
1444 void lcd_yuv_set_options(unsigned options)
1446 \conditions !defined(HAVE_LCD_CHARCELLS) )) && (LCD_DEPTH == 16) && (defined(TOSHIBA_GIGABEAT_F) || defined(SANSA_E200) || defined(SANSA_C200) || defined(IRIVER_H10) || defined(COWON_D2
1454 void logf(const char *fmt, ...) ATTRIBUTE_PRINTF(1, 2)
1456 \conditions (defined(ROCKBOX_HAS_LOGF))
1460 const unsigned long *audio_master_sampr_list
1462 \conditions (CONFIG_CODEC == SWCODEC)
1466 const unsigned long *hw_freq_sampr
1468 \conditions (CONFIG_CODEC == SWCODEC)
1472 const unsigned long *rec_freq_sampr
1474 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING))
1478 int mas_codec_readreg(int reg)
1479 \group MAS communication
1480 \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)) && ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F))
1485 int mas_codec_writereg(int reg, unsigned int val)
1486 \group MAS communication
1487 \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC)) && ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F))
1493 int mas_readmem(int bank, int addr, unsigned long* dest, int len)
1494 \group MAS communication
1495 \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC))
1503 int mas_readreg(int reg)
1504 \group MAS communication
1505 \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC))
1510 int mas_writemem(int bank, int addr, const unsigned long* src, int len)
1511 \group MAS communication
1512 \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC))
1520 int mas_writereg(int reg, unsigned int val)
1521 \group MAS communication
1522 \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC))
1528 void *memchr(const void *s1, int c, size_t n)
1529 \group strings and memory
1536 int memcmp(const void *s1, const void *s2, size_t n)
1537 \group strings and memory
1544 void* memcpy(void *out, const void *in, size_t n)
1545 \group strings and memory
1550 \description Copies =n= bytes of data in memory from =in= to =out=
1552 void* memmove(void *out, const void *in, size_t n)
1553 \group strings and memory
1560 void* memset(void *dst, int c, size_t length)
1561 \group strings and memory
1566 \description Fills a memory region with specified byte value =c=
1568 int mkdir(const char *name)
1574 time_t mktime(struct tm *t)
1576 \conditions (CONFIG_RTC)
1581 bool mp3info(struct mp3entry *entry, const char *filename)
1585 \return FALSE if successfull
1586 \description The given =entry= is filled in with whatever id3 info it could find about the given =filename=
1588 bool mp3_is_playing(void)
1590 \conditions (!defined(SIMULATOR))
1591 \return true if an mp3 is playing, else return false
1592 \description Note: a paused mp3 is considered as a playing mp3
1594 void mp3_play_data(const unsigned char* start, int size, void (*get_more)(unsigned char** start, size_t* size))
1596 \conditions (!defined(SIMULATOR))
1597 \param start points to the begining of the file to play
1598 \param size is the size to play
1599 \param get_more is a callback function
1600 \description Plays a chunk of an mp3 file
1602 void mp3_play_pause(bool play)
1604 \conditions (!defined(SIMULATOR))
1606 \description If playback was paused and =play= is TRUE, resume playback. If playback isn't paused and =play= is FALSE, pause playback.
1608 void mp3_play_stop(void)
1610 \conditions (!defined(SIMULATOR))
1611 \description Stops playback
1613 unsigned long mpeg_get_last_header(void)
1614 \group playback control
1615 \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC))
1619 void mutex_init(struct mutex *m)
1620 \group kernel/ system
1621 \conditions (CONFIG_CODEC == SWCODEC)
1625 void mutex_lock(struct mutex *m)
1626 \group kernel/ system
1627 \conditions (CONFIG_CODEC == SWCODEC)
1631 void mutex_unlock(struct mutex *m)
1632 \group kernel/ system
1633 \conditions (CONFIG_CODEC == SWCODEC)
1637 DIR* opendir(const char* name)
1640 \return a pointer to the directory stream
1641 \description The opendir() function opens a directory stream corresponding to the directory name. The stream is positioned at the first entry in the directory.
1643 bool option_screen(const struct settings_list *setting, struct viewport parent[NB_SCREENS], bool use_temp_var, unsigned char* option_title)
1646 \param parent[NB_SCREENS]
1652 void pcm_apply_settings(void)
1654 \conditions (CONFIG_CODEC == SWCODEC)
1657 void pcm_calculate_peaks(int *left, int *right)
1659 \conditions (CONFIG_CODEC == SWCODEC)
1664 void pcm_calculate_rec_peaks(int *left, int *right)
1666 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING))
1671 void pcm_close_recording(void)
1673 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING))
1676 size_t pcm_get_bytes_waiting(void)
1678 \conditions (CONFIG_CODEC == SWCODEC)
1682 void pcm_init_recording(void)
1684 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING))
1687 bool pcm_is_paused(void)
1689 \conditions (CONFIG_CODEC == SWCODEC)
1690 \return true if playback is paused, else false
1693 bool pcm_is_playing(void)
1695 \conditions (CONFIG_CODEC == SWCODEC)
1696 \return true unless playback is paused
1699 void pcm_play_data(pcm_more_callback_type get_more, unsigned char* start, size_t size)
1701 \conditions (CONFIG_CODEC == SWCODEC)
1707 void pcm_play_lock(void)
1709 \conditions (CONFIG_CODEC == SWCODEC)
1712 void pcm_play_pause(bool play)
1714 \conditions (CONFIG_CODEC == SWCODEC)
1716 \description Pauses or unpauses the playback depending on the truth value of =play=
1718 void pcm_play_stop(void)
1720 \conditions (CONFIG_CODEC == SWCODEC)
1721 \description Stops the playback and empties the audio buffer unlike [F[pcm_play_pause]]
1723 void pcm_play_unlock(void)
1725 \conditions (CONFIG_CODEC == SWCODEC)
1728 void pcm_record_data(pcm_more_callback_type2 more_ready, void *start, size_t size)
1730 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING))
1736 void pcm_record_more(void *start, size_t size)
1738 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING))
1743 void pcm_set_frequency(unsigned int frequency)
1745 \conditions (CONFIG_CODEC == SWCODEC)
1749 void pcm_stop_recording(void)
1751 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING))
1754 bool peak_meter_get_use_dbfs(void)
1755 \conditions ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F))
1756 \return 1 if the meter currently is displaying dBfs values, 0 if the meter is displaying percent values
1759 unsigned short peak_meter_scale_value(unsigned short val, int meterwidth)
1760 \conditions ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F))
1761 \param val is the volume value (range: 0 <= val < MAX_PEAK)
1762 \param meterwidth is the width of the meter in pixel
1763 \return a value between 0 and meterwidth
1764 \description Scales a peak value as read from the MAS to the range of =meterwidth=. The scaling is performed according to the scaling method (dBfs / linear) and the range (peak_meter_range_min .. peak_meter_range_max).
1766 void peak_meter_set_use_dbfs(bool use)
1767 \conditions ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F))
1768 \param use If =use= is 0 use linear percent scale, else use dBfs
1769 \description Specifies whether the values displayed are scaled as dBfs or as linear percent values
1771 int playlist_amount(void)
1772 \group playback control
1773 \return the number of tracks in current playlist
1776 int playlist_resume(void)
1777 \group playback control
1781 int playlist_start(int start_index, int offset)
1782 \group playback control
1788 void* plugin_get_audio_buffer(size_t *buffer_size)
1792 \description Steals =buffer_size= bytes from the available RAM, reducing the available buffer for audio buffering
1794 void* plugin_get_buffer(size_t *buffer_size)
1796 \param buffer_size this is the memory size left in plugin buffer upon return
1797 \return 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.
1800 char* plugin_get_current_filename(void)
1805 void plugin_iram_init(char *iramstart, char *iramcopy, size_t iram_size, char *iedata, size_t iedata_size)
1807 \conditions (defined(PLUGIN_USE_IRAM))
1815 void plugin_tsr(bool (*exit_callback)(bool reenter))
1817 \param exit_callback
1820 void PREFIX(audio_play)(long offset)
1821 \group playback control
1826 int PREFIX(close)(int fd)
1830 \return 0 upon success
1831 \description The close() function will deallocate the file descriptor indicated by =fd=. To deallocate means to make the file descriptor available for return by subsequent calls to open() or other functions that allocate file descriptors.
1833 int PREFIX(creat)(const char *pathname)
1837 \return the file descriptor associated to this file
1838 \description Create a file with mode O_RDONLY, O_WRONLY or O_RDWR
1840 off_t PREFIX(filesize)(int fd)
1844 \return size of a file; upon error, returns -1
1847 int PREFIX(ftruncate)(int fd, off_t length)
1853 \description Truncate file to the specified =length=
1855 off_t PREFIX(lseek)(int fd, off_t offset, int whence)
1862 \description The lseek() function sets the file pointer associated with the open file descriptor specified by =fd= as follows: If =whence= is SEEK_SET, the pointer is set to =offset= bytes. If =whence= is SEEK_CUR, the pointer is set to its current location plus =offset=. If =whence= is SEEK_END, the pointer is set to the size of the file plus =offset=.
1864 int PREFIX(open)(const char* pathname, int flags)
1870 \description The open() function establishes the connection between a file and a file descriptor. It creates an open file description that refers to a file and a file descriptor that refers to that open file description. The file descriptor is used by other I/O functions to refer to that file.
1872 ssize_t PREFIX(read)(int fd, void* buf, size_t count)
1879 \description The read() function attempts to read =count= bytes from the file associated with the open file descriptor, =fd=, into the buffer pointed to by =buf=
1881 int PREFIX(remove)(const char* pathname)
1886 \description remove() deletes a name from the filesystem. It calls unlink for files, and rmdir for directories.
1888 int PREFIX(rename)(const char* path, const char* newname)
1891 \param path points to the pathname of the file to be renamed
1892 \param newname points to the new pathname of the file
1894 \description The rename() function changes the name of a file
1896 void PREFIX(sleep)(int ticks)
1897 \group kernel/ system
1900 \description Sleep a specified number of =ticks=, we have HZ ticks per second
1902 ssize_t PREFIX(write)(int fd, const void* buf, size_t count)
1909 \description Write writes up to =count= bytes to the file referenced by the file descriptor =fd= from the buffer starting at =buf=
1911 void profile_func_enter(void *this_fn, void *call_site)
1912 \conditions (defined(RB_PROFILE))
1917 void profile_func_exit(void *this_fn, void *call_site)
1918 \conditions (defined(RB_PROFILE))
1923 void profile_thread(void)
1924 \conditions (defined(RB_PROFILE))
1928 \conditions (defined(RB_PROFILE))
1931 void qsort(void *base, size_t nmemb, size_t size, int(*compar)(const void *, const void *))
1933 \param base start of array
1934 \param nmemb number of elements
1935 \param size describes the size of each element of the array
1937 \description qsort sorts an array (begining at =base=) of =nmemb= objects
1939 void queue_delete(struct event_queue *q)
1943 bool queue_empty(const struct event_queue *q)
1944 \conditions (CONFIG_CODEC == SWCODEC)
1949 void queue_enable_queue_send(struct event_queue *q, struct queue_sender_list *send, struct thread_entry *owner)
1950 \conditions (CONFIG_CODEC == SWCODEC)
1956 void queue_init(struct event_queue *q, bool register_queue)
1958 \param register_queue
1961 void queue_post(struct event_queue *q, long id, intptr_t data)
1967 void queue_reply(struct event_queue *q, intptr_t retval)
1968 \conditions (CONFIG_CODEC == SWCODEC)
1973 intptr_t queue_send(struct event_queue *q, long id, intptr_t data)
1974 \conditions (CONFIG_CODEC == SWCODEC)
1981 void queue_wait(struct event_queue *q, struct queue_event *ev)
1982 \conditions (CONFIG_CODEC == SWCODEC)
1987 void queue_wait_w_tmo(struct event_queue *q, struct queue_event *ev, int ticks)
1995 \return a pseudo random number between 0 and 0x7fffffff
1998 struct dirent* readdir(DIR* dir)
2001 \return a pointer to a dirent structure representing the next directory entry in the directory stream pointed to by =dir= or NULL on reaching the end-of-file or if an error occurred
2004 int read_bmp_file(const char* filename, struct bitmap *bm, int maxsize, int format)
2005 \conditions (defined(HAVE_LCD_BITMAP))
2013 int read_line(int fd, char* buffer, int buffer_size)
2018 \return number of bytes read (which may be larger than the number of bytes stored in buffer) or upon error -1 (and buffer contains whatever could be read)
2019 \description Read (up to) a line of text from =fd= into =buffer=. A line is terminated by a LF char. Neither LF nor CR chars are stored in buffer.
2021 void register_ata_idle_func(ata_idle_notify function)
2023 \conditions (USING_ATA_CALLBACK)
2027 void reload_directory(void)
2031 void remote_backlight_off(void)
2032 \conditions (defined(HAVE_REMOTE_LCD))
2033 \description Turns the remote backlight off
2035 void remote_backlight_on(void)
2036 \conditions (defined(HAVE_REMOTE_LCD))
2037 \description Turns the remote backlight on
2039 void remote_backlight_set_timeout(int index)
2040 \conditions (defined(HAVE_REMOTE_LCD))
2044 void remote_backlight_set_timeout_plugged(int index)
2045 \conditions (defined(HAVE_REMOTE_LCD)) && (CONFIG_CHARGING)
2049 void reset_poweroff_timer(void)
2050 \description The function name pretty much says what it's supposed to do
2052 int rmdir(const char *name)
2058 struct screen* screens[NB_SCREENS]
2062 void screen_clear_area(struct screen * display, int xstart, int ystart, int width, int height)
2063 \conditions !defined(HAVE_LCD_CHARCELLS)
2071 void screen_dump_set_hook(void (*hook)(int fh))
2072 \conditions (defined(HAVE_LCD_BITMAP))
2076 bool search_albumart_files(const struct mp3entry *id3, const char *size_string, char *buf, int buflen)
2077 \conditions (defined(HAVE_ALBUMART))
2080 \param buf Pointer to output
2081 \param buflen Max length for =buf=
2082 \return true if an album art was found
2083 \description Searches the the album art file for the given =id3= struct, appending the =size_string= to the search pattern (cover.bmp). It writes the complete path into =buf=, but not more bytes than =buflen=.
2085 void semaphore_init(struct semaphore *s, int max, int start)
2086 \conditions (defined(HAVE_SEMAPHORE_OBJECTS))
2092 void semaphore_release(struct semaphore *s)
2093 \conditions (defined(HAVE_SEMAPHORE_OBJECTS))
2097 void semaphore_wait(struct semaphore *s)
2098 \conditions (defined(HAVE_SEMAPHORE_OBJECTS))
2102 const struct settings_list* find_setting(const void* variable, int *id)
2109 bool settings_parseline(char* line, char** name, char** value)
2114 \return false if no valid config entry was found
2115 \description Parse a line from a configuration file. The line format is: 'name: value'. Any whitespace before setting name or value (after ':') is ignored. A # as first non-whitespace character discards the whole line. Function sets pointers to null-terminated setting name and value.
2117 bool set_bool(const char* string, const bool* variable )
2124 bool set_bool_options(const char* string, const bool* variable, const char* yes_str, int yes_voice, const char* no_str, int no_voice, void (*function)(bool))
2136 bool set_color(struct screen *display, char *title, unsigned *color, unsigned banned_color)
2137 \conditions (defined(HAVE_LCD_COLOR))
2145 void set_current_file(char* path)
2149 void set_dirfilter(int l_dirfilter)
2153 bool set_int(const unsigned char* string, const char* unit, int voice_unit, const int* variable, void (*function)(int), int step, int min, int max, void (*formatter)(char*, size_t, int, const char*) )
2167 bool set_option(const char* string, const void* variable, enum optiontype type, const struct opt_items* options, int numoptions, void (*function)(int))
2178 int set_time(const struct tm *tm)
2181 \return FALSE upon success
2182 \description Set current time
2189 void simplelist_info_init(struct simplelist_info *info, char* title, int count, void* data)
2197 bool simplelist_show_list(struct simplelist_info *info)
2203 void sim_lcd_ex_init(int shades, unsigned long (*getpixel)(int, int))
2204 \group special simulator hooks
2205 \conditions (defined(SIMULATOR)) && (defined(HAVE_LCD_BITMAP) && LCD_DEPTH < 8)
2210 void sim_lcd_ex_update_rect(int x, int y, int width, int height)
2211 \group special simulator hooks
2212 \conditions (defined(SIMULATOR)) && (defined(HAVE_LCD_BITMAP) && LCD_DEPTH < 8)
2219 int snprintf(char *buf, size_t size, const char *fmt, ...) ATTRIBUTE_PRINTF(3, 4)
2220 \group strings and memory
2224 \return the number of characters printed or that would have been printed if the output was truncated (not including the trailing NULL character) upon success
2225 \description Write a formatted string =fmt= in buffer =buf= of size =size= (including the trailing NULL character). These support %c, %s, %d and %x only with the width and zero padding flag only.
2227 int sound_default(int setting)
2233 int sound_max(int setting)
2239 int sound_min(int setting)
2245 void sound_set(int setting, int value)
2251 void sound_set_pitch(int pitch)
2252 \group playback control
2253 \conditions ((CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F) || (CONFIG_CODEC == SWCODEC))
2257 const char * sound_unit(int setting)
2263 int sound_val2phys(int setting, int value)
2270 void splash(int ticks, const char *str)
2273 \description Display a formatted string in a box for =ticks= time. The string is formatted as with the printf function. (there are =HZ= ticks per second)
2275 void splashf(int ticks, const char *fmt, ...) ATTRIBUTE_PRINTF(2, 3)
2280 void srand(unsigned int seed)
2283 \description Seed the random number generator
2285 struct gui_syncstatusbar *statusbars
2290 int strcasecmp(const char *, const char *)
2291 \group strings and memory
2294 \return an integer less than, equal to, or greater than zero if s1 is found, respectively, to be less than, to match, or be greater than s2
2295 \description The strcasecmp() function compares the two strings s1 and s2, ignoring the case of the characters
2297 char *strcat(char *s1, const char *s2)
2298 \group strings and memory
2301 \return =s1= concatenated with =s2=
2302 \description Appends =s2= to =s1=, replacing the NULL terminating character of =s1= and returns it
2304 char *strchr(const char *s, int c)
2305 \group strings and memory
2311 int strcmp(const char *, const char *)
2312 \group strings and memory
2316 \description strcmp() compares the string a to string b. If a sorts lexicographically after b, strcmp returns a number greater than zero. If the two strings match, strcmp returns zero. If a sorts lexicographically before b, strcmp returns a number less than zero.
2318 char* strcpy(char *dst, const char *src)
2319 \group strings and memory
2322 \return the initial value of =dst=
2323 \description strcpy() copies the string pointed to by =src= (including the terminating null character) to the array pointed to by =dst=
2325 size_t strlen(const char *str)
2326 \group strings and memory
2328 \return the character count
2329 \description The strlen() function works out the length of the string starting at =str= by counting characters until it reaches a null character.
2331 int strncasecmp(const char *s1, const char *s2, size_t n)
2332 \group strings and memory
2337 \description Like strcasecmp() but only on the first =n= characters
2340 int strncmp(const char *, const char *, size_t)
2341 \group strings and memory
2348 char* strncpy(char *dst, const char *src, size_t length)
2349 \group strings and memory
2353 \return the initial value of =dst=
2354 \description strncpy() copies not more than =length= characters from the string pointed to by =src= (including the terminating null character) to the array pointed to by =dst=. If the string pointed to by =src= is shorter than length characters, null characters are appended to the destination array until a total of =length= characters have been written.
2356 char * strrchr(const char *s, int c)
2357 \group strings and memory
2360 \return a pointer to the located character, or a null pointer if =c= does not occur in string.
2361 \description This function finds the last occurence of =c= (converted to a char) in the string pointed to by string (including the terminating null character)
2363 char* strtok_r(char *ptr, const char *sep, char **end)
2364 \group strings and memory
2371 int system_memory_guard(int newmode)
2372 \conditions (!defined(SIMULATOR))
2377 bool tagcache_get_next(struct tagcache_search *tcs)
2378 \conditions (defined(HAVE_TAGCACHE))
2383 long tagcache_get_numeric(const struct tagcache_search *tcs, int tag)
2384 \conditions (defined(HAVE_TAGCACHE))
2390 bool tagcache_retrieve(struct tagcache_search *tcs, int idxid, int tag, char *buf, long size)
2391 \conditions (defined(HAVE_TAGCACHE))
2400 bool tagcache_search(struct tagcache_search *tcs, int tag)
2401 \conditions (defined(HAVE_TAGCACHE))
2407 bool tagcache_search_add_filter(struct tagcache_search *tcs, int tag, int seek)
2408 \conditions (defined(HAVE_TAGCACHE))
2415 void tagcache_search_finish(struct tagcache_search *tcs)
2416 \conditions (defined(HAVE_TAGCACHE))
2420 void tagcache_search_set_uniqbuf(struct tagcache_search *tcs, void *buffer, long length)
2421 \conditions (defined(HAVE_TAGCACHE))
2427 void talk_disable(bool disable)
2432 struct thread_entry* threads
2433 \group kernel/ system
2437 void thread_exit(void)
2438 \group kernel/ system
2441 void thread_thaw(struct thread_entry *thread)
2445 void thread_wait(struct thread_entry *thread)
2446 \group kernel/ system
2450 bool timer_register(int reg_prio, void (*unregister_callback)(void), long cycles, int int_prio, void (*timer_callback)(void) IF_COP(, int core))
2452 \param unregister_callback
2456 \param timer_callback
2460 bool timer_set_period(long count)
2465 void timer_unregister(void)
2468 void touchscreen_set_mode(enum touchscreen_mode)
2470 \conditions (defined(HAVE_TOUCHSCREEN))
2471 \param touchscreen_mode
2474 struct tree_context* tree_get_context(void)
2478 void trigger_cpu_boost(void)
2479 \conditions (defined(HAVE_SCHEDULER_BOOSTCTRL))
2480 \description Boosts the CPU for the current thread
2482 void unregister_ata_idle_func(ata_idle_notify function, bool run)
2484 \conditions (USING_ATA_CALLBACK)
2489 void usb_acknowledge(long id)
2493 bool usb_powered(void)
2495 \conditions (defined(HAVE_USB_POWER))
2499 unsigned char* utf8encode(unsigned long ucs, unsigned char *utf8)
2500 \group unicode stuff
2506 unsigned long utf8length(const unsigned char *utf8)
2507 \group unicode stuff
2512 int utf8seek(const unsigned char* utf8, int offset)
2513 \group unicode stuff
2519 unsigned char* utf16BEdecode(const unsigned char *utf16, unsigned char *utf8, int count)
2520 \group unicode stuff
2527 unsigned char* utf16LEdecode(const unsigned char *utf16, unsigned char *utf8, int count)
2528 \group unicode stuff
2535 void viewport_set_defaults(struct viewport *vp, enum screen_type screen)
2540 int vsnprintf(char *buf, int size, const char *fmt, va_list ap)
2541 \group strings and memory
2549 void wheel_send_events(bool send)
2550 \conditions (defined(HAVE_WHEEL_POSITION))
2554 int wheel_status(void)
2555 \conditions (defined(HAVE_WHEEL_POSITION))
2560 \group kernel/ system
2561 \description Let another thread run. This should be used as soon as you have to "wait" for something or similar, and also if you do anything that takes "a long time". This function is the entire foundation that our "cooperative multitasking" is based on. Use it!
2562 \see [W[RockboxKernel]]