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-cacasink
21 * @see_also: #GstAASink
22 *
23 * Displays video as color ascii art.
24 *
25 * <refsect2>
26 * <title>Example launch line</title>
27 * |[
28 * CACA_GEOMETRY=160x60 CACA_FONT=5x7 gst-launch-1.0 filesrc location=test.avi ! decodebin ! videoconvert ! cacasink
29 * ]| This pipeline renders a video to ascii art into a separate window using a
30 * small font and specifying the ascii resolution.
31 * |[
32 * CACA_DRIVER=ncurses gst-launch-1.0 filesrc location=test.avi ! decodebin ! videoconvert ! cacasink
33 * ]| This pipeline renders a video to ascii art into the current terminal.
34 * </refsect2>
35 */
36
37 #ifdef HAVE_CONFIG_H
38 #include "config.h"
39 #endif
40
41 #include <string.h>
42 #include "gstcacasink.h"
43
44
45 //#define GST_CACA_DEFAULT_RED_MASK R_MASK_32_REVERSE_INT
46 //#define GST_CACA_DEFAULT_GREEN_MASK G_MASK_32_REVERSE_INT
47 //#define GST_CACA_DEFAULT_BLUE_MASK B_MASK_32_REVERSE_INT
48
49 /* cacasink signals and args */
50 enum
51 {
52 LAST_SIGNAL
53 };
54
55 #define GST_CACA_DEFAULT_SCREEN_WIDTH 80
56 #define GST_CACA_DEFAULT_SCREEN_HEIGHT 25
57 #define GST_CACA_DEFAULT_DITHER CACA_DITHERING_NONE
58 #define GST_CACA_DEFAULT_ANTIALIASING TRUE
59
60 enum
61 {
62 PROP_0,
63 PROP_SCREEN_WIDTH,
64 PROP_SCREEN_HEIGHT,
65 PROP_DITHER,
66 PROP_ANTIALIASING
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
73 ("{ RGB, BGR, RGBx, xRGB, BGRx, xBGR, RGB16, RGB15 }"))
74 );
75
76 static gboolean gst_cacasink_setcaps (GstBaseSink * pad, GstCaps * caps);
77 static void gst_cacasink_get_times (GstBaseSink * sink, GstBuffer * buffer,
78 GstClockTime * start, GstClockTime * end);
79 static GstFlowReturn gst_cacasink_render (GstBaseSink * basesink,
80 GstBuffer * buffer);
81
82 static void gst_cacasink_set_property (GObject * object, guint prop_id,
83 const GValue * value, GParamSpec * pspec);
84 static void gst_cacasink_get_property (GObject * object, guint prop_id,
85 GValue * value, GParamSpec * pspec);
86
87 static GstStateChangeReturn gst_cacasink_change_state (GstElement * element,
88 GstStateChange transition);
89
90 #define gst_cacasink_parent_class parent_class
91 G_DEFINE_TYPE (GstCACASink, gst_cacasink, GST_TYPE_BASE_SINK);
92
93 #define GST_TYPE_CACADITHER (gst_cacasink_dither_get_type())
94 static GType
gst_cacasink_dither_get_type(void)95 gst_cacasink_dither_get_type (void)
96 {
97 static GType dither_type = 0;
98
99 static const GEnumValue dither_types[] = {
100 {CACA_DITHERING_NONE, "No dithering", "none"},
101 {CACA_DITHERING_ORDERED2, "Ordered 2x2 Bayer dithering", "2x2"},
102 {CACA_DITHERING_ORDERED4, "Ordered 4x4 Bayer dithering", "4x4"},
103 {CACA_DITHERING_ORDERED8, "Ordered 8x8 Bayer dithering", "8x8"},
104 {CACA_DITHERING_RANDOM, "Random dithering", "random"},
105 {0, NULL, NULL},
106 };
107
108 if (!dither_type) {
109 dither_type = g_enum_register_static ("GstCACASinkDithering", dither_types);
110 }
111 return dither_type;
112 }
113
114 static void
gst_cacasink_class_init(GstCACASinkClass * klass)115 gst_cacasink_class_init (GstCACASinkClass * klass)
116 {
117 GObjectClass *gobject_class;
118 GstElementClass *gstelement_class;
119 GstBaseSinkClass *gstbasesink_class;
120
121 gobject_class = (GObjectClass *) klass;
122 gstelement_class = (GstElementClass *) klass;
123 gstbasesink_class = (GstBaseSinkClass *) klass;
124
125 parent_class = g_type_class_peek_parent (klass);
126
127 gobject_class->set_property = gst_cacasink_set_property;
128 gobject_class->get_property = gst_cacasink_get_property;
129
130 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SCREEN_WIDTH,
131 g_param_spec_int ("screen-width", "Screen Width",
132 "The width of the screen", 0, G_MAXINT, GST_CACA_DEFAULT_SCREEN_WIDTH,
133 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
134 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SCREEN_HEIGHT,
135 g_param_spec_int ("screen-height", "Screen Height",
136 "The height of the screen", 0, G_MAXINT,
137 GST_CACA_DEFAULT_SCREEN_HEIGHT,
138 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
139 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DITHER,
140 g_param_spec_enum ("dither", "Dither Type", "Set type of Dither",
141 GST_TYPE_CACADITHER, GST_CACA_DEFAULT_DITHER,
142 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
143 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_ANTIALIASING,
144 g_param_spec_boolean ("anti-aliasing", "Anti Aliasing",
145 "Enables Anti-Aliasing", GST_CACA_DEFAULT_ANTIALIASING,
146 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
147
148 gstelement_class->change_state = gst_cacasink_change_state;
149
150 gst_element_class_set_static_metadata (gstelement_class,
151 "A colored ASCII art video sink", "Sink/Video",
152 "A colored ASCII art videosink", "Zeeshan Ali <zak147@yahoo.com>");
153 gst_element_class_add_static_pad_template (gstelement_class, &sink_template);
154
155 gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_cacasink_setcaps);
156 gstbasesink_class->get_times = GST_DEBUG_FUNCPTR (gst_cacasink_get_times);
157 gstbasesink_class->preroll = GST_DEBUG_FUNCPTR (gst_cacasink_render);
158 gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_cacasink_render);
159 }
160
161 static void
gst_cacasink_get_times(GstBaseSink * sink,GstBuffer * buffer,GstClockTime * start,GstClockTime * end)162 gst_cacasink_get_times (GstBaseSink * sink, GstBuffer * buffer,
163 GstClockTime * start, GstClockTime * end)
164 {
165 *start = GST_BUFFER_TIMESTAMP (buffer);
166 *end = *start + GST_BUFFER_DURATION (buffer);
167 }
168
169 static gboolean
gst_cacasink_setcaps(GstBaseSink * basesink,GstCaps * caps)170 gst_cacasink_setcaps (GstBaseSink * basesink, GstCaps * caps)
171 {
172 GstCACASink *cacasink;
173 GstVideoInfo info;
174 guint bpp, red_mask, green_mask, blue_mask;
175
176 cacasink = GST_CACASINK (basesink);
177
178 if (!gst_video_info_from_caps (&info, caps))
179 goto caps_error;
180
181 switch (GST_VIDEO_INFO_FORMAT (&info)) {
182 case GST_VIDEO_FORMAT_RGB:
183 case GST_VIDEO_FORMAT_BGR:
184 case GST_VIDEO_FORMAT_RGBx:
185 case GST_VIDEO_FORMAT_xRGB:
186 case GST_VIDEO_FORMAT_BGRx:
187 case GST_VIDEO_FORMAT_xBGR:
188 bpp = 8 * info.finfo->pixel_stride[0];
189 red_mask = 0xff << (8 * info.finfo->poffset[GST_VIDEO_COMP_R]);
190 green_mask = 0xff << (8 * info.finfo->poffset[GST_VIDEO_COMP_G]);
191 blue_mask = 0xff << (8 * info.finfo->poffset[GST_VIDEO_COMP_B]);
192 break;
193 case GST_VIDEO_FORMAT_RGB16:
194 bpp = 16;
195 red_mask = 0xf800;
196 green_mask = 0x07e0;
197 blue_mask = 0x001f;
198 break;
199 case GST_VIDEO_FORMAT_RGB15:
200 bpp = 16;
201 red_mask = 0x7c00;
202 green_mask = 0x03e0;
203 blue_mask = 0x001f;
204 break;
205 default:
206 goto invalid_format;
207 }
208
209 if (cacasink->bitmap) {
210 caca_free_bitmap (cacasink->bitmap);
211 }
212 cacasink->bitmap = caca_create_bitmap (bpp,
213 GST_VIDEO_INFO_WIDTH (&info),
214 GST_VIDEO_INFO_HEIGHT (&info),
215 GST_ROUND_UP_4 (GST_VIDEO_INFO_WIDTH (&info) * bpp / 8),
216 red_mask, green_mask, blue_mask, 0);
217 if (!cacasink->bitmap)
218 goto no_bitmap;
219
220 cacasink->info = info;
221
222 return TRUE;
223
224 /* ERROS */
225 caps_error:
226 {
227 GST_ERROR_OBJECT (cacasink, "error parsing caps");
228 return FALSE;
229 }
230 invalid_format:
231 {
232 GST_ERROR_OBJECT (cacasink, "invalid format");
233 return FALSE;
234 }
235 no_bitmap:
236 {
237 GST_ERROR_OBJECT (cacasink, "could not create bitmap");
238 return FALSE;
239 }
240 }
241
242 static void
gst_cacasink_init(GstCACASink * cacasink)243 gst_cacasink_init (GstCACASink * cacasink)
244 {
245 cacasink->screen_width = GST_CACA_DEFAULT_SCREEN_WIDTH;
246 cacasink->screen_height = GST_CACA_DEFAULT_SCREEN_HEIGHT;
247
248 cacasink->dither = GST_CACA_DEFAULT_DITHER;
249 cacasink->antialiasing = GST_CACA_DEFAULT_ANTIALIASING;
250 }
251
252 static GstFlowReturn
gst_cacasink_render(GstBaseSink * basesink,GstBuffer * buffer)253 gst_cacasink_render (GstBaseSink * basesink, GstBuffer * buffer)
254 {
255 GstCACASink *cacasink = GST_CACASINK (basesink);
256 GstVideoFrame frame;
257
258 GST_DEBUG ("render");
259
260 if (!gst_video_frame_map (&frame, &cacasink->info, buffer, GST_MAP_READ))
261 goto invalid_frame;
262
263 caca_clear ();
264 caca_draw_bitmap (0, 0, cacasink->screen_width - 1,
265 cacasink->screen_height - 1, cacasink->bitmap,
266 GST_VIDEO_FRAME_PLANE_DATA (&frame, 0));
267 caca_refresh ();
268
269 gst_video_frame_unmap (&frame);
270
271 return GST_FLOW_OK;
272
273 /* ERRORS */
274 invalid_frame:
275 {
276 GST_ERROR_OBJECT (cacasink, "invalid frame received");
277 return GST_FLOW_ERROR;
278 }
279 }
280
281 static void
gst_cacasink_set_property(GObject * object,guint prop_id,const GValue * value,GParamSpec * pspec)282 gst_cacasink_set_property (GObject * object, guint prop_id,
283 const GValue * value, GParamSpec * pspec)
284 {
285 GstCACASink *cacasink;
286
287 g_return_if_fail (GST_IS_CACASINK (object));
288
289 cacasink = GST_CACASINK (object);
290
291 switch (prop_id) {
292 case PROP_DITHER:{
293 cacasink->dither = g_value_get_enum (value);
294 caca_set_dithering (cacasink->dither + CACA_DITHERING_NONE);
295 break;
296 }
297 case PROP_ANTIALIASING:{
298 cacasink->antialiasing = g_value_get_boolean (value);
299 if (cacasink->antialiasing) {
300 caca_set_feature (CACA_ANTIALIASING_MAX);
301 } else {
302 caca_set_feature (CACA_ANTIALIASING_MIN);
303 }
304 break;
305 }
306 default:
307 break;
308 }
309 }
310
311 static void
gst_cacasink_get_property(GObject * object,guint prop_id,GValue * value,GParamSpec * pspec)312 gst_cacasink_get_property (GObject * object, guint prop_id, GValue * value,
313 GParamSpec * pspec)
314 {
315 GstCACASink *cacasink;
316
317 cacasink = GST_CACASINK (object);
318
319 switch (prop_id) {
320 case PROP_SCREEN_WIDTH:{
321 g_value_set_int (value, cacasink->screen_width);
322 break;
323 }
324 case PROP_SCREEN_HEIGHT:{
325 g_value_set_int (value, cacasink->screen_height);
326 break;
327 }
328 case PROP_DITHER:{
329 g_value_set_enum (value, cacasink->dither);
330 break;
331 }
332 case PROP_ANTIALIASING:{
333 g_value_set_boolean (value, cacasink->antialiasing);
334 break;
335 }
336 default:{
337 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
338 break;
339 }
340 }
341 }
342
343 static gboolean
gst_cacasink_open(GstCACASink * cacasink)344 gst_cacasink_open (GstCACASink * cacasink)
345 {
346 cacasink->bitmap = NULL;
347
348 if (caca_init () < 0)
349 goto init_failed;
350
351 cacasink->screen_width = caca_get_width ();
352 cacasink->screen_height = caca_get_height ();
353 cacasink->antialiasing = TRUE;
354 caca_set_feature (CACA_ANTIALIASING_MAX);
355 cacasink->dither = 0;
356 caca_set_dithering (CACA_DITHERING_NONE);
357
358 return TRUE;
359
360 /* ERRORS */
361 init_failed:
362 {
363 GST_ELEMENT_ERROR (cacasink, RESOURCE, OPEN_WRITE, (NULL),
364 ("caca_init() failed"));
365 return FALSE;
366 }
367 }
368
369 static void
gst_cacasink_close(GstCACASink * cacasink)370 gst_cacasink_close (GstCACASink * cacasink)
371 {
372 if (cacasink->bitmap) {
373 caca_free_bitmap (cacasink->bitmap);
374 cacasink->bitmap = NULL;
375 }
376 caca_end ();
377 }
378
379 static GstStateChangeReturn
gst_cacasink_change_state(GstElement * element,GstStateChange transition)380 gst_cacasink_change_state (GstElement * element, GstStateChange transition)
381 {
382 GstStateChangeReturn ret;
383
384 switch (transition) {
385 case GST_STATE_CHANGE_READY_TO_PAUSED:
386 if (!gst_cacasink_open (GST_CACASINK (element)))
387 return GST_STATE_CHANGE_FAILURE;
388 break;
389 default:
390 break;
391 }
392
393 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
394
395 switch (transition) {
396 case GST_STATE_CHANGE_PAUSED_TO_READY:
397 gst_cacasink_close (GST_CACASINK (element));
398 break;
399 default:
400 break;
401 }
402 return ret;
403 }
404
405 static gboolean
plugin_init(GstPlugin * plugin)406 plugin_init (GstPlugin * plugin)
407 {
408 if (!gst_element_register (plugin, "cacasink", GST_RANK_NONE,
409 GST_TYPE_CACASINK))
410 return FALSE;
411
412 return TRUE;
413 }
414
415 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
416 GST_VERSION_MINOR,
417 cacasink,
418 "Colored ASCII Art video sink",
419 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)
420