fc91069a675a393e5000965479dde8913b5d560d
[platform/upstream/gst-plugins-good.git] / ext / libcaca / gstcacasink.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 #ifdef HAVE_CONFIG_H
21 #include "config.h"
22 #endif
23
24 #include <string.h>
25 #include <sys/time.h>
26 #include <gst/navigation/navigation.h>
27
28 #include "gstcacasink.h"
29
30 /* elementfactory information */
31 static GstElementDetails gst_cacasink_details = {
32   "CACA sink",
33   "Sink/Video",
34   "A colored ASCII art videosink",
35   "Zeeshan Ali <zak147@yahoo.com>"
36 };
37
38 /* cacasink signals and args */
39 enum
40 {
41   LAST_SIGNAL
42 };
43
44
45 enum
46 {
47   ARG_0,
48   ARG_SCREEN_WIDTH,
49   ARG_SCREEN_HEIGHT,
50   ARG_DITHER,
51   ARG_ANTIALIASING
52 };
53
54 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
55     GST_PAD_SINK,
56     GST_PAD_ALWAYS,
57     GST_STATIC_CAPS (GST_VIDEO_CAPS_RGB ";" GST_VIDEO_CAPS_RGBx ";"
58         GST_VIDEO_CAPS_RGB_16 ";" GST_VIDEO_CAPS_RGB_15)
59     );
60
61 static void gst_cacasink_base_init (gpointer g_class);
62 static void gst_cacasink_class_init (GstCACASinkClass * klass);
63 static void gst_cacasink_init (GstCACASink * cacasink);
64 static void gst_cacasink_interface_init (GstImplementsInterfaceClass * klass);
65 static void gst_cacasink_set_clock (GstElement * element, GstClock * clock);
66 static gboolean gst_cacasink_interface_supported (GstImplementsInterface *
67     iface, GType type);
68 static void gst_cacasink_navigation_init (GstNavigationInterface * iface);
69 static void gst_cacasink_navigation_send_event (GstNavigation * navigation,
70     GstStructure * structure);
71
72 static void gst_cacasink_chain (GstPad * pad, GstData * _data);
73
74 static void gst_cacasink_set_property (GObject * object, guint prop_id,
75     const GValue * value, GParamSpec * pspec);
76 static void gst_cacasink_get_property (GObject * object, guint prop_id,
77     GValue * value, GParamSpec * pspec);
78
79 static GstElementStateReturn gst_cacasink_change_state (GstElement * element);
80
81 static GstElementClass *parent_class = NULL;
82
83 GType
84 gst_cacasink_get_type (void)
85 {
86   static GType cacasink_type = 0;
87
88   if (!cacasink_type) {
89     static const GTypeInfo cacasink_info = {
90       sizeof (GstCACASinkClass),
91       gst_cacasink_base_init,
92       NULL,
93       (GClassInitFunc) gst_cacasink_class_init,
94       NULL,
95       NULL,
96       sizeof (GstCACASink),
97       0,
98       (GInstanceInitFunc) gst_cacasink_init,
99     };
100
101     static const GInterfaceInfo iface_info = {
102       (GInterfaceInitFunc) gst_cacasink_interface_init,
103       NULL,
104       NULL,
105     };
106
107     static const GInterfaceInfo navigation_info = {
108       (GInterfaceInitFunc) gst_cacasink_navigation_init,
109       NULL,
110       NULL,
111     };
112
113     cacasink_type =
114         g_type_register_static (GST_TYPE_VIDEOSINK, "GstCACASink",
115         &cacasink_info, 0);
116
117     g_type_add_interface_static (cacasink_type, GST_TYPE_IMPLEMENTS_INTERFACE,
118         &iface_info);
119     g_type_add_interface_static (cacasink_type, GST_TYPE_NAVIGATION,
120         &navigation_info);
121   }
122   return cacasink_type;
123 }
124
125 #define GST_TYPE_CACADITHER (gst_cacasink_dither_get_type())
126 static GType
127 gst_cacasink_dither_get_type (void)
128 {
129   static GType dither_type = 0;
130
131   if (!dither_type) {
132     GEnumValue *dithers;
133     gint n_dithers;
134     gint i;
135     gchar *caca_dithernames[] = {
136       "NONE", "ORDERED2", "ORDERED4", "ORDERED8", "RANDOM", NULL
137     };
138
139     n_dithers = 5;
140
141     dithers = g_new0 (GEnumValue, n_dithers + 1);
142
143     for (i = 0; i < n_dithers; i++) {
144       dithers[i].value = i;
145       dithers[i].value_name = g_strdup (caca_dithernames[i]);
146       dithers[i].value_nick = g_strdup (caca_dithernames[i]);
147     }
148     dithers[i].value = 0;
149     dithers[i].value_name = NULL;
150     dithers[i].value_nick = NULL;
151
152     dither_type = g_enum_register_static ("GstCACASinkDithers", dithers);
153   }
154   return dither_type;
155 }
156
157 static void
158 gst_cacasink_base_init (gpointer g_class)
159 {
160   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
161
162   gst_element_class_set_details (element_class, &gst_cacasink_details);
163   gst_element_class_add_pad_template (element_class,
164       gst_static_pad_template_get (&sink_template));
165 }
166
167 static void
168 gst_cacasink_class_init (GstCACASinkClass * klass)
169 {
170   GObjectClass *gobject_class;
171   GstElementClass *gstelement_class;
172   GstVideoSinkClass *gstvs_class;
173
174   gobject_class = (GObjectClass *) klass;
175   gstelement_class = (GstElementClass *) klass;
176   gstvs_class = (GstVideoSinkClass *) klass;
177
178   parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
179
180   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SCREEN_WIDTH, g_param_spec_int ("screen_width", "screen_width", "screen_width", G_MININT, G_MAXINT, 0, G_PARAM_READABLE));       /* CHECKME */
181   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SCREEN_HEIGHT, g_param_spec_int ("screen_height", "screen_height", "screen_height", G_MININT, G_MAXINT, 0, G_PARAM_READABLE));   /* CHECKME */
182   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_DITHER,
183       g_param_spec_enum ("dither", "Dither Type", "Set type of Dither",
184           GST_TYPE_CACADITHER, 0, G_PARAM_READWRITE));
185   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_ANTIALIASING,
186       g_param_spec_boolean ("anti_aliasing", "Anti-Aliasing",
187           "Enables Anti-Aliasing", TRUE, G_PARAM_READWRITE));
188
189   gobject_class->set_property = gst_cacasink_set_property;
190   gobject_class->get_property = gst_cacasink_get_property;
191
192   gstelement_class->change_state = gst_cacasink_change_state;
193
194   gstelement_class->set_clock = gst_cacasink_set_clock;
195 }
196
197 static void
198 gst_cacasink_interface_init (GstImplementsInterfaceClass * klass)
199 {
200   klass->supported = gst_cacasink_interface_supported;
201 }
202
203 static gboolean
204 gst_cacasink_interface_supported (GstImplementsInterface * iface, GType type)
205 {
206   g_assert (type == GST_TYPE_NAVIGATION);
207
208   return (GST_STATE (iface) != GST_STATE_NULL);
209 }
210
211 static void
212 gst_cacasink_navigation_init (GstNavigationInterface * iface)
213 {
214   iface->send_event = gst_cacasink_navigation_send_event;
215 }
216
217 static void
218 gst_cacasink_navigation_send_event (GstNavigation * navigation,
219     GstStructure * structure)
220 {
221   GstCACASink *cacasink = GST_CACASINK (navigation);
222   GstEvent *event;
223
224   event = gst_event_new (GST_EVENT_NAVIGATION);
225   /*GST_EVENT_TIMESTAMP (event) = 0; */
226   event->event_data.structure.structure = structure;
227
228   /* FIXME 
229    * Obviously, the pointer x,y coordinates need to be adjusted by the
230    * window size and relation to the bounding window. */
231
232   gst_pad_send_event (gst_pad_get_peer (GST_VIDEOSINK_PAD (cacasink)), event);
233 }
234
235 static GstPadLinkReturn
236 gst_cacasink_sinkconnect (GstPad * pad, const GstCaps * caps)
237 {
238   GstCACASink *cacasink;
239   GstStructure *structure;
240
241   cacasink = GST_CACASINK (gst_pad_get_parent (pad));
242
243   /* We cannot use library functions if the sink is not open */
244   if (!GST_FLAG_IS_SET (GST_ELEMENT (cacasink), GST_CACASINK_OPEN))
245     return GST_PAD_LINK_DELAYED;
246   /*if (!GST_CAPS_IS_FIXED (caps))
247      return GST_PAD_LINK_DELAYED; */
248
249   structure = gst_caps_get_structure (caps, 0);
250   gst_structure_get_int (structure, "width", &(GST_VIDEOSINK_WIDTH (cacasink)));
251   gst_structure_get_int (structure, "height",
252       &(GST_VIDEOSINK_HEIGHT (cacasink)));
253   gst_structure_get_int (structure, "bpp", &cacasink->bpp);
254   gst_structure_get_int (structure, "red_mask", &cacasink->red_mask);
255   gst_structure_get_int (structure, "green_mask", &cacasink->green_mask);
256   gst_structure_get_int (structure, "blue_mask", &cacasink->blue_mask);
257
258   if (cacasink->bpp == 24) {
259     cacasink->red_mask = GUINT32_FROM_BE (cacasink->red_mask) >> 8;
260     cacasink->green_mask = GUINT32_FROM_BE (cacasink->green_mask) >> 8;
261     cacasink->blue_mask = GUINT32_FROM_BE (cacasink->blue_mask) >> 8;
262   }
263
264   else if (cacasink->bpp == 32) {
265     cacasink->red_mask = GUINT32_FROM_BE (cacasink->red_mask);
266     cacasink->green_mask = GUINT32_FROM_BE (cacasink->green_mask);
267     cacasink->blue_mask = GUINT32_FROM_BE (cacasink->blue_mask);
268   }
269
270   else if (cacasink->bpp == 16 || cacasink->bpp == 15) {
271     cacasink->red_mask = GUINT16_FROM_BE (cacasink->red_mask);
272     cacasink->green_mask = GUINT16_FROM_BE (cacasink->green_mask);
273     cacasink->blue_mask = GUINT16_FROM_BE (cacasink->blue_mask);
274   }
275
276   if (cacasink->bitmap) {
277     caca_free_bitmap (cacasink->bitmap);
278   }
279
280   cacasink->bitmap = caca_create_bitmap (cacasink->bpp,
281       GST_VIDEOSINK_WIDTH (cacasink),
282       GST_VIDEOSINK_HEIGHT (cacasink),
283       GST_VIDEOSINK_WIDTH (cacasink) * cacasink->bpp / 8,
284       cacasink->red_mask, cacasink->green_mask, cacasink->blue_mask, 0);
285
286   if (!cacasink->bitmap) {
287     return GST_PAD_LINK_DELAYED;
288   }
289
290   return GST_PAD_LINK_OK;
291 }
292
293 static void
294 gst_cacasink_set_clock (GstElement * element, GstClock * clock)
295 {
296   GstCACASink *cacasink = GST_CACASINK (element);
297
298   cacasink->clock = clock;
299 }
300
301 static void
302 gst_cacasink_init (GstCACASink * cacasink)
303 {
304   GST_VIDEOSINK_PAD (cacasink) =
305       gst_pad_new_from_template (gst_static_pad_template_get (&sink_template),
306       "sink");
307   gst_element_add_pad (GST_ELEMENT (cacasink), GST_VIDEOSINK_PAD (cacasink));
308   gst_pad_set_chain_function (GST_VIDEOSINK_PAD (cacasink), gst_cacasink_chain);
309   gst_pad_set_link_function (GST_VIDEOSINK_PAD (cacasink),
310       gst_cacasink_sinkconnect);
311
312   cacasink->screen_width = GST_CACA_DEFAULT_SCREEN_WIDTH;
313   cacasink->screen_height = GST_CACA_DEFAULT_SCREEN_HEIGHT;
314   cacasink->bpp = GST_CACA_DEFAULT_BPP;
315   cacasink->red_mask = GST_CACA_DEFAULT_RED_MASK;
316   cacasink->green_mask = GST_CACA_DEFAULT_GREEN_MASK;
317   cacasink->blue_mask = GST_CACA_DEFAULT_BLUE_MASK;
318
319   cacasink->clock = NULL;
320
321   GST_FLAG_SET (cacasink, GST_ELEMENT_THREAD_SUGGESTED);
322 }
323
324 static void
325 gst_cacasink_chain (GstPad * pad, GstData * _data)
326 {
327   GstBuffer *buf = GST_BUFFER (_data);
328   GstCACASink *cacasink;
329
330   g_return_if_fail (pad != NULL);
331   g_return_if_fail (GST_IS_PAD (pad));
332   g_return_if_fail (buf != NULL);
333
334   cacasink = GST_CACASINK (gst_pad_get_parent (pad));
335   /* We cannot use library functions if the sink is not open */
336   if (!GST_FLAG_IS_SET (GST_ELEMENT (cacasink), GST_CACASINK_OPEN))
337     return;
338
339   GST_DEBUG ("videosink: clock wait: %" G_GUINT64_FORMAT,
340       GST_BUFFER_TIMESTAMP (buf));
341
342   if (cacasink->clock && GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
343     gst_element_wait (GST_ELEMENT (cacasink), GST_BUFFER_TIMESTAMP (buf));
344   }
345
346   caca_clear ();
347   caca_draw_bitmap (0, 0, cacasink->screen_width - 1,
348       cacasink->screen_height - 1, cacasink->bitmap, GST_BUFFER_DATA (buf));
349   caca_refresh ();
350
351   gst_buffer_unref (buf);
352 }
353
354 static void
355 gst_cacasink_set_property (GObject * object, guint prop_id,
356     const GValue * value, GParamSpec * pspec)
357 {
358   GstCACASink *cacasink;
359
360   /* it's not null if we got it, but it might not be ours */
361   g_return_if_fail (GST_IS_CACASINK (object));
362
363   cacasink = GST_CACASINK (object);
364
365   switch (prop_id) {
366     case ARG_DITHER:{
367       cacasink->dither = g_value_get_enum (value);
368       caca_set_dithering (cacasink->dither + CACA_DITHERING_NONE);
369       break;
370     }
371     case ARG_ANTIALIASING:{
372       cacasink->antialiasing = g_value_get_boolean (value);
373       if (cacasink->antialiasing) {
374         caca_set_feature (CACA_ANTIALIASING_MAX);
375       }
376
377       else {
378         caca_set_feature (CACA_ANTIALIASING_MIN);
379       }
380       break;
381     }
382     default:
383       break;
384   }
385 }
386
387 static void
388 gst_cacasink_get_property (GObject * object, guint prop_id, GValue * value,
389     GParamSpec * pspec)
390 {
391   GstCACASink *cacasink;
392
393   /* it's not null if we got it, but it might not be ours */
394   cacasink = GST_CACASINK (object);
395
396   switch (prop_id) {
397     case ARG_SCREEN_WIDTH:{
398       g_value_set_int (value, cacasink->screen_width);
399       break;
400     }
401     case ARG_SCREEN_HEIGHT:{
402       g_value_set_int (value, cacasink->screen_height);
403       break;
404     }
405     case ARG_DITHER:{
406       g_value_set_enum (value, cacasink->dither);
407       break;
408     }
409     case ARG_ANTIALIASING:{
410       g_value_set_boolean (value, cacasink->antialiasing);
411       break;
412     }
413     default:{
414       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
415       break;
416     }
417   }
418 }
419
420 static gboolean
421 gst_cacasink_open (GstCACASink * cacasink)
422 {
423   g_return_val_if_fail (!GST_FLAG_IS_SET (cacasink, GST_CACASINK_OPEN), FALSE);
424
425   cacasink->bitmap = NULL;
426   caca_init ();
427
428   cacasink->screen_width = caca_get_width ();
429   cacasink->screen_height = caca_get_height ();
430   cacasink->antialiasing = TRUE;
431   caca_set_feature (CACA_ANTIALIASING_MAX);
432   cacasink->dither = 0;
433   caca_set_dithering (CACA_DITHERING_NONE);
434
435
436   GST_FLAG_SET (cacasink, GST_CACASINK_OPEN);
437
438   return TRUE;
439 }
440
441 static void
442 gst_cacasink_close (GstCACASink * cacasink)
443 {
444   g_return_if_fail (GST_FLAG_IS_SET (cacasink, GST_CACASINK_OPEN));
445
446   if (cacasink->bitmap) {
447     caca_free_bitmap (cacasink->bitmap);
448     cacasink->bitmap = NULL;
449   }
450   caca_end ();
451
452   GST_FLAG_UNSET (cacasink, GST_CACASINK_OPEN);
453 }
454
455 static GstElementStateReturn
456 gst_cacasink_change_state (GstElement * element)
457 {
458   g_return_val_if_fail (GST_IS_CACASINK (element), GST_STATE_FAILURE);
459
460   if (GST_STATE_PENDING (element) == GST_STATE_NULL) {
461     if (GST_FLAG_IS_SET (element, GST_CACASINK_OPEN))
462       gst_cacasink_close (GST_CACASINK (element));
463   } else {
464     if (!GST_FLAG_IS_SET (element, GST_CACASINK_OPEN)) {
465       if (!gst_cacasink_open (GST_CACASINK (element)))
466         return GST_STATE_FAILURE;
467     }
468   }
469
470   if (GST_ELEMENT_CLASS (parent_class)->change_state)
471     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
472
473   return GST_STATE_SUCCESS;
474 }
475
476 static gboolean
477 plugin_init (GstPlugin * plugin)
478 {
479   /* Loading the library containing GstVideoSink, our parent object */
480   if (!gst_library_load ("gstvideo"))
481     return FALSE;
482
483   if (!gst_element_register (plugin, "cacasink", GST_RANK_NONE,
484           GST_TYPE_CACASINK))
485     return FALSE;
486
487   return TRUE;
488 }
489
490 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
491     GST_VERSION_MINOR,
492     "cacasink",
493     "Colored ASCII Art video sink",
494     plugin_init, VERSION, GST_LICENSE, GST_PACKAGE, GST_ORIGIN)