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 #ifdef HAVE_CONFIG_H
  21 #include "config.h"
  22 #endif
  23
  24 #include <string.h>
  25 #include <sys/time.h>
  26 #include <gst/navigation/navigation.h>
  27
  28 #include "gstcacasink.h"
  29
  30 /* elementfactory information */
  31 static GstElementDetails gst_cacasink_details = {
  32   "CACA sink",
  33   "Sink/Video",
  34   "A colored ASCII art videosink",
  35   "Zeeshan Ali <zak147@yahoo.com>"
  36 };
  37
  38 /* cacasink signals and args */
  39 enum
  40 {
  41   LAST_SIGNAL
  42 };
  43
  44
  45 enum
  46 {
  47   ARG_0,
  48   ARG_SCREEN_WIDTH,
  49   ARG_SCREEN_HEIGHT,
  50   ARG_DITHER,
  51   ARG_ANTIALIASING
  52 };
  53
  54 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
  55     GST_PAD_SINK,
  56     GST_PAD_ALWAYS,
  57     GST_STATIC_CAPS (GST_VIDEO_CAPS_RGB ";" GST_VIDEO_CAPS_RGBx ";"
  58         GST_VIDEO_CAPS_RGB_16 ";" GST_VIDEO_CAPS_RGB_15)
  59     );
  60
  61 static void gst_cacasink_base_init (gpointer g_class);
  62 static void gst_cacasink_class_init (GstCACASinkClass * klass);
  63 static void gst_cacasink_init (GstCACASink * cacasink);
  64 static void gst_cacasink_interface_init (GstImplementsInterfaceClass * klass);
  65 static gboolean gst_cacasink_interface_supported (GstImplementsInterface *
  66     iface, GType type);
  67 static void gst_cacasink_navigation_init (GstNavigationInterface * iface);
  68 static void gst_cacasink_navigation_send_event (GstNavigation * navigation,
  69     GstStructure * structure);
  70
  71 static void gst_cacasink_chain (GstPad * pad, GstData * _data);
  72
  73 static void gst_cacasink_set_property (GObject * object, guint prop_id,
  74     const GValue * value, GParamSpec * pspec);
  75 static void gst_cacasink_get_property (GObject * object, guint prop_id,
  76     GValue * value, GParamSpec * pspec);
  77 static void gst_cacasink_dispose (GObject * object);
  78
  79 static GstElementStateReturn gst_cacasink_change_state (GstElement * element);
  80
  81 static GstElementClass *parent_class = NULL;
  82
  83 GType
  84 gst_cacasink_get_type (void)
  85 {
  86   static GType cacasink_type = 0;
  87
  88   if (!cacasink_type) {
  89     static const GTypeInfo cacasink_info = {
  90       sizeof (GstCACASinkClass),
  91       gst_cacasink_base_init,
  92       NULL,
  93       (GClassInitFunc) gst_cacasink_class_init,
  94       NULL,
  95       NULL,
  96       sizeof (GstCACASink),
  97       0,
  98       (GInstanceInitFunc) gst_cacasink_init,
  99     };
 100
 101     static const GInterfaceInfo iface_info = {
 102       (GInterfaceInitFunc) gst_cacasink_interface_init,
 103       NULL,
 104       NULL,
 105     };
 106
 107     static const GInterfaceInfo navigation_info = {
 108       (GInterfaceInitFunc) gst_cacasink_navigation_init,
 109       NULL,
 110       NULL,
 111     };
 112
 113     cacasink_type =
 114         g_type_register_static (GST_TYPE_VIDEOSINK, "GstCACASink",
 115         &cacasink_info, 0);
 116
 117     g_type_add_interface_static (cacasink_type, GST_TYPE_IMPLEMENTS_INTERFACE,
 118         &iface_info);
 119     g_type_add_interface_static (cacasink_type, GST_TYPE_NAVIGATION,
 120         &navigation_info);
 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   if (!dither_type) {
 132     GEnumValue *dithers;
 133     gint n_dithers;
 134     gint i;
 135     gchar *caca_dithernames[] = {
 136       "NONE", "ORDERED2", "ORDERED4", "ORDERED8", "RANDOM", NULL
 137     };
 138
 139     n_dithers = 5;
 140
 141     dithers = g_new0 (GEnumValue, n_dithers + 1);
 142
 143     for (i = 0; i < n_dithers; i++) {
 144       dithers[i].value = i;
 145       dithers[i].value_name = g_strdup (caca_dithernames[i]);
 146       dithers[i].value_nick = g_strdup (caca_dithernames[i]);
 147     }
 148     dithers[i].value = 0;
 149     dithers[i].value_name = NULL;
 150     dithers[i].value_nick = NULL;
 151
 152     dither_type = g_enum_register_static ("GstCACASinkDithers", dithers);
 153   }
 154   return dither_type;
 155 }
 156
 157 static void
 158 gst_cacasink_base_init (gpointer g_class)
 159 {
 160   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 161
 162   gst_element_class_set_details (element_class, &gst_cacasink_details);
 163   gst_element_class_add_pad_template (element_class,
 164       gst_static_pad_template_get (&sink_template));
 165 }
 166
 167 static void
 168 gst_cacasink_class_init (GstCACASinkClass * klass)
 169 {
 170   GObjectClass *gobject_class;
 171   GstElementClass *gstelement_class;
 172   GstVideoSinkClass *gstvs_class;
 173
 174   gobject_class = (GObjectClass *) klass;
 175   gstelement_class = (GstElementClass *) klass;
 176   gstvs_class = (GstVideoSinkClass *) klass;
 177
 178   parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
 179
 180   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SCREEN_WIDTH, g_param_spec_int ("screen_width", "screen_width", "screen_width", G_MININT, G_MAXINT, 0, G_PARAM_READABLE));       /* CHECKME */
 181   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SCREEN_HEIGHT, g_param_spec_int ("screen_height", "screen_height", "screen_height", G_MININT, G_MAXINT, 0, G_PARAM_READABLE));   /* CHECKME */
 182   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_DITHER,
 183       g_param_spec_enum ("dither", "Dither Type", "Set type of Dither",
 184           GST_TYPE_CACADITHER, 0, G_PARAM_READWRITE));
 185   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_ANTIALIASING,
 186       g_param_spec_boolean ("anti_aliasing", "Anti-Aliasing",
 187           "Enables Anti-Aliasing", TRUE, G_PARAM_READWRITE));
 188
 189   gobject_class->set_property = gst_cacasink_set_property;
 190   gobject_class->get_property = gst_cacasink_get_property;
 191   gobject_class->dispose = gst_cacasink_dispose;
 192
 193   gstelement_class->change_state = gst_cacasink_change_state;
 194 }
 195
 196 static void
 197 gst_cacasink_interface_init (GstImplementsInterfaceClass * klass)
 198 {
 199   klass->supported = gst_cacasink_interface_supported;
 200 }
 201
 202 static gboolean
 203 gst_cacasink_interface_supported (GstImplementsInterface * iface, GType type)
 204 {
 205   g_assert (type == GST_TYPE_NAVIGATION);
 206
 207   return (GST_STATE (iface) != GST_STATE_NULL);
 208 }
 209
 210 static void
 211 gst_cacasink_navigation_init (GstNavigationInterface * iface)
 212 {
 213   iface->send_event = gst_cacasink_navigation_send_event;
 214 }
 215
 216 static void
 217 gst_cacasink_navigation_send_event (GstNavigation * navigation,
 218     GstStructure * structure)
 219 {
 220   GstCACASink *cacasink = GST_CACASINK (navigation);
 221   GstEvent *event;
 222
 223   event = gst_event_new (GST_EVENT_NAVIGATION);
 224   /*GST_EVENT_TIMESTAMP (event) = 0; */
 225   event->event_data.structure.structure = structure;
 226
 227   /* FIXME
 228    * Obviously, the pointer x,y coordinates need to be adjusted by the
 229    * window size and relation to the bounding window. */
 230
 231   gst_pad_send_event (gst_pad_get_peer (GST_VIDEOSINK_PAD (cacasink)), event);
 232 }
 233
 234 static GstPadLinkReturn
 235 gst_cacasink_sinkconnect (GstPad * pad, const GstCaps * caps)
 236 {
 237   GstCACASink *cacasink;
 238   GstStructure *structure;
 239
 240   cacasink = GST_CACASINK (gst_pad_get_parent (pad));
 241
 242   /*if (!GST_CAPS_IS_FIXED (caps))
 243      return GST_PAD_LINK_DELAYED; */
 244
 245   structure = gst_caps_get_structure (caps, 0);
 246   gst_structure_get_int (structure, "width", &(GST_VIDEOSINK_WIDTH (cacasink)));
 247   gst_structure_get_int (structure, "height",
 248       &(GST_VIDEOSINK_HEIGHT (cacasink)));
 249   gst_structure_get_int (structure, "bpp", &cacasink->bpp);
 250   gst_structure_get_int (structure, "red_mask", &cacasink->red_mask);
 251   gst_structure_get_int (structure, "green_mask", &cacasink->green_mask);
 252   gst_structure_get_int (structure, "blue_mask", &cacasink->blue_mask);
 253
 254   if (cacasink->bpp == 24) {
 255     cacasink->red_mask = GUINT32_FROM_BE (cacasink->red_mask) >> 8;
 256     cacasink->green_mask = GUINT32_FROM_BE (cacasink->green_mask) >> 8;
 257     cacasink->blue_mask = GUINT32_FROM_BE (cacasink->blue_mask) >> 8;
 258   }
 259
 260   else if (cacasink->bpp == 32) {
 261     cacasink->red_mask = GUINT32_FROM_BE (cacasink->red_mask);
 262     cacasink->green_mask = GUINT32_FROM_BE (cacasink->green_mask);
 263     cacasink->blue_mask = GUINT32_FROM_BE (cacasink->blue_mask);
 264   }
 265
 266   else if (cacasink->bpp == 16 || cacasink->bpp == 15) {
 267     cacasink->red_mask = GUINT16_FROM_BE (cacasink->red_mask);
 268     cacasink->green_mask = GUINT16_FROM_BE (cacasink->green_mask);
 269     cacasink->blue_mask = GUINT16_FROM_BE (cacasink->blue_mask);
 270   }
 271
 272   if (cacasink->bitmap) {
 273     caca_free_bitmap (cacasink->bitmap);
 274   }
 275
 276   cacasink->bitmap = caca_create_bitmap (cacasink->bpp,
 277       GST_VIDEOSINK_WIDTH (cacasink),
 278       GST_VIDEOSINK_HEIGHT (cacasink),
 279       GST_VIDEOSINK_WIDTH (cacasink) * cacasink->bpp / 8,
 280       cacasink->red_mask, cacasink->green_mask, cacasink->blue_mask, 0);
 281
 282   if (!cacasink->bitmap) {
 283     return GST_PAD_LINK_DELAYED;
 284   }
 285
 286   return GST_PAD_LINK_OK;
 287 }
 288
 289 static void
 290 gst_cacasink_init (GstCACASink * cacasink)
 291 {
 292   GST_VIDEOSINK_PAD (cacasink) =
 293       gst_pad_new_from_template (gst_static_pad_template_get (&sink_template),
 294       "sink");
 295   gst_element_add_pad (GST_ELEMENT (cacasink), GST_VIDEOSINK_PAD (cacasink));
 296   gst_pad_set_chain_function (GST_VIDEOSINK_PAD (cacasink), gst_cacasink_chain);
 297   gst_pad_set_link_function (GST_VIDEOSINK_PAD (cacasink),
 298       gst_cacasink_sinkconnect);
 299
 300   cacasink->screen_width = GST_CACA_DEFAULT_SCREEN_WIDTH;
 301   cacasink->screen_height = GST_CACA_DEFAULT_SCREEN_HEIGHT;
 302   cacasink->bpp = GST_CACA_DEFAULT_BPP;
 303   cacasink->red_mask = GST_CACA_DEFAULT_RED_MASK;
 304   cacasink->green_mask = GST_CACA_DEFAULT_GREEN_MASK;
 305   cacasink->blue_mask = GST_CACA_DEFAULT_BLUE_MASK;
 306
 307   cacasink->bitmap = NULL;
 308   caca_init ();
 309
 310   cacasink->screen_width = caca_get_width ();
 311   cacasink->screen_height = caca_get_height ();
 312   cacasink->antialiasing = TRUE;
 313   caca_set_feature (CACA_ANTIALIASING_MAX);
 314   cacasink->dither = 0;
 315   caca_set_dithering (CACA_DITHERING_NONE);
 316
 317   GST_FLAG_SET (cacasink, GST_ELEMENT_THREAD_SUGGESTED);
 318 }
 319
 320 static void
 321 gst_cacasink_chain (GstPad * pad, GstData * _data)
 322 {
 323   GstBuffer *buf = GST_BUFFER (_data);
 324   GstCACASink *cacasink;
 325   GstClockTime time = GST_BUFFER_TIMESTAMP (buf);
 326   gint64 jitter;
 327
 328   g_return_if_fail (pad != NULL);
 329   g_return_if_fail (GST_IS_PAD (pad));
 330   g_return_if_fail (buf != NULL);
 331
 332   cacasink = GST_CACASINK (gst_pad_get_parent (pad));
 333
 334   if (cacasink->id && GST_CLOCK_TIME_IS_VALID (time)) {
 335     GST_DEBUG ("videosink: clock %s wait: %" G_GUINT64_FORMAT " %u",
 336         GST_OBJECT_NAME (GST_VIDEOSINK_CLOCK (cacasink)),
 337         time, GST_BUFFER_SIZE (buf));
 338     gst_element_wait (GST_ELEMENT (cacasink), GST_BUFFER_TIMESTAMP (buf));
 339   }
 340
 341   caca_clear ();
 342   caca_draw_bitmap (0, 0, cacasink->screen_width - 1,
 343       cacasink->screen_height - 1, cacasink->bitmap, GST_BUFFER_DATA (buf));
 344   caca_refresh ();
 345
 346   if (GST_VIDEOSINK_CLOCK (cacasink)) {
 347     jitter = gst_clock_get_time (GST_VIDEOSINK_CLOCK (cacasink)) - time;
 348
 349     cacasink->correction = (cacasink->correction + jitter) >> 1;
 350     cacasink->correction = 0;
 351   }
 352
 353   gst_buffer_unref (buf);
 354 }
 355
 356
 357 static void
 358 gst_cacasink_dispose (GObject * object)
 359 {
 360   GstCACASink *cacasink = GST_CACASINK (object);
 361
 362   if (cacasink->bitmap) {
 363     caca_free_bitmap (cacasink->bitmap);
 364   }
 365
 366   caca_end ();
 367
 368   G_OBJECT_CLASS (parent_class)->dispose (object);
 369 }
 370
 371 static void
 372 gst_cacasink_set_property (GObject * object, guint prop_id,
 373     const GValue * value, GParamSpec * pspec)
 374 {
 375   GstCACASink *cacasink;
 376
 377   /* it's not null if we got it, but it might not be ours */
 378   g_return_if_fail (GST_IS_CACASINK (object));
 379
 380   cacasink = GST_CACASINK (object);
 381
 382   switch (prop_id) {
 383     case ARG_DITHER:{
 384       cacasink->dither = g_value_get_enum (value);
 385       caca_set_dithering (cacasink->dither + CACA_DITHERING_NONE);
 386       break;
 387     }
 388     case ARG_ANTIALIASING:{
 389       cacasink->antialiasing = g_value_get_boolean (value);
 390       if (cacasink->antialiasing) {
 391         caca_set_feature (CACA_ANTIALIASING_MAX);
 392       }
 393
 394       else {
 395         caca_set_feature (CACA_ANTIALIASING_MIN);
 396       }
 397       break;
 398     }
 399     default:
 400       break;
 401   }
 402 }
 403
 404 static void
 405 gst_cacasink_get_property (GObject * object, guint prop_id, GValue * value,
 406     GParamSpec * pspec)
 407 {
 408   GstCACASink *cacasink;
 409
 410   /* it's not null if we got it, but it might not be ours */
 411   cacasink = GST_CACASINK (object);
 412
 413   switch (prop_id) {
 414     case ARG_SCREEN_WIDTH:{
 415       g_value_set_int (value, cacasink->screen_width);
 416       break;
 417     }
 418     case ARG_SCREEN_HEIGHT:{
 419       g_value_set_int (value, cacasink->screen_height);
 420       break;
 421     }
 422     case ARG_DITHER:{
 423       g_value_set_enum (value, cacasink->dither);
 424       break;
 425     }
 426     case ARG_ANTIALIASING:{
 427       g_value_set_boolean (value, cacasink->antialiasing);
 428       break;
 429     }
 430     default:{
 431       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 432       break;
 433     }
 434   }
 435 }
 436
 437 static gboolean
 438 gst_cacasink_open (GstCACASink * cacasink)
 439 {
 440   g_return_val_if_fail (!GST_FLAG_IS_SET (cacasink, GST_CACASINK_OPEN), FALSE);
 441
 442   GST_FLAG_SET (cacasink, GST_CACASINK_OPEN);
 443
 444   return TRUE;
 445 }
 446
 447 static void
 448 gst_cacasink_close (GstCACASink * cacasink)
 449 {
 450   g_return_if_fail (GST_FLAG_IS_SET (cacasink, GST_CACASINK_OPEN));
 451
 452   GST_FLAG_UNSET (cacasink, GST_CACASINK_OPEN);
 453 }
 454
 455 static GstElementStateReturn
 456 gst_cacasink_change_state (GstElement * element)
 457 {
 458   g_return_val_if_fail (GST_IS_CACASINK (element), GST_STATE_FAILURE);
 459
 460   if (GST_STATE_PENDING (element) == GST_STATE_NULL) {
 461     if (GST_FLAG_IS_SET (element, GST_CACASINK_OPEN))
 462       gst_cacasink_close (GST_CACASINK (element));
 463   } else {
 464     if (!GST_FLAG_IS_SET (element, GST_CACASINK_OPEN)) {
 465       if (!gst_cacasink_open (GST_CACASINK (element)))
 466         return GST_STATE_FAILURE;
 467     }
 468   }
 469
 470   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 471     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
 472
 473   return GST_STATE_SUCCESS;
 474 }
 475
 476 static gboolean
 477 plugin_init (GstPlugin * plugin)
 478 {
 479   /* Loading the library containing GstVideoSink, our parent object */
 480   if (!gst_library_load ("gstvideo"))
 481     return FALSE;
 482
 483   if (!gst_element_register (plugin, "cacasink", GST_RANK_NONE,
 484           GST_TYPE_CACASINK))
 485     return FALSE;
 486
 487   return TRUE;
 488 }
 489
 490 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
 491     GST_VERSION_MINOR,
 492     "cacasink",
 493     "Colored ASCII Art video sink",
 494     plugin_init, VERSION, GST_LICENSE, GST_PACKAGE, GST_ORIGIN)