mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-26 19:51:11 +00:00
Code Issues 1 Projects Releases Wiki Activity

gst-plugins-base: Fix several annotations

Browse source 
Add annotations for virtual methods when possible.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1965>
This commit is contained in:
Corentin Noël 2022-03-15 13:59:16 +01:00 committed by GStreamer Marge Bot
parent 15a75b99df
commit a5249f7c5f
7 changed files with 27 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
subprojects/gst-plugins-base/gst-libs/gst/audio/gstaudiodecoder.h
View file

@ -272,6 +272,11 @@ struct _GstAudioDecoderClass
gboolean (*set_format) (GstAudioDecoder *dec,
GstCaps *caps);
/**
* GstAudioDecoderClass::parse:
* @offset: (out):
* @length: (out):
*/
GstFlowReturn (*parse) (GstAudioDecoder *dec,
GstAdapter *adapter,
gint *offset, gint *length);

2
subprojects/gst-plugins-base/gst-libs/gst/audio/gstaudioringbuffer.c
View file

@ -1675,7 +1675,7 @@ not_started:
/**
* gst_audio_ring_buffer_commit:
* @buf: the #GstAudioRingBuffer to commit
* @sample: the sample position of the data
* @sample: (inout): the sample position of the data
* @data: (array length=in_samples): the data to commit
* @in_samples: the number of samples in the data to commit
* @out_samples: the number of samples to write to the ringbuffer

7
subprojects/gst-plugins-base/gst-libs/gst/audio/gstaudiosink.h
View file

@ -98,7 +98,12 @@ struct _GstAudioSinkClass {
gboolean (*unprepare) (GstAudioSink *sink);
/* close the device */
gboolean (*close) (GstAudioSink *sink);
/* write samples to the device */
/**
* GstAudioSinkClass::write:
* @data: (type guint8) (array length=length): the sample data
*
* Write samples to the device.
*/
gint (*write) (GstAudioSink *sink, gpointer data, guint length);
/* get number of frames queued in the device */
guint (*delay) (GstAudioSink *sink);

8
subprojects/gst-plugins-base/gst-libs/gst/audio/gstaudiosrc.h
View file

@ -84,7 +84,13 @@ struct _GstAudioSrcClass {
gboolean (*unprepare) (GstAudioSrc *src);
/* close the device */
gboolean (*close) (GstAudioSrc *src);
/* read samples from the device */
/**
* GstAudioSrcClass::read:
* @data: (type guint8) (array length=length): the sample data
* @timestamp: (out): a #GstClockTime
*
* Read samples from the device.
*/
guint (*read) (GstAudioSrc *src, gpointer data, guint length,
GstClockTime *timestamp);
/* get number of frames queued in the device */

4
subprojects/gst-plugins-base/gst-libs/gst/video/gstvideoaggregator.h
View file

@ -310,6 +310,10 @@ struct _GstVideoAggregatorClass
GstBuffer * outbuffer);
GstFlowReturn (*create_output_buffer) (GstVideoAggregator * videoaggregator,
GstBuffer ** outbuffer);
/**
* GstVideoAggregatorClass::find_best_format:
* @at_least_one_alpha: (out):
*/
void (*find_best_format) (GstVideoAggregator * vagg,
GstCaps * downstream_caps,
GstVideoInfo * best_info,

4
subprojects/gst-plugins-base/gst-libs/gst/video/video-chroma.c
View file

@ -1111,8 +1111,8 @@ gst_video_chroma_resample_new (GstVideoChromaMethod method,
/**
* gst_video_chroma_resample_get_info:
* @resample: a #GstVideoChromaResample
* @n_lines: the number of input lines
* @offset: the first line
* @n_lines: (out) (optional): the number of input lines
* @offset: (out) (optional): the first line
*
* The resampler must be fed @n_lines at a time. The first line should be
* at @offset.

4
subprojects/gst-plugins-base/gst-libs/gst/video/video-scaler.c
View file

@ -302,8 +302,8 @@ gst_video_scaler_get_max_taps (GstVideoScaler * scale)
* gst_video_scaler_get_coeff:
* @scale: a #GstVideoScaler
* @out_offset: an output offset
* @in_offset: result input offset
* @n_taps: result n_taps
* @in_offset: (out) (optional): result input offset
* @n_taps: (out) (optional): result n_taps
*
* For a given pixel at @out_offset, get the first required input pixel at
* @in_offset and the @n_taps filter coefficients.