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