gst-libs/gst/interfaces/xoverlay.h

   1 /* GStreamer X-based Overlay
   2  * Copyright (C) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
   3  * Copyright (C) 2003 Julien Moutte <julien@moutte.net>
   4  *
   5  * x-overlay.h: X-based overlay interface design
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifndef __GST_X_OVERLAY_H__
  24 #define __GST_X_OVERLAY_H__
  25
  26 #include <gst/gst.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define GST_TYPE_X_OVERLAY \
  31   (gst_x_overlay_get_type ())
  32 #define GST_X_OVERLAY(obj) \
  33   (GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_X_OVERLAY, \
  34                                                  GstXOverlay))
  35 #define GST_X_OVERLAY_CLASS(klass) \
  36   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_X_OVERLAY, GstXOverlayClass))
  37 #define GST_IS_X_OVERLAY(obj) \
  38   (GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_X_OVERLAY))
  39 #define GST_IS_X_OVERLAY_CLASS(klass) \
  40   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_X_OVERLAY))
  41 #define GST_X_OVERLAY_GET_CLASS(inst) \
  42   (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GST_TYPE_X_OVERLAY, GstXOverlayClass))
  43
  44 typedef struct _GstXOverlay GstXOverlay;
  45
  46 typedef struct _GstXOverlayClass {
  47   GTypeInterface klass;
  48
  49   /* virtual functions */
  50   void (* set_xwindow_id) (GstXOverlay *overlay,
  51                            gulong       xwindow_id);
  52
  53   void (* expose)         (GstXOverlay *overlay);
  54
  55   /*< private >*/
  56   gpointer                 _gst_reserved[GST_PADDING];
  57 } GstXOverlayClass;
  58
  59 GType   gst_x_overlay_get_type          (void);
  60
  61 /* virtual class function wrappers */
  62 void gst_x_overlay_set_xwindow_id     (GstXOverlay *overlay, gulong xwindow_id);
  63
  64 void gst_x_overlay_expose             (GstXOverlay *overlay);
  65
  66 /* public methods to dispatch bus messages */
  67 void gst_x_overlay_got_xwindow_id     (GstXOverlay *overlay, gulong xwindow_id);
  68
  69 void gst_x_overlay_prepare_xwindow_id (GstXOverlay *overlay);
  70
  71 G_END_DECLS
  72
  73 #endif /* __GST_X_OVERLAY_H__ */