docs: improve docs

diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt
index 8782899..6272fef 100644 (file)
--- a/docs/libs/gst-plugins-base-libs-sections.txt
+++ b/docs/libs/gst-plugins-base-libs-sections.txt
@@ -88,9 +88,6 @@ GstAudioFormatFlags
 GstAudioFormatInfo
 GstAudioInfo
 gst_audio_info_init
-gst_audio_info_clear
-gst_audio_info_copy
-gst_audio_info_free
 gst_audio_info_from_caps
 gst_audio_info_to_caps
 gst_audio_info_convert
@@ -101,8 +98,8 @@ GST_AUDIO_FORMAT_INFO_FLAGS
 GST_AUDIO_FORMAT_INFO_FORMAT
 GST_AUDIO_FORMAT_INFO_IS_FLOAT
 GST_AUDIO_FORMAT_INFO_IS_INTEGER
-GST_AUDIO_FORMAT_INFO_IS_BE
-GST_AUDIO_FORMAT_INFO_IS_LE
+GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN
+GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN
 GST_AUDIO_FORMAT_INFO_IS_SIGNED
 GST_AUDIO_FORMAT_INFO_NAME
 GST_AUDIO_FORMAT_INFO_WIDTH
@@ -118,19 +115,9 @@ GST_AUDIO_INFO_POSITION
 GST_AUDIO_INFO_RATE
 GST_AUDIO_INFO_WIDTH
 
-GstAudioFieldFlag
 GST_FRAMES_TO_CLOCK_TIME
 GST_CLOCK_TIME_TO_FRAMES
 GST_AUDIO_DEF_RATE
-GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS
-GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS
-GST_AUDIO_INT_PAD_TEMPLATE_CAPS
-GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS
-gst_audio_frame_byte_size
-gst_audio_frame_length
-gst_audio_duration_from_pad_buffer
-gst_audio_is_buffer_framed
-gst_audio_structure_set_int
 gst_audio_buffer_clip
 <SUBSECTION Standard>
 GST_TYPE_BUFFER_FORMAT
@@ -379,7 +366,6 @@ GstRingBufferSpec
 GstRingBufferCallback
 GstRingBufferSegState
 GstRingBufferState
-GstBufferFormat
 GstBufferFormatType
 
 GST_RING_BUFFER_BROADCAST
@@ -2185,100 +2171,12 @@ GstEncodingTargetClass
 <SECTION>
 <FILE>gstvideo</FILE>
 <INCLUDE>gst/video/video.h</INCLUDE>
-GST_VIDEO_BLUE_MASK_15
-GST_VIDEO_BLUE_MASK_15_INT
-GST_VIDEO_BLUE_MASK_16
-GST_VIDEO_BLUE_MASK_16_INT
-GST_VIDEO_BYTE1_MASK_24
-GST_VIDEO_BYTE1_MASK_24_INT
-GST_VIDEO_BYTE1_MASK_32
-GST_VIDEO_BYTE1_MASK_32_INT
-GST_VIDEO_BYTE2_MASK_24
-GST_VIDEO_BYTE2_MASK_24_INT
-GST_VIDEO_BYTE2_MASK_32
-GST_VIDEO_BYTE2_MASK_32_INT
-GST_VIDEO_BYTE3_MASK_24
-GST_VIDEO_BYTE3_MASK_24_INT
-GST_VIDEO_BYTE3_MASK_32
-GST_VIDEO_BYTE3_MASK_32_INT
-GST_VIDEO_BYTE4_MASK_32
-GST_VIDEO_BYTE4_MASK_32_INT
-GST_VIDEO_CAPS_ABGR
-GST_VIDEO_CAPS_ARGB
-GST_VIDEO_CAPS_BGR
-GST_VIDEO_CAPS_BGRA
-GST_VIDEO_CAPS_BGRx
-GST_VIDEO_CAPS_BGRx_HOST_ENDIAN
-GST_VIDEO_CAPS_RGB
-GST_VIDEO_CAPS_RGBA
-GST_VIDEO_CAPS_RGB_15
-GST_VIDEO_CAPS_RGB_16
-GST_VIDEO_CAPS_RGBx
-GST_VIDEO_CAPS_YUV
-GST_VIDEO_CAPS_xBGR
-GST_VIDEO_CAPS_xRGB
-GST_VIDEO_CAPS_xRGB_HOST_ENDIAN
-GST_VIDEO_CAPS_BGR_15
-GST_VIDEO_CAPS_BGR_16
-GST_VIDEO_CAPS_RGB8_PALETTED
-GST_VIDEO_CAPS_GRAY8
-GST_VIDEO_CAPS_GRAY16
-GST_VIDEO_CAPS_ARGB_64
-GST_VIDEO_CAPS_r210
-GST_VIDEO_COMP1_MASK_15
-GST_VIDEO_COMP1_MASK_15_INT
-GST_VIDEO_COMP1_MASK_16
-GST_VIDEO_COMP1_MASK_16_INT
-GST_VIDEO_COMP2_MASK_15
-GST_VIDEO_COMP2_MASK_15_INT
-GST_VIDEO_COMP2_MASK_16
-GST_VIDEO_COMP2_MASK_16_INT
-GST_VIDEO_COMP3_MASK_15
-GST_VIDEO_COMP3_MASK_15_INT
-GST_VIDEO_COMP3_MASK_16
-GST_VIDEO_COMP3_MASK_16_INT
 GST_VIDEO_FPS_RANGE
