chromahold: Add chromahold color effect

This effect converts all colors except a single one to
grey. The color is selected by an RGB triple and a
tolerance for the color matching in hue degree can be specified.

gst/coloreffects/Makefile.am

@@ -2,15 +2,19 @@ plugin_LTLIBRARIES = libgstcoloreffects.la
 
 libgstcoloreffects_la_SOURCES = \
 	gstplugin.c \
-	gstcoloreffects.c
+	gstcoloreffects.c \
+	gstchromahold.c
 libgstcoloreffects_la_CFLAGS = \
 	$(GST_PLUGINS_BASE_CFLAGS) \
+	$(GST_CONTROLLER_CFLAGS) \
+	$(GST_BASE_CFLAGS) \
 	$(GST_CFLAGS)
 libgstcoloreffects_la_LIBADD = \
 	$(GST_PLUGINS_BASE_LIBS) -lgstvideo-@GST_MAJORMINOR@ \
+	$(GST_CONTROLLER_LIBS) \
 	$(GST_BASE_LIBS) \
 	$(GST_LIBS)
 libgstcoloreffects_la_LDFLAGS = $(GST_PLUGIN_LDFLAGS)
 libgstcoloreffects_la_LIBTOOLFLAGS = --tag=disable-static
 
-noinst_HEADERS = gstcoloreffects.h
+noinst_HEADERS = gstcoloreffects.h gstchromahold.h

gst/coloreffects/gstchromahold.c

