mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-03 09:01:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: spa: Minor improvements to driver architecture documentation

Browse source
This commit is contained in:
Carlos Rafael Giani 2025-07-23 21:01:59 +02:00 • committed by Wim Taymans
parent c7838cbbcb
commit 1ed8f771bd
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/dox/internals/driver.dox
View file

@ -37,7 +37,7 @@ updated as follows:
- \ref spa_io_clock::rate : Set to a value that can translate samples to nanoseconds. - \ref spa_io_clock::rate : Set to a value that can translate samples to nanoseconds.
- \ref spa_io_clock::position : Current cycle position, in samples. This is the - \ref spa_io_clock::position : Current cycle position, in samples. This is the
ideal position of the graph cycle (this is explained in greater detail further below). ideal position of the graph cycle (this is explained in greater detail further below).
It is incremented by the dduration (in samples) at the beginning of each cycle. If It is incremented by the duration (in samples) at the beginning of each cycle. If
a discontinuity is experienced by the driver that results in a discontinuity in the a discontinuity is experienced by the driver that results in a discontinuity in the
position of the old and the current cycle, consider setting the position of the old and the current cycle, consider setting the
\ref SPA_IO_CLOCK_FLAG_DISCONT flag to inform other nodes about this. \ref SPA_IO_CLOCK_FLAG_DISCONT flag to inform other nodes about this.
@ -66,7 +66,11 @@ is the moment in monotonic clock time when the cycle _actually_ happens. This is
an important distinction when driver is run by a clock that is different to the monotonic an important distinction when driver is run by a clock that is different to the monotonic
cloc. In that case, the \ref spa_io_clock::nsec timestamps are adjusted to match the pace cloc. In that case, the \ref spa_io_clock::nsec timestamps are adjusted to match the pace
of that different clock (explained in the section below). In such a case, of that different clock (explained in the section below). In such a case,
\ref spa_io_clock::position still is incremented by the duration in samples. \ref spa_io_clock::position still is incremented by the duration in samples. This
is important, since nodes and modules may use this field as an offset within their own
internal ring buffers or similar structures, using the position field as an offset within
said data structures. This requires the position field to advance in a continuous way.
By incrementing by the duration, this requirement is met.
# Using clocks other than the monotonic clock # Using clocks other than the monotonic clock