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., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
20 * SECTION:element-cacasink
21 * @see_also: #GstAASink
23 * Displays video as color ascii art.
26 * <title>Example launch line</title>
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.
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.
42 #include "gstcacasink.h"
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
49 /* cacasink signals and args */
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
69 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
72 GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE
73 ("{ RGB, BGR, RGBx, xRGB, BGRx, xBGR, RGB16, RGB15 }"))
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,
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);
87 static GstStateChangeReturn gst_cacasink_change_state (GstElement * element,
88 GstStateChange transition);
90 #define gst_cacasink_parent_class parent_class
91 G_DEFINE_TYPE (GstCACASink, gst_cacasink, GST_TYPE_BASE_SINK);
93 #define GST_TYPE_CACADITHER (gst_cacasink_dither_get_type())
95 gst_cacasink_dither_get_type (void)
97 static GType dither_type = 0;
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"},
109 dither_type = g_enum_register_static ("GstCACASinkDithering", dither_types);
115 gst_cacasink_class_init (GstCACASinkClass * klass)
117 GObjectClass *gobject_class;
118 GstElementClass *gstelement_class;
119 GstBaseSinkClass *gstbasesink_class;
121 gobject_class = (GObjectClass *) klass;
122 gstelement_class = (GstElementClass *) klass;
123 gstbasesink_class = (GstBaseSinkClass *) klass;
125 parent_class = g_type_class_peek_parent (klass);
127 gobject_class->set_property = gst_cacasink_set_property;
128 gobject_class->get_property = gst_cacasink_get_property;
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));
148 gstelement_class->change_state = gst_cacasink_change_state;
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);
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);
162 gst_cacasink_get_times (GstBaseSink * sink, GstBuffer * buffer,
163 GstClockTime * start, GstClockTime * end)
165 *start = GST_BUFFER_TIMESTAMP (buffer);
166 *end = *start + GST_BUFFER_DURATION (buffer);
170 gst_cacasink_setcaps (GstBaseSink * basesink, GstCaps * caps)
172 GstCACASink *cacasink;
174 guint bpp, red_mask, green_mask, blue_mask;
176 cacasink = GST_CACASINK (basesink);
178 if (!gst_video_info_from_caps (&info, caps))
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]);
193 case GST_VIDEO_FORMAT_RGB16:
199 case GST_VIDEO_FORMAT_RGB15:
209 if (cacasink->bitmap) {
210 caca_free_bitmap (cacasink->bitmap);
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)
220 cacasink->info = info;
227 GST_ERROR_OBJECT (cacasink, "error parsing caps");
232 GST_ERROR_OBJECT (cacasink, "invalid format");
237 GST_ERROR_OBJECT (cacasink, "could not create bitmap");
243 gst_cacasink_init (GstCACASink * cacasink)
245 cacasink->screen_width = GST_CACA_DEFAULT_SCREEN_WIDTH;
246 cacasink->screen_height = GST_CACA_DEFAULT_SCREEN_HEIGHT;
248 cacasink->dither = GST_CACA_DEFAULT_DITHER;
249 cacasink->antialiasing = GST_CACA_DEFAULT_ANTIALIASING;
253 gst_cacasink_render (GstBaseSink * basesink, GstBuffer * buffer)
255 GstCACASink *cacasink = GST_CACASINK (basesink);
258 GST_DEBUG ("render");
260 if (!gst_video_frame_map (&frame, &cacasink->info, buffer, GST_MAP_READ))
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));
269 gst_video_frame_unmap (&frame);
276 GST_ERROR_OBJECT (cacasink, "invalid frame received");
277 return GST_FLOW_ERROR;
282 gst_cacasink_set_property (GObject * object, guint prop_id,
283 const GValue * value, GParamSpec * pspec)
285 GstCACASink *cacasink;
287 g_return_if_fail (GST_IS_CACASINK (object));
289 cacasink = GST_CACASINK (object);
293 cacasink->dither = g_value_get_enum (value);
294 caca_set_dithering (cacasink->dither + CACA_DITHERING_NONE);
297 case PROP_ANTIALIASING:{
298 cacasink->antialiasing = g_value_get_boolean (value);
299 if (cacasink->antialiasing) {
300 caca_set_feature (CACA_ANTIALIASING_MAX);
302 caca_set_feature (CACA_ANTIALIASING_MIN);
312 gst_cacasink_get_property (GObject * object, guint prop_id, GValue * value,
315 GstCACASink *cacasink;
317 cacasink = GST_CACASINK (object);
320 case PROP_SCREEN_WIDTH:{
321 g_value_set_int (value, cacasink->screen_width);
324 case PROP_SCREEN_HEIGHT:{
325 g_value_set_int (value, cacasink->screen_height);
329 g_value_set_enum (value, cacasink->dither);
332 case PROP_ANTIALIASING:{
333 g_value_set_boolean (value, cacasink->antialiasing);
337 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
344 gst_cacasink_open (GstCACASink * cacasink)
346 cacasink->bitmap = NULL;
348 if (caca_init () < 0)
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);
363 GST_ELEMENT_ERROR (cacasink, RESOURCE, OPEN_WRITE, (NULL),
364 ("caca_init() failed"));
370 gst_cacasink_close (GstCACASink * cacasink)
372 if (cacasink->bitmap) {
373 caca_free_bitmap (cacasink->bitmap);
374 cacasink->bitmap = NULL;
379 static GstStateChangeReturn
380 gst_cacasink_change_state (GstElement * element, GstStateChange transition)
382 GstStateChangeReturn ret;
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;
393 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
395 switch (transition) {
396 case GST_STATE_CHANGE_PAUSED_TO_READY:
397 gst_cacasink_close (GST_CACASINK (element));
406 plugin_init (GstPlugin * plugin)
408 if (!gst_element_register (plugin, "cacasink", GST_RANK_NONE,
415 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
418 "Colored ASCII Art video sink",
419 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)