@@ -0,0 +1,463 @@
+/* GStreamer
+ * Copyright (C) 1999 Erik Walthinsen <omega@cse.ogi.edu>
+ * Copyright (C) 2007 Wim Taymans <wim.taymans@collabora.co.uk>
+ * Copyright (C) 2007 Edward Hervey <edward.hervey@collabora.co.uk>
+ * Copyright (C) 2007 Jan Schmidt <thaytan@noraisin.net>
+ * Copyright (C) 2010 Sebastian Dröge <sebastian.droege@collabora.co.uk>
+ *
+ * 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.
+ */
+
+/**
+ * SECTION:element-chromahold
+ * 
+ * The chromahold element will remove all color information for
+ * all colors except a single one and converts them to grayscale.
+ *
+ * Sample pipeline:
+ * |[
+ * gst-launch videotestsrc pattern=smpte75 ! \
+ *   chromahold target-r=0 target-g=0 target-b=255 ! \
+ *   ffmpegcolorspace ! autovideosink     \
+ * ]| This pipeline only keeps the red color.
+ */
+
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "gstchromahold.h"
+
+#include <stdlib.h>
+#include <string.h>
+#include <math.h>
+
+GST_DEBUG_CATEGORY_STATIC (gst_chroma_hold_debug);
+#define GST_CAT_DEFAULT gst_chroma_hold_debug
+
+#define DEFAULT_TARGET_R 255
+#define DEFAULT_TARGET_G 0
+#define DEFAULT_TARGET_B 0
+#define DEFAULT_TOLERANCE 2
+
+enum
+{
+  PROP_0,
+  PROP_TARGET_R,
+  PROP_TARGET_G,
+  PROP_TARGET_B,
+  PROP_TOLERANCE,
+  PROP_LAST
+};
+
+static GstStaticPadTemplate gst_chroma_hold_src_template =
+    GST_STATIC_PAD_TEMPLATE ("src",
+    GST_PAD_SRC,
+    GST_PAD_ALWAYS,
+    GST_STATIC_CAPS (GST_VIDEO_CAPS_ARGB ";" GST_VIDEO_CAPS_BGRA ";"
+        GST_VIDEO_CAPS_ABGR ";" GST_VIDEO_CAPS_RGBA
+        ";" GST_VIDEO_CAPS_xRGB ";" GST_VIDEO_CAPS_BGRx ";" GST_VIDEO_CAPS_xBGR
+        ";" GST_VIDEO_CAPS_RGBx)
+    );
+
+static GstStaticPadTemplate gst_chroma_hold_sink_template =
+    GST_STATIC_PAD_TEMPLATE ("sink",
+    GST_PAD_SINK,
+    GST_PAD_ALWAYS,
+    GST_STATIC_CAPS (GST_VIDEO_CAPS_ARGB ";" GST_VIDEO_CAPS_BGRA ";"
+        GST_VIDEO_CAPS_ABGR ";" GST_VIDEO_CAPS_RGBA
+        ";" GST_VIDEO_CAPS_xRGB ";" GST_VIDEO_CAPS_BGRx ";" GST_VIDEO_CAPS_xBGR
+        ";" GST_VIDEO_CAPS_RGBx)
+    );
+
+#define GST_CHROMA_HOLD_LOCK(self) G_STMT_START { \
+  GST_LOG_OBJECT (self, "Locking chromahold from thread %p", g_thread_self ()); \
+  g_static_mutex_lock (&self->lock); \
+  GST_LOG_OBJECT (self, "Locked chromahold from thread %p", g_thread_self ()); \
+} G_STMT_END
+
+#define GST_CHROMA_HOLD_UNLOCK(self) G_STMT_START { \
+  GST_LOG_OBJECT (self, "Unlocking chromahold from thread %p", g_thread_self ()); \
+  g_static_mutex_unlock (&self->lock); \
+} G_STMT_END
+
+static gboolean gst_chroma_hold_start (GstBaseTransform * trans);
+static gboolean gst_chroma_hold_get_unit_size (GstBaseTransform * btrans,
+    GstCaps * caps, guint * size);
+static gboolean gst_chroma_hold_set_caps (GstBaseTransform * btrans,
+    GstCaps * incaps, GstCaps * outcaps);
+static GstFlowReturn gst_chroma_hold_transform_ip (GstBaseTransform * btrans,
+    GstBuffer * buf);
+static void gst_chroma_hold_before_transform (GstBaseTransform * btrans,
+    GstBuffer * buf);
+
+static void gst_chroma_hold_init_params (GstChromaHold * self);
+static gboolean gst_chroma_hold_set_process_function (GstChromaHold * self);
+
+static void gst_chroma_hold_set_property (GObject * object, guint prop_id,
+    const GValue * value, GParamSpec * pspec);
+static void gst_chroma_hold_get_property (GObject * object, guint prop_id,
+    GValue * value, GParamSpec * pspec);
+static void gst_chroma_hold_finalize (GObject * object);
+
+GST_BOILERPLATE (GstChromaHold, gst_chroma_hold, GstVideoFilter,
+    GST_TYPE_VIDEO_FILTER);
+
+static void
+gst_chroma_hold_base_init (gpointer g_class)
+{
+  GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
+
+  gst_element_class_set_details_simple (element_class, "Chroma hold filter",
+      "Filter/Effect/Video",
+      "Removes all color information except for one color",
+      "Sebastian Dröge <sebastian.droege@collabora.co.uk>");
+
+  gst_element_class_add_pad_template (element_class,
+      gst_static_pad_template_get (&gst_chroma_hold_sink_template));
+  gst_element_class_add_pad_template (element_class,
+      gst_static_pad_template_get (&gst_chroma_hold_src_template));
+
+  GST_DEBUG_CATEGORY_INIT (gst_chroma_hold_debug, "chromahold", 0,
+      "chromahold - Removes all color information except for one color");
+}
+
+static void
+gst_chroma_hold_class_init (GstChromaHoldClass * klass)
+{
+  GObjectClass *gobject_class = (GObjectClass *) klass;
+  GstBaseTransformClass *btrans_class = (GstBaseTransformClass *) klass;
+
+  gobject_class->set_property = gst_chroma_hold_set_property;
+  gobject_class->get_property = gst_chroma_hold_get_property;
+  gobject_class->finalize = gst_chroma_hold_finalize;
+
+  g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TARGET_R,
+      g_param_spec_uint ("target-r", "Target Red", "The Red target", 0, 255,
+          DEFAULT_TARGET_R,
+          G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE | G_PARAM_STATIC_STRINGS));
+  g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TARGET_G,
+      g_param_spec_uint ("target-g", "Target Green", "The Green target", 0, 255,
+          DEFAULT_TARGET_G,
+          G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE | G_PARAM_STATIC_STRINGS));
+  g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TARGET_B,
+      g_param_spec_uint ("target-b", "Target Blue", "The Blue target", 0, 255,
+          DEFAULT_TARGET_B,
+          G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE | G_PARAM_STATIC_STRINGS));
+  g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TOLERANCE,
+      g_param_spec_uint ("tolerance", "Tolerance",
+          "Tolerance for the target color", 0, 180, DEFAULT_TOLERANCE,
+          G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE | G_PARAM_STATIC_STRINGS));
+
+  btrans_class->start = GST_DEBUG_FUNCPTR (gst_chroma_hold_start);
+  btrans_class->transform_ip = GST_DEBUG_FUNCPTR (gst_chroma_hold_transform_ip);
+  btrans_class->before_transform =
+      GST_DEBUG_FUNCPTR (gst_chroma_hold_before_transform);
+  btrans_class->get_unit_size =
+      GST_DEBUG_FUNCPTR (gst_chroma_hold_get_unit_size);
+  btrans_class->set_caps = GST_DEBUG_FUNCPTR (gst_chroma_hold_set_caps);
+}
+
+static void
+gst_chroma_hold_init (GstChromaHold * self, GstChromaHoldClass * klass)
+{
+  self->target_r = DEFAULT_TARGET_R;
+  self->target_g = DEFAULT_TARGET_G;
+  self->target_b = DEFAULT_TARGET_B;
+  self->tolerance = DEFAULT_TOLERANCE;
+
+  g_static_mutex_init (&self->lock);
+}
+
+static void
+gst_chroma_hold_finalize (GObject * object)
+{
+  GstChromaHold *self = GST_CHROMA_HOLD (object);
+
+  g_static_mutex_free (&self->lock);
+
+  G_OBJECT_CLASS (parent_class)->finalize (object);
+}
+
+static void
+gst_chroma_hold_set_property (GObject * object, guint prop_id,
+    const GValue * value, GParamSpec * pspec)
+{
+  GstChromaHold *self = GST_CHROMA_HOLD (object);
+
+  GST_CHROMA_HOLD_LOCK (self);
+  switch (prop_id) {
+    case PROP_TARGET_R:
+      self->target_r = g_value_get_uint (value);
+      gst_chroma_hold_init_params (self);
+      break;
+    case PROP_TARGET_G:
+      self->target_g = g_value_get_uint (value);
+      gst_chroma_hold_init_params (self);
+      break;
+    case PROP_TARGET_B:
+      self->target_b = g_value_get_uint (value);
+      gst_chroma_hold_init_params (self);
+      break;
+    case PROP_TOLERANCE:
+      self->tolerance = g_value_get_uint (value);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+  }
+
+  GST_CHROMA_HOLD_UNLOCK (self);
+}
+
+static void
+gst_chroma_hold_get_property (GObject * object, guint prop_id, GValue * value,
+    GParamSpec * pspec)
+{
+  GstChromaHold *self = GST_CHROMA_HOLD (object);
+
+  switch (prop_id) {
+    case PROP_TARGET_R:
+      g_value_set_uint (value, self->target_r);
+      break;
+    case PROP_TARGET_G:
+      g_value_set_uint (value, self->target_g);
+      break;
+    case PROP_TARGET_B:
+      g_value_set_uint (value, self->target_b);
+      break;
+    case PROP_TOLERANCE:
+      g_value_set_uint (value, self->tolerance);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+  }
+}
+
+static gboolean
+gst_chroma_hold_get_unit_size (GstBaseTransform * btrans,
+    GstCaps * caps, guint * size)
+{
+  GstVideoFormat format;
+  gint width, height;
+
+  if (!gst_video_format_parse_caps (caps, &format, &width, &height))
+    return FALSE;
+
+  *size = gst_video_format_get_size (format, width, height);
+
+  GST_DEBUG_OBJECT (btrans, "unit size = %d for format %d w %d height %d",
+      *size, format, width, height);
+
+  return TRUE;
+}
+
+static gboolean
+gst_chroma_hold_set_caps (GstBaseTransform * btrans,
+    GstCaps * incaps, GstCaps * outcaps)
+{
+  GstChromaHold *self = GST_CHROMA_HOLD (btrans);
+
+  GST_CHROMA_HOLD_LOCK (self);
+
+  if (!gst_video_format_parse_caps (outcaps, &self->format,
+          &self->width, &self->height)) {
+    GST_WARNING_OBJECT (self,
+        "Failed to parse caps %" GST_PTR_FORMAT " -> %" GST_PTR_FORMAT, incaps,
+        outcaps);
+    GST_CHROMA_HOLD_UNLOCK (self);
+    return FALSE;
+  }
+
+  GST_DEBUG_OBJECT (self,
+      "Setting caps %" GST_PTR_FORMAT " -> %" GST_PTR_FORMAT, incaps, outcaps);
+
+  if (!gst_chroma_hold_set_process_function (self)) {
+    GST_WARNING_OBJECT (self, "No processing function for this caps");
+    GST_CHROMA_HOLD_UNLOCK (self);
+    return FALSE;
+  }
+
+  GST_CHROMA_HOLD_UNLOCK (self);
+
+  return TRUE;
+}
+
+static inline gint
+rgb_to_hue (gint r, gint g, gint b)
+{
+  gint m, M, C, h;
+
+  m = MIN (MIN (r, g), b);
+  M = MAX (MAX (r, g), b);
+  C = M - m;
+
+  if (C == 0) {
+    h = 0;
+  } else if (M == r) {
+    h = ((g - b) / C) % 6;
+  } else if (M == g) {
+    h = ((b - r) / C) + 2;
+  } else {                      /* if (M == b) */
+
+    h = ((r - g) / C) + 4;
+  }
+  h = 60 * h;
+
+  if (h >= 360)
+    h -= 360;
+  else if (h < 0)
+    h += 360;
+
+  return h;
+}
+
+static inline gint
+hue_dist (gint h1, gint h2)
+{
+  gint d1, d2;
+
+  d1 = h1 - h2;
+  d2 = h2 - h1;
+
+  if (d1 < 0)
+    d1 += 360;
+  if (d2 < 0)
+    d2 += 360;
+
+  return MIN (d1, d2);
+}
+
+static void
+gst_chroma_hold_process_xrgb (guint8 * dest, gint width,
+    gint height, GstChromaHold * self)
+{
+  gint i, j;
+  gint r, g, b;
+  gint grey;
+  gint h1, h2;
+  gint tolerance = self->tolerance;
+  gint p[4];
+  gint diff;
+
+  p[0] = gst_video_format_get_component_offset (self->format, 3, width, height);
+  p[1] = gst_video_format_get_component_offset (self->format, 0, width, height);
+  p[2] = gst_video_format_get_component_offset (self->format, 1, width, height);
+  p[3] = gst_video_format_get_component_offset (self->format, 2, width, height);
+
+  h1 = self->hue;
+
+  for (i = 0; i < height; i++) {
+    for (j = 0; j < width; j++) {
+      r = dest[p[1]];
+      g = dest[p[2]];
+      b = dest[p[3]];
+
+      h2 = rgb_to_hue (r, g, b);
+      diff = hue_dist (h1, h2);
+      if (diff > tolerance) {
+        grey = (13938 * r + 46869 * g + 4730 * b) >> 16;
+        grey = CLAMP (grey, 0, 255);
+        dest[p[1]] = grey;
+        dest[p[2]] = grey;
+        dest[p[3]] = grey;
+      }
+
+      dest += 4;
+    }
+  }
+}
+
+/* Protected with the chroma hold lock */
+static void
+gst_chroma_hold_init_params (GstChromaHold * self)
+{
+  self->hue = rgb_to_hue (self->target_r, self->target_g, self->target_b);
+}
+
+/* Protected with the chroma hold lock */
+static gboolean
+gst_chroma_hold_set_process_function (GstChromaHold * self)
+{
+  self->process = NULL;
+
+  switch (self->format) {
+    case GST_VIDEO_FORMAT_ARGB:
+    case GST_VIDEO_FORMAT_ABGR:
+    case GST_VIDEO_FORMAT_RGBA:
+    case GST_VIDEO_FORMAT_BGRA:
+    case GST_VIDEO_FORMAT_xRGB:
+    case GST_VIDEO_FORMAT_xBGR:
+    case GST_VIDEO_FORMAT_RGBx:
+    case GST_VIDEO_FORMAT_BGRx:
+      self->process = gst_chroma_hold_process_xrgb;
+      break;
+    default:
+      break;
+  }
+  return self->process != NULL;
+}
+
+static gboolean
+gst_chroma_hold_start (GstBaseTransform * btrans)
+{
+  GstChromaHold *self = GST_CHROMA_HOLD (btrans);
+
+  GST_CHROMA_HOLD_LOCK (self);
+  gst_chroma_hold_init_params (self);
+  GST_CHROMA_HOLD_UNLOCK (self);
+
+  return TRUE;
+}
+
+static void
+gst_chroma_hold_before_transform (GstBaseTransform * btrans, GstBuffer * buf)
+{
+  GstChromaHold *self = GST_CHROMA_HOLD (btrans);
+  GstClockTime timestamp;
+
+  timestamp = gst_segment_to_stream_time (&btrans->segment, GST_FORMAT_TIME,
+      GST_BUFFER_TIMESTAMP (buf));
+  GST_LOG ("Got stream time of %" GST_TIME_FORMAT, GST_TIME_ARGS (timestamp));
+  if (GST_CLOCK_TIME_IS_VALID (timestamp))
+    gst_object_sync_values (G_OBJECT (self), timestamp);
+}
+
+static GstFlowReturn
+gst_chroma_hold_transform_ip (GstBaseTransform * btrans, GstBuffer * buf)
+{
+  GstChromaHold *self = GST_CHROMA_HOLD (btrans);
+  gint width, height;
+
+  GST_CHROMA_HOLD_LOCK (self);
+
+  if (G_UNLIKELY (!self->process)) {
+    GST_ERROR_OBJECT (self, "Not negotiated yet");
+    GST_CHROMA_HOLD_UNLOCK (self);
+    return GST_FLOW_NOT_NEGOTIATED;
+  }
+
+  width = self->width;
+  height = self->height;
+
+  self->process (GST_BUFFER_DATA (buf), width, height, self);
+
+  GST_CHROMA_HOLD_UNLOCK (self);
+
+  return GST_FLOW_OK;
+}

