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
  47 //#define GST_CACA_DEFAULT_RED_MASK R_MASK_32_REVERSE_INT
  48 //#define GST_CACA_DEFAULT_GREEN_MASK G_MASK_32_REVERSE_INT
  49 //#define GST_CACA_DEFAULT_BLUE_MASK B_MASK_32_REVERSE_INT
  50
  51 /* cacasink signals and args */
  52 enum
  53 {
  54   LAST_SIGNAL
  55 };
  56
  57 #define GST_CACA_DEFAULT_SCREEN_WIDTH 80
  58 #define GST_CACA_DEFAULT_SCREEN_HEIGHT 25
  59 #define GST_CACA_DEFAULT_DITHER CACA_DITHERING_NONE
  60 #define GST_CACA_DEFAULT_ANTIALIASING TRUE
  61
  62 enum
  63 {
  64   PROP_0,
  65   PROP_SCREEN_WIDTH,
  66   PROP_SCREEN_HEIGHT,
  67   PROP_DITHER,
  68   PROP_ANTIALIASING
  69 };
  70
  71 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
  72     GST_PAD_SINK,
  73     GST_PAD_ALWAYS,
  74     GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE ("{ RGB, RGBx, RGB16, RGB15 }"))
  75     );
  76
  77 static gboolean gst_cacasink_setcaps (GstBaseSink * pad, GstCaps * caps);
  78 static void gst_cacasink_get_times (GstBaseSink * sink, GstBuffer * buffer,
  79     GstClockTime * start, GstClockTime * end);
  80 static GstFlowReturn gst_cacasink_render (GstBaseSink * basesink,
  81     GstBuffer * buffer);
  82
  83 static void gst_cacasink_set_property (GObject * object, guint prop_id,
  84     const GValue * value, GParamSpec * pspec);
  85 static void gst_cacasink_get_property (GObject * object, guint prop_id,
  86     GValue * value, GParamSpec * pspec);
  87
  88 static GstStateChangeReturn gst_cacasink_change_state (GstElement * element,
  89     GstStateChange transition);
  90
  91 #define gst_cacasink_parent_class parent_class
  92 G_DEFINE_TYPE (GstCACASink, gst_cacasink, GST_TYPE_BASE_SINK);
  93
  94 #define GST_TYPE_CACADITHER (gst_cacasink_dither_get_type())
  95 static GType
  96 gst_cacasink_dither_get_type (void)
  97 {
  98   static GType dither_type = 0;
  99
 100   static const GEnumValue dither_types[] = {
 101     {CACA_DITHERING_NONE, "No dithering", "none"},
 102     {CACA_DITHERING_ORDERED2, "Ordered 2x2 Bayer dithering", "2x2"},
 103     {CACA_DITHERING_ORDERED4, "Ordered 4x4 Bayer dithering", "4x4"},
 104     {CACA_DITHERING_ORDERED8, "Ordered 8x8 Bayer dithering", "8x8"},
 105     {CACA_DITHERING_RANDOM, "Random dithering", "random"},
 106     {0, NULL, NULL},
 107   };
 108
 109   if (!dither_type) {
 110     dither_type = g_enum_register_static ("GstCACASinkDithering", dither_types);
 111   }
 112   return dither_type;
 113 }
 114
 115 static void
 116 gst_cacasink_class_init (GstCACASinkClass * klass)
 117 {
 118   GObjectClass *gobject_class;
 119   GstElementClass *gstelement_class;
 120   GstBaseSinkClass *gstbasesink_class;
 121
 122   gobject_class = (GObjectClass *) klass;
 123   gstelement_class = (GstElementClass *) klass;
 124   gstbasesink_class = (GstBaseSinkClass *) klass;
 125
 126   parent_class = g_type_class_peek_parent (klass);
 127
 128   gobject_class->set_property = gst_cacasink_set_property;
 129   gobject_class->get_property = gst_cacasink_get_property;
 130
 131   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SCREEN_WIDTH,
 132       g_param_spec_int ("screen-width", "Screen Width",
 133           "The width of the screen", 0, G_MAXINT, GST_CACA_DEFAULT_SCREEN_WIDTH,
 134           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 135   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SCREEN_HEIGHT,
 136       g_param_spec_int ("screen-height", "Screen Height",
 137           "The height of the screen", 0, G_MAXINT,
 138           GST_CACA_DEFAULT_SCREEN_HEIGHT,
 139           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 140   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DITHER,
 141       g_param_spec_enum ("dither", "Dither Type", "Set type of Dither",
 142           GST_TYPE_CACADITHER, GST_CACA_DEFAULT_DITHER,
 143           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 144   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_ANTIALIASING,
 145       g_param_spec_boolean ("anti-aliasing", "Anti Aliasing",
 146           "Enables Anti-Aliasing", GST_CACA_DEFAULT_ANTIALIASING,
 147           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 148
 149   gstelement_class->change_state = gst_cacasink_change_state;
 150
 151   gst_element_class_set_details_simple (gstelement_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_pad_template (gstelement_class,
 155       gst_static_pad_template_get (&sink_template));
 156
 157   gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_cacasink_setcaps);
 158   gstbasesink_class->get_times = GST_DEBUG_FUNCPTR (gst_cacasink_get_times);
 159   gstbasesink_class->preroll = GST_DEBUG_FUNCPTR (gst_cacasink_render);
 160   gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_cacasink_render);
 161 }
 162
 163 static void
 164 gst_cacasink_get_times (GstBaseSink * sink, GstBuffer * buffer,
 165     GstClockTime * start, GstClockTime * end)
 166 {
 167   *start = GST_BUFFER_TIMESTAMP (buffer);
 168   *end = *start + GST_BUFFER_DURATION (buffer);
 169 }
 170
 171 static gboolean
 172 gst_cacasink_setcaps (GstBaseSink * basesink, GstCaps * caps)
 173 {
 174   GstCACASink *cacasink;
 175   GstVideoInfo info;
 176   guint bpp, red_mask, green_mask, blue_mask;
 177
 178   cacasink = GST_CACASINK (basesink);
 179
 180   if (!gst_video_info_from_caps (&info, caps))
 181     goto caps_error;
 182
 183
 184   switch (GST_VIDEO_INFO_FORMAT (&info)) {
 185     case GST_VIDEO_FORMAT_RGB:
 186       bpp = 24;
 187       red_mask = 0xff0000;
 188       green_mask = 0x00ff00;
 189       blue_mask = 0x0000ff;
 190       break;
 191     case GST_VIDEO_FORMAT_RGBx:
 192       bpp = 32;
 193       red_mask = 0xff000000;
 194       green_mask = 0x00ff0000;
 195       blue_mask = 0x0000ff00;
 196       break;
 197     case GST_VIDEO_FORMAT_RGB16:
 198       bpp = 16;
 199       red_mask = 0xf800;
 200       green_mask = 0x07e0;
 201       blue_mask = 0x001f;
 202       break;
 203     case GST_VIDEO_FORMAT_RGB15:
 204       bpp = 16;
 205       red_mask = 0x7c00;
 206       green_mask = 0x03e0;
 207       blue_mask = 0x001f;
 208       break;
 209     default:
 210       goto invalid_format;
 211   }
 212
 213   if (cacasink->bitmap) {
 214     caca_free_bitmap (cacasink->bitmap);
 215   }
 216   cacasink->bitmap = caca_create_bitmap (bpp,
 217       GST_VIDEO_INFO_WIDTH (&info),
 218       GST_VIDEO_INFO_HEIGHT (&info),
 219       GST_ROUND_UP_4 (GST_VIDEO_INFO_WIDTH (&info) * bpp / 8),
 220       red_mask, green_mask, blue_mask, 0);
 221   if (!cacasink->bitmap)
 222     goto no_bitmap;
 223
 224   cacasink->info = info;
 225
 226   return TRUE;
 227
 228   /* ERROS */
 229 caps_error:
 230   {
 231     GST_ERROR_OBJECT (cacasink, "error parsing caps");
 232     return FALSE;
 233   }
 234 invalid_format:
 235   {
 236     GST_ERROR_OBJECT (cacasink, "invalid format");
 237     return FALSE;
 238   }
 239 no_bitmap:
 240   {
 241     GST_ERROR_OBJECT (cacasink, "could not create bitmap");
 242     return FALSE;
 243   }
 244 }
 245
 246 static void
 247 gst_cacasink_init (GstCACASink * cacasink)
 248 {
 249   cacasink->screen_width = GST_CACA_DEFAULT_SCREEN_WIDTH;
 250   cacasink->screen_height = GST_CACA_DEFAULT_SCREEN_HEIGHT;
 251
 252   cacasink->dither = GST_CACA_DEFAULT_DITHER;
 253   cacasink->antialiasing = GST_CACA_DEFAULT_ANTIALIASING;
 254 }
 255
 256 static GstFlowReturn
 257 gst_cacasink_render (GstBaseSink * basesink, GstBuffer * buffer)
 258 {
 259   GstCACASink *cacasink = GST_CACASINK (basesink);
 260   GstVideoFrame frame;
 261
 262   GST_DEBUG ("render");
 263
 264   if (!gst_video_frame_map (&frame, &cacasink->info, buffer, GST_MAP_READ))
 265     goto invalid_frame;
 266
 267   caca_clear ();
 268   caca_draw_bitmap (0, 0, cacasink->screen_width - 1,
 269       cacasink->screen_height - 1, cacasink->bitmap,
 270       GST_VIDEO_FRAME_PLANE_DATA (&frame, 0));
 271   caca_refresh ();
 272
 273   gst_video_frame_unmap (&frame);
 274
 275   return GST_FLOW_OK;
 276
 277   /* ERRORS */
 278 invalid_frame:
 279   {
 280     GST_ERROR_OBJECT (cacasink, "invalid frame received");
 281     return GST_FLOW_ERROR;
 282   }
 283 }
 284
 285 static void
 286 gst_cacasink_set_property (GObject * object, guint prop_id,
 287     const GValue * value, GParamSpec * pspec)
 288 {
 289   GstCACASink *cacasink;
 290
 291   g_return_if_fail (GST_IS_CACASINK (object));
 292
 293   cacasink = GST_CACASINK (object);
 294
 295   switch (prop_id) {
 296     case PROP_DITHER:{
 297       cacasink->dither = g_value_get_enum (value);
 298       caca_set_dithering (cacasink->dither + CACA_DITHERING_NONE);
 299       break;
 300     }
 301     case PROP_ANTIALIASING:{
 302       cacasink->antialiasing = g_value_get_boolean (value);
 303       if (cacasink->antialiasing) {
 304         caca_set_feature (CACA_ANTIALIASING_MAX);
 305       } else {
 306         caca_set_feature (CACA_ANTIALIASING_MIN);
 307       }
 308       break;
 309     }
 310     default:
 311       break;
 312   }
 313 }
 314
 315 static void
 316 gst_cacasink_get_property (GObject * object, guint prop_id, GValue * value,
 317     GParamSpec * pspec)
 318 {
 319   GstCACASink *cacasink;
 320
 321   cacasink = GST_CACASINK (object);
 322
 323   switch (prop_id) {
 324     case PROP_SCREEN_WIDTH:{
 325       g_value_set_int (value, cacasink->screen_width);
 326       break;
 327     }
 328     case PROP_SCREEN_HEIGHT:{
 329       g_value_set_int (value, cacasink->screen_height);
 330       break;
 331     }
 332     case PROP_DITHER:{
 333       g_value_set_enum (value, cacasink->dither);
 334       break;
 335     }
 336     case PROP_ANTIALIASING:{
 337       g_value_set_boolean (value, cacasink->antialiasing);
 338       break;
 339     }
 340     default:{
 341       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 342       break;
 343     }
 344   }
 345 }
 346
 347 static gboolean
 348 gst_cacasink_open (GstCACASink * cacasink)
 349 {
 350   cacasink->bitmap = NULL;
 351
 352   if (caca_init () < 0)
 353     goto init_failed;
 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   /* ERRORS */
 365 init_failed:
 366   {
 367     GST_ELEMENT_ERROR (cacasink, RESOURCE, OPEN_WRITE, (NULL),
 368         ("caca_init() failed"));
 369     return FALSE;
 370   }
 371 }
 372
 373 static void
 374 gst_cacasink_close (GstCACASink * cacasink)
 375 {
 376   if (cacasink->bitmap) {
 377     caca_free_bitmap (cacasink->bitmap);
 378     cacasink->bitmap = NULL;
 379   }
 380   caca_end ();
 381 }
 382
 383 static GstStateChangeReturn
 384 gst_cacasink_change_state (GstElement * element, GstStateChange transition)
 385 {
 386   GstStateChangeReturn ret;
 387
 388   switch (transition) {
 389     case GST_STATE_CHANGE_READY_TO_PAUSED:
 390       if (!gst_cacasink_open (GST_CACASINK (element)))
 391         return GST_STATE_CHANGE_FAILURE;
 392       break;
 393     default:
 394       break;
 395   }
 396
 397   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 398
 399   switch (transition) {
 400     case GST_STATE_CHANGE_PAUSED_TO_READY:
 401       gst_cacasink_close (GST_CACASINK (element));
 402       break;
 403     default:
 404       break;
 405   }
 406   return ret;
 407 }
 408
 409 static gboolean
 410 plugin_init (GstPlugin * plugin)
 411 {
 412   if (!gst_element_register (plugin, "cacasink", GST_RANK_NONE,
 413           GST_TYPE_CACASINK))
 414     return FALSE;
 415
 416   return TRUE;
 417 }
 418
 419 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
 420     GST_VERSION_MINOR,
 421     "cacasink",
 422     "Colored ASCII Art video sink",
 423     plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)