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