gst/coloreffects/gstchromahold.h

@@ -0,0 +1,82 @@
+/* GStreamer
+ *
+ * Copyright (C) 1999 Erik Walthinsen <omega@cse.ogi.edu>
+ * Copyright (C) 2007 Wim Taymans <wim.taymans@collabora.co.uk>
+ * Copyright (C) 2007 Edward Hervey <edward.hervey@collabora.co.uk>
+ * Copyright (C) 2007 Jan Schmidt <thaytan@noraisin.net>
+ * Copyright (C) 2010 Sebastian Dröge <sebastian.droege@collabora.co.uk>
+ *
+ * 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.
+ */
+
+#ifndef __GST_CHROMA_HOLD_H__
+#define __GST_CHROMA_HOLD_H__
+
+#include <gst/gst.h>
+#include <gst/video/video.h>
+#include <gst/video/gstvideofilter.h>
+#include <gst/controller/gstcontroller.h>
+
+G_BEGIN_DECLS
+
+#define GST_TYPE_CHROMA_HOLD \
+  (gst_chroma_hold_get_type())
+#define GST_CHROMA_HOLD(obj) \
+  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_CHROMA_HOLD,GstChromaHold))
+#define GST_CHROMA_HOLD_CLASS(klass) \
+  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_CHROMA_HOLD,GstChromaHoldClass))
+#define GST_IS_CHROMA_HOLD(obj) \
+  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_CHROMA_HOLD))
+#define GST_IS_CHROMA_HOLD_CLASS(klass) \
+  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_CHROMA_HOLD))
+
+typedef struct _GstChromaHold GstChromaHold;
+typedef struct _GstChromaHoldClass GstChromaHoldClass;
+
+struct _GstChromaHold
+{
+  GstVideoFilter parent;
+
+  /* <private> */
+
+  /* caps */
+  GStaticMutex lock;
+
+  GstVideoFormat format;
+  gint width, height;
+
+  guint target_r;
+  guint target_g;
+  guint target_b;
+  guint tolerance;
+
+  /* processing function */
+  void (*process) (guint8 *dest, gint width, gint height, GstChromaHold *chroma_hold);
+
+  /* pre-calculated values */
+  gint hue;
+};
+
+struct _GstChromaHoldClass
+{
+  GstVideoFilterClass parent_class;
+};
+
+GType gst_chroma_hold_get_type (void);
+
+G_END_DECLS
+
+#endif /* __GST_CHROMA_HOLD_H__ */

gst/coloreffects/gstplugin.c

@@ -24,10 +24,7 @@
 #include <gst/gst.h>
 
 #include "gstcoloreffects.h"
-
+#include "gstchromahold.h"
-#ifndef PACKAGE
-#define PACKAGE "coloreffects"
-#endif
 
 struct _elements_entry
 {
@@ -37,6 +34,7 @@ struct _elements_entry
 
 static const struct _elements_entry _elements[] = {
   {"coloreffects", gst_color_effects_get_type},
+  {"chromahold", gst_chroma_hold_get_type},
   {NULL, 0},
 };