From a61b7728b4d03f61c130d5b5df67e1903fe84a3b Mon Sep 17 00:00:00 2001 From: Gwenole Beauchesne Date: Tue, 1 Jul 2014 16:09:28 +0200 Subject: [PATCH] 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. --- gst-libs/gst/codecparsers/gsth264parser.h | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/gst-libs/gst/codecparsers/gsth264parser.h b/gst-libs/gst/codecparsers/gsth264parser.h index 35dd55850..8b2ff65e6 100644 --- a/gst-libs/gst/codecparsers/gsth264parser.h +++ b/gst-libs/gst/codecparsers/gsth264parser.h @@ -241,16 +241,20 @@ typedef struct _GstH264SEIMessage GstH264SEIMessage; /** * GstH264NalUnit: - * @ref_idc: not equal to 0 specifies that the content of the NAL unit contains a sequence - * parameter set, a sequence * parameter set extension, a subset sequence parameter set, a - * picture parameter 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. + * @ref_idc: not equal to 0 specifies that the content of the NAL unit + * contains a sequence parameter set, a sequence parameter set + * extension, a subset sequence parameter set, a picture parameter + * 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 * @idr_pic_flag: calculated idr_pic_flag - * @size: The size of the nal unit starting from @offset - * @offset: The offset of the actual start of the nal unit - * @sc_offset:The offset of the start code of the nal unit - * @valid: If the nal unit is valid, which mean it has + * @size: The size of the nal unit starting from @offset, thus + * including the header bytes. e.g. @type (nal_unit_type) + * @offset: The offset of the actual start of the nal unit, thus + * 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 * @data: The data from which the Nalu has been parsed * -- 2.34.1