gst-libs/gst/video/videoorientation.h

   1 /* GStreamer
   2  * Copyright (C) 2006 Nokia <stefan.kost@nokia.com
   3  *
   4  * videoorientation.h: video flipping and centering interface
   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_ORIENTATION_H__
  23 #define __GST_VIDEO_ORIENTATION_H__
  24
  25 #include <gst/gst.h>
  26
  27 G_BEGIN_DECLS
  28
  29 #define GST_TYPE_VIDEO_ORIENTATION \
  30   (gst_video_orientation_get_type ())
  31 #define GST_VIDEO_ORIENTATION(obj) \
  32   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_VIDEO_ORIENTATION, GstVideoOrientation))
  33 #define GST_IS_VIDEO_ORIENTATION(obj) \
  34   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_VIDEO_ORIENTATION))
  35 #define GST_VIDEO_ORIENTATION_GET_INTERFACE(inst) \
  36   (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GST_TYPE_VIDEO_ORIENTATION, GstVideoOrientationInterface))
  37
  38 /**
  39  * GstVideoOrientation:
  40  *
  41  * Opaque #GstVideoOrientation data structure.
  42  */
  43 typedef struct _GstVideoOrientation GstVideoOrientation;
  44 typedef struct _GstVideoOrientationInterface GstVideoOrientationInterface;
  45
  46 /**
  47  * GstVideoOrientationInterface:
  48  * @iface: parent interface type.
  49  * @get_hflip: virtual method to get horizontal flipping state
  50  * @get_vflip: virtual method to get vertical flipping state
  51  * @get_hcenter: virtual method to get horizontal centering state
  52  * @get_vcenter: virtual method to get vertical centering state
  53  * @set_hflip: virtual method to set horizontal flipping state
  54  * @set_vflip: virtual method to set vertical flipping state
  55  * @set_hcenter: virtual method to set horizontal centering state
  56  * @set_vcenter: virtual method to set vertical centering state
  57  *
  58  * #GstVideoOrientationInterface interface.
  59  */
  60 struct _GstVideoOrientationInterface {
  61   GTypeInterface iface;
  62
  63   /* FIXME 0.11: fix awkward API? add some kind of get_supported flags thing
  64    * and then just return booleans/int from all vfuncs requiring the caller
  65    * to check the flags first */
  66
  67   /* virtual functions */
  68   gboolean (* get_hflip)   (GstVideoOrientation *video_orientation, gboolean *flip);
  69   gboolean (* get_vflip)   (GstVideoOrientation *video_orientation, gboolean *flip);
  70   gboolean (* get_hcenter) (GstVideoOrientation *video_orientation, gint *center);
  71   gboolean (* get_vcenter) (GstVideoOrientation *video_orientation, gint *center);
  72
  73   gboolean (* set_hflip)   (GstVideoOrientation *video_orientation, gboolean flip);
  74   gboolean (* set_vflip)   (GstVideoOrientation *video_orientation, gboolean flip);
  75   gboolean (* set_hcenter) (GstVideoOrientation *video_orientation, gint center);
  76   gboolean (* set_vcenter) (GstVideoOrientation *video_orientation, gint center);
  77 };
  78
  79 GST_EXPORT
  80 GType           gst_video_orientation_get_type              (void);
  81
  82 /* virtual class function wrappers */
  83
  84 GST_EXPORT
  85 gboolean gst_video_orientation_get_hflip (GstVideoOrientation *video_orientation, gboolean *flip);
  86
  87 GST_EXPORT
  88 gboolean gst_video_orientation_get_vflip (GstVideoOrientation *video_orientation, gboolean *flip);
  89
  90 GST_EXPORT
  91 gboolean gst_video_orientation_get_hcenter (GstVideoOrientation *video_orientation, gint *center);
  92
  93 GST_EXPORT
  94 gboolean gst_video_orientation_get_vcenter (GstVideoOrientation *video_orientation, gint *center);
  95
  96 GST_EXPORT
  97 gboolean gst_video_orientation_set_hflip (GstVideoOrientation *video_orientation, gboolean flip);
  98
  99 GST_EXPORT
 100 gboolean gst_video_orientation_set_vflip (GstVideoOrientation *video_orientation, gboolean flip);
 101
 102 GST_EXPORT
 103 gboolean gst_video_orientation_set_hcenter (GstVideoOrientation *video_orientation, gint center);
 104
 105 GST_EXPORT
 106 gboolean gst_video_orientation_set_vcenter (GstVideoOrientation *video_orientation, gint center);
 107
 108 G_END_DECLS
 109
 110 #endif /* __GST_VIDEO_ORIENTATION_H__ */