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 GstElementDetails flxdec_details = {
37 "Codec/Decoder/Audio",
39 "Sepp Wijnands <mrrazz@garbage-coderz.net>, Zeeshan Ali <zeenix@gmail.com>"
42 /* Flx signals and args */
55 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
58 GST_STATIC_CAPS ("video/x-fli")
62 static GstStaticPadTemplate src_video_factory = GST_STATIC_PAD_TEMPLATE ("src",
65 GST_STATIC_CAPS (GST_VIDEO_CAPS_xRGB_HOST_ENDIAN)
69 static void gst_flxdec_class_init (GstFlxDecClass * klass);
70 static void gst_flxdec_base_init (GstFlxDecClass * klass);
71 static void gst_flxdec_init (GstFlxDec * flxdec);
73 static GstFlowReturn gst_flxdec_chain (GstPad * pad, GstBuffer * buf);
75 static GstStateChangeReturn gst_flxdec_change_state (GstElement * element,
76 GstStateChange transition);
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) % 2))
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_ref (GST_TYPE_ELEMENT);
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)
155 gst_pad_new_from_template (gst_static_pad_template_get (&sink_factory),
157 gst_element_add_pad (GST_ELEMENT (flxdec), flxdec->sinkpad);
158 gst_pad_set_chain_function (flxdec->sinkpad, gst_flxdec_chain);
159 gst_pad_set_event_function (flxdec->sinkpad, gst_flxdec_sink_event_handler);
162 gst_pad_new_from_template (gst_static_pad_template_get
163 (&src_video_factory), "src");
164 gst_element_add_pad (GST_ELEMENT (flxdec), flxdec->srcpad);
165 gst_pad_set_event_function (flxdec->srcpad, gst_flxdec_src_event_handler);
167 gst_pad_use_fixed_caps (flxdec->srcpad);
169 flxdec->frame = NULL;
170 flxdec->delta = NULL;
172 flxdec->adapter = gst_adapter_new ();
176 gst_flxdec_src_event_handler (GstPad * pad, GstEvent * event)
178 GstFlxDec *flxdec = (GstFlxDec *) gst_pad_get_parent (pad);
181 /* TODO: implement the seek and other event handling */
183 ret = gst_pad_push_event (flxdec->sinkpad, event);
185 gst_object_unref (flxdec);
191 gst_flxdec_sink_event_handler (GstPad * pad, GstEvent * event)
196 flxdec = GST_FLXDEC (gst_pad_get_parent (pad));
198 ret = gst_pad_push_event (flxdec->srcpad, event);
200 gst_object_unref (flxdec);
205 flx_decode_chunks (GstFlxDec * flxdec, gulong count, guchar * data,
210 g_return_if_fail (data != NULL);
213 hdr = (FlxFrameChunk *) data;
214 data += FlxFrameChunkSize;
218 flx_decode_color (flxdec, data, dest, 2);
219 data += rndalign (hdr->size) - FlxFrameChunkSize;
223 flx_decode_color (flxdec, data, dest, 0);
224 data += rndalign (hdr->size) - FlxFrameChunkSize;
228 flx_decode_brun (flxdec, data, dest);
229 data += rndalign (hdr->size) - FlxFrameChunkSize;
233 flx_decode_delta_fli (flxdec, data, dest);
234 data += rndalign (hdr->size) - FlxFrameChunkSize;
238 flx_decode_delta_flc (flxdec, data, dest);
239 data += rndalign (hdr->size) - FlxFrameChunkSize;
243 memset (dest, 0, flxdec->size);
247 data += rndalign (hdr->size) - FlxFrameChunkSize;
251 GST_WARNING ("Unimplented chunk type: 0x%02x size: %d - skipping",
253 data += rndalign (hdr->size) - FlxFrameChunkSize;
261 flx_decode_color (GstFlxDec * flxdec, guchar * data, guchar * dest, gint scale)
263 guint packs, count, indx;
265 g_return_if_fail (flxdec != NULL);
267 packs = (data[0] + (data[1] << 8));
272 GST_LOG ("GstFlxDec: cmap packs: %d", packs);
274 /* color map index + skip count */
277 /* number of rgb triplets */
278 count = *data++ & 0xff;
282 GST_LOG ("GstFlxDec: cmap count: %d (indx: %d)\n", count, indx);
283 flx_set_palette_vector (flxdec->converter, indx, count, data, scale);
290 flx_decode_brun (GstFlxDec * flxdec, guchar * data, guchar * dest)
292 gulong count, lines, row;
295 g_return_if_fail (flxdec != NULL);
297 lines = flxdec->hdr.height;
300 * should not be used anymore, since the flc format can
301 * contain more then 255 RLE packets. we use the frame
306 row = flxdec->hdr.width;
312 count = 0x100 - count;
331 flx_decode_delta_fli (GstFlxDec * flxdec, guchar * data, guchar * dest)
333 gulong count, packets, lines, start_line, start_l;
336 g_return_if_fail (flxdec != NULL);
337 g_return_if_fail (flxdec->delta != NULL);
339 /* use last frame for delta */
340 memcpy (dest, GST_BUFFER_DATA (flxdec->delta),
341 GST_BUFFER_SIZE (flxdec->delta));
343 start_line = (data[0] + (data[1] << 8));
344 lines = (data[2] + (data[3] << 8));
347 /* start position of delta */
348 dest += (flxdec->hdr.width * start_line);
365 count = 0x100 - count;
377 start_p += flxdec->hdr.width;
383 flx_decode_delta_flc (GstFlxDec * flxdec, guchar * data, guchar * dest)
385 gulong count, lines, start_l, opcode;
388 g_return_if_fail (flxdec != NULL);
389 g_return_if_fail (flxdec->delta != NULL);
391 /* use last frame for delta */
392 memcpy (dest, GST_BUFFER_DATA (flxdec->delta),
393 GST_BUFFER_SIZE (flxdec->delta));
395 lines = (data[0] + (data[1] << 8));
402 dest = start_p + (flxdec->hdr.width * (start_l - lines));
404 /* process opcode(s) */
405 while ((opcode = (data[0] + (data[1] << 8))) & 0xc000) {
407 if ((opcode & 0xc000) == 0xc000) {
409 start_l += (0x10000 - opcode);
410 dest += flxdec->hdr.width * (0x10000 - opcode);
413 dest += flxdec->hdr.width;
414 *dest++ = (opcode & 0xff);
419 /* last opcode is the packet count */
428 /* replicate word run */
429 count = 0x100 - count;
436 /* literal word run */
448 gst_flxdec_chain (GstPad * pad, GstBuffer * buf)
452 GstFlowReturn res = GST_FLOW_OK;
457 g_return_val_if_fail (buf != NULL, GST_FLOW_ERROR);
458 flxdec = (GstFlxDec *) gst_pad_get_parent (pad);
459 g_return_val_if_fail (flxdec != NULL, GST_FLOW_ERROR);
461 gst_adapter_push (flxdec->adapter, buf);
462 avail = gst_adapter_available (flxdec->adapter);
464 if (flxdec->state == GST_FLXDEC_READ_HEADER) {
465 if (avail >= FlxHeaderSize) {
466 const guint8 *data = gst_adapter_peek (flxdec->adapter, FlxHeaderSize);
468 memcpy ((gchar *) & flxdec->hdr, data, FlxHeaderSize);
469 gst_adapter_flush (flxdec->adapter, FlxHeaderSize);
474 if (flxh->type != FLX_MAGICHDR_FLI &&
475 flxh->type != FLX_MAGICHDR_FLC && flxh->type != FLX_MAGICHDR_FLX) {
476 GST_ELEMENT_ERROR (flxdec, STREAM, WRONG_TYPE, (NULL),
477 ("not a flx file (type %d)\n", flxh->type));
478 return GST_FLOW_ERROR;
482 GST_LOG ("size : %d\n", flxh->size);
483 GST_LOG ("frames : %d\n", flxh->frames);
484 GST_LOG ("width : %d\n", flxh->width);
485 GST_LOG ("height : %d\n", flxh->height);
486 GST_LOG ("depth : %d\n", flxh->depth);
487 GST_LOG ("speed : %d\n", flxh->speed);
489 flxdec->next_time = 0;
491 if (flxh->type == FLX_MAGICHDR_FLI) {
492 flxdec->frame_time = JIFFIE * flxh->speed;
494 flxdec->frame_time = flxh->speed * GST_MSECOND;
497 caps = gst_caps_from_string (GST_VIDEO_CAPS_xRGB_HOST_ENDIAN);
498 gst_caps_set_simple (caps,
499 "width", G_TYPE_INT, flxh->width,
500 "height", G_TYPE_INT, flxh->height,
501 "framerate", GST_TYPE_FRACTION, (gint) GST_MSECOND,
502 (gint) flxdec->frame_time / 1000, NULL);
504 gst_pad_set_caps (flxdec->srcpad, caps);
505 gst_caps_unref (caps);
507 if (flxh->depth <= 8)
509 flx_colorspace_converter_new (flxh->width, flxh->height);
511 if (flxh->type == FLX_MAGICHDR_FLC || flxh->type == FLX_MAGICHDR_FLX) {
512 GST_LOG ("(FLC) aspect_dx : %d\n", flxh->aspect_dx);
513 GST_LOG ("(FLC) aspect_dy : %d\n", flxh->aspect_dy);
514 GST_LOG ("(FLC) oframe1 : 0x%08x\n", flxh->oframe1);
515 GST_LOG ("(FLC) oframe2 : 0x%08x\n", flxh->oframe2);
518 flxdec->size = (flxh->width * flxh->height);
520 /* create delta and output frame */
521 flxdec->frame = gst_buffer_new ();
522 flxdec->delta = gst_buffer_new ();
523 GST_BUFFER_DATA (flxdec->frame) = g_malloc (flxdec->size);
524 GST_BUFFER_SIZE (flxdec->frame) = flxdec->size;
525 GST_BUFFER_DATA (flxdec->delta) = g_malloc (flxdec->size);
526 GST_BUFFER_SIZE (flxdec->delta) = flxdec->size;
528 flxdec->state = GST_FLXDEC_PLAYING;
530 } else if (flxdec->state == GST_FLXDEC_PLAYING) {
533 if (avail >= FlxFrameChunkSize) {
535 guchar *chunk = NULL;
538 gst_adapter_peek (flxdec->adapter, FlxFrameChunkSize);
539 memcpy (&flxfh, data, FlxFrameChunkSize);
543 if (avail < flxfh.size) {
547 gst_adapter_flush (flxdec->adapter, FlxFrameChunkSize);
548 data = gst_adapter_peek (flxdec->adapter,
549 flxfh.size - FlxFrameChunkSize);
550 chunk = g_memdup (data, flxfh.size - FlxFrameChunkSize);
551 to_flush = flxfh.size - FlxFrameChunkSize;
553 if (((FlxFrameType *) chunk)->chunks == 0)
556 /* create 32 bits output frame */
557 res = gst_pad_alloc_buffer_and_set_caps (flxdec->srcpad,
558 GST_BUFFER_OFFSET_NONE,
559 flxdec->size * 4, GST_PAD_CAPS (flxdec->srcpad), &out);
561 if (res != GST_FLOW_OK)
565 flx_decode_chunks (flxdec,
566 ((FlxFrameType *) chunk)->chunks,
567 chunk + FlxFrameTypeSize, GST_BUFFER_DATA (flxdec->frame));
569 /* save copy of the current frame for possible delta. */
570 memcpy (GST_BUFFER_DATA (flxdec->delta),
571 GST_BUFFER_DATA (flxdec->frame), GST_BUFFER_SIZE (flxdec->delta));
573 /* convert current frame. */
574 flx_colorspace_convert (flxdec->converter,
575 GST_BUFFER_DATA (flxdec->frame), GST_BUFFER_DATA (out));
577 GST_BUFFER_TIMESTAMP (out) = flxdec->next_time;
578 flxdec->next_time += flxdec->frame_time;
580 gst_pad_push (flxdec->srcpad, out);
584 gst_adapter_flush (flxdec->adapter, to_flush);
594 static GstStateChangeReturn
595 gst_flxdec_change_state (GstElement * element, GstStateChange transition)
598 GstStateChangeReturn ret;
600 flxdec = GST_FLXDEC (element);
602 switch (transition) {
603 case GST_STATE_CHANGE_NULL_TO_READY:
605 case GST_STATE_CHANGE_READY_TO_PAUSED:
606 gst_adapter_clear (flxdec->adapter);
607 flxdec->state = GST_FLXDEC_READ_HEADER;
609 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
615 ret = parent_class->change_state (element, transition);
617 switch (transition) {
618 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
620 case GST_STATE_CHANGE_PAUSED_TO_READY:
622 gst_buffer_unref (flxdec->frame);
623 flxdec->frame = NULL;
626 gst_buffer_unref (flxdec->delta);
627 flxdec->delta = NULL;
630 case GST_STATE_CHANGE_READY_TO_NULL:
639 gst_flxdec_set_property (GObject * object, guint prop_id, const GValue * value,
644 g_return_if_fail (GST_IS_FLXDEC (object));
645 flxdec = GST_FLXDEC (object);
654 gst_flxdec_get_property (GObject * object, guint prop_id, GValue * value,
659 g_return_if_fail (GST_IS_FLXDEC (object));
660 flxdec = GST_FLXDEC (object);
664 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
670 plugin_init (GstPlugin * plugin)
672 return gst_element_register (plugin, "flxdec",
673 GST_RANK_PRIMARY, GST_TYPE_FLXDEC);
676 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
680 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)