tsiry-sandratraina.com / rockbox-zig
A modern Music Player Daemon based on Rockbox open source high quality audio player
libadwaita audio rust zig deno mpris rockbox mpd
fork atom
rockbox-zig / docs / PLUGIN_API
at master 3144 lines 81 kB view raw
1# Auto generated documentation by Rockbox plugin API generator v2 2# Made by Maurus Cuelenaere 3# __________ __ ___. 4# Open \______ \ ____ ____ | | _\_ |__ _______ ___ 5# Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ / 6# Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < < 7# Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \ 8# \/ \/ \/ \/ \/ 9# $Id$ 10# 11# Generated from https://git.rockbox.org/cgit/rockbox.git/aapps/plugin.h 12# 13# Format: 14# \group memory and strings 15# \conditions defined(HAVE_BACKLIGHT) 16# \param fmt 17# \return 18# \description 19# \see func1 func2 [S[apps/plugin.c]] 20# 21# Markup: 22# [W[wiki url]] 23# [S[svn url]] 24# [F[function]] 25# [[url]] 26# %BR% 27# =code= 28 29char *strcasestr (const char* phaystack, const char* pneedle) 30 \group strings and memory 31 \param phaystack 32 \param pneedle 33 \return 34 \description 35 36unsigned char **language_strings 37 \return 38 \description 39 40int action_get_touchscreen_press(short *x, short *y) 41 \group action handling 42 \conditions (defined(HAVE_TOUCHSCREEN)) 43 \param x 44 \param y 45 \return 46 \description 47 48int action_get_touchscreen_press_in_vp(short *x1, short *y1, struct viewport *vp) 49 \group action handling 50 \conditions (defined(HAVE_TOUCHSCREEN)) 51 \param x1 52 \param y1 53 \param vp 54 \return 55 \description 56 57bool action_userabort(int timeout) 58 \group action handling 59 \param timeout 60 \return 61 \description 62 63bool add_event(unsigned short id, void (*handler)(unsigned short id, void *data)) 64 \group event api 65 \param id 66 \param handler 67 \return 68 \description 69 70void add_playbacklog(struct mp3entry *id3) 71 \group new stuff at the end, sort into place next time the API gets incompatible 72 \param id3 73 \description 74 75void adjust_volume(int steps) 76 \group sound 77 \param steps 78 \description 79 80int atoi(const char *str) 81 \group strings and memory 82 \param str 83 \return 84 \description he atoi() function converts the initial portion of a string pointed to by str to int 85 86struct mp3entry* audio_current_track(void) 87 \group playback control 88 \return the mp3entry struct of the currently playing track 89 \description 90 \see [S[firmware/export/id3.h]] 91 92void audio_ff_rewind(long newtime) 93 \group playback control 94 \param newtime 95 \description 96 97void audio_flush_and_reload_tracks(void) 98 \group playback control 99 \description 100 101int audio_get_file_pos(void) 102 \group playback control 103 \return 104 \description 105 106void audio_hard_stop(void) 107 \group playback control 108 \conditions (defined(PLUGIN_USE_IRAM)) 109 \description 110 111void audio_next(void) 112 \group playback control 113 \description 114 115struct mp3entry* audio_next_track(void) 116 \group playback control 117 \return the mp3entry struct of the upcoming track 118 \description 119 \see [S[firmware/export/id3.h]] 120 121void audio_pause(void) 122 \group playback control 123 \description 124 125void audio_play(unsigned long elapsed, unsigned long offset) 126 \group playback control 127 \param elapsed 128 \param offset 129 \description 130 131void audio_prev(void) 132 \group playback control 133 \description 134 135void audio_resume(void) 136 \group playback control 137 \description 138 139void audio_set_input_source(int source, unsigned flags) 140 \group sound 141 \conditions (INPUT_SRC_CAPS != 0) 142 \param source 143 \param flags 144 \description 145 146void audio_set_output_source(int monitor) 147 \group sound 148 \conditions (INPUT_SRC_CAPS != 0) 149 \param monitor 150 \description 151 152void audio_set_recording_gain(int left, int right, int type) 153 \group sound 154 \conditions (defined(HAVE_RECORDING)) 155 \param left 156 \param right 157 \param type 158 \description 159 160int audio_status(void) 161 \group playback control 162 \return 163 \description 164 165void audio_stop(void) 166 \group playback control 167 \description 168 169void backlight_off(void) 170 \group For OLED targets like the Sansa Clip, the backlight_* functions control * the display enable, which has essentially the same effect. 171 \conditions (defined(HAVE_BACKLIGHT)) 172 \description Turns the backlight off 173 174void backlight_on(void) 175 \group For OLED targets like the Sansa Clip, the backlight_* functions control * the display enable, which has essentially the same effect. 176 \conditions (defined(HAVE_BACKLIGHT)) 177 \description Turns the backlight on 178 179void backlight_set_brightness(int val) 180 \group For OLED targets like the Sansa Clip, the backlight_* functions control * the display enable, which has essentially the same effect. 181 \conditions (defined(HAVE_BACKLIGHT)) && (defined(HAVE_BACKLIGHT_BRIGHTNESS)) 182 \param val 183 \description 184 185void backlight_set_timeout(int index) 186 \group For OLED targets like the Sansa Clip, the backlight_* functions control * the display enable, which has essentially the same effect. 187 \conditions (defined(HAVE_BACKLIGHT)) 188 \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 189 \description Set the backlight timeout 190 191void backlight_set_timeout_plugged(int index) 192 \conditions (defined(HAVE_BACKLIGHT)) && (CONFIG_CHARGING) 193 \param index 194 \description 195 196int battery_current(void) 197 \group power 198 \return 199 \description 200 201int battery_level(void) 202 \group power 203 \return battery level in percent 204 \description On the simulator, battery_level is always 75 205 206bool battery_level_safe(void) 207 \group power 208 \return 209 \description 210 211int battery_time(void) 212 \group power 213 \return 214 \description 215 216int battery_voltage(void) 217 \group power 218 \return 219 \description 220 221void beep_play(unsigned int frequency, unsigned int duration, unsigned int amplitude) 222 \group sound 223 \param frequency 224 \param duration 225 \param amplitude 226 \description 227 228ucschar_t *bidi_l2v( const unsigned char *str, int orientation ) 229 \param str 230 \param orientation 231 \return 232 \description 233 234bool browse_id3(struct mp3entry *id3, int playlist_display_index, int playlist_amount, struct tm *modified, int track_ct, int (*view_text)(const char *title, const char *text)) 235 \param id3 236 \param playlist_display_index 237 \param playlist_amount 238 \param modified 239 \param track_ct 240 \param view_text 241 \return 242 \description 243 244int buflib_alloc(struct buflib_context* ctx, size_t size) 245 \group the buflib memory management library 246 \param ctx 247 \param size 248 \return 249 \description 250 251int buflib_alloc_ex(struct buflib_context* ctx, size_t size, struct buflib_callbacks *ops) 252 \group the buflib memory management library 253 \param ctx 254 \param size 255 \param ops 256 \return 257 \description 258 259int buflib_alloc_maximum(struct buflib_context* ctx, size_t* size, struct buflib_callbacks *ops) 260 \group the buflib memory management library 261 \param ctx 262 \param size 263 \param ops 264 \return 265 \description 266 267size_t buflib_available(struct buflib_context* ctx) 268 \group the buflib memory management library 269 \param ctx 270 \return 271 \description 272 273void buflib_buffer_in(struct buflib_context* ctx, int size) 274 \group the buflib memory management library 275 \param ctx 276 \param size 277 \description 278 279void* buflib_buffer_out(struct buflib_context* ctx, size_t* size) 280 \group the buflib memory management library 281 \param ctx 282 \param size 283 \return 284 \description 285 286int buflib_free(struct buflib_context* ctx, int handle) 287 \group the buflib memory management library 288 \param ctx 289 \param handle 290 \return 291 \description 292 293void* buflib_get_data(struct buflib_context* ctx, int handle) 294 \group the buflib memory management library 295 \param ctx 296 \param handle 297 \return 298 \description 299 300void buflib_init(struct buflib_context* ctx, void* buf, size_t size) 301 \group the buflib memory management library 302 \param ctx 303 \param buf 304 \param size 305 \description 306 307bool buflib_shrink(struct buflib_context* ctx, int handle, void* new_start, size_t new_size) 308 \group the buflib memory management library 309 \param ctx 310 \param handle 311 \param new_start 312 \param new_size 313 \return 314 \description 315 316void buttonlight_off(void) 317 \group button 318 \conditions (defined(HAVE_BUTTON_LIGHT)) 319 \description 320 321void buttonlight_on(void) 322 \group button 323 \conditions (defined(HAVE_BUTTON_LIGHT)) 324 \description 325 326void buttonlight_set_brightness(int val) 327 \group button 328 \conditions (defined(HAVE_BUTTON_LIGHT)) && (defined(HAVE_BUTTONLIGHT_BRIGHTNESS)) 329 \param val 330 \description 331 332void buttonlight_set_timeout(int value) 333 \group button 334 \conditions (defined(HAVE_BUTTON_LIGHT)) 335 \param value 336 \description 337 338void button_clear_queue(void) 339 \group button 340 \description Empty the button queue 341 342long button_get(bool block) 343 \group button 344 \param block If is set TRUE, button_get won't return until a key is pressed 345 \return a bitmask for which keys were pressed 346 \description 347 348intptr_t button_get_data(void) 349 \group button 350 \conditions (defined(HAVE_BUTTON_DATA)) 351 \return 352 \description 353 354bool button_get_sw_poweroff_state(void) 355 \group button 356 \conditions (defined(HAVE_SW_POWEROFF)) 357 \return 358 \description 359 360long button_get_w_tmo(int ticks) 361 \group button 362 \param ticks 363 \return a bitmask for which keys were pressed; if no key was pressed, return BUTTON_NONE 364 \description Wait for a key press for =ticks= ticks. (there are HZ ticks per second) 365 366bool button_hold(void) 367 \group button 368 \conditions (defined(HAS_BUTTON_HOLD)) 369 \return 370 \description 371 372int button_queue_count(void) 373 \group button 374 \return 375 \description 376 377void button_queue_post(long id, intptr_t data) 378 \conditions (defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)) 379 \param id 380 \param data 381 \description 382 383void button_set_sw_poweroff_state(bool enable) 384 \group button 385 \conditions (defined(HAVE_SW_POWEROFF)) 386 \param enable 387 \description 388 389int button_status(void) 390 \group button 391 \return a bitmask for which keys are currently pressed 392 \description 393 394int button_status_wdata(int *pdata) 395 \group button 396 \conditions (defined(HAVE_BUTTON_DATA)) 397 \param pdata 398 \return 399 \description 400 401void cancel_cpu_boost(void) 402 \group kernel/ system 403 \conditions (defined(HAVE_SCHEDULER_BOOSTCTRL)) 404 \description Unboosts the CPU for the current thread 405 406const struct cbmp_bitmap_info_entry *core_bitmaps 407 \return 408 \description 409 410const unsigned char *font_get_bits( struct font *pf, ucschar_t char_code ) 411 \param pf 412 \param char_code 413 \return 414 \description 415 416const unsigned char* utf8decode(const unsigned char *utf8, ucschar_t *ucs) 417 \group unicode stuff 418 \param utf8 419 \param ucs 420 \return 421 \description 422 423const unsigned char *_rbctype_ 424 \group strings and memory 425 \conditions ((CONFIG_PLATFORM & PLATFORM_NATIVE)) 426 \return 427 \description 428 429bool charger_inserted(void) 430 \group power 431 \conditions (CONFIG_CHARGING) 432 \return 433 \description 434 435bool charging_state(void) 436 \group power 437 \conditions (CONFIG_CHARGING) && (CONFIG_CHARGING >= CHARGING_MONITOR) 438 \return 439 \description 440 441int closedir(DIR* dirp) 442 \group dir 443 \param dir 444 \return 445 \description The closedir() function closes the directory stream associated with =dir=. The directory stream descriptor dir is not available after this call. 446 447int codec_close(void) 448 \group misc 449 \return 450 \description 451 452int codec_load_file(const char* codec, struct codec_api *api) 453 \group misc 454 \param codec 455 \param api 456 \return 457 \description 458 459int codec_run_proc(void) 460 \group misc 461 \return 462 \description 463 464void codec_thread_do_callback(void (*fn)(void), unsigned int *audio_thread_id) 465 \group misc 466 \param fn 467 \param audio_thread_id 468 \description 469 470void commit_dcache(void) 471 \description 472 473void commit_discard_dcache(void) 474 \description 475 476void commit_discard_idcache(void) 477 \description 478 479int core_set_keyremap(struct button_mapping* core_keymap, int count) 480 \group action handling 481 \param core_keymap 482 \param count 483 \return 484 \description 485 486int count_mp3_frames(int fd, int startpos, int filesize, void (*progressfunc)(int), unsigned char* buf, size_t buflen) 487 \group metadata 488 \param fd 489 \param startpos 490 \param filesize 491 \param progressfunc 492 \param buf 493 \param buflen 494 \return 495 \description 496 497void cpu_boost(bool on_off) 498 \group kernel/ system 499 \conditions ((CONFIG_PLATFORM & PLATFORM_NATIVE)) && (defined(HAVE_ADJUSTABLE_CPU_FREQ)) && (!( defined(CPU_BOOST_LOGGING) )) 500 \param on_off 501 \description Boosts the CPU if =on_off= is true, otherwise it unboosts the CPU 502 503void cpu_boost_(bool on_off,char*location,int line) 504 \group kernel/ system 505 \conditions ((CONFIG_PLATFORM & PLATFORM_NATIVE)) && (defined(HAVE_ADJUSTABLE_CPU_FREQ)) && (defined(CPU_BOOST_LOGGING)) 506 \param on_off 507 \param charlocation 508 \param line 509 \description 510 511long *cpu_frequency 512 \group kernel/ system 513 \conditions ((CONFIG_PLATFORM & PLATFORM_NATIVE)) 514 \return the current cpu frequency 515 \description 516 517uint32_t crc_32(const void *src, uint32_t len, uint32_t crc32) 518 \group file 519 \param src 520 \param len 521 \param crc32 522 \return 523 \description 524 525uint32_t crc_32r(const void *src, uint32_t len, uint32_t crc32) 526 \group file 527 \param src 528 \param len 529 \param crc32 530 \return 531 \description 532 533char *create_numbered_filename(char *buffer, const char *path, const char *prefix, const char *suffix, int numberlen IF_CNFN_NUM_(, int *num)) 534 \group file 535 \param buffer 536 \param path 537 \param prefix 538 \param suffix 539 \param num 540 \param numberlen 541 \return 542 \description 543 544unsigned int 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)) 545 \group kernel/ system 546 \param function 547 \param stack 548 \param stack_size 549 \param flags 550 \param priority 551 \param core 552 \param name 553 \description Creates a thread 554 \return its ID if context area could be allocated, else return -1 555 556int 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, unsigned char* tempbuf, size_t tempbuf_len) 557 \group metadata 558 \param fd 559 \param startpos 560 \param filesize 561 \param buf 562 \param num_frames 563 \param rec_time 564 \param header_template 565 \param progressfunc 566 \param generate_toc 567 \param tempbuf 568 \param tempbuf_len 569 \return 570 \description 571 572volatile long* current_tick 573 \group kernel/ system 574 \return 575 \description 576 577void debugf(const char *fmt, ...) ATTRIBUTE_PRINTF(1, 2) 578 \group misc 579 \conditions (defined(DEBUG) || defined(SIMULATOR)) 580 \param fmt 581 \description Prints =fmt= in a printf-like fashion to STDERR 582 583long default_event_handler(long event) 584 \group kernel/ system 585 \param event 586 \return SYS_USB_CONNECTED and call usb_screen() if =event= equals to SYS_USB_CONNECTED, else do nothing and return 0 587 \description 588 589long default_event_handler_ex(long event, void (*callback)(void *), void *parameter) 590 \group kernel/ system 591 \param event 592 \param callback 593 \param parameter 594 \return 595 \description 596 597bool detect_flashed_ramimage(void) 598 \group Routines for the iriver_flash -plugin. 599 \conditions (defined(IRIVER_H100_SERIES) || defined(IRIVER_H300_SERIES)) 600 \return 601 \description 602 603bool detect_flashed_romimage(void) 604 \group Routines for the iriver_flash -plugin. 605 \conditions (defined(IRIVER_H100_SERIES) || defined(IRIVER_H300_SERIES)) 606 \return 607 \description 608 609bool detect_original_firmware(void) 610 \group Routines for the iriver_flash -plugin. 611 \conditions (defined(IRIVER_H100_SERIES) || defined(IRIVER_H300_SERIES)) 612 \return 613 \description 614 615bool dir_exists(const char *dirname) 616 \group dir 617 \param dirname 618 \return 619 \description 620 621struct dirinfo dir_get_info(DIR *dirp, struct dirent *entry) 622 \group dir 623 \param dirp 624 \param entry 625 \return 626 \description 627 628int do_menu(const struct menu_item_ex *menu, int *start_selected, struct viewport parent[NB_SCREENS], bool hide_theme) 629 \group menu 630 \param menu 631 \param start_selected 632 \param parent[NB_SCREENS] 633 \param hide_theme 634 \return 635 \description 636 637intptr_t dsp_configure(struct dsp_config *dsp, unsigned int setting, intptr_t value) 638 \group sound 639 \param dsp 640 \param setting 641 \param value 642 \return 643 \description 644 645void dsp_dither_enable(bool enable) 646 \group sound 647 \param enable 648 \description 649 650void dsp_eq_enable(bool enable) 651 \group sound 652 \param enable 653 \description 654 655struct dsp_config * dsp_get_config(unsigned int dsp_id) 656 \group sound 657 \param dsp_id 658 \return 659 \description 660 661int32_t dsp_get_timestretch(void) 662 \group sound 663 \conditions (defined(HAVE_PITCHCONTROL)) 664 \return 665 \description 666 667void dsp_process(struct dsp_config *dsp, struct dsp_buffer *src, struct dsp_buffer *dst, bool thread_yield) 668 \group sound 669 \param dsp 670 \param src 671 \param dst 672 \param thread_yield 673 \description 674 675void dsp_set_crossfeed_type(int type) 676 \group sound 677 \param type 678 \description 679 680void dsp_set_timestretch(int32_t percent) 681 \group sound 682 \conditions (defined(HAVE_PITCHCONTROL)) 683 \param percent 684 \description 685 686bool dsp_timestretch_available(void) 687 \group sound 688 \conditions (defined(HAVE_PITCHCONTROL)) 689 \return 690 \description 691 692void dsp_timestretch_enable(bool enabled) 693 \group sound 694 \conditions (defined(HAVE_PITCHCONTROL)) 695 \param enabled 696 \description 697 698int fdprintf(int fildes, const char *fmt, ...) ATTRIBUTE_PRINTF(2, 3) 699 \group file 700 \param fildes 701 \param fmt 702 \return number of characters writen to =fd= or a negative value upon error 703 \description Write a formated string in the =fd= 704 705int filetype_get_attr(const char* file) 706 \param file 707 \return 708 \description 709 710char* filetype_get_plugin(int attr, char *buffer, size_t buffer_len) 711 \param attr 712 \param buffer 713 \param buffer_len 714 \return 715 \description 716 717bool file_exists(const char *path) 718 \group file 719 \param path 720 \return 721 \description 722 723void ** find_array_ptr(void **arr, void *ptr) 724 \group misc 725 \param arr 726 \param ptr 727 \return 728 \description 729 730void fix_path_part(char* path, int offset, int count) 731 \group pathfuncs 732 \param path 733 \param offset 734 \param count 735 \description 736 737struct font* font_get(int font) 738 \param font 739 \return the font structure for =font= 740 \description If the requested font isn't loaded/compiled-in, decrement the font number and try again. 741 \see [S[firmware/export/font.h]] 742 743int font_getstringsize(const unsigned char *str, int *w, int *h, int fontnumber) 744 \param str 745 \param w 746 \param h 747 \param fontnumber 748 \return 749 \description 750 751int font_get_width(struct font* pf, ucschar_t char_code) 752 \param pf 753 \param char_code 754 \return 755 \description 756 757int font_load(const char *path) 758 \param path 759 \description Load font =path= 760 \return returns ID or -1 if failed 761 \see [S[firmware/export/font.h]] 762 763void font_unload(int font_id) 764 \param font_id 765 \description 766 767const char* format_time_auto(char *buffer, int buf_len, long value, int unit_idx, bool supress_unit) 768 \group misc 769 \param buffer 770 \param buf_len 771 \param value 772 \param unit_idx 773 \param supress_unit 774 \return 775 \description 776 777int ftruncate(int fildes, off_t length) 778 \group file 779 \param fildes 780 \param length 781 \return 782 \description 783 784int get_action(int context, int timeout) 785 \group action handling 786 \param context 787 \param timeout 788 \return 789 \description 790 791const char *get_codec_filename(int cod_spec) 792 \group misc 793 \param cod_spec 794 \return 795 \description 796 797const char* get_codec_string(int codectype) 798 \group metadata 799 \param codectype 800 \return 801 \description 802 803const char* get_codepage_name(int cp) 804 \param cp 805 \return 806 \description 807 808int get_custom_action(int context,int timeout, const struct button_mapping* (*get_context_map)(int)) 809 \group action handling 810 \param context 811 \param timeout 812 \param get_context_map 813 \return 814 \description 815 816bool get_metadata(struct mp3entry* id3, int fd, const char* trackname) 817 \group metadata 818 \param id3 819 \param fd 820 \param trackname 821 \return 822 \description 823 824int get_sleep_timer(void) 825 \group kernel/ system 826 \return 827 \description 828 829struct tm* get_time(void) 830 \group misc 831 \return current time 832 \description 833 \see [S[firmware/include/time.h]] 834 835struct user_settings* global_settings 836 \group misc 837 \return the global_settings struct 838 \description 839 \see [S[apps/settings.h]] 840 841struct system_status *global_status 842 \group misc 843 \return the global_status struct 844 \description 845 \see [S[apps/settings.h]] 846 847struct tm * gmtime_r(const time_t *timep, struct tm *tm) 848 \group misc 849 \param timep 850 \param tm 851 \return 852 \description 853 854void gui_scrollbar_draw(struct screen * screen, int x, int y, int width, int height, int items, int min_shown, int max_shown, unsigned flags) 855 \param screen 856 \param x 857 \param y 858 \param width 859 \param height 860 \param items 861 \param min_shown 862 \param max_shown 863 \param flags 864 \description 865 866void gui_synclist_add_item(struct gui_synclist * lists) 867 \group list 868 \param lists 869 \description 870 871void gui_synclist_del_item(struct gui_synclist * lists) 872 \group list 873 \param lists 874 \description 875 876bool gui_synclist_do_button(struct gui_synclist * lists, int *action) 877 \group list 878 \param lists 879 \param action 880 \return 881 \description 882 883void gui_synclist_draw(struct gui_synclist * lists) 884 \group list 885 \param lists 886 \description 887 888int gui_synclist_get_nb_items(struct gui_synclist * lists) 889 \group list 890 \param lists 891 \return 892 \description 893 894int gui_synclist_get_sel_pos(struct gui_synclist * lists) 895 \group list 896 \param lists 897 \return 898 \description 899 900void 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]) 901 \group list 902 \param lists 903 \param callback_get_item_name 904 \param data 905 \param scroll_all 906 \param selected_size 907 \param parent[NB_SCREENS] 908 \description 909 910void gui_synclist_select_item(struct gui_synclist * lists, int item_number) 911 \group list 912 \param lists 913 \param item_number 914 \description 915 916void gui_synclist_set_icon_callback(struct gui_synclist * lists, list_get_icon icon_callback) 917 \group list 918 \param lists 919 \param icon_callback 920 \description 921 922void gui_synclist_set_nb_items(struct gui_synclist * lists, int nb_items) 923 \group list 924 \param lists 925 \param nb_items 926 \description 927 928void gui_synclist_set_title(struct gui_synclist *lists, const char* title, enum themable_icons icon) 929 \group list 930 \param lists 931 \param title 932 \param icon 933 \description 934 935void gui_synclist_set_voice_callback(struct gui_synclist * lists, list_speak_item voice_callback) 936 \group list 937 \param lists 938 \param voice_callback 939 \description 940 941void gui_synclist_speak_item(struct gui_synclist * lists) 942 \group list 943 \param lists 944 \description 945 946enum yesno_res gui_syncyesno_run(const struct text_message * main_message, const struct text_message * yes_message, const struct text_message * no_message) 947 \group list 948 \param main_message 949 \param yes_message 950 \param no_message 951 \return 952 \description 953 954unsigned char* iso_decode(const unsigned char *iso, unsigned char *utf8, int cp, int count) 955 \group unicode stuff 956 \param iso 957 \param utf8 958 \param cp 959 \param count 960 \return 961 \description 962 963bool is_backlight_on(bool ignore_always_off) 964 \group For OLED targets like the Sansa Clip, the backlight_* functions control * the display enable, which has essentially the same effect. 965 \conditions (defined(HAVE_BACKLIGHT)) 966 \param ignore_always_off 967 \return 968 \description 969 970bool is_diacritic(const unsigned short char_code, bool *is_rtl) 971 \param char_code 972 \param is_rtl 973 \return 974 \description 975 976int kbd_input(char* buffer, int buflen, ucschar_t *kbd) 977 \group misc 978 \param buffer 979 \param buflen 980 \param *kbd 981 \return 0 upon success, negative upon failure 982 \description Prompt for a string to be stored in =buffer= which is of length =buflen= 983 984void keyclick_click(bool rawbutton, int action) 985 \param rawbutton 986 \param action 987 \description 988 989int lang_is_rtl(void) 990 \group language 991 \return 992 \description 993 994void lcd_bitmap(const fb_data *src, int x, int y, int width, int height) 995 \group lcd 996 \conditions (LCD_DEPTH > 1) 997 \param src 998 \param x 999 \param y 1000 \param width 1001 \param height 1002 \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. 1003 1004void lcd_bitmap_part(const fb_data *src, int src_x, int src_y, int stride, int x, int y, int width, int height) 1005 \group lcd 1006 \conditions (LCD_DEPTH > 1) 1007 \param src 1008 \param src_x 1009 \param src_y 1010 \param stride 1011 \param x 1012 \param y 1013 \param width 1014 \param height 1015 \description 1016 1017void lcd_bitmap_transparent(const fb_data *src, int x, int y, int width, int height) 1018 \group lcd 1019 \conditions (LCD_DEPTH >= 16) 1020 \param src 1021 \param x 1022 \param y 1023 \param width 1024 \param height 1025 \description 1026 1027void lcd_bitmap_transparent_part(const fb_data *src, int src_x, int src_y, int stride, int x, int y, int width, int height) 1028 \group lcd 1029 \conditions (LCD_DEPTH >= 16) 1030 \param src 1031 \param src_x 1032 \param src_y 1033 \param stride 1034 \param x 1035 \param y 1036 \param width 1037 \param height 1038 \description 1039 1040void lcd_blit_grey_phase(unsigned char *values, unsigned char *phases, int bx, int by, int bwidth, int bheight, int stride) 1041 \group lcd 1042 \conditions ((LCD_DEPTH < 4) && (CONFIG_PLATFORM & PLATFORM_NATIVE)) 1043 \param values 1044 \param phases 1045 \param bx 1046 \param by 1047 \param bwidth 1048 \param bheight 1049 \param stride 1050 \description 1051 1052void lcd_blit_mono(const unsigned char *data, int x, int by, int width, int bheight, int stride) 1053 \group lcd 1054 \conditions ((LCD_DEPTH < 4) && (CONFIG_PLATFORM & PLATFORM_NATIVE)) 1055 \param data 1056 \param x 1057 \param by 1058 \param width 1059 \param bheight 1060 \param stride 1061 \description 1062 1063void lcd_blit_pal256(unsigned char *src, int src_x, int src_y, int x, int y, int width, int height) 1064 \group lcd 1065 \conditions (defined(HAVE_LCD_MODES) && (HAVE_LCD_MODES & LCD_MODE_PAL256)) 1066 \param src 1067 \param src_x 1068 \param src_y 1069 \param x 1070 \param y 1071 \param width 1072 \param height 1073 \description 1074 1075void lcd_blit_yuv(unsigned char * const src[3], int src_x, int src_y, int stride, int x, int y, int width, int height) 1076 \group lcd 1077 \conditions (LCD_DEPTH >= 16) && (MEMORYSIZE > 2) 1078 \param src[3] 1079 \param src_x 1080 \param src_y 1081 \param stride 1082 \param x 1083 \param y 1084 \param width 1085 \param height 1086 \description 1087 1088void lcd_bmp_part(const struct bitmap *bm, int src_x, int src_y, int x, int y, int width, int height) 1089 \group lcd 1090 \param bm 1091 \param src_x 1092 \param src_y 1093 \param x 1094 \param y 1095 \param width 1096 \param height 1097 \description 1098 1099void lcd_clear_display(void) 1100 \group lcd 1101 \description Clears the LCD and the framebuffer 1102 1103void lcd_drawline(int x1, int y1, int x2, int y2) 1104 \group lcd 1105 \param x1 X top coordinate 1106 \param y1 Y top coordinate 1107 \param x2 X bottom coordinate 1108 \param y2 Y bottom coordinate 1109 \description Draws a line at (=x1=, =y1=) -> (=x2=, =y2=) within current drawing mode 1110 1111void lcd_drawpixel(int x, int y) 1112 \group lcd 1113 \param x 1114 \param y 1115 \description Draws a pixel at (=x=, =y=) within current drawing mode 1116 1117void lcd_drawrect(int x, int y, int width, int height) 1118 \group lcd 1119 \param x 1120 \param y 1121 \param width 1122 \param height 1123 \description Draws a rectangle at (=x=, =y=) -> (=x= + =width=, =y= + =height=) within current drawing mode 1124 1125void lcd_fillrect(int x, int y, int width, int height) 1126 \group lcd 1127 \param x 1128 \param y 1129 \param width 1130 \param height 1131 \description Draws a filled rectangle at (=x=, =y=) -> (=x= + =width=, =y= + =height=) within current drawing mode 1132 1133int lcd_getstringsize(const unsigned char *str, int *w, int *h) 1134 \group lcd 1135 \param str String 1136 \param w Width 1137 \param h Height 1138 \return Success or not 1139 \description Stores the width and height of the string in =w= and =h= 1140 1141fb_data* lcd_get_backdrop(void) 1142 \group lcd 1143 \conditions (LCD_DEPTH > 1) 1144 \return Pointer to framebuffer data 1145 \description Gets the current backdrop 1146 \see lcd_framebuffer 1147 1148unsigned lcd_get_background(void) 1149 \group lcd 1150 \conditions (LCD_DEPTH > 1) 1151 \return 1152 \description 1153 1154int lcd_get_drawmode(void) 1155 \group lcd 1156 \return current LCD drawing mode 1157 \description 1158 1159unsigned lcd_get_foreground(void) 1160 \group lcd 1161 \conditions (LCD_DEPTH > 1) 1162 \return 1163 \description 1164 1165void lcd_hline(int x1, int x2, int y) 1166 \group lcd 1167 \param x1 X start coordinate 1168 \param x2 X end coordinate 1169 \param y Y coordinate 1170 \description Draws a horizontal line at (=x1=, =y=) -> (=x2=, =y=) within current drawing mode 1171 1172void lcd_mono_bitmap(const unsigned char *src, int x, int y, int width, int height) 1173 \group lcd 1174 \param src 1175 \param x 1176 \param y 1177 \param width 1178 \param height 1179 \description 1180 1181void lcd_mono_bitmap_part(const unsigned char *src, int src_x, int src_y, int stride, int x, int y, int width, int height) 1182 \group lcd 1183 \param src 1184 \param src_x 1185 \param src_y 1186 \param stride 1187 \param x 1188 \param y 1189 \param width 1190 \param height 1191 \description 1192 1193void lcd_pal256_update_pal(fb_data *palette) 1194 \group lcd 1195 \conditions (defined(HAVE_LCD_MODES) && (HAVE_LCD_MODES & LCD_MODE_PAL256)) 1196 \param palette 1197 \description 1198 1199void lcd_puts(int x, int y, const unsigned char *string) 1200 \group lcd 1201 \param x Row X 1202 \param y Column Y 1203 \param string 1204 \description Puts string on the LCD at row =x= and column =y= 1205 1206void lcd_putsf(int x, int y, const unsigned char *fmt, ...) 1207 \group lcd 1208 \param x 1209 \param y 1210 \param fmt 1211 \description 1212 1213void lcd_putsxy(int x, int y, const unsigned char *string) 1214 \group lcd 1215 \param x X coordinate 1216 \param y Y coordinate 1217 \param string 1218 \description Puts string on the LCD at position (=x=, =y=) 1219 1220void lcd_putsxyf(int x, int y, const unsigned char *fmt, ...) 1221 \group lcd 1222 \param x 1223 \param y 1224 \param fmt 1225 \description 1226 1227bool lcd_puts_scroll(int x, int y, const unsigned char* string) 1228 \group lcd 1229 \param x Row X 1230 \param y Column Y 1231 \param string 1232 \return 1233 \description Puts scrolling string on the LCD at row =x= and column =y=. The scrolling style is STYLE_DEFAULT. 1234 1235void lcd_remote_bitmap(const fb_remote_data *src, int x, int y, int width, int height) 1236 \group remote lcd 1237 \conditions (defined(HAVE_REMOTE_LCD)) && ((LCD_REMOTE_DEPTH > 1)) 1238 \param src 1239 \param x 1240 \param y 1241 \param width 1242 \param height 1243 \description 1244 1245void 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) 1246 \group remote lcd 1247 \conditions (defined(HAVE_REMOTE_LCD)) && ((LCD_REMOTE_DEPTH > 1)) 1248 \param src 1249 \param src_x 1250 \param src_y 1251 \param stride 1252 \param x 1253 \param y 1254 \param width 1255 \param height 1256 \description 1257 1258void lcd_remote_clear_display(void) 1259 \group remote lcd 1260 \conditions (defined(HAVE_REMOTE_LCD)) 1261 \description 1262 1263void lcd_remote_drawline(int x1, int y1, int x2, int y2) 1264 \group remote lcd 1265 \conditions (defined(HAVE_REMOTE_LCD)) 1266 \param x1 X top coordinate 1267 \param y1 Y top coordinate 1268 \param x2 X bottom coordinate 1269 \param y2 Y bottom coordinate 1270 \description Draws a line at (=x1=, =y1=) -> (=x2=, =y2=) within current drawing mode 1271 1272void lcd_remote_drawpixel(int x, int y) 1273 \group remote lcd 1274 \conditions (defined(HAVE_REMOTE_LCD)) 1275 \param x 1276 \param y 1277 \description Draws a pixel at (=x=, =y=) within current drawing mode 1278 1279void lcd_remote_drawrect(int x, int y, int nx, int ny) 1280 \group remote lcd 1281 \conditions (defined(HAVE_REMOTE_LCD)) 1282 \param x 1283 \param y 1284 \param nx 1285 \param ny 1286 \description 1287 1288void lcd_remote_fillrect(int x, int y, int nx, int ny) 1289 \group remote lcd 1290 \conditions (defined(HAVE_REMOTE_LCD)) 1291 \param x 1292 \param y 1293 \param nx 1294 \param ny 1295 \description 1296 1297int lcd_remote_getstringsize(const unsigned char *str, int *w, int *h) 1298 \group remote lcd 1299 \conditions (defined(HAVE_REMOTE_LCD)) 1300 \param str String 1301 \param w Width 1302 \param h Height 1303 \return Success or not 1304 \description Stores the width and height of the string in =w= and =h= 1305 1306unsigned lcd_remote_get_background(void) 1307 \group remote lcd 1308 \conditions (defined(HAVE_REMOTE_LCD)) && ((LCD_REMOTE_DEPTH > 1)) 1309 \return 1310 \description 1311 1312int lcd_remote_get_drawmode(void) 1313 \group remote lcd 1314 \conditions (defined(HAVE_REMOTE_LCD)) 1315 \return 1316 \description 1317 1318unsigned lcd_remote_get_foreground(void) 1319 \group remote lcd 1320 \conditions (defined(HAVE_REMOTE_LCD)) && ((LCD_REMOTE_DEPTH > 1)) 1321 \return 1322 \description 1323 1324void lcd_remote_hline(int x1, int x2, int y) 1325 \group remote lcd 1326 \conditions (defined(HAVE_REMOTE_LCD)) 1327 \param x1 1328 \param x2 1329 \param y 1330 \description 1331 1332void lcd_remote_mono_bitmap(const unsigned char *src, int x, int y, int width, int height) 1333 \group remote lcd 1334 \conditions (defined(HAVE_REMOTE_LCD)) 1335 \param src 1336 \param x 1337 \param y 1338 \param width 1339 \param height 1340 \description 1341 1342void 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) 1343 \group remote lcd 1344 \conditions (defined(HAVE_REMOTE_LCD)) 1345 \param src 1346 \param src_x 1347 \param src_y 1348 \param stride 1349 \param x 1350 \param y 1351 \param width 1352 \param height 1353 \description 1354 1355void lcd_remote_puts(int x, int y, const unsigned char *string) 1356 \group remote lcd 1357 \conditions (defined(HAVE_REMOTE_LCD)) 1358 \param x 1359 \param y 1360 \param string 1361 \description 1362 1363void lcd_remote_putsxy(int x, int y, const unsigned char *string) 1364 \group remote lcd 1365 \conditions (defined(HAVE_REMOTE_LCD)) 1366 \param x 1367 \param y 1368 \param string 1369 \description 1370 1371bool lcd_remote_puts_scroll(int x, int y, const unsigned char* string) 1372 \group remote lcd 1373 \conditions (defined(HAVE_REMOTE_LCD)) 1374 \param x 1375 \param y 1376 \param string 1377 \return 1378 \description 1379 1380void lcd_remote_scroll_stop(void) 1381 \group remote lcd 1382 \conditions (defined(HAVE_REMOTE_LCD)) 1383 \description 1384 1385void lcd_remote_setfont(int font) 1386 \group remote lcd 1387 \conditions (defined(HAVE_REMOTE_LCD)) 1388 \param font 1389 \description Set default font 1390 1391void lcd_remote_set_background(unsigned background) 1392 \group remote lcd 1393 \conditions (defined(HAVE_REMOTE_LCD)) && ((LCD_REMOTE_DEPTH > 1)) 1394 \param background 1395 \description 1396 1397void lcd_remote_set_contrast(int x) 1398 \group remote lcd 1399 \conditions (defined(HAVE_REMOTE_LCD)) 1400 \param x 1401 \description 1402 1403void lcd_remote_set_drawmode(int mode) 1404 \group remote lcd 1405 \conditions (defined(HAVE_REMOTE_LCD)) 1406 \param mode 1407 \description 1408 1409void lcd_remote_set_foreground(unsigned foreground) 1410 \group remote lcd 1411 \conditions (defined(HAVE_REMOTE_LCD)) && ((LCD_REMOTE_DEPTH > 1)) 1412 \param foreground 1413 \description 1414 1415void lcd_remote_update(void) 1416 \group remote lcd 1417 \conditions (defined(HAVE_REMOTE_LCD)) 1418 \description 1419 1420void lcd_remote_update_rect(int x, int y, int width, int height) 1421 \group remote lcd 1422 \conditions (defined(HAVE_REMOTE_LCD)) 1423 \param x 1424 \param y 1425 \param width 1426 \param height 1427 \description 1428 1429void lcd_remote_vline(int x, int y1, int y2) 1430 \group remote lcd 1431 \conditions (defined(HAVE_REMOTE_LCD)) 1432 \param x 1433 \param y1 1434 \param y2 1435 \description 1436 1437void lcd_scroll_stop(void) 1438 \group lcd 1439 \description 1440 1441void lcd_setfont(int font) 1442 \group lcd 1443 \param font 1444 \description Set default font 1445 1446void lcd_set_backdrop(fb_data* backdrop) 1447 \group lcd 1448 \conditions (LCD_DEPTH > 1) 1449 \param backdrop Pointer to backdrop image 1450 \description Set the backdrop to =backdrop= 1451 \see lcd_framebuffer 1452 1453void lcd_set_background(unsigned foreground) 1454 \group lcd 1455 \conditions (LCD_DEPTH > 1) 1456 \param foreground 1457 \description 1458 1459void lcd_set_contrast(int x) 1460 \group lcd 1461 \conditions (defined(HAVE_LCD_CONTRAST)) 1462 \param x Should be between =MIN_CONTRAST_SETTING= and =MAX_CONTRAST_SETTING= 1463 \description Sets LCD contrast to value =x= 1464 1465void lcd_set_drawmode(int mode) 1466 \group lcd 1467 \param mode 1468 \description 1469 1470void lcd_set_foreground(unsigned foreground) 1471 \group lcd 1472 \conditions (LCD_DEPTH > 1) 1473 \param foreground 1474 \description 1475 1476void lcd_set_invert_display(bool yesno) 1477 \group lcd 1478 \conditions (defined(HAVE_LCD_INVERT)) 1479 \param yesno 1480 \description 1481 1482void lcd_set_mode(int mode) 1483 \group lcd 1484 \conditions (defined(HAVE_LCD_MODES)) 1485 \param mode 1486 \description 1487 1488struct viewport* lcd_set_viewport(struct viewport* vp) 1489 \group lcd 1490 \param vp 1491 \return 1492 \description 1493 1494void lcd_update(void) 1495 \group lcd 1496 \description Pushes LCD framebuffer changes to the LCD 1497 1498void lcd_update_rect(int x, int y, int width, int height) 1499 \group lcd 1500 \param x measured in pixels 1501 \param y measured in pixels 1502 \param width measured in pixels 1503 \param height measured in pixels 1504 \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. 1505 1506void lcd_vline(int x, int y1, int y2) 1507 \group lcd 1508 \param x X coordinate 1509 \param y1 Y start coordinate 1510 \param y2 Y end coordinate 1511 \description Draws a vertical line at (=x=, =y1=) -> (=x=, =y2=) within current drawing mode 1512 1513void lcd_yuv_set_options(unsigned options) 1514 \group lcd 1515 \conditions (LCD_DEPTH >= 16) && (MEMORYSIZE > 2) && (defined(TOSHIBA_GIGABEAT_F) || defined(SANSA_E200) || defined(SANSA_C200) || defined(IRIVER_H10) || defined(COWON_D2) || defined(PHILIPS_HDD1630) || defined(SANSA_FUZE) || defined(SANSA_E200V2) || defined(SANSA_FUZEV2) || defined(TOSHIBA_GIGABEAT_S) || defined(PHILIPS_SA9200)) 1516 \param options 1517 \description 1518 1519void lc_close(void *handle) 1520 \group load code api for overlay 1521 \param handle 1522 \description 1523 1524void* lc_get_header(void *handle) 1525 \group load code api for overlay 1526 \param handle 1527 \return 1528 \description 1529 1530void* lc_open(const char *filename, unsigned char *buf, size_t buf_size) 1531 \group load code api for overlay 1532 \param filename 1533 \param buf 1534 \param buf_size 1535 \return 1536 \description 1537 1538void* lc_open_from_mem(void* addr, size_t blob_size) 1539 \group load code api for overlay 1540 \param addr 1541 \param blob_size 1542 \return 1543 \description 1544 1545void led(bool on) 1546 \group misc 1547 \param on 1548 \description 1549 1550void logf(const char *fmt, ...) ATTRIBUTE_PRINTF(1, 2) 1551 \group misc 1552 \conditions (defined(ROCKBOX_HAS_LOGF)) 1553 \param fmt 1554 \description 1555 1556const unsigned long *audio_master_sampr_list 1557 \group sound 1558 \return 1559 \description 1560 1561const unsigned long *hw_freq_sampr 1562 \group sound 1563 \return 1564 \description 1565 1566const unsigned long *rec_freq_sampr 1567 \group sound 1568 \conditions (defined(HAVE_RECORDING)) 1569 \return 1570 \description 1571 1572void *memchr(const void *s1, int c, size_t n) 1573 \group strings and memory 1574 \param s1 1575 \param c 1576 \param n 1577 \return 1578 \description 1579 1580int memcmp(const void *s1, const void *s2, size_t n) 1581 \group strings and memory 1582 \param s1 1583 \param s2 1584 \param n 1585 \return 1586 \description 1587 1588void* memcpy(void *out, const void *in, size_t n) 1589 \group strings and memory 1590 \param out 1591 \param in 1592 \param n 1593 \return 1594 \description Copies =n= bytes of data in memory from =in= to =out= 1595 1596void* memmove(void *out, const void *in, size_t n) 1597 \group strings and memory 1598 \param out 1599 \param in 1600 \param n 1601 \return 1602 \description 1603 1604void* memset(void *dst, int c, size_t length) 1605 \group strings and memory 1606 \param dst 1607 \param c 1608 \param length 1609 \return 1610 \description Fills a memory region with specified byte value =c= 1611 1612void mixer_channel_calculate_peaks(enum pcm_mixer_channel channel, struct pcm_peaks *peaks) 1613 \param channel 1614 \param peaks 1615 \description 1616 1617const void * mixer_channel_get_buffer(enum pcm_mixer_channel channel, int *count) 1618 \param channel 1619 \param count 1620 \return 1621 \description 1622 1623size_t mixer_channel_get_bytes_waiting(enum pcm_mixer_channel channel) 1624 \param channel 1625 \return 1626 \description 1627 1628void mixer_channel_play_data(enum pcm_mixer_channel channel, pcm_play_callback_type get_more, const void *start, size_t size) 1629 \param channel 1630 \param get_more 1631 \param start 1632 \param size 1633 \description 1634 1635void mixer_channel_play_pause(enum pcm_mixer_channel channel, bool play) 1636 \param channel 1637 \param play 1638 \description 1639 1640void mixer_channel_set_amplitude(enum pcm_mixer_channel channel, unsigned int amplitude) 1641 \param channel 1642 \param amplitude 1643 \description 1644 1645void mixer_channel_set_buffer_hook(enum pcm_mixer_channel channel, chan_buffer_hook_fn_type fn) 1646 \param channel 1647 \param fn 1648 \description 1649 1650enum channel_status mixer_channel_status(enum pcm_mixer_channel channel) 1651 \param channel 1652 \return 1653 \description 1654 1655void mixer_channel_stop(enum pcm_mixer_channel channel) 1656 \param channel 1657 \description 1658 1659unsigned int mixer_get_frequency(void) 1660 \return 1661 \description 1662 1663void mixer_set_frequency(unsigned int samplerate) 1664 \param samplerate 1665 \description 1666 1667int mkdir(const char *path) 1668 \group dir 1669 \param path 1670 \return 1671 \description 1672 1673time_t mktime(struct tm *t) 1674 \group misc 1675 \conditions (CONFIG_RTC) 1676 \param t 1677 \return 1678 \description 1679 1680void mutex_init(struct mutex *m) 1681 \group kernel/ system 1682 \param m 1683 \description 1684 1685void mutex_lock(struct mutex *m) 1686 \group kernel/ system 1687 \param m 1688 \description 1689 1690void mutex_unlock(struct mutex *m) 1691 \group kernel/ system 1692 \param m 1693 \description 1694 1695void onplay_show_playlist_cat_menu(const char* track_name, int attr, void (*add_to_pl_cb)) 1696 \param track_name 1697 \param attr 1698 \param add_to_pl_cb 1699 \description 1700 1701void onplay_show_playlist_menu(const char* path, int attr, void (*playlist_insert_cb)) 1702 \param path 1703 \param attr 1704 \param playlist_insert_cb 1705 \description 1706 1707int open(const char *path, int oflag, ...) 1708 \group file 1709 \param path 1710 \param oflag 1711 \return 1712 \description 1713 1714DIR * opendir(const char *dirname) 1715 \group dir 1716 \param dirname 1717 \return a pointer to the directory stream 1718 \description The opendir() function opens a directory stream corresponding to the directory name. The stream is positioned at the first entry in the directory. 1719 1720int open_utf8(const char* pathname, int flags) 1721 \group file 1722 \param pathname 1723 \param flags 1724 \return 1725 \description 1726 1727bool option_screen(const struct settings_list *setting, struct viewport parent[NB_SCREENS], bool use_temp_var, const unsigned char* option_title) 1728 \group options 1729 \param setting 1730 \param parent[NB_SCREENS] 1731 \param use_temp_var 1732 \param option_title 1733 \return 1734 \description 1735 1736char* output_dyn_value(char *buf, int buf_size, int64_t value, const unsigned char * const *units, unsigned int unit_count, bool binary_scale) 1737 \group strings and memory 1738 \param buf 1739 \param buf_size 1740 \param value 1741 \param units 1742 \param unit_count 1743 \param binary_scale 1744 \return 1745 \description 1746 1747int path_strip_volume(const char *name, const char **nameptr, bool greedy) 1748 \group pathfuncs 1749 \conditions (defined(HAVE_MULTIVOLUME)) 1750 \param name 1751 \param nameptr 1752 \param greedy 1753 \return 1754 \description 1755 1756void pcmbuf_fade(bool fade, bool in) 1757 \param fade 1758 \param in 1759 \description 1760 1761void pcmbuf_set_low_latency(bool state) 1762 \param state 1763 \description 1764 1765void pcm_apply_settings(void) 1766 \group sound 1767 \description 1768 1769void pcm_calculate_rec_peaks(int *left, int *right) 1770 \group sound 1771 \conditions (defined(HAVE_RECORDING)) 1772 \param left 1773 \param right 1774 \description 1775 1776void pcm_close_recording(void) 1777 \group sound 1778 \conditions (defined(HAVE_RECORDING)) 1779 \description 1780 1781void pcm_init_recording(void) 1782 \group sound 1783 \conditions (defined(HAVE_RECORDING)) 1784 \description 1785 1786bool pcm_is_playing(void) 1787 \group sound 1788 \return true unless playback is paused 1789 \description 1790 1791void pcm_play_data(pcm_play_callback_type get_more, pcm_status_callback_type status_cb, const void *start, size_t size) 1792 \group sound 1793 \param get_more Optional callback 1794 \param status_cb Optional status callback 1795 \param start is the address of raw 16-16, interleaved PCM data 1796 \param size is the size of the data to play 1797 \description 1798 1799void pcm_play_lock(void) 1800 \group sound 1801 \description 1802 1803void pcm_play_stop(void) 1804 \group sound 1805 \description Stops the playback and empties the audio buffer. 1806 1807void pcm_play_unlock(void) 1808 \group sound 1809 \description 1810 1811void pcm_record_data(pcm_rec_callback_type more_ready, pcm_status_callback_type status_cb, void *start, size_t size) 1812 \group sound 1813 \conditions (defined(HAVE_RECORDING)) 1814 \param more_ready 1815 \param status_cb 1816 \param start 1817 \param size 1818 \description 1819 1820void pcm_set_frequency(unsigned int frequency) 1821 \group sound 1822 \param frequency 1823 \description 1824 1825void pcm_stop_recording(void) 1826 \group sound 1827 \conditions (defined(HAVE_RECORDING)) 1828 \description 1829 1830int playlist_amount(void) 1831 \group playback control 1832 \return the number of tracks in current playlist 1833 \description 1834 1835int playlist_create(const char *dir, const char *file) 1836 \group playback control 1837 \param dir 1838 \param file 1839 \return 1840 \description 1841 1842bool playlist_entries_iterate(const char *filename, struct playlist_insert_context *pl_context, bool (*action_cb)(const char *file_name)) 1843 \group playback control 1844 \param filename 1845 \param pl_context 1846 \param action_cb 1847 \return 1848 \description 1849 1850struct playlist_info* playlist_get_current(void) 1851 \group playback control 1852 \return pointer to current playlist 1853 \description 1854 1855int playlist_get_display_index(void) 1856 \group playback control 1857 \return 1858 \description 1859 1860int playlist_get_first_index(const struct playlist_info* playlist) 1861 \group playback control 1862 \param playlist 1863 \return 1864 \description 1865 1866int playlist_get_resume_info(int *resume_index) 1867 \group playback control 1868 \param resume_index 1869 \return 1870 \description 1871 1872int playlist_get_track_info(struct playlist_info* playlist, int index, struct playlist_track_info* info) 1873 \group playback control 1874 \param playlist 1875 \param index 1876 \param info 1877 \return 1878 \description 1879 1880int playlist_insert_directory(struct playlist_info* playlist, const char *dirname, int position, bool queue, bool recurse) 1881 \group playback control 1882 \param playlist 1883 \param dirname 1884 \param position 1885 \param queue 1886 \param recurse 1887 \return 1888 \description 1889 1890int playlist_insert_playlist(struct playlist_info* playlist, const char *filename, int position, bool queue) 1891 \group playback control 1892 \param playlist 1893 \param filename 1894 \param position 1895 \param queue 1896 \return 1897 \description 1898 1899int playlist_insert_track(struct playlist_info* playlist, const char *filename, int position, bool queue, bool sync) 1900 \group playback control 1901 \param playlist 1902 \param filename 1903 \param position 1904 \param queue 1905 \param sync 1906 \return 1907 \description 1908 1909int playlist_remove_all_tracks(struct playlist_info *playlist) 1910 \group playback control 1911 \param playlist 1912 \return 1913 \description 1914 1915int playlist_resume(void) 1916 \group playback control 1917 \return 1918 \description 1919 1920void playlist_resume_track(int start_index, unsigned int crc, unsigned long elapsed, unsigned long offset) 1921 \group playback control 1922 \param start_index 1923 \param crc 1924 \param elapsed 1925 \param offset 1926 \description 1927 1928void playlist_set_modified(struct playlist_info *playlist, bool modified) 1929 \group playback control 1930 \param playlist 1931 \param modified 1932 \description 1933 1934int playlist_shuffle(int random_seed, int start_index) 1935 \group playback control 1936 \param random_seed 1937 \param start_index 1938 \return 1939 \description 1940 1941void playlist_start(int start_index, unsigned long elapsed, unsigned long offset) 1942 \group playback control 1943 \param start_index 1944 \param elapsed 1945 \param offset 1946 \description 1947 1948void playlist_sync(struct playlist_info* playlist) 1949 \group playback control 1950 \param playlist 1951 \description 1952 1953void* plugin_get_audio_buffer(size_t *buffer_size) 1954 \group plugin 1955 \param buffer_size 1956 \return 1957 \description Steals =buffer_size= bytes from the available RAM, reducing the available buffer for audio buffering 1958 1959void* plugin_get_buffer(size_t *buffer_size) 1960 \group plugin 1961 \param buffer_size this is the memory size left in plugin buffer upon return 1962 \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. 1963 \description 1964 1965char* plugin_get_current_filename(void) 1966 \group plugin 1967 \return 1968 \description 1969 1970int plugin_open(const char *path, const char *parameter) 1971 \group plugin 1972 \param path 1973 \param parameter 1974 \return 1975 \description 1976 1977void plugin_release_audio_buffer(void) 1978 \group plugin 1979 \description 1980 1981size_t plugin_reserve_buffer(size_t buffer_size) 1982 \group plugin 1983 \param buffer_size 1984 \return 1985 \description 1986 1987void plugin_tsr(int (*exit_callback)(bool reenter)) 1988 \group plugin 1989 \param exit_callback 1990 \description 1991 1992int close(int filedes) 1993 \group file 1994 \param fiedes 1995 \return 0 upon success 1996 \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. 1997 1998int creat(const char *pathname, mode_t mode) 1999 \group file 2000 \param pathname 2001 \param mode 2002 \return the file descriptor associated to this file 2003 \description Create a file with mode O_RDONLY, O_WRONLY or O_RDWR 2004 2005off_t filesize(int filedes) 2006 \group file 2007 \param filedes 2008 \return size of a file; upon error, returns -1 2009 \description 2010 2011int ftruncate(int fildes, off_t length) 2012 \group file 2013 \param fildes 2014 \param length 2015 \return 2016 \description Truncate file to the specified =length= 2017 2018off_t lseek(int fildes, off_t offset, int whence) 2019 \group file 2020 \param fildes 2021 \param offset 2022 \param whence 2023 \return 2024 \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=. 2025 2026int open(const char *path, int oflag, ...) 2027 \group file 2028 \param path 2029 \param oflag 2030 \return 2031 \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. 2032 2033ssize_t read(int fildes, void *buf, size_t nbyte) 2034 \group file 2035 \param fildes 2036 \param buf 2037 \param nbyte 2038 \return 2039 \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= 2040 2041int remove(const char *path) 2042 \group file 2043 \param path 2044 \return 2045 \description remove() deletes a name from the filesystem. It calls unlink for files, and rmdir for directories. 2046 2047 2048int rename(const char *old, const char *new) 2049 \group file 2050 \param old points to the pathname of the file to be renamed 2051 \param new points to the new pathname of the file 2052 \return 2053 \description The rename() function changes the name of a file 2054 2055unsigned sleep(unsigned ticks) 2056 \group kernel/ system 2057 \param ticks 2058 \return 2059 \description Sleep a specified number of =ticks=, we have HZ ticks per second 2060 2061ssize_t write(int fildes, const void *buf, size_t nbyte) 2062 \group file 2063 \param fildes 2064 \param buf 2065 \param nbyte 2066 \return 2067 \description Write writes up to =count= bytes to the file referenced by the file descriptor =fd= from the buffer starting at =buf= 2068 2069void profile_func_enter(void *this_fn, void *call_site) 2070 \conditions (defined(RB_PROFILE)) 2071 \param this_fn 2072 \param call_site 2073 \description 2074 2075void profile_func_exit(void *this_fn, void *call_site) 2076 \conditions (defined(RB_PROFILE)) 2077 \param this_fn 2078 \param call_site 2079 \description 2080 2081void profile_thread(void) 2082 \conditions (defined(RB_PROFILE)) 2083 \description 2084 2085void profstop(void) 2086 \conditions (defined(RB_PROFILE)) 2087 \description 2088 2089void qsort(void *base, size_t nmemb, size_t size, int(*compar)(const void *, const void *)) 2090 \group misc 2091 \param base start of array 2092 \param nmemb number of elements 2093 \param size describes the size of each element of the array 2094 \param compar 2095 \description qsort sorts an array (begining at =base=) of =nmemb= objects 2096 2097void queue_delete(struct event_queue *q) 2098 \param q 2099 \description 2100 2101bool queue_empty(const struct event_queue *q) 2102 \param q 2103 \return 2104 \description 2105 2106void queue_enable_queue_send(struct event_queue *q, struct queue_sender_list *send, unsigned int thread_id) 2107 \param q 2108 \param send 2109 \param thread_id 2110 \description 2111 2112void queue_init(struct event_queue *q, bool register_queue) 2113 \param q 2114 \param register_queue 2115 \description 2116 2117void queue_post(struct event_queue *q, long id, intptr_t data) 2118 \param q 2119 \param id 2120 \param data 2121 \description 2122 2123void queue_remove_from_head(struct event_queue *q, long id) 2124 \param q 2125 \param id 2126 \description 2127 2128void queue_reply(struct event_queue *q, intptr_t retval) 2129 \param q 2130 \param retval 2131 \description 2132 2133intptr_t queue_send(struct event_queue *q, long id, intptr_t data) 2134 \param q 2135 \param id 2136 \param data 2137 \return 2138 \description 2139 2140void queue_wait(struct event_queue *q, struct queue_event *ev) 2141 \param q 2142 \param ev 2143 \description 2144 2145void queue_wait_w_tmo(struct event_queue *q, struct queue_event *ev, int ticks) 2146 \param q 2147 \param ev 2148 \param ticks 2149 \description 2150 2151int rand(void) 2152 \group misc 2153 \return a pseudo random number between 0 and 0x7fffffff 2154 \description 2155 2156const char *rbversion 2157 \return version of the plugin API 2158 \description 2159 2160struct dirent * readdir(DIR *dirp) 2161 \group dir 2162 \param dirp 2163 \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 2164 \description 2165 2166int read_bmp_fd(int fd, struct bitmap *bm, int maxsize, int format, const struct custom_format *cformat) 2167 \param fd 2168 \param bm 2169 \param maxsize 2170 \param format 2171 \param cformat 2172 \return 2173 \description 2174 2175int read_bmp_file(const char* filename, struct bitmap *bm, int maxsize, int format, const struct custom_format *cformat) 2176 \param filename 2177 \param bm 2178 \param maxsize 2179 \param format 2180 \param cformat 2181 \return 2182 \description 2183 2184int read_jpeg_fd(int fd, struct bitmap *bm, int maxsize, int format, const struct custom_format *cformat) 2185 \conditions (defined(HAVE_JPEG)) 2186 \param fd 2187 \param bm 2188 \param maxsize 2189 \param format 2190 \param cformat 2191 \return 2192 \description 2193 2194int read_jpeg_file(const char* filename, struct bitmap *bm, int maxsize, int format, const struct custom_format *cformat) 2195 \conditions (defined(HAVE_JPEG)) 2196 \param filename 2197 \param bm 2198 \param maxsize 2199 \param format 2200 \param cformat 2201 \return 2202 \description 2203 2204int read_line(int fd, char* buffer, int buffer_size) 2205 \group file 2206 \param fd 2207 \param buffer 2208 \param buffer_size 2209 \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) 2210 \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. 2211 2212void register_storage_idle_func(void (*function)(void)) 2213 \group file 2214 \conditions (USING_STORAGE_CALLBACK) 2215 \param function 2216 \description 2217 2218void reload_directory(void) 2219 \group file 2220 \description 2221 2222void remote_backlight_off(void) 2223 \conditions (defined(HAVE_BACKLIGHT)) && (defined(HAVE_REMOTE_LCD)) 2224 \description Turns the remote backlight off 2225 2226void remote_backlight_on(void) 2227 \conditions (defined(HAVE_BACKLIGHT)) && (defined(HAVE_REMOTE_LCD)) 2228 \description Turns the remote backlight on 2229 2230void remote_backlight_set_timeout(int index) 2231 \conditions (defined(HAVE_BACKLIGHT)) && (defined(HAVE_REMOTE_LCD)) 2232 \param index 2233 \description 2234 2235void remote_backlight_set_timeout_plugged(int index) 2236 \conditions (defined(HAVE_BACKLIGHT)) && (defined(HAVE_REMOTE_LCD)) && (CONFIG_CHARGING) 2237 \param index 2238 \description 2239 2240int remove_array_ptr(void **arr, void *ptr) 2241 \group misc 2242 \param arr 2243 \param ptr 2244 \return 2245 \description 2246 2247void remove_event(unsigned short id, void (*handler)(unsigned short id, void *data)) 2248 \group event api 2249 \param id 2250 \param handler 2251 \description 2252 2253void reset_poweroff_timer(void) 2254 \group kernel/ system 2255 \description The function name pretty much says what it's supposed to do 2256 2257int rmdir(const char *path) 2258 \group dir 2259 \param path 2260 \return 2261 \description 2262 2263int rockbox_browse(struct browse_context *browse) 2264 \group browsing 2265 \param browse 2266 \return 2267 \description 2268 2269struct menu_table *root_menu_get_options(int *nb_options) 2270 \group menu 2271 \param nb_options 2272 \return 2273 \description 2274 2275void root_menu_load_from_cfg(void* setting, char *value) 2276 \group menu 2277 \param setting 2278 \param value 2279 \description 2280 2281void root_menu_set_default(void* setting, void* defaultval) 2282 \group menu 2283 \param setting 2284 \param defaultval 2285 \description 2286 2287char* root_menu_write_to_cfg(void* setting, char*buf, int buf_len) 2288 \group menu 2289 \param setting 2290 \param charbuf 2291 \param buf_len 2292 \return 2293 \description 2294 2295int round_value_to_list32(unsigned long value, const unsigned long list[], int count, bool signd) 2296 \group misc 2297 \param value 2298 \param list[] 2299 \param count 2300 \param signd 2301 \return 2302 \description 2303 2304struct screen* screens[NB_SCREENS] 2305 \group remote lcd 2306 \return 2307 \description 2308 2309void screen_clear_area(struct screen * display, int xstart, int ystart, int width, int height) 2310 \param display 2311 \param xstart 2312 \param ystart 2313 \param width 2314 \param height 2315 \description 2316 2317void screen_dump_set_hook(void (*hook)(int fh)) 2318 \param hook 2319 \description 2320 2321bool search_albumart_files(const struct mp3entry *id3, const char *size_string, char *buf, int buflen) 2322 \conditions (defined(HAVE_ALBUMART)) 2323 \param id3 2324 \param size_string 2325 \param buf Pointer to output 2326 \param buflen Max length for =buf= 2327 \return true if an album art was found 2328 \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=. 2329 2330void semaphore_init(struct semaphore *s, int max, int start) 2331 \group kernel/ system 2332 \conditions (defined(HAVE_SEMAPHORE_OBJECTS)) 2333 \param s 2334 \param max 2335 \param start 2336 \description 2337 2338void semaphore_release(struct semaphore *s) 2339 \group kernel/ system 2340 \conditions (defined(HAVE_SEMAPHORE_OBJECTS)) 2341 \param s 2342 \description 2343 2344int semaphore_wait(struct semaphore *s, int timeout) 2345 \group kernel/ system 2346 \conditions (defined(HAVE_SEMAPHORE_OBJECTS)) 2347 \param s 2348 \param timeout 2349 \return 2350 \description 2351 2352void send_event(unsigned short id, void *data) 2353 \group event api 2354 \param id 2355 \param data 2356 \description 2357 2358const struct settings_list* find_setting(const void* variable) 2359 \group options 2360 \param variable 2361 \param id 2362 \return 2363 \description 2364 2365const struct settings_list* get_settings_list(int*count) 2366 \group options 2367 \param intcount 2368 \return 2369 \description 2370 2371bool settings_parseline(char* line, char** name, char** value) 2372 \group file 2373 \param line 2374 \param name 2375 \param value 2376 \return false if no valid config entry was found 2377 \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. 2378 2379int settings_save(void) 2380 \group options 2381 \return 2382 \description 2383 2384bool set_bool(const char* string, const bool* variable ) 2385 \group options 2386 \param string 2387 \param variable 2388 \return 2389 \description 2390 2391bool 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)) 2392 \group options 2393 \param string 2394 \param variable 2395 \param yes_str 2396 \param yes_voice 2397 \param no_str 2398 \param no_voice 2399 \param function 2400 \return 2401 \description 2402 2403bool set_color(struct screen *display, char *title, unsigned *color, unsigned banned_color) 2404 \conditions (defined(HAVE_LCD_COLOR)) 2405 \param display 2406 \param title 2407 \param color 2408 \param banned_color 2409 \return 2410 \description 2411 2412void set_current_file(const char* path) 2413 \param path 2414 \description 2415 2416void set_dirfilter(int l_dirfilter) 2417 \param l_dirfilter 2418 \description 2419 2420bool set_int(const unsigned char* string, const char* unit, int voice_unit, const int* variable, void (*function)(int), int step, int min, int max, const char* (*formatter)(char*, size_t, int, const char*) ) 2421 \group options 2422 \param string 2423 \param unit 2424 \param voice_unit 2425 \param variable 2426 \param function 2427 \param step 2428 \param min 2429 \param max 2430 \param formatter 2431 \return 2432 \description 2433 2434bool set_int_ex(const unsigned char* string, const char* unit, int voice_unit, const int* variable, void (*function)(int), int step, int min, int max, const char* (*formatter)(char*, size_t, int, const char*) , int32_t (*get_talk_id)(int, int)) 2435 \group options 2436 \param string 2437 \param unit 2438 \param voice_unit 2439 \param variable 2440 \param function 2441 \param step 2442 \param min 2443 \param max 2444 \param formatter 2445 \param get_talk_id 2446 \return 2447 \description 2448 2449bool set_option(const char* string, const void* variable, enum optiontype type, const struct opt_items* options, int numoptions, void (*function)(int)) 2450 \group options 2451 \param string 2452 \param variable 2453 \param type 2454 \param options 2455 \param numoptions 2456 \param function 2457 \return 2458 \description 2459 2460void set_sleeptimer_duration(int minutes) 2461 \group kernel/ system 2462 \param minutes 2463 \description 2464 2465void simplelist_info_init(struct simplelist_info *info, char* title, int count, void* data) 2466 \group list 2467 \param info 2468 \param title 2469 \param count 2470 \param data 2471 \description 2472 2473bool simplelist_show_list(struct simplelist_info *info) 2474 \group list 2475 \param info 2476 \return 2477 \description 2478 2479void sim_lcd_ex_init(unsigned long (*getpixel)(int, int)) 2480 \group special simulator hooks 2481 \conditions ((CONFIG_PLATFORM & PLATFORM_HOSTED)) && (LCD_DEPTH < 8) 2482 \param getpixel 2483 \description 2484 2485void sim_lcd_ex_update_rect(int x, int y, int width, int height) 2486 \group special simulator hooks 2487 \conditions ((CONFIG_PLATFORM & PLATFORM_HOSTED)) && (LCD_DEPTH < 8) 2488 \param x 2489 \param y 2490 \param width 2491 \param height 2492 \description 2493 2494int snprintf(char *buf, size_t size, const char *fmt, ...) ATTRIBUTE_PRINTF(3, 4) 2495 \group strings and memory 2496 \param buf 2497 \param size 2498 \param fmt 2499 \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 2500 \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. 2501 2502int sound_current(int setting); /*stub* 2503 \group sound 2504 \param setting 2505 \return 2506 \description 2507 2508int sound_default(int setting) 2509 \group sound 2510 \param setting 2511 \return 2512 \description 2513 2514int sound_enum_hw_eq_band_setting(unsigned int band, unsigned int band_setting) 2515 \group sound 2516 \conditions (defined(AUDIOHW_HAVE_EQ)) 2517 \param band 2518 \param band_setting 2519 \return 2520 \description 2521 2522int32_t sound_get_pitch(void) 2523 \group sound 2524 \conditions (defined (HAVE_PITCHCONTROL)) 2525 \return 2526 \description 2527 2528int sound_max(int setting) 2529 \group sound 2530 \param setting 2531 \return 2532 \description 2533 2534int sound_min(int setting) 2535 \group sound 2536 \param setting 2537 \return 2538 \description 2539 2540void sound_set(int setting, int value) 2541 \group sound 2542 \param setting 2543 \param value 2544 \description 2545 2546void sound_set_pitch(int32_t pitch) 2547 \group sound 2548 \conditions (defined (HAVE_PITCHCONTROL)) 2549 \param pitch 2550 \description 2551 2552const char * sound_unit(int setting) 2553 \group sound 2554 \param setting 2555 \return 2556 \description 2557 2558int sound_val2phys(int setting, int value) 2559 \group sound 2560 \param setting 2561 \param value 2562 \return 2563 \description 2564 2565void splash(int ticks, const char *str) 2566 \group lcd 2567 \param ticks 2568 \param str 2569 \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) 2570 2571void splashf(int ticks, const char *fmt, ...) ATTRIBUTE_PRINTF(2, 3) 2572 \group lcd 2573 \param ticks 2574 \param fmt 2575 \description 2576 2577void splash_progress(int current, int total, const char *fmt, ...) ATTRIBUTE_PRINTF(3, 4) 2578 \group lcd 2579 \param current 2580 \param total 2581 \param fmt 2582 \description 2583 2584void splash_progress_set_delay(long delay_ticks) 2585 \group lcd 2586 \param delay_ticks 2587 \description 2588 2589void srand(unsigned int seed) 2590 \group misc 2591 \param seed 2592 \description Seed the random number generator 2593 2594void storage_sleep(void) 2595 \group file 2596 \description 2597 2598void storage_spin(void) 2599 \group file 2600 \description 2601 2602void storage_spindown(int seconds) 2603 \group file 2604 \param seconds 2605 \description 2606 2607int strcasecmp(const char *, const char *) 2608 \group strings and memory 2609 \param 2610 \param 2611 \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 2612 \description The strcasecmp() function compares the two strings s1 and s2, ignoring the case of the characters 2613 2614char *strcat(char *s1, const char *s2) 2615 \group strings and memory 2616 \param s1 2617 \param s2 2618 \return =s1= concatenated with =s2= 2619 \description Appends =s2= to =s1=, replacing the NULL terminating character of =s1= and returns it 2620 2621char *strchr(const char *s, int c) 2622 \group strings and memory 2623 \param s 2624 \param c 2625 \return 2626 \description 2627 2628int strcmp(const char *, const char *) 2629 \group strings and memory 2630 \param 2631 \param 2632 \return 2633 \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. 2634 2635char* strcpy(char *dst, const char *src) 2636 \group strings and memory 2637 \param dst 2638 \param src 2639 \return the initial value of =dst= 2640 \description strcpy() copies the string pointed to by =src= (including the terminating null character) to the array pointed to by =dst= 2641 2642char* strip_extension(char* buffer, int buffer_size, const char *filename) 2643 \group file 2644 \param buffer 2645 \param buffer_size 2646 \param filename 2647 \return 2648 \description 2649 2650size_t strlcat(char *dst, const char *src, size_t length) 2651 \group strings and memory 2652 \param dst 2653 \param src 2654 \param length 2655 \return 2656 \description 2657 2658size_t strlcpy(char *dst, const char *src, size_t length) 2659 \group strings and memory 2660 \param dst 2661 \param src 2662 \param length 2663 \return 2664 \description 2665 2666size_t strlen(const char *str) 2667 \group strings and memory 2668 \param str 2669 \return the character count 2670 \description The strlen() function works out the length of the string starting at =str= by counting characters until it reaches a null character. 2671 2672int strncasecmp(const char *s1, const char *s2, size_t n) 2673 \group strings and memory 2674 \param s1 2675 \param s2 2676 \param n 2677 \return 2678 \description Like strcasecmp() but only on the first =n= characters 2679 \see strcasecmp 2680 2681int strncmp(const char *, const char *, size_t) 2682 \group strings and memory 2683 \param 2684 \param 2685 \param size_t 2686 \return 2687 \description 2688 2689char * strrchr(const char *s, int c) 2690 \group strings and memory 2691 \param s 2692 \param c 2693 \return a pointer to the located character, or a null pointer if =c= does not occur in string. 2694 \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) 2695 2696char* strtok_r(char *ptr, const char *sep, char **end) 2697 \group strings and memory 2698 \param ptr 2699 \param sep 2700 \param end 2701 \return 2702 \description 2703 2704int system_memory_guard(int newmode) 2705 \group kernel/ system 2706 \conditions ((CONFIG_PLATFORM & PLATFORM_NATIVE)) 2707 \param newmode 2708 \return 2709 \description 2710 2711void system_sound_play(enum system_sound sound) 2712 \param sound 2713 \description 2714 2715void sys_poweroff(void) 2716 \group reboot and poweroff 2717 \description 2718 2719void sys_reboot(void) 2720 \group reboot and poweroff 2721 \description 2722 2723void tagcache_commit_finalize(void) 2724 \group metadata 2725 \conditions (defined(HAVE_TAGCACHE)) 2726 \description 2727 2728bool tagcache_fill_tags(struct mp3entry *id3, const char *filename) 2729 \group metadata 2730 \conditions (defined(HAVE_TAGCACHE)) && (defined(HAVE_TC_RAMCACHE)) && (defined(HAVE_DIRCACHE)) 2731 \param id3 2732 \param filename 2733 \return 2734 \description 2735 2736bool tagcache_get_next(struct tagcache_search *tcs, char *buf, long size) 2737 \group metadata 2738 \conditions (defined(HAVE_TAGCACHE)) 2739 \param tcs 2740 \param buf 2741 \param size 2742 \return 2743 \description 2744 2745long tagcache_get_numeric(const struct tagcache_search *tcs, int tag) 2746 \group metadata 2747 \conditions (defined(HAVE_TAGCACHE)) 2748 \param tcs 2749 \param tag 2750 \return 2751 \description 2752 2753struct tagcache_stat* tagcache_get_stat(void) 2754 \group metadata 2755 \conditions (defined(HAVE_TAGCACHE)) 2756 \return 2757 \description 2758 2759bool tagcache_is_in_ram(void) 2760 \group metadata 2761 \conditions (defined(HAVE_TAGCACHE)) && (defined(HAVE_TC_RAMCACHE)) 2762 \return 2763 \description 2764 2765bool tagcache_retrieve(struct tagcache_search *tcs, int idxid, int tag, char *buf, long size) 2766 \group metadata 2767 \conditions (defined(HAVE_TAGCACHE)) 2768 \param tcs 2769 \param idxid 2770 \param tag 2771 \param buf 2772 \param size 2773 \return 2774 \description 2775 2776bool tagcache_search(struct tagcache_search *tcs, int tag) 2777 \group metadata 2778 \conditions (defined(HAVE_TAGCACHE)) 2779 \param tcs 2780 \param tag 2781 \return 2782 \description 2783 2784bool tagcache_search_add_filter(struct tagcache_search *tcs, int tag, int seek) 2785 \group metadata 2786 \conditions (defined(HAVE_TAGCACHE)) 2787 \param tcs 2788 \param tag 2789 \param seek 2790 \return 2791 \description 2792 2793void tagcache_search_finish(struct tagcache_search *tcs) 2794 \group metadata 2795 \conditions (defined(HAVE_TAGCACHE)) 2796 \param tcs 2797 \description 2798 2799void tagcache_search_set_uniqbuf(struct tagcache_search *tcs, void *buffer, long length) 2800 \group metadata 2801 \conditions (defined(HAVE_TAGCACHE)) 2802 \param tcs 2803 \param buffer 2804 \param length 2805 \description 2806 2807bool tagtree_subentries_do_action(bool (*action_cb)(const char *file_name)) 2808 \group metadata 2809 \conditions (defined(HAVE_TAGCACHE)) 2810 \param action_cb 2811 \return 2812 \description 2813 2814void talk_date(const struct tm *tm, bool enqueue) 2815 \group talking 2816 \param tm 2817 \param enqueue 2818 \description 2819 2820int talk_dir_or_spell(const char* filename, const long *prefix_ids, bool enqueue) 2821 \group talking 2822 \param filename 2823 \param prefix_ids 2824 \param enqueue 2825 \return 2826 \description 2827 2828void talk_disable(bool disable) 2829 \group talking 2830 \param disable 2831 \description 2832 2833int talk_file(const char *root, const char *dir, const char *file, const char *ext, const long *prefix_ids, bool enqueue) 2834 \group talking 2835 \param root 2836 \param dir 2837 \param file 2838 \param ext 2839 \param prefix_ids 2840 \param enqueue 2841 \return 2842 \description 2843 2844int talk_file_or_spell(const char *dirname, const char* filename, const long *prefix_ids, bool enqueue) 2845 \group talking 2846 \param dirname 2847 \param filename 2848 \param prefix_ids 2849 \param enqueue 2850 \return 2851 \description 2852 2853void talk_force_enqueue_next(void) 2854 \group talking 2855 \description 2856 2857void talk_force_shutup(void) 2858 \group talking 2859 \description 2860 2861int talk_fullpath(const char* path, bool enqueue) 2862 \group talking 2863 \param path 2864 \param enqueue 2865 \return 2866 \description 2867 2868int talk_id(int32_t id, bool enqueue) 2869 \group talking 2870 \param id 2871 \param enqueue 2872 \return 2873 \description 2874 2875int talk_idarray(const long *idarray, bool enqueue) 2876 \group talking 2877 \param idarray 2878 \param enqueue 2879 \return 2880 \description 2881 2882int talk_number(long n, bool enqueue) 2883 \group talking 2884 \param n 2885 \param enqueue 2886 \return 2887 \description 2888 2889void talk_shutup(void) 2890 \group talking 2891 \description 2892 2893int talk_spell(const char* spell, bool enqueue) 2894 \group talking 2895 \param spell 2896 \param enqueue 2897 \return 2898 \description 2899 2900void talk_time(const struct tm *tm, bool enqueue) 2901 \group talking 2902 \param tm 2903 \param enqueue 2904 \description 2905 2906int talk_value_decimal(long n, int unit, int decimals, bool enqueue) 2907 \group talking 2908 \param n 2909 \param unit 2910 \param decimals 2911 \param enqueue 2912 \return 2913 \description 2914 2915void thread_exit(void) 2916 \group kernel/ system 2917 \description 2918 2919unsigned int thread_self(void) 2920 \group kernel/ system 2921 \return 2922 \description 2923 2924int thread_set_priority(unsigned int thread_id, int priority) 2925 \group kernel/ system 2926 \conditions (defined(HAVE_PRIORITY_SCHEDULING)) 2927 \param thread_id 2928 \param priority 2929 \return 2930 \description 2931 2932void thread_thaw(unsigned int thread_id) 2933 \group kernel/ system 2934 \param thread_id 2935 \description 2936 2937void thread_wait(unsigned int thread_id) 2938 \group kernel/ system 2939 \param thread_id 2940 \description 2941 2942bool timer_register(int reg_prio, void (*unregister_callback)(void), long cycles, void (*timer_callback)(void) IF_COP(, int core)) 2943 \param reg_prio 2944 \param unregister_callback 2945 \param cycles 2946 \param core 2947 \param timer_callback 2948 \return 2949 \description 2950 2951bool timer_set_period(long count) 2952 \param count 2953 \return 2954 \description 2955 2956void timer_unregister(void) 2957 \description 2958 2959enum touchscreen_mode touchscreen_get_mode(void) 2960 \group button 2961 \conditions (defined(HAVE_TOUCHSCREEN)) 2962 \return 2963 \description 2964 2965void touchscreen_set_mode(enum touchscreen_mode) 2966 \group button 2967 \conditions (defined(HAVE_TOUCHSCREEN)) 2968 \param touchscreen_mode 2969 \description 2970 2971struct tree_context* tree_get_context(void) 2972 \group browsing 2973 \return 2974 \description 2975 2976struct entry* tree_get_entries(struct tree_context* t) 2977 \group browsing 2978 \param t 2979 \return 2980 \description 2981 2982struct entry* tree_get_entry_at(struct tree_context* t, int index) 2983 \group browsing 2984 \param t 2985 \param index 2986 \return 2987 \description 2988 2989void trigger_cpu_boost(void) 2990 \group kernel/ system 2991 \conditions (defined(HAVE_SCHEDULER_BOOSTCTRL)) 2992 \description Boosts the CPU for the current thread 2993 2994void unregister_storage_idle_func(void (*function)(void), bool run) 2995 \group file 2996 \conditions (USING_STORAGE_CALLBACK) 2997 \param function 2998 \param run 2999 \description 3000 3001void usb_acknowledge(long id) 3002 \group usb 3003 \param id 3004 \description 3005 3006void usb_hid_send(usage_page_t usage_page, int id) 3007 \group usb 3008 \conditions (defined(USB_ENABLE_HID)) 3009 \param usage_page 3010 \param id 3011 \description 3012 3013bool usb_inserted(void) 3014 \group usb 3015 \return 3016 \description 3017 3018unsigned char* utf8encode(unsigned long ucs, unsigned char *utf8) 3019 \group unicode stuff 3020 \param ucs 3021 \param utf8 3022 \return 3023 \description 3024 3025unsigned long utf8length(const unsigned char *utf8) 3026 \group unicode stuff 3027 \param utf8 3028 \return 3029 \description 3030 3031int utf8seek(const unsigned char* utf8, int offset) 3032 \group unicode stuff 3033 \param utf8 3034 \param offset 3035 \return 3036 \description 3037 3038unsigned char* utf16BEdecode(const unsigned char *utf16, unsigned char *utf8, int count) 3039 \group unicode stuff 3040 \param utf16 3041 \param utf8 3042 \param count 3043 \return 3044 \description 3045 3046unsigned char* utf16LEdecode(const unsigned char *utf16, unsigned char *utf8, int count) 3047 \group unicode stuff 3048 \param utf16 3049 \param utf8 3050 \param count 3051 \return 3052 \description 3053 3054void viewportmanager_theme_enable(enum screen_type screen, bool enable, struct viewport *viewport) 3055 \param screen 3056 \param enable 3057 \param viewport 3058 \description 3059 3060void viewportmanager_theme_undo(enum screen_type screen, bool force_redraw) 3061 \param screen 3062 \param force_redraw 3063 \description 3064 3065void viewport_set_buffer(struct viewport *vp, struct frame_buffer_t *buffer, const enum screen_type screen) 3066 \param vp 3067 \param buffer 3068 \param screen 3069 \description 3070 3071void viewport_set_defaults(struct viewport *vp, const enum screen_type screen) 3072 \param vp 3073 \param screen 3074 \description 3075 3076void viewport_set_fullscreen(struct viewport *vp, const enum screen_type screen) 3077 \param vp 3078 \param screen 3079 \description 3080 3081int vsnprintf(char *buf, size_t size, const char *fmt, va_list ap) 3082 \group strings and memory 3083 \param buf 3084 \param size 3085 \param fmt 3086 \param ap 3087 \return 3088 \description 3089 3090int vuprintf(vuprintf_push_cb push, void *userp, const char *fmt, va_list ap) 3091 \group strings and memory 3092 \param push 3093 \param userp 3094 \param fmt 3095 \param ap 3096 \return 3097 \description 3098 3099bool warn_on_pl_erase(void) 3100 \group playback control 3101 \return 3102 \description 3103 3104void wheel_send_events(bool send) 3105 \conditions (defined(HAVE_WHEEL_POSITION)) 3106 \param send 3107 \description 3108 3109int wheel_status(void) 3110 \conditions (defined(HAVE_WHEEL_POSITION)) 3111 \return 3112 \description 3113 3114ssize_t write(int fildes, const void *buf, size_t nbyte) 3115 \group file 3116 \param fildes 3117 \param buf 3118 \param nbyte 3119 \return 3120 \description 3121 3122bool yesno_pop(const char* text) 3123 \group list 3124 \param text 3125 \return 3126 \description 3127 3128void yield(void) 3129 \group kernel/ system 3130 \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! 3131 \see [W[RockboxKernel]] 3132 3133void __div0(void) 3134 \group kernel/ system 3135 \conditions (defined(ARM_NEED_DIV0)) 3136 \description 3137 3138int * __errno(void) 3139 \group misc 3140 \conditions ((CONFIG_PLATFORM & PLATFORM_NATIVE)) 3141 \return 3142 \description 3143 3144# END