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.
23 #include "gstflxdec.h"
25 #define JIFFIE (1000000/70)
27 static GstCaps* flxdec_type_find(GstBuffer *buf, gpointer private);
29 /* flx element information */
30 static GstElementDetails flxdec_details = {
32 "Codec/Audio/Decoder",
35 "Sepp Wijnands <mrrazz@garbage-coderz.net>"
39 static GstTypeDefinition flxdec_definition = {
46 /* Flx signals and args */
57 GST_PAD_TEMPLATE_FACTORY (sink_factory,
69 GST_PAD_TEMPLATE_FACTORY (src_video_factory,
76 "format", GST_PROPS_FOURCC (GST_MAKE_FOURCC ('R', 'G', 'B', ' ')),
77 "bpp", GST_PROPS_INT (32),
78 "depth", GST_PROPS_INT (32),
79 "endianness", GST_PROPS_INT (G_LITTLE_ENDIAN),
80 "red_mask", GST_PROPS_INT (0x00ff0000),
81 "green_mask", GST_PROPS_INT (0x0000ff00),
82 "blue_mask", GST_PROPS_INT (0x000000ff),
83 "width", GST_PROPS_INT_RANGE(320, 1280),
84 "height", GST_PROPS_INT_RANGE(200, 1024)
89 static void gst_flxdec_class_init (GstFlxDecClass *klass);
90 static void gst_flxdec_init (GstFlxDec *flxdec);
92 static void gst_flxdec_loop (GstElement *element);
94 static GstElementStateReturn
95 gst_flxdec_change_state (GstElement *element);
97 static void gst_flxdec_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
98 static void gst_flxdec_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
101 static void flx_decode_color (GstFlxDec *, guchar *, guchar *, gint);
102 static void flx_decode_brun (GstFlxDec *, guchar *, guchar *);
103 static void flx_decode_delta_fli (GstFlxDec *, guchar *, guchar *);
104 static void flx_decode_delta_flc (GstFlxDec *, guchar *, guchar *);
106 #define rndalign(off) ((off) + ((off) % 2))
108 static GstElementClass *parent_class = NULL;
111 flxdec_type_find (GstBuffer *buf, gpointer private)
113 guchar *data = GST_BUFFER_DATA(buf);
117 if ((data[4] == 0x11 || data[4] == 0x12
118 || data[4] == 0x30 || data[4] == 0x44) && data[5] == 0xaf) {
119 /* check the frame type of the first frame */
120 if ((data[132] == 0x00 || data[132] == 0xfa) && data[133] == 0xf1) {
121 g_print("GstFlxDec: found supported flx format\n");
122 new = gst_caps_new("flxdec_type_find","video/fli", NULL);
132 gst_flxdec_get_type(void)
134 static GType flxdec_type = 0;
137 static const GTypeInfo flxdec_info = {
138 sizeof(GstFlxDecClass), NULL,
140 (GClassInitFunc)gst_flxdec_class_init,
145 (GInstanceInitFunc)gst_flxdec_init,
147 flxdec_type = g_type_register_static(GST_TYPE_ELEMENT, "GstFlxDec", &flxdec_info, 0);
153 gst_flxdec_class_init (GstFlxDecClass *klass)
155 GObjectClass *gobject_class;
156 GstElementClass *gstelement_class;
158 gobject_class = (GObjectClass*)klass;
159 gstelement_class = (GstElementClass*)klass;
161 parent_class = g_type_class_ref(GST_TYPE_ELEMENT);
163 gobject_class->set_property = gst_flxdec_set_property;
164 gobject_class->get_property = gst_flxdec_get_property;
166 gstelement_class->change_state = gst_flxdec_change_state;
172 gst_flxdec_init(GstFlxDec *flxdec)
174 flxdec->sinkpad = gst_pad_new_from_template (
175 GST_PAD_TEMPLATE_GET (sink_factory), "sink");
176 gst_element_add_pad(GST_ELEMENT(flxdec),flxdec->sinkpad);
177 gst_element_set_loop_function(GST_ELEMENT(flxdec),gst_flxdec_loop);
179 flxdec->srcpad = gst_pad_new_from_template (
180 GST_PAD_TEMPLATE_GET (src_video_factory), "src");
181 gst_element_add_pad(GST_ELEMENT(flxdec),flxdec->srcpad);
184 flxdec->frame = NULL;
185 flxdec->delta = NULL;
189 flx_decode_chunks (GstFlxDec *flxdec , gulong count, gchar *data, gchar *dest)
193 g_return_if_fail(data != NULL);
196 hdr = (FlxFrameChunk *) data;
197 data += FlxFrameChunkSize;
202 flx_decode_color(flxdec, data, dest, 2);
203 data += rndalign(hdr->size) - FlxFrameChunkSize;
207 flx_decode_color(flxdec, data, dest, 0);
208 data += rndalign(hdr->size) - FlxFrameChunkSize;
212 flx_decode_brun(flxdec, data, dest);
213 data += rndalign(hdr->size) - FlxFrameChunkSize;
217 flx_decode_delta_fli(flxdec, data, dest);
218 data += rndalign(hdr->size) - FlxFrameChunkSize;
222 flx_decode_delta_flc(flxdec, data, dest);
223 data += rndalign(hdr->size) - FlxFrameChunkSize;
227 memset(dest, 0, flxdec->size);
231 data += rndalign(hdr->size) - FlxFrameChunkSize;
235 g_print("GstFlxDec: Unimplented chunk type: 0x%02x size: %d\n",
237 g_print("GstFlxDec: Skipping...\n");
238 data += rndalign(hdr->size) - FlxFrameChunkSize;
246 flx_decode_color(GstFlxDec *flxdec, guchar *data, guchar *dest, gint scale)
248 guint packs, count, indx;
250 g_return_if_fail(flxdec != NULL);
252 packs = (data[0] + (data[1] << 8));
257 g_print("GstFlxDec: cmap packs: %d\n", packs);
259 /* color map index + skip count */
262 /* number of rgb triplets */
263 count = *data++ & 0xff;
267 g_print("GstFlxDec: cmap count: %d (indx: %d)\n", count, indx);
268 flx_set_palette_vector(flxdec->converter, indx, count, data, scale);
275 flx_decode_brun(GstFlxDec *flxdec, guchar *data, guchar *dest)
277 gulong count, lines, row;
280 g_return_if_fail(flxdec != NULL);
282 lines = flxdec->hdr.height;
285 * should not be used anymore, since the flc format can
286 * contain more then 255 RLE packets. we use the frame
291 row = flxdec->hdr.width;
297 count = 0x100 - count;
316 flx_decode_delta_fli(GstFlxDec *flxdec, guchar *data, guchar *dest)
318 gulong count, packets, lines, start_line, start_l;
321 g_return_if_fail(flxdec != NULL);
322 g_return_if_fail(flxdec->delta != NULL);
325 /* use last frame for delta */
326 memcpy(dest, GST_BUFFER_DATA(flxdec->delta),
327 GST_BUFFER_SIZE(flxdec->delta));
329 start_line = (data[0] + (data[1] << 8));
330 lines = (data[2] + (data[3] << 8));
333 /* start position of delta */
334 dest += (flxdec->hdr.width * start_line);
351 count = 0x100 - count;
363 start_p += flxdec->hdr.width;
369 flx_decode_delta_flc(GstFlxDec *flxdec, guchar *data, guchar *dest)
371 gulong count, lines, start_l, opcode;
374 g_return_if_fail(flxdec != NULL);
375 g_return_if_fail(flxdec->delta != NULL);
378 /* use last frame for delta */
379 memcpy(dest, GST_BUFFER_DATA(flxdec->delta),
380 GST_BUFFER_SIZE(flxdec->delta));
382 lines = (data[0] + (data[1] << 8));
389 dest = start_p + (flxdec->hdr.width * (start_l - lines));
391 /* process opcode(s) */
392 while ((opcode = (data[0] + (data[1] << 8))) & 0xc000) {
394 if ((opcode & 0xc000) == 0xc000) {
396 start_l += (0x10000 - opcode);
397 dest += flxdec->hdr.width * (0x10000 - opcode);
400 dest += flxdec->hdr.width;
401 *dest++ = (opcode & 0xff);
406 /* last opcode is the packet count */
415 /* replicate word run */
416 count = 0x100 - count;
423 /* literal word run */
435 flx_get_data(GstFlxDec *flxdec, gulong size)
439 g_return_val_if_fail (flxdec != NULL, NULL);
441 retbuf = gst_bytestream_read (flxdec->bs, size);
446 gst_bytestream_get_status (flxdec->bs, &remaining, &event);
447 gst_pad_event_default (flxdec->sinkpad, event);
455 gst_flxdec_loop (GstElement *element)
459 guchar *data, *chunk;
463 FlxFrameChunk *flxfh;
465 g_return_if_fail (element != NULL);
466 g_return_if_fail (GST_IS_FLXDEC(element));
468 GST_DEBUG (0, "entering loop function");
470 flxdec = GST_FLXDEC(element);
472 if (flxdec->state == GST_FLXDEC_READ_HEADER) {
473 databuf = flx_get_data(flxdec, FlxHeaderSize);
476 g_print ("empty buffer\n");
480 data = GST_BUFFER_DATA(databuf);
482 memcpy((char *) &flxdec->hdr, data, sizeof(FlxHeader));
484 gst_buffer_unref (databuf);
489 if (flxh->type != FLX_MAGICHDR_FLI &&
490 flxh->type != FLX_MAGICHDR_FLC &&
491 flxh->type != FLX_MAGICHDR_FLX) {
492 gst_element_error (element, "not a flx file (type %d)\n", flxh->type);
497 g_print("GstFlxDec: size : %d\n", flxh->size);
498 g_print("GstFlxDec: frames : %d\n", flxh->frames);
499 g_print("GstFlxDec: width : %d\n", flxh->width);
500 g_print("GstFlxDec: height : %d\n", flxh->height);
501 g_print("GstFlxDec: depth : %d\n", flxh->depth);
502 g_print("GstFlxDec: speed : %d\n", flxh->speed);
504 flxdec->next_time = 0;
506 if (flxh->type == FLX_MAGICHDR_FLI) {
507 flxdec->frame_time = JIFFIE * flxh->speed;
510 flxdec->frame_time = flxh->speed * 1000;
513 gst_pad_try_set_caps (flxdec->srcpad,
518 "format", GST_PROPS_FOURCC (GST_MAKE_FOURCC ('R', 'G', 'B', ' ')),
519 "bpp", GST_PROPS_INT (32),
520 "depth", GST_PROPS_INT (32),
521 "endianness", GST_PROPS_INT (G_LITTLE_ENDIAN),
522 "red_mask", GST_PROPS_INT (0x00ff0000),
523 "green_mask", GST_PROPS_INT (0x0000ff00),
524 "blue_mask", GST_PROPS_INT (0x000000ff),
525 "width", GST_PROPS_INT (flxh->width),
526 "height", GST_PROPS_INT (flxh->height),
529 if (flxh->depth <= 8)
530 flxdec->converter = flx_colorspace_converter_new(flxh->width, flxh->height);
532 if (flxh->type == FLX_MAGICHDR_FLC ||
533 flxh->type == FLX_MAGICHDR_FLX) {
534 g_print("GstFlxDec: (FLC) aspect_dx : %d\n", flxh->aspect_dx);
535 g_print("GstFlxDec: (FLC) aspect_dy : %d\n", flxh->aspect_dy);
536 g_print("GstFlxDec: (FLC) oframe1 : 0x%08x\n", flxh->oframe1);
537 g_print("GstFlxDec: (FLC) oframe2 : 0x%08x\n", flxh->oframe2);
541 flxdec->size = (flxh->width * flxh->height);
543 /* create delta and output frame */
544 flxdec->frame = gst_buffer_new();
545 flxdec->delta = gst_buffer_new();
546 GST_BUFFER_DATA(flxdec->frame) = g_malloc(flxdec->size);
547 GST_BUFFER_SIZE(flxdec->frame) = flxdec->size;
548 GST_BUFFER_DATA(flxdec->delta) = g_malloc(flxdec->size);
549 GST_BUFFER_SIZE(flxdec->delta) = flxdec->size;
551 flxdec->state = GST_FLXDEC_PLAYING;
553 else if (flxdec->state == GST_FLXDEC_PLAYING) {
556 databuf = flx_get_data(flxdec, FlxFrameChunkSize);
560 flxfh = (FlxFrameChunk *) GST_BUFFER_DATA(databuf);
564 buf = flx_get_data(flxdec, flxfh->size-FlxFrameChunkSize);
566 chunk = GST_BUFFER_DATA(buf);
568 if (((FlxFrameType *)chunk)->chunks == 0)
571 /* create 32 bits output frame */
572 out = gst_buffer_new();
573 GST_BUFFER_DATA(out) = g_malloc(flxdec->size * 4);
574 GST_BUFFER_SIZE(out) = flxdec->size * 4;
577 flx_decode_chunks(flxdec,
578 ((FlxFrameType *)chunk)->chunks,
579 GST_BUFFER_DATA(buf) + FlxFrameTypeSize,
580 GST_BUFFER_DATA(flxdec->frame));
582 /* destroy input buffer*/
583 gst_buffer_unref(buf);
585 /* save copy of the current frame for possible delta. */
586 memcpy(GST_BUFFER_DATA(flxdec->delta),
587 GST_BUFFER_DATA(flxdec->frame),
588 GST_BUFFER_SIZE(flxdec->delta));
590 /* convert current frame. */
591 flx_colorspace_convert(flxdec->converter,
592 GST_BUFFER_DATA(flxdec->frame),
593 GST_BUFFER_DATA(out));
595 GST_BUFFER_TIMESTAMP (out) = flxdec->next_time;
596 flxdec->next_time += flxdec->frame_time;
598 gst_pad_push(flxdec->srcpad, out);
603 /* destroy header buffer */
604 gst_buffer_unref(databuf);
608 static GstElementStateReturn
609 gst_flxdec_change_state (GstElement *element)
613 flxdec = GST_FLXDEC(element);
615 switch (GST_STATE_TRANSITION (element)) {
616 case GST_STATE_NULL_TO_READY:
618 case GST_STATE_READY_TO_PAUSED:
619 flxdec->bs = gst_bytestream_new (flxdec->sinkpad);
620 flxdec->state = GST_FLXDEC_READ_HEADER;
622 case GST_STATE_PAUSED_TO_PLAYING:
624 case GST_STATE_PLAYING_TO_PAUSED:
626 case GST_STATE_PAUSED_TO_READY:
627 gst_buffer_unref (flxdec->frame);
628 flxdec->frame = NULL;
629 gst_buffer_unref (flxdec->delta);
630 flxdec->delta = NULL;
631 gst_bytestream_destroy (flxdec->bs);
633 case GST_STATE_READY_TO_NULL:
637 parent_class->change_state (element);
639 return GST_STATE_SUCCESS;
643 gst_flxdec_set_property (GObject *object, guint prop_id, const 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);
658 gst_flxdec_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
662 /* it's not null if we got it, but it might not be ours */
663 g_return_if_fail(GST_IS_FLXDEC(object));
664 flxdec = GST_FLXDEC(object);
668 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
674 plugin_init (GModule *module, GstPlugin *plugin)
676 GstElementFactory *factory;
677 GstTypeFactory *type;
679 /* this filter needs the bytestream package */
680 if (!gst_library_load("gstbytestream")) {
681 gst_info("flxdec:: could not load support library: 'gstbytestream'\n");
685 factory = gst_element_factory_new("flxdec", GST_TYPE_FLXDEC, &flxdec_details);
686 g_return_val_if_fail(factory != NULL, FALSE);
688 gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (sink_factory));
689 gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (src_video_factory));
691 gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));
693 type = gst_type_factory_new (&flxdec_definition);
694 gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (type));
699 GstPluginDesc plugin_desc = {