From 78d12bf41ea83780ff30635be513fed57028f965 Mon Sep 17 00:00:00 2001
From: Robert Swain <robert.swain@collabora.co.uk>
Date: Tue, 24 Jul 2012 11:13:23 +0200
Subject: [PATCH] docs: Improve gstvideo and add GstVideoFrame

Some items have been removed that are no longer in the headers
---
 docs/libs/gst-plugins-base-libs-sections.txt | 258 +++++++++++--------
 1 file changed, 154 insertions(+), 104 deletions(-)

diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt
index 8e8acaad19..b6f26a3e5b 100644
--- a/docs/libs/gst-plugins-base-libs-sections.txt
+++ b/docs/libs/gst-plugins-base-libs-sections.txt
@@ -1924,101 +1924,173 @@ GstEncodingTargetClass
 <SECTION>
 <FILE>gstvideo</FILE>
 <INCLUDE>gst/video/video.h</INCLUDE>
-GST_VIDEO_FPS_RANGE
-GST_VIDEO_SIZE_RANGE
-GstVideoBufferFlags
-GstVideoChromaSite
-GstVideoColorMatrix
-GstVideoColorPrimaries
-GstVideoColorRange
-GstVideoColorimetry
-GstVideoFlags
-GstVideoFormatFlags
-GstVideoFormatPack
-GstVideoFormatUnpack
-GstVideoInterlaceMode
-GstVideoTransferFunction
+
+#video.h
+<SUBSECTION>
+gst_video_calculate_display_ratio
+GstVideoConvertSampleCallback
+gst_video_convert_sample
+gst_video_convert_sample_async
+
+#video-event.h
+<SUBSECTION>
+gst_video_event_new_still_frame
+gst_video_event_parse_still_frame
+gst_video_event_new_downstream_force_key_unit
+gst_video_event_parse_downstream_force_key_unit
+gst_video_event_new_upstream_force_key_unit
+gst_video_event_parse_upstream_force_key_unit
+gst_video_event_is_force_key_unit
+
+#video-format.h
+<SUBSECTION>
 GstVideoFormat
+GST_VIDEO_MAX_PLANES
+GST_VIDEO_MAX_COMPONENTS
 GstVideoFormatInfo
-GST_VIDEO_FORMAT_INFO_BITS
-GST_VIDEO_FORMAT_INFO_DATA
-GST_VIDEO_FORMAT_INFO_DEPTH
-GST_VIDEO_FORMAT_INFO_FLAGS
+GstVideoChromaSite
+gst_video_chroma_from_string
+gst_video_chroma_to_string
+GstVideoFormatFlags
+GstVideoPackFlags
+GstVideoFormatUnpack
+GstVideoFormatPack
 GST_VIDEO_FORMAT_INFO_FORMAT
-GST_VIDEO_FORMAT_INFO_HAS_ALPHA
-GST_VIDEO_FORMAT_INFO_HAS_PALETTE
-GST_VIDEO_FORMAT_INFO_H_SUB
-GST_VIDEO_FORMAT_INFO_IS_GRAY
-GST_VIDEO_FORMAT_INFO_IS_LE
-GST_VIDEO_FORMAT_INFO_IS_RGB
-GST_VIDEO_FORMAT_INFO_IS_YUV
-GST_VIDEO_FORMAT_INFO_IS_COMPLEX
 GST_VIDEO_FORMAT_INFO_NAME
+GST_VIDEO_FORMAT_INFO_FLAGS
+GST_VIDEO_FORMAT_INFO_IS_YUV
+GST_VIDEO_FORMAT_INFO_IS_RGB
+GST_VIDEO_FORMAT_INFO_IS_GRAY
+GST_VIDEO_FORMAT_INFO_HAS_ALPHA
+GST_VIDEO_FORMAT_INFO_IS_LE
+GST_VIDEO_FORMAT_INFO_HAS_PALETTE
+GST_VIDEO_FORMAT_INFO_IS_COMPLEX
+GST_VIDEO_FORMAT_INFO_BITS
 GST_VIDEO_FORMAT_INFO_N_COMPONENTS
+GST_VIDEO_FORMAT_INFO_SHIFT
+GST_VIDEO_FORMAT_INFO_DEPTH
+GST_VIDEO_FORMAT_INFO_PSTRIDE
 GST_VIDEO_FORMAT_INFO_N_PLANES
-GST_VIDEO_FORMAT_INFO_OFFSET
 GST_VIDEO_FORMAT_INFO_PLANE
 GST_VIDEO_FORMAT_INFO_POFFSET
-GST_VIDEO_FORMAT_INFO_PSTRIDE
-GST_VIDEO_FORMAT_INFO_SCALE_HEIGHT
-GST_VIDEO_FORMAT_INFO_SCALE_WIDTH
-GST_VIDEO_FORMAT_INFO_SHIFT
-GST_VIDEO_FORMAT_INFO_STRIDE
 GST_VIDEO_FORMAT_INFO_W_SUB
