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 static GstCaps* flxdec_type_find (GstByteStream *bs, gpointer private);
33 /* flx element information */
34 static GstElementDetails flxdec_details = {
36 "Codec/Audio/Decoder",
40 "Sepp Wijnands <mrrazz@garbage-coderz.net>",
44 static GstTypeDefinition flxdec_definition = {
51 /* Flx signals and args */
62 GST_PAD_TEMPLATE_FACTORY (sink_factory,
74 GST_PAD_TEMPLATE_FACTORY (src_video_factory,
81 "bpp", GST_PROPS_INT (32),
82 "depth", GST_PROPS_INT (32),
83 "endianness", GST_PROPS_INT (G_BIG_ENDIAN),
84 "red_mask", GST_PROPS_INT (R_MASK_32),
85 "green_mask", GST_PROPS_INT (G_MASK_32),
86 "blue_mask", GST_PROPS_INT (B_MASK_32),
87 "width", GST_PROPS_INT_RANGE(320, 1280),
88 "height", GST_PROPS_INT_RANGE(200, 1024),
89 "framerate", GST_PROPS_FLOAT_RANGE (0, G_MAXFLOAT)
94 static void gst_flxdec_class_init (GstFlxDecClass *klass);
95 static void gst_flxdec_init (GstFlxDec *flxdec);
97 static void gst_flxdec_loop (GstElement *element);
99 static GstElementStateReturn
100 gst_flxdec_change_state (GstElement *element);
102 static void gst_flxdec_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
103 static void gst_flxdec_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
106 static void flx_decode_color (GstFlxDec *, guchar *, guchar *, gint);
107 static void flx_decode_brun (GstFlxDec *, guchar *, guchar *);
108 static void flx_decode_delta_fli (GstFlxDec *, guchar *, guchar *);
109 static void flx_decode_delta_flc (GstFlxDec *, guchar *, guchar *);
111 #define rndalign(off) ((off) + ((off) % 2))
113 static GstElementClass *parent_class = NULL;
116 flxdec_type_find (GstByteStream *bs, gpointer private)
118 GstBuffer *buf = NULL;
121 if (gst_bytestream_peek (bs, &buf, 134) == 134) {
122 guint8 *data = GST_BUFFER_DATA (buf);
125 if ((data[4] == 0x11 || data[4] == 0x12 ||
126 data[4] == 0x30 || data[4] == 0x44) &&
128 /* check the frame type of the first frame */
129 if ((data[132] == 0x00 || data[132] == 0xfa) && data[133] == 0xf1) {
130 GST_DEBUG ("GstFlxDec: found supported flx format");
131 new = gst_caps_new ("flxdec_type_find",
139 gst_buffer_unref (buf);
147 gst_flxdec_get_type(void)
149 static GType flxdec_type = 0;
152 static const GTypeInfo flxdec_info = {
153 sizeof(GstFlxDecClass), NULL,
155 (GClassInitFunc)gst_flxdec_class_init,
160 (GInstanceInitFunc)gst_flxdec_init,
162 flxdec_type = g_type_register_static(GST_TYPE_ELEMENT, "GstFlxDec", &flxdec_info, 0);
168 gst_flxdec_class_init (GstFlxDecClass *klass)
170 GObjectClass *gobject_class;
171 GstElementClass *gstelement_class;
173 gobject_class = (GObjectClass*)klass;
174 gstelement_class = (GstElementClass*)klass;
176 parent_class = g_type_class_ref(GST_TYPE_ELEMENT);
178 gobject_class->set_property = gst_flxdec_set_property;
179 gobject_class->get_property = gst_flxdec_get_property;
181 gstelement_class->change_state = gst_flxdec_change_state;
187 gst_flxdec_init(GstFlxDec *flxdec)
189 flxdec->sinkpad = gst_pad_new_from_template (
190 GST_PAD_TEMPLATE_GET (sink_factory), "sink");
191 gst_element_add_pad(GST_ELEMENT(flxdec),flxdec->sinkpad);
192 gst_element_set_loop_function(GST_ELEMENT(flxdec),gst_flxdec_loop);
194 flxdec->srcpad = gst_pad_new_from_template (
195 GST_PAD_TEMPLATE_GET (src_video_factory), "src");
196 gst_element_add_pad(GST_ELEMENT(flxdec),flxdec->srcpad);
199 flxdec->frame = NULL;
200 flxdec->delta = NULL;
204 flx_decode_chunks (GstFlxDec *flxdec , gulong count, gchar *data, gchar *dest)
208 g_return_if_fail(data != NULL);
211 hdr = (FlxFrameChunk *) data;
212 data += FlxFrameChunkSize;
217 flx_decode_color(flxdec, data, dest, 2);
218 data += rndalign(hdr->size) - FlxFrameChunkSize;
222 flx_decode_color(flxdec, data, dest, 0);
223 data += rndalign(hdr->size) - FlxFrameChunkSize;
227 flx_decode_brun(flxdec, data, dest);
228 data += rndalign(hdr->size) - FlxFrameChunkSize;
232 flx_decode_delta_fli(flxdec, data, dest);
233 data += rndalign(hdr->size) - FlxFrameChunkSize;
237 flx_decode_delta_flc(flxdec, data, dest);
238 data += rndalign(hdr->size) - FlxFrameChunkSize;
242 memset(dest, 0, flxdec->size);
246 data += rndalign(hdr->size) - FlxFrameChunkSize;
250 g_print("GstFlxDec: Unimplented chunk type: 0x%02x size: %d\n",
252 g_print("GstFlxDec: Skipping...\n");
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 g_print("GstFlxDec: cmap packs: %d\n", packs);
274 /* color map index + skip count */
277 /* number of rgb triplets */
278 count = *data++ & 0xff;
282 g_print("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);
340 /* use last frame for delta */
341 memcpy(dest, GST_BUFFER_DATA(flxdec->delta),
342 GST_BUFFER_SIZE(flxdec->delta));
344 start_line = (data[0] + (data[1] << 8));
345 lines = (data[2] + (data[3] << 8));
348 /* start position of delta */
349 dest += (flxdec->hdr.width * start_line);
366 count = 0x100 - count;
378 start_p += flxdec->hdr.width;
384 flx_decode_delta_flc(GstFlxDec *flxdec, guchar *data, guchar *dest)
386 gulong count, lines, start_l, opcode;
389 g_return_if_fail(flxdec != NULL);
390 g_return_if_fail(flxdec->delta != NULL);
393 /* use last frame for delta */
394 memcpy(dest, GST_BUFFER_DATA(flxdec->delta),
395 GST_BUFFER_SIZE(flxdec->delta));
397 lines = (data[0] + (data[1] << 8));
404 dest = start_p + (flxdec->hdr.width * (start_l - lines));
406 /* process opcode(s) */
407 while ((opcode = (data[0] + (data[1] << 8))) & 0xc000) {
409 if ((opcode & 0xc000) == 0xc000) {
411 start_l += (0x10000 - opcode);
412 dest += flxdec->hdr.width * (0x10000 - opcode);
415 dest += flxdec->hdr.width;
416 *dest++ = (opcode & 0xff);
421 /* last opcode is the packet count */
430 /* replicate word run */
431 count = 0x100 - count;
438 /* literal word run */
450 flx_get_data(GstFlxDec *flxdec, gulong size)
455 g_return_val_if_fail (flxdec != NULL, NULL);
457 got_bytes = gst_bytestream_read (flxdec->bs, &retbuf, size);
458 if (got_bytes < size) {
462 gst_bytestream_get_status (flxdec->bs, &remaining, &event);
463 gst_pad_event_default (flxdec->sinkpad, event);
471 gst_flxdec_loop (GstElement *element)
475 guchar *data, *chunk;
479 FlxFrameChunk *flxfh;
481 g_return_if_fail (element != NULL);
482 g_return_if_fail (GST_IS_FLXDEC(element));
484 GST_DEBUG ("entering loop function");
486 flxdec = GST_FLXDEC(element);
488 if (flxdec->state == GST_FLXDEC_READ_HEADER) {
489 databuf = flx_get_data(flxdec, FlxHeaderSize);
492 g_print ("empty buffer\n");
496 data = GST_BUFFER_DATA(databuf);
498 memcpy((char *) &flxdec->hdr, data, sizeof(FlxHeader));
500 gst_buffer_unref (databuf);
505 if (flxh->type != FLX_MAGICHDR_FLI &&
506 flxh->type != FLX_MAGICHDR_FLC &&
507 flxh->type != FLX_MAGICHDR_FLX) {
508 gst_element_error (element, "not a flx file (type %d)\n", flxh->type);
513 g_print("GstFlxDec: size : %d\n", flxh->size);
514 g_print("GstFlxDec: frames : %d\n", flxh->frames);
515 g_print("GstFlxDec: width : %d\n", flxh->width);
516 g_print("GstFlxDec: height : %d\n", flxh->height);
517 g_print("GstFlxDec: depth : %d\n", flxh->depth);
518 g_print("GstFlxDec: speed : %d\n", flxh->speed);
520 flxdec->next_time = 0;
522 if (flxh->type == FLX_MAGICHDR_FLI) {
523 flxdec->frame_time = JIFFIE * flxh->speed;
526 flxdec->frame_time = flxh->speed * GST_MSECOND;
529 gst_pad_try_set_caps (flxdec->srcpad,
533 "bpp", GST_PROPS_INT (32),
534 "depth", GST_PROPS_INT (32),
535 "endianness", GST_PROPS_INT (G_BIG_ENDIAN),
536 "red_mask", GST_PROPS_INT (R_MASK_32),
537 "green_mask", GST_PROPS_INT (G_MASK_32),
538 "blue_mask", GST_PROPS_INT (B_MASK_32),
539 "width", GST_PROPS_INT (flxh->width),
540 "height", GST_PROPS_INT (flxh->height),
541 "framerate", GST_PROPS_FLOAT (GST_SECOND/flxdec->frame_time)));
543 if (flxh->depth <= 8)
544 flxdec->converter = flx_colorspace_converter_new(flxh->width, flxh->height);
546 if (flxh->type == FLX_MAGICHDR_FLC ||
547 flxh->type == FLX_MAGICHDR_FLX) {
548 g_print("GstFlxDec: (FLC) aspect_dx : %d\n", flxh->aspect_dx);
549 g_print("GstFlxDec: (FLC) aspect_dy : %d\n", flxh->aspect_dy);
550 g_print("GstFlxDec: (FLC) oframe1 : 0x%08x\n", flxh->oframe1);
551 g_print("GstFlxDec: (FLC) oframe2 : 0x%08x\n", flxh->oframe2);
555 flxdec->size = (flxh->width * flxh->height);
557 /* create delta and output frame */
558 flxdec->frame = gst_buffer_new();
559 flxdec->delta = gst_buffer_new();
560 GST_BUFFER_DATA(flxdec->frame) = g_malloc(flxdec->size);
561 GST_BUFFER_SIZE(flxdec->frame) = flxdec->size;
562 GST_BUFFER_DATA(flxdec->delta) = g_malloc(flxdec->size);
563 GST_BUFFER_SIZE(flxdec->delta) = flxdec->size;
565 flxdec->state = GST_FLXDEC_PLAYING;
567 else if (flxdec->state == GST_FLXDEC_PLAYING) {
570 databuf = flx_get_data(flxdec, FlxFrameChunkSize);
574 flxfh = (FlxFrameChunk *) GST_BUFFER_DATA(databuf);
578 buf = flx_get_data(flxdec, flxfh->size-FlxFrameChunkSize);
580 chunk = GST_BUFFER_DATA(buf);
582 if (((FlxFrameType *)chunk)->chunks == 0)
585 /* create 32 bits output frame */
586 out = gst_buffer_new();
587 GST_BUFFER_DATA(out) = g_malloc(flxdec->size * 4);
588 GST_BUFFER_SIZE(out) = flxdec->size * 4;
591 flx_decode_chunks(flxdec,
592 ((FlxFrameType *)chunk)->chunks,
593 GST_BUFFER_DATA(buf) + FlxFrameTypeSize,
594 GST_BUFFER_DATA(flxdec->frame));
596 /* destroy input buffer*/
597 gst_buffer_unref(buf);
599 /* save copy of the current frame for possible delta. */
600 memcpy(GST_BUFFER_DATA(flxdec->delta),
601 GST_BUFFER_DATA(flxdec->frame),
602 GST_BUFFER_SIZE(flxdec->delta));
604 /* convert current frame. */
605 flx_colorspace_convert(flxdec->converter,
606 GST_BUFFER_DATA(flxdec->frame),
607 GST_BUFFER_DATA(out));
609 GST_BUFFER_TIMESTAMP (out) = flxdec->next_time;
610 flxdec->next_time += flxdec->frame_time;
612 gst_pad_push(flxdec->srcpad, GST_DATA (out));
617 /* destroy header buffer */
618 gst_buffer_unref(databuf);
622 static GstElementStateReturn
623 gst_flxdec_change_state (GstElement *element)
627 flxdec = GST_FLXDEC(element);
629 switch (GST_STATE_TRANSITION (element)) {
630 case GST_STATE_NULL_TO_READY:
632 case GST_STATE_READY_TO_PAUSED:
633 flxdec->bs = gst_bytestream_new (flxdec->sinkpad);
634 flxdec->state = GST_FLXDEC_READ_HEADER;
636 case GST_STATE_PAUSED_TO_PLAYING:
638 case GST_STATE_PLAYING_TO_PAUSED:
640 case GST_STATE_PAUSED_TO_READY:
641 gst_buffer_unref (flxdec->frame);
642 flxdec->frame = NULL;
643 gst_buffer_unref (flxdec->delta);
644 flxdec->delta = NULL;
645 gst_bytestream_destroy (flxdec->bs);
647 case GST_STATE_READY_TO_NULL:
651 parent_class->change_state (element);
653 return GST_STATE_SUCCESS;
657 gst_flxdec_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
661 /* it's not null if we got it, but it might not be ours */
662 g_return_if_fail(GST_IS_FLXDEC(object));
663 flxdec = GST_FLXDEC(object);
672 gst_flxdec_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
676 /* it's not null if we got it, but it might not be ours */
677 g_return_if_fail(GST_IS_FLXDEC(object));
678 flxdec = GST_FLXDEC(object);
682 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
688 plugin_init (GModule *module, GstPlugin *plugin)
690 GstElementFactory *factory;
691 GstTypeFactory *type;
693 factory = gst_element_factory_new("flxdec", GST_TYPE_FLXDEC, &flxdec_details);
694 g_return_val_if_fail(factory != NULL, FALSE);
695 gst_element_factory_set_rank (factory, GST_ELEMENT_RANK_PRIMARY);
697 gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (sink_factory));
698 gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (src_video_factory));
700 gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));
702 type = gst_type_factory_new (&flxdec_definition);
703 gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (type));
708 GstPluginDesc plugin_desc = {