mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-19 14:56:36 +00:00
ae429de8f6
We need different export decorators for the different libs. For now no actual change though, just rename before the release, and add prelude headers to define the new decorator to GST_EXPORT.
317 lines
13 KiB
C
317 lines
13 KiB
C
/* GStreamer Video Overlay Composition
|
|
* Copyright (C) 2011 Intel Corporation
|
|
* Copyright (C) 2011 Collabora Ltd.
|
|
* Copyright (C) 2011 Tim-Philipp Müller <tim centricular net>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef __GST_VIDEO_OVERLAY_COMPOSITION_H__
|
|
#define __GST_VIDEO_OVERLAY_COMPOSITION_H__
|
|
|
|
#include <gst/gst.h>
|
|
#include <gst/video/video.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/**
|
|
* GstVideoOverlayRectangle:
|
|
*
|
|
* An opaque video overlay rectangle object. A rectangle contains a single
|
|
* overlay rectangle which can be added to a composition.
|
|
*/
|
|
#define GST_TYPE_VIDEO_OVERLAY_RECTANGLE \
|
|
(gst_video_overlay_rectangle_get_type ())
|
|
#define GST_VIDEO_OVERLAY_RECTANGLE_CAST(obj) \
|
|
((GstVideoOverlayRectangle *)(obj))
|
|
#define GST_VIDEO_OVERLAY_RECTANGLE(obj) \
|
|
(GST_VIDEO_OVERLAY_RECTANGLE_CAST(obj))
|
|
#define GST_IS_VIDEO_OVERLAY_RECTANGLE(obj) \
|
|
(GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_VIDEO_OVERLAY_RECTANGLE))
|
|
|
|
typedef struct _GstVideoOverlayRectangle GstVideoOverlayRectangle;
|
|
|
|
/**
|
|
* gst_video_overlay_rectangle_ref:
|
|
* @comp: a a #GstVideoOverlayRectangle.
|
|
*
|
|
* Increases the refcount of the given rectangle by one.
|
|
*
|
|
* Note that the refcount affects the writeability
|
|
* of @comp, use gst_video_overlay_rectangle_copy() to ensure a rectangle can
|
|
* be modified (there is no gst_video_overlay_rectangle_make_writable() because
|
|
* it is unlikely that someone will hold the single reference to the rectangle
|
|
* and not know that that's the case).
|
|
*
|
|
* Returns: (transfer full): @comp
|
|
*/
|
|
static inline GstVideoOverlayRectangle *
|
|
gst_video_overlay_rectangle_ref (GstVideoOverlayRectangle * comp)
|
|
{
|
|
return (GstVideoOverlayRectangle *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (comp));
|
|
}
|
|
|
|
/**
|
|
* gst_video_overlay_rectangle_unref:
|
|
* @comp: (transfer full): a #GstVideoOverlayRectangle.
|
|
*
|
|
* Decreases the refcount of the rectangle. If the refcount reaches 0, the
|
|
* rectangle will be freed.
|
|
*/
|
|
static inline void
|
|
gst_video_overlay_rectangle_unref (GstVideoOverlayRectangle * comp)
|
|
{
|
|
gst_mini_object_unref (GST_MINI_OBJECT_CAST (comp));
|
|
}
|
|
|
|
/**
|
|
* GstVideoOverlayFormatFlags:
|
|
* @GST_VIDEO_OVERLAY_FORMAT_FLAG_NONE: no flags
|
|
* @GST_VIDEO_OVERLAY_FORMAT_FLAG_PREMULTIPLIED_ALPHA: RGB are premultiplied by A/255.
|
|
* @GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA: a global-alpha value != 1 is set.
|
|
*
|
|
* Overlay format flags.
|
|
*/
|
|
typedef enum {
|
|
GST_VIDEO_OVERLAY_FORMAT_FLAG_NONE = 0,
|
|
GST_VIDEO_OVERLAY_FORMAT_FLAG_PREMULTIPLIED_ALPHA = 1,
|
|
GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA = 2
|
|
} GstVideoOverlayFormatFlags;
|
|
|
|
#define GST_CAPS_FEATURE_META_GST_VIDEO_OVERLAY_COMPOSITION "meta:GstVideoOverlayComposition"
|
|
|
|
/**
|
|
* GST_VIDEO_OVERLAY_COMPOSITION_FORMAT_RGB:
|
|
*
|
|
* Supported RGB overlay video format.
|
|
*/
|
|
#if G_BYTE_ORDER == G_LITTLE_ENDIAN
|
|
#define GST_VIDEO_OVERLAY_COMPOSITION_FORMAT_RGB GST_VIDEO_FORMAT_BGRA
|
|
#else
|
|
#define GST_VIDEO_OVERLAY_COMPOSITION_FORMAT_RGB GST_VIDEO_FORMAT_ARGB
|
|
#endif
|
|
|
|
/**
|
|
* GST_VIDEO_OVERLAY_COMPOSITION_FORMAT_YUV:
|
|
*
|
|
* Supported YUV overlay video format.
|
|
*/
|
|
#define GST_VIDEO_OVERLAY_COMPOSITION_FORMAT_YUV GST_VIDEO_FORMAT_AYUV
|
|
|
|
/**
|
|
* GST_VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS:
|
|
*
|
|
* Video formats supported by gst_video_overlay_composition_blend(), for
|
|
* use in overlay elements' pad template caps.
|
|
*
|
|
* Since: 1.2
|
|
*/
|
|
#define GST_VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS \
|
|
"{ BGRx, RGBx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR," \
|
|
" I420, YV12, AYUV, YUY2, UYVY, v308, Y41B, Y42B, Y444," \
|
|
" NV12, NV21, A420, YUV9, YVU9, IYU1, GRAY8 }"
|
|
|
|
GST_VIDEO_API
|
|
GType gst_video_overlay_rectangle_get_type (void);
|
|
|
|
GST_VIDEO_API
|
|
GstVideoOverlayRectangle * gst_video_overlay_rectangle_new_raw (GstBuffer * pixels,
|
|
gint render_x, gint render_y,
|
|
guint render_width, guint render_height,
|
|
GstVideoOverlayFormatFlags flags);
|
|
|
|
GST_VIDEO_API
|
|
GstVideoOverlayRectangle * gst_video_overlay_rectangle_copy (GstVideoOverlayRectangle * rectangle);
|
|
|
|
GST_VIDEO_API
|
|
guint gst_video_overlay_rectangle_get_seqnum (GstVideoOverlayRectangle * rectangle);
|
|
|
|
GST_VIDEO_API
|
|
void gst_video_overlay_rectangle_set_render_rectangle (GstVideoOverlayRectangle * rectangle,
|
|
gint render_x,
|
|
gint render_y,
|
|
guint render_width,
|
|
guint render_height);
|
|
|
|
GST_VIDEO_API
|
|
gboolean gst_video_overlay_rectangle_get_render_rectangle (GstVideoOverlayRectangle * rectangle,
|
|
gint * render_x,
|
|
gint * render_y,
|
|
guint * render_width,
|
|
guint * render_height);
|
|
|
|
GST_VIDEO_API
|
|
GstBuffer * gst_video_overlay_rectangle_get_pixels_raw (GstVideoOverlayRectangle * rectangle,
|
|
GstVideoOverlayFormatFlags flags);
|
|
|
|
GST_VIDEO_API
|
|
GstBuffer * gst_video_overlay_rectangle_get_pixels_argb (GstVideoOverlayRectangle * rectangle,
|
|
GstVideoOverlayFormatFlags flags);
|
|
|
|
GST_VIDEO_API
|
|
GstBuffer * gst_video_overlay_rectangle_get_pixels_ayuv (GstVideoOverlayRectangle * rectangle,
|
|
GstVideoOverlayFormatFlags flags);
|
|
|
|
GST_VIDEO_API
|
|
GstBuffer * gst_video_overlay_rectangle_get_pixels_unscaled_raw (GstVideoOverlayRectangle * rectangle,
|
|
GstVideoOverlayFormatFlags flags);
|
|
|
|
GST_VIDEO_API
|
|
GstBuffer * gst_video_overlay_rectangle_get_pixels_unscaled_argb (GstVideoOverlayRectangle * rectangle,
|
|
GstVideoOverlayFormatFlags flags);
|
|
|
|
GST_VIDEO_API
|
|
GstBuffer * gst_video_overlay_rectangle_get_pixels_unscaled_ayuv (GstVideoOverlayRectangle * rectangle,
|
|
GstVideoOverlayFormatFlags flags);
|
|
|
|
GST_VIDEO_API
|
|
GstVideoOverlayFormatFlags gst_video_overlay_rectangle_get_flags (GstVideoOverlayRectangle * rectangle);
|
|
|
|
GST_VIDEO_API
|
|
gfloat gst_video_overlay_rectangle_get_global_alpha (GstVideoOverlayRectangle * rectangle);
|
|
|
|
GST_VIDEO_API
|
|
void gst_video_overlay_rectangle_set_global_alpha (GstVideoOverlayRectangle * rectangle,
|
|
gfloat global_alpha);
|
|
|
|
/**
|
|
* GstVideoOverlayComposition:
|
|
*
|
|
* An opaque video overlay composition object. A composition contains
|
|
* multiple overlay rectangles.
|
|
*/
|
|
#define GST_TYPE_VIDEO_OVERLAY_COMPOSITION \
|
|
(gst_video_overlay_composition_get_type ())
|
|
#define GST_VIDEO_OVERLAY_COMPOSITION_CAST(obj) \
|
|
((GstVideoOverlayComposition *)(obj))
|
|
#define GST_VIDEO_OVERLAY_COMPOSITION(obj) \
|
|
(GST_VIDEO_OVERLAY_COMPOSITION_CAST(obj))
|
|
#define GST_IS_VIDEO_OVERLAY_COMPOSITION(obj) \
|
|
(GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_VIDEO_OVERLAY_COMPOSITION))
|
|
|
|
typedef struct _GstVideoOverlayComposition GstVideoOverlayComposition;
|
|
|
|
/**
|
|
* gst_video_overlay_composition_ref:
|
|
* @comp: a a #GstVideoOverlayComposition.
|
|
*
|
|
* Increases the refcount of the given composition by one.
|
|
*
|
|
* Note that the refcount affects the writeability
|
|
* of @comp, use gst_video_overlay_composition_make_writable() to ensure
|
|
* a composition and its rectangles can be modified.
|
|
*
|
|
* Returns: (transfer full): @comp
|
|
*/
|
|
static inline GstVideoOverlayComposition *
|
|
gst_video_overlay_composition_ref (GstVideoOverlayComposition * comp)
|
|
{
|
|
return (GstVideoOverlayComposition *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (comp));
|
|
}
|
|
|
|
/**
|
|
* gst_video_overlay_composition_unref:
|
|
* @comp: (transfer full): a #GstVideoOverlayComposition.
|
|
*
|
|
* Decreases the refcount of the composition. If the refcount reaches 0, the
|
|
* composition will be freed.
|
|
*/
|
|
static inline void
|
|
gst_video_overlay_composition_unref (GstVideoOverlayComposition * comp)
|
|
{
|
|
gst_mini_object_unref (GST_MINI_OBJECT_CAST (comp));
|
|
}
|
|
|
|
GST_VIDEO_API
|
|
GType gst_video_overlay_composition_get_type (void);
|
|
|
|
GST_VIDEO_API
|
|
GstVideoOverlayComposition * gst_video_overlay_composition_copy (GstVideoOverlayComposition * comp);
|
|
|
|
GST_VIDEO_API
|
|
GstVideoOverlayComposition * gst_video_overlay_composition_make_writable (GstVideoOverlayComposition * comp);
|
|
|
|
GST_VIDEO_API
|
|
GstVideoOverlayComposition * gst_video_overlay_composition_new (GstVideoOverlayRectangle * rectangle);
|
|
|
|
GST_VIDEO_API
|
|
void gst_video_overlay_composition_add_rectangle (GstVideoOverlayComposition * comp,
|
|
GstVideoOverlayRectangle * rectangle);
|
|
|
|
GST_VIDEO_API
|
|
guint gst_video_overlay_composition_n_rectangles (GstVideoOverlayComposition * comp);
|
|
|
|
GST_VIDEO_API
|
|
GstVideoOverlayRectangle * gst_video_overlay_composition_get_rectangle (GstVideoOverlayComposition * comp, guint n);
|
|
|
|
GST_VIDEO_API
|
|
guint gst_video_overlay_composition_get_seqnum (GstVideoOverlayComposition * comp);
|
|
|
|
/* blend composition onto raw video buffer */
|
|
|
|
GST_VIDEO_API
|
|
gboolean gst_video_overlay_composition_blend (GstVideoOverlayComposition * comp,
|
|
GstVideoFrame * video_buf);
|
|
|
|
/* attach/retrieve composition from buffers */
|
|
|
|
#define GST_VIDEO_OVERLAY_COMPOSITION_META_API_TYPE \
|
|
(gst_video_overlay_composition_meta_api_get_type())
|
|
#define GST_VIDEO_OVERLAY_COMPOSITION_META_INFO \
|
|
(gst_video_overlay_composition_meta_get_info())
|
|
|
|
typedef struct _GstVideoOverlayCompositionMeta GstVideoOverlayCompositionMeta;
|
|
|
|
/**
|
|
* GstVideoOverlayCompositionMeta:
|
|
* @meta: parent #GstMeta
|
|
* @overlay: the attached #GstVideoOverlayComposition
|
|
*
|
|
* Extra buffer metadata describing image overlay data.
|
|
*/
|
|
struct _GstVideoOverlayCompositionMeta
|
|
{
|
|
GstMeta meta;
|
|
|
|
GstVideoOverlayComposition *overlay;
|
|
};
|
|
|
|
GST_VIDEO_API
|
|
GType gst_video_overlay_composition_meta_api_get_type (void);
|
|
|
|
GST_VIDEO_API
|
|
const GstMetaInfo *gst_video_overlay_composition_meta_get_info (void);
|
|
|
|
GST_VIDEO_API
|
|
GstVideoOverlayCompositionMeta * gst_buffer_add_video_overlay_composition_meta (GstBuffer * buf,
|
|
GstVideoOverlayComposition * comp);
|
|
|
|
#define gst_buffer_get_video_overlay_composition_meta(b) \
|
|
((GstVideoOverlayCompositionMeta*)gst_buffer_get_meta((b),GST_VIDEO_OVERLAY_COMPOSITION_META_API_TYPE))
|
|
#define gst_buffer_remove_video_overlay_composition_meta(b,m) \
|
|
gst_buffer_remove_meta((b),((GstMeta *) m))
|
|
|
|
#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
|
|
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstVideoOverlayComposition, gst_video_overlay_composition_unref)
|
|
#endif
|
|
|
|
#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
|
|
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstVideoOverlayRectangle, gst_video_overlay_rectangle_unref)
|
|
#endif
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GST_VIDEO_OVERLAY_COMPOSITION_H__ */
|