+GST_VIDEO_FORMAT_INFO_H_SUB
+GST_VIDEO_SUB_SCALE
+GST_VIDEO_FORMAT_INFO_SCALE_WIDTH
+GST_VIDEO_FORMAT_INFO_SCALE_HEIGHT
+GST_VIDEO_FORMAT_INFO_DATA
+GST_VIDEO_FORMAT_INFO_STRIDE
+GST_VIDEO_FORMAT_INFO_OFFSET
+gst_video_format_from_masks
+gst_video_format_from_fourcc
+gst_video_format_to_fourcc
+gst_video_format_from_string
+gst_video_format_to_string
+gst_video_format_get_info
+GST_VIDEO_SIZE_RANGE
+GST_VIDEO_FPS_RANGE
+GST_VIDEO_FORMATS_ALL
+GST_VIDEO_CAPS_MAKE
+<SUBSECTION Standard>
+gst_video_format_get_type
+GST_TYPE_VIDEO_FORMAT
+gst_video_chroma_site_get_type
+GST_TYPE_VIDEO_CHROMA_SITE
+gst_video_format_flags_get_type
+GST_TYPE_VIDEO_FORMAT_FLAGS
+gst_video_pack_flags_get_type
+GST_TYPE_VIDEO_PACK_FLAGS
+
+#video-color.h
+<SUBSECTION>
+GstVideoColorRange
+GstVideoColorMatrix
+GstVideoTransferFunction
+GstVideoColorPrimaries
+GstVideoColorimetry
+gst_video_colorimetry_matches
+gst_video_colorimetry_from_string
+gst_video_colorimetry_to_string
+gst_video_color_range_offsets
+<SUBSECTION Standard>
+gst_video_color_range_get_type
+GST_TYPE_VIDEO_COLOR_RANGE
+gst_video_color_matrix_get_type
+GST_TYPE_VIDEO_COLOR_MATRIX
+gst_video_transfer_function_get_type
+GST_TYPE_VIDEO_TRANSFER_FUNCTION
+gst_video_color_primaries_get_type
+GST_TYPE_VIDEO_COLOR_PRIMARIES
+
+#video-info.h
+<SUBSECTION>
 GstVideoInfo
-GST_VIDEO_INFO_COMP_BITS
-GST_VIDEO_INFO_COMP_DATA
-GST_VIDEO_INFO_COMP_DEPTH
-GST_VIDEO_INFO_COMP_HEIGHT
-GST_VIDEO_INFO_COMP_OFFSET
-GST_VIDEO_INFO_COMP_PLANE
-GST_VIDEO_INFO_COMP_POFFSET
-GST_VIDEO_INFO_COMP_PSTRIDE
-GST_VIDEO_INFO_COMP_STRIDE
-GST_VIDEO_INFO_COMP_WIDTH
+GstVideoInterlaceMode
+GstVideoFlags
+GST_VIDEO_INFO_FORMAT
+GST_VIDEO_INFO_NAME
+GST_VIDEO_INFO_IS_YUV
+GST_VIDEO_INFO_IS_RGB
+GST_VIDEO_INFO_IS_GRAY
+GST_VIDEO_INFO_HAS_ALPHA
+GST_VIDEO_INFO_INTERLACE_MODE
+GST_VIDEO_INFO_IS_INTERLACED
 GST_VIDEO_INFO_FLAGS
+GST_VIDEO_INFO_WIDTH
+GST_VIDEO_INFO_HEIGHT
+GST_VIDEO_INFO_SIZE
+GST_VIDEO_INFO_VIEWS
+GST_VIDEO_INFO_PAR_N
+GST_VIDEO_INFO_PAR_D
+GST_VIDEO_INFO_FPS_N
+GST_VIDEO_INFO_FPS_D
 GST_VIDEO_INFO_FLAG_IS_SET
 GST_VIDEO_INFO_FLAG_SET
 GST_VIDEO_INFO_FLAG_UNSET
-GST_VIDEO_INFO_FORMAT
-GST_VIDEO_INFO_FPS_D
-GST_VIDEO_INFO_FPS_N
-GST_VIDEO_INFO_HAS_ALPHA
-GST_VIDEO_INFO_HEIGHT
-GST_VIDEO_INFO_INTERLACE_MODE
-GST_VIDEO_INFO_IS_GRAY
-GST_VIDEO_INFO_IS_INTERLACED
-GST_VIDEO_INFO_IS_RGB
-GST_VIDEO_INFO_IS_YUV
-GST_VIDEO_INFO_NAME
-GST_VIDEO_INFO_N_COMPONENTS
 GST_VIDEO_INFO_N_PLANES
-GST_VIDEO_INFO_PAR_D
-GST_VIDEO_INFO_PAR_N
 GST_VIDEO_INFO_PLANE_OFFSET
 GST_VIDEO_INFO_PLANE_STRIDE
