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 /* flx element information */
32 static GstElementDetails flxdec_details = {
34 "Codec/Decoder/Audio",
36 "Sepp Wijnands <mrrazz@garbage-coderz.net>"
39 /* Flx signals and args */
50 GST_PAD_TEMPLATE_FACTORY (sink_factory,
62 GST_PAD_TEMPLATE_FACTORY (src_video_factory,
69 "bpp", GST_PROPS_INT (32),
70 "depth", GST_PROPS_INT (32),
71 "endianness", GST_PROPS_INT (G_BIG_ENDIAN),
72 "red_mask", GST_PROPS_INT (R_MASK_32),
73 "green_mask", GST_PROPS_INT (G_MASK_32),
74 "blue_mask", GST_PROPS_INT (B_MASK_32),
75 "width", GST_PROPS_INT_RANGE(320, 1280),
76 "height", GST_PROPS_INT_RANGE(200, 1024),
77 "framerate", GST_PROPS_FLOAT_RANGE (0, G_MAXFLOAT)
82 static void gst_flxdec_class_init (GstFlxDecClass *klass);
83 static void gst_flxdec_base_init (GstFlxDecClass *klass);
84 static void gst_flxdec_init (GstFlxDec *flxdec);
86 static void gst_flxdec_loop (GstElement *element);
88 static GstElementStateReturn
89 gst_flxdec_change_state (GstElement *element);
91 static void gst_flxdec_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
92 static void gst_flxdec_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
95 static void flx_decode_color (GstFlxDec *, guchar *, guchar *, gint);
96 static void flx_decode_brun (GstFlxDec *, guchar *, guchar *);
97 static void flx_decode_delta_fli (GstFlxDec *, guchar *, guchar *);
98 static void flx_decode_delta_flc (GstFlxDec *, guchar *, guchar *);
100 #define rndalign(off) ((off) + ((off) % 2))
102 static GstElementClass *parent_class = NULL;
105 gst_flxdec_get_type(void)
107 static GType flxdec_type = 0;
110 static const GTypeInfo flxdec_info = {
111 sizeof(GstFlxDecClass),
112 (GBaseInitFunc)gst_flxdec_base_init,
114 (GClassInitFunc)gst_flxdec_class_init,
119 (GInstanceInitFunc)gst_flxdec_init,
121 flxdec_type = g_type_register_static(GST_TYPE_ELEMENT, "GstFlxDec", &flxdec_info, 0);
127 gst_flxdec_base_init (GstFlxDecClass *klass)
129 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
131 gst_element_class_set_details (gstelement_class, &flxdec_details);
132 gst_element_class_add_pad_template (gstelement_class,
133 GST_PAD_TEMPLATE_GET (sink_factory));
134 gst_element_class_add_pad_template (gstelement_class,
135 GST_PAD_TEMPLATE_GET (src_video_factory));
139 gst_flxdec_class_init (GstFlxDecClass *klass)
141 GObjectClass *gobject_class;
142 GstElementClass *gstelement_class;
144 gobject_class = (GObjectClass*)klass;
145 gstelement_class = (GstElementClass*)klass;
147 parent_class = g_type_class_ref(GST_TYPE_ELEMENT);
149 gobject_class->set_property = gst_flxdec_set_property;
150 gobject_class->get_property = gst_flxdec_get_property;
152 gstelement_class->change_state = gst_flxdec_change_state;
158 gst_flxdec_init(GstFlxDec *flxdec)
160 flxdec->sinkpad = gst_pad_new_from_template (
161 GST_PAD_TEMPLATE_GET (sink_factory), "sink");
162 gst_element_add_pad(GST_ELEMENT(flxdec),flxdec->sinkpad);
163 gst_element_set_loop_function(GST_ELEMENT(flxdec),gst_flxdec_loop);
165 flxdec->srcpad = gst_pad_new_from_template (
166 GST_PAD_TEMPLATE_GET (src_video_factory), "src");
167 gst_element_add_pad(GST_ELEMENT(flxdec),flxdec->srcpad);
170 flxdec->frame = NULL;
171 flxdec->delta = NULL;
175 flx_decode_chunks (GstFlxDec *flxdec , gulong count, gchar *data, gchar *dest)
179 g_return_if_fail(data != NULL);
182 hdr = (FlxFrameChunk *) data;
183 data += FlxFrameChunkSize;
188 flx_decode_color(flxdec, data, dest, 2);
189 data += rndalign(hdr->size) - FlxFrameChunkSize;
193 flx_decode_color(flxdec, data, dest, 0);
194 data += rndalign(hdr->size) - FlxFrameChunkSize;
198 flx_decode_brun(flxdec, data, dest);
199 data += rndalign(hdr->size) - FlxFrameChunkSize;
203 flx_decode_delta_fli(flxdec, data, dest);
204 data += rndalign(hdr->size) - FlxFrameChunkSize;
208 flx_decode_delta_flc(flxdec, data, dest);
209 data += rndalign(hdr->size) - FlxFrameChunkSize;
213 memset(dest, 0, flxdec->size);
217 data += rndalign(hdr->size) - FlxFrameChunkSize;
221 g_print("GstFlxDec: Unimplented chunk type: 0x%02x size: %d\n",
223 g_print("GstFlxDec: Skipping...\n");
224 data += rndalign(hdr->size) - FlxFrameChunkSize;
232 flx_decode_color(GstFlxDec *flxdec, guchar *data, guchar *dest, gint scale)
234 guint packs, count, indx;
236 g_return_if_fail(flxdec != NULL);
238 packs = (data[0] + (data[1] << 8));
243 g_print("GstFlxDec: cmap packs: %d\n", packs);
245 /* color map index + skip count */
248 /* number of rgb triplets */
249 count = *data++ & 0xff;
253 g_print("GstFlxDec: cmap count: %d (indx: %d)\n", count, indx);
254 flx_set_palette_vector(flxdec->converter, indx, count, data, scale);
261 flx_decode_brun(GstFlxDec *flxdec, guchar *data, guchar *dest)
263 gulong count, lines, row;
266 g_return_if_fail(flxdec != NULL);
268 lines = flxdec->hdr.height;
271 * should not be used anymore, since the flc format can
272 * contain more then 255 RLE packets. we use the frame
277 row = flxdec->hdr.width;
283 count = 0x100 - count;
302 flx_decode_delta_fli(GstFlxDec *flxdec, guchar *data, guchar *dest)
304 gulong count, packets, lines, start_line, start_l;
307 g_return_if_fail(flxdec != NULL);
308 g_return_if_fail(flxdec->delta != NULL);
311 /* use last frame for delta */
312 memcpy(dest, GST_BUFFER_DATA(flxdec->delta),
313 GST_BUFFER_SIZE(flxdec->delta));
315 start_line = (data[0] + (data[1] << 8));
316 lines = (data[2] + (data[3] << 8));
319 /* start position of delta */
320 dest += (flxdec->hdr.width * start_line);
337 count = 0x100 - count;
349 start_p += flxdec->hdr.width;
355 flx_decode_delta_flc(GstFlxDec *flxdec, guchar *data, guchar *dest)
357 gulong count, lines, start_l, opcode;
360 g_return_if_fail(flxdec != NULL);
361 g_return_if_fail(flxdec->delta != NULL);
364 /* use last frame for delta */
365 memcpy(dest, GST_BUFFER_DATA(flxdec->delta),
366 GST_BUFFER_SIZE(flxdec->delta));
368 lines = (data[0] + (data[1] << 8));
375 dest = start_p + (flxdec->hdr.width * (start_l - lines));
377 /* process opcode(s) */
378 while ((opcode = (data[0] + (data[1] << 8))) & 0xc000) {
380 if ((opcode & 0xc000) == 0xc000) {
382 start_l += (0x10000 - opcode);
383 dest += flxdec->hdr.width * (0x10000 - opcode);
386 dest += flxdec->hdr.width;
387 *dest++ = (opcode & 0xff);
392 /* last opcode is the packet count */
401 /* replicate word run */
402 count = 0x100 - count;
409 /* literal word run */
421 flx_get_data(GstFlxDec *flxdec, gulong size)
426 g_return_val_if_fail (flxdec != NULL, NULL);
428 got_bytes = gst_bytestream_read (flxdec->bs, &retbuf, size);
429 if (got_bytes < size) {
433 gst_bytestream_get_status (flxdec->bs, &remaining, &event);
434 gst_pad_event_default (flxdec->sinkpad, event);
442 gst_flxdec_loop (GstElement *element)
446 guchar *data, *chunk;
450 FlxFrameChunk *flxfh;
452 g_return_if_fail (element != NULL);
453 g_return_if_fail (GST_IS_FLXDEC(element));
455 GST_DEBUG ("entering loop function");
457 flxdec = GST_FLXDEC(element);
459 if (flxdec->state == GST_FLXDEC_READ_HEADER) {
460 databuf = flx_get_data(flxdec, FlxHeaderSize);
463 g_print ("empty buffer\n");
467 data = GST_BUFFER_DATA(databuf);
469 memcpy((char *) &flxdec->hdr, data, sizeof(FlxHeader));
471 gst_buffer_unref (databuf);
476 if (flxh->type != FLX_MAGICHDR_FLI &&
477 flxh->type != FLX_MAGICHDR_FLC &&
478 flxh->type != FLX_MAGICHDR_FLX) {
479 gst_element_error (element, "not a flx file (type %d)\n", flxh->type);
484 g_print("GstFlxDec: size : %d\n", flxh->size);
485 g_print("GstFlxDec: frames : %d\n", flxh->frames);
486 g_print("GstFlxDec: width : %d\n", flxh->width);
487 g_print("GstFlxDec: height : %d\n", flxh->height);
488 g_print("GstFlxDec: depth : %d\n", flxh->depth);
489 g_print("GstFlxDec: speed : %d\n", flxh->speed);
491 flxdec->next_time = 0;
493 if (flxh->type == FLX_MAGICHDR_FLI) {
494 flxdec->frame_time = JIFFIE * flxh->speed;
497 flxdec->frame_time = flxh->speed * GST_MSECOND;
500 gst_pad_try_set_caps (flxdec->srcpad,
504 "bpp", GST_PROPS_INT (32),
505 "depth", GST_PROPS_INT (32),
506 "endianness", GST_PROPS_INT (G_BIG_ENDIAN),
507 "red_mask", GST_PROPS_INT (R_MASK_32),
508 "green_mask", GST_PROPS_INT (G_MASK_32),
509 "blue_mask", GST_PROPS_INT (B_MASK_32),
510 "width", GST_PROPS_INT (flxh->width),
511 "height", GST_PROPS_INT (flxh->height),
512 "framerate", GST_PROPS_FLOAT (GST_SECOND/flxdec->frame_time)));
514 if (flxh->depth <= 8)
515 flxdec->converter = flx_colorspace_converter_new(flxh->width, flxh->height);
517 if (flxh->type == FLX_MAGICHDR_FLC ||
518 flxh->type == FLX_MAGICHDR_FLX) {
519 g_print("GstFlxDec: (FLC) aspect_dx : %d\n", flxh->aspect_dx);
520 g_print("GstFlxDec: (FLC) aspect_dy : %d\n", flxh->aspect_dy);
521 g_print("GstFlxDec: (FLC) oframe1 : 0x%08x\n", flxh->oframe1);
522 g_print("GstFlxDec: (FLC) oframe2 : 0x%08x\n", flxh->oframe2);
526 flxdec->size = (flxh->width * flxh->height);
528 /* create delta and output frame */
529 flxdec->frame = gst_buffer_new();
530 flxdec->delta = gst_buffer_new();
531 GST_BUFFER_DATA(flxdec->frame) = g_malloc(flxdec->size);
532 GST_BUFFER_SIZE(flxdec->frame) = flxdec->size;
533 GST_BUFFER_DATA(flxdec->delta) = g_malloc(flxdec->size);
534 GST_BUFFER_SIZE(flxdec->delta) = flxdec->size;
536 flxdec->state = GST_FLXDEC_PLAYING;
538 else if (flxdec->state == GST_FLXDEC_PLAYING) {
541 databuf = flx_get_data(flxdec, FlxFrameChunkSize);
545 flxfh = (FlxFrameChunk *) GST_BUFFER_DATA(databuf);
549 buf = flx_get_data(flxdec, flxfh->size-FlxFrameChunkSize);
551 chunk = GST_BUFFER_DATA(buf);
553 if (((FlxFrameType *)chunk)->chunks == 0)
556 /* create 32 bits output frame */
557 out = gst_buffer_new();
558 GST_BUFFER_DATA(out) = g_malloc(flxdec->size * 4);
559 GST_BUFFER_SIZE(out) = flxdec->size * 4;
562 flx_decode_chunks(flxdec,
563 ((FlxFrameType *)chunk)->chunks,
564 GST_BUFFER_DATA(buf) + FlxFrameTypeSize,
565 GST_BUFFER_DATA(flxdec->frame));
567 /* destroy input buffer*/
568 gst_buffer_unref(buf);
570 /* save copy of the current frame for possible delta. */
571 memcpy(GST_BUFFER_DATA(flxdec->delta),
572 GST_BUFFER_DATA(flxdec->frame),
573 GST_BUFFER_SIZE(flxdec->delta));
575 /* convert current frame. */
576 flx_colorspace_convert(flxdec->converter,
577 GST_BUFFER_DATA(flxdec->frame),
578 GST_BUFFER_DATA(out));
580 GST_BUFFER_TIMESTAMP (out) = flxdec->next_time;
581 flxdec->next_time += flxdec->frame_time;
583 gst_pad_push(flxdec->srcpad, GST_DATA (out));
588 /* destroy header buffer */
589 gst_buffer_unref(databuf);
593 static GstElementStateReturn
594 gst_flxdec_change_state (GstElement *element)
598 flxdec = GST_FLXDEC(element);
600 switch (GST_STATE_TRANSITION (element)) {
601 case GST_STATE_NULL_TO_READY:
603 case GST_STATE_READY_TO_PAUSED:
604 flxdec->bs = gst_bytestream_new (flxdec->sinkpad);
605 flxdec->state = GST_FLXDEC_READ_HEADER;
607 case GST_STATE_PAUSED_TO_PLAYING:
609 case GST_STATE_PLAYING_TO_PAUSED:
611 case GST_STATE_PAUSED_TO_READY:
612 gst_buffer_unref (flxdec->frame);
613 flxdec->frame = NULL;
614 gst_buffer_unref (flxdec->delta);
615 flxdec->delta = NULL;
616 gst_bytestream_destroy (flxdec->bs);
618 case GST_STATE_READY_TO_NULL:
622 parent_class->change_state (element);
624 return GST_STATE_SUCCESS;
628 gst_flxdec_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
632 /* it's not null if we got it, but it might not be ours */
633 g_return_if_fail(GST_IS_FLXDEC(object));
634 flxdec = GST_FLXDEC(object);
643 gst_flxdec_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
647 /* it's not null if we got it, but it might not be ours */
648 g_return_if_fail(GST_IS_FLXDEC(object));
649 flxdec = GST_FLXDEC(object);
653 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
659 plugin_init (GstPlugin *plugin)
661 if (!gst_library_load ("gstbytestream"))
664 return gst_element_register (plugin, "flxdec",
665 GST_RANK_PRIMARY, GST_TYPE_FLXDEC);