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   if (!dither_type) {
 112     GEnumValue *dithers;
 113     gint n_dithers;
 114     gint i;
 115     gchar *caca_dithernames[] = {
 116       "NONE", "ORDERED2", "ORDERED4", "ORDERED8", "RANDOM", NULL
 117     };
 118
 119     n_dithers = 5;
 120
 121     dithers = g_new0 (GEnumValue, n_dithers + 1);
 122
 123     for (i = 0; i < n_dithers; i++) {
 124       dithers[i].value = i;
 125       dithers[i].value_name = g_strdup (caca_dithernames[i]);
 126       dithers[i].value_nick = g_strdup (caca_dithernames[i]);
 127     }
 128     dithers[i].value = 0;
 129     dithers[i].value_name = NULL;
 130     dithers[i].value_nick = NULL;
 131
 132     dither_type = g_enum_register_static ("GstCACASinkDithers", dithers);
 133   }
 134   return dither_type;
 135 }
 136
 137 static void
 138 gst_cacasink_base_init (gpointer g_class)
 139 {
 140   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 141
 142   gst_element_class_set_details (element_class, &gst_cacasink_details);
 143   gst_element_class_add_pad_template (element_class,
 144       gst_static_pad_template_get (&sink_template));
 145 }
 146
 147 static void
 148 gst_cacasink_class_init (GstCACASinkClass * klass)
 149 {
 150   GObjectClass *gobject_class;
 151   GstElementClass *gstelement_class;
 152   GstBaseSinkClass *gstbasesink_class;
 153
 154   gobject_class = (GObjectClass *) klass;
 155   gstelement_class = (GstElementClass *) klass;
 156   gstbasesink_class = (GstBaseSinkClass *) klass;
 157
 158   parent_class = g_type_class_ref (GST_TYPE_BASE_SINK);
 159
 160   gobject_class->set_property = gst_cacasink_set_property;
 161   gobject_class->get_property = gst_cacasink_get_property;
 162   gstelement_class->change_state = gst_cacasink_change_state;
 163
 164   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 */
 165   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 */
 166   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_DITHER,
 167       g_param_spec_enum ("dither", "Dither Type", "Set type of Dither",
 168           GST_TYPE_CACADITHER, 0, G_PARAM_READWRITE));
 169   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_ANTIALIASING,
 170       g_param_spec_boolean ("anti_aliasing", "Anti-Aliasing",
 171           "Enables Anti-Aliasing", TRUE, G_PARAM_READWRITE));
 172
 173   gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_cacasink_setcaps);
 174   gstbasesink_class->get_times = GST_DEBUG_FUNCPTR (gst_cacasink_get_times);
 175   gstbasesink_class->preroll = GST_DEBUG_FUNCPTR (gst_cacasink_render);
 176   gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_cacasink_render);
 177 }
 178
 179 static void
 180 gst_cacasink_get_times (GstBaseSink * sink, GstBuffer * buffer,
 181     GstClockTime * start, GstClockTime * end)
 182 {
 183   *start = GST_BUFFER_TIMESTAMP (buffer);
 184   *end = *start + GST_BUFFER_DURATION (buffer);
 185 }
 186
 187 static gboolean
 188 gst_cacasink_setcaps (GstBaseSink * basesink, GstCaps * caps)
 189 {
 190   GstCACASink *cacasink;
 191   GstStructure *structure;
 192
 193   cacasink = GST_CACASINK (basesink);
 194
 195   structure = gst_caps_get_structure (caps, 0);
 196   gst_structure_get_int (structure, "width", &(cacasink->width));
 197   gst_structure_get_int (structure, "height", &(cacasink->height));
 198   gst_structure_get_int (structure, "bpp", (int *) &cacasink->bpp);
 199   gst_structure_get_int (structure, "red_mask", (int *) &cacasink->red_mask);
 200   gst_structure_get_int (structure, "green_mask",
 201       (int *) &cacasink->green_mask);
 202   gst_structure_get_int (structure, "blue_mask", (int *) &cacasink->blue_mask);
 203
 204   if (cacasink->bpp == 24) {
 205     cacasink->red_mask = GUINT32_FROM_BE (cacasink->red_mask) >> 8;
 206     cacasink->green_mask = GUINT32_FROM_BE (cacasink->green_mask) >> 8;
 207     cacasink->blue_mask = GUINT32_FROM_BE (cacasink->blue_mask) >> 8;
 208   }
 209
 210   else if (cacasink->bpp == 32) {
 211     cacasink->red_mask = GUINT32_FROM_BE (cacasink->red_mask);
 212     cacasink->green_mask = GUINT32_FROM_BE (cacasink->green_mask);
 213     cacasink->blue_mask = GUINT32_FROM_BE (cacasink->blue_mask);
 214   }
 215
 216   else if (cacasink->bpp == 16 || cacasink->bpp == 15) {
 217     cacasink->red_mask = GUINT16_FROM_BE (cacasink->red_mask);
 218     cacasink->green_mask = GUINT16_FROM_BE (cacasink->green_mask);
 219     cacasink->blue_mask = GUINT16_FROM_BE (cacasink->blue_mask);
 220   }
 221
 222   if (cacasink->bitmap) {
 223     caca_free_bitmap (cacasink->bitmap);
 224   }
 225
 226   cacasink->bitmap = caca_create_bitmap (cacasink->bpp,
 227       cacasink->width,
 228       cacasink->height,
 229       cacasink->width * cacasink->bpp / 8,
 230       cacasink->red_mask, cacasink->green_mask, cacasink->blue_mask, 0);
 231
 232   if (!cacasink->bitmap) {
 233     return FALSE;
 234   }
 235
 236   return TRUE;
 237 }
 238
 239 static void
 240 gst_cacasink_init (GstCACASink * cacasink)
 241 {
 242   GstPad *pad;
 243
 244   pad = GST_BASE_SINK_PAD (cacasink);
 245   /* gst_pad_set_fixatecaps_function (pad, gst_cacasink_fixate); */
 246
 247   cacasink->screen_width = GST_CACA_DEFAULT_SCREEN_WIDTH;
 248   cacasink->screen_height = GST_CACA_DEFAULT_SCREEN_HEIGHT;
 249   cacasink->bpp = GST_CACA_DEFAULT_BPP;
 250   cacasink->red_mask = GST_CACA_DEFAULT_RED_MASK;
 251   cacasink->green_mask = GST_CACA_DEFAULT_GREEN_MASK;
 252   cacasink->blue_mask = GST_CACA_DEFAULT_BLUE_MASK;
 253 }
 254
 255 static GstFlowReturn
 256 gst_cacasink_render (GstBaseSink * basesink, GstBuffer * buffer)
 257 {
 258   GstCACASink *cacasink = GST_CACASINK (basesink);
 259
 260   GST_DEBUG ("render");
 261
 262   caca_clear ();
 263   caca_draw_bitmap (0, 0, cacasink->screen_width - 1,
 264       cacasink->screen_height - 1, cacasink->bitmap, GST_BUFFER_DATA (buffer));
 265   caca_refresh ();
 266
 267   return GST_FLOW_OK;
 268 }
 269
 270 static void
 271 gst_cacasink_set_property (GObject * object, guint prop_id,
 272     const GValue * value, GParamSpec * pspec)
 273 {
 274   GstCACASink *cacasink;
 275
 276   g_return_if_fail (GST_IS_CACASINK (object));
 277
 278   cacasink = GST_CACASINK (object);
 279
 280   switch (prop_id) {
 281     case ARG_DITHER:{
 282       cacasink->dither = g_value_get_enum (value);
 283       caca_set_dithering (cacasink->dither + CACA_DITHERING_NONE);
 284       break;
 285     }
 286     case ARG_ANTIALIASING:{
 287       cacasink->antialiasing = g_value_get_boolean (value);
 288       if (cacasink->antialiasing) {
 289         caca_set_feature (CACA_ANTIALIASING_MAX);
 290       }
 291
 292       else {
 293         caca_set_feature (CACA_ANTIALIASING_MIN);
 294       }
 295       break;
 296     }
 297     default:
 298       break;
 299   }
 300 }
 301
 302 static void
 303 gst_cacasink_get_property (GObject * object, guint prop_id, GValue * value,
 304     GParamSpec * pspec)
 305 {
 306   GstCACASink *cacasink;
 307
 308   cacasink = GST_CACASINK (object);
 309
 310   switch (prop_id) {
 311     case ARG_SCREEN_WIDTH:{
 312       g_value_set_int (value, cacasink->screen_width);
 313       break;
 314     }
 315     case ARG_SCREEN_HEIGHT:{
 316       g_value_set_int (value, cacasink->screen_height);
 317       break;
 318     }
 319     case ARG_DITHER:{
 320       g_value_set_enum (value, cacasink->dither);
 321       break;
 322     }
 323     case ARG_ANTIALIASING:{
 324       g_value_set_boolean (value, cacasink->antialiasing);
 325       break;
 326     }
 327     default:{
 328       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 329       break;
 330     }
 331   }
 332 }
 333
 334 static gboolean
 335 gst_cacasink_open (GstCACASink * cacasink)
 336 {
 337   cacasink->bitmap = NULL;
 338   caca_init ();
 339
 340   cacasink->screen_width = caca_get_width ();
 341   cacasink->screen_height = caca_get_height ();
 342   cacasink->antialiasing = TRUE;
 343   caca_set_feature (CACA_ANTIALIASING_MAX);
 344   cacasink->dither = 0;
 345   caca_set_dithering (CACA_DITHERING_NONE);
 346
 347   return TRUE;
 348 }
 349
 350 static void
 351 gst_cacasink_close (GstCACASink * cacasink)
 352 {
 353   if (cacasink->bitmap) {
 354     caca_free_bitmap (cacasink->bitmap);
 355     cacasink->bitmap = NULL;
 356   }
 357   caca_end ();
 358 }
 359
 360 static GstStateChangeReturn
 361 gst_cacasink_change_state (GstElement * element, GstStateChange transition)
 362 {
 363   GstStateChangeReturn ret;
 364
 365
 366   switch (transition) {
 367     case GST_STATE_CHANGE_READY_TO_PAUSED:
 368       if (!gst_cacasink_open (GST_CACASINK (element)))
 369         return GST_STATE_CHANGE_FAILURE;
 370       break;
 371     default:
 372       break;
 373   }
 374
 375   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 376
 377   switch (transition) {
 378     case GST_STATE_CHANGE_PAUSED_TO_READY:
 379       gst_cacasink_close (GST_CACASINK (element));
 380       break;
 381     default:
 382       break;
 383   }
 384   return ret;
 385 }
 386
 387 static gboolean
 388 plugin_init (GstPlugin * plugin)
 389 {
 390   if (!gst_element_register (plugin, "cacasink", GST_RANK_NONE,
 391           GST_TYPE_CACASINK))
 392     return FALSE;
 393
 394   return TRUE;
 395 }
 396
 397 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
 398     GST_VERSION_MINOR,
 399     "cacasink",
 400     "Colored ASCII Art video sink",
 401     plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)