mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-12 09:15:29 +00:00
Code Issues 1 Projects Releases Wiki Activity

design: streams: markup and readability fixes

Browse source
This commit is contained in:
Reynaldo H. Verdejo Pinochet 2016-12-30 00:24:42 -08:00
parent f2929cfdb6
commit 54a1f8e328
1 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
markdown/design/streams.md
View file

@ -8,10 +8,10 @@
The following objects are to be expected in the streaming thread: The following objects are to be expected in the streaming thread:
- events - events
- STREAM_START (START) - `STREAM_START` (START)
- SEGMENT (SEGMENT) - `SEGMENT` (SEGMENT)
- EOS * (EOS) - `EOS` * (EOS)
- TAG (T) - `TAG` (T)
- buffers * (B) - buffers * (B)
Objects marked with * need to be synchronised to the clock in sinks and Objects marked with * need to be synchronised to the clock in sinks and
@ -37,19 +37,19 @@ more buffers are to be processed after the EOS event.
2) **`SEGMENT`**, rate, start/stop, time 2) **`SEGMENT`**, rate, start/stop, time
- marks valid buffer timestamp range (start, stop) - marks valid buffer timestamp range (start, stop)
- marks stream_time of buffers (time). This is the stream time of buffers - marks `stream_time` of buffers (time). This is the stream time of buffers
with a timestamp of S.start. with a timestamp of S.start.
- marks playback rate (rate). This is the required playback rate. - marks playback rate (rate). This is the required playback rate.
- marks applied rate (applied_rate). This is the already applied playback - marks applied rate (`applied_rate`). This is the already applied playback
rate. (See also [trickmodes](design/trickmodes.md)) rate. (See also [trickmodes](design/trickmodes.md))
- marks running_time of buffers. This is the time used to synchronize - marks `running_time` of buffers. This is the time used to synchronize
against the clock. against the clock.
3) **N buffers** 3) **N buffers**
- displayable buffers are between start/stop of the SEGMENT (S). Buffers - displayable buffers are between start/stop of the `SEGMENT` (S). Buffers
outside the segment range should be dropped or clipped. outside the segment range should be dropped or clipped.
- running_time: - `running_time`:
``` ```
if (S.rate > 0.0) if (S.rate > 0.0)
@ -62,7 +62,7 @@ more buffers are to be processed after the EOS event.
against the clock (See also against the clock (See also
[synchronisation](design/synchronisation.md)). [synchronisation](design/synchronisation.md)).
- stream_time: - `stream_time`:
* current position in stream between 0 and duration. * current position in stream between 0 and duration.
``` ```
@ -71,12 +71,12 @@ more buffers are to be processed after the EOS event.
4) **`EOS`** 4) **`EOS`**
- marks the end of data, nothing is to be expected after EOS, elements - marks the end of data, nothing is to be expected after `EOS`, elements
should refuse more data and return GST_FLOW_EOS. A FLUSH_STOP should refuse more data and return `GST_FLOW_EOS`. A `FLUSH_STOP`
event clears the EOS state of an element. event clears the `EOS` state of an element.
## Elements ## Elements
These events are generated typically either by the GstBaseSrc class for These events are generated typically either by the `GstBaseSrc` class for
sources operating in push mode, or by a parser/demuxer operating in sources operating in push mode, or by a parser/demuxer operating in
pull-mode and pushing parsed/demuxed data downstream. pull-mode and pushing parsed/demuxed data downstream.