diff options
author | Jan Schmidt <jan@centricular.com> | 2015-03-13 01:06:57 +1100 |
---|---|---|
committer | Jan Schmidt <jan@centricular.com> | 2015-03-13 01:08:25 +1100 |
commit | 3d60fb654bbcb45214c6bfdd99ef078630e26bde (patch) | |
tree | efb8f382a65d4682439f9d545caf53da18437244 | |
parent | 8093e3ba948d3bafb6687ef68e202ca04b8ad254 (diff) |
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
-rw-r--r-- | docs/libs/gst-plugins-base-libs-docs.sgml | 4 | ||||
-rw-r--r-- | docs/libs/gst-plugins-base-libs-sections.txt | 87 | ||||
-rw-r--r-- | gst-libs/gst/video/gstvideometa.c | 2 | ||||
-rw-r--r-- | gst-libs/gst/video/video-chroma.c | 12 | ||||
-rw-r--r-- | gst-libs/gst/video/video-converter.c | 2 | ||||
-rw-r--r-- | gst-libs/gst/video/video-dither.c | 8 | ||||
-rw-r--r-- | gst-libs/gst/video/video-resampler.c | 8 | ||||
-rw-r--r-- | gst-libs/gst/video/video-resampler.h | 1 | ||||
-rw-r--r-- | gst-libs/gst/video/video-scaler.c | 9 | ||||
-rw-r--r-- | gst/videoscale/gstvideoscale.h | 1 |
10 files changed, 120 insertions, 14 deletions
diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml index 3da30ad7a..865ee293e 100644 --- a/docs/libs/gst-plugins-base-libs-docs.sgml +++ b/docs/libs/gst-plugins-base-libs-docs.sgml @@ -198,6 +198,10 @@ <xi:include href="xml/gstvideometa.xml" /> <xi:include href="xml/gstvideooverlaycomposition.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/gstcolorbalance.xml" /> <xi:include href="xml/gstcolorbalancechannel.xml" /> diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt index 8b5058953..82a351fda 100644 --- a/docs/libs/gst-plugins-base-libs-sections.txt +++ b/docs/libs/gst-plugins-base-libs-sections.txt @@ -2241,9 +2241,6 @@ GstVideoFormat GST_VIDEO_MAX_PLANES GST_VIDEO_MAX_COMPONENTS GstVideoFormatInfo -GstVideoChromaSite -gst_video_chroma_from_string -gst_video_chroma_to_string GstVideoFormatFlags GstVideoPackFlags GstVideoFormatUnpack @@ -2427,6 +2424,7 @@ gst_video_blend_scale_linear_RGBA #video-converter.h <SUBSECTION> +GstVideoConverter gst_video_converter_new gst_video_converter_free 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> <SUBSECTION composition> GstVideoOverlayComposition -GstVideoOverlayCompositionClass gst_video_overlay_composition_new gst_video_overlay_composition_ref gst_video_overlay_composition_unref @@ -2542,7 +2539,6 @@ gst_buffer_remove_video_overlay_composition_meta <SUBSECTION rectangle> GstVideoOverlayFormatFlags GstVideoOverlayRectangle -GstVideoOverlayRectangleClass gst_video_overlay_rectangle_new_raw gst_video_overlay_rectangle_ref gst_video_overlay_rectangle_unref @@ -2562,10 +2558,7 @@ gst_video_overlay_rectangle_set_global_alpha <SUBSECTION Standard> GST_TYPE_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_VIDEO_OVERLAY_COMPOSITION_CLASS GST_VIDEO_OVERLAY_COMPOSITION_CAST GST_VIDEO_OVERLAY_COMPOSITION_META_API_TYPE GST_VIDEO_OVERLAY_COMPOSITION_META_INFO @@ -2574,10 +2567,7 @@ gst_video_overlay_composition_meta_api_get_type GST_TYPE_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_VIDEO_OVERLAY_RECTANGLE_CLASS gst_video_overlay_rectangle_get_type </SECTION> @@ -2718,6 +2708,81 @@ gst_video_encoder_get_type </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> <FILE>gstvideoutils</FILE> GstVideoCodecFrame GstVideoCodecFrameFlags diff --git a/gst-libs/gst/video/gstvideometa.c b/gst-libs/gst/video/gstvideometa.c index a5cd8bded..14fca21e9 100644 --- a/gst-libs/gst/video/gstvideometa.c +++ b/gst-libs/gst/video/gstvideometa.c @@ -645,7 +645,7 @@ gst_video_region_of_interest_meta_get_info (void) * Buffers can contain multiple #GstVideoRegionOfInterestMeta metadata items if * 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. */ GstVideoRegionOfInterestMeta * diff --git a/gst-libs/gst/video/video-chroma.c b/gst-libs/gst/video/video-chroma.c index 0330f4afd..d0b4407b1 100644 --- a/gst-libs/gst/video/video-chroma.c +++ b/gst-libs/gst/video/video-chroma.c @@ -27,6 +27,18 @@ #include "video-orc.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 { const gchar *name; diff --git a/gst-libs/gst/video/video-converter.c b/gst-libs/gst/video/video-converter.c index 9f123061a..437c3c6db 100644 --- a/gst-libs/gst/video/video-converter.c +++ b/gst-libs/gst/video/video-converter.c @@ -2312,7 +2312,7 @@ gst_video_converter_set_config (GstVideoConverter * convert, /** * gst_video_converter_get_config: - * @@convert: a #GstVideoConverter + * @convert: a #GstVideoConverter * * Get the current configuration of @convert. * diff --git a/gst-libs/gst/video/video-dither.c b/gst-libs/gst/video/video-dither.c index 854f9bc6f..64e0f9fbe 100644 --- a/gst-libs/gst/video/video-dither.c +++ b/gst-libs/gst/video/video-dither.c @@ -22,6 +22,14 @@ #include "video-dither.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 { GstVideoDitherMethod method; diff --git a/gst-libs/gst/video/video-resampler.c b/gst-libs/gst/video/video-resampler.c index ccad73c0e..3024e544b 100644 --- a/gst-libs/gst/video/video-resampler.c +++ b/gst-libs/gst/video/video-resampler.c @@ -27,6 +27,14 @@ #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_C (1.0 / 3.0) diff --git a/gst-libs/gst/video/video-resampler.h b/gst-libs/gst/video/video-resampler.h index 13331b10b..d0c18cc1b 100644 --- a/gst-libs/gst/video/video-resampler.h +++ b/gst-libs/gst/video/video-resampler.h @@ -151,6 +151,7 @@ struct _GstVideoResampler guint32 *n_taps; gdouble *taps; + /*< private >*/ gpointer _gst_reserved[GST_PADDING]; }; diff --git a/gst-libs/gst/video/video-scaler.c b/gst-libs/gst/video/video-scaler.c index 7a94412b8..b637775df 100644 --- a/gst-libs/gst/video/video-scaler.c +++ b/gst-libs/gst/video/video-scaler.c @@ -25,6 +25,15 @@ #include <stdio.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 #include <orc/orcfunctions.h> #else diff --git a/gst/videoscale/gstvideoscale.h b/gst/videoscale/gstvideoscale.h index e459eda62..297ceed85 100644 --- a/gst/videoscale/gstvideoscale.h +++ b/gst/videoscale/gstvideoscale.h @@ -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_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_BILINEAR2: use a multitap bilinear filter * @GST_VIDEO_SCALE_SINC: use a multitap sinc filter * @GST_VIDEO_SCALE_HERMITE: use a multitap bicubic Hermite filter |