From 3e626122596011f2cd2ccd728a317f507cd9ca77 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim-Philipp=20M=C3=BCller?= Date: Wed, 29 Oct 2014 13:15:51 +0000 Subject: [PATCH] codecparsers: sprinkle some gtk-doc Since: markers for new API --- gst-libs/gst/codecparsers/gsth264parser.c | 6 ++++ gst-libs/gst/codecparsers/gsth264parser.h | 40 +++++++++++++++++++++-- 2 files changed, 44 insertions(+), 2 deletions(-) diff --git a/gst-libs/gst/codecparsers/gsth264parser.c b/gst-libs/gst/codecparsers/gsth264parser.c index 734a18d634..f481241af9 100644 --- a/gst-libs/gst/codecparsers/gsth264parser.c +++ b/gst-libs/gst/codecparsers/gsth264parser.c @@ -1829,6 +1829,8 @@ error: * syntax elements are not parsed and no extra memory is allocated. * * Returns: a #GstH264ParserResult + * + * Since: 1.6 */ GstH264ParserResult gst_h264_parser_parse_subset_sps (GstH264NalParser * nalparser, @@ -1865,6 +1867,8 @@ gst_h264_parser_parse_subset_sps (GstH264NalParser * nalparser, * syntax elements are not parsed and no extra memory is allocated. * * Returns: a #GstH264ParserResult + * + * Since: 1.6 */ GstH264ParserResult gst_h264_parse_subset_sps (GstH264NalUnit * nalu, GstH264SPS * sps, @@ -2297,6 +2301,8 @@ gst_h264_sps_mvc_clear (GstH264SPS * sps) * @sps: The #GstH264SPS to free * * Clears all @sps internal resources. + * + * Since: 1.6 */ void gst_h264_sps_clear (GstH264SPS * sps) diff --git a/gst-libs/gst/codecparsers/gsth264parser.h b/gst-libs/gst/codecparsers/gsth264parser.h index 12853d05bb..a6aaa223b3 100644 --- a/gst-libs/gst/codecparsers/gsth264parser.h +++ b/gst-libs/gst/codecparsers/gsth264parser.h @@ -50,6 +50,14 @@ G_BEGIN_DECLS #define GST_H264_IS_SP_SLICE(slice) (((slice)->type % 5) == GST_H264_SP_SLICE) #define GST_H264_IS_SI_SLICE(slice) (((slice)->type % 5) == GST_H264_SI_SLICE) +/** + * GST_H264_IS_MVC_NALU: + * @nalu: a #GstH264NalUnit + * + * Check if @nalu is a multiview extension NAL unit. + * + * Since: 1.6 + */ #define GST_H264_IS_MVC_NALU(nalu) \ ((nalu)->extension_type == GST_H264_NAL_EXTENSION_MVC) @@ -142,6 +150,8 @@ typedef enum * @GST_H264_NAL_EXTENSION_MVC: NAL unit header extension for MVC (Annex H) * * Indicates the type of H.264 NAL unit extension. + * + * Since: 1.6 */ typedef enum { @@ -182,6 +192,8 @@ typedef enum * @GST_H264_FRAME_PACKING_TEMPORAL_INTERLEAVING: Temporal interleaving * * Frame packing arrangement types. + * + * Since: 1.6 */ typedef enum { @@ -199,6 +211,9 @@ typedef enum * @GST_H264_SEI_BUF_PERIOD: Buffering Period SEI Message * @GST_H264_SEI_PIC_TIMING: Picture Timing SEI Message * @GST_H264_SEI_RECOVERY_POINT: Recovery Point SEI Message (D.2.7) + * @GST_H264_SEI_STEREO_VIDEO_INFO: stereo video info SEI message (Since: 1.6) + * @GST_H264_SEI_FRAME_PACKING: Frame Packing Arrangement (FPA) message that + * contains the 3D arrangement for stereoscopic 3D video (Since: 1.6) * ... * * The type of SEI message. @@ -303,6 +318,8 @@ typedef struct _GstH264SEIMessage GstH264SEIMessage; * @inter_view_flag: If equal to 0, it specifies that the current view * component is not used for inter-view prediction by any other view * component in the current access unit + * + * Since: 1.6 */ struct _GstH264NalUnitExtensionMVC { @@ -332,7 +349,8 @@ struct _GstH264NalUnitExtensionMVC * @valid: If the nal unit is valid, which means it has * already been parsed * @data: The data from which the Nalu has been parsed - * @header_bytes: The size of the NALU header in bytes + * @header_bytes: The size of the NALU header in bytes (Since 1.6) + * @extension_type: the extension type (Since 1.6) * * Structure defining the Nal unit headers */ @@ -532,6 +550,8 @@ struct _GstH264VUIParams * * Represents inter-view dependency relationships for the coded video * sequence. + * + * Since: 1.6 */ struct _GstH264SPSExtMVCView { @@ -550,6 +570,8 @@ struct _GstH264SPSExtMVCView * GstH264SPSExtMVCLevelValueOp: * * Represents an operation point for the coded video sequence. + * + * Since: 1.6 */ struct _GstH264SPSExtMVCLevelValueOp { @@ -569,6 +591,8 @@ struct _GstH264SPSExtMVCLevelValueOp * * Represents level values for a subset of the operation points for * the coded video sequence. + * + * Since: 1.6 */ struct _GstH264SPSExtMVCLevelValue { @@ -587,7 +611,9 @@ struct _GstH264SPSExtMVCLevelValue * @level_value: array of #GstH264SPSExtMVCLevelValue * * Represents the parsed seq_parameter_set_mvc_extension(). - */ + * + * Since: 1.6 + */ struct _GstH264SPSExtMVC { guint16 num_views_minus1; @@ -870,6 +896,11 @@ struct _GstH264ClockTimestamp guint32 time_offset; }; +/** + * GstH264FramePacking: + * + * Since: 1.6 + */ struct _GstH264FramePacking { guint32 frame_packing_id; @@ -890,6 +921,11 @@ struct _GstH264FramePacking guint16 frame_packing_repetition_period; }; +/** + * GstH264StereoVideoInfo: + * + * Since: 1.6 + */ struct _GstH264StereoVideoInfo { guint8 field_views_flag;