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