summaryrefslogtreecommitdiff
path: root/gst-libs/gst/xoverlay/xoverlay.c
blob: 2efe296660f24194f65104d5d3d4262501ba9176 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/* GStreamer X-based Overlay
 * Copyright (C) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
 *
 * tv-mixer.c: tv-mixer design virtual class function wrappers
 *
 * 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., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "xoverlay.h"

enum {
  HAVE_XWINDOW_ID,
  DESIRED_SIZE,
  LAST_SIGNAL
};

static guint gst_x_overlay_signals[LAST_SIGNAL] = { 0 };

static void gst_x_overlay_base_init (gpointer g_class);

GType
gst_x_overlay_get_type (void)
{
  static GType gst_x_overlay_type = 0;

  if (!gst_x_overlay_type) {
    static const GTypeInfo gst_x_overlay_info = {
      sizeof (GstXOverlayClass),
      gst_x_overlay_base_init,
      NULL,
      NULL,
      NULL,
      NULL,
      0,
      0,
      NULL,
    };

    gst_x_overlay_type = g_type_register_static (G_TYPE_INTERFACE,
						 "GstXOverlay",
						 &gst_x_overlay_info, 0);
    g_type_interface_add_prerequisite (gst_x_overlay_type,
				       GST_TYPE_IMPLEMENTS_INTERFACE);
  }

  return gst_x_overlay_type;
}

/* FIXME: evil hack, we should figure out our marshal handling in this interfaces some day */
extern void gst_marshal_VOID__INT_INT (GClosure *closure, GValue *return_value, guint n_param_values,
    const GValue *param_values, gpointer invocation_hint, gpointer marshal_data);

static void
gst_x_overlay_base_init (gpointer g_class)
{
  GstXOverlayClass *overlay_class = (GstXOverlayClass *) g_class;
  static gboolean initialized = FALSE;
  
  if (! initialized)
    {
      gst_x_overlay_signals[HAVE_XWINDOW_ID] =
        g_signal_new ("have_xwindow_id",
                      GST_TYPE_X_OVERLAY, G_SIGNAL_RUN_LAST,
                      G_STRUCT_OFFSET (GstXOverlayClass, have_xwindow_id),
                      NULL, NULL,
                      g_cclosure_marshal_VOID__INT, G_TYPE_NONE, 1,
		      G_TYPE_INT);
      gst_x_overlay_signals[DESIRED_SIZE] =
        g_signal_new ("desired_size_changed",
                      GST_TYPE_X_OVERLAY, G_SIGNAL_RUN_LAST,
                      G_STRUCT_OFFSET (GstXOverlayClass, desired_size),
                      NULL, NULL,
                      gst_marshal_VOID__INT_INT, G_TYPE_NONE, 2,
		      G_TYPE_INT, G_TYPE_INT);
      
      initialized = TRUE;
    }

  overlay_class->set_xwindow_id = NULL;
}

/**
 * gst_x_overlay_set_xwindow_id:
 * @overlay: a #GstXOverlay to set the XWindow on.
 * @xwindow_id: a #XID referencing the XWindow.
 *
 * This will call the video overlay's set_xwindow_id method. You should
 * use this method to tell to a XOverlay to display video output to a
 * specific XWindow. Passing 0 as the xwindow_id will tell the overlay to
 * stop using that window and create an internal one.
 */
void
gst_x_overlay_set_xwindow_id (GstXOverlay *overlay, XID xwindow_id)
{
  GstXOverlayClass *klass = GST_X_OVERLAY_GET_CLASS (overlay);

  if (klass->set_xwindow_id) {
    klass->set_xwindow_id (overlay, xwindow_id);
  }
}

/**
 * gst_x_overlay_got_xwindow_id:
 * @overlay: a #GstXOverlay which got a XWindow.
 * @xwindow_id: a #XID referencing the XWindow.
 *
 * This will fire an have_xwindow_id signal.
 *
 * This function should be used by video overlay developpers.
 */
void
gst_x_overlay_got_xwindow_id (GstXOverlay *overlay, XID xwindow_id)
{
  g_return_if_fail (overlay != NULL);
  g_return_if_fail (GST_IS_X_OVERLAY (overlay));
  
  g_signal_emit (G_OBJECT (overlay),
                 gst_x_overlay_signals[HAVE_XWINDOW_ID], 0, (gint) xwindow_id);
}

/**
 * gst_x_overlay_get_desired_size:
 * @overlay: a #GstXOverlay which got a XWindow.
 * @width: pointer to a gint taking the width or NULL.
 * @height: pointer to a gint taking the height or NULL.
 *
 * Gets the desired size of the overlay. If the overlay doesn't know its desired
 * size, width and height are set to 0.
 */
void
gst_x_overlay_get_desired_size (GstXOverlay *overlay, guint *width, guint *height)
{
  guint width_tmp, height_tmp;
  GstXOverlayClass *klass;
  
  g_return_if_fail (G_TYPE_CHECK_INSTANCE_TYPE ((overlay), GST_TYPE_X_OVERLAY));
  
  klass = GST_X_OVERLAY_GET_CLASS (overlay);
  if (klass->get_desired_size && GST_IS_X_OVERLAY (overlay)) {
    /* this ensures that elements don't need to check width and height for NULL 
       but apps may use NULL */
    klass->get_desired_size (overlay, width ? width : &width_tmp, height ? height : &height_tmp);
  } else {
    if (width)
      *width = 0;
    if (height)
      *height = 0;
  }
}

/**
 * gst_x_overlay_got_desired_size:
 * @overlay: a #GstXOverlay which changed its desired size.
 * @width: The new desired width
 * @height: The new desired height
 *
 * This will fire a "desired_size_changed" signal.
 *
 * This function should be used by video overlay developpers.
 */
void
gst_x_overlay_got_desired_size (GstXOverlay *overlay, guint width, guint height)
{
  g_return_if_fail (GST_IS_X_OVERLAY (overlay));
  
  g_signal_emit (G_OBJECT (overlay),
                 gst_x_overlay_signals[DESIRED_SIZE], 0, width, height);
}