flx plugin ported to 0.9
[platform/upstream/gst-plugins-good.git] / gst / flx / gstflxdec.c
1 /* GStreamer
2  * Copyright (C) <1999> Erik Walthinsen <omega@temple-baptist.com>
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 #ifdef HAVE_CONFIG_H
21 #include "config.h"
22 #endif
23 #include <string.h>
24
25 #include "flx_fmt.h"
26 #include "gstflxdec.h"
27 #include <gst/video/video.h>
28
29 #define JIFFIE  (GST_SECOND/70)
30
31 GST_DEBUG_CATEGORY_STATIC (flxdec_debug);
32 #define GST_CAT_DEFAULT flxdec_debug
33
34 /* flx element information */
35 static GstElementDetails flxdec_details = {
36   "FLX Decoder",
37   "Codec/Decoder/Audio",
38   "FLX decoder",
39   "Sepp Wijnands <mrrazz@garbage-coderz.net>, Zeeshan Ali <zeenix@gmail.com>"
40 };
41
42 /* Flx signals and args */
43 enum
44 {
45   /* FILL ME */
46   LAST_SIGNAL
47 };
48
49 enum
50 {
51   ARG_0
52 };
53
54 /* input */
55 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
56     GST_PAD_SINK,
57     GST_PAD_ALWAYS,
58     GST_STATIC_CAPS ("video/x-fli")
59     );
60
61 /* output */
62 static GstStaticPadTemplate src_video_factory = GST_STATIC_PAD_TEMPLATE ("src",
63     GST_PAD_SRC,
64     GST_PAD_ALWAYS,
65     GST_STATIC_CAPS (GST_VIDEO_CAPS_xRGB_HOST_ENDIAN)
66     );
67
68
69 static void gst_flxdec_class_init (GstFlxDecClass * klass);
70 static void gst_flxdec_base_init (GstFlxDecClass * klass);
71 static void gst_flxdec_init (GstFlxDec * flxdec);
72
73 static GstFlowReturn gst_flxdec_chain (GstPad * pad, GstBuffer * buf);
74
75 static GstStateChangeReturn gst_flxdec_change_state (GstElement * element,
76     GstStateChange transition);
77
78 static gboolean gst_flxdec_src_event_handler (GstPad * pad, GstEvent * event);
79 static gboolean gst_flxdec_sink_event_handler (GstPad * pad, GstEvent * event);
80
81 static void gst_flxdec_set_property (GObject * object, guint prop_id,
82     const GValue * value, GParamSpec * pspec);
83 static void gst_flxdec_get_property (GObject * object, guint prop_id,
84     GValue * value, GParamSpec * pspec);
85
86
87 static void flx_decode_color (GstFlxDec *, guchar *, guchar *, gint);
88 static void flx_decode_brun (GstFlxDec *, guchar *, guchar *);
89 static void flx_decode_delta_fli (GstFlxDec *, guchar *, guchar *);
90 static void flx_decode_delta_flc (GstFlxDec *, guchar *, guchar *);
91
92 #define rndalign(off) ((off) + ((off) % 2))
93
94 static GstElementClass *parent_class = NULL;
95
96 GType
97 gst_flxdec_get_type (void)
98 {
99   static GType flxdec_type = 0;
100
101   if (!flxdec_type) {
102     static const GTypeInfo flxdec_info = {
103       sizeof (GstFlxDecClass),
104       (GBaseInitFunc) gst_flxdec_base_init,
105       NULL,
106       (GClassInitFunc) gst_flxdec_class_init,
107       NULL,
108       NULL,
109       sizeof (GstFlxDec),
110       0,
111       (GInstanceInitFunc) gst_flxdec_init,
112     };
113
114     flxdec_type =
115         g_type_register_static (GST_TYPE_ELEMENT, "GstFlxDec", &flxdec_info, 0);
116   }
117   return flxdec_type;
118 }
119
120 static void
121 gst_flxdec_base_init (GstFlxDecClass * klass)
122 {
123   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
124
125   gst_element_class_set_details (gstelement_class, &flxdec_details);
126   gst_element_class_add_pad_template (gstelement_class,
127       gst_static_pad_template_get (&sink_factory));
128   gst_element_class_add_pad_template (gstelement_class,
129       gst_static_pad_template_get (&src_video_factory));
130 }
131
132 static void
133 gst_flxdec_class_init (GstFlxDecClass * klass)
134 {
135   GObjectClass *gobject_class;
136   GstElementClass *gstelement_class;
137
138   gobject_class = (GObjectClass *) klass;
139   gstelement_class = (GstElementClass *) klass;
140
141   parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
142
143   GST_DEBUG_CATEGORY_INIT (flxdec_debug, "flxdec", 0, "FLX video decoder");
144
145   gobject_class->set_property = gst_flxdec_set_property;
146   gobject_class->get_property = gst_flxdec_get_property;
147
148   gstelement_class->change_state = gst_flxdec_change_state;
149 }
150
151 static void
152 gst_flxdec_init (GstFlxDec * flxdec)
153 {
154   flxdec->sinkpad =
155       gst_pad_new_from_template (gst_static_pad_template_get (&sink_factory),
156       "sink");
157   gst_element_add_pad (GST_ELEMENT (flxdec), flxdec->sinkpad);
158   gst_pad_set_chain_function (flxdec->sinkpad, gst_flxdec_chain);
159   gst_pad_set_event_function (flxdec->sinkpad, gst_flxdec_sink_event_handler);
160
161   flxdec->srcpad =
162       gst_pad_new_from_template (gst_static_pad_template_get
163       (&src_video_factory), "src");
164   gst_element_add_pad (GST_ELEMENT (flxdec), flxdec->srcpad);
165   gst_pad_set_event_function (flxdec->srcpad, gst_flxdec_src_event_handler);
166
167   gst_pad_use_fixed_caps (flxdec->srcpad);
168
169   flxdec->frame = NULL;
170   flxdec->delta = NULL;
171
172   flxdec->adapter = gst_adapter_new ();
173 }
174
175 static gboolean
176 gst_flxdec_src_event_handler (GstPad * pad, GstEvent * event)
177 {
178   GstFlxDec *flxdec = (GstFlxDec *) gst_pad_get_parent (pad);
179
180   g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
181
182   /* TODO: implement the seek and other event handling */
183
184   return gst_pad_push_event (flxdec->sinkpad, event);
185 }
186
187 static gboolean
188 gst_flxdec_sink_event_handler (GstPad * pad, GstEvent * event)
189 {
190   GstFlxDec *flxdec = (GstFlxDec *) gst_pad_get_parent (pad);
191
192   g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
193
194   if (GST_EVENT_TYPE (event) == GST_EVENT_EOS ||
195       GST_EVENT_TYPE (event) == GST_EVENT_NEWSEGMENT)
196     GST_STREAM_LOCK (flxdec->srcpad);
197
198   gst_pad_push_event (flxdec->srcpad, gst_event_ref (event));
199
200   if (GST_EVENT_TYPE (event) == GST_EVENT_EOS ||
201       GST_EVENT_TYPE (event) == GST_EVENT_NEWSEGMENT)
202     GST_STREAM_UNLOCK (flxdec->srcpad);
203
204   return TRUE;
205 }
206
207 static void
208 flx_decode_chunks (GstFlxDec * flxdec, gulong count, gchar * data, gchar * dest)
209 {
210   FlxFrameChunk *hdr;
211
212   g_return_if_fail (data != NULL);
213
214   while (count--) {
215     hdr = (FlxFrameChunk *) data;
216     data += FlxFrameChunkSize;
217
218     switch (hdr->id) {
219       case FLX_COLOR64:
220         flx_decode_color (flxdec, data, dest, 2);
221         data += rndalign (hdr->size) - FlxFrameChunkSize;
222         break;
223
224       case FLX_COLOR256:
225         flx_decode_color (flxdec, data, dest, 0);
226         data += rndalign (hdr->size) - FlxFrameChunkSize;
227         break;
228
229       case FLX_BRUN:
230         flx_decode_brun (flxdec, data, dest);
231         data += rndalign (hdr->size) - FlxFrameChunkSize;
232         break;
233
234       case FLX_LC:
235         flx_decode_delta_fli (flxdec, data, dest);
236         data += rndalign (hdr->size) - FlxFrameChunkSize;
237         break;
238
239       case FLX_SS2:
240         flx_decode_delta_flc (flxdec, data, dest);
241         data += rndalign (hdr->size) - FlxFrameChunkSize;
242         break;
243
244       case FLX_BLACK:
245         memset (dest, 0, flxdec->size);
246         break;
247
248       case FLX_MINI:
249         data += rndalign (hdr->size) - FlxFrameChunkSize;
250         break;
251
252       default:
253         GST_WARNING ("Unimplented chunk type: 0x%02x size: %d - skipping",
254             hdr->id, hdr->size);
255         data += rndalign (hdr->size) - FlxFrameChunkSize;
256         break;
257     }
258   }
259 }
260
261
262 static void
263 flx_decode_color (GstFlxDec * flxdec, guchar * data, guchar * dest, gint scale)
264 {
265   guint packs, count, indx;
266
267   g_return_if_fail (flxdec != NULL);
268
269   packs = (data[0] + (data[1] << 8));
270
271   data += 2;
272   indx = 0;
273
274   GST_LOG ("GstFlxDec: cmap packs: %d", packs);
275   while (packs--) {
276     /* color map index + skip count */
277     indx += *data++;
278
279     /* number of rgb triplets */
280     count = *data++ & 0xff;
281     if (count == 0)
282       count = 256;
283
284     GST_LOG ("GstFlxDec: cmap count: %d (indx: %d)\n", count, indx);
285     flx_set_palette_vector (flxdec->converter, indx, count, data, scale);
286
287     data += (count * 3);
288   }
289 }
290
291 static void
292 flx_decode_brun (GstFlxDec * flxdec, guchar * data, guchar * dest)
293 {
294   gulong count, lines, row;
295   guchar x;
296
297   g_return_if_fail (flxdec != NULL);
298
299   lines = flxdec->hdr.height;
300   while (lines--) {
301     /* packet count.  
302      * should not be used anymore, since the flc format can
303      * contain more then 255 RLE packets. we use the frame 
304      * width instead. 
305      */
306     data++;
307
308     row = flxdec->hdr.width;
309     while (row) {
310       count = *data++;
311
312       if (count > 0x7f) {
313         /* literal run */
314         count = 0x100 - count;
315         row -= count;
316
317         while (count--)
318           *dest++ = *data++;
319
320       } else {
321         /* replicate run */
322         row -= count;
323         x = *data++;
324
325         while (count--)
326           *dest++ = x;
327       }
328     }
329   }
330 }
331
332 static void
333 flx_decode_delta_fli (GstFlxDec * flxdec, guchar * data, guchar * dest)
334 {
335   gulong count, packets, lines, start_line, start_l;
336   guchar *start_p, x;
337
338   g_return_if_fail (flxdec != NULL);
339   g_return_if_fail (flxdec->delta != NULL);
340
341
342   /* use last frame for delta */
343   memcpy (dest, GST_BUFFER_DATA (flxdec->delta),
344       GST_BUFFER_SIZE (flxdec->delta));
345
346   start_line = (data[0] + (data[1] << 8));
347   lines = (data[2] + (data[3] << 8));
348   data += 4;
349
350   /* start position of delta */
351   dest += (flxdec->hdr.width * start_line);
352   start_p = dest;
353   start_l = lines;
354
355   while (lines--) {
356     /* packet count */
357     packets = *data++;
358
359     while (packets--) {
360       /* skip count */
361       dest += *data++;
362
363       /* RLE count */
364       count = *data++;
365
366       if (count > 0x7f) {
367         /* literal run */
368         count = 0x100 - count;
369         x = *data++;
370
371         while (count--)
372           *dest++ = x;
373
374       } else {
375         /* replicate run */
376         while (count--)
377           *dest++ = *data++;
378       }
379     }
380     start_p += flxdec->hdr.width;
381     dest = start_p;
382   }
383 }
384
385 static void
386 flx_decode_delta_flc (GstFlxDec * flxdec, guchar * data, guchar * dest)
387 {
388   gulong count, lines, start_l, opcode;
389   guchar *start_p;
390
391   g_return_if_fail (flxdec != NULL);
392   g_return_if_fail (flxdec->delta != NULL);
393
394
395   /* use last frame for delta */
396   memcpy (dest, GST_BUFFER_DATA (flxdec->delta),
397       GST_BUFFER_SIZE (flxdec->delta));
398
399   lines = (data[0] + (data[1] << 8));
400   data += 2;
401
402   start_p = dest;
403   start_l = lines;
404
405   while (lines) {
406     dest = start_p + (flxdec->hdr.width * (start_l - lines));
407
408     /* process opcode(s) */
409     while ((opcode = (data[0] + (data[1] << 8))) & 0xc000) {
410       data += 2;
411       if ((opcode & 0xc000) == 0xc000) {
412         /* skip count */
413         start_l += (0x10000 - opcode);
414         dest += flxdec->hdr.width * (0x10000 - opcode);
415       } else {
416         /* last pixel */
417         dest += flxdec->hdr.width;
418         *dest++ = (opcode & 0xff);
419       }
420     }
421     data += 2;
422
423     /* last opcode is the packet count */
424     while (opcode--) {
425       /* skip count */
426       dest += *data++;
427
428       /* RLE count */
429       count = *data++;
430
431       if (count > 0x7f) {
432         /* replicate word run */
433         count = 0x100 - count;
434         while (count--) {
435           *dest++ = data[0];
436           *dest++ = data[1];
437         }
438         data += 2;
439       } else {
440         /* literal word run */
441         while (count--) {
442           *dest++ = *data++;
443           *dest++ = *data++;
444         }
445       }
446     }
447     lines--;
448   }
449 }
450
451 static GstFlowReturn
452 gst_flxdec_chain (GstPad * pad, GstBuffer * buf)
453 {
454   GstCaps *caps;
455   guint avail;
456   GstFlowReturn res = GST_FLOW_OK;
457
458   GstFlxDec *flxdec;
459   FlxHeader *flxh;
460   FlxFrameChunk *flxfh;
461
462   g_return_val_if_fail (buf != NULL, GST_FLOW_ERROR);
463   flxdec = (GstFlxDec *) gst_pad_get_parent (pad);
464   g_return_val_if_fail (flxdec != NULL, GST_FLOW_ERROR);
465
466   gst_adapter_push (flxdec->adapter, buf);
467   avail = gst_adapter_available (flxdec->adapter);
468
469   if (flxdec->state == GST_FLXDEC_READ_HEADER) {
470     if (avail >= FlxHeaderSize) {
471       const guint8 *data = gst_adapter_peek (flxdec->adapter, FlxHeaderSize);
472
473       memcpy ((gchar *) & flxdec->hdr, data, FlxHeaderSize);
474       gst_adapter_flush (flxdec->adapter, FlxHeaderSize);
475
476       flxh = &flxdec->hdr;
477
478       /* check header */
479       if (flxh->type != FLX_MAGICHDR_FLI &&
480           flxh->type != FLX_MAGICHDR_FLC && flxh->type != FLX_MAGICHDR_FLX) {
481         GST_ELEMENT_ERROR (flxdec, STREAM, WRONG_TYPE, (NULL),
482             ("not a flx file (type %d)\n", flxh->type));
483         return GST_FLOW_ERROR;
484       }
485
486
487       GST_LOG ("size      :  %d\n", flxh->size);
488       GST_LOG ("frames    :  %d\n", flxh->frames);
489       GST_LOG ("width     :  %d\n", flxh->width);
490       GST_LOG ("height    :  %d\n", flxh->height);
491       GST_LOG ("depth     :  %d\n", flxh->depth);
492       GST_LOG ("speed     :  %d\n", flxh->speed);
493
494       flxdec->next_time = 0;
495
496       if (flxh->type == FLX_MAGICHDR_FLI) {
497         flxdec->frame_time = JIFFIE * flxh->speed;
498       } else {
499         flxdec->frame_time = flxh->speed * GST_MSECOND;
500       }
501
502       caps = gst_caps_from_string (GST_VIDEO_CAPS_xRGB_HOST_ENDIAN);
503       gst_caps_set_simple (caps,
504           "width", G_TYPE_INT, flxh->width,
505           "height", G_TYPE_INT, flxh->height,
506           "framerate", G_TYPE_DOUBLE,
507           (gdouble) (GST_SECOND / flxdec->frame_time), NULL);
508
509       gst_pad_set_caps (flxdec->srcpad, caps);
510       gst_caps_unref (caps);
511
512       if (flxh->depth <= 8)
513         flxdec->converter =
514             flx_colorspace_converter_new (flxh->width, flxh->height);
515
516       if (flxh->type == FLX_MAGICHDR_FLC || flxh->type == FLX_MAGICHDR_FLX) {
517         GST_LOG ("(FLC) aspect_dx :  %d\n", flxh->aspect_dx);
518         GST_LOG ("(FLC) aspect_dy :  %d\n", flxh->aspect_dy);
519         GST_LOG ("(FLC) oframe1   :  0x%08x\n", flxh->oframe1);
520         GST_LOG ("(FLC) oframe2   :  0x%08x\n", flxh->oframe2);
521       }
522
523       flxdec->size = (flxh->width * flxh->height);
524
525       /* create delta and output frame */
526       flxdec->frame = gst_buffer_new ();
527       flxdec->delta = gst_buffer_new ();
528       GST_BUFFER_DATA (flxdec->frame) = g_malloc (flxdec->size);
529       GST_BUFFER_SIZE (flxdec->frame) = flxdec->size;
530       GST_BUFFER_DATA (flxdec->delta) = g_malloc (flxdec->size);
531       GST_BUFFER_SIZE (flxdec->delta) = flxdec->size;
532
533       flxdec->state = GST_FLXDEC_PLAYING;
534     }
535   } else if (flxdec->state == GST_FLXDEC_PLAYING) {
536     GstBuffer *out;
537
538     if (avail >= FlxFrameChunkSize) {
539       guchar *chunk = NULL;
540       guint to_flush = 0;
541       const guint8 *data =
542           gst_adapter_peek (flxdec->adapter, FlxFrameChunkSize);
543       flxfh = (FlxFrameChunk *) g_memdup (data, FlxFrameChunkSize);
544
545       switch (flxfh->id) {
546         case FLX_FRAME_TYPE:
547           if (avail < flxfh->size) {
548             break;
549           }
550
551           gst_adapter_flush (flxdec->adapter, FlxFrameChunkSize);
552           data = gst_adapter_peek (flxdec->adapter,
553               flxfh->size - FlxFrameChunkSize);
554           chunk = g_memdup (data, flxfh->size - FlxFrameChunkSize);
555           to_flush = flxfh->size - FlxFrameChunkSize;
556
557           if (((FlxFrameType *) chunk)->chunks == 0)
558             break;
559
560           /* create 32 bits output frame */
561           res = gst_pad_alloc_buffer (flxdec->srcpad,
562               GST_BUFFER_OFFSET_NONE,
563               flxdec->size * 4, GST_PAD_CAPS (flxdec->srcpad), &out);
564
565           if (res != GST_FLOW_OK)
566             break;
567
568           /* decode chunks */
569           flx_decode_chunks (flxdec,
570               ((FlxFrameType *) chunk)->chunks,
571               chunk + FlxFrameTypeSize, GST_BUFFER_DATA (flxdec->frame));
572
573           /* save copy of the current frame for possible delta. */
574           memcpy (GST_BUFFER_DATA (flxdec->delta),
575               GST_BUFFER_DATA (flxdec->frame), GST_BUFFER_SIZE (flxdec->delta));
576
577           /* convert current frame. */
578           flx_colorspace_convert (flxdec->converter,
579               GST_BUFFER_DATA (flxdec->frame), GST_BUFFER_DATA (out));
580
581           GST_BUFFER_TIMESTAMP (out) = flxdec->next_time;
582           flxdec->next_time += flxdec->frame_time;
583
584           gst_pad_push (flxdec->srcpad, out);
585           break;
586       }
587
588       gst_adapter_flush (flxdec->adapter, to_flush);
589
590       if (chunk)
591         g_free (chunk);
592       g_free (flxfh);
593     }
594   }
595
596   return res;
597 }
598
599 static GstStateChangeReturn
600 gst_flxdec_change_state (GstElement * element, GstStateChange transition)
601 {
602   GstFlxDec *flxdec;
603
604   flxdec = GST_FLXDEC (element);
605
606   switch (transition) {
607     case GST_STATE_CHANGE_NULL_TO_READY:
608       break;
609     case GST_STATE_CHANGE_READY_TO_PAUSED:
610       gst_adapter_clear (flxdec->adapter);
611       flxdec->state = GST_FLXDEC_READ_HEADER;
612       break;
613     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
614       break;
615     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
616       break;
617     case GST_STATE_CHANGE_PAUSED_TO_READY:
618       gst_buffer_unref (flxdec->frame);
619       flxdec->frame = NULL;
620       gst_buffer_unref (flxdec->delta);
621       flxdec->delta = NULL;
622       break;
623     case GST_STATE_CHANGE_READY_TO_NULL:
624       break;
625   }
626
627   return parent_class->change_state (element, transition);
628
629   //return GST_STATE_CHANGE_SUCCESS;
630 }
631
632 static void
633 gst_flxdec_set_property (GObject * object, guint prop_id, const GValue * value,
634     GParamSpec * pspec)
635 {
636   GstFlxDec *flxdec;
637
638   g_return_if_fail (GST_IS_FLXDEC (object));
639   flxdec = GST_FLXDEC (object);
640
641   switch (prop_id) {
642     default:
643       break;
644   }
645 }
646
647 static void
648 gst_flxdec_get_property (GObject * object, guint prop_id, GValue * value,
649     GParamSpec * pspec)
650 {
651   GstFlxDec *flxdec;
652
653   g_return_if_fail (GST_IS_FLXDEC (object));
654   flxdec = GST_FLXDEC (object);
655
656   switch (prop_id) {
657     default:
658       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
659       break;
660   }
661 }
662
663 static gboolean
664 plugin_init (GstPlugin * plugin)
665 {
666   return gst_element_register (plugin, "flxdec",
667       GST_RANK_PRIMARY, GST_TYPE_FLXDEC);
668 }
669
670 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
671     GST_VERSION_MINOR,
672     "flxdec",
673     "FLX video decoder",
674     plugin_init, VERSION, GST_LICENSE, GST_PACKAGE, GST_ORIGIN)