ext/aalib/gstaasink.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-aasink
  21  * @see_also: #GstCACASink
  22  *
  23  * Displays video as b/w ascii art.
  24  *
  25  * <refsect2>
  26  * <title>Example launch line</title>
  27  * |[
  28  * gst-launch filesrc location=test.avi ! decodebin ! ffmpegcolorspace ! aasink
  29  * ]| This pipeline renders a video to ascii art into a separate window.
  30  * |[
  31  * gst-launch filesrc location=test.avi ! decodebin ! ffmpegcolorspace ! aasink driver=curses
  32  * ]| This pipeline renders a video to ascii art into the current terminal.
  33  * </refsect2>
  34  */
  35
  36 #ifdef HAVE_CONFIG_H
  37 #include "config.h"
  38 #endif
  39
  40 #include <string.h>
  41 #include <sys/time.h>
  42
  43 #include "gstaasink.h"
  44 #include <gst/video/video.h>
  45
  46 /* aasink signals and args */
  47 enum
  48 {
  49   SIGNAL_FRAME_DISPLAYED,
  50   SIGNAL_HAVE_SIZE,
  51   LAST_SIGNAL
  52 };
  53
  54
  55 enum
  56 {
  57   ARG_0,
  58   ARG_WIDTH,
  59   ARG_HEIGHT,
  60   ARG_DRIVER,
  61   ARG_DITHER,
  62   ARG_BRIGHTNESS,
  63   ARG_CONTRAST,
  64   ARG_GAMMA,
  65   ARG_INVERSION,
  66   ARG_RANDOMVAL,
  67   ARG_FRAMES_DISPLAYED,
  68   ARG_FRAME_TIME
  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_YUV ("I420"))
  75     );
  76
  77 static void gst_aasink_base_init (gpointer g_class);
  78 static void gst_aasink_class_init (GstAASinkClass * klass);
  79 static void gst_aasink_init (GstAASink * aasink);
  80
  81 static gboolean gst_aasink_setcaps (GstBaseSink * pad, GstCaps * caps);
  82 static void gst_aasink_get_times (GstBaseSink * sink, GstBuffer * buffer,
  83     GstClockTime * start, GstClockTime * end);
  84 static GstFlowReturn gst_aasink_render (GstBaseSink * basesink,
  85     GstBuffer * buffer);
  86
  87 static void gst_aasink_set_property (GObject * object, guint prop_id,
  88     const GValue * value, GParamSpec * pspec);
  89 static void gst_aasink_get_property (GObject * object, guint prop_id,
  90     GValue * value, GParamSpec * pspec);
  91
  92 static GstStateChangeReturn gst_aasink_change_state (GstElement * element,
  93     GstStateChange transition);
  94
  95 static GstElementClass *parent_class = NULL;
  96 static guint gst_aasink_signals[LAST_SIGNAL] = { 0 };
  97
  98 GType
  99 gst_aasink_get_type (void)
 100 {
 101   static GType aasink_type = 0;
 102
 103   if (!aasink_type) {
 104     static const GTypeInfo aasink_info = {
 105       sizeof (GstAASinkClass),
 106       gst_aasink_base_init,
 107       NULL,
 108       (GClassInitFunc) gst_aasink_class_init,
 109       NULL,
 110       NULL,
 111       sizeof (GstAASink),
 112       0,
 113       (GInstanceInitFunc) gst_aasink_init,
 114     };
 115
 116     aasink_type =
 117         g_type_register_static (GST_TYPE_BASE_SINK, "GstAASink", &aasink_info,
 118         0);
 119   }
 120   return aasink_type;
 121 }
 122
 123 #define GST_TYPE_AADRIVERS (gst_aasink_drivers_get_type())
 124 static GType
 125 gst_aasink_drivers_get_type (void)
 126 {
 127   static GType driver_type = 0;
 128
 129   if (!driver_type) {
 130     GEnumValue *drivers;
 131     const struct aa_driver *driver;
 132     gint n_drivers;
 133     gint i;
 134
 135     for (n_drivers = 0; aa_drivers[n_drivers]; n_drivers++) {
 136       /* count number of drivers */
 137     }
 138
 139     drivers = g_new0 (GEnumValue, n_drivers + 1);
 140
 141     for (i = 0; i < n_drivers; i++) {
 142       driver = aa_drivers[i];
 143       drivers[i].value = i;
 144       drivers[i].value_name = g_strdup (driver->name);
 145       drivers[i].value_nick = g_utf8_strdown (driver->shortname, -1);
 146     }
 147     drivers[i].value = 0;
 148     drivers[i].value_name = NULL;
 149     drivers[i].value_nick = NULL;
 150
 151     driver_type = g_enum_register_static ("GstAASinkDrivers", drivers);
 152   }
 153   return driver_type;
 154 }
 155
 156 #define GST_TYPE_AADITHER (gst_aasink_dither_get_type())
 157 static GType
 158 gst_aasink_dither_get_type (void)
 159 {
 160   static GType dither_type = 0;
 161
 162   if (!dither_type) {
 163     GEnumValue *ditherers;
 164     gint n_ditherers;
 165     gint i;
 166
 167     for (n_ditherers = 0; aa_dithernames[n_ditherers]; n_ditherers++) {
 168       /* count number of ditherers */
 169     }
 170
 171     ditherers = g_new0 (GEnumValue, n_ditherers + 1);
 172
 173     for (i = 0; i < n_ditherers; i++) {
 174       ditherers[i].value = i;
 175       ditherers[i].value_name = g_strdup (aa_dithernames[i]);
 176       ditherers[i].value_nick =
 177           g_strdelimit (g_strdup (aa_dithernames[i]), " _", '-');
 178     }
 179     ditherers[i].value = 0;
 180     ditherers[i].value_name = NULL;
 181     ditherers[i].value_nick = NULL;
 182
 183     dither_type = g_enum_register_static ("GstAASinkDitherers", ditherers);
 184   }
 185   return dither_type;
 186 }
 187
 188 static void
 189 gst_aasink_base_init (gpointer g_class)
 190 {
 191   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 192
 193   gst_element_class_add_pad_template (element_class,
 194       gst_static_pad_template_get (&sink_template));
 195   gst_element_class_set_details_simple (element_class, "ASCII art video sink",
 196       "Sink/Video",
 197       "An ASCII art videosink", "Wim Taymans <wim.taymans@chello.be>");
 198 }
 199
 200 static void
 201 gst_aasink_class_init (GstAASinkClass * klass)
 202 {
 203   GObjectClass *gobject_class;
 204   GstElementClass *gstelement_class;
 205   GstBaseSinkClass *gstbasesink_class;
 206
 207   gobject_class = (GObjectClass *) klass;
 208   gstelement_class = (GstElementClass *) klass;
 209   gstbasesink_class = (GstBaseSinkClass *) klass;
 210
 211   parent_class = g_type_class_peek_parent (klass);
 212
 213   gobject_class->set_property = gst_aasink_set_property;
 214   gobject_class->get_property = gst_aasink_get_property;
 215
 216   /* FIXME: add long property descriptions */
 217   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_WIDTH,
 218       g_param_spec_int ("width", "width", "width", G_MININT, G_MAXINT, 0,
 219           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 220   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_HEIGHT,
 221       g_param_spec_int ("height", "height", "height", G_MININT, G_MAXINT, 0,
 222           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 223   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_DRIVER,
 224       g_param_spec_enum ("driver", "driver", "driver", GST_TYPE_AADRIVERS, 0,
 225           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 226   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_DITHER,
 227       g_param_spec_enum ("dither", "dither", "dither", GST_TYPE_AADITHER, 0,
 228           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 229   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_BRIGHTNESS,
 230       g_param_spec_int ("brightness", "brightness", "brightness", G_MININT,
 231           G_MAXINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 232   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_CONTRAST,
 233       g_param_spec_int ("contrast", "contrast", "contrast", G_MININT, G_MAXINT,
 234           0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 235   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_GAMMA,
 236       g_param_spec_float ("gamma", "gamma", "gamma", 0.0, 5.0, 1.0,
 237           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 238   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_INVERSION,
 239       g_param_spec_boolean ("inversion", "inversion", "inversion", TRUE,
 240           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 241   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_RANDOMVAL,
 242       g_param_spec_int ("randomval", "randomval", "randomval", G_MININT,
 243           G_MAXINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 244   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_FRAMES_DISPLAYED,
 245       g_param_spec_int ("frames-displayed", "frames displayed",
 246           "frames displayed", G_MININT, G_MAXINT, 0,
 247           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 248   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_FRAME_TIME,
 249       g_param_spec_int ("frame-time", "frame time", "frame time", G_MININT,
 250           G_MAXINT, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 251
 252   gst_aasink_signals[SIGNAL_FRAME_DISPLAYED] =
 253       g_signal_new ("frame-displayed", G_TYPE_FROM_CLASS (klass),
 254       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstAASinkClass, frame_displayed),
 255       NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 256   gst_aasink_signals[SIGNAL_HAVE_SIZE] =
 257       g_signal_new ("have-size", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 258       G_STRUCT_OFFSET (GstAASinkClass, have_size), NULL, NULL,
 259       gst_marshal_VOID__INT_INT, G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
 260
 261   gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_aasink_change_state);
 262
 263   gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_aasink_setcaps);
 264   gstbasesink_class->get_times = GST_DEBUG_FUNCPTR (gst_aasink_get_times);
 265   gstbasesink_class->preroll = GST_DEBUG_FUNCPTR (gst_aasink_render);
 266   gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_aasink_render);
 267 }
 268
 269 static void
 270 gst_aasink_fixate (GstPad * pad, GstCaps * caps)
 271 {
 272   GstStructure *structure;
 273
 274   structure = gst_caps_get_structure (caps, 0);
 275
 276   gst_structure_fixate_field_nearest_int (structure, "width", 320);
 277   gst_structure_fixate_field_nearest_int (structure, "height", 240);
 278   gst_structure_fixate_field_nearest_fraction (structure, "framerate", 30, 1);
 279 }
 280
 281 static gboolean
 282 gst_aasink_setcaps (GstBaseSink * basesink, GstCaps * caps)
 283 {
 284   GstAASink *aasink;
 285   GstStructure *structure;
 286
 287   aasink = GST_AASINK (basesink);
 288
 289   structure = gst_caps_get_structure (caps, 0);
 290   gst_structure_get_int (structure, "width", &aasink->width);
 291   gst_structure_get_int (structure, "height", &aasink->height);
 292
 293   /* FIXME aasink->format is never set */
 294   g_print ("%d %d\n", aasink->width, aasink->height);
 295
 296   GST_DEBUG ("aasink: setting %08lx (%" GST_FOURCC_FORMAT ")",
 297       aasink->format, GST_FOURCC_ARGS (aasink->format));
 298
 299   g_signal_emit (G_OBJECT (aasink), gst_aasink_signals[SIGNAL_HAVE_SIZE], 0,
 300       aasink->width, aasink->height);
 301
 302   return TRUE;
 303 }
 304
 305 static void
 306 gst_aasink_init (GstAASink * aasink)
 307 {
 308   GstPad *pad;
 309
 310   pad = GST_BASE_SINK_PAD (aasink);
 311   gst_pad_set_fixatecaps_function (pad, gst_aasink_fixate);
 312
 313   memcpy (&aasink->ascii_surf, &aa_defparams,
 314       sizeof (struct aa_hardware_params));
 315   aasink->ascii_parms.bright = 0;
 316   aasink->ascii_parms.contrast = 16;
 317   aasink->ascii_parms.gamma = 1.0;
 318   aasink->ascii_parms.dither = 0;
 319   aasink->ascii_parms.inversion = 0;
 320   aasink->ascii_parms.randomval = 0;
 321   aasink->aa_driver = 0;
 322
 323   aasink->width = -1;
 324   aasink->height = -1;
 325
 326 }
 327
 328 static void
 329 gst_aasink_scale (GstAASink * aasink, guchar * src, guchar * dest,
 330     gint sw, gint sh, gint dw, gint dh)
 331 {
 332   gint ypos, yinc, y;
 333   gint xpos, xinc, x;
 334
 335   g_return_if_fail ((dw != 0) && (dh != 0));
 336
 337   ypos = 0x10000;
 338   yinc = (sh << 16) / dh;
 339   xinc = (sw << 16) / dw;
 340
 341   for (y = dh; y; y--) {
 342     while (ypos > 0x10000) {
 343       ypos -= 0x10000;
 344       src += sw;
 345     }
 346     xpos = 0x10000;
 347     {
 348       guchar *destp = dest;
 349       guchar *srcp = src;
 350
 351       for (x = dw; x; x--) {
 352         while (xpos >= 0x10000L) {
 353           srcp++;
 354           xpos -= 0x10000L;
 355         }
 356         *destp++ = *srcp;
 357         xpos += xinc;
 358       }
 359     }
 360     dest += dw;
 361     ypos += yinc;
 362   }
 363 }
 364
 365 static void
 366 gst_aasink_get_times (GstBaseSink * sink, GstBuffer * buffer,
 367     GstClockTime * start, GstClockTime * end)
 368 {
 369   *start = GST_BUFFER_TIMESTAMP (buffer);
 370   *end = *start + GST_BUFFER_DURATION (buffer);
 371 }
 372
 373 static GstFlowReturn
 374 gst_aasink_render (GstBaseSink * basesink, GstBuffer * buffer)
 375 {
 376   GstAASink *aasink;
 377
 378   aasink = GST_AASINK (basesink);
 379
 380   GST_DEBUG ("render");
 381
 382   gst_aasink_scale (aasink, GST_BUFFER_DATA (buffer),   /* src */
 383       aa_image (aasink->context),       /* dest */
 384       aasink->width,            /* sw */
 385       aasink->height,           /* sh */
 386       aa_imgwidth (aasink->context),    /* dw */
 387       aa_imgheight (aasink->context));  /* dh */
 388
 389   aa_render (aasink->context, &aasink->ascii_parms,
 390       0, 0, aa_imgwidth (aasink->context), aa_imgheight (aasink->context));
 391   aa_flush (aasink->context);
 392   aa_getevent (aasink->context, FALSE);
 393
 394   return GST_FLOW_OK;
 395 }
 396
 397
 398 static void
 399 gst_aasink_set_property (GObject * object, guint prop_id, const GValue * value,
 400     GParamSpec * pspec)
 401 {
 402   GstAASink *aasink;
 403
 404   aasink = GST_AASINK (object);
 405
 406   switch (prop_id) {
 407     case ARG_WIDTH:
 408       aasink->ascii_surf.width = g_value_get_int (value);
 409       break;
 410     case ARG_HEIGHT:
 411       aasink->ascii_surf.height = g_value_get_int (value);
 412       break;
 413     case ARG_DRIVER:{
 414       aasink->aa_driver = g_value_get_enum (value);
 415       break;
 416     }
 417     case ARG_DITHER:{
 418       aasink->ascii_parms.dither = g_value_get_enum (value);
 419       break;
 420     }
 421     case ARG_BRIGHTNESS:{
 422       aasink->ascii_parms.bright = g_value_get_int (value);
 423       break;
 424     }
 425     case ARG_CONTRAST:{
 426       aasink->ascii_parms.contrast = g_value_get_int (value);
 427       break;
 428     }
 429     case ARG_GAMMA:{
 430       aasink->ascii_parms.gamma = g_value_get_float (value);
 431       break;
 432     }
 433     case ARG_INVERSION:{
 434       aasink->ascii_parms.inversion = g_value_get_boolean (value);
 435       break;
 436     }
 437     case ARG_RANDOMVAL:{
 438       aasink->ascii_parms.randomval = g_value_get_int (value);
 439       break;
 440     }
 441     default:
 442       break;
 443   }
 444 }
 445
 446 static void
 447 gst_aasink_get_property (GObject * object, guint prop_id, GValue * value,
 448     GParamSpec * pspec)
 449 {
 450   GstAASink *aasink;
 451
 452   aasink = GST_AASINK (object);
 453
 454   switch (prop_id) {
 455     case ARG_WIDTH:{
 456       g_value_set_int (value, aasink->ascii_surf.width);
 457       break;
 458     }
 459     case ARG_HEIGHT:{
 460       g_value_set_int (value, aasink->ascii_surf.height);
 461       break;
 462     }
 463     case ARG_DRIVER:{
 464       g_value_set_enum (value, aasink->aa_driver);
 465       break;
 466     }
 467     case ARG_DITHER:{
 468       g_value_set_enum (value, aasink->ascii_parms.dither);
 469       break;
 470     }
 471     case ARG_BRIGHTNESS:{
 472       g_value_set_int (value, aasink->ascii_parms.bright);
 473       break;
 474     }
 475     case ARG_CONTRAST:{
 476       g_value_set_int (value, aasink->ascii_parms.contrast);
 477       break;
 478     }
 479     case ARG_GAMMA:{
 480       g_value_set_float (value, aasink->ascii_parms.gamma);
 481       break;
 482     }
 483     case ARG_INVERSION:{
 484       g_value_set_boolean (value, aasink->ascii_parms.inversion);
 485       break;
 486     }
 487     case ARG_RANDOMVAL:{
 488       g_value_set_int (value, aasink->ascii_parms.randomval);
 489       break;
 490     }
 491     case ARG_FRAMES_DISPLAYED:{
 492       g_value_set_int (value, aasink->frames_displayed);
 493       break;
 494     }
 495     case ARG_FRAME_TIME:{
 496       g_value_set_int (value, aasink->frame_time / 1000000);
 497       break;
 498     }
 499     default:{
 500       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 501       break;
 502     }
 503   }
 504 }
 505
 506 static gboolean
 507 gst_aasink_open (GstAASink * aasink)
 508 {
 509   if (!aasink->context) {
 510     aa_recommendhidisplay (aa_drivers[aasink->aa_driver]->shortname);
 511
 512     aasink->context = aa_autoinit (&aasink->ascii_surf);
 513     if (aasink->context == NULL) {
 514       GST_ELEMENT_ERROR (GST_ELEMENT (aasink), LIBRARY, TOO_LAZY, (NULL),
 515           ("error opening aalib context"));
 516       return FALSE;
 517     }
 518     aa_autoinitkbd (aasink->context, 0);
 519     aa_resizehandler (aasink->context, (void *) aa_resize);
 520   }
 521   return TRUE;
 522 }
 523
 524 static gboolean
 525 gst_aasink_close (GstAASink * aasink)
 526 {
 527   aa_close (aasink->context);
 528   aasink->context = NULL;
 529
 530   return TRUE;
 531 }
 532
 533 static GstStateChangeReturn
 534 gst_aasink_change_state (GstElement * element, GstStateChange transition)
 535 {
 536   GstStateChangeReturn ret;
 537
 538
 539   switch (transition) {
 540     case GST_STATE_CHANGE_NULL_TO_READY:
 541       break;
 542     case GST_STATE_CHANGE_READY_TO_PAUSED:
 543       if (!gst_aasink_open (GST_AASINK (element)))
 544         goto open_failed;
 545       break;
 546     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 547       break;
 548     default:
 549       break;
 550   }
 551
 552   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 553
 554   switch (transition) {
 555     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 556       break;
 557     case GST_STATE_CHANGE_PAUSED_TO_READY:
 558       break;
 559     case GST_STATE_CHANGE_READY_TO_NULL:
 560       gst_aasink_close (GST_AASINK (element));
 561       break;
 562     default:
 563       break;
 564   }
 565
 566   return ret;
 567
 568 open_failed:
 569   {
 570     return GST_STATE_CHANGE_FAILURE;
 571   }
 572 }
 573
 574 static gboolean
 575 plugin_init (GstPlugin * plugin)
 576 {
 577   if (!gst_element_register (plugin, "aasink", GST_RANK_NONE, GST_TYPE_AASINK))
 578     return FALSE;
 579
 580   return TRUE;
 581 }
 582
 583 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
 584     GST_VERSION_MINOR,
 585     "aasink",
 586     "ASCII Art video sink",
 587     plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);