video-format: Document usage of GST_VIDEO_FORMAT_ENCODED

This must only ever be used in caps in combination with a non-system
memory GstCapsFeatures, and where it does not make sense to specify
any of the other video formats. Examples of this would be in gst-vaapi.
This commit is contained in:
Sebastian Dröge 2013-12-17 17:25:07 +01:00
parent 8499a0e35a
commit 27c1261c72

View file

@ -29,7 +29,10 @@ G_BEGIN_DECLS
/**
* GstVideoFormat:
* @GST_VIDEO_FORMAT_UNKNOWN: Unknown or unset video format id
* @GST_VIDEO_FORMAT_ENCODED: Encoded video format
* @GST_VIDEO_FORMAT_ENCODED: Encoded video format. Only ever use that in caps for
* special video formats in combination with non-system
* memory GstCapsFeatures where it does not make sense
* to specify a real video format.
* @GST_VIDEO_FORMAT_I420: planar 4:2:0 YUV
* @GST_VIDEO_FORMAT_YV12: planar 4:2:0 YVU (like I420 but UV planes swapped)
* @GST_VIDEO_FORMAT_YUY2: packed 4:2:2 YUV (Y0-U0-Y1-V0 Y2-U2-Y3-V2 Y4 ...)