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"
28 #define JIFFIE (GST_SECOND/70)
30 static GstCaps* flxdec_type_find(GstBuffer *buf, gpointer private);
32 /* flx element information */
33 static GstElementDetails flxdec_details = {
35 "Codec/Audio/Decoder",
39 "Sepp Wijnands <mrrazz@garbage-coderz.net>"
43 static GstTypeDefinition flxdec_definition = {
50 /* Flx signals and args */
61 GST_PAD_TEMPLATE_FACTORY (sink_factory,
73 GST_PAD_TEMPLATE_FACTORY (src_video_factory,
80 "format", GST_PROPS_FOURCC (GST_MAKE_FOURCC ('R', 'G', 'B', ' ')),
81 "bpp", GST_PROPS_INT (32),
82 "depth", GST_PROPS_INT (32),
83 "endianness", GST_PROPS_INT (G_LITTLE_ENDIAN),
84 "red_mask", GST_PROPS_INT (0x00ff0000),
85 "green_mask", GST_PROPS_INT (0x0000ff00),
86 "blue_mask", GST_PROPS_INT (0x000000ff),
87 "width", GST_PROPS_INT_RANGE(320, 1280),
88 "height", GST_PROPS_INT_RANGE(200, 1024)
93 static void gst_flxdec_class_init (GstFlxDecClass *klass);
94 static void gst_flxdec_init (GstFlxDec *flxdec);
96 static void gst_flxdec_loop (GstElement *element);
98 static GstElementStateReturn
99 gst_flxdec_change_state (GstElement *element);
101 static void gst_flxdec_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
102 static void gst_flxdec_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
105 static void flx_decode_color (GstFlxDec *, guchar *, guchar *, gint);
106 static void flx_decode_brun (GstFlxDec *, guchar *, guchar *);
107 static void flx_decode_delta_fli (GstFlxDec *, guchar *, guchar *);
108 static void flx_decode_delta_flc (GstFlxDec *, guchar *, guchar *);
110 #define rndalign(off) ((off) + ((off) % 2))
112 static GstElementClass *parent_class = NULL;
115 flxdec_type_find (GstBuffer *buf, gpointer private)
117 guchar *data = GST_BUFFER_DATA(buf);
120 if(GST_BUFFER_SIZE(buf) < 134){
125 if ((data[4] == 0x11 || data[4] == 0x12
126 || data[4] == 0x30 || data[4] == 0x44) && data[5] == 0xaf) {
127 /* check the frame type of the first frame */
128 if ((data[132] == 0x00 || data[132] == 0xfa) && data[133] == 0xf1) {
129 g_print("GstFlxDec: found supported flx format\n");
130 new = gst_caps_new("flxdec_type_find","video/fli", NULL);
140 gst_flxdec_get_type(void)
142 static GType flxdec_type = 0;
145 static const GTypeInfo flxdec_info = {
146 sizeof(GstFlxDecClass), NULL,
148 (GClassInitFunc)gst_flxdec_class_init,
153 (GInstanceInitFunc)gst_flxdec_init,
155 flxdec_type = g_type_register_static(GST_TYPE_ELEMENT, "GstFlxDec", &flxdec_info, 0);
161 gst_flxdec_class_init (GstFlxDecClass *klass)
163 GObjectClass *gobject_class;
164 GstElementClass *gstelement_class;
166 gobject_class = (GObjectClass*)klass;
167 gstelement_class = (GstElementClass*)klass;
169 parent_class = g_type_class_ref(GST_TYPE_ELEMENT);
171 gobject_class->set_property = gst_flxdec_set_property;
172 gobject_class->get_property = gst_flxdec_get_property;
174 gstelement_class->change_state = gst_flxdec_change_state;
180 gst_flxdec_init(GstFlxDec *flxdec)
182 flxdec->sinkpad = gst_pad_new_from_template (
183 GST_PAD_TEMPLATE_GET (sink_factory), "sink");
184 gst_element_add_pad(GST_ELEMENT(flxdec),flxdec->sinkpad);
185 gst_element_set_loop_function(GST_ELEMENT(flxdec),gst_flxdec_loop);
187 flxdec->srcpad = gst_pad_new_from_template (
188 GST_PAD_TEMPLATE_GET (src_video_factory), "src");
189 gst_element_add_pad(GST_ELEMENT(flxdec),flxdec->srcpad);
192 flxdec->frame = NULL;
193 flxdec->delta = NULL;
197 flx_decode_chunks (GstFlxDec *flxdec , gulong count, gchar *data, gchar *dest)
201 g_return_if_fail(data != NULL);
204 hdr = (FlxFrameChunk *) data;
205 data += FlxFrameChunkSize;
210 flx_decode_color(flxdec, data, dest, 2);
211 data += rndalign(hdr->size) - FlxFrameChunkSize;
215 flx_decode_color(flxdec, data, dest, 0);
216 data += rndalign(hdr->size) - FlxFrameChunkSize;
220 flx_decode_brun(flxdec, data, dest);
221 data += rndalign(hdr->size) - FlxFrameChunkSize;
225 flx_decode_delta_fli(flxdec, data, dest);
226 data += rndalign(hdr->size) - FlxFrameChunkSize;
230 flx_decode_delta_flc(flxdec, data, dest);
231 data += rndalign(hdr->size) - FlxFrameChunkSize;
235 memset(dest, 0, flxdec->size);
239 data += rndalign(hdr->size) - FlxFrameChunkSize;
243 g_print("GstFlxDec: Unimplented chunk type: 0x%02x size: %d\n",
245 g_print("GstFlxDec: Skipping...\n");
246 data += rndalign(hdr->size) - FlxFrameChunkSize;
254 flx_decode_color(GstFlxDec *flxdec, guchar *data, guchar *dest, gint scale)
256 guint packs, count, indx;
258 g_return_if_fail(flxdec != NULL);
260 packs = (data[0] + (data[1] << 8));
265 g_print("GstFlxDec: cmap packs: %d\n", packs);
267 /* color map index + skip count */
270 /* number of rgb triplets */
271 count = *data++ & 0xff;
275 g_print("GstFlxDec: cmap count: %d (indx: %d)\n", count, indx);
276 flx_set_palette_vector(flxdec->converter, indx, count, data, scale);
283 flx_decode_brun(GstFlxDec *flxdec, guchar *data, guchar *dest)
285 gulong count, lines, row;
288 g_return_if_fail(flxdec != NULL);
290 lines = flxdec->hdr.height;
293 * should not be used anymore, since the flc format can
294 * contain more then 255 RLE packets. we use the frame
299 row = flxdec->hdr.width;
305 count = 0x100 - count;
324 flx_decode_delta_fli(GstFlxDec *flxdec, guchar *data, guchar *dest)
326 gulong count, packets, lines, start_line, start_l;
329 g_return_if_fail(flxdec != NULL);
330 g_return_if_fail(flxdec->delta != NULL);
333 /* use last frame for delta */
334 memcpy(dest, GST_BUFFER_DATA(flxdec->delta),
335 GST_BUFFER_SIZE(flxdec->delta));
337 start_line = (data[0] + (data[1] << 8));
338 lines = (data[2] + (data[3] << 8));
341 /* start position of delta */
342 dest += (flxdec->hdr.width * start_line);
359 count = 0x100 - count;
371 start_p += flxdec->hdr.width;
377 flx_decode_delta_flc(GstFlxDec *flxdec, guchar *data, guchar *dest)
379 gulong count, lines, start_l, opcode;
382 g_return_if_fail(flxdec != NULL);
383 g_return_if_fail(flxdec->delta != NULL);
386 /* use last frame for delta */
387 memcpy(dest, GST_BUFFER_DATA(flxdec->delta),
388 GST_BUFFER_SIZE(flxdec->delta));
390 lines = (data[0] + (data[1] << 8));
397 dest = start_p + (flxdec->hdr.width * (start_l - lines));
399 /* process opcode(s) */
400 while ((opcode = (data[0] + (data[1] << 8))) & 0xc000) {
402 if ((opcode & 0xc000) == 0xc000) {
404 start_l += (0x10000 - opcode);
405 dest += flxdec->hdr.width * (0x10000 - opcode);
408 dest += flxdec->hdr.width;
409 *dest++ = (opcode & 0xff);
414 /* last opcode is the packet count */
423 /* replicate word run */
424 count = 0x100 - count;
431 /* literal word run */
443 flx_get_data(GstFlxDec *flxdec, gulong size)
448 g_return_val_if_fail (flxdec != NULL, NULL);
450 got_bytes = gst_bytestream_read (flxdec->bs, &retbuf, size);
451 if (got_bytes < size) {
455 gst_bytestream_get_status (flxdec->bs, &remaining, &event);
456 gst_pad_event_default (flxdec->sinkpad, event);
464 gst_flxdec_loop (GstElement *element)
468 guchar *data, *chunk;
472 FlxFrameChunk *flxfh;
474 g_return_if_fail (element != NULL);
475 g_return_if_fail (GST_IS_FLXDEC(element));
477 GST_DEBUG ("entering loop function");
479 flxdec = GST_FLXDEC(element);
481 if (flxdec->state == GST_FLXDEC_READ_HEADER) {
482 databuf = flx_get_data(flxdec, FlxHeaderSize);
485 g_print ("empty buffer\n");
489 data = GST_BUFFER_DATA(databuf);
491 memcpy((char *) &flxdec->hdr, data, sizeof(FlxHeader));
493 gst_buffer_unref (databuf);
498 if (flxh->type != FLX_MAGICHDR_FLI &&
499 flxh->type != FLX_MAGICHDR_FLC &&
500 flxh->type != FLX_MAGICHDR_FLX) {
501 gst_element_error (element, "not a flx file (type %d)\n", flxh->type);
506 g_print("GstFlxDec: size : %d\n", flxh->size);
507 g_print("GstFlxDec: frames : %d\n", flxh->frames);
508 g_print("GstFlxDec: width : %d\n", flxh->width);
509 g_print("GstFlxDec: height : %d\n", flxh->height);
510 g_print("GstFlxDec: depth : %d\n", flxh->depth);
511 g_print("GstFlxDec: speed : %d\n", flxh->speed);
513 flxdec->next_time = 0;
515 if (flxh->type == FLX_MAGICHDR_FLI) {
516 flxdec->frame_time = JIFFIE * flxh->speed;
519 flxdec->frame_time = flxh->speed * GST_MSECOND;
522 gst_pad_try_set_caps (flxdec->srcpad,
527 "format", GST_PROPS_FOURCC (GST_MAKE_FOURCC ('R', 'G', 'B', ' ')),
528 "bpp", GST_PROPS_INT (32),
529 "depth", GST_PROPS_INT (32),
530 "endianness", GST_PROPS_INT (G_LITTLE_ENDIAN),
531 "red_mask", GST_PROPS_INT (0x00ff0000),
532 "green_mask", GST_PROPS_INT (0x0000ff00),
533 "blue_mask", GST_PROPS_INT (0x000000ff),
534 "width", GST_PROPS_INT (flxh->width),
535 "height", GST_PROPS_INT (flxh->height),
538 if (flxh->depth <= 8)
539 flxdec->converter = flx_colorspace_converter_new(flxh->width, flxh->height);
541 if (flxh->type == FLX_MAGICHDR_FLC ||
542 flxh->type == FLX_MAGICHDR_FLX) {
543 g_print("GstFlxDec: (FLC) aspect_dx : %d\n", flxh->aspect_dx);
544 g_print("GstFlxDec: (FLC) aspect_dy : %d\n", flxh->aspect_dy);
545 g_print("GstFlxDec: (FLC) oframe1 : 0x%08x\n", flxh->oframe1);
546 g_print("GstFlxDec: (FLC) oframe2 : 0x%08x\n", flxh->oframe2);
550 flxdec->size = (flxh->width * flxh->height);
552 /* create delta and output frame */
553 flxdec->frame = gst_buffer_new();
554 flxdec->delta = gst_buffer_new();
555 GST_BUFFER_DATA(flxdec->frame) = g_malloc(flxdec->size);
556 GST_BUFFER_SIZE(flxdec->frame) = flxdec->size;
557 GST_BUFFER_DATA(flxdec->delta) = g_malloc(flxdec->size);
558 GST_BUFFER_SIZE(flxdec->delta) = flxdec->size;
560 flxdec->state = GST_FLXDEC_PLAYING;
562 else if (flxdec->state == GST_FLXDEC_PLAYING) {
565 databuf = flx_get_data(flxdec, FlxFrameChunkSize);
569 flxfh = (FlxFrameChunk *) GST_BUFFER_DATA(databuf);
573 buf = flx_get_data(flxdec, flxfh->size-FlxFrameChunkSize);
575 chunk = GST_BUFFER_DATA(buf);
577 if (((FlxFrameType *)chunk)->chunks == 0)
580 /* create 32 bits output frame */
581 out = gst_buffer_new();
582 GST_BUFFER_DATA(out) = g_malloc(flxdec->size * 4);
583 GST_BUFFER_SIZE(out) = flxdec->size * 4;
586 flx_decode_chunks(flxdec,
587 ((FlxFrameType *)chunk)->chunks,
588 GST_BUFFER_DATA(buf) + FlxFrameTypeSize,
589 GST_BUFFER_DATA(flxdec->frame));
591 /* destroy input buffer*/
592 gst_buffer_unref(buf);
594 /* save copy of the current frame for possible delta. */
595 memcpy(GST_BUFFER_DATA(flxdec->delta),
596 GST_BUFFER_DATA(flxdec->frame),
597 GST_BUFFER_SIZE(flxdec->delta));
599 /* convert current frame. */
600 flx_colorspace_convert(flxdec->converter,
601 GST_BUFFER_DATA(flxdec->frame),
602 GST_BUFFER_DATA(out));
604 GST_BUFFER_TIMESTAMP (out) = flxdec->next_time;
605 flxdec->next_time += flxdec->frame_time;
607 gst_pad_push(flxdec->srcpad, out);
612 /* destroy header buffer */
613 gst_buffer_unref(databuf);
617 static GstElementStateReturn
618 gst_flxdec_change_state (GstElement *element)
622 flxdec = GST_FLXDEC(element);
624 switch (GST_STATE_TRANSITION (element)) {
625 case GST_STATE_NULL_TO_READY:
627 case GST_STATE_READY_TO_PAUSED:
628 flxdec->bs = gst_bytestream_new (flxdec->sinkpad);
629 flxdec->state = GST_FLXDEC_READ_HEADER;
631 case GST_STATE_PAUSED_TO_PLAYING:
633 case GST_STATE_PLAYING_TO_PAUSED:
635 case GST_STATE_PAUSED_TO_READY:
636 gst_buffer_unref (flxdec->frame);
637 flxdec->frame = NULL;
638 gst_buffer_unref (flxdec->delta);
639 flxdec->delta = NULL;
640 gst_bytestream_destroy (flxdec->bs);
642 case GST_STATE_READY_TO_NULL:
646 parent_class->change_state (element);
648 return GST_STATE_SUCCESS;
652 gst_flxdec_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
656 /* it's not null if we got it, but it might not be ours */
657 g_return_if_fail(GST_IS_FLXDEC(object));
658 flxdec = GST_FLXDEC(object);
667 gst_flxdec_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
671 /* it's not null if we got it, but it might not be ours */
672 g_return_if_fail(GST_IS_FLXDEC(object));
673 flxdec = GST_FLXDEC(object);
677 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
683 plugin_init (GModule *module, GstPlugin *plugin)
685 GstElementFactory *factory;
686 GstTypeFactory *type;
688 /* this filter needs the bytestream package */
689 if (!gst_library_load ("gstbytestream"))
692 factory = gst_element_factory_new("flxdec", GST_TYPE_FLXDEC, &flxdec_details);
693 g_return_val_if_fail(factory != NULL, FALSE);
694 gst_element_factory_set_rank (factory, GST_ELEMENT_RANK_PRIMARY);
696 gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (sink_factory));
697 gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (src_video_factory));
699 gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));
701 type = gst_type_factory_new (&flxdec_definition);
702 gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (type));
707 GstPluginDesc plugin_desc = {