mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-11 18:05:37 +00:00
Code Issues 1 Projects Releases Wiki Activity

libs: Documentation cleanup

Browse source 
* Fix wrong naming, wrong types and typos
* Add missing sections
* Add missing documentation for entries
* Explicitely mark private structure entries
* Remove items that never existed
This commit is contained in:
Edward Hervey 2018-04-02 08:34:58 +02:00 committed by Edward Hervey
parent cb28f49625
commit 22c9e5f7c1
53 changed files with 175 additions and 115 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
gst-libs/gst/allocators/gstdmabuf.c
View file

@ -145,7 +145,7 @@ gst_dmabuf_allocator_new (void)
*
* Returns: (transfer full): a GstMemory based on @allocator.
* When the buffer will be released dmabuf allocator will close the @fd.
* The memory is only mmapped on gst_buffer_mmap() request.
* The memory is only mmapped on gst_buffer_map() request.
*
* Since: 1.2
*/

2
gst-libs/gst/allocators/gstfdmemory.c
View file

@ -265,7 +265,7 @@ gst_fd_allocator_new (void)
* Returns: (transfer full): a GstMemory based on @allocator.
* When the buffer will be released the allocator will close the @fd unless
* the %GST_FD_MEMORY_FLAG_DONT_CLOSE flag is specified.
* The memory is only mmapped on gst_buffer_mmap() request.
* The memory is only mmapped on gst_buffer_map() request.
*
* Since: 1.6
*/

4
gst-libs/gst/allocators/gstphysmemory.h
View file

@ -38,6 +38,8 @@ typedef struct _GstPhysMemoryAllocatorInterface GstPhysMemoryAllocatorInterface;
/**
* GstPhysMemoryAllocatorInterface:
* @get_phys_addr: Implementations shall return the physicall memory address
* that is backing the provided memory, or 0 if none.
*
* Marker interface for allocators with physical address backed memory
*
@ -45,8 +47,10 @@ typedef struct _GstPhysMemoryAllocatorInterface GstPhysMemoryAllocatorInterface;
*/
struct _GstPhysMemoryAllocatorInterface
{
/*< private >*/
GTypeInterface parent_iface;
/*< public >*/
guintptr (*get_phys_addr) (GstPhysMemoryAllocator * allocator, GstMemory * mem);
};

5
gst-libs/gst/audio/audio-converter.c
View file

