codecparsers: h264: clarifications and documentation fixes.

Fix documentation for GstH264NalUnit. The @ref_idc part was totally
unbalanced. Also add a note about @offset and @size fields to remind
that this is relative to the start of the NAL unit, thus including
the header bytes.
This commit is contained in:
Gwenole Beauchesne 2014-07-01 16:09:28 +02:00
parent 22b68b60ec
commit a61b7728b4

View file

@ -241,16 +241,20 @@ typedef struct _GstH264SEIMessage GstH264SEIMessage;
/** /**
* GstH264NalUnit: * GstH264NalUnit:
* @ref_idc: not equal to 0 specifies that the content of the NAL unit contains a sequence * @ref_idc: not equal to 0 specifies that the content of the NAL unit
* parameter set, a sequence * parameter set extension, a subset sequence parameter set, a * contains a sequence parameter set, a sequence parameter set
* picture parameter set, a slice of a reference picture, a slice data partition of a * extension, a subset sequence parameter set, a picture parameter
* reference picture, or a prefix NAL unit preceding a slice of a reference picture. * set, a slice of a reference picture, a slice data partition of a
* reference picture, or a prefix NAL unit preceding a slice of a
* reference picture.
* @type: A #GstH264NalUnitType * @type: A #GstH264NalUnitType
* @idr_pic_flag: calculated idr_pic_flag * @idr_pic_flag: calculated idr_pic_flag
* @size: The size of the nal unit starting from @offset * @size: The size of the nal unit starting from @offset, thus
* @offset: The offset of the actual start of the nal unit * including the header bytes. e.g. @type (nal_unit_type)
* @sc_offset:The offset of the start code of the nal unit * @offset: The offset of the actual start of the nal unit, thus
* @valid: If the nal unit is valid, which mean it has * including the header bytes
* @sc_offset: The offset of the start code of the nal unit
* @valid: If the nal unit is valid, which means it has
* already been parsed * already been parsed
* @data: The data from which the Nalu has been parsed * @data: The data from which the Nalu has been parsed
* *