flvenc: Ignore metadata that has special values and is stored already based on
[ffmpeg.git] / libavformat / flvenc.c
1 /*
2  * FLV muxer
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 #include "libavutil/intreadwrite.h"
23 #include "libavutil/intfloat_readwrite.h"
24 #include "avformat.h"
25 #include "flv.h"
26 #include "internal.h"
27 #include "avc.h"
28 #include "metadata.h"
29 #include "libavutil/dict.h"
30
31 #undef NDEBUG
32 #include <assert.h>
33
34 static const AVCodecTag flv_video_codec_ids[] = {
35     {CODEC_ID_FLV1,    FLV_CODECID_H263  },
36     {CODEC_ID_H263,    FLV_CODECID_REALH263},
37     {CODEC_ID_MPEG4,   FLV_CODECID_MPEG4 },
38     {CODEC_ID_FLASHSV, FLV_CODECID_SCREEN},
39     {CODEC_ID_FLASHSV2, FLV_CODECID_SCREEN2},
40     {CODEC_ID_VP6F,    FLV_CODECID_VP6   },
41     {CODEC_ID_VP6,     FLV_CODECID_VP6   },
42     {CODEC_ID_H264,    FLV_CODECID_H264  },
43     {CODEC_ID_NONE,    0}
44 };
45
46 static const AVCodecTag flv_audio_codec_ids[] = {
47     {CODEC_ID_MP3,       FLV_CODECID_MP3    >> FLV_AUDIO_CODECID_OFFSET},
48     {CODEC_ID_PCM_U8,    FLV_CODECID_PCM    >> FLV_AUDIO_CODECID_OFFSET},
49     {CODEC_ID_PCM_S16BE, FLV_CODECID_PCM    >> FLV_AUDIO_CODECID_OFFSET},
50     {CODEC_ID_PCM_S16LE, FLV_CODECID_PCM_LE >> FLV_AUDIO_CODECID_OFFSET},
51     {CODEC_ID_ADPCM_SWF, FLV_CODECID_ADPCM  >> FLV_AUDIO_CODECID_OFFSET},
52     {CODEC_ID_AAC,       FLV_CODECID_AAC    >> FLV_AUDIO_CODECID_OFFSET},
53     {CODEC_ID_NELLYMOSER, FLV_CODECID_NELLYMOSER >> FLV_AUDIO_CODECID_OFFSET},
54     {CODEC_ID_SPEEX,     FLV_CODECID_SPEEX  >> FLV_AUDIO_CODECID_OFFSET},
55     {CODEC_ID_NONE,      0}
56 };
57
58 typedef struct FLVContext {
59     int reserved;
60     int64_t duration_offset;
61     int64_t filesize_offset;
62     int64_t duration;
63     int delay; ///< first dts delay for AVC
64     int64_t last_video_ts;
65 } FLVContext;
66
67 static int get_audio_flags(AVCodecContext *enc){
68     int flags = (enc->bits_per_coded_sample == 16) ? FLV_SAMPLESSIZE_16BIT : FLV_SAMPLESSIZE_8BIT;
69
70     if (enc->codec_id == CODEC_ID_AAC) // specs force these parameters
71         return FLV_CODECID_AAC | FLV_SAMPLERATE_44100HZ | FLV_SAMPLESSIZE_16BIT | FLV_STEREO;
72     else if (enc->codec_id == CODEC_ID_SPEEX) {
73         if (enc->sample_rate != 16000) {
74             av_log(enc, AV_LOG_ERROR, "flv only supports wideband (16kHz) Speex audio\n");
75             return -1;
76         }
77         if (enc->channels != 1) {
78             av_log(enc, AV_LOG_ERROR, "flv only supports mono Speex audio\n");
79             return -1;
80         }
81         if (enc->frame_size / 320 > 8) {
82             av_log(enc, AV_LOG_WARNING, "Warning: Speex stream has more than "
83                                         "8 frames per packet. Adobe Flash "
84                                         "Player cannot handle this!\n");
85         }
86         return FLV_CODECID_SPEEX | FLV_SAMPLERATE_11025HZ | FLV_SAMPLESSIZE_16BIT;
87     } else {
88     switch (enc->sample_rate) {
89         case    44100:
90             flags |= FLV_SAMPLERATE_44100HZ;
91             break;
92         case    22050:
93             flags |= FLV_SAMPLERATE_22050HZ;
94             break;
95         case    11025:
96             flags |= FLV_SAMPLERATE_11025HZ;
97             break;
98         case     8000: //nellymoser only
99         case     5512: //not mp3
100             if(enc->codec_id != CODEC_ID_MP3){
101                 flags |= FLV_SAMPLERATE_SPECIAL;
102                 break;
103             }
104         default:
105             av_log(enc, AV_LOG_ERROR, "flv does not support that sample rate, choose from (44100, 22050, 11025).\n");
106             return -1;
107     }
108     }
109
110     if (enc->channels > 1) {
111         flags |= FLV_STEREO;
112     }
113
114     switch(enc->codec_id){
115     case CODEC_ID_MP3:
116         flags |= FLV_CODECID_MP3    | FLV_SAMPLESSIZE_16BIT;
117         break;
118     case CODEC_ID_PCM_U8:
119         flags |= FLV_CODECID_PCM    | FLV_SAMPLESSIZE_8BIT;
120         break;
121     case CODEC_ID_PCM_S16BE:
122         flags |= FLV_CODECID_PCM    | FLV_SAMPLESSIZE_16BIT;
123         break;
124     case CODEC_ID_PCM_S16LE:
125         flags |= FLV_CODECID_PCM_LE | FLV_SAMPLESSIZE_16BIT;
126         break;
127     case CODEC_ID_ADPCM_SWF:
128         flags |= FLV_CODECID_ADPCM | FLV_SAMPLESSIZE_16BIT;
129         break;
130     case CODEC_ID_NELLYMOSER:
131         if (enc->sample_rate == 8000) {
132             flags |= FLV_CODECID_NELLYMOSER_8KHZ_MONO | FLV_SAMPLESSIZE_16BIT;
133         } else {
134             flags |= FLV_CODECID_NELLYMOSER | FLV_SAMPLESSIZE_16BIT;
135         }
136         break;
137     case 0:
138         flags |= enc->codec_tag<<4;
139         break;
140     default:
141         av_log(enc, AV_LOG_ERROR, "codec not compatible with flv\n");
142         return -1;
143     }
144
145     return flags;
146 }
147
148 static void put_amf_string(AVIOContext *pb, const char *str)
149 {
150     size_t len = strlen(str);
151     avio_wb16(pb, len);
152     avio_write(pb, str, len);
153 }
154
155 static void put_avc_eos_tag(AVIOContext *pb, unsigned ts) {
156     avio_w8(pb, FLV_TAG_TYPE_VIDEO);
157     avio_wb24(pb, 5);  /* Tag Data Size */
158     avio_wb24(pb, ts);  /* lower 24 bits of timestamp in ms*/
159     avio_w8(pb, (ts >> 24) & 0x7F);  /* MSB of ts in ms*/
160     avio_wb24(pb, 0);  /* StreamId = 0 */
161     avio_w8(pb, 23);  /* ub[4] FrameType = 1, ub[4] CodecId = 7 */
162     avio_w8(pb, 2);  /* AVC end of sequence */
163     avio_wb24(pb, 0);  /* Always 0 for AVC EOS. */
164     avio_wb32(pb, 16);  /* Size of FLV tag */
165 }
166
167 static void put_amf_double(AVIOContext *pb, double d)
168 {
169     avio_w8(pb, AMF_DATA_TYPE_NUMBER);
170     avio_wb64(pb, av_dbl2int(d));
171 }
172
173 static void put_amf_bool(AVIOContext *pb, int b) {
174     avio_w8(pb, AMF_DATA_TYPE_BOOL);
175     avio_w8(pb, !!b);
176 }
177
178 static int flv_write_header(AVFormatContext *s)
179 {
180     AVIOContext *pb = s->pb;
181     FLVContext *flv = s->priv_data;
182     AVCodecContext *audio_enc = NULL, *video_enc = NULL;
183     int i;
184     double framerate = 0.0;
185     int64_t metadata_size_pos, data_size;
186     AVDictionaryEntry *tag = NULL;
187
188     for(i=0; i<s->nb_streams; i++){
189         AVCodecContext *enc = s->streams[i]->codec;
190         if (enc->codec_type == AVMEDIA_TYPE_VIDEO) {
191             if (s->streams[i]->r_frame_rate.den && s->streams[i]->r_frame_rate.num) {
192                 framerate = av_q2d(s->streams[i]->r_frame_rate);
193             } else {
194                 framerate = 1/av_q2d(s->streams[i]->codec->time_base);
195             }
196             video_enc = enc;
197             if(enc->codec_tag == 0) {
198                 av_log(enc, AV_LOG_ERROR, "video codec not compatible with flv\n");
199                 return -1;
200             }
201         } else if (enc->codec_type == AVMEDIA_TYPE_AUDIO) {
202             audio_enc = enc;
203             if(get_audio_flags(enc)<0)
204                 return -1;
205         }
206         av_set_pts_info(s->streams[i], 32, 1, 1000); /* 32 bit pts in ms */
207     }
208     avio_write(pb, "FLV", 3);
209     avio_w8(pb,1);
210     avio_w8(pb,   FLV_HEADER_FLAG_HASAUDIO * !!audio_enc
211                  + FLV_HEADER_FLAG_HASVIDEO * !!video_enc);
212     avio_wb32(pb,9);
213     avio_wb32(pb,0);
214
215     for(i=0; i<s->nb_streams; i++){
216         if(s->streams[i]->codec->codec_tag == 5){
217             avio_w8(pb,8); // message type
218             avio_wb24(pb,0); // include flags
219             avio_wb24(pb,0); // time stamp
220             avio_wb32(pb,0); // reserved
221             avio_wb32(pb,11); // size
222             flv->reserved=5;
223         }
224     }
225
226     flv->last_video_ts = -1;
227
228     /* write meta_tag */
229     avio_w8(pb, 18);         // tag type META
230     metadata_size_pos= avio_tell(pb);
231     avio_wb24(pb, 0);          // size of data part (sum of all parts below)
232     avio_wb24(pb, 0);          // time stamp
233     avio_wb32(pb, 0);          // reserved
234
235     /* now data of data_size size */
236
237     /* first event name as a string */
238     avio_w8(pb, AMF_DATA_TYPE_STRING);
239     put_amf_string(pb, "onMetaData"); // 12 bytes
240
241     /* mixed array (hash) with size and string/type/data tuples */
242     avio_w8(pb, AMF_DATA_TYPE_MIXEDARRAY);
243     avio_wb32(pb, 5*!!video_enc + 5*!!audio_enc + 2); // +2 for duration and file size
244
245     put_amf_string(pb, "duration");
246     flv->duration_offset= avio_tell(pb);
247     put_amf_double(pb, s->duration / AV_TIME_BASE); // fill in the guessed duration, it'll be corrected later if incorrect
248
249     if(video_enc){
250         put_amf_string(pb, "width");
251         put_amf_double(pb, video_enc->width);
252
253         put_amf_string(pb, "height");
254         put_amf_double(pb, video_enc->height);
255
256         put_amf_string(pb, "videodatarate");
257         put_amf_double(pb, video_enc->bit_rate / 1024.0);
258
259         put_amf_string(pb, "framerate");
260         put_amf_double(pb, framerate);
261
262         put_amf_string(pb, "videocodecid");
263         put_amf_double(pb, video_enc->codec_tag);
264     }
265
266     if(audio_enc){
267         put_amf_string(pb, "audiodatarate");
268         put_amf_double(pb, audio_enc->bit_rate / 1024.0);
269
270         put_amf_string(pb, "audiosamplerate");
271         put_amf_double(pb, audio_enc->sample_rate);
272
273         put_amf_string(pb, "audiosamplesize");
274         put_amf_double(pb, audio_enc->codec_id == CODEC_ID_PCM_U8 ? 8 : 16);
275
276         put_amf_string(pb, "stereo");
277         put_amf_bool(pb, audio_enc->channels == 2);
278
279         put_amf_string(pb, "audiocodecid");
280         put_amf_double(pb, audio_enc->codec_tag);
281     }
282
283     while ((tag = av_dict_get(s->metadata, "", tag, AV_DICT_IGNORE_SUFFIX))) {
284         if(   !strcmp(tag->key, "width")
285             ||!strcmp(tag->key, "height")
286             ||!strcmp(tag->key, "videodatarate")
287             ||!strcmp(tag->key, "framerate")
288             ||!strcmp(tag->key, "videocodecid")
289             ||!strcmp(tag->key, "audiodatarate")
290             ||!strcmp(tag->key, "audiosamplerate")
291             ||!strcmp(tag->key, "audiosamplesize")
292             ||!strcmp(tag->key, "stereo")
293             ||!strcmp(tag->key, "audiocodecid")
294             ||!strcmp(tag->key, "duration")
295             ||!strcmp(tag->key, "onMetaData")
296         ){
297             av_log(s, AV_LOG_DEBUG, "ignoring metadata for %s\n", tag->key);
298             continue;
299         }
300         put_amf_string(pb, tag->key);
301         avio_w8(pb, AMF_DATA_TYPE_STRING);
302         put_amf_string(pb, tag->value);
303     }
304
305     put_amf_string(pb, "filesize");
306     flv->filesize_offset= avio_tell(pb);
307     put_amf_double(pb, 0); // delayed write
308
309     put_amf_string(pb, "");
310     avio_w8(pb, AMF_END_OF_OBJECT);
311
312     /* write total size of tag */
313     data_size= avio_tell(pb) - metadata_size_pos - 10;
314     avio_seek(pb, metadata_size_pos, SEEK_SET);
315     avio_wb24(pb, data_size);
316     avio_skip(pb, data_size + 10 - 3);
317     avio_wb32(pb, data_size + 11);
318
319     for (i = 0; i < s->nb_streams; i++) {
320         AVCodecContext *enc = s->streams[i]->codec;
321         if (enc->codec_id == CODEC_ID_AAC || enc->codec_id == CODEC_ID_H264 || enc->codec_id == CODEC_ID_MPEG4) {
322             int64_t pos;
323             avio_w8(pb, enc->codec_type == AVMEDIA_TYPE_VIDEO ?
324                      FLV_TAG_TYPE_VIDEO : FLV_TAG_TYPE_AUDIO);
325             avio_wb24(pb, 0); // size patched later
326             avio_wb24(pb, 0); // ts
327             avio_w8(pb, 0); // ts ext
328             avio_wb24(pb, 0); // streamid
329             pos = avio_tell(pb);
330             if (enc->codec_id == CODEC_ID_AAC) {
331                 avio_w8(pb, get_audio_flags(enc));
332                 avio_w8(pb, 0); // AAC sequence header
333                 avio_write(pb, enc->extradata, enc->extradata_size);
334             } else {
335                 avio_w8(pb, enc->codec_tag | FLV_FRAME_KEY); // flags
336                 avio_w8(pb, 0); // AVC sequence header
337                 avio_wb24(pb, 0); // composition time
338                 ff_isom_write_avcc(pb, enc->extradata, enc->extradata_size);
339             }
340             data_size = avio_tell(pb) - pos;
341             avio_seek(pb, -data_size - 10, SEEK_CUR);
342             avio_wb24(pb, data_size);
343             avio_skip(pb, data_size + 10 - 3);
344             avio_wb32(pb, data_size + 11); // previous tag size
345         }
346     }
347
348     return 0;
349 }
350
351 static int flv_write_trailer(AVFormatContext *s)
352 {
353     int64_t file_size;
354
355     AVIOContext *pb = s->pb;
356     FLVContext *flv = s->priv_data;
357     int i;
358
359     /* Add EOS tag */
360     for (i = 0; i < s->nb_streams; i++) {
361         AVCodecContext *enc = s->streams[i]->codec;
362         if (enc->codec_type == AVMEDIA_TYPE_VIDEO &&
363                 (enc->codec_id == CODEC_ID_H264 || enc->codec_id == CODEC_ID_MPEG4)) {
364             put_avc_eos_tag(pb, flv->last_video_ts);
365         }
366     }
367
368     file_size = avio_tell(pb);
369
370     /* update informations */
371     avio_seek(pb, flv->duration_offset, SEEK_SET);
372     put_amf_double(pb, flv->duration / (double)1000);
373     avio_seek(pb, flv->filesize_offset, SEEK_SET);
374     put_amf_double(pb, file_size);
375
376     avio_seek(pb, file_size, SEEK_SET);
377     return 0;
378 }
379
380 static int flv_write_packet(AVFormatContext *s, AVPacket *pkt)
381 {
382     AVIOContext *pb = s->pb;
383     AVCodecContext *enc = s->streams[pkt->stream_index]->codec;
384     FLVContext *flv = s->priv_data;
385     unsigned ts;
386     int size= pkt->size;
387     uint8_t *data= NULL;
388     int flags, flags_size;
389
390 //    av_log(s, AV_LOG_DEBUG, "type:%d pts: %"PRId64" size:%d\n", enc->codec_type, timestamp, size);
391
392     if(enc->codec_id == CODEC_ID_VP6 || enc->codec_id == CODEC_ID_VP6F ||
393        enc->codec_id == CODEC_ID_AAC)
394         flags_size= 2;
395     else if(enc->codec_id == CODEC_ID_H264 || enc->codec_id == CODEC_ID_MPEG4)
396         flags_size= 5;
397     else
398         flags_size= 1;
399
400     if (enc->codec_type == AVMEDIA_TYPE_VIDEO) {
401         avio_w8(pb, FLV_TAG_TYPE_VIDEO);
402
403         flags = enc->codec_tag;
404         if(flags == 0) {
405             av_log(enc, AV_LOG_ERROR, "video codec %s not compatible with flv\n", avcodec_get_name(enc->codec_id));
406             return -1;
407         }
408
409         flags |= pkt->flags & AV_PKT_FLAG_KEY ? FLV_FRAME_KEY : FLV_FRAME_INTER;
410     } else if (enc->codec_type == AVMEDIA_TYPE_AUDIO) {
411         flags = get_audio_flags(enc);
412
413         assert(size);
414
415         avio_w8(pb, FLV_TAG_TYPE_AUDIO);
416     } else {
417         // In-band flv metadata ("scriptdata")
418         assert(enc->codec_type == AVMEDIA_TYPE_DATA);
419         avio_w8(pb, FLV_TAG_TYPE_META);
420         flags_size = 0;
421         flags = NULL;
422     }
423
424     if (enc->codec_id == CODEC_ID_H264 || enc->codec_id == CODEC_ID_MPEG4) {
425         /* check if extradata looks like mp4 formated */
426         if (enc->extradata_size > 0 && *(uint8_t*)enc->extradata != 1) {
427             if (ff_avc_parse_nal_units_buf(pkt->data, &data, &size) < 0)
428                 return -1;
429         }
430         if (!flv->delay && pkt->dts < 0)
431             flv->delay = -pkt->dts;
432     } else if (enc->codec_id == CODEC_ID_AAC && pkt->size > 2 &&
433                (AV_RB16(pkt->data) & 0xfff0) == 0xfff0) {
434         av_log(s, AV_LOG_ERROR, "malformated aac bitstream, use -absf aac_adtstoasc\n");
435         return -1;
436     }
437
438     ts = pkt->dts + flv->delay; // add delay to force positive dts
439     if (enc->codec_type == AVMEDIA_TYPE_VIDEO) {
440         if (flv->last_video_ts < ts)
441             flv->last_video_ts = ts;
442     }
443     avio_wb24(pb,size + flags_size);
444     avio_wb24(pb,ts);
445     avio_w8(pb,(ts >> 24) & 0x7F); // timestamps are 32bits _signed_
446     avio_wb24(pb,flv->reserved);
447
448     if(flags_size)
449         avio_w8(pb,flags);
450
451     if (enc->codec_id == CODEC_ID_VP6)
452         avio_w8(pb,0);
453     if (enc->codec_id == CODEC_ID_VP6F)
454         avio_w8(pb, enc->extradata_size ? enc->extradata[0] : 0);
455     else if (enc->codec_id == CODEC_ID_AAC)
456         avio_w8(pb,1); // AAC raw
457     else if (enc->codec_id == CODEC_ID_H264 || enc->codec_id == CODEC_ID_MPEG4) {
458         avio_w8(pb,1); // AVC NALU
459         avio_wb24(pb,pkt->pts - pkt->dts);
460     }
461
462     avio_write(pb, data ? data : pkt->data, size);
463
464     avio_wb32(pb,size+flags_size+11); // previous tag size
465     flv->duration = FFMAX(flv->duration, pkt->pts + flv->delay + pkt->duration);
466
467     avio_flush(pb);
468
469     av_free(data);
470
471     return pb->error;
472 }
473
474 AVOutputFormat ff_flv_muxer = {
475     .name           = "flv",
476     .long_name      = NULL_IF_CONFIG_SMALL("FLV format"),
477     .mime_type      = "video/x-flv",
478     .extensions     = "flv",
479     .priv_data_size = sizeof(FLVContext),
480 #if CONFIG_LIBMP3LAME
481     .audio_codec    = CODEC_ID_MP3,
482 #else // CONFIG_LIBMP3LAME
483     .audio_codec    = CODEC_ID_ADPCM_SWF,
484 #endif // CONFIG_LIBMP3LAME
485     .video_codec    = CODEC_ID_FLV1,
486     .write_header   = flv_write_header,
487     .write_packet   = flv_write_packet,
488     .write_trailer  = flv_write_trailer,
489     .codec_tag= (const AVCodecTag* const []){flv_video_codec_ids, flv_audio_codec_ids, 0},
490     .flags= AVFMT_GLOBALHEADER | AVFMT_VARIABLE_FPS,
491 };