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