-GST_VIDEO_GREEN_MASK_15
-GST_VIDEO_GREEN_MASK_15_INT
-GST_VIDEO_GREEN_MASK_16
-GST_VIDEO_GREEN_MASK_16_INT
-GST_VIDEO_RED_MASK_15
-GST_VIDEO_RED_MASK_15_INT
-GST_VIDEO_RED_MASK_16
-GST_VIDEO_RED_MASK_16_INT
 GST_VIDEO_SIZE_RANGE
-GST_VIDEO_BUFFER_TFF
-GST_VIDEO_BUFFER_RFF
-GST_VIDEO_BUFFER_ONEFIELD
-GST_VIDEO_BUFFER_PROGRESSIVE
 GstVideoFormat
 gst_video_calculate_display_ratio
-gst_video_frame_rate
-gst_video_get_size
-gst_video_get_size_from_caps
-gst_video_format_convert
-gst_video_format_new_caps
-gst_video_format_new_caps_interlaced
-gst_video_format_new_template_caps
-gst_video_format_get_component_height
-gst_video_format_get_component_offset
-gst_video_format_get_component_width
-gst_video_format_get_component_depth
-gst_video_format_get_pixel_stride
-gst_video_format_get_row_stride
-gst_video_format_get_size
-gst_video_format_has_alpha
-gst_video_format_is_rgb
-gst_video_format_is_gray
-gst_video_format_is_yuv
 gst_video_format_to_fourcc
 gst_video_format_from_fourcc
-gst_video_format_parse_caps
-gst_video_format_parse_caps_interlaced
-gst_video_parse_caps_framerate
-gst_video_parse_caps_pixel_aspect_ratio
-gst_video_parse_caps_color_matrix
-gst_video_parse_caps_chroma_site
 gst_video_parse_caps_palette
 GstVideoConvertFrameCallback
 gst_video_convert_frame

