grayscale mjpeg decoding support based upon a patch by (Leon Bottou (leonb))
[ffmpeg.git] / libavformat / avidec.c
1 /*
2  * AVI decoder.
3  * Copyright (c) 2001 Fabrice Bellard.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  */
19 #include "avformat.h"
20 #include "avi.h"
21 #include "dv.h"
22
23 //#define DEBUG
24 //#define DEBUG_SEEK
25
26 typedef struct AVIIndexEntry {
27     unsigned int flags;
28     unsigned int pos;
29     unsigned int cum_len; /* sum of all lengths before this packet */
30 } AVIIndexEntry;
31
32 typedef struct AVIStream {
33     AVIIndexEntry *index_entries;
34     int nb_index_entries;
35     int index_entries_allocated_size;
36     int frame_offset; /* current frame (video) or byte (audio) counter
37                          (used to compute the pts) */
38     int scale;
39     int rate;    
40     int sample_size; /* audio only data */
41     
42     int new_frame_offset; /* temporary storage (used during seek) */
43     int cum_len; /* temporary storage (used during seek) */
44 } AVIStream;
45
46 typedef struct {
47     int64_t  riff_end;
48     int64_t  movi_end;
49     offset_t movi_list;
50     int index_loaded;
51     DVDemuxContext* dv_demux;
52 } AVIContext;
53
54 #ifdef DEBUG
55 static void print_tag(const char *str, unsigned int tag, int size)
56 {
57     printf("%s: tag=%c%c%c%c size=0x%x\n",
58            str, tag & 0xff,
59            (tag >> 8) & 0xff,
60            (tag >> 16) & 0xff,
61            (tag >> 24) & 0xff,
62            size);
63 }
64 #endif
65
66 static int get_riff(AVIContext *avi, ByteIOContext *pb)
67 {
68     uint32_t tag; 
69     /* check RIFF header */
70     tag = get_le32(pb);
71
72     if (tag != MKTAG('R', 'I', 'F', 'F'))
73         return -1;
74     avi->riff_end = get_le32(pb);   /* RIFF chunk size */
75     avi->riff_end += url_ftell(pb); /* RIFF chunk end */
76     tag = get_le32(pb);
77     if (tag != MKTAG('A', 'V', 'I', ' ') && tag != MKTAG('A', 'V', 'I', 'X'))
78         return -1;
79     
80     return 0;
81 }
82
83 static int avi_read_header(AVFormatContext *s, AVFormatParameters *ap)
84 {
85     AVIContext *avi = s->priv_data;
86     ByteIOContext *pb = &s->pb;
87     uint32_t tag, tag1, handler;
88     int codec_type, stream_index, frame_period, bit_rate, scale, rate;
89     unsigned int size, nb_frames;
90     int i, n;
91     AVStream *st;
92     AVIStream *ast;
93     int xan_video = 0;  /* hack to support Xan A/V */
94
95     av_set_pts_info(s, 64, 1, AV_TIME_BASE);
96
97     if (get_riff(avi, pb) < 0)
98         return -1;
99
100     /* first list tag */
101     stream_index = -1;
102     codec_type = -1;
103     frame_period = 0;
104     for(;;) {
105         if (url_feof(pb))
106             goto fail;
107         tag = get_le32(pb);
108         size = get_le32(pb);
109 #ifdef DEBUG
110         print_tag("tag", tag, size);
111 #endif
112
113         switch(tag) {
114         case MKTAG('L', 'I', 'S', 'T'):
115             /* ignored, except when start of video packets */
116             tag1 = get_le32(pb);
117 #ifdef DEBUG
118             print_tag("list", tag1, 0);
119 #endif
120             if (tag1 == MKTAG('m', 'o', 'v', 'i')) {
121                 avi->movi_list = url_ftell(pb) - 4;
122                 avi->movi_end = avi->movi_list + size;
123 #ifdef DEBUG
124                 printf("movi end=%Lx\n", avi->movi_end);
125 #endif
126                 goto end_of_header;
127             }
128             break;
129         case MKTAG('a', 'v', 'i', 'h'):
130             /* avi header */
131             /* using frame_period is bad idea */
132             frame_period = get_le32(pb);
133             bit_rate = get_le32(pb) * 8;
134             url_fskip(pb, 4 * 4);
135             n = get_le32(pb);
136             for(i=0;i<n;i++) {
137                 AVIStream *ast;
138                 st = av_new_stream(s, i);
139                 if (!st)
140                     goto fail;
141                 ast = av_mallocz(sizeof(AVIStream));
142                 if (!ast)
143                     goto fail;
144                 st->priv_data = ast;
145             }
146             url_fskip(pb, size - 7 * 4);
147             break;
148         case MKTAG('s', 't', 'r', 'h'):
149             /* stream header */
150             stream_index++;
151             tag1 = get_le32(pb);
152             handler = get_le32(pb); /* codec tag */
153             switch(tag1) {
154             case MKTAG('i', 'a', 'v', 's'):
155             case MKTAG('i', 'v', 'a', 's'):
156                 /* 
157                  * After some consideration -- I don't think we 
158                  * have to support anything but DV in a type1 AVIs.
159                  */
160                 if (s->nb_streams != 1)
161                     goto fail;
162                 
163                 if (handler != MKTAG('d', 'v', 's', 'd') &&
164                     handler != MKTAG('d', 'v', 'h', 'd') &&
165                     handler != MKTAG('d', 'v', 's', 'l'))
166                    goto fail;
167                 
168                 av_freep(&s->streams[0]->codec.extradata);
169                 av_freep(&s->streams[0]);
170                 s->nb_streams = 0;
171                 avi->dv_demux = dv_init_demux(s);
172                 if (!avi->dv_demux)
173                     goto fail;
174                 stream_index = s->nb_streams - 1;
175                 url_fskip(pb, size - 8);
176                 break;
177             case MKTAG('v', 'i', 'd', 's'):
178                 codec_type = CODEC_TYPE_VIDEO;
179
180                 if (stream_index >= s->nb_streams) {
181                     url_fskip(pb, size - 8);
182                     break;
183                 } 
184
185                 st = s->streams[stream_index];
186                 ast = st->priv_data;
187                 st->codec.stream_codec_tag= handler;
188                 
189                 get_le32(pb); /* flags */
190                 get_le16(pb); /* priority */
191                 get_le16(pb); /* language */
192                 get_le32(pb); /* XXX: initial frame ? */
193                 scale = get_le32(pb); /* scale */
194                 rate = get_le32(pb); /* rate */
195
196                 if(scale && rate){
197                 }else if(frame_period){
198                     rate = 1000000;
199                     scale = frame_period;
200                 }else{
201                     rate = 25;
202                     scale = 1;
203                 }
204                 ast->rate = rate;
205                 ast->scale = scale;
206                 st->codec.frame_rate = rate;
207                 st->codec.frame_rate_base = scale;
208                 get_le32(pb); /* start */
209                 nb_frames = get_le32(pb);
210                 st->start_time = 0;
211                 st->duration = (double)nb_frames * 
212                     st->codec.frame_rate_base * AV_TIME_BASE / 
213                     st->codec.frame_rate;
214                 url_fskip(pb, size - 9 * 4);
215                 break;
216             case MKTAG('a', 'u', 'd', 's'):
217                 {
218                     unsigned int length;
219
220                     codec_type = CODEC_TYPE_AUDIO;
221
222                     if (stream_index >= s->nb_streams) {
223                         url_fskip(pb, size - 8);
224                         break;
225                     } 
226                     st = s->streams[stream_index];
227                     ast = st->priv_data;
228                     
229                     get_le32(pb); /* flags */
230                     get_le16(pb); /* priority */
231                     get_le16(pb); /* language */
232                     get_le32(pb); /* initial frame */
233                     ast->scale = get_le32(pb); /* scale */
234                     ast->rate = get_le32(pb);
235                     get_le32(pb); /* start */
236                     length = get_le32(pb); /* length, in samples or bytes */
237                     get_le32(pb); /* buffer size */
238                     get_le32(pb); /* quality */
239                     ast->sample_size = get_le32(pb); /* sample ssize */
240                     st->start_time = 0;
241                     if (ast->rate != 0)
242                         st->duration = (int64_t)length * AV_TIME_BASE / ast->rate;
243                     url_fskip(pb, size - 12 * 4);
244                 }
245                 break;
246             default:
247                 goto fail;
248             }
249             break;
250         case MKTAG('s', 't', 'r', 'f'):
251             /* stream header */
252             if (stream_index >= s->nb_streams || avi->dv_demux) {
253                 url_fskip(pb, size);
254             } else {
255                 st = s->streams[stream_index];
256                 switch(codec_type) {
257                 case CODEC_TYPE_VIDEO:
258                     get_le32(pb); /* size */
259                     st->codec.width = get_le32(pb);
260                     st->codec.height = get_le32(pb);
261                     get_le16(pb); /* panes */
262                     st->codec.bits_per_sample= get_le16(pb); /* depth */
263                     tag1 = get_le32(pb);
264                     get_le32(pb); /* ImageSize */
265                     get_le32(pb); /* XPelsPerMeter */
266                     get_le32(pb); /* YPelsPerMeter */
267                     get_le32(pb); /* ClrUsed */
268                     get_le32(pb); /* ClrImportant */
269
270                     st->codec.extradata_size= size - 10*4;
271                     st->codec.extradata= av_malloc(st->codec.extradata_size);
272                     get_buffer(pb, st->codec.extradata, st->codec.extradata_size);
273                     
274                     if(st->codec.extradata_size & 1) //FIXME check if the encoder really did this correctly
275                         get_byte(pb);
276
277                     /* Extract palette from extradata if bpp <= 8 */
278                     /* This code assumes that extradata contains only palette */
279                     /* This is true for all paletted codecs implemented in ffmpeg */
280                     if (st->codec.extradata_size && (st->codec.bits_per_sample <= 8)) {
281                         st->codec.palctrl = av_mallocz(sizeof(AVPaletteControl));
282 #ifdef WORDS_BIGENDIAN
283                         for (i = 0; i < FFMIN(st->codec.extradata_size, AVPALETTE_SIZE)/4; i++)
284                             st->codec.palctrl->palette[i] = bswap_32(((uint32_t*)st->codec.extradata)[i]);
285 #else
286                         memcpy(st->codec.palctrl->palette, st->codec.extradata,
287                                FFMIN(st->codec.extradata_size, AVPALETTE_SIZE));
288 #endif
289                         st->codec.palctrl->palette_changed = 1;
290                     }
291
292 #ifdef DEBUG
293                     print_tag("video", tag1, 0);
294 #endif
295                     st->codec.codec_type = CODEC_TYPE_VIDEO;
296                     st->codec.codec_tag = tag1;
297                     st->codec.codec_id = codec_get_id(codec_bmp_tags, tag1);
298                     if (st->codec.codec_id == CODEC_ID_XAN_WC4)
299                         xan_video = 1;
300 //                    url_fskip(pb, size - 5 * 4);
301                     break;
302                 case CODEC_TYPE_AUDIO:
303                     get_wav_header(pb, &st->codec, size);
304                     if (size%2) /* 2-aligned (fix for Stargate SG-1 - 3x18 - Shades of Grey.avi) */
305                         url_fskip(pb, 1);
306                     /* special case time: To support Xan DPCM, hardcode
307                      * the format if Xxan is the video codec */
308                     st->need_parsing = 1;
309                     /* force parsing as several audio frames can be in
310                        one packet */
311                     if (xan_video)
312                         st->codec.codec_id = CODEC_ID_XAN_DPCM;
313                     break;
314                 default:
315                     url_fskip(pb, size);
316                     break;
317                 }
318             }
319             break;
320         default:
321             /* skip tag */
322             size += (size & 1);
323             url_fskip(pb, size);
324             break;
325         }
326     }
327  end_of_header:
328     /* check stream number */
329     if (stream_index != s->nb_streams - 1) {
330     fail:
331         for(i=0;i<s->nb_streams;i++) {
332             av_freep(&s->streams[i]->codec.extradata);
333             av_freep(&s->streams[i]);
334         }
335         return -1;
336     }
337
338     return 0;
339 }
340
341 static int avi_read_packet(AVFormatContext *s, AVPacket *pkt)
342 {
343     AVIContext *avi = s->priv_data;
344     ByteIOContext *pb = &s->pb;
345     int n, d[8], size, i;
346     void* dstr;
347
348     memset(d, -1, sizeof(int)*8);
349    
350     if (avi->dv_demux) {
351         size = dv_get_packet(avi->dv_demux, pkt);
352         if (size >= 0)
353             return size;
354     }
355         
356     for(i=url_ftell(pb); !url_feof(pb); i++) {
357         int j;
358
359         if (i >= avi->movi_end) { /* Let's see if it's an OpenDML AVI */
360             uint32_t tag, size, tag2;
361             url_fskip(pb, avi->riff_end - url_ftell(pb));
362             if (get_riff(avi, pb) < 0)
363                 return -1;
364             
365             tag = get_le32(pb);
366             size = get_le32(pb);
367             tag2 = get_le32(pb);
368             if (tag == MKTAG('L','I','S','T') && tag2 == MKTAG('m','o','v','i'))
369                 avi->movi_end = url_ftell(pb) + size - 4; 
370             else
371                 return -1;
372         }
373
374         for(j=0; j<7; j++)
375             d[j]= d[j+1];
376         d[7]= get_byte(pb);
377         
378         size= d[4] + (d[5]<<8) + (d[6]<<16) + (d[7]<<24);
379         
380         //parse ix##
381         n= (d[2] - '0') * 10 + (d[3] - '0');
382         if(    d[2] >= '0' && d[2] <= '9'
383             && d[3] >= '0' && d[3] <= '9'
384             && d[0] == 'i' && d[1] == 'x'
385             && n < s->nb_streams
386             && i + size <= avi->movi_end){
387             
388             url_fskip(pb, size);
389         }
390         
391         //parse ##dc/##wb
392         n= (d[0] - '0') * 10 + (d[1] - '0');
393         if(    d[0] >= '0' && d[0] <= '9'
394             && d[1] >= '0' && d[1] <= '9'
395             && ((d[2] == 'd' && d[3] == 'c') || 
396                 (d[2] == 'w' && d[3] == 'b') || 
397                 (d[2] == 'd' && d[3] == 'b') ||
398                 (d[2] == '_' && d[3] == '_'))
399             && n < s->nb_streams
400             && i + size <= avi->movi_end) {
401         
402             av_new_packet(pkt, size);
403             get_buffer(pb, pkt->data, size);
404             if (size & 1) {
405                 get_byte(pb);
406                 size++;
407             }
408         
409             if (avi->dv_demux) {
410                 dstr = pkt->destruct;
411                 size = dv_produce_packet(avi->dv_demux, pkt,
412                                          pkt->data, pkt->size);
413                 pkt->destruct = dstr;
414                 pkt->flags |= PKT_FLAG_KEY;
415             } else {
416                 AVStream *st;
417                 AVIStream *ast;
418                 st = s->streams[n];
419                 ast = st->priv_data;
420
421                 /* XXX: how to handle B frames in avi ? */
422                 pkt->pts = ((int64_t)ast->frame_offset * ast->scale* AV_TIME_BASE) / ast->rate;
423                 pkt->stream_index = n;
424                 /* FIXME: We really should read index for that */
425                 if (st->codec.codec_type == CODEC_TYPE_VIDEO) {
426                     if (ast->frame_offset < ast->nb_index_entries) {
427                         if (ast->index_entries[ast->frame_offset].flags & AVIIF_INDEX)
428                             pkt->flags |= PKT_FLAG_KEY; 
429                     } else {
430                         /* if no index, better to say that all frames
431                            are key frames */
432                         pkt->flags |= PKT_FLAG_KEY;
433                     }
434                     ast->frame_offset++;
435                 } else {
436                     ast->frame_offset += pkt->size;
437                     pkt->flags |= PKT_FLAG_KEY; 
438                 }
439             }
440             return size;
441         }
442     }
443     return -1;
444 }
445
446 /* XXX: we make the implicit supposition that the position are sorted
447    for each stream */
448 static int avi_read_idx1(AVFormatContext *s, int size)
449 {
450     ByteIOContext *pb = &s->pb;
451     int nb_index_entries, i;
452     AVStream *st;
453     AVIStream *ast;
454     AVIIndexEntry *ie, *entries;
455     unsigned int index, tag, flags, pos, len;
456     
457     nb_index_entries = size / 16;
458     if (nb_index_entries <= 0)
459         return -1;
460
461     /* read the entries and sort them in each stream component */
462     for(i = 0; i < nb_index_entries; i++) {
463         tag = get_le32(pb);
464         flags = get_le32(pb);
465         pos = get_le32(pb);
466         len = get_le32(pb);
467 #if defined(DEBUG_SEEK) && 0
468         printf("%d: tag=0x%x flags=0x%x pos=0x%x len=%d\n", 
469                i, tag, flags, pos, len);
470 #endif
471         index = ((tag & 0xff) - '0') * 10;
472         index += ((tag >> 8) & 0xff) - '0';
473         if (index >= s->nb_streams)
474             continue;
475         st = s->streams[index];
476         ast = st->priv_data;
477         
478         entries = av_fast_realloc(ast->index_entries,
479                                   &ast->index_entries_allocated_size,
480                                   (ast->nb_index_entries + 1) * 
481                                   sizeof(AVIIndexEntry));
482         if (entries) {
483             ast->index_entries = entries;
484             ie = &entries[ast->nb_index_entries++];
485             ie->flags = flags;
486             ie->pos = pos;
487             ie->cum_len = ast->cum_len;
488             ast->cum_len += len;
489         }
490     }
491     return 0;
492 }
493
494 static int avi_load_index(AVFormatContext *s)
495 {
496     AVIContext *avi = s->priv_data;
497     ByteIOContext *pb = &s->pb;
498     uint32_t tag, size;
499
500     url_fseek(pb, avi->movi_end, SEEK_SET);
501 #ifdef DEBUG_SEEK
502     printf("movi_end=0x%llx\n", avi->movi_end);
503 #endif
504     for(;;) {
505         if (url_feof(pb))
506             break;
507         tag = get_le32(pb);
508         size = get_le32(pb);
509 #ifdef DEBUG_SEEK
510         printf("tag=%c%c%c%c size=0x%x\n",
511                tag & 0xff,
512                (tag >> 8) & 0xff,
513                (tag >> 16) & 0xff,
514                (tag >> 24) & 0xff,
515                size);
516 #endif
517         switch(tag) {
518         case MKTAG('i', 'd', 'x', '1'):
519             if (avi_read_idx1(s, size) < 0)
520                 goto skip;
521             else
522                 goto the_end;
523             break;
524         default:
525         skip:
526             size += (size & 1);
527             url_fskip(pb, size);
528             break;
529         }
530     }
531  the_end:
532     return 0;
533 }
534
535 /* return the index entry whose position is immediately >= 'wanted_pos' */
536 static int locate_frame_in_index(AVIIndexEntry *entries, 
537                                  int nb_entries, int wanted_pos)
538 {
539     int a, b, m, pos;
540     
541     a = 0;
542     b = nb_entries - 1;
543     while (a <= b) {
544         m = (a + b) >> 1;
545         pos = entries[m].pos;
546         if (pos == wanted_pos)
547             goto found;
548         else if (pos > wanted_pos) {
549             b = m - 1;
550         } else {
551             a = m + 1;
552         }
553     }
554     m = a;
555     if (m > 0)
556         m--;
557  found:
558     return m;
559 }
560
561 static int avi_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp)
562 {
563     AVIContext *avi = s->priv_data;
564     AVStream *st;
565     AVIStream *ast;
566     int frame_number, i;
567     int64_t pos;
568
569     if (!avi->index_loaded) {
570         /* we only load the index on demand */
571         avi_load_index(s);
572         avi->index_loaded = 1;
573     }
574     if (stream_index < 0) {
575         for(i = 0; i < s->nb_streams; i++) {
576             st = s->streams[i];
577             if (st->codec.codec_type == CODEC_TYPE_VIDEO)
578                 goto found;
579         }
580         return -1;
581     found:
582         stream_index = i;
583     }
584
585     st = s->streams[stream_index];
586     if (st->codec.codec_type != CODEC_TYPE_VIDEO)
587         return -1;
588     ast = st->priv_data;
589     /* compute the frame number */
590     frame_number = (timestamp * ast->rate) /
591         (ast->scale * (int64_t)AV_TIME_BASE);
592 #ifdef DEBUG_SEEK
593     printf("timestamp=%0.3f nb_indexes=%d frame_number=%d\n", 
594            (double)timestamp / AV_TIME_BASE,
595            ast->nb_index_entries, frame_number);
596 #endif
597     /* find a closest key frame before */
598     if (frame_number >= ast->nb_index_entries)
599         return -1;
600     while (frame_number >= 0 &&
601            !(ast->index_entries[frame_number].flags & AVIIF_INDEX))
602         frame_number--;
603     if (frame_number < 0)
604         return -1;
605     ast->new_frame_offset = frame_number;
606
607     /* find the position */
608     pos = ast->index_entries[frame_number].pos;
609
610 #ifdef DEBUG_SEEK
611     printf("key_frame_number=%d pos=0x%llx\n", 
612            frame_number, pos);
613 #endif
614     
615     /* update the frame counters for all the other stream by looking
616        at the positions just after the one found */
617     for(i = 0; i < s->nb_streams; i++) {
618         int j;
619         if (i != stream_index) {
620             st = s->streams[i];
621             ast = st->priv_data;
622             if (ast->nb_index_entries <= 0)
623                 return -1;
624             j = locate_frame_in_index(ast->index_entries,
625                                       ast->nb_index_entries,
626                                       pos);
627             /* get next frame */
628             if ((j  + 1) < ast->nb_index_entries)
629                 j++;
630             /* extract the current frame number */
631             if (st->codec.codec_type == CODEC_TYPE_VIDEO)           
632                 ast->new_frame_offset = j;
633             else
634                 ast->new_frame_offset = ast->index_entries[j].cum_len;
635         }
636     }
637     
638     /* everything is OK now. We can update the frame offsets */
639     for(i = 0; i < s->nb_streams; i++) {
640         st = s->streams[i];
641         ast = st->priv_data;
642         ast->frame_offset = ast->new_frame_offset;
643 #ifdef DEBUG_SEEK
644         printf("%d: frame_offset=%d\n", i, 
645                ast->frame_offset);
646 #endif
647     }
648     /* do the seek */
649     pos += avi->movi_list;
650     url_fseek(&s->pb, pos, SEEK_SET);
651     return 0;
652 }
653
654 static int avi_read_close(AVFormatContext *s)
655 {
656     int i;
657     AVIContext *avi = s->priv_data;
658
659     for(i=0;i<s->nb_streams;i++) {
660         AVStream *st = s->streams[i];
661         AVIStream *ast = st->priv_data;
662         if(ast){
663             av_free(ast->index_entries);
664             av_free(ast);
665         }
666         av_free(st->codec.extradata);
667         av_free(st->codec.palctrl);
668     }
669
670     if (avi->dv_demux)
671         av_free(avi->dv_demux);
672
673     return 0;
674 }
675
676 static int avi_probe(AVProbeData *p)
677 {
678     /* check file header */
679     if (p->buf_size <= 32)
680         return 0;
681     if (p->buf[0] == 'R' && p->buf[1] == 'I' &&
682         p->buf[2] == 'F' && p->buf[3] == 'F' &&
683         p->buf[8] == 'A' && p->buf[9] == 'V' &&
684         p->buf[10] == 'I' && p->buf[11] == ' ')
685         return AVPROBE_SCORE_MAX;
686     else
687         return 0;
688 }
689
690 static AVInputFormat avi_iformat = {
691     "avi",
692     "avi format",
693     sizeof(AVIContext),
694     avi_probe,
695     avi_read_header,
696     avi_read_packet,
697     avi_read_close,
698     avi_read_seek,
699 };
700
701 int avidec_init(void)
702 {
703     av_register_input_format(&avi_iformat);
704     return 0;
705 }