2 * Copyright (C) <1999> Erik Walthinsen <omega@temple-baptist.com>
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.
26 #include "gstflxdec.h"
27 #include <gst/video/video.h>
29 #define JIFFIE (GST_SECOND/70)
31 GST_DEBUG_CATEGORY_STATIC (flxdec_debug);
32 #define GST_CAT_DEFAULT flxdec_debug
34 /* flx element information */
35 static const GstElementDetails flxdec_details =
36 GST_ELEMENT_DETAILS ("FLX audio decoder",
37 "Codec/Decoder/Audio",
39 "Sepp Wijnands <mrrazz@garbage-coderz.net>, Zeeshan Ali <zeenix@gmail.com>");
41 /* Flx signals and args */
54 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
57 GST_STATIC_CAPS ("video/x-fli")
61 static GstStaticPadTemplate src_video_factory = GST_STATIC_PAD_TEMPLATE ("src",
64 GST_STATIC_CAPS (GST_VIDEO_CAPS_xRGB_HOST_ENDIAN)
68 static void gst_flxdec_class_init (GstFlxDecClass * klass);
69 static void gst_flxdec_base_init (GstFlxDecClass * klass);
70 static void gst_flxdec_init (GstFlxDec * flxdec);
72 static GstFlowReturn gst_flxdec_chain (GstPad * pad, GstBuffer * buf);
74 static GstStateChangeReturn gst_flxdec_change_state (GstElement * element,
75 GstStateChange transition);
77 static gboolean gst_flxdec_src_query_handler (GstPad * pad, GstQuery * query);
78 static gboolean gst_flxdec_src_event_handler (GstPad * pad, GstEvent * event);
79 static gboolean gst_flxdec_sink_event_handler (GstPad * pad, GstEvent * event);
81 static void gst_flxdec_set_property (GObject * object, guint prop_id,
82 const GValue * value, GParamSpec * pspec);
83 static void gst_flxdec_get_property (GObject * object, guint prop_id,
84 GValue * value, GParamSpec * pspec);
87 static void flx_decode_color (GstFlxDec *, guchar *, guchar *, gint);
88 static void flx_decode_brun (GstFlxDec *, guchar *, guchar *);
89 static void flx_decode_delta_fli (GstFlxDec *, guchar *, guchar *);
90 static void flx_decode_delta_flc (GstFlxDec *, guchar *, guchar *);
92 #define rndalign(off) ((off) + ((off) & 1))
94 static GstElementClass *parent_class = NULL;
97 gst_flxdec_get_type (void)
99 static GType flxdec_type = 0;
102 static const GTypeInfo flxdec_info = {
103 sizeof (GstFlxDecClass),
104 (GBaseInitFunc) gst_flxdec_base_init,
106 (GClassInitFunc) gst_flxdec_class_init,
111 (GInstanceInitFunc) gst_flxdec_init,
115 g_type_register_static (GST_TYPE_ELEMENT, "GstFlxDec", &flxdec_info, 0);
121 gst_flxdec_base_init (GstFlxDecClass * klass)
123 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
125 gst_element_class_set_details (gstelement_class, &flxdec_details);
126 gst_element_class_add_pad_template (gstelement_class,
127 gst_static_pad_template_get (&sink_factory));
128 gst_element_class_add_pad_template (gstelement_class,
129 gst_static_pad_template_get (&src_video_factory));
133 gst_flxdec_class_init (GstFlxDecClass * klass)
135 GObjectClass *gobject_class;
136 GstElementClass *gstelement_class;
138 gobject_class = (GObjectClass *) klass;
139 gstelement_class = (GstElementClass *) klass;
141 parent_class = g_type_class_peek_parent (klass);
143 GST_DEBUG_CATEGORY_INIT (flxdec_debug, "flxdec", 0, "FLX video decoder");
145 gobject_class->set_property = gst_flxdec_set_property;
146 gobject_class->get_property = gst_flxdec_get_property;
148 gstelement_class->change_state = gst_flxdec_change_state;
152 gst_flxdec_init (GstFlxDec * flxdec)
154 flxdec->sinkpad = gst_pad_new_from_static_template (&sink_factory, "sink");
155 gst_element_add_pad (GST_ELEMENT (flxdec), flxdec->sinkpad);
156 gst_pad_set_chain_function (flxdec->sinkpad, gst_flxdec_chain);
157 gst_pad_set_event_function (flxdec->sinkpad, gst_flxdec_sink_event_handler);
159 flxdec->srcpad = gst_pad_new_from_static_template (&src_video_factory, "src");
160 gst_element_add_pad (GST_ELEMENT (flxdec), flxdec->srcpad);
161 gst_pad_set_query_function (flxdec->srcpad, gst_flxdec_src_query_handler);
162 gst_pad_set_event_function (flxdec->srcpad, gst_flxdec_src_event_handler);
164 gst_pad_use_fixed_caps (flxdec->srcpad);
166 flxdec->frame = NULL;
167 flxdec->delta = NULL;
169 flxdec->adapter = gst_adapter_new ();
173 gst_flxdec_src_query_handler (GstPad * pad, GstQuery * query)
175 GstFlxDec *flxdec = (GstFlxDec *) gst_pad_get_parent (pad);
176 gboolean ret = FALSE;
178 switch (GST_QUERY_TYPE (query)) {
179 case GST_QUERY_DURATION:
183 gst_query_parse_duration (query, &format, NULL);
185 if (format != GST_FORMAT_TIME)
188 gst_query_set_duration (query, format, flxdec->duration);
196 gst_object_unref (flxdec);
202 gst_flxdec_src_event_handler (GstPad * pad, GstEvent * event)
204 GstFlxDec *flxdec = (GstFlxDec *) gst_pad_get_parent (pad);
207 /* TODO: implement the seek and other event handling */
209 ret = gst_pad_push_event (flxdec->sinkpad, event);
211 gst_object_unref (flxdec);
217 gst_flxdec_sink_event_handler (GstPad * pad, GstEvent * event)
222 flxdec = GST_FLXDEC (gst_pad_get_parent (pad));
224 ret = gst_pad_push_event (flxdec->srcpad, event);
226 gst_object_unref (flxdec);
231 flx_decode_chunks (GstFlxDec * flxdec, gulong count, guchar * data,
236 g_return_if_fail (data != NULL);
239 hdr = (FlxFrameChunk *) data;
240 FLX_FRAME_CHUNK_FIX_ENDIANNESS (hdr);
241 data += FlxFrameChunkSize;
245 flx_decode_color (flxdec, data, dest, 2);
246 data += rndalign (hdr->size) - FlxFrameChunkSize;
250 flx_decode_color (flxdec, data, dest, 0);
251 data += rndalign (hdr->size) - FlxFrameChunkSize;
255 flx_decode_brun (flxdec, data, dest);
256 data += rndalign (hdr->size) - FlxFrameChunkSize;
260 flx_decode_delta_fli (flxdec, data, dest);
261 data += rndalign (hdr->size) - FlxFrameChunkSize;
265 flx_decode_delta_flc (flxdec, data, dest);
266 data += rndalign (hdr->size) - FlxFrameChunkSize;
270 memset (dest, 0, flxdec->size);
274 data += rndalign (hdr->size) - FlxFrameChunkSize;
278 GST_WARNING ("Unimplented chunk type: 0x%02x size: %d - skipping",
280 data += rndalign (hdr->size) - FlxFrameChunkSize;
288 flx_decode_color (GstFlxDec * flxdec, guchar * data, guchar * dest, gint scale)
290 guint packs, count, indx;
292 g_return_if_fail (flxdec != NULL);
294 packs = (data[0] + (data[1] << 8));
299 GST_LOG ("GstFlxDec: cmap packs: %d", packs);
301 /* color map index + skip count */
304 /* number of rgb triplets */
305 count = *data++ & 0xff;
309 GST_LOG ("GstFlxDec: cmap count: %d (indx: %d)", count, indx);
310 flx_set_palette_vector (flxdec->converter, indx, count, data, scale);
317 flx_decode_brun (GstFlxDec * flxdec, guchar * data, guchar * dest)
319 gulong count, lines, row;
322 g_return_if_fail (flxdec != NULL);
324 lines = flxdec->hdr.height;
327 * should not be used anymore, since the flc format can
328 * contain more then 255 RLE packets. we use the frame
333 row = flxdec->hdr.width;
339 count = 0x100 - count;
358 flx_decode_delta_fli (GstFlxDec * flxdec, guchar * data, guchar * dest)
360 gulong count, packets, lines, start_line, start_l;
363 g_return_if_fail (flxdec != NULL);
364 g_return_if_fail (flxdec->delta != NULL);
366 /* use last frame for delta */
367 memcpy (dest, GST_BUFFER_DATA (flxdec->delta),
368 GST_BUFFER_SIZE (flxdec->delta));
370 start_line = (data[0] + (data[1] << 8));
371 lines = (data[2] + (data[3] << 8));
374 /* start position of delta */
375 dest += (flxdec->hdr.width * start_line);
392 count = 0x100 - count;
404 start_p += flxdec->hdr.width;
410 flx_decode_delta_flc (GstFlxDec * flxdec, guchar * data, guchar * dest)
412 gulong count, lines, start_l, opcode;
415 g_return_if_fail (flxdec != NULL);
416 g_return_if_fail (flxdec->delta != NULL);
418 /* use last frame for delta */
419 memcpy (dest, GST_BUFFER_DATA (flxdec->delta),
420 GST_BUFFER_SIZE (flxdec->delta));
422 lines = (data[0] + (data[1] << 8));
429 dest = start_p + (flxdec->hdr.width * (start_l - lines));
431 /* process opcode(s) */
432 while ((opcode = (data[0] + (data[1] << 8))) & 0xc000) {
434 if ((opcode & 0xc000) == 0xc000) {
436 start_l += (0x10000 - opcode);
437 dest += flxdec->hdr.width * (0x10000 - opcode);
440 dest += flxdec->hdr.width;
441 *dest++ = (opcode & 0xff);
446 /* last opcode is the packet count */
455 /* replicate word run */
456 count = 0x100 - count;
463 /* literal word run */
475 gst_flxdec_chain (GstPad * pad, GstBuffer * buf)
479 GstFlowReturn res = GST_FLOW_OK;
484 g_return_val_if_fail (buf != NULL, GST_FLOW_ERROR);
485 flxdec = (GstFlxDec *) gst_pad_get_parent (pad);
486 g_return_val_if_fail (flxdec != NULL, GST_FLOW_ERROR);
488 gst_adapter_push (flxdec->adapter, buf);
489 avail = gst_adapter_available (flxdec->adapter);
491 if (flxdec->state == GST_FLXDEC_READ_HEADER) {
492 if (avail >= FlxHeaderSize) {
493 const guint8 *data = gst_adapter_peek (flxdec->adapter, FlxHeaderSize);
495 memcpy ((gchar *) & flxdec->hdr, data, FlxHeaderSize);
496 FLX_HDR_FIX_ENDIANNESS (&(flxdec->hdr));
497 gst_adapter_flush (flxdec->adapter, FlxHeaderSize);
502 if (flxh->type != FLX_MAGICHDR_FLI &&
503 flxh->type != FLX_MAGICHDR_FLC && flxh->type != FLX_MAGICHDR_FLX)
506 GST_LOG ("size : %d", flxh->size);
507 GST_LOG ("frames : %d", flxh->frames);
508 GST_LOG ("width : %d", flxh->width);
509 GST_LOG ("height : %d", flxh->height);
510 GST_LOG ("depth : %d", flxh->depth);
511 GST_LOG ("speed : %d", flxh->speed);
513 flxdec->next_time = 0;
515 if (flxh->type == FLX_MAGICHDR_FLI) {
516 flxdec->frame_time = JIFFIE * flxh->speed;
517 } else if (flxh->speed == 0) {
518 flxdec->frame_time = GST_SECOND / 70;
520 flxdec->frame_time = flxh->speed * GST_MSECOND;
523 flxdec->duration = flxh->frames * flxdec->frame_time;
524 GST_LOG ("duration : %" GST_TIME_FORMAT,
525 GST_TIME_ARGS (flxdec->duration));
527 caps = gst_caps_from_string (GST_VIDEO_CAPS_xRGB_HOST_ENDIAN);
528 gst_caps_set_simple (caps,
529 "width", G_TYPE_INT, flxh->width,
530 "height", G_TYPE_INT, flxh->height,
531 "framerate", GST_TYPE_FRACTION, (gint) GST_MSECOND,
532 (gint) flxdec->frame_time / 1000, NULL);
534 gst_pad_set_caps (flxdec->srcpad, caps);
535 gst_caps_unref (caps);
537 if (flxh->depth <= 8)
539 flx_colorspace_converter_new (flxh->width, flxh->height);
541 if (flxh->type == FLX_MAGICHDR_FLC || flxh->type == FLX_MAGICHDR_FLX) {
542 GST_LOG ("(FLC) aspect_dx : %d", flxh->aspect_dx);
543 GST_LOG ("(FLC) aspect_dy : %d", flxh->aspect_dy);
544 GST_LOG ("(FLC) oframe1 : 0x%08x", flxh->oframe1);
545 GST_LOG ("(FLC) oframe2 : 0x%08x", flxh->oframe2);
548 flxdec->size = (flxh->width * flxh->height);
550 /* create delta and output frame */
551 flxdec->frame = gst_buffer_new ();
552 flxdec->delta = gst_buffer_new ();
553 GST_BUFFER_DATA (flxdec->frame) = g_malloc (flxdec->size);
554 GST_BUFFER_MALLOCDATA (flxdec->frame) = GST_BUFFER_DATA (flxdec->frame);
555 GST_BUFFER_SIZE (flxdec->frame) = flxdec->size;
556 GST_BUFFER_DATA (flxdec->delta) = g_malloc (flxdec->size);
557 GST_BUFFER_MALLOCDATA (flxdec->delta) = GST_BUFFER_DATA (flxdec->delta);
558 GST_BUFFER_SIZE (flxdec->delta) = flxdec->size;
560 flxdec->state = GST_FLXDEC_PLAYING;
562 } else if (flxdec->state == GST_FLXDEC_PLAYING) {
565 /* while we have enough data in the adapter */
566 while (avail >= FlxFrameChunkSize) {
572 data = gst_adapter_peek (flxdec->adapter, FlxFrameChunkSize);
573 memcpy (&flxfh, data, FlxFrameChunkSize);
574 FLX_FRAME_CHUNK_FIX_ENDIANNESS (&flxfh);
578 /* check if we have the complete frame */
579 if (avail < flxfh.size)
583 gst_adapter_flush (flxdec->adapter, FlxFrameChunkSize);
585 chunk = gst_adapter_take (flxdec->adapter,
586 flxfh.size - FlxFrameChunkSize);
587 FLX_FRAME_TYPE_FIX_ENDIANNESS ((FlxFrameType *) chunk);
588 if (((FlxFrameType *) chunk)->chunks == 0)
591 /* create 32 bits output frame */
592 res = gst_pad_alloc_buffer_and_set_caps (flxdec->srcpad,
593 GST_BUFFER_OFFSET_NONE,
594 flxdec->size * 4, GST_PAD_CAPS (flxdec->srcpad), &out);
595 if (res != GST_FLOW_OK)
599 flx_decode_chunks (flxdec,
600 ((FlxFrameType *) chunk)->chunks,
601 chunk + FlxFrameTypeSize, GST_BUFFER_DATA (flxdec->frame));
603 /* save copy of the current frame for possible delta. */
604 memcpy (GST_BUFFER_DATA (flxdec->delta),
605 GST_BUFFER_DATA (flxdec->frame), GST_BUFFER_SIZE (flxdec->delta));
607 /* convert current frame. */
608 flx_colorspace_convert (flxdec->converter,
609 GST_BUFFER_DATA (flxdec->frame), GST_BUFFER_DATA (out));
611 GST_BUFFER_TIMESTAMP (out) = flxdec->next_time;
612 flxdec->next_time += flxdec->frame_time;
614 gst_pad_push (flxdec->srcpad, out);
621 avail = gst_adapter_available (flxdec->adapter);
625 gst_object_unref (flxdec);
631 GST_ELEMENT_ERROR (flxdec, STREAM, WRONG_TYPE, (NULL),
632 ("not a flx file (type %x)", flxh->type));
633 gst_object_unref (flxdec);
634 return GST_FLOW_ERROR;
638 static GstStateChangeReturn
639 gst_flxdec_change_state (GstElement * element, GstStateChange transition)
642 GstStateChangeReturn ret;
644 flxdec = GST_FLXDEC (element);
646 switch (transition) {
647 case GST_STATE_CHANGE_NULL_TO_READY:
649 case GST_STATE_CHANGE_READY_TO_PAUSED:
650 gst_adapter_clear (flxdec->adapter);
651 flxdec->state = GST_FLXDEC_READ_HEADER;
653 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
659 ret = parent_class->change_state (element, transition);
661 switch (transition) {
662 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
664 case GST_STATE_CHANGE_PAUSED_TO_READY:
666 gst_buffer_unref (flxdec->frame);
667 flxdec->frame = NULL;
670 gst_buffer_unref (flxdec->delta);
671 flxdec->delta = NULL;
674 case GST_STATE_CHANGE_READY_TO_NULL:
683 gst_flxdec_set_property (GObject * object, guint prop_id, const GValue * value,
688 g_return_if_fail (GST_IS_FLXDEC (object));
689 flxdec = GST_FLXDEC (object);
698 gst_flxdec_get_property (GObject * object, guint prop_id, GValue * value,
703 g_return_if_fail (GST_IS_FLXDEC (object));
704 flxdec = GST_FLXDEC (object);
708 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
714 plugin_init (GstPlugin * plugin)
716 return gst_element_register (plugin, "flxdec",
717 GST_RANK_PRIMARY, GST_TYPE_FLXDEC);
720 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
724 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)