diff --git a/gst-libs/gst/audio/audio.h b/gst-libs/gst/audio/audio.h
index b76bada..1c8287b 100644 (file)
--- a/gst-libs/gst/audio/audio.h
+++ b/gst-libs/gst/audio/audio.h
@@ -268,7 +268,7 @@ typedef enum {
  * @channels: the number of channels
  * @bpf: the number of bytes for one frame, this is the size of one
  *         sample * @channels
- * @positions: the positions for each channel
+ * @position: the positions for each channel
  *
  * Information describing audio properties. This information can be filled
  * in from GstCaps with gst_audio_info_from_caps().

diff --git a/gst-libs/gst/audio/gstringbuffer.h b/gst-libs/gst/audio/gstringbuffer.h
index 76e61c3..ddd2c68 100644 (file)
--- a/gst-libs/gst/audio/gstringbuffer.h
+++ b/gst-libs/gst/audio/gstringbuffer.h
@@ -119,19 +119,11 @@ typedef enum
  * GstRingBufferSpec:
  * @caps: The caps that generated the Spec.
  * @type: the sample type
- * @format: the sample format
- * @sign: the sample sign
- * @bigend: the endianness of the samples
- * @width: the width of the samples
- * @depth: th depth of the samples
- * @rate: the samplerate
- * @channels: the number of channels
+ * @info: the #GstAudioInfo
  * @latency_time: the latency in microseconds
  * @buffer_time: the total buffer size in microseconds
  * @segsize: the size of one segment in bytes
  * @segtotal: the total number of segments
- * @bytes_per_sample: number of bytes in one sample
- * @silence_sample: bytes representing one sample of silence
  * @seglatency: number of segments queued in the lower level device,
  *  defaults to segtotal
  *
@@ -178,7 +170,8 @@ struct _GstRingBufferSpec
  * @cond: used to signal start/stop/pause/resume actions
  * @open: boolean indicating that the ringbuffer is open
  * @acquired: boolean indicating that the ringbuffer is acquired
- * @data: data in the ringbuffer
+ * @memory: data in the ringbuffer
+ * @size: size of data in the ringbuffer
  * @spec: format and layout of the ringbuffer data
  * @segstate: status of each segment in the ringbuffer (unused)
  * @samples_per_seg: number of samples in one segment

diff --git a/gst-libs/gst/audio/multichannel.h b/gst-libs/gst/audio/multichannel.h
index ab00eca..186ba3c 100644 (file)
--- a/gst-libs/gst/audio/multichannel.h
+++ b/gst-libs/gst/audio/multichannel.h
@@ -39,6 +39,13 @@ G_BEGIN_DECLS
  * @GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER: front right of center
  * @GST_AUDIO_CHANNEL_POSITION_SIDE_LEFT: side left
  * @GST_AUDIO_CHANNEL_POSITION_SIDE_RIGHT: side right
+ * @GST_AUDIO_CHANNEL_POSITION_TOP_CENTER: top center
+ * @GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_LEFT: top front left
+ * @GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_RIGHT: top front right
+ * @GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_CENTER: top front center
+ * @GST_AUDIO_CHANNEL_POSITION_TOP_REAR_LEFT: top rear left
+ * @GST_AUDIO_CHANNEL_POSITION_TOP_REAR_RIGHT: top rear right
+ * @GST_AUDIO_CHANNEL_POSITION_TOP_REAR_CENTER: top rear center
  * @GST_AUDIO_CHANNEL_POSITION_NONE: used for position-less channels, e.g.
  *     from a sound card that records 1024 channels; mutually exclusive with
  *     any other channel position

diff --git a/gst-libs/gst/video/convertframe.c b/gst-libs/gst/video/convertframe.c
index 4e9eb45..6639248 100644 (file)
--- a/gst-libs/gst/video/convertframe.c
+++ b/gst-libs/gst/video/convertframe.c
@@ -571,6 +571,7 @@ done:
 /**
  * gst_video_convert_frame_async:
  * @buf: a #GstBuffer
+ * @from_caps: the #GstCaps to convert from
  * @to_caps: the #GstCaps to convert to
  * @timeout: the maximum amount of time allowed for the processing.
  * @callback: %GstVideoConvertFrameCallback that will be called after conversion.

diff --git a/gst-libs/gst/video/video.h b/gst-libs/gst/video/video.h
index 5ab3aee..56716f4 100644 (file)
--- a/gst-libs/gst/video/video.h
+++ b/gst-libs/gst/video/video.h
@@ -306,12 +306,12 @@ typedef struct _GstVideoFrame GstVideoFrame;
 /**
  * GstVideoFlags:
  * @GST_META_VIDEO_FLAG_NONE: no flags
- * @GST_META_VIDEO_FLAG_INTERLACED:
- * @GST_META_VIDEO_FLAG_TFF:
- * @GST_META_VIDEO_FLAG_RFF:
- * @GST_META_VIDEO_FLAG_ONEFIELD:
- * @GST_META_VIDEO_FLAG_TELECINE:
- * @GST_META_VIDEO_FLAG_PROGRESSIVE:
+ * @GST_META_VIDEO_FLAG_INTERLACED: The video is interlaced
+ * @GST_META_VIDEO_FLAG_TFF: The video has the top field first
+ * @GST_META_VIDEO_FLAG_RFF: The video has the repeat flag
+ * @GST_META_VIDEO_FLAG_ONEFIELD: one field
+ * @GST_META_VIDEO_FLAG_TELECINE: telecine
+ * @GST_META_VIDEO_FLAG_PROGRESSIVE: video is progressive
  *
  * Extra video flags
  */
@@ -389,18 +389,18 @@ typedef enum {
 
 /**
  * GstVideoTransferFunction:
- * GST_VIDEO_TRANSFER_UNKNOWN: unknown transfer function
- * GST_VIDEO_TRANSFER_GAMMA10: linear RGB, gamma 1.0 curve
- * GST_VIDEO_TRANSFER_GAMMA18: Gamma 1.8 curve
- * GST_VIDEO_TRANSFER_GAMMA20: Gamma 2.0 curve
- * GST_VIDEO_TRANSFER_GAMMA22: Gamma 2.2 curve
- * GST_VIDEO_TRANSFER_BT709: Gamma 2.2 curve with a linear segment in the lower
+ * @GST_VIDEO_TRANSFER_UNKNOWN: unknown transfer function
+ * @GST_VIDEO_TRANSFER_GAMMA10: linear RGB, gamma 1.0 curve
+ * @GST_VIDEO_TRANSFER_GAMMA18: Gamma 1.8 curve
+ * @GST_VIDEO_TRANSFER_GAMMA20: Gamma 2.0 curve
+ * @GST_VIDEO_TRANSFER_GAMMA22: Gamma 2.2 curve
+ * @GST_VIDEO_TRANSFER_BT709: Gamma 2.2 curve with a linear segment in the lower
  *                           range
- * GST_VIDEO_TRANSFER_SMPTE240M: Gamma 2.2 curve with a linear segment in the
+ * @GST_VIDEO_TRANSFER_SMPTE240M: Gamma 2.2 curve with a linear segment in the
  *                               lower range
- * GST_VIDEO_TRANSFER_SRGB: Gamma 2.4 curve with a linear segment in the lower
+ * @GST_VIDEO_TRANSFER_SRGB: Gamma 2.4 curve with a linear segment in the lower
  *                          range
- * GST_VIDEO_TRANSFER_GAMMA28: Gamma 2.8 curve
+ * @GST_VIDEO_TRANSFER_GAMMA28: Gamma 2.8 curve
  *
  * The video transfer function defines the formula for converting between
  * non-linear RGB (R'G'B') and linear RGB
@@ -420,11 +420,11 @@ typedef enum {
 /**
  * GstVideoColorPrimaries:
  * @GST_VIDEO_COLOR_PRIMARIES_UNKNOWN: unknown color primaries
- * @GST_VIDEO_COLOR_PRIMARIES_BT601:
- * @GST_VIDEO_COLOR_PRIMARIES_BT470M:
- * @GST_VIDEO_COLOR_PRIMARIES_BT470BG:
- * @GST_VIDEO_COLOR_PRIMARIES_SMPTE170M:
- * @GST_VIDEO_COLOR_PRIMARIES_SMPTE240M:
+ * @GST_VIDEO_COLOR_PRIMARIES_BT709: BT709 primaries
+ * @GST_VIDEO_COLOR_PRIMARIES_BT470M: BT470M primaries
+ * @GST_VIDEO_COLOR_PRIMARIES_BT470BG: BT470BG primaries
+ * @GST_VIDEO_COLOR_PRIMARIES_SMPTE170M: SMPTE170M primaries
+ * @GST_VIDEO_COLOR_PRIMARIES_SMPTE240M: SMPTE240M primaries
  *
  * The color primaries define the how to transform linear RGB values to and from
  * the CIE XYZ colorspace.