ext/libcaca/gstcacasink.c

   1 /* GStreamer
   2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #include "config.h"
  22 #endif
  23
  24 #include <string.h>
  25 #include <sys/time.h>
  26
  27 #include "gstcacasink.h"
  28
  29 /* elementfactory information */
  30 static GstElementDetails gst_cacasink_details = {
  31   "CACA sink",
  32   "Sink/Video",
  33   "A colored ASCII art videosink",
  34   "Zeeshan Ali <zak147@yahoo.com>"
  35 };
  36
  37 /* cacasink signals and args */
  38 enum
  39 {
  40   LAST_SIGNAL
  41 };
  42
  43
  44 enum
  45 {
  46   ARG_0,
  47   ARG_SCREEN_WIDTH,
  48   ARG_SCREEN_HEIGHT,
  49   ARG_DITHER,
  50   ARG_ANTIALIASING
  51 };
  52
  53 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
  54     GST_PAD_SINK,
  55     GST_PAD_ALWAYS,
  56     GST_STATIC_CAPS (GST_VIDEO_CAPS_RGB ";" GST_VIDEO_CAPS_RGBx ";"
  57         GST_VIDEO_CAPS_RGB_16 ";" GST_VIDEO_CAPS_RGB_15)
  58     );
  59
  60 static void gst_cacasink_base_init (gpointer g_class);
  61 static void gst_cacasink_class_init (GstCACASinkClass * klass);
  62 static void gst_cacasink_init (GstCACASink * cacasink);
  63
  64 static gboolean gst_cacasink_setcaps (GstBaseSink * pad, GstCaps * caps);
  65 static void gst_cacasink_get_times (GstBaseSink * sink, GstBuffer * buffer,
  66     GstClockTime * start, GstClockTime * end);
  67 static GstFlowReturn gst_cacasink_render (GstBaseSink * basesink,
  68     GstBuffer * buffer);
  69
  70 static void gst_cacasink_set_property (GObject * object, guint prop_id,
  71     const GValue * value, GParamSpec * pspec);
  72 static void gst_cacasink_get_property (GObject * object, guint prop_id,
  73     GValue * value, GParamSpec * pspec);
  74
  75 static GstStateChangeReturn gst_cacasink_change_state (GstElement * element,
  76     GstStateChange transition);
  77
  78 static GstElementClass *parent_class = NULL;
  79
  80 GType
  81 gst_cacasink_get_type (void)
  82 {
  83   static GType cacasink_type = 0;
  84
  85   if (!cacasink_type) {
  86     static const GTypeInfo cacasink_info = {
  87       sizeof (GstCACASinkClass),
  88       gst_cacasink_base_init,
  89       NULL,
  90       (GClassInitFunc) gst_cacasink_class_init,
  91       NULL,
  92       NULL,
  93       sizeof (GstCACASink),
  94       0,
  95       (GInstanceInitFunc) gst_cacasink_init,
  96     };
  97
  98     cacasink_type =
  99         g_type_register_static (GST_TYPE_BASE_SINK, "GstCACASink",
 100         &cacasink_info, 0);
 101   }
 102   return cacasink_type;
 103 }
 104
 105 #define GST_TYPE_CACADITHER (gst_cacasink_dither_get_type())
 106 static GType
 107 gst_cacasink_dither_get_type (void)
 108 {
 109   static GType dither_type = 0;
 110
 111   static GEnumValue dither_types[] = {
 112     {CACA_DITHERING_NONE, "No dithering", "none"},
 113     {CACA_DITHERING_ORDERED2, "Ordered 2x2 Bayer dithering", "2x2"},
 114     {CACA_DITHERING_ORDERED4, "Ordered 4x4 Bayer dithering", "4x4"},
 115     {CACA_DITHERING_ORDERED8, "Ordered 8x8 Bayer dithering", "8x8"},
 116     {CACA_DITHERING_RANDOM, "Random dithering", "random"},
 117     {0, NULL, NULL},
 118   };
 119
 120   if (!dither_type) {
 121     dither_type = g_enum_register_static ("GstCACASinkDithering", dither_types);
 122   }
 123   return dither_type;
 124 }
 125
 126 static void
 127 gst_cacasink_base_init (gpointer g_class)
 128 {
 129   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 130
 131   gst_element_class_set_details (element_class, &gst_cacasink_details);
 132   gst_element_class_add_pad_template (element_class,
 133       gst_static_pad_template_get (&sink_template));
 134 }
 135
 136 static void
 137 gst_cacasink_class_init (GstCACASinkClass * klass)
 138 {
 139   GObjectClass *gobject_class;
 140   GstElementClass *gstelement_class;
 141   GstBaseSinkClass *gstbasesink_class;
 142
 143   gobject_class = (GObjectClass *) klass;
 144   gstelement_class = (GstElementClass *) klass;
 145   gstbasesink_class = (GstBaseSinkClass *) klass;
 146
 147   parent_class = g_type_class_ref (GST_TYPE_BASE_SINK);
 148
 149   gobject_class->set_property = gst_cacasink_set_property;
 150   gobject_class->get_property = gst_cacasink_get_property;
 151   gstelement_class->change_state = gst_cacasink_change_state;
 152
 153   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SCREEN_WIDTH, g_param_spec_int ("screen-width", "screen_width", "screen_width", G_MININT, G_MAXINT, 0, G_PARAM_READABLE));       /* CHECKME */
 154   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SCREEN_HEIGHT, g_param_spec_int ("screen-height", "screen_height", "screen_height", G_MININT, G_MAXINT, 0, G_PARAM_READABLE));   /* CHECKME */
 155   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_DITHER,
 156       g_param_spec_enum ("dither", "Dither Type", "Set type of Dither",
 157           GST_TYPE_CACADITHER, CACA_DITHERING_NONE, G_PARAM_READWRITE));
 158   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_ANTIALIASING,
 159       g_param_spec_boolean ("anti-aliasing", "Anti-Aliasing",
 160           "Enables Anti-Aliasing", TRUE, G_PARAM_READWRITE));
 161
 162   gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_cacasink_setcaps);
 163   gstbasesink_class->get_times = GST_DEBUG_FUNCPTR (gst_cacasink_get_times);
 164   gstbasesink_class->preroll = GST_DEBUG_FUNCPTR (gst_cacasink_render);
 165   gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_cacasink_render);
 166 }
 167
 168 static void
 169 gst_cacasink_get_times (GstBaseSink * sink, GstBuffer * buffer,
 170     GstClockTime * start, GstClockTime * end)
 171 {
 172   *start = GST_BUFFER_TIMESTAMP (buffer);
 173   *end = *start + GST_BUFFER_DURATION (buffer);
 174 }
 175
 176 static gboolean
 177 gst_cacasink_setcaps (GstBaseSink * basesink, GstCaps * caps)
 178 {
 179   GstCACASink *cacasink;
 180   GstStructure *structure;
 181
 182   cacasink = GST_CACASINK (basesink);
 183
 184   structure = gst_caps_get_structure (caps, 0);
 185   gst_structure_get_int (structure, "width", &(cacasink->width));
 186   gst_structure_get_int (structure, "height", &(cacasink->height));
 187   gst_structure_get_int (structure, "bpp", (int *) &cacasink->bpp);
 188   gst_structure_get_int (structure, "red_mask", (int *) &cacasink->red_mask);
 189   gst_structure_get_int (structure, "green_mask",
 190       (int *) &cacasink->green_mask);
 191   gst_structure_get_int (structure, "blue_mask", (int *) &cacasink->blue_mask);
 192
 193   if (cacasink->bpp == 24) {
 194     cacasink->red_mask = GUINT32_FROM_BE (cacasink->red_mask) >> 8;
 195     cacasink->green_mask = GUINT32_FROM_BE (cacasink->green_mask) >> 8;
 196     cacasink->blue_mask = GUINT32_FROM_BE (cacasink->blue_mask) >> 8;
 197   }
 198
 199   else if (cacasink->bpp == 32) {
 200     cacasink->red_mask = GUINT32_FROM_BE (cacasink->red_mask);
 201     cacasink->green_mask = GUINT32_FROM_BE (cacasink->green_mask);
 202     cacasink->blue_mask = GUINT32_FROM_BE (cacasink->blue_mask);
 203   }
 204
 205   else if (cacasink->bpp == 16 || cacasink->bpp == 15) {
 206     cacasink->red_mask = GUINT16_FROM_BE (cacasink->red_mask);
 207     cacasink->green_mask = GUINT16_FROM_BE (cacasink->green_mask);
 208     cacasink->blue_mask = GUINT16_FROM_BE (cacasink->blue_mask);
 209   }
 210
 211   if (cacasink->bitmap) {
 212     caca_free_bitmap (cacasink->bitmap);
 213   }
 214
 215   cacasink->bitmap = caca_create_bitmap (cacasink->bpp,
 216       cacasink->width,
 217       cacasink->height,
 218       cacasink->width * cacasink->bpp / 8,
 219       cacasink->red_mask, cacasink->green_mask, cacasink->blue_mask, 0);
 220
 221   if (!cacasink->bitmap) {
 222     return FALSE;
 223   }
 224
 225   return TRUE;
 226 }
 227
 228 static void
 229 gst_cacasink_init (GstCACASink * cacasink)
 230 {
 231   GstPad *pad;
 232
 233   pad = GST_BASE_SINK_PAD (cacasink);
 234   /* gst_pad_set_fixatecaps_function (pad, gst_cacasink_fixate); */
 235
 236   cacasink->screen_width = GST_CACA_DEFAULT_SCREEN_WIDTH;
 237   cacasink->screen_height = GST_CACA_DEFAULT_SCREEN_HEIGHT;
 238   cacasink->bpp = GST_CACA_DEFAULT_BPP;
 239   cacasink->red_mask = GST_CACA_DEFAULT_RED_MASK;
 240   cacasink->green_mask = GST_CACA_DEFAULT_GREEN_MASK;
 241   cacasink->blue_mask = GST_CACA_DEFAULT_BLUE_MASK;
 242 }
 243
 244 static GstFlowReturn
 245 gst_cacasink_render (GstBaseSink * basesink, GstBuffer * buffer)
 246 {
 247   GstCACASink *cacasink = GST_CACASINK (basesink);
 248
 249   GST_DEBUG ("render");
 250
 251   caca_clear ();
 252   caca_draw_bitmap (0, 0, cacasink->screen_width - 1,
 253       cacasink->screen_height - 1, cacasink->bitmap, GST_BUFFER_DATA (buffer));
 254   caca_refresh ();
 255
 256   return GST_FLOW_OK;
 257 }
 258
 259 static void
 260 gst_cacasink_set_property (GObject * object, guint prop_id,
 261     const GValue * value, GParamSpec * pspec)
 262 {
 263   GstCACASink *cacasink;
 264
 265   g_return_if_fail (GST_IS_CACASINK (object));
 266
 267   cacasink = GST_CACASINK (object);
 268
 269   switch (prop_id) {
 270     case ARG_DITHER:{
 271       cacasink->dither = g_value_get_enum (value);
 272       caca_set_dithering (cacasink->dither + CACA_DITHERING_NONE);
 273       break;
 274     }
 275     case ARG_ANTIALIASING:{
 276       cacasink->antialiasing = g_value_get_boolean (value);
 277       if (cacasink->antialiasing) {
 278         caca_set_feature (CACA_ANTIALIASING_MAX);
 279       }
 280
 281       else {
 282         caca_set_feature (CACA_ANTIALIASING_MIN);
 283       }
 284       break;
 285     }
 286     default:
 287       break;
 288   }
 289 }
 290
 291 static void
 292 gst_cacasink_get_property (GObject * object, guint prop_id, GValue * value,
 293     GParamSpec * pspec)
 294 {
 295   GstCACASink *cacasink;
 296
 297   cacasink = GST_CACASINK (object);
 298
 299   switch (prop_id) {
 300     case ARG_SCREEN_WIDTH:{
 301       g_value_set_int (value, cacasink->screen_width);
 302       break;
 303     }
 304     case ARG_SCREEN_HEIGHT:{
 305       g_value_set_int (value, cacasink->screen_height);
 306       break;
 307     }
 308     case ARG_DITHER:{
 309       g_value_set_enum (value, cacasink->dither);
 310       break;
 311     }
 312     case ARG_ANTIALIASING:{
 313       g_value_set_boolean (value, cacasink->antialiasing);
 314       break;
 315     }
 316     default:{
 317       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 318       break;
 319     }
 320   }
 321 }
 322
 323 static gboolean
 324 gst_cacasink_open (GstCACASink * cacasink)
 325 {
 326   cacasink->bitmap = NULL;
 327   caca_init ();
 328
 329   cacasink->screen_width = caca_get_width ();
 330   cacasink->screen_height = caca_get_height ();
 331   cacasink->antialiasing = TRUE;
 332   caca_set_feature (CACA_ANTIALIASING_MAX);
 333   cacasink->dither = 0;
 334   caca_set_dithering (CACA_DITHERING_NONE);
 335
 336   return TRUE;
 337 }
 338
 339 static void
 340 gst_cacasink_close (GstCACASink * cacasink)
 341 {
 342   if (cacasink->bitmap) {
 343     caca_free_bitmap (cacasink->bitmap);
 344     cacasink->bitmap = NULL;
 345   }
 346   caca_end ();
 347 }
 348
 349 static GstStateChangeReturn
 350 gst_cacasink_change_state (GstElement * element, GstStateChange transition)
 351 {
 352   GstStateChangeReturn ret;
 353
 354
 355   switch (transition) {
 356     case GST_STATE_CHANGE_READY_TO_PAUSED:
 357       if (!gst_cacasink_open (GST_CACASINK (element)))
 358         return GST_STATE_CHANGE_FAILURE;
 359       break;
 360     default:
 361       break;
 362   }
 363
 364   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 365
 366   switch (transition) {
 367     case GST_STATE_CHANGE_PAUSED_TO_READY:
 368       gst_cacasink_close (GST_CACASINK (element));
 369       break;
 370     default:
 371       break;
 372   }
 373   return ret;
 374 }
 375
 376 static gboolean
 377 plugin_init (GstPlugin * plugin)
 378 {
 379   if (!gst_element_register (plugin, "cacasink", GST_RANK_NONE,
 380           GST_TYPE_CACASINK))
 381     return FALSE;
 382
 383   return TRUE;
 384 }
 385
 386 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
 387     GST_VERSION_MINOR,
 388     "cacasink",
 389     "Colored ASCII Art video sink",
 390     plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)