6295f1a567a395ecb8133f6ea137f7a70ef877ef
[ffmpeg.git] / libavformat / flvdec.c
1 /*
2  * FLV demuxer
3  * Copyright (c) 2003 The FFmpeg Project.
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  *
21  *
22  * This demuxer will generate a 1 byte extradata for VP6F content.
23  * It is composed of:
24  *  - upper 4bits: difference between encoded width and visible width
25  *  - lower 4bits: difference between encoded height and visible height
26  */
27 #include "avformat.h"
28 #include "flv.h"
29
30 static int flv_probe(AVProbeData *p)
31 {
32     const uint8_t *d;
33
34     if (p->buf_size < 6)
35         return 0;
36     d = p->buf;
37     if (d[0] == 'F' && d[1] == 'L' && d[2] == 'V' && d[3] < 5 && d[5]==0) {
38         return AVPROBE_SCORE_MAX;
39     }
40     return 0;
41 }
42
43 static void flv_set_audio_codec(AVFormatContext *s, AVStream *astream, int flv_codecid) {
44     AVCodecContext *acodec = astream->codec;
45     switch(flv_codecid) {
46         //no distinction between S16 and S8 PCM codec flags
47         case FLV_CODECID_PCM_BE:
48             acodec->codec_id = acodec->bits_per_sample == 8 ? CODEC_ID_PCM_S8 : CODEC_ID_PCM_S16BE; break;
49         case FLV_CODECID_PCM_LE:
50             acodec->codec_id = acodec->bits_per_sample == 8 ? CODEC_ID_PCM_S8 : CODEC_ID_PCM_S16LE; break;
51         case FLV_CODECID_ADPCM: acodec->codec_id = CODEC_ID_ADPCM_SWF;                              break;
52         case FLV_CODECID_MP3  : acodec->codec_id = CODEC_ID_MP3      ; astream->need_parsing = 1  ; break;
53         case FLV_CODECID_NELLYMOSER_8HZ_MONO:
54             acodec->sample_rate = 8000; //in case metadata does not otherwise declare samplerate
55         case FLV_CODECID_NELLYMOSER:
56         default:
57             av_log(s, AV_LOG_INFO, "Unsupported audio codec (%x)\n", flv_codecid >> FLV_AUDIO_CODECID_OFFSET);
58             acodec->codec_tag = flv_codecid >> FLV_AUDIO_CODECID_OFFSET;
59     }
60 }
61
62 static int flv_set_video_codec(AVFormatContext *s, AVStream *vstream, int flv_codecid) {
63     AVCodecContext *vcodec = vstream->codec;
64     switch(flv_codecid) {
65         case FLV_CODECID_H263  : vcodec->codec_id = CODEC_ID_FLV1   ; break;
66         case FLV_CODECID_SCREEN: vcodec->codec_id = CODEC_ID_FLASHSV; break;
67         case FLV_CODECID_VP6   : vcodec->codec_id = CODEC_ID_VP6F   ;
68             if(vcodec->extradata_size != 1) {
69                 vcodec->extradata_size = 1;
70                 vcodec->extradata = av_malloc(1);
71             }
72             vcodec->extradata[0] = get_byte(&s->pb);
73             return 1; // 1 byte body size adjustment for flv_read_packet()
74         default:
75             av_log(s, AV_LOG_INFO, "Unsupported video codec (%x)\n", flv_codecid);
76             vcodec->codec_tag = flv_codecid;
77     }
78
79     return 0;
80 }
81
82 static int amf_get_string(ByteIOContext *ioc, char *buffer, int buffsize) {
83     int length = get_be16(ioc);
84     if(length >= buffsize) {
85         url_fskip(ioc, length);
86         return -1;
87     }
88
89     get_buffer(ioc, buffer, length);
90
91     buffer[length] = '\0';
92
93     return length;
94 }
95
96 static int amf_parse_object(AVFormatContext *s, AVStream *astream, AVStream *vstream, const char *key, unsigned int max_pos, int depth) {
97     AVCodecContext *acodec, *vcodec;
98     ByteIOContext *ioc;
99     AMFDataType amf_type;
100     char str_val[256];
101     double num_val;
102
103     num_val = 0;
104     ioc = &s->pb;
105
106     amf_type = get_byte(ioc);
107
108     switch(amf_type) {
109         case AMF_DATA_TYPE_NUMBER:
110             num_val = av_int2dbl(get_be64(ioc)); break;
111         case AMF_DATA_TYPE_BOOL:
112             num_val = get_byte(ioc); break;
113         case AMF_DATA_TYPE_STRING:
114             if(amf_get_string(ioc, str_val, sizeof(str_val)) < 0)
115                 return -1;
116             break;
117         case AMF_DATA_TYPE_OBJECT: {
118             unsigned int keylen;
119
120             while(url_ftell(ioc) < max_pos - 2 && (keylen = get_be16(ioc))) {
121                 url_fskip(ioc, keylen); //skip key string
122                 if(amf_parse_object(s, NULL, NULL, NULL, max_pos, depth + 1) < 0)
123                     return -1; //if we couldn't skip, bomb out.
124             }
125             if(get_byte(ioc) != AMF_END_OF_OBJECT)
126                 return -1;
127         }
128             break;
129         case AMF_DATA_TYPE_NULL:
130         case AMF_DATA_TYPE_UNDEFINED:
131         case AMF_DATA_TYPE_UNSUPPORTED:
132             break; //these take up no additional space
133         case AMF_DATA_TYPE_MIXEDARRAY:
134             url_fskip(ioc, 4); //skip 32-bit max array index
135             while(url_ftell(ioc) < max_pos - 2 && amf_get_string(ioc, str_val, sizeof(str_val)) > 0) {
136                 //this is the only case in which we would want a nested parse to not skip over the object
137                 if(amf_parse_object(s, astream, vstream, str_val, max_pos, depth + 1) < 0)
138                     return -1;
139             }
140             if(get_byte(ioc) != AMF_END_OF_OBJECT)
141                 return -1;
142             break;
143         case AMF_DATA_TYPE_ARRAY: {
144             unsigned int arraylen, i;
145
146             arraylen = get_be32(ioc);
147             for(i = 0; i < arraylen && url_ftell(ioc) < max_pos - 1; i++) {
148                 if(amf_parse_object(s, NULL, NULL, NULL, max_pos, depth + 1) < 0)
149                     return -1; //if we couldn't skip, bomb out.
150             }
151         }
152             break;
153         case AMF_DATA_TYPE_DATE:
154             url_fskip(ioc, 8 + 2); //timestamp (double) and UTC offset (int16)
155             break;
156         default: //unsupported type, we couldn't skip
157             return -1;
158     }
159
160     if(depth == 1 && key) { //only look for metadata values when we are not nested and key != NULL
161         acodec = astream ? astream->codec : NULL;
162         vcodec = vstream ? vstream->codec : NULL;
163
164         if(amf_type == AMF_DATA_TYPE_BOOL) {
165             if(!strcmp(key, "stereo") && acodec) acodec->channels = num_val > 0 ? 2 : 1;
166         } else if(amf_type == AMF_DATA_TYPE_NUMBER) {
167             if(!strcmp(key, "duration")) s->duration = num_val * AV_TIME_BASE;
168 //            else if(!strcmp(key, "width")  && vcodec && num_val > 0) vcodec->width  = num_val;
169 //            else if(!strcmp(key, "height") && vcodec && num_val > 0) vcodec->height = num_val;
170             else if(!strcmp(key, "audiocodecid") && acodec) flv_set_audio_codec(s, astream, (int)num_val << FLV_AUDIO_CODECID_OFFSET);
171             else if(!strcmp(key, "videocodecid") && vcodec) flv_set_video_codec(s, vstream, (int)num_val);
172             else if(!strcmp(key, "audiosamplesize") && acodec && num_val >= 0) {
173                 acodec->bits_per_sample = num_val;
174                 //we may have to rewrite a previously read codecid because FLV only marks PCM endianness.
175                 if(num_val == 8 && (acodec->codec_id == CODEC_ID_PCM_S16BE || acodec->codec_id == CODEC_ID_PCM_S16LE))
176                     acodec->codec_id = CODEC_ID_PCM_S8;
177             }
178             else if(!strcmp(key, "audiosamplerate") && acodec && num_val >= 0) {
179                 //some tools, like FLVTool2, write consistently approximate metadata sample rates
180                 switch((int)num_val) {
181                     case 44000: acodec->sample_rate = 44100  ; break;
182                     case 22000: acodec->sample_rate = 22050  ; break;
183                     case 11000: acodec->sample_rate = 11025  ; break;
184                     case 5000 : acodec->sample_rate = 5512   ; break;
185                     default   : acodec->sample_rate = num_val;
186                 }
187             }
188         }
189     }
190
191     return 0;
192 }
193
194 static int flv_read_metabody(AVFormatContext *s, unsigned int next_pos) {
195     AMFDataType type;
196     AVStream *stream, *astream, *vstream;
197     ByteIOContext *ioc;
198     int i, keylen;
199     char buffer[11]; //only needs to hold the string "onMetaData". Anything longer is something we don't want.
200
201     astream = NULL;
202     vstream = NULL;
203     keylen = 0;
204     ioc = &s->pb;
205
206     //first object needs to be "onMetaData" string
207     type = get_byte(ioc);
208     if(type != AMF_DATA_TYPE_STRING || amf_get_string(ioc, buffer, sizeof(buffer)) < 0 || strcmp(buffer, "onMetaData"))
209         return -1;
210
211     //find the streams now so that amf_parse_object doesn't need to do the lookup every time it is called.
212     for(i = 0; i < s->nb_streams; i++) {
213         stream = s->streams[i];
214         if     (stream->codec->codec_type == CODEC_TYPE_AUDIO) astream = stream;
215         else if(stream->codec->codec_type == CODEC_TYPE_VIDEO) vstream = stream;
216     }
217
218     //parse the second object (we want a mixed array)
219     if(amf_parse_object(s, astream, vstream, buffer, next_pos, 0) < 0)
220         return -1;
221
222     return 0;
223 }
224
225 static int flv_read_header(AVFormatContext *s,
226                            AVFormatParameters *ap)
227 {
228     int offset, flags;
229     AVStream *st;
230
231     url_fskip(&s->pb, 4);
232     flags = get_byte(&s->pb);
233
234     if(flags & FLV_HEADER_FLAG_HASVIDEO){
235         st = av_new_stream(s, 0);
236         if (!st)
237             return AVERROR_NOMEM;
238         st->codec->codec_type = CODEC_TYPE_VIDEO;
239         av_set_pts_info(st, 24, 1, 1000); /* 24 bit pts in ms */
240     }
241     if(flags & FLV_HEADER_FLAG_HASAUDIO){
242         st = av_new_stream(s, 1);
243         if (!st)
244             return AVERROR_NOMEM;
245         st->codec->codec_type = CODEC_TYPE_AUDIO;
246         av_set_pts_info(st, 24, 1, 1000); /* 24 bit pts in ms */
247     }
248
249     offset = get_be32(&s->pb);
250     url_fseek(&s->pb, offset, SEEK_SET);
251
252     s->start_time = 0;
253
254     return 0;
255 }
256
257 static int flv_read_packet(AVFormatContext *s, AVPacket *pkt)
258 {
259     int ret, i, type, size, pts, flags, is_audio, next, pos;
260     AVStream *st = NULL;
261
262  for(;;){
263     pos = url_ftell(&s->pb);
264     url_fskip(&s->pb, 4); /* size of previous packet */
265     type = get_byte(&s->pb);
266     size = get_be24(&s->pb);
267     pts = get_be24(&s->pb);
268 //    av_log(s, AV_LOG_DEBUG, "type:%d, size:%d, pts:%d\n", type, size, pts);
269     if (url_feof(&s->pb))
270         return AVERROR_IO;
271     url_fskip(&s->pb, 4); /* reserved */
272     flags = 0;
273
274     if(size == 0)
275         continue;
276
277     next= size + url_ftell(&s->pb);
278
279     if (type == FLV_TAG_TYPE_AUDIO) {
280         is_audio=1;
281         flags = get_byte(&s->pb);
282     } else if (type == FLV_TAG_TYPE_VIDEO) {
283         is_audio=0;
284         flags = get_byte(&s->pb);
285     } else {
286         if (type == FLV_TAG_TYPE_META && size > 13+1+4)
287             flv_read_metabody(s, next);
288         else /* skip packet */
289             av_log(s, AV_LOG_ERROR, "skipping flv packet: type %d, size %d, flags %d\n", type, size, flags);
290         url_fseek(&s->pb, next, SEEK_SET);
291         continue;
292     }
293
294     /* now find stream */
295     for(i=0;i<s->nb_streams;i++) {
296         st = s->streams[i];
297         if (st->id == is_audio)
298             break;
299     }
300     if(i == s->nb_streams){
301         av_log(NULL, AV_LOG_ERROR, "invalid stream\n");
302         url_fseek(&s->pb, next, SEEK_SET);
303         continue;
304     }
305 //    av_log(NULL, AV_LOG_DEBUG, "%d %X %d \n", is_audio, flags, st->discard);
306     if(  (st->discard >= AVDISCARD_NONKEY && !((flags & FLV_VIDEO_FRAMETYPE_MASK) == FLV_FRAME_KEY ||         is_audio))
307        ||(st->discard >= AVDISCARD_BIDIR  &&  ((flags & FLV_VIDEO_FRAMETYPE_MASK) == FLV_FRAME_DISP_INTER && !is_audio))
308        || st->discard >= AVDISCARD_ALL
309        ){
310         url_fseek(&s->pb, next, SEEK_SET);
311         continue;
312     }
313     if ((flags & FLV_VIDEO_FRAMETYPE_MASK) == FLV_FRAME_KEY)
314         av_add_index_entry(st, pos, pts, size, 0, AVINDEX_KEYFRAME);
315     break;
316  }
317
318     // if not streamed and no duration from metadata then seek to end to find the duration from the timestamps
319     if(!url_is_streamed(&s->pb) && s->duration==AV_NOPTS_VALUE){
320         int size;
321         const int pos= url_ftell(&s->pb);
322         const int fsize= url_fsize(&s->pb);
323         url_fseek(&s->pb, fsize-4, SEEK_SET);
324         size= get_be32(&s->pb);
325         url_fseek(&s->pb, fsize-3-size, SEEK_SET);
326         if(size == get_be24(&s->pb) + 11){
327             s->duration= get_be24(&s->pb) * (int64_t)AV_TIME_BASE / 1000;
328         }
329         url_fseek(&s->pb, pos, SEEK_SET);
330     }
331
332     if(is_audio){
333         if(!st->codec->sample_rate || !st->codec->bits_per_sample || (!st->codec->codec_id && !st->codec->codec_tag)) {
334             st->codec->channels = (flags & FLV_AUDIO_CHANNEL_MASK) == FLV_STEREO ? 2 : 1;
335             if((flags & FLV_AUDIO_CODECID_MASK) == FLV_CODECID_NELLYMOSER_8HZ_MONO)
336                 st->codec->sample_rate= 8000;
337             else
338                 st->codec->sample_rate = (44100 << ((flags & FLV_AUDIO_SAMPLERATE_MASK) >> FLV_AUDIO_SAMPLERATE_OFFSET) >> 3);
339             st->codec->bits_per_sample = (flags & FLV_AUDIO_SAMPLESIZE_MASK) ? 16 : 8;
340             flv_set_audio_codec(s, st, flags & FLV_AUDIO_CODECID_MASK);
341         }
342     }else{
343         size -= flv_set_video_codec(s, st, flags & FLV_VIDEO_CODECID_MASK);
344     }
345
346     ret= av_get_packet(&s->pb, pkt, size - 1);
347     if (ret <= 0) {
348         return AVERROR_IO;
349     }
350     /* note: we need to modify the packet size here to handle the last
351        packet */
352     pkt->size = ret;
353     pkt->pts = pts;
354     pkt->stream_index = st->index;
355
356     if (is_audio || ((flags & FLV_VIDEO_FRAMETYPE_MASK) == FLV_FRAME_KEY))
357         pkt->flags |= PKT_FLAG_KEY;
358
359     return ret;
360 }
361
362 static int flv_read_close(AVFormatContext *s)
363 {
364     return 0;
365 }
366
367 static int flv_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
368 {
369     AVStream *st = s->streams[stream_index];
370     int index = av_index_search_timestamp(st, timestamp, flags);
371     if (index < 0)
372         return -1;
373     url_fseek(&s->pb, st->index_entries[index].pos, SEEK_SET);
374
375     return 0;
376 }
377
378 AVInputFormat flv_demuxer = {
379     "flv",
380     "flv format",
381     0,
382     flv_probe,
383     flv_read_header,
384     flv_read_packet,
385     flv_read_close,
386     flv_read_seek,
387     .extensions = "flv",
388     .value = CODEC_ID_FLV1,
389 };