gst-libs/gst/interfaces/colorbalance.h

   1 /* GStreamer Color Balance
   2  * Copyright (C) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
   3  *
   4  * color-balance.h: image color balance interface design
   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., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 #ifndef __GST_COLOR_BALANCE_H__
  23 #define __GST_COLOR_BALANCE_H__
  24
  25 #include <gst/gst.h>
  26 #include <gst/interfaces/colorbalancechannel.h>
  27 #include <gst/interfaces/interfaces-enumtypes.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define GST_TYPE_COLOR_BALANCE \
  32   (gst_color_balance_get_type ())
  33 #define GST_COLOR_BALANCE(obj) \
  34   (GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_COLOR_BALANCE, \
  35                                                  GstColorBalance))
  36 #define GST_COLOR_BALANCE_CLASS(klass) \
  37   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_COLOR_BALANCE, \
  38                             GstColorBalanceClass))
  39 #define GST_IS_COLOR_BALANCE(obj) \
  40   (GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_COLOR_BALANCE))
  41 #define GST_IS_COLOR_BALANCE_CLASS(klass) \
  42   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_COLOR_BALANCE))
  43 #define GST_COLOR_BALANCE_GET_CLASS(inst) \
  44   (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GST_TYPE_COLOR_BALANCE, GstColorBalanceClass))
  45
  46 #define GST_COLOR_BALANCE_TYPE(klass) (klass->balance_type)
  47
  48 typedef struct _GstColorBalance GstColorBalance;
  49 typedef struct _GstColorBalanceClass GstColorBalanceClass;
  50
  51 /**
  52  * GstColorBalanceType:
  53  * @GST_COLOR_BALANCE_HARDWARE: Color balance is implemented with dedicated
  54  *         hardware.
  55  * @GST_COLOR_BALANCE_SOFTWARE: Color balance is implemented via software
  56  *         processing.
  57  *
  58  * An enumeration indicating whether an element implements color balancing
  59  * operations in software or in dedicated hardware. In general, dedicated
  60  * hardware implementations (such as those provided by xvimagesink) are
  61  * preferred.
  62  */
  63 typedef enum
  64 {
  65   GST_COLOR_BALANCE_HARDWARE,
  66   GST_COLOR_BALANCE_SOFTWARE
  67 } GstColorBalanceType;
  68
  69 struct _GstColorBalanceClass {
  70   GTypeInterface klass;
  71
  72   GstColorBalanceType balance_type;
  73
  74   /* virtual functions */
  75   const GList * (* list_channels) (GstColorBalance        *balance);
  76
  77   void          (* set_value)     (GstColorBalance        *balance,
  78                                    GstColorBalanceChannel *channel,
  79                                    gint                    value);
  80   gint          (* get_value)     (GstColorBalance        *balance,
  81                                    GstColorBalanceChannel *channel);
  82
  83   /* signals */
  84   void (* value_changed) (GstColorBalance        *balance,
  85                           GstColorBalanceChannel *channel,
  86                           gint                    value);
  87
  88   gpointer _gst_reserved[GST_PADDING];
  89 };
  90
  91 GType   gst_color_balance_get_type      (void);
  92
  93 /* virtual class function wrappers */
  94 const GList *
  95         gst_color_balance_list_channels (GstColorBalance        *balance);
  96 void    gst_color_balance_set_value     (GstColorBalance        *balance,
  97                                          GstColorBalanceChannel *channel,
  98                                          gint                    value);
  99 gint    gst_color_balance_get_value     (GstColorBalance        *balance,
 100                                          GstColorBalanceChannel *channel);
 101
 102 GstColorBalanceType
 103         gst_color_balance_get_balance_type (GstColorBalance        *balance);
 104
 105 /* trigger signal */
 106 void    gst_color_balance_value_changed (GstColorBalance        *balance,
 107                                          GstColorBalanceChannel *channel,
 108                                          gint                    value);
 109
 110 G_END_DECLS
 111
 112 #endif /* __GST_COLOR_BALANCE_H__ */