len0rd/rockbox
1
0
Fork 1
mirror of https://github.com/Rockbox/rockbox.git synced 2026-10-10 08:03:04 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

plugins: Convert all plugins to using mixer API for playback

Browse source 
pcm_play_data -> mixer_channel_play_data
pcm_set_frequeny -> mixer_set_frequency
pcm_play_stop -> audio_stop at startup / mixer_channel_stop at shutdown
pcm_is_playing -> mixer_channel_status

All of these have been removed from the plugin API.  Updated API docs to
clarify role of audio_stop() vs mixer_channel_stop()

Todo:  get rid of pcm_play_[un]lock().

Change-Id: I8800c131b51f064ee923a4c6e42aa405d33851fc
This commit is contained in:
Solomon Peachy 2026-02-21 08:02:12 -05:00
parent f6dfa5144d
commit 017dd72ff3
22 changed files with 113 additions and 178 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/PLUGIN_API
View file

@ -163,7 +163,7 @@ int audio_status(void)
void audio_stop(void)
\group playback control
\description
\description Gracefully shuts down the playback (ie codec) engine. Anything else playing back (talk/voice, other mixer channels) is unaffected.
void backlight_off(void)
\group For OLED targets like the Sansa Clip, the backlight_* functions control * the display enable, which has essentially the same effect.
@ -1775,27 +1775,10 @@ void pcm_init_recording(void)
\conditions (defined(HAVE_RECORDING))
\description
bool pcm_is_playing(void)
\group sound
\return true unless playback is paused
\description
void pcm_play_data(pcm_play_callback_type get_more, pcm_status_callback_type status_cb, const void *start, size_t size)
\group sound
\param get_more Optional callback
\param status_cb Optional status callback
\param start is the address of raw 16-16, interleaved PCM data
\param size is the size of the data to play
\description
void pcm_play_lock(void)
\group sound
\description
void pcm_play_stop(void)
\group sound
\description Stops the playback and empties the audio buffer.
void pcm_play_unlock(void)
\group sound
\description
@ -1809,11 +1792,6 @@ void pcm_record_data(pcm_rec_callback_type more_ready, pcm_status_callback_type
\param size
\description
void pcm_set_frequency(unsigned int frequency)
\group sound
\param frequency
\description
void pcm_stop_recording(void)
\group sound
\conditions (defined(HAVE_RECORDING))