2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
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.
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.
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.
20 * SECTION:element-aasink
21 * @see_also: #GstCACASink
23 * Displays video as b/w ascii art.
26 * <title>Example launch line</title>
28 * gst-launch filesrc location=test.avi ! decodebin ! ffmpegcolorspace ! aasink
29 * ]| This pipeline renders a video to ascii art into a separate window.
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.
43 #include "gstaasink.h"
44 #include <gst/video/video.h>
46 /* aasink signals and args */
49 SIGNAL_FRAME_DISPLAYED,
71 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
74 GST_STATIC_CAPS (GST_VIDEO_CAPS_YUV ("I420"))
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);
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,
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);
92 static GstStateChangeReturn gst_aasink_change_state (GstElement * element,
93 GstStateChange transition);
95 static GstElementClass *parent_class = NULL;
96 static guint gst_aasink_signals[LAST_SIGNAL] = { 0 };
99 gst_aasink_get_type (void)
101 static GType aasink_type = 0;
104 static const GTypeInfo aasink_info = {
105 sizeof (GstAASinkClass),
106 gst_aasink_base_init,
108 (GClassInitFunc) gst_aasink_class_init,
113 (GInstanceInitFunc) gst_aasink_init,
117 g_type_register_static (GST_TYPE_BASE_SINK, "GstAASink", &aasink_info,
123 #define GST_TYPE_AADRIVERS (gst_aasink_drivers_get_type())
125 gst_aasink_drivers_get_type (void)
127 static GType driver_type = 0;
131 const struct aa_driver *driver;
135 for (n_drivers = 0; aa_drivers[n_drivers]; n_drivers++) {
136 /* count number of drivers */
139 drivers = g_new0 (GEnumValue, n_drivers + 1);
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);
147 drivers[i].value = 0;
148 drivers[i].value_name = NULL;
149 drivers[i].value_nick = NULL;
151 driver_type = g_enum_register_static ("GstAASinkDrivers", drivers);
156 #define GST_TYPE_AADITHER (gst_aasink_dither_get_type())
158 gst_aasink_dither_get_type (void)
160 static GType dither_type = 0;
163 GEnumValue *ditherers;
167 for (n_ditherers = 0; aa_dithernames[n_ditherers]; n_ditherers++) {
168 /* count number of ditherers */
171 ditherers = g_new0 (GEnumValue, n_ditherers + 1);
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]), " _", '-');
179 ditherers[i].value = 0;
180 ditherers[i].value_name = NULL;
181 ditherers[i].value_nick = NULL;
183 dither_type = g_enum_register_static ("GstAASinkDitherers", ditherers);
189 gst_aasink_base_init (gpointer g_class)
191 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
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",
197 "An ASCII art videosink", "Wim Taymans <wim.taymans@chello.be>");
201 gst_aasink_class_init (GstAASinkClass * klass)
203 GObjectClass *gobject_class;
204 GstElementClass *gstelement_class;
205 GstBaseSinkClass *gstbasesink_class;
207 gobject_class = (GObjectClass *) klass;
208 gstelement_class = (GstElementClass *) klass;
209 gstbasesink_class = (GstBaseSinkClass *) klass;
211 parent_class = g_type_class_peek_parent (klass);
213 gobject_class->set_property = gst_aasink_set_property;
214 gobject_class->get_property = gst_aasink_get_property;
216 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_WIDTH, g_param_spec_int ("width", "width", "width", G_MININT, G_MAXINT, 0, G_PARAM_READWRITE)); /* CHECKME */
217 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_HEIGHT, g_param_spec_int ("height", "height", "height", G_MININT, G_MAXINT, 0, G_PARAM_READWRITE)); /* CHECKME */
218 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_DRIVER, g_param_spec_enum ("driver", "driver", "driver", GST_TYPE_AADRIVERS, 0, G_PARAM_READWRITE)); /* CHECKME! */
219 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_DITHER, g_param_spec_enum ("dither", "dither", "dither", GST_TYPE_AADITHER, 0, G_PARAM_READWRITE)); /* CHECKME! */
220 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_BRIGHTNESS, g_param_spec_int ("brightness", "brightness", "brightness", G_MININT, G_MAXINT, 0, G_PARAM_READWRITE)); /* CHECKME */
221 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_CONTRAST, g_param_spec_int ("contrast", "contrast", "contrast", G_MININT, G_MAXINT, 0, G_PARAM_READWRITE)); /* CHECKME */
222 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_GAMMA, g_param_spec_float ("gamma", "gamma", "gamma", 0.0, 5.0, 1.0, G_PARAM_READWRITE)); /* CHECKME */
223 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_INVERSION, g_param_spec_boolean ("inversion", "inversion", "inversion", TRUE, G_PARAM_READWRITE)); /* CHECKME */
224 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_RANDOMVAL, g_param_spec_int ("randomval", "randomval", "randomval", G_MININT, G_MAXINT, 0, G_PARAM_READWRITE)); /* CHECKME */
225 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_FRAMES_DISPLAYED, g_param_spec_int ("frames-displayed", "frames displayed", "frames displayed", G_MININT, G_MAXINT, 0, G_PARAM_READABLE)); /* CHECKME */
226 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_FRAME_TIME, g_param_spec_int ("frame-time", "frame time", "frame time", G_MININT, G_MAXINT, 0, G_PARAM_READABLE)); /* CHECKME */
228 gst_aasink_signals[SIGNAL_FRAME_DISPLAYED] =
229 g_signal_new ("frame-displayed", G_TYPE_FROM_CLASS (klass),
230 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstAASinkClass, frame_displayed),
231 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
232 gst_aasink_signals[SIGNAL_HAVE_SIZE] =
233 g_signal_new ("have-size", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
234 G_STRUCT_OFFSET (GstAASinkClass, have_size), NULL, NULL,
235 gst_marshal_VOID__INT_INT, G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_UINT);
237 gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_aasink_change_state);
239 gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_aasink_setcaps);
240 gstbasesink_class->get_times = GST_DEBUG_FUNCPTR (gst_aasink_get_times);
241 gstbasesink_class->preroll = GST_DEBUG_FUNCPTR (gst_aasink_render);
242 gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_aasink_render);
246 gst_aasink_fixate (GstPad * pad, GstCaps * caps)
248 GstStructure *structure;
250 structure = gst_caps_get_structure (caps, 0);
252 gst_structure_fixate_field_nearest_int (structure, "width", 320);
253 gst_structure_fixate_field_nearest_int (structure, "height", 240);
254 gst_structure_fixate_field_nearest_fraction (structure, "framerate", 30, 1);
258 gst_aasink_setcaps (GstBaseSink * basesink, GstCaps * caps)
261 GstStructure *structure;
263 aasink = GST_AASINK (basesink);
265 structure = gst_caps_get_structure (caps, 0);
266 gst_structure_get_int (structure, "width", &aasink->width);
267 gst_structure_get_int (structure, "height", &aasink->height);
269 /* FIXME aasink->format is never set */
270 g_print ("%d %d\n", aasink->width, aasink->height);
272 GST_DEBUG ("aasink: setting %08lx (%" GST_FOURCC_FORMAT ")",
273 aasink->format, GST_FOURCC_ARGS (aasink->format));
275 g_signal_emit (G_OBJECT (aasink), gst_aasink_signals[SIGNAL_HAVE_SIZE], 0,
276 aasink->width, aasink->height);
282 gst_aasink_init (GstAASink * aasink)
286 pad = GST_BASE_SINK_PAD (aasink);
287 gst_pad_set_fixatecaps_function (pad, gst_aasink_fixate);
289 memcpy (&aasink->ascii_surf, &aa_defparams,
290 sizeof (struct aa_hardware_params));
291 aasink->ascii_parms.bright = 0;
292 aasink->ascii_parms.contrast = 16;
293 aasink->ascii_parms.gamma = 1.0;
294 aasink->ascii_parms.dither = 0;
295 aasink->ascii_parms.inversion = 0;
296 aasink->ascii_parms.randomval = 0;
297 aasink->aa_driver = 0;
305 gst_aasink_scale (GstAASink * aasink, guchar * src, guchar * dest,
306 gint sw, gint sh, gint dw, gint dh)
311 g_return_if_fail ((dw != 0) && (dh != 0));
314 yinc = (sh << 16) / dh;
315 xinc = (sw << 16) / dw;
317 for (y = dh; y; y--) {
318 while (ypos > 0x10000) {
324 guchar *destp = dest;
327 for (x = dw; x; x--) {
328 while (xpos >= 0x10000L) {
342 gst_aasink_get_times (GstBaseSink * sink, GstBuffer * buffer,
343 GstClockTime * start, GstClockTime * end)
345 *start = GST_BUFFER_TIMESTAMP (buffer);
346 *end = *start + GST_BUFFER_DURATION (buffer);
350 gst_aasink_render (GstBaseSink * basesink, GstBuffer * buffer)
354 aasink = GST_AASINK (basesink);
356 GST_DEBUG ("render");
358 gst_aasink_scale (aasink, GST_BUFFER_DATA (buffer), /* src */
359 aa_image (aasink->context), /* dest */
360 aasink->width, /* sw */
361 aasink->height, /* sh */
362 aa_imgwidth (aasink->context), /* dw */
363 aa_imgheight (aasink->context)); /* dh */
365 aa_render (aasink->context, &aasink->ascii_parms,
366 0, 0, aa_imgwidth (aasink->context), aa_imgheight (aasink->context));
367 aa_flush (aasink->context);
368 aa_getevent (aasink->context, FALSE);
375 gst_aasink_set_property (GObject * object, guint prop_id, const GValue * value,
380 aasink = GST_AASINK (object);
384 aasink->ascii_surf.width = g_value_get_int (value);
387 aasink->ascii_surf.height = g_value_get_int (value);
390 aasink->aa_driver = g_value_get_enum (value);
394 aasink->ascii_parms.dither = g_value_get_enum (value);
397 case ARG_BRIGHTNESS:{
398 aasink->ascii_parms.bright = g_value_get_int (value);
402 aasink->ascii_parms.contrast = g_value_get_int (value);
406 aasink->ascii_parms.gamma = g_value_get_float (value);
410 aasink->ascii_parms.inversion = g_value_get_boolean (value);
414 aasink->ascii_parms.randomval = g_value_get_int (value);
423 gst_aasink_get_property (GObject * object, guint prop_id, GValue * value,
428 aasink = GST_AASINK (object);
432 g_value_set_int (value, aasink->ascii_surf.width);
436 g_value_set_int (value, aasink->ascii_surf.height);
440 g_value_set_enum (value, aasink->aa_driver);
444 g_value_set_enum (value, aasink->ascii_parms.dither);
447 case ARG_BRIGHTNESS:{
448 g_value_set_int (value, aasink->ascii_parms.bright);
452 g_value_set_int (value, aasink->ascii_parms.contrast);
456 g_value_set_float (value, aasink->ascii_parms.gamma);
460 g_value_set_boolean (value, aasink->ascii_parms.inversion);
464 g_value_set_int (value, aasink->ascii_parms.randomval);
467 case ARG_FRAMES_DISPLAYED:{
468 g_value_set_int (value, aasink->frames_displayed);
471 case ARG_FRAME_TIME:{
472 g_value_set_int (value, aasink->frame_time / 1000000);
476 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
483 gst_aasink_open (GstAASink * aasink)
485 if (!aasink->context) {
486 aa_recommendhidisplay (aa_drivers[aasink->aa_driver]->shortname);
488 aasink->context = aa_autoinit (&aasink->ascii_surf);
489 if (aasink->context == NULL) {
490 GST_ELEMENT_ERROR (GST_ELEMENT (aasink), LIBRARY, TOO_LAZY, (NULL),
491 ("error opening aalib context"));
494 aa_autoinitkbd (aasink->context, 0);
495 aa_resizehandler (aasink->context, (void *) aa_resize);
501 gst_aasink_close (GstAASink * aasink)
503 aa_close (aasink->context);
504 aasink->context = NULL;
509 static GstStateChangeReturn
510 gst_aasink_change_state (GstElement * element, GstStateChange transition)
512 GstStateChangeReturn ret;
515 switch (transition) {
516 case GST_STATE_CHANGE_NULL_TO_READY:
518 case GST_STATE_CHANGE_READY_TO_PAUSED:
519 if (!gst_aasink_open (GST_AASINK (element)))
522 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
528 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
530 switch (transition) {
531 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
533 case GST_STATE_CHANGE_PAUSED_TO_READY:
535 case GST_STATE_CHANGE_READY_TO_NULL:
536 gst_aasink_close (GST_AASINK (element));
546 return GST_STATE_CHANGE_FAILURE;
551 plugin_init (GstPlugin * plugin)
553 if (!gst_element_register (plugin, "aasink", GST_RANK_NONE, GST_TYPE_AASINK))
559 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
562 "ASCII Art video sink",
563 plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);