1/* GStreamer Video Overlay Interface
2 * Copyright (C) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
3 * Copyright (C) 2003 Julien Moutte <julien@moutte.net>
4 * Copyright (C) 2011 Tim-Philipp Müller <tim@centricular.net>
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
15 *
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
20 */
21
22#ifndef __GST_VIDEO_OVERLAY_H__
23#define __GST_VIDEO_OVERLAY_H__
24
25#include <gst/gst.h>
26#include <gst/video/gstvideosink.h>
27
28G_BEGIN_DECLS
29
30#define GST_TYPE_VIDEO_OVERLAY \
31 (gst_video_overlay_get_type ())
32#define GST_VIDEO_OVERLAY(obj) \
33 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_VIDEO_OVERLAY, GstVideoOverlay))
34#define GST_IS_VIDEO_OVERLAY(obj) \
35 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_VIDEO_OVERLAY))
36#define GST_VIDEO_OVERLAY_GET_INTERFACE(inst) \
37 (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GST_TYPE_VIDEO_OVERLAY, GstVideoOverlayInterface))
38
39/**
40 * GstVideoOverlay:
41 *
42 * Opaque #GstVideoOverlay interface structure
43 */
44typedef struct _GstVideoOverlay GstVideoOverlay;
45typedef struct _GstVideoOverlayInterface GstVideoOverlayInterface;
46
47/**
48 * GstVideoOverlayInterface:
49 * @iface: parent interface type.
50 * @expose: virtual method to handle expose events
51 * @handle_events: virtual method to handle events
52 * @set_render_rectangle: virtual method to set the render rectangle
53 * @set_window_handle: virtual method to configure the window handle
54 *
55 * #GstVideoOverlay interface
56 */
57struct _GstVideoOverlayInterface {
58 GTypeInterface iface;
59
60 /* virtual functions */
61 void (*expose) (GstVideoOverlay *overlay);
62
63 void (*handle_events) (GstVideoOverlay *overlay, gboolean handle_events);
64
65 void (*set_render_rectangle) (GstVideoOverlay *overlay,
66 gint x, gint y,
67 gint width, gint height);
68
69 void (*set_window_handle) (GstVideoOverlay *overlay, guintptr handle);
70};
71
72GST_VIDEO_API
73GType gst_video_overlay_get_type (void);
74
75/* virtual function wrappers */
76
77GST_VIDEO_API
78gboolean gst_video_overlay_set_render_rectangle (GstVideoOverlay * overlay,
79 gint x,
80 gint y,
81 gint width,
82 gint height);
83
84GST_VIDEO_API
85void gst_video_overlay_expose (GstVideoOverlay * overlay);
86
87GST_VIDEO_API
88void gst_video_overlay_handle_events (GstVideoOverlay * overlay,
89 gboolean handle_events);
90
91GST_VIDEO_API
92void gst_video_overlay_set_window_handle (GstVideoOverlay * overlay,
93 guintptr handle);
94
95/* public methods to dispatch bus messages */
96
97GST_VIDEO_API
98void gst_video_overlay_got_window_handle (GstVideoOverlay * overlay,
99 guintptr handle);
100
101GST_VIDEO_API
102void gst_video_overlay_prepare_window_handle (GstVideoOverlay * overlay);
103
104GST_VIDEO_API
105gboolean gst_is_video_overlay_prepare_window_handle_message (GstMessage * msg);
106
107GST_VIDEO_API
108void gst_video_overlay_install_properties (GObjectClass * oclass,
109 gint last_prop_id);
110
111GST_VIDEO_API
112gboolean gst_video_overlay_set_property (GObject * object,
113 gint last_prop_id,
114 guint property_id,
115 const GValue * value);
116
117G_END_DECLS
118
119#endif /* __GST_VIDEO_OVERLAY_H__ */
120

source code of include/gstreamer-1.0/gst/video/videooverlay.h