summaryrefslogtreecommitdiff
path: root/docs/PLUGIN_API
diff options
context:
space:
mode:
Diffstat (limited to 'docs/PLUGIN_API')
-rw-r--r--docs/PLUGIN_API77
1 files changed, 10 insertions, 67 deletions
diff --git a/docs/PLUGIN_API b/docs/PLUGIN_API
index e7ab119f97..7cd04cc410 100644
--- a/docs/PLUGIN_API
+++ b/docs/PLUGIN_API
@@ -111,20 +111,20 @@ void audio_resume(void)
111 111
112void audio_set_input_source(int source, unsigned flags) 112void audio_set_input_source(int source, unsigned flags)
113 \group sound 113 \group sound
114 \conditions (CONFIG_CODEC == SWCODEC) && (INPUT_SRC_CAPS != 0) 114 \conditions (INPUT_SRC_CAPS != 0)
115 \param source 115 \param source
116 \param flags 116 \param flags
117 \description 117 \description
118 118
119void audio_set_output_source(int monitor) 119void audio_set_output_source(int monitor)
120 \group sound 120 \group sound
121 \conditions (CONFIG_CODEC == SWCODEC) && (INPUT_SRC_CAPS != 0) 121 \conditions (INPUT_SRC_CAPS != 0)
122 \param monitor 122 \param monitor
123 \description 123 \description
124 124
125void audio_set_recording_gain(int left, int right, int type) 125void audio_set_recording_gain(int left, int right, int type)
126 \group sound 126 \group sound
127 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING)) 127 \conditions (defined(HAVE_RECORDING))
128 \param left 128 \param left
129 \param right 129 \param right
130 \param type 130 \param type
@@ -191,16 +191,8 @@ unsigned short *bidi_l2v( const unsigned char *str, int orientation )
191 \return 191 \return
192 \description 192 \description
193 193
194void bitswap(unsigned char *data, int length)
195 \group sound
196 \conditions (!defined(SIMULATOR)) && (CONFIG_CODEC != SWCODEC)
197 \param data
198 \param length
199 \description Swap the bits for each element of array =data= of size =length=
200
201int bufadvance(int handle_id, off_t offset) 194int bufadvance(int handle_id, off_t offset)
202 \group buffering API 195 \group buffering API
203 \conditions ((CONFIG_CODEC == SWCODEC))
204 \param handle_id 196 \param handle_id
205 \param offset 197 \param offset
206 \return 198 \return
@@ -208,7 +200,6 @@ int bufadvance(int handle_id, off_t offset)
208 200
209int bufalloc(const void *src, size_t size, enum data_type type) 201int bufalloc(const void *src, size_t size, enum data_type type)
210 \group buffering API 202 \group buffering API
211 \conditions ((CONFIG_CODEC == SWCODEC))
212 \param src 203 \param src
213 \param size 204 \param size
214 \param type 205 \param type
@@ -217,14 +208,12 @@ int bufalloc(const void *src, size_t size, enum data_type type)
217 208
218bool bufclose(int handle_id) 209bool bufclose(int handle_id)
219 \group buffering API 210 \group buffering API
220 \conditions ((CONFIG_CODEC == SWCODEC))
221 \param handle_id 211 \param handle_id
222 \return 212 \return
223 \description 213 \description
224 214
225ssize_t bufcuttail(int handle_id, size_t size) 215ssize_t bufcuttail(int handle_id, size_t size)
226 \group buffering API 216 \group buffering API
227 \conditions ((CONFIG_CODEC == SWCODEC))
228 \param handle_id 217 \param handle_id
229 \param size 218 \param size
230 \return 219 \return
@@ -232,7 +221,6 @@ ssize_t bufcuttail(int handle_id, size_t size)
232 221
233ssize_t bufgetdata(int handle_id, size_t size, void **data) 222ssize_t bufgetdata(int handle_id, size_t size, void **data)
234 \group buffering API 223 \group buffering API
235 \conditions ((CONFIG_CODEC == SWCODEC))
236 \param handle_id 224 \param handle_id
237 \param size 225 \param size
238 \param data 226 \param data
@@ -241,7 +229,6 @@ ssize_t bufgetdata(int handle_id, size_t size, void **data)
241 229
242ssize_t bufgettail(int handle_id, size_t size, void **data) 230ssize_t bufgettail(int handle_id, size_t size, void **data)
243 \group buffering API 231 \group buffering API
244 \conditions ((CONFIG_CODEC == SWCODEC))
245 \param handle_id 232 \param handle_id
246 \param size 233 \param size
247 \param data 234 \param data
@@ -250,7 +237,6 @@ ssize_t bufgettail(int handle_id, size_t size, void **data)
250 237
251int bufopen(const char *file, size_t offset, enum data_type type) 238int bufopen(const char *file, size_t offset, enum data_type type)
252 \group buffering API 239 \group buffering API
253 \conditions ((CONFIG_CODEC == SWCODEC))
254 \param file 240 \param file
255 \param offset 241 \param offset
256 \param type 242 \param type
@@ -259,7 +245,6 @@ int bufopen(const char *file, size_t offset, enum data_type type)
259 245
260ssize_t bufread(int handle_id, size_t size, void *dest) 246ssize_t bufread(int handle_id, size_t size, void *dest)
261 \group buffering API 247 \group buffering API
262 \conditions ((CONFIG_CODEC == SWCODEC))
263 \param handle_id 248 \param handle_id
264 \param size 249 \param size
265 \param dest 250 \param dest
@@ -268,37 +253,31 @@ ssize_t bufread(int handle_id, size_t size, void *dest)
268 253
269int bufseek(int handle_id, size_t newpos) 254int bufseek(int handle_id, size_t newpos)
270 \group buffering API 255 \group buffering API
271 \conditions ((CONFIG_CODEC == SWCODEC))
272 \param handle_id 256 \param handle_id
273 \param newpos 257 \param newpos
274 \return 258 \return
275 \description 259 \description
276 260
277ssize_t buf_get_offset(int handle_id, void *ptr) 261ssize_t buf_get_offset(int handle_id, void *ptr)
278 \conditions ((CONFIG_CODEC == SWCODEC))
279 \param handle_id 262 \param handle_id
280 \param ptr 263 \param ptr
281 \return 264 \return
282 \description 265 \description
283 266
284ssize_t buf_handle_offset(int handle_id) 267ssize_t buf_handle_offset(int handle_id)
285 \conditions ((CONFIG_CODEC == SWCODEC))
286 \param handle_id 268 \param handle_id
287 \return 269 \return
288 \description 270 \description
289 271
290void buf_request_buffer_handle(int handle_id) 272void buf_request_buffer_handle(int handle_id)
291 \conditions ((CONFIG_CODEC == SWCODEC))
292 \param handle_id 273 \param handle_id
293 \description 274 \description
294 275
295void buf_set_base_handle(int handle_id) 276void buf_set_base_handle(int handle_id)
296 \conditions ((CONFIG_CODEC == SWCODEC))
297 \param handle_id 277 \param handle_id
298 \description 278 \description
299 279
300size_t buf_used(void) 280size_t buf_used(void)
301 \conditions ((CONFIG_CODEC == SWCODEC))
302 \return 281 \return
303 \description 282 \description
304 283
@@ -410,7 +389,6 @@ int closedir(DIR* dir)
410 389
411int codec_load_file(const char* codec, struct codec_api *api) 390int codec_load_file(const char* codec, struct codec_api *api)
412 \group misc 391 \group misc
413 \conditions (CONFIG_CODEC == SWCODEC)
414 \param codec 392 \param codec
415 \param api 393 \param api
416 \return 394 \return
@@ -540,7 +518,6 @@ int do_menu(const struct menu_item_ex *menu, int *start_selected, struct viewpor
540 518
541intptr_t dsp_configure(struct dsp_config *dsp, int setting, intptr_t value) 519intptr_t dsp_configure(struct dsp_config *dsp, int setting, intptr_t value)
542 \group sound 520 \group sound
543 \conditions (CONFIG_CODEC == SWCODEC)
544 \param dsp 521 \param dsp
545 \param setting 522 \param setting
546 \param value 523 \param value
@@ -549,13 +526,11 @@ intptr_t dsp_configure(struct dsp_config *dsp, int setting, intptr_t value)
549 526
550void dsp_dither_enable(bool enable) 527void dsp_dither_enable(bool enable)
551 \group sound 528 \group sound
552 \conditions (CONFIG_CODEC == SWCODEC)
553 \param enable 529 \param enable
554 \description 530 \description
555 531
556int dsp_process(struct dsp_config *dsp, char *dest, const char *src[], int count) 532int dsp_process(struct dsp_config *dsp, char *dest, const char *src[], int count)
557 \group sound 533 \group sound
558 \conditions (CONFIG_CODEC == SWCODEC)
559 \param dsp 534 \param dsp
560 \param dest 535 \param dest
561 \param src[] 536 \param src[]
@@ -565,13 +540,11 @@ int dsp_process(struct dsp_config *dsp, char *dest, const char *src[], int count
565 540
566void dsp_set_crossfeed(bool enable) 541void dsp_set_crossfeed(bool enable)
567 \group sound 542 \group sound
568 \conditions (CONFIG_CODEC == SWCODEC)
569 \param enable 543 \param enable
570 \description 544 \description
571 545
572void dsp_set_eq(bool enable) 546void dsp_set_eq(bool enable)
573 \group sound 547 \group sound
574 \conditions (CONFIG_CODEC == SWCODEC)
575 \param enable 548 \param enable
576 \description 549 \description
577 550
@@ -666,7 +639,6 @@ int get_action(int context, int timeout)
666 639
667const char *get_codec_filename(int cod_spec) 640const char *get_codec_filename(int cod_spec)
668 \group misc 641 \group misc
669 \conditions (CONFIG_CODEC == SWCODEC)
670 \param cod_spec 642 \param cod_spec
671 \return 643 \return
672 \description 644 \description
@@ -681,7 +653,6 @@ int get_custom_action(int context,int timeout, const struct button_mapping* (*ge
681 653
682bool get_metadata(struct mp3entry* id3, int fd, const char* trackname) 654bool get_metadata(struct mp3entry* id3, int fd, const char* trackname)
683 \group misc 655 \group misc
684 \conditions (CONFIG_CODEC == SWCODEC)
685 \param id3 656 \param id3
686 \param fd 657 \param fd
687 \param trackname 658 \param trackname
@@ -1342,19 +1313,17 @@ void logf(const char *fmt, ...) ATTRIBUTE_PRINTF(1, 2)
1342 1313
1343const unsigned long *audio_master_sampr_list 1314const unsigned long *audio_master_sampr_list
1344 \group sound 1315 \group sound
1345 \conditions (CONFIG_CODEC == SWCODEC)
1346 \return 1316 \return
1347 \description 1317 \description
1348 1318
1349const unsigned long *hw_freq_sampr 1319const unsigned long *hw_freq_sampr
1350 \group sound 1320 \group sound
1351 \conditions (CONFIG_CODEC == SWCODEC)
1352 \return 1321 \return
1353 \description 1322 \description
1354 1323
1355const unsigned long *rec_freq_sampr 1324const unsigned long *rec_freq_sampr
1356 \group sound 1325 \group sound
1357 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING)) 1326 \conditions defined(HAVE_RECORDING)
1358 \return 1327 \return
1359 \description 1328 \description
1360 1329
@@ -1443,27 +1412,18 @@ void mp3_play_stop(void)
1443 \conditions (!defined(SIMULATOR)) 1412 \conditions (!defined(SIMULATOR))
1444 \description Stops playback 1413 \description Stops playback
1445 1414
1446unsigned long mpeg_get_last_header(void)
1447 \group playback control
1448 \conditions (!defined(SIMULATOR) && (CONFIG_CODEC != SWCODEC))
1449 \return
1450 \description
1451
1452void mutex_init(struct mutex *m) 1415void mutex_init(struct mutex *m)
1453 \group kernel/ system 1416 \group kernel/ system
1454 \conditions (CONFIG_CODEC == SWCODEC)
1455 \param m 1417 \param m
1456 \description 1418 \description
1457 1419
1458void mutex_lock(struct mutex *m) 1420void mutex_lock(struct mutex *m)
1459 \group kernel/ system 1421 \group kernel/ system
1460 \conditions (CONFIG_CODEC == SWCODEC)
1461 \param m 1422 \param m
1462 \description 1423 \description
1463 1424
1464void mutex_unlock(struct mutex *m) 1425void mutex_unlock(struct mutex *m)
1465 \group kernel/ system 1426 \group kernel/ system
1466 \conditions (CONFIG_CODEC == SWCODEC)
1467 \param m 1427 \param m
1468 \description 1428 \description
1469 1429
@@ -1484,54 +1444,48 @@ bool option_screen(const struct settings_list *setting, struct viewport parent[N
1484 1444
1485void pcm_apply_settings(void) 1445void pcm_apply_settings(void)
1486 \group sound 1446 \group sound
1487 \conditions (CONFIG_CODEC == SWCODEC)
1488 \description 1447 \description
1489 1448
1490void pcm_calculate_peaks(int *left, int *right) 1449void pcm_calculate_peaks(int *left, int *right)
1491 \group sound 1450 \group sound
1492 \conditions (CONFIG_CODEC == SWCODEC)
1493 \param left 1451 \param left
1494 \param right 1452 \param right
1495 \description 1453 \description
1496 1454
1497void pcm_calculate_rec_peaks(int *left, int *right) 1455void pcm_calculate_rec_peaks(int *left, int *right)
1498 \group sound 1456 \group sound
1499 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING)) 1457 \conditions defined(HAVE_RECORDING)
1500 \param left 1458 \param left
1501 \param right 1459 \param right
1502 \description 1460 \description
1503 1461
1504void pcm_close_recording(void) 1462void pcm_close_recording(void)
1505 \group sound 1463 \group sound
1506 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING)) 1464 \conditions defined(HAVE_RECORDING)
1507 \description 1465 \description
1508 1466
1509size_t pcm_get_bytes_waiting(void) 1467size_t pcm_get_bytes_waiting(void)
1510 \group sound 1468 \group sound
1511 \conditions (CONFIG_CODEC == SWCODEC)
1512 \return 1469 \return
1513 \description 1470 \description
1514 1471
1515void pcm_init_recording(void) 1472void pcm_init_recording(void)
1516 \group sound 1473 \group sound
1517 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING)) 1474 \conditions defined(HAVE_RECORDING)
1518 \description 1475 \description
1519 1476
1520bool pcm_is_paused(void) 1477bool pcm_is_paused(void)
1521 \group sound 1478 \group sound
1522 \conditions (CONFIG_CODEC == SWCODEC)
1523 \return true if playback is paused, else false 1479 \return true if playback is paused, else false
1524 \description 1480 \description
1525 1481
1526bool pcm_is_playing(void) 1482bool pcm_is_playing(void)
1527 \group sound 1483 \group sound
1528 \conditions (CONFIG_CODEC == SWCODEC)
1529 \return true unless playback is paused 1484 \return true unless playback is paused
1530 \description 1485 \description
1531 1486
1532void pcm_play_data(pcm_more_callback_type get_more, unsigned char* start, size_t size) 1487void pcm_play_data(pcm_more_callback_type get_more, unsigned char* start, size_t size)
1533 \group sound 1488 \group sound
1534 \conditions (CONFIG_CODEC == SWCODEC)
1535 \param get_more Optional callback 1489 \param get_more Optional callback
1536 \param start is the address of raw 16-16, interleaved PCM data 1490 \param start is the address of raw 16-16, interleaved PCM data
1537 \param size is the size of the data to play 1491 \param size is the size of the data to play
@@ -1539,28 +1493,24 @@ void pcm_play_data(pcm_more_callback_type get_more, unsigned char* start, size_t
1539 1493
1540void pcm_play_lock(void) 1494void pcm_play_lock(void)
1541 \group sound 1495 \group sound
1542 \conditions (CONFIG_CODEC == SWCODEC)
1543 \description 1496 \description
1544 1497
1545void pcm_play_pause(bool play) 1498void pcm_play_pause(bool play)
1546 \group sound 1499 \group sound
1547 \conditions (CONFIG_CODEC == SWCODEC)
1548 \param play 1500 \param play
1549 \description Pauses or unpauses the playback depending on the truth value of =play= 1501 \description Pauses or unpauses the playback depending on the truth value of =play=
1550 1502
1551void pcm_play_stop(void) 1503void pcm_play_stop(void)
1552 \group sound 1504 \group sound
1553 \conditions (CONFIG_CODEC == SWCODEC)
1554 \description Stops the playback and empties the audio buffer unlike [F[pcm_play_pause]] 1505 \description Stops the playback and empties the audio buffer unlike [F[pcm_play_pause]]
1555 1506
1556void pcm_play_unlock(void) 1507void pcm_play_unlock(void)
1557 \group sound 1508 \group sound
1558 \conditions (CONFIG_CODEC == SWCODEC)
1559 \description 1509 \description
1560 1510
1561void pcm_record_data(pcm_more_callback_type2 more_ready, void *start, size_t size) 1511void pcm_record_data(pcm_more_callback_type2 more_ready, void *start, size_t size)
1562 \group sound 1512 \group sound
1563 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING)) 1513 \conditions defined(HAVE_RECORDING)
1564 \param more_ready 1514 \param more_ready
1565 \param start 1515 \param start
1566 \param size 1516 \param size
@@ -1568,20 +1518,19 @@ void pcm_record_data(pcm_more_callback_type2 more_ready, void *start, size_t siz
1568 1518
1569void pcm_record_more(void *start, size_t size) 1519void pcm_record_more(void *start, size_t size)
1570 \group sound 1520 \group sound
1571 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING)) 1521 \conditions defined(HAVE_RECORDING)
1572 \param start 1522 \param start
1573 \param size 1523 \param size
1574 \description 1524 \description
1575 1525
1576void pcm_set_frequency(unsigned int frequency) 1526void pcm_set_frequency(unsigned int frequency)
1577 \group sound 1527 \group sound
1578 \conditions (CONFIG_CODEC == SWCODEC)
1579 \param frequency 1528 \param frequency
1580 \description 1529 \description
1581 1530
1582void pcm_stop_recording(void) 1531void pcm_stop_recording(void)
1583 \group sound 1532 \group sound
1584 \conditions (CONFIG_CODEC == SWCODEC) && (defined(HAVE_RECORDING)) 1533 \conditions defined(HAVE_RECORDING)
1585 \description 1534 \description
1586 1535
1587int playlist_amount(void) 1536int playlist_amount(void)
@@ -1757,13 +1706,11 @@ void queue_delete(struct event_queue *q)
1757 \description 1706 \description
1758 1707
1759bool queue_empty(const struct event_queue *q) 1708bool queue_empty(const struct event_queue *q)
1760 \conditions (CONFIG_CODEC == SWCODEC)
1761 \param q 1709 \param q
1762 \return 1710 \return
1763 \description 1711 \description
1764 1712
1765void queue_enable_queue_send(struct event_queue *q, struct queue_sender_list *send, struct thread_entry *owner) 1713void queue_enable_queue_send(struct event_queue *q, struct queue_sender_list *send, struct thread_entry *owner)
1766 \conditions (CONFIG_CODEC == SWCODEC)
1767 \param q 1714 \param q
1768 \param send 1715 \param send
1769 \param owner 1716 \param owner
@@ -1781,13 +1728,11 @@ void queue_post(struct event_queue *q, long id, intptr_t data)
1781 \description 1728 \description
1782 1729
1783void queue_reply(struct event_queue *q, intptr_t retval) 1730void queue_reply(struct event_queue *q, intptr_t retval)
1784 \conditions (CONFIG_CODEC == SWCODEC)
1785 \param q 1731 \param q
1786 \param retval 1732 \param retval
1787 \description 1733 \description
1788 1734
1789intptr_t queue_send(struct event_queue *q, long id, intptr_t data) 1735intptr_t queue_send(struct event_queue *q, long id, intptr_t data)
1790 \conditions (CONFIG_CODEC == SWCODEC)
1791 \param q 1736 \param q
1792 \param id 1737 \param id
1793 \param data 1738 \param data
@@ -1795,7 +1740,6 @@ intptr_t queue_send(struct event_queue *q, long id, intptr_t data)
1795 \description 1740 \description
1796 1741
1797void queue_wait(struct event_queue *q, struct queue_event *ev) 1742void queue_wait(struct event_queue *q, struct queue_event *ev)
1798 \conditions (CONFIG_CODEC == SWCODEC)
1799 \param q 1743 \param q
1800 \param ev 1744 \param ev
1801 \description 1745 \description
@@ -2066,7 +2010,6 @@ void sound_set(int setting, int value)
2066 2010
2067void sound_set_pitch(int pitch) 2011void sound_set_pitch(int pitch)
2068 \group playback control 2012 \group playback control
2069 \conditions (CONFIG_CODEC == SWCODEC)
2070 \param pitch 2013 \param pitch
2071 \description 2014 \description
2072 2015