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