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-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-1.0 filesrc location=test.avi ! decodebin ! videoconvert ! aasink
29 * ]| This pipeline renders a video to ascii art into a separate window.
30 * |[
31 * gst-launch-1.0 filesrc location=test.avi ! decodebin ! videoconvert ! 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 <gst/video/gstvideometa.h>
44 #include "gstaasink.h"
45
46 /* aasink signals and args */
47 enum
48 {
49 LAST_SIGNAL
50 };
51
52
53 enum
54 {
55 PROP_0,
56 PROP_WIDTH,
57 PROP_HEIGHT,
58 PROP_DRIVER,
59 PROP_DITHER,
60 PROP_BRIGHTNESS,
61 PROP_CONTRAST,
62 PROP_GAMMA,
63 PROP_INVERSION,
64 PROP_RANDOMVAL,
65 PROP_FRAMES_DISPLAYED,
66 PROP_FRAME_TIME
67 };
68
69 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
70 GST_PAD_SINK,
71 GST_PAD_ALWAYS,
72 GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE ("I420"))
73 );
74
75 static GstCaps *gst_aasink_fixate (GstBaseSink * bsink, GstCaps * caps);
76 static gboolean gst_aasink_setcaps (GstBaseSink * bsink, GstCaps * caps);
77 static void gst_aasink_get_times (GstBaseSink * bsink, GstBuffer * buffer,
78 GstClockTime * start, GstClockTime * end);
79 static gboolean gst_aasink_propose_allocation (GstBaseSink * bsink,
80 GstQuery * query);
81 static GstFlowReturn gst_aasink_show_frame (GstVideoSink * videosink,
82 GstBuffer * buffer);
83
84 static void gst_aasink_set_property (GObject * object, guint prop_id,
85 const GValue * value, GParamSpec * pspec);
86 static void gst_aasink_get_property (GObject * object, guint prop_id,
87 GValue * value, GParamSpec * pspec);
88
89 static GstStateChangeReturn gst_aasink_change_state (GstElement * element,
90 GstStateChange transition);
91
92 #define gst_aasink_parent_class parent_class
93 G_DEFINE_TYPE (GstAASink, gst_aasink, GST_TYPE_VIDEO_SINK);
94
95 #define GST_TYPE_AADRIVERS (gst_aasink_drivers_get_type())
96 static GType
gst_aasink_drivers_get_type(void)97 gst_aasink_drivers_get_type (void)
98 {
99 static GType driver_type = 0;
100
101 if (!driver_type) {
102 GEnumValue *drivers;
103 const struct aa_driver *driver;
104 gint n_drivers;
105 gint i;
106
107 for (n_drivers = 0; aa_drivers[n_drivers]; n_drivers++) {
108 /* count number of drivers */
109 }
110
111 drivers = g_new0 (GEnumValue, n_drivers + 1);
112
113 for (i = 0; i < n_drivers; i++) {
114 driver = aa_drivers[i];
115 drivers[i].value = i;
116 drivers[i].value_name = g_strdup (driver->name);
117 drivers[i].value_nick = g_utf8_strdown (driver->shortname, -1);
118 }
119 drivers[i].value = 0;
120 drivers[i].value_name = NULL;
121 drivers[i].value_nick = NULL;
122
123 driver_type = g_enum_register_static ("GstAASinkDrivers", drivers);
124 }
125 return driver_type;
126 }
127
128 #define GST_TYPE_AADITHER (gst_aasink_dither_get_type())
129 static GType
gst_aasink_dither_get_type(void)130 gst_aasink_dither_get_type (void)
131 {
132 static GType dither_type = 0;
133
134 if (!dither_type) {
135 GEnumValue *ditherers;
136 gint n_ditherers;
137 gint i;
138
139 for (n_ditherers = 0; aa_dithernames[n_ditherers]; n_ditherers++) {
140 /* count number of ditherers */
141 }
142
143 ditherers = g_new0 (GEnumValue, n_ditherers + 1);
144
145 for (i = 0; i < n_ditherers; i++) {
146 ditherers[i].value = i;
147 ditherers[i].value_name = g_strdup (aa_dithernames[i]);
148 ditherers[i].value_nick =
149 g_strdelimit (g_strdup (aa_dithernames[i]), " _", '-');
150 }
151 ditherers[i].value = 0;
152 ditherers[i].value_name = NULL;
153 ditherers[i].value_nick = NULL;
154
155 dither_type = g_enum_register_static ("GstAASinkDitherers", ditherers);
156 }
157 return dither_type;
158 }
159
160 static void
gst_aasink_class_init(GstAASinkClass * klass)161 gst_aasink_class_init (GstAASinkClass * klass)
162 {
163 GObjectClass *gobject_class;
164 GstElementClass *gstelement_class;
165 GstBaseSinkClass *gstbasesink_class;
166 GstVideoSinkClass *gstvideosink_class;
167
168 gobject_class = (GObjectClass *) klass;
169 gstelement_class = (GstElementClass *) klass;
170 gstbasesink_class = (GstBaseSinkClass *) klass;
171 gstvideosink_class = (GstVideoSinkClass *) klass;
172
173 gobject_class->set_property = gst_aasink_set_property;
174 gobject_class->get_property = gst_aasink_get_property;
175
176 /* FIXME: add long property descriptions */
177 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_WIDTH,
178 g_param_spec_int ("width", "width", "width", G_MININT, G_MAXINT, 0,
179 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
180 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_HEIGHT,
181 g_param_spec_int ("height", "height", "height", G_MININT, G_MAXINT, 0,
182 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
183 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DRIVER,
184 g_param_spec_enum ("driver", "driver", "driver", GST_TYPE_AADRIVERS, 0,
185 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
186 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DITHER,
187 g_param_spec_enum ("dither", "dither", "dither", GST_TYPE_AADITHER, 0,
188 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
189 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BRIGHTNESS,
190 g_param_spec_int ("brightness", "brightness", "brightness", G_MININT,
191 G_MAXINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
192 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_CONTRAST,
193 g_param_spec_int ("contrast", "contrast", "contrast", G_MININT, G_MAXINT,
194 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
195 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_GAMMA,
196 g_param_spec_float ("gamma", "gamma", "gamma", 0.0, 5.0, 1.0,
197 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
198 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_INVERSION,
199 g_param_spec_boolean ("inversion", "inversion", "inversion", TRUE,
200 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
201 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_RANDOMVAL,
202 g_param_spec_int ("randomval", "randomval", "randomval", G_MININT,
203 G_MAXINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
204 g_object_class_install_property (G_OBJECT_CLASS (klass),
205 PROP_FRAMES_DISPLAYED, g_param_spec_int ("frames-displayed",
206 "frames displayed", "frames displayed", G_MININT, G_MAXINT, 0,
207 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
208 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_FRAME_TIME,
209 g_param_spec_int ("frame-time", "frame time", "frame time", G_MININT,
210 G_MAXINT, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
211
212 gst_element_class_add_static_pad_template (gstelement_class, &sink_template);
213
214 gst_element_class_set_static_metadata (gstelement_class,
215 "ASCII art video sink", "Sink/Video", "An ASCII art videosink",
216 "Wim Taymans <wim.taymans@chello.be>");
217
218 gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_aasink_change_state);
219
220 gstbasesink_class->fixate = GST_DEBUG_FUNCPTR (gst_aasink_fixate);
221 gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_aasink_setcaps);
222 gstbasesink_class->get_times = GST_DEBUG_FUNCPTR (gst_aasink_get_times);
223 gstbasesink_class->propose_allocation =
224 GST_DEBUG_FUNCPTR (gst_aasink_propose_allocation);
225
226 gstvideosink_class->show_frame = GST_DEBUG_FUNCPTR (gst_aasink_show_frame);
227 }
228
229 static GstCaps *
gst_aasink_fixate(GstBaseSink * bsink,GstCaps * caps)230 gst_aasink_fixate (GstBaseSink * bsink, GstCaps * caps)
231 {
232 GstStructure *structure;
233
234 caps = gst_caps_make_writable (caps);
235
236 structure = gst_caps_get_structure (caps, 0);
237
238 gst_structure_fixate_field_nearest_int (structure, "width", 320);
239 gst_structure_fixate_field_nearest_int (structure, "height", 240);
240 gst_structure_fixate_field_nearest_fraction (structure, "framerate", 30, 1);
241
242 caps = GST_BASE_SINK_CLASS (parent_class)->fixate (bsink, caps);
243
244 return caps;
245 }
246
247 static gboolean
gst_aasink_setcaps(GstBaseSink * basesink,GstCaps * caps)248 gst_aasink_setcaps (GstBaseSink * basesink, GstCaps * caps)
249 {
250 GstAASink *aasink;
251 GstVideoInfo info;
252
253 aasink = GST_AASINK (basesink);
254
255 if (!gst_video_info_from_caps (&info, caps))
256 goto invalid_caps;
257
258 aasink->info = info;
259
260 return TRUE;
261
262 /* ERRORS */
263 invalid_caps:
264 {
265 GST_DEBUG_OBJECT (aasink, "invalid caps");
266 return FALSE;
267 }
268 }
269
270 static void
gst_aasink_init(GstAASink * aasink)271 gst_aasink_init (GstAASink * aasink)
272 {
273 memcpy (&aasink->ascii_surf, &aa_defparams,
274 sizeof (struct aa_hardware_params));
275 aasink->ascii_parms.bright = 0;
276 aasink->ascii_parms.contrast = 16;
277 aasink->ascii_parms.gamma = 1.0;
278 aasink->ascii_parms.dither = 0;
279 aasink->ascii_parms.inversion = 0;
280 aasink->ascii_parms.randomval = 0;
281 aasink->aa_driver = 0;
282 }
283
284 static void
gst_aasink_scale(GstAASink * aasink,guchar * src,guchar * dest,gint sw,gint sh,gint ss,gint dw,gint dh)285 gst_aasink_scale (GstAASink * aasink, guchar * src, guchar * dest,
286 gint sw, gint sh, gint ss, gint dw, gint dh)
287 {
288 gint ypos, yinc, y;
289 gint xpos, xinc, x;
290
291 g_return_if_fail ((dw != 0) && (dh != 0));
292
293 ypos = 0x10000;
294 yinc = (sh << 16) / dh;
295 xinc = (sw << 16) / dw;
296
297 for (y = dh; y; y--) {
298 while (ypos > 0x10000) {
299 ypos -= 0x10000;
300 src += ss;
301 }
302 xpos = 0x10000;
303 {
304 guchar *destp = dest;
305 guchar *srcp = src;
306
307 for (x = dw; x; x--) {
308 while (xpos >= 0x10000L) {
309 srcp++;
310 xpos -= 0x10000L;
311 }
312 *destp++ = *srcp;
313 xpos += xinc;
314 }
315 }
316 dest += dw;
317 ypos += yinc;
318 }
319 }
320
321 static void
gst_aasink_get_times(GstBaseSink * sink,GstBuffer * buffer,GstClockTime * start,GstClockTime * end)322 gst_aasink_get_times (GstBaseSink * sink, GstBuffer * buffer,
323 GstClockTime * start, GstClockTime * end)
324 {
325 *start = GST_BUFFER_TIMESTAMP (buffer);
326 if (GST_BUFFER_DURATION_IS_VALID (buffer))
327 *end = *start + GST_BUFFER_DURATION (buffer);
328 }
329
330 static gboolean
gst_aasink_propose_allocation(GstBaseSink * bsink,GstQuery * query)331 gst_aasink_propose_allocation (GstBaseSink * bsink, GstQuery * query)
332 {
333 GstCaps *caps;
334 GstVideoInfo info;
335 guint size;
336
337 gst_query_parse_allocation (query, &caps, NULL);
338
339 if (caps == NULL)
340 goto no_caps;
341
342 if (!gst_video_info_from_caps (&info, caps))
343 goto invalid_caps;
344
345 size = GST_VIDEO_INFO_SIZE (&info);
346
347 /* we need at least 2 buffer because we hold on to the last one */
348 gst_query_add_allocation_pool (query, NULL, size, 2, 0);
349
350 /* we support various metadata */
351 gst_query_add_allocation_meta (query, GST_VIDEO_META_API_TYPE, NULL);
352
353 return TRUE;
354
355 /* ERRORS */
356 no_caps:
357 {
358 GST_DEBUG_OBJECT (bsink, "no caps specified");
359 return FALSE;
360 }
361 invalid_caps:
362 {
363 GST_DEBUG_OBJECT (bsink, "invalid caps specified");
364 return FALSE;
365 }
366 }
367
368 static GstFlowReturn
gst_aasink_show_frame(GstVideoSink * videosink,GstBuffer * buffer)369 gst_aasink_show_frame (GstVideoSink * videosink, GstBuffer * buffer)
370 {
371 GstAASink *aasink;
372 GstVideoFrame frame;
373
374 aasink = GST_AASINK (videosink);
375
376 GST_DEBUG ("show frame");
377
378 if (!gst_video_frame_map (&frame, &aasink->info, buffer, GST_MAP_READ))
379 goto invalid_frame;
380
381 gst_aasink_scale (aasink, GST_VIDEO_FRAME_PLANE_DATA (&frame, 0), /* src */
382 aa_image (aasink->context), /* dest */
383 GST_VIDEO_INFO_WIDTH (&aasink->info), /* sw */
384 GST_VIDEO_INFO_HEIGHT (&aasink->info), /* sh */
385 GST_VIDEO_FRAME_PLANE_STRIDE (&frame, 0), /* ss */
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 gst_video_frame_unmap (&frame);
394
395 return GST_FLOW_OK;
396
397 /* ERRORS */
398 invalid_frame:
399 {
400 GST_DEBUG_OBJECT (aasink, "invalid frame");
401 return GST_FLOW_ERROR;
402 }
403 }
404
405
406 static void
gst_aasink_set_property(GObject * object,guint prop_id,const GValue * value,GParamSpec * pspec)407 gst_aasink_set_property (GObject * object, guint prop_id, const GValue * value,
408 GParamSpec * pspec)
409 {
410 GstAASink *aasink;
411
412 aasink = GST_AASINK (object);
413
414 switch (prop_id) {
415 case PROP_WIDTH:
416 aasink->ascii_surf.width = g_value_get_int (value);
417 break;
418 case PROP_HEIGHT:
419 aasink->ascii_surf.height = g_value_get_int (value);
420 break;
421 case PROP_DRIVER:{
422 aasink->aa_driver = g_value_get_enum (value);
423 break;
424 }
425 case PROP_DITHER:{
426 aasink->ascii_parms.dither = g_value_get_enum (value);
427 break;
428 }
429 case PROP_BRIGHTNESS:{
430 aasink->ascii_parms.bright = g_value_get_int (value);
431 break;
432 }
433 case PROP_CONTRAST:{
434 aasink->ascii_parms.contrast = g_value_get_int (value);
435 break;
436 }
437 case PROP_GAMMA:{
438 aasink->ascii_parms.gamma = g_value_get_float (value);
439 break;
440 }
441 case PROP_INVERSION:{
442 aasink->ascii_parms.inversion = g_value_get_boolean (value);
443 break;
444 }
445 case PROP_RANDOMVAL:{
446 aasink->ascii_parms.randomval = g_value_get_int (value);
447 break;
448 }
449 default:
450 break;
451 }
452 }
453
454 static void
gst_aasink_get_property(GObject * object,guint prop_id,GValue * value,GParamSpec * pspec)455 gst_aasink_get_property (GObject * object, guint prop_id, GValue * value,
456 GParamSpec * pspec)
457 {
458 GstAASink *aasink;
459
460 aasink = GST_AASINK (object);
461
462 switch (prop_id) {
463 case PROP_WIDTH:{
464 g_value_set_int (value, aasink->ascii_surf.width);
465 break;
466 }
467 case PROP_HEIGHT:{
468 g_value_set_int (value, aasink->ascii_surf.height);
469 break;
470 }
471 case PROP_DRIVER:{
472 g_value_set_enum (value, aasink->aa_driver);
473 break;
474 }
475 case PROP_DITHER:{
476 g_value_set_enum (value, aasink->ascii_parms.dither);
477 break;
478 }
479 case PROP_BRIGHTNESS:{
480 g_value_set_int (value, aasink->ascii_parms.bright);
481 break;
482 }
483 case PROP_CONTRAST:{
484 g_value_set_int (value, aasink->ascii_parms.contrast);
485 break;
486 }
487 case PROP_GAMMA:{
488 g_value_set_float (value, aasink->ascii_parms.gamma);
489 break;
490 }
491 case PROP_INVERSION:{
492 g_value_set_boolean (value, aasink->ascii_parms.inversion);
493 break;
494 }
495 case PROP_RANDOMVAL:{
496 g_value_set_int (value, aasink->ascii_parms.randomval);
497 break;
498 }
499 case PROP_FRAMES_DISPLAYED:{
500 g_value_set_int (value, aasink->frames_displayed);
501 break;
502 }
503 case PROP_FRAME_TIME:{
504 g_value_set_int (value, aasink->frame_time / 1000000);
505 break;
506 }
507 default:{
508 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
509 break;
510 }
511 }
512 }
513
514 static gboolean
gst_aasink_open(GstAASink * aasink)515 gst_aasink_open (GstAASink * aasink)
516 {
517 if (!aasink->context) {
518 aa_recommendhidisplay (aa_drivers[aasink->aa_driver]->shortname);
519
520 aasink->context = aa_autoinit (&aasink->ascii_surf);
521 if (aasink->context == NULL) {
522 GST_ELEMENT_ERROR (GST_ELEMENT (aasink), LIBRARY, TOO_LAZY, (NULL),
523 ("error opening aalib context"));
524 return FALSE;
525 }
526 aa_autoinitkbd (aasink->context, 0);
527 aa_resizehandler (aasink->context, (void *) aa_resize);
528 }
529 return TRUE;
530 }
531
532 static gboolean
gst_aasink_close(GstAASink * aasink)533 gst_aasink_close (GstAASink * aasink)
534 {
535 aa_close (aasink->context);
536 aasink->context = NULL;
537
538 return TRUE;
539 }
540
541 static GstStateChangeReturn
gst_aasink_change_state(GstElement * element,GstStateChange transition)542 gst_aasink_change_state (GstElement * element, GstStateChange transition)
543 {
544 GstStateChangeReturn ret;
545
546
547 switch (transition) {
548 case GST_STATE_CHANGE_NULL_TO_READY:
549 break;
550 case GST_STATE_CHANGE_READY_TO_PAUSED:
551 if (!gst_aasink_open (GST_AASINK (element)))
552 goto open_failed;
553 break;
554 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
555 break;
556 default:
557 break;
558 }
559
560 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
561
562 switch (transition) {
563 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
564 break;
565 case GST_STATE_CHANGE_PAUSED_TO_READY:
566 break;
567 case GST_STATE_CHANGE_READY_TO_NULL:
568 gst_aasink_close (GST_AASINK (element));
569 break;
570 default:
571 break;
572 }
573
574 return ret;
575
576 open_failed:
577 {
578 return GST_STATE_CHANGE_FAILURE;
579 }
580 }
581
582 static gboolean
plugin_init(GstPlugin * plugin)583 plugin_init (GstPlugin * plugin)
584 {
585 if (!gst_element_register (plugin, "aasink", GST_RANK_NONE, GST_TYPE_AASINK))
586 return FALSE;
587
588 return TRUE;
589 }
590
591 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
592 GST_VERSION_MINOR,
593 aasink,
594 "ASCII Art video sink",
595 plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);
596