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