gst-libs/gst/interfaces/colorbalance.c

   1 /* GStreamer Color Balance
   2  * Copyright (C) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
   3  *
   4  * colorbalance.c: image color balance interface design
   5  *                 virtual class function wrappers
   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 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26
  27 #include "colorbalance.h"
  28 #include "interfaces-marshal.h"
  29
  30 /**
  31  * SECTION:gstcolorbalance
  32  * @short_description: Interface for adjusting color balance settings
  33  *
  34  * <refsect2><para>
  35  * This interface is implemented by elements which can perform some color
  36  * balance operation on video frames they process. For example, modifying
  37  * the brightness, contrast, hue or saturation.
  38  * </para><para>
  39  * Example elements are 'xvimagesink' and 'colorbalance'
  40  * </para>
  41  * </refsect2>
  42  */
  43
  44 /* FIXME 0.11: check if we need to add API for sometimes-supportedness
  45  * (aka making up for GstImplementsInterface removal) */
  46
  47 /* FIXME 0.11: replace signals with messages (+ make API thread-safe) */
  48
  49 enum
  50 {
  51   VALUE_CHANGED,
  52   LAST_SIGNAL
  53 };
  54
  55 static void gst_color_balance_class_init (GstColorBalanceClass * klass);
  56
  57 static guint gst_color_balance_signals[LAST_SIGNAL] = { 0 };
  58
  59 GType
  60 gst_color_balance_get_type (void)
  61 {
  62   static GType gst_color_balance_type = 0;
  63
  64   if (!gst_color_balance_type) {
  65     static const GTypeInfo gst_color_balance_info = {
  66       sizeof (GstColorBalanceClass),
  67       (GBaseInitFunc) gst_color_balance_class_init,
  68       NULL,
  69       NULL,
  70       NULL,
  71       NULL,
  72       0,
  73       0,
  74       NULL,
  75     };
  76
  77     gst_color_balance_type = g_type_register_static (G_TYPE_INTERFACE,
  78         "GstColorBalance", &gst_color_balance_info, 0);
  79   }
  80
  81   return gst_color_balance_type;
  82 }
  83
  84 static void
  85 gst_color_balance_class_init (GstColorBalanceClass * klass)
  86 {
  87   static gboolean initialized = FALSE;
  88
  89   if (!initialized) {
  90     /**
  91      * GstColorBalance::value-changed:
  92      * @colorbalance: The GstColorBalance instance
  93      * @channel: The #GstColorBalanceChannel
  94      * @value: The new value
  95      *
  96      * Fired when the value of the indicated channel has changed.
  97      */
  98     gst_color_balance_signals[VALUE_CHANGED] =
  99         g_signal_new ("value-changed",
 100         GST_TYPE_COLOR_BALANCE, G_SIGNAL_RUN_LAST,
 101         G_STRUCT_OFFSET (GstColorBalanceClass, value_changed),
 102         NULL, NULL,
 103         gst_interfaces_marshal_VOID__OBJECT_INT,
 104         G_TYPE_NONE, 2, GST_TYPE_COLOR_BALANCE_CHANNEL, G_TYPE_INT);
 105
 106     initialized = TRUE;
 107   }
 108
 109   klass->balance_type = GST_COLOR_BALANCE_SOFTWARE;
 110
 111   /* default virtual functions */
 112   klass->list_channels = NULL;
 113   klass->set_value = NULL;
 114   klass->get_value = NULL;
 115 }
 116
 117 /**
 118  * gst_color_balance_list_channels:
 119  * @balance: A #GstColorBalance instance
 120  *
 121  * Retrieve a list of the available channels.
 122  *
 123  * Returns: A GList containing pointers to #GstColorBalanceChannel objects.
 124  *          The list is owned by the #GstColorBalance instance and must not
 125  *          be freed.
 126  */
 127 const GList *
 128 gst_color_balance_list_channels (GstColorBalance * balance)
 129 {
 130   GstColorBalanceClass *klass = GST_COLOR_BALANCE_GET_CLASS (balance);
 131
 132   if (klass->list_channels) {
 133     return klass->list_channels (balance);
 134   }
 135
 136   return NULL;
 137 }
 138
 139 /**
 140  * gst_color_balance_set_value:
 141  * @balance: A #GstColorBalance instance
 142  * @channel: A #GstColorBalanceChannel instance
 143  * @value: The new value for the channel.
 144  *
 145  * Sets the current value of the channel to the passed value, which must
 146  * be between min_value and max_value.
 147  *
 148  * See Also: The #GstColorBalanceChannel.min_value and
 149  *         #GstColorBalanceChannel.max_value members of the
 150  *         #GstColorBalanceChannel object.
 151  */
 152 void
 153 gst_color_balance_set_value (GstColorBalance * balance,
 154     GstColorBalanceChannel * channel, gint value)
 155 {
 156   GstColorBalanceClass *klass = GST_COLOR_BALANCE_GET_CLASS (balance);
 157
 158   if (klass->set_value) {
 159     klass->set_value (balance, channel, value);
 160   }
 161 }
 162
 163 /**
 164  * gst_color_balance_get_value:
 165  * @balance: A #GstColorBalance instance
 166  * @channel: A #GstColorBalanceChannel instance
 167  *
 168  * Retrieve the current value of the indicated channel, between min_value
 169  * and max_value.
 170  *
 171  * See Also: The #GstColorBalanceChannel.min_value and
 172  *         #GstColorBalanceChannel.max_value members of the
 173  *         #GstColorBalanceChannel object.
 174  *
 175  * Returns: The current value of the channel.
 176  */
 177 gint
 178 gst_color_balance_get_value (GstColorBalance * balance,
 179     GstColorBalanceChannel * channel)
 180 {
 181   GstColorBalanceClass *klass = GST_COLOR_BALANCE_GET_CLASS (balance);
 182
 183   if (klass->get_value) {
 184     return klass->get_value (balance, channel);
 185   }
 186
 187   return channel->min_value;
 188 }
 189
 190 /**
 191  * gst_color_balance_get_balance_type:
 192  * @balance: The #GstColorBalance implementation
 193  *
 194  * Get the #GstColorBalanceType of this implementation.
 195  *
 196  * Returns: A the #GstColorBalanceType.
 197  *
 198  * Since: 0.10.24
 199  */
 200 GstColorBalanceType
 201 gst_color_balance_get_balance_type (GstColorBalance * balance)
 202 {
 203   GstColorBalanceClass *klass = GST_COLOR_BALANCE_GET_CLASS (balance);
 204
 205   return klass->balance_type;
 206 }
 207
 208 /**
 209  * gst_color_balance_value_changed:
 210  * @balance: A #GstColorBalance instance
 211  * @channel: A #GstColorBalanceChannel whose value has changed
 212  * @value: The new value of the channel
 213  *
 214  * A helper function called by implementations of the GstColorBalance
 215  * interface. It fires the #GstColorBalance::value-changed signal on the
 216  * instance, and the #GstColorBalanceChannel::value-changed signal on the
 217  * channel object.
 218  */
 219 void
 220 gst_color_balance_value_changed (GstColorBalance * balance,
 221     GstColorBalanceChannel * channel, gint value)
 222 {
 223   g_signal_emit (G_OBJECT (balance),
 224       gst_color_balance_signals[VALUE_CHANGED], 0, channel, value);
 225
 226   g_signal_emit_by_name (G_OBJECT (channel), "value_changed", value);
 227 }