Fix documentation

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1458>
This commit is contained in:
Andoni Morales Alastruey 2022-02-27 18:41:12 +00:00 committed by GStreamer Marge Bot
parent 804a6054bb
commit 64a92b549d
3 changed files with 50 additions and 21 deletions

View file

@ -241,7 +241,6 @@ typedef enum
* @GST_H264_SEI_BUF_PERIOD: Buffering Period SEI Message * @GST_H264_SEI_BUF_PERIOD: Buffering Period SEI Message
* @GST_H264_SEI_PIC_TIMING: Picture Timing SEI Message * @GST_H264_SEI_PIC_TIMING: Picture Timing SEI Message
* @GST_H264_SEI_REGISTERED_USER_DATA: Registered user data (D.2.5) * @GST_H264_SEI_REGISTERED_USER_DATA: Registered user data (D.2.5)
* @GST_H264_SEI_USER_DATA_UNREGISTERED: Registered user data (D.2.6) (Since: 1.22)
* @GST_H264_SEI_RECOVERY_POINT: Recovery Point SEI Message (D.2.7) * @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_STEREO_VIDEO_INFO: stereo video info SEI message (Since: 1.6)
* @GST_H264_SEI_FRAME_PACKING: Frame Packing Arrangement (FPA) message that * @GST_H264_SEI_FRAME_PACKING: Frame Packing Arrangement (FPA) message that
@ -254,6 +253,14 @@ typedef enum
* *
* The type of SEI message. * The type of SEI message.
*/ */
/**
* GST_H264_SEI_USER_DATA_UNREGISTERED:
*
* User Data Unregistered (D.2.6)
*
* Since: 1.22
*/
typedef enum typedef enum
{ {
GST_H264_SEI_BUF_PERIOD = 0, GST_H264_SEI_BUF_PERIOD = 0,
@ -1116,11 +1123,12 @@ struct _GstH264RegisteredUserData
/** /**
* GstH264UserDataUnregistered: * GstH264UserDataUnregistered:
* The User data unregistered SEI message syntax.
* @uuid: an uuid_iso_iec_11578. * @uuid: an uuid_iso_iec_11578.
* @data: the data of user_data_payload_byte * @data: the data of user_data_payload_byte
* @size: the size of @data in bytes * @size: the size of @data in bytes
* *
* The User data unregistered SEI message syntax.
*
* Since: 1.22 * Since: 1.22
*/ */
struct _GstH264UserDataUnregistered struct _GstH264UserDataUnregistered
@ -1204,6 +1212,13 @@ struct _GstH264SEIUnhandledPayload
guint size; guint size;
}; };
/**
* _GstH264SEIMessage.payload.user_data_unregistered:
*
* User Data Unregistered
*
* Since: 1.22
*/
struct _GstH264SEIMessage struct _GstH264SEIMessage
{ {
GstH264SEIPayloadType payloadType; GstH264SEIPayloadType payloadType;

View file

@ -33,6 +33,8 @@
* *
* A collection of objects and methods to assist with SEI User Data Unregistered * A collection of objects and methods to assist with SEI User Data Unregistered
* metadata in H.264 and H.265 streams. * metadata in H.264 and H.265 streams.
*
* Since: 1.22
*/ */
#ifndef GST_DISABLE_GST_DEBUG #ifndef GST_DISABLE_GST_DEBUG
@ -59,6 +61,13 @@ ensure_debug_category (void)
/* SEI User Data Unregistered implementation */ /* SEI User Data Unregistered implementation */
/**
* gst_video_sei_user_data_unregistered_meta_api_get_type:
*
* Returns: #GType for the #GstVideoSEIUserDataUnregisteredMeta structure.
*
* Since: 1.22
*/
GType GType
gst_video_sei_user_data_unregistered_meta_api_get_type (void) gst_video_sei_user_data_unregistered_meta_api_get_type (void)
{ {
@ -118,6 +127,13 @@ gst_video_sei_user_data_unregistered_meta_free (GstMeta * meta, GstBuffer * buf)
smeta->data = NULL; smeta->data = NULL;
} }
/**
* gst_video_sei_user_data_unregistered_meta_get_info:
*
* Returns: #GstMetaInfo pointer that describes #GstVideoSEIUserDataUnregisteredMeta.
*
* Since: 1.22
*/
const GstMetaInfo * const GstMetaInfo *
gst_video_sei_user_data_unregistered_meta_get_info (void) gst_video_sei_user_data_unregistered_meta_get_info (void)
{ {
@ -169,6 +185,18 @@ gst_buffer_add_video_sei_user_data_unregistered_meta (GstBuffer * buffer,
return meta; return meta;
} }
/**
* gst_video_sei_user_data_unregistered_parse_precision_time_stamp:
* @user_data: (transfer none): a #GstVideoSEIUserDataUnregisteredMeta
* @status: (out): User Data Unregistered UUID
* @precision_time_stamp: (out): The parsed Precision Time Stamp SEI
*
* Parses and returns the Precision Time Stamp (ST 0604) from the SEI User Data Unregistered buffer
*
* Returns: True if data is a Precision Time Stamp and it was parsed correctly
*
* Since: 1.22
*/
gboolean gboolean
gst_video_sei_user_data_unregistered_parse_precision_time_stamp gst_video_sei_user_data_unregistered_parse_precision_time_stamp
(GstVideoSEIUserDataUnregisteredMeta * user_data, guint8 * status, (GstVideoSEIUserDataUnregisteredMeta * user_data, guint8 * status,

View file

@ -26,31 +26,16 @@
G_BEGIN_DECLS G_BEGIN_DECLS
/**
* MISB UUID for H.264 Precision Time Stamp
*
* This is from MISB ST 0604.6 Section 11.1.
*/
static const guint8 H264_MISP_MICROSECTIME[] = { static const guint8 H264_MISP_MICROSECTIME[] = {
0x4D, 0x49, 0x53, 0x50, 0x6D, 0x69, 0x63, 0x72, 0x4D, 0x49, 0x53, 0x50, 0x6D, 0x69, 0x63, 0x72,
0x6F, 0x73, 0x65, 0x63, 0x74, 0x69, 0x6D, 0x65 0x6F, 0x73, 0x65, 0x63, 0x74, 0x69, 0x6D, 0x65
}; };
/**
* MISB UUID for H.265 Precision Time Stamp
*
* This is from MISB ST 0604.6 Section 12.1.
*/
static const guint8 H265_MISP_MICROSECONDS[] = { static const guint8 H265_MISP_MICROSECONDS[] = {
0xA8, 0x68, 0x7D, 0xD4, 0xD7, 0x59, 0x37, 0x58, 0xA8, 0x68, 0x7D, 0xD4, 0xD7, 0x59, 0x37, 0x58,
0xA5, 0xCE, 0xF0, 0x33, 0x8B, 0x65, 0x45, 0xF1 0xA5, 0xCE, 0xF0, 0x33, 0x8B, 0x65, 0x45, 0xF1
}; };
/**
* MISB UUID for H.265 Nano Time Stamp
*
* This is from MISB ST 0604.6 Section 12.1.
*/
static const guint8 H265_MISP_NANOSECONDS[] = { static const guint8 H265_MISP_NANOSECONDS[] = {
0xCF, 0x84, 0x82, 0x78, 0xEE, 0x23, 0x30, 0x6C, 0xCF, 0x84, 0x82, 0x78, 0xEE, 0x23, 0x30, 0x6C,
0x92, 0x65, 0xE8, 0xFE, 0xF2, 0x2F, 0xB8, 0xB8 0x92, 0x65, 0xE8, 0xFE, 0xF2, 0x2F, 0xB8, 0xB8
@ -59,11 +44,12 @@ static const guint8 H265_MISP_NANOSECONDS[] = {
/** /**
* GstVideoSEIUserDataUnregisteredMeta: * GstVideoSEIUserDataUnregisteredMeta:
* @meta: parent #GstMeta * @meta: parent #GstMeta
* @description: H.264 H.265 metadata from SEI User Data Unregistered messages
* @uuid: User Data Unregistered UUID * @uuid: User Data Unregistered UUID
* @data: Unparsed data buffer * @data: Unparsed data buffer
* @size: Size of the data buffer * @size: Size of the data buffer
* *
* H.264 H.265 metadata from SEI User Data Unregistered messages
*
* Since: 1.22 * Since: 1.22
*/ */
typedef struct { typedef struct {
@ -98,12 +84,12 @@ const GstMetaInfo *gst_video_sei_user_data_unregistered_meta_get_info (void);
* gst_buffer_get_video_sei_user_data_unregistered_meta: * gst_buffer_get_video_sei_user_data_unregistered_meta:
* @b: A #GstBuffer * @b: A #GstBuffer
* *
* Gets the #GstVideoSEIUserDataUnregisteredMeta that might be present on @b. * Gets the GstVideoSEIUserDataUnregisteredMeta that might be present on @b.
*
* Since: 1.22
* *
* Returns: The first #GstVideoSEIUserDataUnregisteredMeta present on @b, or %NULL if * Returns: The first #GstVideoSEIUserDataUnregisteredMeta present on @b, or %NULL if
* no #GstVideoSEIUserDataUnregisteredMeta are present * no #GstVideoSEIUserDataUnregisteredMeta are present
*
* Since: 1.22
*/ */
#define gst_buffer_get_video_sei_user_data_unregistered_meta(b) \ #define gst_buffer_get_video_sei_user_data_unregistered_meta(b) \
((GstVideoSEIUserDataUnregisteredMeta*)gst_buffer_get_meta((b),GST_VIDEO_SEI_USER_DATA_UNREGISTERED_META_API_TYPE)) ((GstVideoSEIUserDataUnregisteredMeta*)gst_buffer_get_meta((b),GST_VIDEO_SEI_USER_DATA_UNREGISTERED_META_API_TYPE))