-GST_VIDEO_INFO_SIZE
-GST_VIDEO_INFO_WIDTH
-GST_VIDEO_MAX_COMPONENTS
-GST_VIDEO_MAX_PLANES
-GST_VIDEO_SUB_SCALE
-gst_video_info_convert
-gst_video_info_from_caps
+GST_VIDEO_INFO_N_COMPONENTS
+GST_VIDEO_INFO_COMP_DEPTH
+GST_VIDEO_INFO_COMP_DATA
+GST_VIDEO_INFO_COMP_OFFSET
+GST_VIDEO_INFO_COMP_STRIDE
+GST_VIDEO_INFO_COMP_WIDTH
+GST_VIDEO_INFO_COMP_HEIGHT
+GST_VIDEO_INFO_COMP_PLANE
+GST_VIDEO_INFO_COMP_PSTRIDE
+GST_VIDEO_INFO_COMP_POFFSET
 gst_video_info_init
 gst_video_info_set_format
+gst_video_info_from_caps
 gst_video_info_to_caps
+gst_video_info_convert
+gst_video_info_is_equal
+<SUBSECTION Standard>
+gst_video_interlace_mode_get_type
+GST_TYPE_VIDEO_INTERLACE_MODE
+gst_video_flags_get_type
+GST_TYPE_VIDEO_FLAGS
+
+#video-frame.h
+<SUBSECTION>
 GstVideoFrame
 GstVideoFrameFlags
+gst_video_frame_map_id
+gst_video_frame_map
+gst_video_frame_unmap
+gst_video_frame_copy
+gst_video_frame_copy_plane
+GST_VIDEO_FRAME_FORMAT
+GST_VIDEO_FRAME_WIDTH
+GST_VIDEO_FRAME_HEIGHT
+GST_VIDEO_FRAME_SIZE
 GST_VIDEO_FRAME_FLAGS
 GST_VIDEO_FRAME_FLAG_IS_SET
 GST_VIDEO_FRAME_IS_INTERLACED
 GST_VIDEO_FRAME_IS_TFF
 GST_VIDEO_FRAME_IS_RFF
 GST_VIDEO_FRAME_IS_ONEFIELD
-GST_VIDEO_FRAME_FORMAT
-GST_VIDEO_FRAME_WIDTH
-GST_VIDEO_FRAME_HEIGHT
-GST_VIDEO_FRAME_SIZE
 GST_VIDEO_FRAME_N_PLANES
 GST_VIDEO_FRAME_PLANE_DATA
 GST_VIDEO_FRAME_PLANE_OFFSET
@@ -2033,46 +2105,24 @@ GST_VIDEO_FRAME_COMP_HEIGHT
 GST_VIDEO_FRAME_COMP_PLANE
 GST_VIDEO_FRAME_COMP_PSTRIDE
 GST_VIDEO_FRAME_COMP_POFFSET
-gst_video_frame_map_id
-gst_video_frame_map
-gst_video_frame_unmap
-gst_video_frame_copy
-gst_video_frame_copy_plane
-gst_video_calculate_display_ratio
-gst_video_format_to_fourcc
-gst_video_format_from_fourcc
-gst_video_parse_caps_palette
-GstVideoConvertSampleCallback
-gst_video_convert_sample
-gst_video_convert_sample_async
-gst_video_event_new_still_frame
-gst_video_event_parse_still_frame
-gst_video_event_new_upstream_force_key_unit
-gst_video_event_new_downstream_force_key_unit
-gst_video_event_is_force_key_unit
-gst_video_event_parse_upstream_force_key_unit
-gst_video_event_parse_downstream_force_key_unit
+GstVideoBufferFlags
+
+#video-enumtypes.h
 <SUBSECTION Standard>
-gst_video_format_get_type
-GST_TYPE_VIDEO_FORMAT
-GST_TYPE_VIDEO_CHROMA_SITE
-GST_TYPE_VIDEO_COLOR_MATRIX
-GST_TYPE_VIDEO_COLOR_PRIMARIES
-GST_TYPE_VIDEO_COLOR_RANGE
-GST_TYPE_VIDEO_FLAGS
-GST_TYPE_VIDEO_FORMAT_FLAGS
-GST_TYPE_VIDEO_INTERLACE_MODE
-GST_TYPE_VIDEO_TRANSFER_FUNCTION
-gst_video_chroma_site_get_type
-gst_video_color_matrix_get_type
-gst_video_color_primaries_get_type
-gst_video_color_range_get_type
-gst_video_flags_get_type
-gst_video_format_flags_get_type
-gst_video_interlace_mode_get_type
-gst_video_transfer_function_get_type
+gst_color_balance_type_get_type
+GST_TYPE_COLOR_BALANCE_TYPE
+gst_navigation_command_get_type
+GST_TYPE_NAVIGATION_COMMAND
+gst_navigation_query_type_get_type
+GST_TYPE_NAVIGATION_QUERY_TYPE
+gst_navigation_message_type_get_type
+GST_TYPE_NAVIGATION_MESSAGE_TYPE
+gst_navigation_event_type_get_type
+GST_TYPE_NAVIGATION_EVENT_TYPE
+
 </SECTION>
 
+
 <SECTION>
 <FILE>gstvideooverlaycomposition</FILE>
 <INCLUDE>gst/video/video-overlay-composition.h</INCLUDE>