Update for stream lock API changes: don't take stream log in sink event handlers...
[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   gboolean ret;
180
181   /* TODO: implement the seek and other event handling */
182
183   ret = gst_pad_push_event (flxdec->sinkpad, event);
184
185   gst_object_unref (flxdec);
186
187   return ret;
188 }
189
190 static gboolean
191 gst_flxdec_sink_event_handler (GstPad * pad, GstEvent * event)
192 {
193   GstFlxDec *flxdec;
194   gboolean ret;
195
196   flxdec = GST_FLXDEC (gst_pad_get_parent (pad));
197
198   ret = gst_pad_push_event (flxdec->srcpad, event);
199
200   gst_object_unref (flxdec);
201   return ret;
202 }
203
204 static void
205 flx_decode_chunks (GstFlxDec * flxdec, gulong count, guchar * data,
206     guchar * dest)
207 {
208   FlxFrameChunk *hdr;
209
210   g_return_if_fail (data != NULL);
211
212   while (count--) {
213     hdr = (FlxFrameChunk *) data;
214     data += FlxFrameChunkSize;
215
216     switch (hdr->id) {
217       case FLX_COLOR64:
218         flx_decode_color (flxdec, data, dest, 2);
219         data += rndalign (hdr->size) - FlxFrameChunkSize;
220         break;
221
222       case FLX_COLOR256:
223         flx_decode_color (flxdec, data, dest, 0);
224         data += rndalign (hdr->size) - FlxFrameChunkSize;
225         break;
226
227       case FLX_BRUN:
228         flx_decode_brun (flxdec, data, dest);
229         data += rndalign (hdr->size) - FlxFrameChunkSize;
230         break;
231
232       case FLX_LC:
233         flx_decode_delta_fli (flxdec, data, dest);
234         data += rndalign (hdr->size) - FlxFrameChunkSize;
235         break;
236
237       case FLX_SS2:
238         flx_decode_delta_flc (flxdec, data, dest);
239         data += rndalign (hdr->size) - FlxFrameChunkSize;
240         break;
241
242       case FLX_BLACK:
243         memset (dest, 0, flxdec->size);
244         break;
245
246       case FLX_MINI:
247         data += rndalign (hdr->size) - FlxFrameChunkSize;
248         break;
249
250       default:
251         GST_WARNING ("Unimplented chunk type: 0x%02x size: %d - skipping",
252             hdr->id, hdr->size);
253         data += rndalign (hdr->size) - FlxFrameChunkSize;
254         break;
255     }
256   }
257 }
258
259
260 static void
261 flx_decode_color (GstFlxDec * flxdec, guchar * data, guchar * dest, gint scale)
262 {
263   guint packs, count, indx;
264
265   g_return_if_fail (flxdec != NULL);
266
267   packs = (data[0] + (data[1] << 8));
268
269   data += 2;
270   indx = 0;
271
272   GST_LOG ("GstFlxDec: cmap packs: %d", packs);
273   while (packs--) {
274     /* color map index + skip count */
275     indx += *data++;
276
277     /* number of rgb triplets */
278     count = *data++ & 0xff;
279     if (count == 0)
280       count = 256;
281
282     GST_LOG ("GstFlxDec: cmap count: %d (indx: %d)\n", count, indx);
283     flx_set_palette_vector (flxdec->converter, indx, count, data, scale);
284
285     data += (count * 3);
286   }
287 }
288
289 static void
290 flx_decode_brun (GstFlxDec * flxdec, guchar * data, guchar * dest)
291 {
292   gulong count, lines, row;
293   guchar x;
294
295   g_return_if_fail (flxdec != NULL);
296
297   lines = flxdec->hdr.height;
298   while (lines--) {
299     /* packet count.  
300      * should not be used anymore, since the flc format can
301      * contain more then 255 RLE packets. we use the frame 
302      * width instead. 
303      */
304     data++;
305
306     row = flxdec->hdr.width;
307     while (row) {
308       count = *data++;
309
310       if (count > 0x7f) {
311         /* literal run */
312         count = 0x100 - count;
313         row -= count;
314
315         while (count--)
316           *dest++ = *data++;
317
318       } else {
319         /* replicate run */
320         row -= count;
321         x = *data++;
322
323         while (count--)
324           *dest++ = x;
325       }
326     }
327   }
328 }
329
330 static void
331 flx_decode_delta_fli (GstFlxDec * flxdec, guchar * data, guchar * dest)
332 {
333   gulong count, packets, lines, start_line, start_l;
334   guchar *start_p, x;
335
336   g_return_if_fail (flxdec != NULL);
337   g_return_if_fail (flxdec->delta != NULL);
338
339   /* use last frame for delta */
340   memcpy (dest, GST_BUFFER_DATA (flxdec->delta),
341       GST_BUFFER_SIZE (flxdec->delta));
342
343   start_line = (data[0] + (data[1] << 8));
344   lines = (data[2] + (data[3] << 8));
345   data += 4;
346
347   /* start position of delta */
348   dest += (flxdec->hdr.width * start_line);
349   start_p = dest;
350   start_l = lines;
351
352   while (lines--) {
353     /* packet count */
354     packets = *data++;
355
356     while (packets--) {
357       /* skip count */
358       dest += *data++;
359
360       /* RLE count */
361       count = *data++;
362
363       if (count > 0x7f) {
364         /* literal run */
365         count = 0x100 - count;
366         x = *data++;
367
368         while (count--)
369           *dest++ = x;
370
371       } else {
372         /* replicate run */
373         while (count--)
374           *dest++ = *data++;
375       }
376     }
377     start_p += flxdec->hdr.width;
378     dest = start_p;
379   }
380 }
381
382 static void
383 flx_decode_delta_flc (GstFlxDec * flxdec, guchar * data, guchar * dest)
384 {
385   gulong count, lines, start_l, opcode;
386   guchar *start_p;
387
388   g_return_if_fail (flxdec != NULL);
389   g_return_if_fail (flxdec->delta != NULL);
390
391   /* use last frame for delta */
392   memcpy (dest, GST_BUFFER_DATA (flxdec->delta),
393       GST_BUFFER_SIZE (flxdec->delta));
394
395   lines = (data[0] + (data[1] << 8));
396   data += 2;
397
398   start_p = dest;
399   start_l = lines;
400
401   while (lines) {
402     dest = start_p + (flxdec->hdr.width * (start_l - lines));
403
404     /* process opcode(s) */
405     while ((opcode = (data[0] + (data[1] << 8))) & 0xc000) {
406       data += 2;
407       if ((opcode & 0xc000) == 0xc000) {
408         /* skip count */
409         start_l += (0x10000 - opcode);
410         dest += flxdec->hdr.width * (0x10000 - opcode);
411       } else {
412         /* last pixel */
413         dest += flxdec->hdr.width;
414         *dest++ = (opcode & 0xff);
415       }
416     }
417     data += 2;
418
419     /* last opcode is the packet count */
420     while (opcode--) {
421       /* skip count */
422       dest += *data++;
423
424       /* RLE count */
425       count = *data++;
426
427       if (count > 0x7f) {
428         /* replicate word run */
429         count = 0x100 - count;
430         while (count--) {
431           *dest++ = data[0];
432           *dest++ = data[1];
433         }
434         data += 2;
435       } else {
436         /* literal word run */
437         while (count--) {
438           *dest++ = *data++;
439           *dest++ = *data++;
440         }
441       }
442     }
443     lines--;
444   }
445 }
446
447 static GstFlowReturn
448 gst_flxdec_chain (GstPad * pad, GstBuffer * buf)
449 {
450   GstCaps *caps;
451   guint avail;
452   GstFlowReturn res = GST_FLOW_OK;
453
454   GstFlxDec *flxdec;
455   FlxHeader *flxh;
456
457   g_return_val_if_fail (buf != NULL, GST_FLOW_ERROR);
458   flxdec = (GstFlxDec *) gst_pad_get_parent (pad);
459   g_return_val_if_fail (flxdec != NULL, GST_FLOW_ERROR);
460
461   gst_adapter_push (flxdec->adapter, buf);
462   avail = gst_adapter_available (flxdec->adapter);
463
464   if (flxdec->state == GST_FLXDEC_READ_HEADER) {
465     if (avail >= FlxHeaderSize) {
466       const guint8 *data = gst_adapter_peek (flxdec->adapter, FlxHeaderSize);
467
468       memcpy ((gchar *) & flxdec->hdr, data, FlxHeaderSize);
469       gst_adapter_flush (flxdec->adapter, FlxHeaderSize);
470
471       flxh = &flxdec->hdr;
472
473       /* check header */
474       if (flxh->type != FLX_MAGICHDR_FLI &&
475           flxh->type != FLX_MAGICHDR_FLC && flxh->type != FLX_MAGICHDR_FLX) {
476         GST_ELEMENT_ERROR (flxdec, STREAM, WRONG_TYPE, (NULL),
477             ("not a flx file (type %d)\n", flxh->type));
478         return GST_FLOW_ERROR;
479       }
480
481
482       GST_LOG ("size      :  %d\n", flxh->size);
483       GST_LOG ("frames    :  %d\n", flxh->frames);
484       GST_LOG ("width     :  %d\n", flxh->width);
485       GST_LOG ("height    :  %d\n", flxh->height);
486       GST_LOG ("depth     :  %d\n", flxh->depth);
487       GST_LOG ("speed     :  %d\n", flxh->speed);
488
489       flxdec->next_time = 0;
490
491       if (flxh->type == FLX_MAGICHDR_FLI) {
492         flxdec->frame_time = JIFFIE * flxh->speed;
493       } else {
494         flxdec->frame_time = flxh->speed * GST_MSECOND;
495       }
496
497       caps = gst_caps_from_string (GST_VIDEO_CAPS_xRGB_HOST_ENDIAN);
498       gst_caps_set_simple (caps,
499           "width", G_TYPE_INT, flxh->width,
500           "height", G_TYPE_INT, flxh->height,
501           "framerate", G_TYPE_DOUBLE,
502           (gdouble) (GST_SECOND / flxdec->frame_time), NULL);
503
504       gst_pad_set_caps (flxdec->srcpad, caps);
505       gst_caps_unref (caps);
506
507       if (flxh->depth <= 8)
508         flxdec->converter =
509             flx_colorspace_converter_new (flxh->width, flxh->height);
510
511       if (flxh->type == FLX_MAGICHDR_FLC || flxh->type == FLX_MAGICHDR_FLX) {
512         GST_LOG ("(FLC) aspect_dx :  %d\n", flxh->aspect_dx);
513         GST_LOG ("(FLC) aspect_dy :  %d\n", flxh->aspect_dy);
514         GST_LOG ("(FLC) oframe1   :  0x%08x\n", flxh->oframe1);
515         GST_LOG ("(FLC) oframe2   :  0x%08x\n", flxh->oframe2);
516       }
517
518       flxdec->size = (flxh->width * flxh->height);
519
520       /* create delta and output frame */
521       flxdec->frame = gst_buffer_new ();
522       flxdec->delta = gst_buffer_new ();
523       GST_BUFFER_DATA (flxdec->frame) = g_malloc (flxdec->size);
524       GST_BUFFER_SIZE (flxdec->frame) = flxdec->size;
525       GST_BUFFER_DATA (flxdec->delta) = g_malloc (flxdec->size);
526       GST_BUFFER_SIZE (flxdec->delta) = flxdec->size;
527
528       flxdec->state = GST_FLXDEC_PLAYING;
529     }
530   } else if (flxdec->state == GST_FLXDEC_PLAYING) {
531     GstBuffer *out;
532
533     if (avail >= FlxFrameChunkSize) {
534       FlxFrameChunk flxfh;
535       guchar *chunk = NULL;
536       guint to_flush = 0;
537       const guint8 *data =
538           gst_adapter_peek (flxdec->adapter, FlxFrameChunkSize);
539       memcpy (&flxfh, data, FlxFrameChunkSize);
540
541       switch (flxfh.id) {
542         case FLX_FRAME_TYPE:
543           if (avail < flxfh.size) {
544             break;
545           }
546
547           gst_adapter_flush (flxdec->adapter, FlxFrameChunkSize);
548           data = gst_adapter_peek (flxdec->adapter,
549               flxfh.size - FlxFrameChunkSize);
550           chunk = g_memdup (data, flxfh.size - FlxFrameChunkSize);
551           to_flush = flxfh.size - FlxFrameChunkSize;
552
553           if (((FlxFrameType *) chunk)->chunks == 0)
554             break;
555
556           /* create 32 bits output frame */
557           res = gst_pad_alloc_buffer (flxdec->srcpad,
558               GST_BUFFER_OFFSET_NONE,
559               flxdec->size * 4, GST_PAD_CAPS (flxdec->srcpad), &out);
560
561           if (res != GST_FLOW_OK)
562             break;
563
564           /* decode chunks */
565           flx_decode_chunks (flxdec,
566               ((FlxFrameType *) chunk)->chunks,
567               chunk + FlxFrameTypeSize, GST_BUFFER_DATA (flxdec->frame));
568
569           /* save copy of the current frame for possible delta. */
570           memcpy (GST_BUFFER_DATA (flxdec->delta),
571               GST_BUFFER_DATA (flxdec->frame), GST_BUFFER_SIZE (flxdec->delta));
572
573           /* convert current frame. */
574           flx_colorspace_convert (flxdec->converter,
575               GST_BUFFER_DATA (flxdec->frame), GST_BUFFER_DATA (out));
576
577           GST_BUFFER_TIMESTAMP (out) = flxdec->next_time;
578           flxdec->next_time += flxdec->frame_time;
579
580           gst_pad_push (flxdec->srcpad, out);
581           break;
582       }
583
584       gst_adapter_flush (flxdec->adapter, to_flush);
585
586       if (chunk)
587         g_free (chunk);
588     }
589   }
590
591   return res;
592 }
593
594 static GstStateChangeReturn
595 gst_flxdec_change_state (GstElement * element, GstStateChange transition)
596 {
597   GstFlxDec *flxdec;
598   GstStateChangeReturn ret;
599
600   flxdec = GST_FLXDEC (element);
601
602   switch (transition) {
603     case GST_STATE_CHANGE_NULL_TO_READY:
604       break;
605     case GST_STATE_CHANGE_READY_TO_PAUSED:
606       gst_adapter_clear (flxdec->adapter);
607       flxdec->state = GST_FLXDEC_READ_HEADER;
608       break;
609     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
610       break;
611     default:
612       break;
613   }
614
615   ret = parent_class->change_state (element, transition);
616
617   switch (transition) {
618     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
619       break;
620     case GST_STATE_CHANGE_PAUSED_TO_READY:
621       if (flxdec->frame) {
622         gst_buffer_unref (flxdec->frame);
623         flxdec->frame = NULL;
624       }
625       if (flxdec->delta) {
626         gst_buffer_unref (flxdec->delta);
627         flxdec->delta = NULL;
628       }
629       break;
630     case GST_STATE_CHANGE_READY_TO_NULL:
631       break;
632     default:
633       break;
634   }
635   return ret;
636 }
637
638 static void
639 gst_flxdec_set_property (GObject * object, guint prop_id, const GValue * value,
640     GParamSpec * pspec)
641 {
642   GstFlxDec *flxdec;
643
644   g_return_if_fail (GST_IS_FLXDEC (object));
645   flxdec = GST_FLXDEC (object);
646
647   switch (prop_id) {
648     default:
649       break;
650   }
651 }
652
653 static void
654 gst_flxdec_get_property (GObject * object, guint prop_id, GValue * value,
655     GParamSpec * pspec)
656 {
657   GstFlxDec *flxdec;
658
659   g_return_if_fail (GST_IS_FLXDEC (object));
660   flxdec = GST_FLXDEC (object);
661
662   switch (prop_id) {
663     default:
664       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
665       break;
666   }
667 }
668
669 static gboolean
670 plugin_init (GstPlugin * plugin)
671 {
672   return gst_element_register (plugin, "flxdec",
673       GST_RANK_PRIMARY, GST_TYPE_FLXDEC);
674 }
675
676 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
677     GST_VERSION_MINOR,
678     "flxdec",
679     "FLX video decoder",
680     plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)