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 (GST_SECOND/70)
27 static GstCaps* flxdec_type_find(GstBuffer *buf, gpointer private);
29 /* flx element information */
30 static GstElementDetails flxdec_details = {
32 "Codec/Audio/Decoder",
36 "Sepp Wijnands <mrrazz@garbage-coderz.net>"
40 static GstTypeDefinition flxdec_definition = {
47 /* Flx signals and args */
58 GST_PAD_TEMPLATE_FACTORY (sink_factory,
70 GST_PAD_TEMPLATE_FACTORY (src_video_factory,
77 "format", GST_PROPS_FOURCC (GST_MAKE_FOURCC ('R', 'G', 'B', ' ')),
78 "bpp", GST_PROPS_INT (32),
79 "depth", GST_PROPS_INT (32),
80 "endianness", GST_PROPS_INT (G_LITTLE_ENDIAN),
81 "red_mask", GST_PROPS_INT (0x00ff0000),
82 "green_mask", GST_PROPS_INT (0x0000ff00),
83 "blue_mask", GST_PROPS_INT (0x000000ff),
84 "width", GST_PROPS_INT_RANGE(320, 1280),
85 "height", GST_PROPS_INT_RANGE(200, 1024)
90 static void gst_flxdec_class_init (GstFlxDecClass *klass);
91 static void gst_flxdec_init (GstFlxDec *flxdec);
93 static void gst_flxdec_loop (GstElement *element);
95 static GstElementStateReturn
96 gst_flxdec_change_state (GstElement *element);
98 static void gst_flxdec_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
99 static void gst_flxdec_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
102 static void flx_decode_color (GstFlxDec *, guchar *, guchar *, gint);
103 static void flx_decode_brun (GstFlxDec *, guchar *, guchar *);
104 static void flx_decode_delta_fli (GstFlxDec *, guchar *, guchar *);
105 static void flx_decode_delta_flc (GstFlxDec *, guchar *, guchar *);
107 #define rndalign(off) ((off) + ((off) % 2))
109 static GstElementClass *parent_class = NULL;
112 flxdec_type_find (GstBuffer *buf, gpointer private)
114 guchar *data = GST_BUFFER_DATA(buf);
117 if(GST_BUFFER_SIZE(buf) < 134){
122 if ((data[4] == 0x11 || data[4] == 0x12
123 || data[4] == 0x30 || data[4] == 0x44) && data[5] == 0xaf) {
124 /* check the frame type of the first frame */
125 if ((data[132] == 0x00 || data[132] == 0xfa) && data[133] == 0xf1) {
126 g_print("GstFlxDec: found supported flx format\n");
127 new = gst_caps_new("flxdec_type_find","video/fli", NULL);
137 gst_flxdec_get_type(void)
139 static GType flxdec_type = 0;
142 static const GTypeInfo flxdec_info = {
143 sizeof(GstFlxDecClass), NULL,
145 (GClassInitFunc)gst_flxdec_class_init,
150 (GInstanceInitFunc)gst_flxdec_init,
152 flxdec_type = g_type_register_static(GST_TYPE_ELEMENT, "GstFlxDec", &flxdec_info, 0);
158 gst_flxdec_class_init (GstFlxDecClass *klass)
160 GObjectClass *gobject_class;
161 GstElementClass *gstelement_class;
163 gobject_class = (GObjectClass*)klass;
164 gstelement_class = (GstElementClass*)klass;
166 parent_class = g_type_class_ref(GST_TYPE_ELEMENT);
168 gobject_class->set_property = gst_flxdec_set_property;
169 gobject_class->get_property = gst_flxdec_get_property;
171 gstelement_class->change_state = gst_flxdec_change_state;
177 gst_flxdec_init(GstFlxDec *flxdec)
179 flxdec->sinkpad = gst_pad_new_from_template (
180 GST_PAD_TEMPLATE_GET (sink_factory), "sink");
181 gst_element_add_pad(GST_ELEMENT(flxdec),flxdec->sinkpad);
182 gst_element_set_loop_function(GST_ELEMENT(flxdec),gst_flxdec_loop);
184 flxdec->srcpad = gst_pad_new_from_template (
185 GST_PAD_TEMPLATE_GET (src_video_factory), "src");
186 gst_element_add_pad(GST_ELEMENT(flxdec),flxdec->srcpad);
189 flxdec->frame = NULL;
190 flxdec->delta = NULL;
194 flx_decode_chunks (GstFlxDec *flxdec , gulong count, gchar *data, gchar *dest)
198 g_return_if_fail(data != NULL);
201 hdr = (FlxFrameChunk *) data;
202 data += FlxFrameChunkSize;
207 flx_decode_color(flxdec, data, dest, 2);
208 data += rndalign(hdr->size) - FlxFrameChunkSize;
212 flx_decode_color(flxdec, data, dest, 0);
213 data += rndalign(hdr->size) - FlxFrameChunkSize;
217 flx_decode_brun(flxdec, data, dest);
218 data += rndalign(hdr->size) - FlxFrameChunkSize;
222 flx_decode_delta_fli(flxdec, data, dest);
223 data += rndalign(hdr->size) - FlxFrameChunkSize;
227 flx_decode_delta_flc(flxdec, data, dest);
228 data += rndalign(hdr->size) - FlxFrameChunkSize;
232 memset(dest, 0, flxdec->size);
236 data += rndalign(hdr->size) - FlxFrameChunkSize;
240 g_print("GstFlxDec: Unimplented chunk type: 0x%02x size: %d\n",
242 g_print("GstFlxDec: Skipping...\n");
243 data += rndalign(hdr->size) - FlxFrameChunkSize;
251 flx_decode_color(GstFlxDec *flxdec, guchar *data, guchar *dest, gint scale)
253 guint packs, count, indx;
255 g_return_if_fail(flxdec != NULL);
257 packs = (data[0] + (data[1] << 8));
262 g_print("GstFlxDec: cmap packs: %d\n", packs);
264 /* color map index + skip count */
267 /* number of rgb triplets */
268 count = *data++ & 0xff;
272 g_print("GstFlxDec: cmap count: %d (indx: %d)\n", count, indx);
273 flx_set_palette_vector(flxdec->converter, indx, count, data, scale);
280 flx_decode_brun(GstFlxDec *flxdec, guchar *data, guchar *dest)
282 gulong count, lines, row;
285 g_return_if_fail(flxdec != NULL);
287 lines = flxdec->hdr.height;
290 * should not be used anymore, since the flc format can
291 * contain more then 255 RLE packets. we use the frame
296 row = flxdec->hdr.width;
302 count = 0x100 - count;
321 flx_decode_delta_fli(GstFlxDec *flxdec, guchar *data, guchar *dest)
323 gulong count, packets, lines, start_line, start_l;
326 g_return_if_fail(flxdec != NULL);
327 g_return_if_fail(flxdec->delta != NULL);
330 /* use last frame for delta */
331 memcpy(dest, GST_BUFFER_DATA(flxdec->delta),
332 GST_BUFFER_SIZE(flxdec->delta));
334 start_line = (data[0] + (data[1] << 8));
335 lines = (data[2] + (data[3] << 8));
338 /* start position of delta */
339 dest += (flxdec->hdr.width * start_line);
356 count = 0x100 - count;
368 start_p += flxdec->hdr.width;
374 flx_decode_delta_flc(GstFlxDec *flxdec, guchar *data, guchar *dest)
376 gulong count, lines, start_l, opcode;
379 g_return_if_fail(flxdec != NULL);
380 g_return_if_fail(flxdec->delta != NULL);
383 /* use last frame for delta */
384 memcpy(dest, GST_BUFFER_DATA(flxdec->delta),
385 GST_BUFFER_SIZE(flxdec->delta));
387 lines = (data[0] + (data[1] << 8));
394 dest = start_p + (flxdec->hdr.width * (start_l - lines));
396 /* process opcode(s) */
397 while ((opcode = (data[0] + (data[1] << 8))) & 0xc000) {
399 if ((opcode & 0xc000) == 0xc000) {
401 start_l += (0x10000 - opcode);
402 dest += flxdec->hdr.width * (0x10000 - opcode);
405 dest += flxdec->hdr.width;
406 *dest++ = (opcode & 0xff);
411 /* last opcode is the packet count */
420 /* replicate word run */
421 count = 0x100 - count;
428 /* literal word run */
440 flx_get_data(GstFlxDec *flxdec, gulong size)
445 g_return_val_if_fail (flxdec != NULL, NULL);
447 got_bytes = gst_bytestream_read (flxdec->bs, &retbuf, size);
448 if (got_bytes < size) {
452 gst_bytestream_get_status (flxdec->bs, &remaining, &event);
453 gst_pad_event_default (flxdec->sinkpad, event);
461 gst_flxdec_loop (GstElement *element)
465 guchar *data, *chunk;
469 FlxFrameChunk *flxfh;
471 g_return_if_fail (element != NULL);
472 g_return_if_fail (GST_IS_FLXDEC(element));
474 GST_DEBUG (0, "entering loop function");
476 flxdec = GST_FLXDEC(element);
478 if (flxdec->state == GST_FLXDEC_READ_HEADER) {
479 databuf = flx_get_data(flxdec, FlxHeaderSize);
482 g_print ("empty buffer\n");
486 data = GST_BUFFER_DATA(databuf);
488 memcpy((char *) &flxdec->hdr, data, sizeof(FlxHeader));
490 gst_buffer_unref (databuf);
495 if (flxh->type != FLX_MAGICHDR_FLI &&
496 flxh->type != FLX_MAGICHDR_FLC &&
497 flxh->type != FLX_MAGICHDR_FLX) {
498 gst_element_error (element, "not a flx file (type %d)\n", flxh->type);
503 g_print("GstFlxDec: size : %d\n", flxh->size);
504 g_print("GstFlxDec: frames : %d\n", flxh->frames);
505 g_print("GstFlxDec: width : %d\n", flxh->width);
506 g_print("GstFlxDec: height : %d\n", flxh->height);
507 g_print("GstFlxDec: depth : %d\n", flxh->depth);
508 g_print("GstFlxDec: speed : %d\n", flxh->speed);
510 flxdec->next_time = 0;
512 if (flxh->type == FLX_MAGICHDR_FLI) {
513 flxdec->frame_time = JIFFIE * flxh->speed;
516 flxdec->frame_time = flxh->speed * GST_MSECOND;
519 gst_pad_try_set_caps (flxdec->srcpad,
524 "format", GST_PROPS_FOURCC (GST_MAKE_FOURCC ('R', 'G', 'B', ' ')),
525 "bpp", GST_PROPS_INT (32),
526 "depth", GST_PROPS_INT (32),
527 "endianness", GST_PROPS_INT (G_LITTLE_ENDIAN),
528 "red_mask", GST_PROPS_INT (0x00ff0000),
529 "green_mask", GST_PROPS_INT (0x0000ff00),
530 "blue_mask", GST_PROPS_INT (0x000000ff),
531 "width", GST_PROPS_INT (flxh->width),
532 "height", GST_PROPS_INT (flxh->height),
535 if (flxh->depth <= 8)
536 flxdec->converter = flx_colorspace_converter_new(flxh->width, flxh->height);
538 if (flxh->type == FLX_MAGICHDR_FLC ||
539 flxh->type == FLX_MAGICHDR_FLX) {
540 g_print("GstFlxDec: (FLC) aspect_dx : %d\n", flxh->aspect_dx);
541 g_print("GstFlxDec: (FLC) aspect_dy : %d\n", flxh->aspect_dy);
542 g_print("GstFlxDec: (FLC) oframe1 : 0x%08x\n", flxh->oframe1);
543 g_print("GstFlxDec: (FLC) oframe2 : 0x%08x\n", flxh->oframe2);
547 flxdec->size = (flxh->width * flxh->height);
549 /* create delta and output frame */
550 flxdec->frame = gst_buffer_new();
551 flxdec->delta = gst_buffer_new();
552 GST_BUFFER_DATA(flxdec->frame) = g_malloc(flxdec->size);
553 GST_BUFFER_SIZE(flxdec->frame) = flxdec->size;
554 GST_BUFFER_DATA(flxdec->delta) = g_malloc(flxdec->size);
555 GST_BUFFER_SIZE(flxdec->delta) = flxdec->size;
557 flxdec->state = GST_FLXDEC_PLAYING;
559 else if (flxdec->state == GST_FLXDEC_PLAYING) {
562 databuf = flx_get_data(flxdec, FlxFrameChunkSize);
566 flxfh = (FlxFrameChunk *) GST_BUFFER_DATA(databuf);
570 buf = flx_get_data(flxdec, flxfh->size-FlxFrameChunkSize);
572 chunk = GST_BUFFER_DATA(buf);
574 if (((FlxFrameType *)chunk)->chunks == 0)
577 /* create 32 bits output frame */
578 out = gst_buffer_new();
579 GST_BUFFER_DATA(out) = g_malloc(flxdec->size * 4);
580 GST_BUFFER_SIZE(out) = flxdec->size * 4;
583 flx_decode_chunks(flxdec,
584 ((FlxFrameType *)chunk)->chunks,
585 GST_BUFFER_DATA(buf) + FlxFrameTypeSize,
586 GST_BUFFER_DATA(flxdec->frame));
588 /* destroy input buffer*/
589 gst_buffer_unref(buf);
591 /* save copy of the current frame for possible delta. */
592 memcpy(GST_BUFFER_DATA(flxdec->delta),
593 GST_BUFFER_DATA(flxdec->frame),
594 GST_BUFFER_SIZE(flxdec->delta));
596 /* convert current frame. */
597 flx_colorspace_convert(flxdec->converter,
598 GST_BUFFER_DATA(flxdec->frame),
599 GST_BUFFER_DATA(out));
601 GST_BUFFER_TIMESTAMP (out) = flxdec->next_time;
602 flxdec->next_time += flxdec->frame_time;
604 gst_pad_push(flxdec->srcpad, out);
609 /* destroy header buffer */
610 gst_buffer_unref(databuf);
614 static GstElementStateReturn
615 gst_flxdec_change_state (GstElement *element)
619 flxdec = GST_FLXDEC(element);
621 switch (GST_STATE_TRANSITION (element)) {
622 case GST_STATE_NULL_TO_READY:
624 case GST_STATE_READY_TO_PAUSED:
625 flxdec->bs = gst_bytestream_new (flxdec->sinkpad);
626 flxdec->state = GST_FLXDEC_READ_HEADER;
628 case GST_STATE_PAUSED_TO_PLAYING:
630 case GST_STATE_PLAYING_TO_PAUSED:
632 case GST_STATE_PAUSED_TO_READY:
633 gst_buffer_unref (flxdec->frame);
634 flxdec->frame = NULL;
635 gst_buffer_unref (flxdec->delta);
636 flxdec->delta = NULL;
637 gst_bytestream_destroy (flxdec->bs);
639 case GST_STATE_READY_TO_NULL:
643 parent_class->change_state (element);
645 return GST_STATE_SUCCESS;
649 gst_flxdec_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
653 /* it's not null if we got it, but it might not be ours */
654 g_return_if_fail(GST_IS_FLXDEC(object));
655 flxdec = GST_FLXDEC(object);
664 gst_flxdec_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
668 /* it's not null if we got it, but it might not be ours */
669 g_return_if_fail(GST_IS_FLXDEC(object));
670 flxdec = GST_FLXDEC(object);
674 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
680 plugin_init (GModule *module, GstPlugin *plugin)
682 GstElementFactory *factory;
683 GstTypeFactory *type;
685 /* this filter needs the bytestream package */
686 if (!gst_library_load ("gstbytestream"))
689 factory = gst_element_factory_new("flxdec", GST_TYPE_FLXDEC, &flxdec_details);
690 g_return_val_if_fail(factory != NULL, FALSE);
691 gst_element_factory_set_rank (factory, GST_ELEMENT_RANK_PRIMARY);
693 gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (sink_factory));
694 gst_element_factory_add_pad_template (factory, GST_PAD_TEMPLATE_GET (src_video_factory));
696 gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));
698 type = gst_type_factory_new (&flxdec_definition);
699 gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (type));
704 GstPluginDesc plugin_desc = {