mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-06-07 07:58:51 +00:00
docs: Add new video functions and objects. Cleanup a little.
Add GstVideoChroma, GstVideoDither, GstVideoScaler and friends to the docs. Remove and clean up a few obsolete/deleted refs and typos
This commit is contained in:
parent
8093e3ba94
commit
3d60fb654b
10 changed files with 120 additions and 14 deletions
|
@ -198,6 +198,10 @@
|
||||||
<xi:include href="xml/gstvideometa.xml" />
|
<xi:include href="xml/gstvideometa.xml" />
|
||||||
<xi:include href="xml/gstvideooverlaycomposition.xml" />
|
<xi:include href="xml/gstvideooverlaycomposition.xml" />
|
||||||
<xi:include href="xml/gstvideofilter.xml" />
|
<xi:include href="xml/gstvideofilter.xml" />
|
||||||
|
<xi:include href="xml/gstvideodither.xml" />
|
||||||
|
<xi:include href="xml/gstvideochroma.xml" />
|
||||||
|
<xi:include href="xml/gstvideoresampler.xml" />
|
||||||
|
<xi:include href="xml/gstvideoscaler.xml" />
|
||||||
<xi:include href="xml/gstvideosink.xml" />
|
<xi:include href="xml/gstvideosink.xml" />
|
||||||
<xi:include href="xml/gstcolorbalance.xml" />
|
<xi:include href="xml/gstcolorbalance.xml" />
|
||||||
<xi:include href="xml/gstcolorbalancechannel.xml" />
|
<xi:include href="xml/gstcolorbalancechannel.xml" />
|
||||||
|
|
|
@ -2241,9 +2241,6 @@ GstVideoFormat
|
||||||
GST_VIDEO_MAX_PLANES
|
GST_VIDEO_MAX_PLANES
|
||||||
GST_VIDEO_MAX_COMPONENTS
|
GST_VIDEO_MAX_COMPONENTS
|
||||||
GstVideoFormatInfo
|
GstVideoFormatInfo
|
||||||
GstVideoChromaSite
|
|
||||||
gst_video_chroma_from_string
|
|
||||||
gst_video_chroma_to_string
|
|
||||||
GstVideoFormatFlags
|
GstVideoFormatFlags
|
||||||
GstVideoPackFlags
|
GstVideoPackFlags
|
||||||
GstVideoFormatUnpack
|
GstVideoFormatUnpack
|
||||||
|
@ -2427,6 +2424,7 @@ gst_video_blend_scale_linear_RGBA
|
||||||
|
|
||||||
#video-converter.h
|
#video-converter.h
|
||||||
<SUBSECTION>
|
<SUBSECTION>
|
||||||
|
GstVideoConverter
|
||||||
gst_video_converter_new
|
gst_video_converter_new
|
||||||
gst_video_converter_free
|
gst_video_converter_free
|
||||||
gst_video_converter_get_config
|
gst_video_converter_get_config
|
||||||
|
@ -2518,7 +2516,6 @@ gst_video_gl_texture_upload_meta_get_info
|
||||||
<INCLUDE>gst/video/video-overlay-composition.h</INCLUDE>
|
<INCLUDE>gst/video/video-overlay-composition.h</INCLUDE>
|
||||||
<SUBSECTION composition>
|
<SUBSECTION composition>
|
||||||
GstVideoOverlayComposition
|
GstVideoOverlayComposition
|
||||||
GstVideoOverlayCompositionClass
|
|
||||||
gst_video_overlay_composition_new
|
gst_video_overlay_composition_new
|
||||||
gst_video_overlay_composition_ref
|
gst_video_overlay_composition_ref
|
||||||
gst_video_overlay_composition_unref
|
gst_video_overlay_composition_unref
|
||||||
|
@ -2542,7 +2539,6 @@ gst_buffer_remove_video_overlay_composition_meta
|
||||||
<SUBSECTION rectangle>
|
<SUBSECTION rectangle>
|
||||||
GstVideoOverlayFormatFlags
|
GstVideoOverlayFormatFlags
|
||||||
GstVideoOverlayRectangle
|
GstVideoOverlayRectangle
|
||||||
GstVideoOverlayRectangleClass
|
|
||||||
gst_video_overlay_rectangle_new_raw
|
gst_video_overlay_rectangle_new_raw
|
||||||
gst_video_overlay_rectangle_ref
|
gst_video_overlay_rectangle_ref
|
||||||
gst_video_overlay_rectangle_unref
|
gst_video_overlay_rectangle_unref
|
||||||
|
@ -2562,10 +2558,7 @@ gst_video_overlay_rectangle_set_global_alpha
|
||||||
<SUBSECTION Standard>
|
<SUBSECTION Standard>
|
||||||
GST_TYPE_VIDEO_OVERLAY_COMPOSITION
|
GST_TYPE_VIDEO_OVERLAY_COMPOSITION
|
||||||
GST_VIDEO_OVERLAY_COMPOSITION
|
GST_VIDEO_OVERLAY_COMPOSITION
|
||||||
GST_VIDEO_OVERLAY_COMPOSITION_CLASS
|
|
||||||
GST_VIDEO_OVERLAY_COMPOSITION_GET_CLASS
|
|
||||||
GST_IS_VIDEO_OVERLAY_COMPOSITION
|
GST_IS_VIDEO_OVERLAY_COMPOSITION
|
||||||
GST_IS_VIDEO_VIDEO_OVERLAY_COMPOSITION_CLASS
|
|
||||||
GST_VIDEO_OVERLAY_COMPOSITION_CAST
|
GST_VIDEO_OVERLAY_COMPOSITION_CAST
|
||||||
GST_VIDEO_OVERLAY_COMPOSITION_META_API_TYPE
|
GST_VIDEO_OVERLAY_COMPOSITION_META_API_TYPE
|
||||||
GST_VIDEO_OVERLAY_COMPOSITION_META_INFO
|
GST_VIDEO_OVERLAY_COMPOSITION_META_INFO
|
||||||
|
@ -2574,10 +2567,7 @@ gst_video_overlay_composition_meta_api_get_type
|
||||||
|
|
||||||
GST_TYPE_VIDEO_OVERLAY_RECTANGLE
|
GST_TYPE_VIDEO_OVERLAY_RECTANGLE
|
||||||
GST_VIDEO_OVERLAY_RECTANGLE
|
GST_VIDEO_OVERLAY_RECTANGLE
|
||||||
GST_VIDEO_OVERLAY_RECTANGLE_CLASS
|
|
||||||
GST_VIDEO_OVERLAY_RECTANGLE_GET_CLASS
|
|
||||||
GST_IS_VIDEO_OVERLAY_RECTANGLE
|
GST_IS_VIDEO_OVERLAY_RECTANGLE
|
||||||
GST_IS_VIDEO_VIDEO_OVERLAY_RECTANGLE_CLASS
|
|
||||||
gst_video_overlay_rectangle_get_type
|
gst_video_overlay_rectangle_get_type
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
|
@ -2717,6 +2707,81 @@ GstVideoEncoderPrivate
|
||||||
gst_video_encoder_get_type
|
gst_video_encoder_get_type
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>gstvideodither</FILE>
|
||||||
|
<TITLE>GstVideoDither</TITLE>
|
||||||
|
<INCLUDE>gst/video/video-dither.h</INCLUDE>
|
||||||
|
GstVideoDither
|
||||||
|
GstVideoDitherFlags
|
||||||
|
GstVideoDitherMethod
|
||||||
|
gst_video_dither_free
|
||||||
|
gst_video_dither_line
|
||||||
|
gst_video_dither_new
|
||||||
|
<SUBSECTION Standard>
|
||||||
|
GST_TYPE_VIDEO_DITHER_FLAGS
|
||||||
|
gst_video_dither_flags_get_type
|
||||||
|
</SECTION>
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>gstvideochroma</FILE>
|
||||||
|
<TITLE>GstVideoChroma</TITLE>
|
||||||
|
<INCLUDE>gst/video/video-chroma.h</INCLUDE>
|
||||||
|
GstVideoChromaSite
|
||||||
|
gst_video_chroma_from_string
|
||||||
|
gst_video_chroma_to_string
|
||||||
|
GstVideoChromaFlags
|
||||||
|
<SUBSECTION GstVideoChromaResample>
|
||||||
|
GstVideoChromaMethod
|
||||||
|
GstVideoChromaResample
|
||||||
|
gst_video_chroma_resample
|
||||||
|
gst_video_chroma_resample_free
|
||||||
|
gst_video_chroma_resample_get_info
|
||||||
|
gst_video_chroma_resample_new
|
||||||
|
<SUBSECTION Standard>
|
||||||
|
gst_video_chroma_flags_get_type
|
||||||
|
gst_video_chroma_method_get_type
|
||||||
|
GST_TYPE_VIDEO_CHROMA_FLAGS
|
||||||
|
GST_TYPE_VIDEO_CHROMA_METHOD
|
||||||
|
</SECTION>
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>gstvideoresampler</FILE>
|
||||||
|
<TITLE>GstVideoResampler</TITLE>
|
||||||
|
<INCLUDE>gst/video/video-resampler.h</INCLUDE>
|
||||||
|
GstVideoResampler
|
||||||
|
GstVideoResamplerFlags
|
||||||
|
GstVideoResamplerMethod
|
||||||
|
gst_video_resampler_clear
|
||||||
|
gst_video_resampler_init
|
||||||
|
GST_VIDEO_RESAMPLER_OPT_CUBIC_B
|
||||||
|
GST_VIDEO_RESAMPLER_OPT_CUBIC_C
|
||||||
|
GST_VIDEO_RESAMPLER_OPT_ENVELOPE
|
||||||
|
GST_VIDEO_RESAMPLER_OPT_MAX_TAPS
|
||||||
|
GST_VIDEO_RESAMPLER_OPT_SHARPEN
|
||||||
|
GST_VIDEO_RESAMPLER_OPT_SHARPNESS
|
||||||
|
<SUBSECTION Standard>
|
||||||
|
gst_video_resampler_flags_get_type
|
||||||
|
gst_video_resampler_method_get_type
|
||||||
|
GST_TYPE_VIDEO_RESAMPLER_FLAGS
|
||||||
|
GST_TYPE_VIDEO_RESAMPLER_METHOD
|
||||||
|
</SECTION>
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>gstvideoscaler</FILE>
|
||||||
|
<TITLE>GstVideoScaler</TITLE>
|
||||||
|
<INCLUDE>gst/video/video-scaler.h</INCLUDE>
|
||||||
|
GstVideoScaler
|
||||||
|
GstVideoScalerFlags
|
||||||
|
gst_video_scaler_2d
|
||||||
|
gst_video_scaler_combine_packed_YUV
|
||||||
|
gst_video_scaler_free
|
||||||
|
gst_video_scaler_get_coeff
|
||||||
|
gst_video_scaler_horizontal
|
||||||
|
gst_video_scaler_new
|
||||||
|
gst_video_scaler_vertical
|
||||||
|
<SUBSECTION Standard>
|
||||||
|
</SECTION>
|
||||||
|
|
||||||
<SECTION>
|
<SECTION>
|
||||||
<FILE>gstvideoutils</FILE>
|
<FILE>gstvideoutils</FILE>
|
||||||
GstVideoCodecFrame
|
GstVideoCodecFrame
|
||||||
|
|
|
@ -645,7 +645,7 @@ gst_video_region_of_interest_meta_get_info (void)
|
||||||
* Buffers can contain multiple #GstVideoRegionOfInterestMeta metadata items if
|
* Buffers can contain multiple #GstVideoRegionOfInterestMeta metadata items if
|
||||||
* multiple regions of interests are marked on a frame.
|
* multiple regions of interests are marked on a frame.
|
||||||
*
|
*
|
||||||
* Returns: the #GstVideoeRegionOfInterestMeta with @id or %NULL when there is
|
* Returns: the #GstVideoRegionOfInterestMeta with @id or %NULL when there is
|
||||||
* no such metadata on @buffer.
|
* no such metadata on @buffer.
|
||||||
*/
|
*/
|
||||||
GstVideoRegionOfInterestMeta *
|
GstVideoRegionOfInterestMeta *
|
||||||
|
|
|
@ -27,6 +27,18 @@
|
||||||
#include "video-orc.h"
|
#include "video-orc.h"
|
||||||
#include "video-format.h"
|
#include "video-format.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* SECTION:gstvideochroma
|
||||||
|
* @short_description: Functions and utility object for operating on chroma video planes
|
||||||
|
*
|
||||||
|
* The functions gst_video_chroma_from_string() and gst_video_chroma_to_string() convert
|
||||||
|
* between #GstVideoChromaSite and string descriptions.
|
||||||
|
*
|
||||||
|
* #GstVideoChromaResample is a utility object for resampling chroma planes
|
||||||
|
* and converting between different chroma sampling sitings.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
typedef struct
|
typedef struct
|
||||||
{
|
{
|
||||||
const gchar *name;
|
const gchar *name;
|
||||||
|
|
|
@ -2312,7 +2312,7 @@ gst_video_converter_set_config (GstVideoConverter * convert,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* gst_video_converter_get_config:
|
* gst_video_converter_get_config:
|
||||||
* @@convert: a #GstVideoConverter
|
* @convert: a #GstVideoConverter
|
||||||
*
|
*
|
||||||
* Get the current configuration of @convert.
|
* Get the current configuration of @convert.
|
||||||
*
|
*
|
||||||
|
|
|
@ -22,6 +22,14 @@
|
||||||
#include "video-dither.h"
|
#include "video-dither.h"
|
||||||
#include "video-orc.h"
|
#include "video-orc.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* SECTION:gstvideodither
|
||||||
|
* @short_description: Utility object for dithering and quantizing lines of video
|
||||||
|
*
|
||||||
|
* GstVideoDither provides implementations of several dithering algorithms
|
||||||
|
* that can be applied to lines of video pixels to quantize and dither them.
|
||||||
|
*
|
||||||
|
*/
|
||||||
struct _GstVideoDither
|
struct _GstVideoDither
|
||||||
{
|
{
|
||||||
GstVideoDitherMethod method;
|
GstVideoDitherMethod method;
|
||||||
|
|
|
@ -27,6 +27,14 @@
|
||||||
|
|
||||||
#include "video-resampler.h"
|
#include "video-resampler.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* SECTION:gstvideoresampler
|
||||||
|
* @short_description: Utility structure for resampler information
|
||||||
|
*
|
||||||
|
* #GstVideoResampler is a structure which holds the information
|
||||||
|
* required to perform various kinds of resampling filtering.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
#define DEFAULT_OPT_CUBIC_B (1.0 / 3.0)
|
#define DEFAULT_OPT_CUBIC_B (1.0 / 3.0)
|
||||||
#define DEFAULT_OPT_CUBIC_C (1.0 / 3.0)
|
#define DEFAULT_OPT_CUBIC_C (1.0 / 3.0)
|
||||||
|
|
|
@ -151,6 +151,7 @@ struct _GstVideoResampler
|
||||||
guint32 *n_taps;
|
guint32 *n_taps;
|
||||||
gdouble *taps;
|
gdouble *taps;
|
||||||
|
|
||||||
|
/*< private >*/
|
||||||
gpointer _gst_reserved[GST_PADDING];
|
gpointer _gst_reserved[GST_PADDING];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
@ -25,6 +25,15 @@
|
||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
#include <math.h>
|
#include <math.h>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* SECTION:gstvideoscaler
|
||||||
|
* @short_description: Utility object for rescaling video frames
|
||||||
|
*
|
||||||
|
* #GstVideoScaler is a utility object for rescaling and resampling
|
||||||
|
* video frames using various interpolation / sampling methods.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
#ifndef DISABLE_ORC
|
#ifndef DISABLE_ORC
|
||||||
#include <orc/orcfunctions.h>
|
#include <orc/orcfunctions.h>
|
||||||
#else
|
#else
|
||||||
|
|
|
@ -48,7 +48,6 @@ GST_DEBUG_CATEGORY_EXTERN (video_scale_debug);
|
||||||
* @GST_VIDEO_SCALE_BILINEAR: use 2-tap bilinear scaling (slower but prettier).
|
* @GST_VIDEO_SCALE_BILINEAR: use 2-tap bilinear scaling (slower but prettier).
|
||||||
* @GST_VIDEO_SCALE_4TAP: use a 4-tap sinc filter for scaling (slow).
|
* @GST_VIDEO_SCALE_4TAP: use a 4-tap sinc filter for scaling (slow).
|
||||||
* @GST_VIDEO_SCALE_LANCZOS: use a multitap Lanczos filter for scaling (slow).
|
* @GST_VIDEO_SCALE_LANCZOS: use a multitap Lanczos filter for scaling (slow).
|
||||||
*
|
|
||||||
* @GST_VIDEO_SCALE_BILINEAR2: use a multitap bilinear filter
|
* @GST_VIDEO_SCALE_BILINEAR2: use a multitap bilinear filter
|
||||||
* @GST_VIDEO_SCALE_SINC: use a multitap sinc filter
|
* @GST_VIDEO_SCALE_SINC: use a multitap sinc filter
|
||||||
* @GST_VIDEO_SCALE_HERMITE: use a multitap bicubic Hermite filter
|
* @GST_VIDEO_SCALE_HERMITE: use a multitap bicubic Hermite filter
|
||||||
|
|
Loading…
Reference in a new issue