blob: 12420f700aebad12dab47f59505dfc3c53b7b6a9 [file] [log] [blame]
/* GStreamer Video Overlay Interface
* Copyright (C) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
* Copyright (C) 2003 Julien Moutte <julien@moutte.net>
* 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_H__
#define __GST_VIDEO_OVERLAY_H__
#include <gst/gst.h>
#include <gst/video/gstvideosink.h>
G_BEGIN_DECLS
#define GST_TYPE_VIDEO_OVERLAY \
(gst_video_overlay_get_type ())
#define GST_VIDEO_OVERLAY(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_VIDEO_OVERLAY, GstVideoOverlay))
#define GST_IS_VIDEO_OVERLAY(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_VIDEO_OVERLAY))
#define GST_VIDEO_OVERLAY_GET_INTERFACE(inst) \
(G_TYPE_INSTANCE_GET_INTERFACE ((inst), GST_TYPE_VIDEO_OVERLAY, GstVideoOverlayInterface))
/**
* GstVideoOverlay:
*
* Opaque #GstVideoOverlay interface structure
*/
typedef struct _GstVideoOverlay GstVideoOverlay;
typedef struct _GstVideoOverlayInterface GstVideoOverlayInterface;
typedef struct _GstVideoOverlayProperties GstVideoOverlayProperties;
/**
* GstVideoOverlayInterface:
* @iface: parent interface type.
* @expose: virtual method to handle expose events
* @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
*/
struct _GstVideoOverlayInterface {
GTypeInterface iface;
/* virtual functions */
void (*expose) (GstVideoOverlay *overlay);
void (*handle_events) (GstVideoOverlay *overlay, gboolean handle_events);
void (*set_render_rectangle) (GstVideoOverlay *overlay,
gint x, gint y,
gint width, gint height);
void (*set_window_handle) (GstVideoOverlay *overlay, guintptr handle);
};
GST_VIDEO_API
GType gst_video_overlay_get_type (void);
/* virtual function wrappers */
GST_VIDEO_API
gboolean gst_video_overlay_set_render_rectangle (GstVideoOverlay * overlay,
gint x,
gint y,
gint width,
gint height);
GST_VIDEO_API
void gst_video_overlay_expose (GstVideoOverlay * overlay);
GST_VIDEO_API
void gst_video_overlay_handle_events (GstVideoOverlay * overlay,
gboolean handle_events);
GST_VIDEO_API
void gst_video_overlay_set_window_handle (GstVideoOverlay * overlay,
guintptr handle);
/* public methods to dispatch bus messages */
GST_VIDEO_API
void gst_video_overlay_got_window_handle (GstVideoOverlay * overlay,
guintptr handle);
GST_VIDEO_API
void gst_video_overlay_prepare_window_handle (GstVideoOverlay * overlay);
GST_VIDEO_API
gboolean gst_is_video_overlay_prepare_window_handle_message (GstMessage * msg);
GST_VIDEO_API
void gst_video_overlay_install_properties (GObjectClass * oclass,
gint last_prop_id);
GST_VIDEO_API
gboolean gst_video_overlay_set_property (GObject * object,
gint last_prop_id,
guint property_id,
const GValue * value);
G_END_DECLS
#endif /* __GST_VIDEO_OVERLAY_H__ */