docs: small update to design docs
authorWim Taymans <wim.taymans@collabora.co.uk>
Tue, 20 Dec 2011 09:08:46 +0000 (10:08 +0100)
committerWim Taymans <wim.taymans@collabora.co.uk>
Tue, 20 Dec 2011 09:08:46 +0000 (10:08 +0100)
docs/design/design-audiosinks.txt
docs/design/part-interlaced-video.txt
docs/design/part-mediatype-video-raw.txt [moved from docs/design/draft-media-types.txt with 99% similarity]
docs/design/part-playbin.txt [moved from docs/design/part-playbin2.txt with 100% similarity]

index bb8ab2d..e2dafad 100644 (file)
@@ -37,7 +37,7 @@ Design:
    +-----+-----+
          |
    +-----V----------+   - manages ringbuffer
-   + baseaudiosink  +   - manages scheduling (push/pull)
+   + audiobasesink  +   - manages scheduling (push/pull)
    +-----+----------+   - manages clock/query/seek
          |              - manages scheduling of samples in the ringbuffer
          |              - manages caps parsing
@@ -106,7 +106,7 @@ Scheduling:
 
   - getrange based mode
 
-    In getrange based mode, the baseaudiosink will use the callback function
+    In getrange based mode, the audiobasesink will use the callback function
     of the ringbuffer to get a segsize samples from the peer element. These
     samples will then be placed in the ringbuffer at the next play position.
     It is assumed that the getrange function returns fast enough to fill the
@@ -120,7 +120,7 @@ Scheduling:
 DMA mode:
 
   - Elements that can do DMA based access to the audio device have to subclass
-    from the GstBaseAudioSink class and wrap the DMA ringbuffer in a subclass
+    from the GstAudioBaseSink class and wrap the DMA ringbuffer in a subclass
     of GstRingBuffer.
     
     The ringbuffer subclass should trigger a callback after writing or playing
@@ -130,7 +130,7 @@ DMA mode:
 
 Clocks:
 
-   The GstBaseAudioSink class will use the ringbuffer to act as a clock provider.
+   The GstAudioBaseSink class will use the ringbuffer to act as a clock provider.
    It can do this by using the play pointer and the delay to calculate the
    clock time.
   
index 6593146..9bd3044 100644 (file)
@@ -1,3 +1,5 @@
+** outdated **
+
 Interlaced Video
 ================
 
similarity index 99%
rename from docs/design/draft-media-types.txt
rename to docs/design/part-mediatype-video-raw.txt
index f50e838..e46e567 100644 (file)
@@ -18,7 +18,7 @@ Media Types
 
   views, G_TYPE_INT, default 1
     The number of views for multiview video. Each buffer contains
-    multiple GstMetaVideo buffers that describe each view. use the frame id to
+    multiple GstVideoMeta buffers that describe each view. use the frame id to
     get access to the different views.
 
   interlace-mode, G_TYPE_STRING, default progressive
@@ -34,7 +34,8 @@ Media Types
                      views property > 1) the second field of view N is at N * 2.
                      Each view has only half the amount of lines as noted in the
                      height property, pads specifying the "fields" property
-                     must be prepared for this.
+                     must be prepared for this. This mode requires multiple
+                     GstVideoMeta metadata to describe the fields.
 
   chroma-site, G_TYPE_STRING, default UNKNOWN
     The chroma siting of the video frames.