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(GstBuffer *buf, 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 (GstBuffer *buf, gpointer private)
118 guchar *data = GST_BUFFER_DATA(buf);
121 if(GST_BUFFER_SIZE(buf) < 134){
126 if ((data[4] == 0x11 || data[4] == 0x12
127 || data[4] == 0x30 || data[4] == 0x44) && data[5] == 0xaf) {
128 /* check the frame type of the first frame */
129 if ((data[132] == 0x00 || data[132] == 0xfa) && data[133] == 0xf1) {
130 g_print("GstFlxDec: found supported flx format\n");
131 new = gst_caps_new("flxdec_type_find","video/fli", NULL);
141 gst_flxdec_get_type(void)
143 static GType flxdec_type = 0;
146 static const GTypeInfo flxdec_info = {
147 sizeof(GstFlxDecClass), NULL,
149 (GClassInitFunc)gst_flxdec_class_init,
154 (GInstanceInitFunc)gst_flxdec_init,
156 flxdec_type = g_type_register_static(GST_TYPE_ELEMENT, "GstFlxDec", &flxdec_info, 0);
162 gst_flxdec_class_init (GstFlxDecClass *klass)
164 GObjectClass *gobject_class;
165 GstElementClass *gstelement_class;
167 gobject_class = (GObjectClass*)klass;
168 gstelement_class = (GstElementClass*)klass;
170 parent_class = g_type_class_ref(GST_TYPE_ELEMENT);
172 gobject_class->set_property = gst_flxdec_set_property;
173 gobject_class->get_property = gst_flxdec_get_property;
175 gstelement_class->change_state = gst_flxdec_change_state;
181 gst_flxdec_init(GstFlxDec *flxdec)
183 flxdec->sinkpad = gst_pad_new_from_template (
184 GST_PAD_TEMPLATE_GET (sink_factory), "sink");
185 gst_element_add_pad(GST_ELEMENT(flxdec),flxdec->sinkpad);
186 gst_element_set_loop_function(GST_ELEMENT(flxdec),gst_flxdec_loop);
188 flxdec->srcpad = gst_pad_new_from_template (
189 GST_PAD_TEMPLATE_GET (src_video_factory), "src");
190 gst_element_add_pad(GST_ELEMENT(flxdec),flxdec->srcpad);
193 flxdec->frame = NULL;
194 flxdec->delta = NULL;
198 flx_decode_chunks (GstFlxDec *flxdec , gulong count, gchar *data, gchar *dest)
202 g_return_if_fail(data != NULL);
205 hdr = (FlxFrameChunk *) data;
206 data += FlxFrameChunkSize;
211 flx_decode_color(flxdec, data, dest, 2);
212 data += rndalign(hdr->size) - FlxFrameChunkSize;
216 flx_decode_color(flxdec, data, dest, 0);
217 data += rndalign(hdr->size) - FlxFrameChunkSize;
221 flx_decode_brun(flxdec, data, dest);
222 data += rndalign(hdr->size) - FlxFrameChunkSize;
226 flx_decode_delta_fli(flxdec, data, dest);
227 data += rndalign(hdr->size) - FlxFrameChunkSize;
231 flx_decode_delta_flc(flxdec, data, dest);
232 data += rndalign(hdr->size) - FlxFrameChunkSize;
236 memset(dest, 0, flxdec->size);
240 data += rndalign(hdr->size) - FlxFrameChunkSize;
244 g_print("GstFlxDec: Unimplented chunk type: 0x%02x size: %d\n",
246 g_print("GstFlxDec: Skipping...\n");
247 data += rndalign(hdr->size) - FlxFrameChunkSize;
255 flx_decode_color(GstFlxDec *flxdec, guchar *data, guchar *dest, gint scale)
257 guint packs, count, indx;
259 g_return_if_fail(flxdec != NULL);
261 packs = (data[0] + (data[1] << 8));
266 g_print("GstFlxDec: cmap packs: %d\n", packs);
268 /* color map index + skip count */
271 /* number of rgb triplets */
272 count = *data++ & 0xff;
276 g_print("GstFlxDec: cmap count: %d (indx: %d)\n", count, indx);
277 flx_set_palette_vector(flxdec->converter, indx, count, data, scale);
284 flx_decode_brun(GstFlxDec *flxdec, guchar *data, guchar *dest)
286 gulong count, lines, row;
289 g_return_if_fail(flxdec != NULL);
291 lines = flxdec->hdr.height;
294 * should not be used anymore, since the flc format can
295 * contain more then 255 RLE packets. we use the frame
300 row = flxdec->hdr.width;
306 count = 0x100 - count;
325 flx_decode_delta_fli(GstFlxDec *flxdec, guchar *data, guchar *dest)
327 gulong count, packets, lines, start_line, start_l;
330 g_return_if_fail(flxdec != NULL);
331 g_return_if_fail(flxdec->delta != NULL);
334 /* use last frame for delta */
335 memcpy(dest, GST_BUFFER_DATA(flxdec->delta),
336 GST_BUFFER_SIZE(flxdec->delta));
338 start_line = (data[0] + (data[1] << 8));
339 lines = (data[2] + (data[3] << 8));
342 /* start position of delta */
343 dest += (flxdec->hdr.width * start_line);
360 count = 0x100 - count;
372 start_p += flxdec->hdr.width;
378 flx_decode_delta_flc(GstFlxDec *flxdec, guchar *data, guchar *dest)
380 gulong count, lines, start_l, opcode;
383 g_return_if_fail(flxdec != NULL);
384 g_return_if_fail(flxdec->delta != NULL);
387 /* use last frame for delta */
388 memcpy(dest, GST_BUFFER_DATA(flxdec->delta),
389 GST_BUFFER_SIZE(flxdec->delta));
391 lines = (data[0] + (data[1] << 8));
398 dest = start_p + (flxdec->hdr.width * (start_l - lines));
400 /* process opcode(s) */
401 while ((opcode = (data[0] + (data[1] << 8))) & 0xc000) {
403 if ((opcode & 0xc000) == 0xc000) {
405 start_l += (0x10000 - opcode);
406 dest += flxdec->hdr.width * (0x10000 - opcode);
409 dest += flxdec->hdr.width;
410 *dest++ = (opcode & 0xff);
415 /* last opcode is the packet count */
424 /* replicate word run */
425 count = 0x100 - count;
432 /* literal word run */
444 flx_get_data(GstFlxDec *flxdec, gulong size)
449 g_return_val_if_fail (flxdec != NULL, NULL);
451 got_bytes = gst_bytestream_read (flxdec->bs, &retbuf, size);
452 if (got_bytes < size) {
456 gst_bytestream_get_status (flxdec->bs, &remaining, &event);
457 gst_pad_event_default (flxdec->sinkpad, event);
465 gst_flxdec_loop (GstElement *element)
469 guchar *data, *chunk;
473 FlxFrameChunk *flxfh;
475 g_return_if_fail (element != NULL);
476 g_return_if_fail (GST_IS_FLXDEC(element));
478 GST_DEBUG ("entering loop function");
480 flxdec = GST_FLXDEC(element);
482 if (flxdec->state == GST_FLXDEC_READ_HEADER) {
483 databuf = flx_get_data(flxdec, FlxHeaderSize);
486 g_print ("empty buffer\n");
490 data = GST_BUFFER_DATA(databuf);
492 memcpy((char *) &flxdec->hdr, data, sizeof(FlxHeader));
494 gst_buffer_unref (databuf);
499 if (flxh->type != FLX_MAGICHDR_FLI &&
500 flxh->type != FLX_MAGICHDR_FLC &&
501 flxh->type != FLX_MAGICHDR_FLX) {
502 gst_element_error (element, "not a flx file (type %d)\n", flxh->type);
507 g_print("GstFlxDec: size : %d\n", flxh->size);
508 g_print("GstFlxDec: frames : %d\n", flxh->frames);
509 g_print("GstFlxDec: width : %d\n", flxh->width);
510 g_print("GstFlxDec: height : %d\n", flxh->height);
511 g_print("GstFlxDec: depth : %d\n", flxh->depth);
512 g_print("GstFlxDec: speed : %d\n", flxh->speed);
514 flxdec->next_time = 0;
516 if (flxh->type == FLX_MAGICHDR_FLI) {
517 flxdec->frame_time = JIFFIE * flxh->speed;
520 flxdec->frame_time = flxh->speed * GST_MSECOND;
523 gst_pad_try_set_caps (flxdec->srcpad,
527 "bpp", GST_PROPS_INT (32),
528 "depth", GST_PROPS_INT (32),
529 "endianness", GST_PROPS_INT (G_BIG_ENDIAN),
530 "red_mask", GST_PROPS_INT (R_MASK_32),
531 "green_mask", GST_PROPS_INT (G_MASK_32),
532 "blue_mask", GST_PROPS_INT (B_MASK_32),
533 "width", GST_PROPS_INT (flxh->width),
534 "height", GST_PROPS_INT (flxh->height),
535 "framerate", GST_PROPS_FLOAT (GST_SECOND/flxdec->frame_time)));
537 if (flxh->depth <= 8)
538 flxdec->converter = flx_colorspace_converter_new(flxh->width, flxh->height);
540 if (flxh->type == FLX_MAGICHDR_FLC ||
541 flxh->type == FLX_MAGICHDR_FLX) {
542 g_print("GstFlxDec: (FLC) aspect_dx : %d\n", flxh->aspect_dx);
543 g_print("GstFlxDec: (FLC) aspect_dy : %d\n", flxh->aspect_dy);
544 g_print("GstFlxDec: (FLC) oframe1 : 0x%08x\n", flxh->oframe1);
545 g_print("GstFlxDec: (FLC) oframe2 : 0x%08x\n", flxh->oframe2);
549 flxdec->size = (flxh->width * flxh->height);
551 /* create delta and output frame */
552 flxdec->frame = gst_buffer_new();
553 flxdec->delta = gst_buffer_new();
554 GST_BUFFER_DATA(flxdec->frame) = g_malloc(flxdec->size);
555 GST_BUFFER_SIZE(flxdec->frame) = flxdec->size;
556 GST_BUFFER_DATA(flxdec->delta) = g_malloc(flxdec->size);
557 GST_BUFFER_SIZE(flxdec->delta) = flxdec->size;
559 flxdec->state = GST_FLXDEC_PLAYING;
561 else if (flxdec->state == GST_FLXDEC_PLAYING) {
564 databuf = flx_get_data(flxdec, FlxFrameChunkSize);
568 flxfh = (FlxFrameChunk *) GST_BUFFER_DATA(databuf);
572 buf = flx_get_data(flxdec, flxfh->size-FlxFrameChunkSize);
574 chunk = GST_BUFFER_DATA(buf);
576 if (((FlxFrameType *)chunk)->chunks == 0)
579 /* create 32 bits output frame */
580 out = gst_buffer_new();
581 GST_BUFFER_DATA(out) = g_malloc(flxdec->size * 4);
582 GST_BUFFER_SIZE(out) = flxdec->size * 4;
585 flx_decode_chunks(flxdec,
586 ((FlxFrameType *)chunk)->chunks,
587 GST_BUFFER_DATA(buf) + FlxFrameTypeSize,
588 GST_BUFFER_DATA(flxdec->frame));
590 /* destroy input buffer*/
591 gst_buffer_unref(buf);
593 /* save copy of the current frame for possible delta. */
594 memcpy(GST_BUFFER_DATA(flxdec->delta),
595 GST_BUFFER_DATA(flxdec->frame),
596 GST_BUFFER_SIZE(flxdec->delta));
598 /* convert current frame. */
599 flx_colorspace_convert(flxdec->converter,
600 GST_BUFFER_DATA(flxdec->frame),
601 GST_BUFFER_DATA(out));
603 GST_BUFFER_TIMESTAMP (out) = flxdec->next_time;
604 flxdec->next_time += flxdec->frame_time;
606 gst_pad_push(flxdec->srcpad, out);
611 /* destroy header buffer */
612 gst_buffer_unref(databuf);
616 static GstElementStateReturn
617 gst_flxdec_change_state (GstElement *element)
621 flxdec = GST_FLXDEC(element);
623 switch (GST_STATE_TRANSITION (element)) {
624 case GST_STATE_NULL_TO_READY:
626 case GST_STATE_READY_TO_PAUSED:
627 flxdec->bs = gst_bytestream_new (flxdec->sinkpad);
628 flxdec->state = GST_FLXDEC_READ_HEADER;
630 case GST_STATE_PAUSED_TO_PLAYING:
632 case GST_STATE_PLAYING_TO_PAUSED:
634 case GST_STATE_PAUSED_TO_READY:
635 gst_buffer_unref (flxdec->frame);
636 flxdec->frame = NULL;
637 gst_buffer_unref (flxdec->delta);
638 flxdec->delta = NULL;
639 gst_bytestream_destroy (flxdec->bs);
641 case GST_STATE_READY_TO_NULL:
645 parent_class->change_state (element);
647 return GST_STATE_SUCCESS;
651 gst_flxdec_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
655 /* it's not null if we got it, but it might not be ours */
656 g_return_if_fail(GST_IS_FLXDEC(object));
657 flxdec = GST_FLXDEC(object);
666 gst_flxdec_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
670 /* it's not null if we got it, but it might not be ours */
671 g_return_if_fail(GST_IS_FLXDEC(object));
672 flxdec = GST_FLXDEC(object);
676 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
682 plugin_init (GModule *module, GstPlugin *plugin)
684 GstElementFactory *factory;
685 GstTypeFactory *type;
687 /* this filter needs the bytestream package */
688 if (!gst_library_load ("gstbytestream"))
691 factory = gst_element_factory_new("flxdec", GST_TYPE_FLXDEC, &flxdec_details);
692 g_return_val_if_fail(factory != NULL, FALSE);
693 gst_element_factory_set_rank (factory, GST_ELEMENT_RANK_PRIMARY);
695 gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (sink_factory));
696 gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (src_video_factory));
698 gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));
700 type = gst_type_factory_new (&flxdec_definition);
701 gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (type));
706 GstPluginDesc plugin_desc = {