Fixed two off by one bugs in the delta decoding code.
[platform/upstream/gst-plugins-good.git] / gst / flx / gstflxdec.c
1 /* Gnome-Streamer
2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
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 #include <string.h>
21
22 #include "flx_fmt.h"
23 #include "gstflxdec.h"
24
25 #define JIFFIE  (1000000/70)
26
27 static GstCaps* flxdec_typefind(GstBuffer *buf, gpointer private);
28
29 /* flx element information */
30 static GstElementDetails flxdec_details = {
31   "FLX Decoder",
32   "flxdec",
33   "FLX decoder",
34   VERSION,
35   "Sepp Wijnands <mrrazz@garbage-coderz.net>"
36   "(C) 2001",
37 };
38
39 static GstTypeDefinition flxdec_definition = {
40   "flxdec_video/fli",
41   "video/fli",
42   ".flc .fli",
43   flxdec_typefind,
44 };
45
46 /* Flx signals and args */
47 enum {
48   /* FILL ME */
49   LAST_SIGNAL
50 };
51
52 enum {
53   ARG_0
54 };
55
56 /* input */
57 GST_PADTEMPLATE_FACTORY (sink_factory,
58   "sink",          
59   GST_PAD_SINK, 
60   GST_PAD_ALWAYS,
61   GST_CAPS_NEW (
62     "flxdec_sink",         
63     "video/fli",
64      NULL
65   )
66 )
67
68 /* output */
69 GST_PADTEMPLATE_FACTORY (src_video_factory,
70   "src",
71   GST_PAD_SRC,
72   GST_PAD_ALWAYS,
73   GST_CAPS_NEW (
74     "src_video",
75     "video/raw",
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)
85   )
86 )
87
88
89 static void     gst_flxdec_class_init   (GstFlxDecClass *klass);
90 static void     gst_flxdec_init         (GstFlxDec *flxdec);
91
92 static void     gst_flxdec_loop         (GstElement *element);
93
94 static GstElementStateReturn 
95                 gst_flxdec_change_state (GstElement *element);
96
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);
99
100
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 *);
105
106 #define rndalign(off) ((off) + ((off) % 2))
107
108 static GstElementClass *parent_class = NULL;
109
110 static GstCaps* 
111 flxdec_typefind (GstBuffer *buf, gpointer private)
112 {
113   guchar *data = GST_BUFFER_DATA(buf);
114   GstCaps *new;
115
116   /* check magic */
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_typefind","video/fli", NULL);
123         return new;
124       }
125   }
126   
127   return NULL; 
128 }
129
130
131 GType
132 gst_flxdec_get_type(void) 
133 {
134   static GType flxdec_type = 0;
135
136   if (!flxdec_type) {
137     static const GTypeInfo flxdec_info = {
138       sizeof(GstFlxDecClass),      NULL,
139       NULL,
140       (GClassInitFunc)gst_flxdec_class_init,
141       NULL,
142       NULL,
143       sizeof(GstFlxDec),
144       0,
145       (GInstanceInitFunc)gst_flxdec_init,
146     };
147     flxdec_type = g_type_register_static(GST_TYPE_ELEMENT, "GstFlxDec", &flxdec_info, 0);
148   }
149   return flxdec_type;
150 }
151
152 static void 
153 gst_flxdec_class_init (GstFlxDecClass *klass) 
154 {
155   GObjectClass *gobject_class;
156   GstElementClass *gstelement_class;
157
158   gobject_class = (GObjectClass*)klass;
159   gstelement_class = (GstElementClass*)klass;
160
161   parent_class = g_type_class_ref(GST_TYPE_ELEMENT);
162
163   gobject_class->set_property = NULL;  
164   gobject_class->get_property = NULL;
165
166   gstelement_class->change_state = gst_flxdec_change_state;
167 }
168
169
170   
171 static void 
172 gst_flxdec_init(GstFlxDec *flxdec) 
173 {
174   flxdec->sinkpad = gst_pad_new_from_template (
175                   GST_PADTEMPLATE_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);
178
179   flxdec->srcpad = gst_pad_new_from_template (
180                   GST_PADTEMPLATE_GET (src_video_factory), "src");
181   gst_element_add_pad(GST_ELEMENT(flxdec),flxdec->srcpad);
182
183   flxdec->buf = NULL;
184   flxdec->bs = NULL;
185   flxdec->frame = NULL;
186   flxdec->delta = NULL;
187 }
188
189 static void
190 flx_decode_chunks (GstFlxDec *flxdec , gulong count, gchar *data, gchar *dest)
191 {
192   FlxFrameChunk  *hdr;
193
194   g_return_if_fail(data != NULL);
195
196   while (count--) {
197     hdr  = (FlxFrameChunk *) data;
198     data += FlxFrameChunkSize;
199
200     switch(hdr->id) 
201     {
202       case FLX_COLOR64:
203         flx_decode_color(flxdec, data, dest, 2);
204         data += rndalign(hdr->size) - FlxFrameChunkSize;
205         break;
206
207       case FLX_COLOR256:
208         flx_decode_color(flxdec, data, dest, 0);
209         data += rndalign(hdr->size) - FlxFrameChunkSize;
210         break;
211
212       case FLX_BRUN:
213         flx_decode_brun(flxdec, data, dest);
214         data += rndalign(hdr->size) - FlxFrameChunkSize;
215         break;
216
217       case FLX_LC:
218         flx_decode_delta_fli(flxdec, data, dest);
219         data += rndalign(hdr->size) - FlxFrameChunkSize;
220         break;
221
222       case FLX_SS2:
223         flx_decode_delta_flc(flxdec, data, dest);
224         data += rndalign(hdr->size) - FlxFrameChunkSize;
225         break;
226
227       case FLX_BLACK:
228         memset(dest, 0, flxdec->size);
229         break;
230
231       case FLX_MINI:
232         data += rndalign(hdr->size) - FlxFrameChunkSize;
233         break;
234
235       default:
236         g_print("GstFlxDec: Unimplented chunk type: 0x%02x size: %d\n",
237                  hdr->id, hdr->size);
238         g_print("GstFlxDec: Skipping...\n");
239         data += rndalign(hdr->size) - FlxFrameChunkSize;
240         break;
241     }
242   }
243 }
244
245
246 static void
247 flx_decode_color(GstFlxDec *flxdec, guchar *data, guchar *dest, gint scale)
248 {
249   guint packs, count, indx;
250
251   g_return_if_fail(flxdec != NULL);
252
253   packs = (data[0] + (data[1] << 8));
254
255   data += 2;
256   indx  = 0;
257
258   g_print("GstFlxDec: cmap packs: %d\n", packs);
259   while (packs--) {
260     /* color map index + skip count */
261     indx += *data++;
262
263     /* number of rgb triplets */
264     count = *data++ & 0xff;
265     if (count == 0)
266       count = 256;
267
268     g_print("GstFlxDec: cmap count: %d (indx: %d)\n", count, indx);
269     flx_set_palette_vector(flxdec->converter, indx, count, data, scale);
270
271     data += (count * 3);
272   }
273 }
274
275 static void 
276 flx_decode_brun(GstFlxDec *flxdec, guchar *data, guchar *dest)
277 {
278   gulong  count, lines, row;
279   guchar  x;
280   
281   g_return_if_fail(flxdec != NULL);
282
283   lines = flxdec->hdr.height;
284   while(lines--) {
285     /* packet count.  
286      * should not be used anymore, since the flc format can
287      * contain more then 255 RLE packets. we use the frame 
288      * width instead. 
289      */
290     data++;
291
292     row = flxdec->hdr.width;
293     while(row) {
294       count = *data++;
295
296       if (count > 0x7f) { 
297         /* literal run */
298         count = 0x100 - count;
299         row -= count;
300
301         while(count--) 
302           *dest++ = *data++;
303         
304       } else {
305         /* replicate run */
306         row -= count;
307         x = *data++;
308
309         while(count--) 
310           *dest++ = x;
311       }
312     }
313   }
314 }
315
316 static void 
317 flx_decode_delta_fli(GstFlxDec *flxdec, guchar *data, guchar *dest)
318 {
319   gulong  count, packets, lines, start_line, start_l;
320   guchar  *start_p,  x;
321   
322   g_return_if_fail(flxdec != NULL);
323   g_return_if_fail(flxdec->delta != NULL);
324
325
326   /* use last frame for delta */
327   memcpy(dest, GST_BUFFER_DATA(flxdec->delta), 
328          GST_BUFFER_SIZE(flxdec->delta));
329
330   start_line = (data[0] + (data[1] << 8));
331   lines      = (data[2] + (data[3] << 8));
332   data    += 4;
333
334   /* start position of delta */
335   dest += (flxdec->hdr.width * start_line);
336   start_p = dest;
337   start_l = lines;
338
339   while(lines--) {
340     /* packet count */
341     packets = *data++;
342
343     while(packets--) {
344       /* skip count */
345       dest += *data++;
346
347       /* RLE count */
348       count = *data++;
349
350       if (count > 0x7f) { 
351         /* literal run */
352         count = 0x100 - count;
353         x = *data++;
354
355         while (count--)
356           *dest++ = x;
357
358       } else {
359         /* replicate run */
360         while (count--) 
361           *dest++ = *data++;
362       }
363     }
364     start_p += flxdec->hdr.width;
365     dest = start_p;
366   }                  
367 }
368
369 static void 
370 flx_decode_delta_flc(GstFlxDec *flxdec, guchar *data, guchar *dest)
371 {
372   gulong  count, lines, start_l, opcode;
373   guchar  *start_p;
374   
375   g_return_if_fail(flxdec != NULL);
376   g_return_if_fail(flxdec->delta != NULL);
377
378
379   /* use last frame for delta */
380   memcpy(dest, GST_BUFFER_DATA(flxdec->delta), 
381          GST_BUFFER_SIZE(flxdec->delta));
382
383   lines      = (data[0] + (data[1] << 8));
384   data    += 2;
385
386   start_p    = dest;
387   start_l    = lines;
388
389   while (lines) {
390     dest = start_p + (flxdec->hdr.width * (start_l - lines));
391
392     /* process opcode(s) */
393     while ((opcode = (data[0] + (data[1] << 8))) & 0xc000) {
394       data += 2;
395       if ((opcode & 0xc000) == 0xc000) {
396         /* skip count */
397         start_l += (0x10000 - opcode);  
398         dest    += flxdec->hdr.width * (0x10000 - opcode);
399       } else {
400         /* last pixel */
401         dest    += flxdec->hdr.width;
402         *dest++  = (opcode & 0xff);
403       }        
404     }
405     data += 2;
406
407     /* last opcode is the packet count */
408     while(opcode--) {
409       /* skip count */
410       dest += *data++;
411   
412       /* RLE count */
413       count = *data++;
414       
415       if (count > 0x7f) {
416         /* replicate word run */
417         count = 0x100 - count;
418         while (count--) {
419           *dest++ = data[0];
420           *dest++ = data[1];
421         }
422         data += 2;
423       } else {
424         /* literal word run */
425         while (count--) {
426           *dest++ = *data++;
427           *dest++ = *data++;
428         }
429       }
430     }
431     lines--;
432   }
433 }
434           
435 static GstBuffer*
436 flx_get_data(GstFlxDec *flxdec, gulong size)
437 {
438   GstBuffer *retbuf;
439
440   g_return_val_if_fail (flxdec != NULL, NULL);
441
442   retbuf = gst_bytestream_read (flxdec->bs, size);
443   if (!retbuf) {
444     GstEvent *event;
445     guint32 remaining;
446
447     gst_bytestream_get_status (flxdec->bs, &remaining, &event);
448     gst_pad_event_default (flxdec->sinkpad, event);
449   }
450
451   return retbuf;
452 }
453
454
455 static void 
456 gst_flxdec_loop (GstElement *element) 
457 {
458   GstBuffer  *buf;  
459   GstBuffer  *databuf;
460   guchar     *data, *chunk;
461
462   GstFlxDec         *flxdec;  
463   FlxHeader      *flxh;
464   FlxFrameChunk  *flxfh;
465   
466   g_return_if_fail (element != NULL);
467   g_return_if_fail (GST_IS_FLXDEC(element));
468
469   GST_DEBUG (0, "entering loop function\n");
470   
471   flxdec = GST_FLXDEC(element);
472
473   if (flxdec->state == GST_FLXDEC_READ_HEADER) {
474     databuf = flx_get_data(flxdec, FlxHeaderSize);
475
476     data = GST_BUFFER_DATA(databuf);
477
478     memcpy((char *) &flxdec->hdr, data, sizeof(FlxHeader));
479
480     gst_buffer_unref (databuf);
481
482     flxh = &flxdec->hdr;
483
484     /* check header */
485     if (flxh->type != FLX_MAGICHDR_FLI &&
486       flxh->type != FLX_MAGICHDR_FLC &&
487       flxh->type != FLX_MAGICHDR_FLX) 
488       return;
489   
490   
491     g_print("GstFlxDec:       size      :  %d\n", flxh->size);
492     g_print("GstFlxDec:       frames    :  %d\n", flxh->frames);
493     g_print("GstFlxDec:       width     :  %d\n", flxh->width);
494     g_print("GstFlxDec:       height    :  %d\n", flxh->height);
495     g_print("GstFlxDec:       depth     :  %d\n", flxh->depth);
496     g_print("GstFlxDec:       speed     :  %d\n", flxh->speed);
497
498     flxdec->next_time = 0;
499
500     if (flxh->type == FLX_MAGICHDR_FLI) {
501       flxdec->frame_time = JIFFIE * flxh->speed;
502     }
503     else {
504       flxdec->frame_time = flxh->speed * 1000;
505     }
506     
507     gst_pad_try_set_caps (flxdec->srcpad,
508                 gst_caps_new (
509                   "src_video",
510                   "video/raw",
511                   gst_props_new (
512                     "format",       GST_PROPS_FOURCC (GST_MAKE_FOURCC ('R', 'G', 'B', ' ')),
513                       "bpp",        GST_PROPS_INT (32),
514                       "depth",      GST_PROPS_INT (32),
515                       "endianness", GST_PROPS_INT (G_LITTLE_ENDIAN),
516                       "red_mask",   GST_PROPS_INT (0x00ff0000),
517                       "green_mask", GST_PROPS_INT (0x0000ff00),
518                       "blue_mask",  GST_PROPS_INT (0x000000ff),
519                       "width",      GST_PROPS_INT (flxh->width), 
520                       "height",     GST_PROPS_INT (flxh->height),
521                     NULL)));
522
523     if (flxh->depth <= 8) 
524       flxdec->converter = flx_colorspace_converter_new(flxh->width, flxh->height);
525
526     if (flxh->type == FLX_MAGICHDR_FLC || 
527         flxh->type == FLX_MAGICHDR_FLX) {
528       g_print("GstFlxDec: (FLC) aspect_dx :  %d\n", flxh->aspect_dx);
529       g_print("GstFlxDec: (FLC) aspect_dy :  %d\n", flxh->aspect_dy);
530       g_print("GstFlxDec: (FLC) oframe1   :  0x%08x\n", flxh->oframe1);
531       g_print("GstFlxDec: (FLC) oframe2   :  0x%08x\n", flxh->oframe2);
532     }
533
534   
535     flxdec->size = (flxh->width * flxh->height);
536   
537     /* create delta and output frame */
538     flxdec->frame = gst_buffer_new();
539     flxdec->delta = gst_buffer_new();
540     GST_BUFFER_DATA(flxdec->frame) = g_malloc(flxdec->size);
541     GST_BUFFER_SIZE(flxdec->frame) = flxdec->size;
542     GST_BUFFER_DATA(flxdec->delta) = g_malloc(flxdec->size);
543     GST_BUFFER_SIZE(flxdec->delta) = flxdec->size;
544
545     flxdec->state = GST_FLXDEC_PLAYING;
546   }
547   else if (flxdec->state == GST_FLXDEC_PLAYING) {
548
549     databuf = flx_get_data(flxdec, FlxFrameChunkSize);
550
551     flxfh = (FlxFrameChunk *) GST_BUFFER_DATA(databuf);
552     
553     switch(flxfh->id) {
554       case FLX_FRAME_TYPE:
555         buf = flx_get_data(flxdec, flxfh->size-FlxFrameChunkSize);
556  
557         chunk = GST_BUFFER_DATA(buf);
558  
559         if (((FlxFrameType *)chunk)->chunks == 0)
560           break;
561
562         /* create 32 bits output frame */
563         flxdec->out = gst_buffer_new();
564         GST_BUFFER_DATA(flxdec->out) = g_malloc(flxdec->size * 4);
565         GST_BUFFER_SIZE(flxdec->out) = flxdec->size * 4;
566
567
568         /* decode chunks */
569         flx_decode_chunks(flxdec, 
570                          ((FlxFrameType *)chunk)->chunks, 
571                          GST_BUFFER_DATA(buf) + FlxFrameTypeSize,
572                          GST_BUFFER_DATA(flxdec->frame));
573  
574         /* destroy input buffer*/
575         gst_buffer_unref(buf);
576     
577         /* save copy of the current frame for possible delta. */
578         memcpy(GST_BUFFER_DATA(flxdec->delta), 
579                GST_BUFFER_DATA(flxdec->frame), 
580                GST_BUFFER_SIZE(flxdec->delta));
581
582         /* convert current frame. */
583         flx_colorspace_convert(flxdec->converter,
584              GST_BUFFER_DATA(flxdec->frame),
585              GST_BUFFER_DATA(flxdec->out));
586
587         GST_BUFFER_TIMESTAMP (flxdec->out) = flxdec->next_time;
588         flxdec->next_time += flxdec->frame_time;
589
590         gst_pad_push(flxdec->srcpad, flxdec->out);
591         
592         break;
593     }
594
595     /* destroy header buffer */
596     gst_buffer_unref(databuf);
597   }
598 }
599
600 static GstElementStateReturn 
601 gst_flxdec_change_state (GstElement *element)
602 {
603   GstFlxDec *flxdec;
604
605   flxdec = GST_FLXDEC(element);
606
607   switch (GST_STATE_TRANSITION (element)) {
608     case GST_STATE_NULL_TO_READY:
609       flxdec->bs = gst_bytestream_new (flxdec->sinkpad);
610       break;
611     case GST_STATE_READY_TO_PAUSED:
612       flxdec->state = GST_FLXDEC_READ_HEADER;
613       break;
614     case GST_STATE_PAUSED_TO_PLAYING:
615       break;
616     case GST_STATE_PLAYING_TO_PAUSED:
617       break;
618     case GST_STATE_PAUSED_TO_READY:
619       gst_buffer_unref (flxdec->frame);
620       gst_buffer_unref (flxdec->delta);
621       break;
622     case GST_STATE_READY_TO_NULL:
623       gst_bytestream_destroy (flxdec->bs);
624       break;
625   }
626   
627   parent_class->change_state (element);
628
629   return GST_STATE_SUCCESS;
630 }
631
632 static void 
633 gst_flxdec_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec) 
634 {
635   GstFlxDec *flxdec;
636
637   /* it's not null if we got it, but it might not be ours */
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, GParamSpec *pspec) 
649 {
650   GstFlxDec *flxdec;
651
652   /* it's not null if we got it, but it might not be ours */
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 (GModule *module, GstPlugin *plugin)
665 {
666   GstElementFactory *factory;
667   GstTypeFactory *type;
668
669   /* this filter needs the bytestream package */
670   if (!gst_library_load("gstbytestream")) {
671     gst_info("flxdec:: could not load support library: 'gstbytestream'\n");
672     return FALSE;
673   }
674
675   factory = gst_elementfactory_new("flxdec", GST_TYPE_FLXDEC, &flxdec_details);
676   g_return_val_if_fail(factory != NULL, FALSE);
677
678   gst_elementfactory_add_padtemplate (factory, GST_PADTEMPLATE_GET (sink_factory));
679   gst_elementfactory_add_padtemplate (factory, GST_PADTEMPLATE_GET (src_video_factory));
680
681   gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (factory));
682
683   type = gst_typefactory_new (&flxdec_definition);
684   gst_plugin_add_feature (plugin, GST_PLUGIN_FEATURE (type));
685
686   return TRUE;
687 }
688
689 GstPluginDesc plugin_desc = {
690   GST_VERSION_MAJOR,
691   GST_VERSION_MINOR,
692   "flxdec",
693   plugin_init
694 };