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