@ -31,7 +31,7 @@
#include "gstaudiopack.h"
/**
* SECTION:audioconverter
* SECTION:gstaudioconverter
* @title: GstAudioConverter
* @short_description: Generic audio conversion
*
@ -1168,7 +1168,7 @@ converter_resample (GstAudioConverter * convert,
* Create a new #GstAudioConverter that is able to convert between @in and @out
* audio formats.
*
* @config contains extra configuration options, see #GST_VIDEO_CONVERTER_OPT_*
* @config contains extra configuration options, see #GST_AUDIO_CONVERTER_OPT_*
* parameters for details about the options and values.
*
* Returns: a #GstAudioConverter or %NULL if conversion is not possible.
@ -1449,6 +1449,7 @@ gst_audio_converter_samples (GstAudioConverter * convert,
/**
* gst_audio_converter_convert:
* @convert: a #GstAudioConverter
* @flags: extra #GstAudioConverterFlags
* @in: (array length=in_size) (element-type guint8): input data
* @in_size: size of @in

3
gst-libs/gst/audio/audio-format.h
View file

@ -188,6 +188,7 @@ typedef enum
/**
* GstAudioFormatUnpack:
* @info: a #GstAudioFormatInfo
* @flags: #GstAudioPackFlags
* @dest: (array) (element-type guint8): a destination array
* @data: (array) (element-type guint8): pointer to the audio data
* @length: the amount of samples to unpack.
@ -203,6 +204,7 @@ typedef void (*GstAudioFormatUnpack) (const GstAudioFormatInfo *info,
/**
* GstAudioFormatPack:
* @info: a #GstAudioFormatInfo
* @flags: #GstAudioPackFlags
* @src: (array) (element-type guint8): a source array
* @data: (array) (element-type guint8): pointer to the destination
* data
@ -233,6 +235,7 @@ typedef void (*GstAudioFormatPack) (const GstAudioFormatInfo *info,
* Information for an audio format.
*/
struct _GstAudioFormatInfo {
/*< public >*/
GstAudioFormat format;
const gchar *name;
const gchar *description;

5
gst-libs/gst/audio/audio-resampler.c
View file

@ -1318,13 +1318,16 @@ gst_audio_resampler_options_set_quality (GstAudioResamplerMethod method,
* gst_audio_resampler_new:
* @method: a #GstAudioResamplerMethod
* @flags: #GstAudioResamplerFlags
* @format: the #GstAudioFormat
* @channels: the number of channels
* @in_rate: input rate
* @out_rate: output rate
* @options: extra options
*
* Make a new resampler.
*
* Returns: (skip) (transfer full): %TRUE on success
* Returns: (skip) (transfer full): The new #GstAudioResampler, or
* %NULL on failure.
*/
GstAudioResampler *
gst_audio_resampler_new (GstAudioResamplerMethod method,

2
gst-libs/gst/audio/gstaudioaggregator.c
View file

@ -40,7 +40,7 @@
* to enable that behaviour, the GType of the sink pads must either be
* a (subclass of) #GstAudioAggregatorConvertPad to use the default
* #GstAudioConverter implementation, or a subclass of #GstAudioAggregatorPad
* implementing #GstAudioAggregatorPad.convert_buffer.
* implementing #GstAudioAggregatorPadClass.convert_buffer.
*
* To allow for the output caps to change, the mechanism is the same as
* above, with the GType of the source pad.

9
gst-libs/gst/audio/gstaudioaggregator.h
View file

@ -59,7 +59,6 @@ typedef struct _GstAudioAggregatorPadPrivate GstAudioAggregatorPadPrivate;
/**
* GstAudioAggregatorPad:
* @parent: The parent #GstAggregatorPad
* @info: The audio info for this pad set from the incoming caps
*
* The default implementation of GstPad used with #GstAudioAggregator
@ -68,6 +67,7 @@ struct _GstAudioAggregatorPad
{
GstAggregatorPad parent;
/*< public >*/
/* read-only, with OBJECT_LOCK */
GstAudioInfo info;
@ -118,7 +118,6 @@ typedef struct _GstAudioAggregatorConvertPadPrivate GstAudioAggregatorConvertPad
/**
* GstAudioAggregatorConvertPad:
* @parent: The parent #GstAudioAggregatorPad
*
* An implementation of GstPad that can be used with #GstAudioAggregator.
*
@ -126,9 +125,9 @@ typedef struct _GstAudioAggregatorConvertPadPrivate GstAudioAggregatorConvertPad
*/
struct _GstAudioAggregatorConvertPad
{
/*< private >*/
GstAudioAggregatorPad parent;
/*< private >*/
GstAudioAggregatorConvertPadPrivate *priv;
gpointer _gst_reserved[GST_PADDING];
@ -162,8 +161,6 @@ GType gst_audio_aggregator_convert_pad_get_type (void);
/**
* GstAudioAggregator:
* @parent: The parent #GstAggregator
* @info: The information parsed from the current caps
* @current_caps: The caps set by the subclass
*
* GstAudioAggregator object
@ -172,6 +169,7 @@ struct _GstAudioAggregator
{
GstAggregator parent;
/*< public >*/
GstCaps *current_caps;
/*< private >*/
@ -191,6 +189,7 @@ struct _GstAudioAggregator
struct _GstAudioAggregatorClass {
GstAggregatorClass parent_class;
/*< public >*/
GstBuffer * (* create_output_buffer) (GstAudioAggregator * aagg,
guint num_frames);
gboolean (* aggregate_one_buffer) (GstAudioAggregator * aagg,

4
gst-libs/gst/audio/gstaudiodecoder.c
View file

@ -1190,7 +1190,7 @@ foreach_metadata (GstBuffer * inbuf, GstMeta ** meta, gpointer user_data)
* Otherwise, source pad caps must be set when it is called with valid
* data in @buf.
*
* Note that a frame received in gst_audio_decoder_handle_frame() may be
* Note that a frame received in #GstAudioDecoderClass.handle_frame() may be
* invalidated by a call to this function.
*
* Returns: a #GstFlowReturn that should be escalated to caller (of caller)
@ -3563,7 +3563,7 @@ fallback:
* @allocator: (out) (allow-none) (transfer full): the #GstAllocator
* used
* @params: (out) (allow-none) (transfer full): the
* #GstAllocatorParams of @allocator
* #GstAllocationParams of @allocator
*
* Lets #GstAudioDecoder sub-classes to know the memory @allocator
* used by the base class and its @params.

12
gst-libs/gst/audio/gstaudioencoder.c
View file

@ -720,7 +720,7 @@ foreach_metadata (GstBuffer * inbuf, GstMeta ** meta, gpointer user_data)
* are considered discarded, e.g. as a result of discontinuous transmission,
* and a discontinuity is marked.
*
* Note that samples received in gst_audio_encoder_handle_frame()
* Note that samples received in #GstAudioEncoderClass.handle_frame()
* may be invalidated by a call to this function.
*
* Returns: a #GstFlowReturn that should be escalated to caller (of caller)
@ -2148,7 +2148,7 @@ gst_audio_encoder_get_audio_info (GstAudioEncoder * enc)
* must be called with the same number.
*
* Note: This value will be reset to 0 every time before
* GstAudioEncoder::set_format() is called.
* #GstAudioEncoderClass.set_format() is called.
*/
void
gst_audio_encoder_set_frame_samples_min (GstAudioEncoder * enc, gint num)
@ -2185,7 +2185,7 @@ gst_audio_encoder_get_frame_samples_min (GstAudioEncoder * enc)
* must be called with the same number.
*
* Note: This value will be reset to 0 every time before
* GstAudioEncoder::set_format() is called.
* #GstAudioEncoderClass.set_format() is called.
*/
void
gst_audio_encoder_set_frame_samples_max (GstAudioEncoder * enc, gint num)
@ -2219,7 +2219,7 @@ gst_audio_encoder_get_frame_samples_max (GstAudioEncoder * enc)
* Requires @frame_samples_min and @frame_samples_max to be the equal.
*
* Note: This value will be reset to 0 every time before
* GstAudioEncoder::set_format() is called.
* #GstAudioEncoderClass.set_format() is called.
*/
void
gst_audio_encoder_set_frame_max (GstAudioEncoder * enc, gint num)
@ -2252,7 +2252,7 @@ gst_audio_encoder_get_frame_max (GstAudioEncoder * enc)
* Sets encoder lookahead (in units of input rate samples)
*
* Note: This value will be reset to 0 every time before
* GstAudioEncoder::set_format() is called.
* #GstAudioEncoderClass.set_format() is called.
*/
void
gst_audio_encoder_set_lookahead (GstAudioEncoder * enc, gint num)
@ -2927,7 +2927,7 @@ fallback:
* @allocator: (out) (allow-none) (transfer full): the #GstAllocator
* used
* @params: (out) (allow-none) (transfer full): the
* #GstAllocatorParams of @allocator
* #GstAllocationParams of @allocator
*
* Lets #GstAudioEncoder sub-classes to know the memory @allocator
* used by the base class and its @params.

2
gst-libs/gst/audio/gstaudiometa.c
View file

@ -19,7 +19,7 @@
/**
* SECTION:gstaudiometa
* @title: GstAudioDownmixMeta
* @title: GstAudio meta
* @short_description: Buffer metadata for audio downmix matrix handling
*
* #GstAudioDownmixMeta defines an audio downmix matrix to be send along with

2
gst-libs/gst/audio/gstaudioringbuffer.h
View file

@ -187,7 +187,9 @@ struct _GstAudioRingBuffer {
gboolean acquired;
guint8 *memory;
gsize size;
/*< private >*/
GstClockTime *timestamps;
/*< public >*/ /* with LOCK */
GstAudioRingBufferSpec spec;
gint samples_per_seg;
guint8 *empty_seg;

18
gst-libs/gst/audio/gstaudiostreamalign.c
View file

@ -65,7 +65,7 @@ struct _GstAudioStreamAlign
*
* Allocate a new #GstAudioStreamAlign with the given configuration. All
* processing happens according to sample rate @rate, until
* gst_audio_discont_wait_set_rate() is called with a new @rate.
* gst_audio_stream_align_set_rate() is called with a new @rate.
* A negative rate can be used for reverse playback.
*
* @alignment_threshold gives the tolerance in nanoseconds after which a
@ -139,7 +139,7 @@ gst_audio_stream_align_free (GstAudioStreamAlign * align)
}
/**
* gst_audio_discont_set_rate:
* gst_audio_stream_align_set_rate:
* @align: a #GstAudioStreamAlign
* @rate: a new sample rate
*
@ -162,7 +162,7 @@ gst_audio_stream_align_set_rate (GstAudioStreamAlign * align, gint rate)
}
/**
* gst_audio_discont_get_rate:
* gst_audio_stream_align_get_rate:
* @align: a #GstAudioStreamAlign
*
* Gets the currently configured sample rate.
@ -180,9 +180,9 @@ gst_audio_stream_align_get_rate (GstAudioStreamAlign * align)
}
/**
* gst_audio_discont_set_alignment_threshold:
* gst_audio_stream_align_set_alignment_threshold:
* @align: a #GstAudioStreamAlign
* @alignment_treshold: a new alignment threshold
* @alignment_threshold: a new alignment threshold
*
* Sets @alignment_treshold as new alignment threshold for the following processing.
*
@ -198,7 +198,7 @@ gst_audio_stream_align_set_alignment_threshold (GstAudioStreamAlign *
}
/**
* gst_audio_discont_get_alignment_threshold:
* gst_audio_stream_align_get_alignment_threshold:
* @align: a #GstAudioStreamAlign
*
* Gets the currently configured alignment threshold.
@ -216,9 +216,9 @@ gst_audio_stream_align_get_alignment_threshold (GstAudioStreamAlign * align)
}
/**
* gst_audio_discont_set_discont_wait:
* gst_audio_stream_align_set_discont_wait:
* @align: a #GstAudioStreamAlign
* @alignment_treshold: a new discont wait
* @discont_wait: a new discont wait
*
* Sets @alignment_treshold as new discont wait for the following processing.
*
@ -234,7 +234,7 @@ gst_audio_stream_align_set_discont_wait (GstAudioStreamAlign * align,
}
/**
* gst_audio_discont_get_discont_wait:
* gst_audio_stream_align_get_discont_wait:
* @align: a #GstAudioStreamAlign
*
* Gets the currently configured discont wait.

2
gst-libs/gst/gl/egl/gsteglimage.h
View file

@ -55,13 +55,13 @@ typedef void (*GstEGLImageDestroyNotify) (GstEGLImage * image,
*/
struct _GstEGLImage
{
/*< private >*/
GstMiniObject parent;
GstGLContext *context;
gpointer image;
GstGLFormat format;
/* <private> */
gpointer destroy_data;
GstEGLImageDestroyNotify destroy_notify;

2
gst-libs/gst/gl/egl/gstglmemoryegl.c
View file

@ -25,7 +25,7 @@
/**
* SECTION:gstglmemoryegl
* @short_description: memory subclass for EGLImage's
* @see_also: #GstGLMemory, #GstGLAllocator, #GstGLBufferPool
* @see_also: #GstGLMemory, #GstGLBaseMemoryAllocator, #GstGLBufferPool
*
* #GstGLMemoryEGL is created or wrapped through gst_gl_base_memory_alloc()
* with #GstGLVideoAllocationParams.

2
gst-libs/gst/gl/egl/gstglmemoryegl.h
View file

@ -36,7 +36,7 @@ GST_GL_API GType gst_gl_memory_egl_allocator_get_type(void);
#define GST_IS_GL_MEMORY_EGL_ALLOCATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_GL_MEMORY_EGL_ALLOCATOR))
#define GST_GL_MEMORY_EGL_ALLOCATOR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_GL_MEMORY_EGL_ALLOCATOR, GstGLMemoryEGLAllocatorClass))
#define GST_GL_MEMORY_EGL_ALLOCATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_GL_MEMORY_EGL_ALLOCATOR, GstGLMemoryEGLAllocator))
#define GST_GL_MEMORY_EGL_ALLOCATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_GL_MEMORY_EGL_ALLOCATOR, GstGLAllocatorClass))
#define GST_GL_MEMORY_EGL_ALLOCATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_GL_MEMORY_EGL_ALLOCATOR, GstGLMemoryEGLAllocatorClass))
#define GST_GL_MEMORY_EGL_ALLOCATOR_CAST(obj) ((GstGLMemoryEGLAllocator *)(obj))
/**

13
gst-libs/gst/gl/gstglbasefilter.h
View file

@ -40,23 +40,25 @@ GType gst_gl_base_filter_get_type(void);
/**
* GstGLBaseFilter:
* @parent: parent #GstBaseTransform
* @display: the currently configured #GstGLDisplay
* @context: the currently configured #GstGLContext
* @in_caps: the currently configured input #GstCaps
* @out_caps: the currently configured output #GstCaps
*
* The parent instance type of a base GStreamer GL Filter.
*/
struct _GstGLBaseFilter
{
GstBaseTransform parent;
/*< public >*/
GstGLDisplay *display;
GstGLContext *context;
GstCaps *in_caps;
GstCaps *out_caps;
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
GstGLBaseFilterPrivate *priv;
@ -64,22 +66,25 @@ struct _GstGLBaseFilter
/**
* GstGLBaseFilterClass:
* @parent_class: parent class
* @supported_gl_api: the logical-OR of #GstGLAPI's supported by this element
* @gl_start: called in the GL thread to setup the element GL state.
* @gl_stop: called in the GL thread to setup the element GL state.
* @gl_set_caps: called in the GL thread when caps are set on @filter.
*
* The base class for GStreamer GL Filter.
*/
struct _GstGLBaseFilterClass
{
GstBaseTransformClass parent_class;
/*< public >*/
GstGLAPI supported_gl_api;
gboolean (*gl_start) (GstGLBaseFilter *filter);
void (*gl_stop) (GstGLBaseFilter *filter);
gboolean (*gl_set_caps) (GstGLBaseFilter *filter, GstCaps * incaps, GstCaps * outcaps);
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};

2
gst-libs/gst/gl/gstglbasememory.h
View file

@ -332,7 +332,7 @@ typedef GstGLBaseMemory * (*GstGLBaseMemoryAllocatorCopyFunction) (Gst
typedef void (*GstGLBaseMemoryAllocatorDestroyFunction) (GstGLBaseMemory * mem);
/**
* GstGLBaseMemoryAllocator
* GstGLBaseMemoryAllocator:
*
* Opaque #GstGLBaseMemoryAllocator struct
*

4
gst-libs/gst/gl/gstglbuffer.h
View file

@ -92,9 +92,9 @@ GstGLBufferAllocationParams * gst_gl_buffer_allocation_params_new (GstGLCo
guint gl_usage);
/**
* GstGLBufferAllocator
* GstGLBufferAllocator:
*
* Opaque #GstGLAllocator struct
* Opaque #GstGLBufferAllocator struct
*/
struct _GstGLBufferAllocator
{

6
gst-libs/gst/gl/gstglcolorconvert.c
View file

@ -781,7 +781,7 @@ gst_gl_color_convert_set_caps (GstGLColorConvert * convert,
* @convert: a #GstGLColorConvert
* @query: a completed ALLOCATION #GstQuery
*
* Provides an implementation of #GstBaseTransfromClass::decide_allocation()
* Provides an implementation of #GstBaseTransformClass.decide_allocation()
*
* Returns: whether the allocation parameters were successfully chosen
*
@ -975,7 +975,7 @@ gst_gl_color_convert_caps_transform_format_info (GstCaps * caps)
* @caps: (transfer none): the #GstCaps to transform
* @filter: (transfer none): a set of filter #GstCaps
*
* Provides an implementation of #GstBaseTransformClass::transform_caps()
* Provides an implementation of #GstBaseTransformClass.transform_caps()
*
* Returns: (transfer full): the converted #GstCaps
*
@ -1213,7 +1213,7 @@ gst_gl_color_convert_fixate_format_target (GstCaps * caps, GstCaps * result)
* @caps: (transfer none): the #GstCaps of @direction
* @other: (transfer full): the #GstCaps to fixate
*
* Provides an implementation of #GstBaseTransformClass::fixate_caps()
* Provides an implementation of #GstBaseTransformClass.fixate_caps()
*
* Returns: (transfer full): the fixated #GstCaps
*

2
gst-libs/gst/gl/gstglcontext.c
View file

@ -1758,7 +1758,7 @@ gst_gl_context_default_get_gl_platform_version (GstGLContext * context,
* @minor: (out): return for the minor version
*
* Get the version of the OpenGL platform (GLX, EGL, etc) used. Only valid
* after a call to gst_gl_context_create_context().
* after a call to gst_gl_context_create().
*/
void
gst_gl_context_get_gl_platform_version (GstGLContext * context, gint * major,

14
gst-libs/gst/gl/gstglfilter.h
View file

@ -41,7 +41,7 @@ GType gst_gl_filter_get_type(void);
/**
* GstGLFilterRenderFunc:
* @filter: the #GstGLFIlter
* @filter: the #GstGLFilter
* @in_tex: the input #GstGLMemory to render
* @user_data: user data
*
@ -53,18 +53,18 @@ typedef gboolean (*GstGLFilterRenderFunc) (GstGLFilter * filter, GstGLMemory * i
/**
* GstGLFilter:
* @parent: parent #GstGLBaseFilter
* @in_info: the video info for input buffers
* @out_info: the video info for output buffers
* @in_texture_target: The texture target of the input buffers (usually 2D)
* @out_texture_target: The texture target of the output buffers (usually 2D)
* @out_caps: the output #GstCaps
* @fbo: #GstGLFramebuffer object used for transformations
* @fbo: #GstGLFramebuffer object used for transformations (only for subclass usage)
*/
struct _GstGLFilter
{
GstGLBaseFilter parent;
/*< public >*/
GstVideoInfo in_info;
GstVideoInfo out_info;
GstGLTextureTarget in_texture_target;
@ -72,10 +72,10 @@ struct _GstGLFilter
GstCaps *out_caps;
/* <protected> */
/* protected */
GstGLFramebuffer *fbo;
/* <private> */
/*< private >*/
gboolean gl_result;
GstBuffer *inbuf;
GstBuffer *outbuf;
@ -94,7 +94,6 @@ struct _GstGLFilter
/**
* GstGLFilterClass:
* @parent_class: parent #GstGLBaseFilterClass
* @set_caps: mirror from #GstBaseTransform
* @filter: perform operations on the input and output buffers. In general,
* you should avoid using this method if at all possible. One valid
@ -110,6 +109,7 @@ struct _GstGLFilterClass
{
GstGLBaseFilterClass parent_class;
/*< public >*/
gboolean (*set_caps) (GstGLFilter* filter, GstCaps* incaps, GstCaps* outcaps);
gboolean (*filter) (GstGLFilter *filter, GstBuffer *inbuf, GstBuffer *outbuf);
gboolean (*filter_texture) (GstGLFilter *filter, GstGLMemory *in_tex, GstGLMemory *out_tex);
@ -118,7 +118,7 @@ struct _GstGLFilterClass
GstCaps *(*transform_internal_caps) (GstGLFilter *filter,
GstPadDirection direction, GstCaps * caps, GstCaps * filter_caps);
/* <private> */
/*< private >*/
gpointer _padding[GST_PADDING];
};

2
gst-libs/gst/gl/gstglmemory.h
View file

@ -60,7 +60,7 @@ GType gst_gl_memory_allocator_get_type(void);
* @mem: the parent #GstGLBaseMemory object
* @tex_id: the GL texture id for this memory
* @tex_target: the GL texture target for this memory
* @tex_type: the texture type
* @tex_format: the texture type
* @info: the texture's #GstVideoInfo
* @valign: data alignment for system memory mapping
* @plane: data plane in @info

10
gst-libs/gst/gl/gstglmemorypbo.h
View file

@ -34,7 +34,7 @@ GType gst_gl_memory_pbo_allocator_get_type(void);
#define GST_IS_GL_MEMORY_PBO_ALLOCATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_GL_MEMORY_PBO_ALLOCATOR))
#define GST_GL_MEMORY_PBO_ALLOCATOR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_GL_MEMORY_PBO_ALLOCATOR, GstGLMemoryPBOAllocatorClass))
#define GST_GL_MEMORY_PBO_ALLOCATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_GL_MEMORY_PBO_ALLOCATOR, GstGLMemoryPBOAllocator))
#define GST_GL_MEMORY_PBO_ALLOCATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_GL_MEMORY_PBO_ALLOCATOR, GstGLAllocatorClass))
#define GST_GL_MEMORY_PBO_ALLOCATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_GL_MEMORY_PBO_ALLOCATOR, GstGLMemoryPBOAllocatorClass))
#define GST_GL_MEMORY_PBO_ALLOCATOR_CAST(obj) ((GstGLMemoryPBOAllocator *)(obj))
/**
@ -80,9 +80,9 @@ gboolean gst_gl_memory_pbo_copy_into_texture (GstGLMemoryPBO *gl_mem,
gboolean respecify);
/**
* GstGLAllocator
* GstGLMemoryPBOAllocator:
*
* Opaque #GstGLAllocator struct
* Opaque #GstGLMemoryPBOAllocator struct
*/
struct _GstGLMemoryPBOAllocator
{
@ -93,9 +93,9 @@ struct _GstGLMemoryPBOAllocator
};
/**
* GstGLAllocatorClass:
* GstGLMemoryPBOAllocatorClass:
*
* The #GstGLAllocatorClass only contains private data
* Only contains private data
*/
struct _GstGLMemoryPBOAllocatorClass
{

4
gst-libs/gst/gl/gstgloverlaycompositor.h
View file

@ -37,17 +37,17 @@ GST_GL_API
GType gst_gl_overlay_compositor_get_type (void);
/**
* GstGLOverlayCompositor
* GstGLOverlayCompositor:
*
* Opaque #GstGLOverlayCompositor object
*/
struct _GstGLOverlayCompositor
{
/* <private> */
GstObject parent;
GstGLContext *context;
/* <private> */
guint last_window_width;
guint last_window_height;

23
gst-libs/gst/gl/gstglrenderbuffer.h
View file

@ -46,9 +46,8 @@ GST_GL_API GType gst_gl_renderbuffer_allocator_get_type(void);
/**
* GstGLRenderbuffer:
* @mem: the parent object
* @renderbuffer_id: the GL texture id for this memory
* @renderbuffer_type: the texture type
* @renderbuffer_format: the texture type
* @width: the width
* @height: the height
*
@ -56,8 +55,10 @@ GST_GL_API GType gst_gl_renderbuffer_allocator_get_type(void);
*/
struct _GstGLRenderbuffer
{
/*< private >*/
GstGLBaseMemory mem;
/*< public >*/
guint renderbuffer_id;
GstGLFormat renderbuffer_format;
guint width;
@ -71,7 +72,7 @@ struct _GstGLRenderbuffer
};
/**
* GstGLRenderbufferAllocator
* GstGLRenderbufferAllocator:
*
* Opaque #GstGLRenderbufferAllocator struct
*/
@ -98,20 +99,32 @@ struct _GstGLRenderbufferAllocatorClass
#include <gst/gl/gstglbasememory.h>
typedef struct _GstGLRenderbufferAllocationParams GstGLRenderbufferAllocationParams;
GST_GL_API GType gst_gl_renderbuffer_allocation_params_get_type (void);
#define GST_TYPE_RENDERBUFFER_ALLOCATION_PARAMS (gst_gl_renderbuffer_allocation_params_get_type)
typedef struct
/**
* GstGLRenderbufferAllocationParams:
* @renderbuffer_format: the #GstGLFormat
* @width: the width
* @height: the height
*
* Allocation parameters
*/
struct _GstGLRenderbufferAllocationParams
{
/*< private >*/
GstGLAllocationParams parent;
/*< public >*/
GstGLFormat renderbuffer_format;
guint width;
guint height;
/* <private> */
gpointer _padding[GST_PADDING];
} GstGLRenderbufferAllocationParams;
};
GST_GL_API
GstGLRenderbufferAllocationParams * gst_gl_renderbuffer_allocation_params_new (GstGLContext * context,

4
gst-libs/gst/gl/gstglutils.c
View file

@ -315,8 +315,8 @@ done:
* @display: (inout) (transfer full): location of a #GstGLDisplay
* @other_context: (inout) (transfer full): location of a #GstGLContext
*
* Helper function for implementing GstElement::set_context() in OpenGL capable
* elements.
* Helper function for implementing #GstElementClass.set_context() in
* OpenGL capable elements.
*
* Retrieve's the #GstGLDisplay or #GstGLContext in @context and places the
* result in @display or @other_context respectively.

4
gst-libs/gst/gl/gstglviewconvert.c
View file

@ -1083,7 +1083,7 @@ _intersect_with_mview_modes (GstCaps * caps, const GValue * modes)
* @caps: (transfer none): the #GstCaps to transform
* @filter: (transfer none): a set of filter #GstCaps
*
* Provides an implementation of #GstBaseTransformClass::transform_caps()
* Provides an implementation of #GstBaseTransformClass.transform_caps()
*
* Returns: (transfer full): the converted #GstCaps
*
@ -1273,7 +1273,7 @@ _fixate_texture_target (GstGLViewConvert * viewconvert,
* @caps: (transfer none): the #GstCaps of @direction
* @othercaps: (transfer full): the #GstCaps to fixate
*
* Provides an implementation of #GstBaseTransformClass::fixate_caps()
* Provides an implementation of #GstBaseTransformClass.fixate_caps()
*
* Returns: (transfer full): the fixated #GstCaps
*

1
gst-libs/gst/gl/wayland/Makefile.am
View file

@ -8,7 +8,6 @@ libgstgl_wayland_la_SOURCES = \
wayland_event_source.c
noinst_HEADERS = \
gstgldisplay_wayland.h \
gstglwindow_wayland_egl.h \
wayland_event_source.h

2
gst-libs/gst/gl/x11/gstgldisplay_x11.h
View file

@ -50,9 +50,9 @@ typedef struct _GstGLDisplayX11Class GstGLDisplayX11Class;
*/
struct _GstGLDisplayX11
{
/*< private >*/
GstGLDisplay parent;
/* <private> */
gchar *name;
Display *display;
xcb_connection_t *xcb_connection;

1
gst-libs/gst/pbutils/gstaudiovisualizer.c
View file

@ -22,6 +22,7 @@
/**
* SECTION:gstaudiovisualizer
* @title: GstAudioVisualizer
* @short_description: Base class for visualizers.
*
* A baseclass for scopes (visualizers). It takes care of re-fitting the
* audio-rate to video-rate and handles renegotiation (downstream video size

4
gst-libs/gst/pbutils/gstaudiovisualizer.h
View file

@ -84,14 +84,16 @@ struct _GstAudioVisualizer
/* audio state */
GstAudioInfo ainfo;
/* <private> */
/*< private >*/
GstAudioVisualizerPrivate *priv;
};
struct _GstAudioVisualizerClass
{
/*< private >*/
GstElementClass parent_class;
/*< public >*/
/* virtual function, called whenever the format changes */
gboolean (*setup) (GstAudioVisualizer * scope);

1
gst-libs/gst/rtp/gstrtcpbuffer.h
View file

@ -209,6 +209,7 @@ struct _GstRTCPBuffer
*/
struct _GstRTCPPacket
{
/*< public >*/
GstRTCPBuffer *rtcp;
guint offset;

33
gst-libs/gst/rtp/gstrtpbasedepayload.h
View file

@ -67,9 +67,21 @@ struct _GstRTPBaseDepayload
* GstRTPBaseDepayloadClass:
* @parent_class: the parent class
* @set_caps: configure the depayloader
* @process: process incoming rtp packets
* @process: process incoming rtp packets. Subclass must implement either
* this method or @process_rtp_packet to process incoming rtp packets.
* If the child returns a buffer without a valid timestamp, the timestamp
* of the provided buffer will be applied to the result buffer and the
* buffer will be pushed. If this function returns %NULL, nothing is pushed.
* @packet_lost: signal the depayloader about packet loss
* @handle_event: custom event handling
* @process_rtp_packet: Same as the process virtual function, but slightly more
* efficient, since it is passed the rtp buffer structure that has already
* been mapped (with GST_MAP_READ) by the base class and thus does not have
* to be mapped again by the subclass. Can be used by the subclass to process
* incoming rtp packets. If the subclass returns a buffer without a valid
* timestamp, the timestamp of the input buffer will be applied to the result
* buffer and the output buffer will be pushed out. If this function returns
* %NULL, nothing is pushed out. Since: 1.6.
*
* Base class for RTP depayloaders.
*/
@ -77,15 +89,11 @@ struct _GstRTPBaseDepayloadClass
{
GstElementClass parent_class;
/*< public >*/
/* virtuals, inform the subclass of the caps. */
gboolean (*set_caps) (GstRTPBaseDepayload *filter, GstCaps *caps);
/* pure virtual function, child must implement either this method
* or the process_rtp_packet virtual method to process incoming
* rtp packets. If the child returns a buffer without a valid timestamp,
* the timestamp of @in will be applied to the result buffer and the
* buffer will be pushed. If this function returns %NULL, nothing is
* pushed. */
/* pure virtual function */
GstBuffer * (*process) (GstRTPBaseDepayload *base, GstBuffer *in);
/* non-pure function used to to signal the depayloader about packet loss. the
@ -97,17 +105,6 @@ struct _GstRTPBaseDepayloadClass
* implementation can override. */
gboolean (*handle_event) (GstRTPBaseDepayload * filter, GstEvent * event);
/* Optional. Same as the process virtual function, but slightly more
* efficient, since it is passed the rtp buffer structure that has already
* been mapped (with GST_MAP_READ) by the base class and thus does not have
* to be mapped again by the subclass. Can be used by the subclass to process
* incoming rtp packets. If the subclass returns a buffer without a valid
* timestamp, the timestamp of the input buffer will be applied to the result
* buffer and the output buffer will be pushed out. If this function returns
* %NULL, nothing is pushed out.
*
* Since: 1.6
*/
GstBuffer * (*process_rtp_packet) (GstRTPBaseDepayload *base, GstRTPBuffer * rtp_buffer);
/*< private >*/

8
gst-libs/gst/rtp/gstrtpdefs.h
View file

@ -27,6 +27,14 @@
#include <gst/gst.h>
#include <gst/rtp/rtp-prelude.h>
/**
* SECTION:gstrtpdefs
* @title: GstRTPdefs
* @short_description: common RTP defines
*
* Provides common defines for the RTP library.
*/
/**
* GstRTPProfile:
* @GST_RTP_PROFILE_UNKNOWN: invalid profile

2
gst-libs/gst/rtsp/gstrtspextension.h
View file

@ -41,7 +41,7 @@ G_BEGIN_DECLS
(G_TYPE_INSTANCE_GET_INTERFACE ((inst), GST_TYPE_RTSP_EXTENSION, GstRTSPExtensionInterface))
/**
* GstRTSPExtension:
* GstRTSPExtensionInterface:
*
* An interface representing RTSP extensions.
*/

15
gst-libs/gst/rtsp/gstrtspmessage.h
View file

@ -261,6 +261,14 @@ GstRTSPResult gst_rtsp_message_steal_body (GstRTSPMessage *msg,
typedef struct _GstRTSPAuthCredential GstRTSPAuthCredential;
typedef struct _GstRTSPAuthParam GstRTSPAuthParam;
/**
* GstRTSPAuthCredential:
* @scheme: a #GstRTSPAuthMethod
* @params: A NULL-terminated array of #GstRTSPAuthParam
* @authorization: The authorization for the basic schem
*
* RTSP Authentication credentials
*/
struct _GstRTSPAuthCredential {
GstRTSPAuthMethod scheme;
@ -272,6 +280,13 @@ struct _GstRTSPAuthCredential {
gchar *authorization;
};
/**
* GstRTSPAuthParam:
* @name: The name of the parameter
* @value: The value of the parameter
*
* RTSP Authentication parameter
*/
struct _GstRTSPAuthParam {
gchar *name;
gchar *value;

2
gst-libs/gst/sdp/gstmikey.c
View file

@ -921,7 +921,7 @@ gst_mikey_message_new_from_bytes (GBytes * bytes, GstMIKEYDecryptInfo * info,
* @V: verify flag
* @prf_func: the #GstMIKEYPRFFunc function to use
* @CSB_id: the Crypto Session Bundle id
* @map_type: the #GstMIKEYCSIDMapType
* @map_type: the #GstMIKEYMapType
*
* Set the information in @msg.
*

10
gst-libs/gst/sdp/gstmikey.h
View file

@ -119,7 +119,7 @@ typedef enum
/**
* GstMIKEYMapType:
* @GST_MIKEY_MAP_TYPE_SRTP:
* @GST_MIKEY_MAP_TYPE_SRTP: SRTP
*
* Specifies the method of uniquely mapping Crypto Sessions to the security
* protocol sessions.
@ -369,7 +369,7 @@ typedef struct {
/**
* GstMIKEYSecProto:
* @GST_MIKEY_SEC_PROTO_SRTP:
* @GST_MIKEY_SEC_PROTO_SRTP: SRTP
*
* Specifies the security protocol
*/
@ -418,7 +418,7 @@ typedef enum
* @pt: the payload header
* @policy: the policy number
* @proto: the security protocol
* @params: array of #GstMIKEYPayloadPSParam
* @params: array of #GstMIKEYPayloadSPParam
*
* The Security Policy payload defines a set of policies that apply to a
* specific security protocol
@ -498,9 +498,9 @@ typedef enum
/**
* GstMIKEYPayloadKeyData:
* @pt: the payload header
* @type: the #GstMIKEYKeyDataType of @key_data
* @key_type: the #GstMIKEYKeyDataType of @key_data
* @key_len: length of @key_data
* @key_dat: the key data
* @key_data: the key data
* @salt_len: the length of @salt_data, can be 0
* @salt_data: salt data
* @kv_type: the Key Validity type

2
gst-libs/gst/sdp/gstsdpmessage.c
View file

@ -1431,7 +1431,7 @@ DEFINE_ARRAY_GETTER (zone, zones, GstSDPZone);
* gst_sdp_message_insert_zone:
* @msg: a #GstSDPMessage
* @idx: an index
* @zone a #GstSDPZone
* @zone: a #GstSDPZone
*
* Insert zone parameters into the array of zones in @msg
* at index @idx.

2
gst-libs/gst/video/gstvideodecoder.c
View file

@ -4391,7 +4391,7 @@ gst_video_decoder_get_buffer_pool (GstVideoDecoder * decoder)
* @allocator: (out) (allow-none) (transfer full): the #GstAllocator
* used
* @params: (out) (allow-none) (transfer full): the
* #GstAllocatorParams of @allocator
* #GstAllocationParams of @allocator
*
* Lets #GstVideoDecoder sub-classes to know the memory @allocator
* used by the base class and its @params.

4
gst-libs/gst/video/gstvideoencoder.c
View file

@ -2496,7 +2496,7 @@ gst_video_encoder_get_oldest_frame (GstVideoEncoder * encoder)
/**
* gst_video_encoder_get_frame:
* @encoder: a #GstVideoEnccoder
* @encoder: a #GstVideoEncoder
* @frame_number: system_frame_number of a frame
*
* Get a pending unfinished #GstVideoCodecFrame
@ -2595,7 +2595,7 @@ gst_video_encoder_merge_tags (GstVideoEncoder * encoder,
* @allocator: (out) (allow-none) (transfer full): the #GstAllocator
* used
* @params: (out) (allow-none) (transfer full): the
* #GstAllocatorParams of @allocator
* #GstAllocationParams of @allocator
*
* Lets #GstVideoEncoder sub-classes to know the memory @allocator
* used by the base class and its @params.

8
gst-libs/gst/video/gstvideometa.c
View file

@ -21,6 +21,13 @@
#include <string.h>
/**
* SECTION:gstvideometa
* @title: GstMeta for video
* @short_description: Video related GstMeta
*
*/
#ifndef GST_DISABLE_GST_DEBUG
#define GST_CAT_DEFAULT ensure_debug_category()
static GstDebugCategory *
@ -885,6 +892,7 @@ gst_video_region_of_interest_meta_add_param (GstVideoRegionOfInterestMeta *
/**
* gst_video_region_of_interest_meta_get_param:
* @meta: a #GstVideoRegionOfInterestMeta
* @name: a name.
*
* Retrieve the parameter for @meta having @name as structure name,
* or %NULL if there is none.

2
gst-libs/gst/video/gstvideotimecode.c
View file

@ -689,7 +689,7 @@ gst_video_time_code_new_from_string (const gchar * tc_str)
* The resulting config->latest_daily_jam is set to
* midnight, and timecode is set to the given time.
*
* Returns: the #GVideoTimeCode representation of @dt.
* Returns: the #GstVideoTimeCode representation of @dt.
*
* Since: 1.12
*/

4
gst-libs/gst/video/gstvideoutils.h
View file

@ -227,14 +227,16 @@ struct _GstVideoCodecFrame
{
/*< private >*/
gint ref_count;
guint32 flags;
/*< public >*/
guint32 system_frame_number; /* ED */
/*< private >*/
guint32 decode_frame_number; /* ED */
guint32 presentation_frame_number; /* ED */
/*< public >*/
GstClockTime dts; /* ED */
GstClockTime pts; /* ED */
GstClockTime duration; /* ED */

8
gst-libs/gst/video/video-converter.h
View file

@ -27,17 +27,17 @@ G_BEGIN_DECLS
/**
* GST_VIDEO_CONVERTER_OPT_RESAMPLER_METHOD:
*
* #GST_TYPE_RESAMPLER_METHOD, The resampler method to use for
* #GST_TYPE_VIDEO_RESAMPLER_METHOD, The resampler method to use for
* resampling. Other options for the resampler can be used, see
* the #GstResampler. Default is #GST_RESAMPLER_METHOD_CUBIC
* the #GstVideoResampler. Default is #GST_VIDEO_RESAMPLER_METHOD_CUBIC
*/
#define GST_VIDEO_CONVERTER_OPT_RESAMPLER_METHOD "GstVideoConverter.resampler-method"
/**
* GST_VIDEO_CONVERTER_OPT_CHROMA_RESAMPLER_METHOD:
*
* #GST_TYPE_RESAMPLER_METHOD, The resampler method to use for
* #GST_TYPE_VIDEO_RESAMPLER_METHOD, The resampler method to use for
* chroma resampling. Other options for the resampler can be used, see
* the #GstResampler. Default is #GST_RESAMPLER_METHOD_LINEAR
* the #GstVideoResampler. Default is #GST_VIDEO_RESAMPLER_METHOD_LINEAR
*/
#define GST_VIDEO_CONVERTER_OPT_CHROMA_RESAMPLER_METHOD "GstVideoConverter.chroma-resampler-method"
/**

4
gst-libs/gst/video/video-frame.h
View file

@ -145,10 +145,10 @@ gboolean gst_video_frame_copy_plane (GstVideoFrame *dest, const GstVideoFr
* in the video frame is the top field. If unset, the
* bottom field is first.
* @GST_VIDEO_BUFFER_FLAG_RFF: If the #GstBuffer is interlaced, then the first field
* (as defined by the %GST_VIDEO_BUFFER_TFF flag setting)
* (as defined by the %GST_VIDEO_BUFFER_FLAG_TFF flag setting)
* is repeated.
* @GST_VIDEO_BUFFER_FLAG_ONEFIELD: If the #GstBuffer is interlaced, then only the
* first field (as defined by the %GST_VIDEO_BUFFER_TFF
* first field (as defined by the %GST_VIDEO_BUFFER_FLAG_TFF
* flag setting) is to be displayed.
* @GST_VIDEO_BUFFER_FLAG_MULTIPLE_VIEW: The #GstBuffer contains one or more specific views,
* such as left or right eye view. This flags is set on

2
gst-libs/gst/video/video-info.h
View file

@ -201,7 +201,7 @@ typedef enum {
*
* GstVideoMultiviewFlags are used to indicate extra properties of a
* stereo/multiview stream beyond the frame layout and buffer mapping
* that is conveyed in the #GstMultiviewMode.
* that is conveyed in the #GstVideoMultiviewMode.
*/
typedef enum {
GST_VIDEO_MULTIVIEW_FLAGS_NONE = 0,

2
gst-libs/gst/video/video-multiview.c
View file

@ -368,7 +368,7 @@ gst_video_multiview_video_info_change_mode (GstVideoInfo * info,
* @par_d: Denominator of the video pixel-aspect-ratio
*
* Returns: A boolean indicating whether the
* #GST_VIDEO_MULTIVIEW_FLAG_HALF_ASPECT flag should be set.
* #GST_VIDEO_MULTIVIEW_FLAGS_HALF_ASPECT flag should be set.
*
* Utility function that heuristically guess whether a
* frame-packed stereoscopic video contains half width/height

2
gst-libs/gst/video/video-overlay-composition.c
View file

@ -42,7 +42,7 @@
*
* Together, this allows existing overlay elements to easily handle raw
* and non-raw video as input in without major changes (once the overlays
* have been put into a #GstOverlayComposition object anyway) - for raw
* have been put into a #GstVideoOverlayComposition object anyway) - for raw
* video the overlay can just use the blending function to blend the data
* on top of the video, and for surface buffers it can just attach them to
* the buffer and let the sink render the overlays.

2
gst-libs/gst/video/video-scaler.c
View file

@ -204,7 +204,7 @@ scaler_dump (GstVideoScaler * scale)
* pixel. If n_taps is 0, this function chooses a good value automatically based
* on the @method and @in_size/@out_size.
*
* Returns: a #GstVideoResample
* Returns: a #GstVideoScaler
*/
GstVideoScaler *
gst_video_scaler_new (GstVideoResamplerMethod method, GstVideoScalerFlags flags,

2
gst-libs/gst/video/video-tile.c
View file

@ -30,7 +30,7 @@
* Get the tile index of the tile at coordinates @x and @y in the tiled
* image of @x_tiles by @y_tiles.
*
* Use this method when @mode is of type %GST_VIDEO_TILE_MODE_INDEXED.
* Use this method when @mode is of type %GST_VIDEO_TILE_TYPE_INDEXED.
*
* Returns: the index of the tile at @x and @y in the tiled image of
* @x_tiles by @y_tiles.

3
gst-libs/gst/video/videooverlay.h
View file

@ -43,7 +43,6 @@ G_BEGIN_DECLS
*/
typedef struct _GstVideoOverlay GstVideoOverlay;
typedef struct _GstVideoOverlayInterface GstVideoOverlayInterface;
typedef struct _GstVideoOverlayProperties GstVideoOverlayProperties;
/**
* GstVideoOverlayInterface:
@ -52,8 +51,6 @@ typedef struct _GstVideoOverlayProperties GstVideoOverlayProperties;
* @handle_events: virtual method to handle events
* @set_render_rectangle: virtual method to set the render rectangle
* @set_window_handle: virtual method to configure the window handle
* @properties_offset: Offset to the #GstVideoOverlayProperties in the
* instance allocation. Since 1.14
*
* #GstVideoOverlay interface
*/