From: Tim-Philipp Müller <tim.muller@collabora.co.uk>
Date: Mon, 9 Jul 2012 15:20:49 +0000 (+0100)
Subject: docs: update stream docs for SEGMENT_START event
X-Git-Tag: RELEASE-0.11.93~135
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=867051c7f6860c74e81e10b8c037ff6bc81f26f9;p=platform%2Fupstream%2Fgstreamer.git

docs: update stream docs for SEGMENT_START event
---

diff --git a/docs/design/part-caps.txt b/docs/design/part-caps.txt
index ac04b75..a768b6d 100644
--- a/docs/design/part-caps.txt
+++ b/docs/design/part-caps.txt
@@ -8,7 +8,8 @@ Caps are exposed on GstPadTemplates to describe all possible types a
 given pad can handle. They are also stored in the registry along with
 a description of the element.
 
-Caps are exposed on the element pads using the _get_caps() pad function.
+Caps are exposed on the element pads via CAPS and ACCEPT_CAPS queries.
+
 This function describes the possible types that the pad can handle or
 produce (see part-pads.txt and part-negotiation.txt).
 
diff --git a/docs/design/part-streams.txt b/docs/design/part-streams.txt
index ebc33d2..3a95634 100644
--- a/docs/design/part-streams.txt
+++ b/docs/design/part-streams.txt
@@ -11,10 +11,11 @@ Stream objects
 The following objects are to be expected in the streaming thread:
 
  - events
-    - SEGMENT           (S)
-    - EOS		(EOS)  *
+    - STREAM_START      (START)
+    - SEGMENT           (SEGMENT)
+    - EOS             * (EOS)
     - TAG               (T)
- - buffers              (B)    *
+ - buffers            * (B)
 
 Objects marked with * need to be synchronised to the clock in sinks
 and live sources.
@@ -23,16 +24,21 @@ and live sources.
 Typical stream
 ~~~~~~~~~~~~~~
 
- A typical stream starts with a segment event that marks the
+ A typical stream starts with a stream start event that marks the
+ start of the stream, followed by a segment event that marks the
  buffer timestamp range. After that buffers are sent one after the
  other. After the last buffer an EOS marks the end of the stream. No
  more buffers are to be processed after the EOS event.
 
-  +-+ +-++-+     +-+ +---+
-  |S| |B||B| ... |B| |EOS|
-  +-+ +-++-+     +-+ +---+
+  +-----+-------+ +-++-+     +-+ +---+
+  |START|SEGMENT| |B||B| ... |B| |EOS|
+  +-----+-------+ +-++-+     +-+ +---+
 
-  1) SEGMENT, rate, start/stop, time
+  1) STREAM_START
+     - marks the start of a stream; unlike the SEGMENT event, there
+       will be no STREAM_START event after flushing seeks.
+
+  2) SEGMENT, rate, start/stop, time
      - marks valid buffer timestamp range (start, stop)
      - marks stream_time of buffers (time). This is the stream time of buffers
        with a timestamp of NS.start.
@@ -42,7 +48,7 @@ Typical stream
      - marks running_time of buffers. This is the time used to synchronize
        against the clock.
 
-  2) N buffers
+  3) N buffers
      - displayable buffers are between start/stop of the SEGMENT. Buffers
        outside the segment range should be dropped or clipped.
 
@@ -62,9 +68,15 @@ Typical stream
 
         * current position in stream between 0 and duration.
 
-  3) EOS
+  4) EOS
      - 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
        event clears the EOS state of an element.
 
 
+Elements
+~~~~~~~~
+
+These events are generated typically either by the GstBaseSrc class for
+sources operating in push mode, or by a parser/demuxer operating in pull-mode
+and pushing parsed/demuxed data downstream.