mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-12-16 08:56:45 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

stream: clarify buffer onwership and lifecycle

Browse source 
Fixes #1126
This commit is contained in:
Wim Taymans 2021-06-01 12:25:44 +02:00
parent f544e4d87c
commit 0f55ff9e60
1 changed files with 10 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/pipewire/stream.h
View file

@ -98,7 +98,8 @@ extern "C" {
* *
* With the add_buffer event, a stream will be notified of a new buffer * With the add_buffer event, a stream will be notified of a new buffer
* that can be used for data transport. You can attach user_data to these * that can be used for data transport. You can attach user_data to these
* buffers. * buffers. The buffers can only be used with the stream that emitted
* the add_buffer event.
* *
* After the buffers are negotiated, the stream will transition to the * After the buffers are negotiated, the stream will transition to the
* \ref PW_STREAM_STATE_PAUSED state. * \ref PW_STREAM_STATE_PAUSED state.
@ -121,13 +122,19 @@ extern "C" {
* \ref pw_stream_dequeue_buffer() should be used to get the data and * \ref pw_stream_dequeue_buffer() should be used to get the data and
* metadata of the buffer. * metadata of the buffer.
* *
* When the buffer is no longer in use, call \ref pw_stream_queue_buffer() * The buffer is owned by the stream and stays alive until the
* remove_buffer event is emitted or the stream is destroyed.
*
* When the buffer has been processed, call \ref pw_stream_queue_buffer()
* to let PipeWire reuse the buffer. * to let PipeWire reuse the buffer.
* *
* \subsection ssec_produce Produce data * \subsection ssec_produce Produce data
* *
* \ref pw_stream_dequeue_buffer() gives an empty buffer that can be filled. * \ref pw_stream_dequeue_buffer() gives an empty buffer that can be filled.
* *
* The buffer is owned by the stream and stays alive until the
* remove_buffer event is emitted or the stream is destroyed.
*
* Filled buffers should be queued with \ref pw_stream_queue_buffer(). * Filled buffers should be queued with \ref pw_stream_queue_buffer().
* *
* The process event is emitted when PipeWire has emptied a buffer that * The process event is emitted when PipeWire has emptied a buffer that