video: improve docs and design of multiview interlaced
authorWim Taymans <wim.taymans@collabora.co.uk>
Wed, 25 Apr 2012 13:27:04 +0000 (15:27 +0200)
committerWim Taymans <wim.taymans@collabora.co.uk>
Wed, 25 Apr 2012 13:27:04 +0000 (15:27 +0200)
Put fields of interlaced frames after eachother.
Improve the docs of the video interlaced enums.

docs/design/part-mediatype-video-raw.txt
gst-libs/gst/video/video.h

index 114594e..ee38d78 100644 (file)
@@ -31,8 +31,8 @@ Media Types
                      the frame and fields.
     "fields"       : 2 fields are stored in one buffer, use the frame ID
                      to get access to the required field. For multiview (the
-                     'views' property > 1) the second field of view N is at N +
-                     'views'.
+                     'views' property > 1) the fields of view N can be found at
+                     frame ID (N * 2) and (N * 2) + 1.
                      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. This mode requires multiple
index a256ff5..35ec822 100644 (file)
@@ -312,14 +312,15 @@ typedef struct _GstVideoFrame GstVideoFrame;
 /**
  * GstVideoInterlaceMode:
  * @GST_VIDEO_INTERLACE_MODE_PROGRESSIVE: all frames are progressive
- * @GST_VIDEO_INTERLACE_MODE_INTERLEAVED: video is interlaced and all fields
- *     are interlaced in one frame.
- * @GST_VIDEO_INTERLACE_MODE_MIXED: video contains both interlaced and
- *     progressive frames, the buffer flags describe the frame and fields.
+ * @GST_VIDEO_INTERLACE_MODE_INTERLEAVED: 2 fields are interleaved in one video
+ *     frame. Extra buffer flags describe the field order.
+ * @GST_VIDEO_INTERLACE_MODE_MIXED: frames contains both interlaced and
+ *     progressive video, the buffer flags describe the frame and fields.
  * @GST_VIDEO_INTERLACE_MODE_FIELDS: 2 fields are stored in one buffer, use the
  *     frame ID to get access to the required field. For multiview (the
- *     'views' property > 1) the second field of view N is at N + 'views'.
- *     Each view has only half the amount of lines as noted in the
+ *     'views' property > 1) the fields of view N can be found at frame ID
+ *     (N * 2) and (N * 2) + 1.
+ *     Each field has only half the amount of lines as noted in the
  *     height property. This mode requires multiple GstVideoMeta metadata
  *     to describe the fields.
  *