3 * Copyright (c) 2000 Fabrice Bellard
5 * This file is part of FFmpeg.
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.
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.
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
27 #include "avio_internal.h"
29 #include "libavformat/avlanguage.h"
30 #include "libavutil/avstring.h"
31 #include "libavutil/intreadwrite.h"
32 #include "libavutil/dict.h"
33 #include "libavutil/avassert.h"
34 #include "libavutil/timestamp.h"
38 * - fill all fields if non streamed (nb_frames for example)
41 typedef struct AVIIentry {
42 unsigned int flags, pos, len;
45 #define AVI_INDEX_CLUSTER_SIZE 16384
47 typedef struct AVIIndex {
55 int64_t riff_start, movi_list, odml_list;
56 int64_t frames_hdr_all;
61 int64_t frames_hdr_strm;
62 int64_t audio_strm_length;
69 static inline AVIIentry* avi_get_ientry(AVIIndex* idx, int ent_id)
71 int cl = ent_id / AVI_INDEX_CLUSTER_SIZE;
72 int id = ent_id % AVI_INDEX_CLUSTER_SIZE;
73 return &idx->cluster[cl][id];
76 static int64_t avi_start_new_riff(AVFormatContext *s, AVIOContext *pb,
77 const char* riff_tag, const char* list_tag)
79 AVIContext *avi= s->priv_data;
84 for (i=0; i<s->nb_streams; i++){
85 AVIStream *avist= s->streams[i]->priv_data;
86 avist->indexes.entry = 0;
89 avi->riff_start = ff_start_tag(pb, "RIFF");
90 ffio_wfourcc(pb, riff_tag);
91 loff = ff_start_tag(pb, "LIST");
92 ffio_wfourcc(pb, list_tag);
96 static char* avi_stream2fourcc(char* tag, int index, enum AVMediaType type)
98 tag[0] = '0' + index/10;
99 tag[1] = '0' + index%10;
100 if (type == AVMEDIA_TYPE_VIDEO) {
103 } else if (type == AVMEDIA_TYPE_SUBTITLE) {
104 // note: this is not an official code
115 static int avi_write_counters(AVFormatContext* s, int riff_id)
117 AVIOContext *pb = s->pb;
118 AVIContext *avi = s->priv_data;
119 int n, au_byterate, au_ssize, au_scale, nb_frames = 0;
121 AVCodecContext* stream;
123 file_size = avio_tell(pb);
124 for(n = 0; n < s->nb_streams; n++) {
125 AVIStream *avist= s->streams[n]->priv_data;
127 av_assert0(avist->frames_hdr_strm);
128 stream = s->streams[n]->codec;
129 avio_seek(pb, avist->frames_hdr_strm, SEEK_SET);
130 ff_parse_specific_params(stream, &au_byterate, &au_ssize, &au_scale);
132 avio_wl32(pb, avist->packet_count);
134 avio_wl32(pb, avist->audio_strm_length / au_ssize);
136 if(stream->codec_type == AVMEDIA_TYPE_VIDEO)
137 nb_frames = FFMAX(nb_frames, avist->packet_count);
140 av_assert0(avi->frames_hdr_all);
141 avio_seek(pb, avi->frames_hdr_all, SEEK_SET);
142 avio_wl32(pb, nb_frames);
144 avio_seek(pb, file_size, SEEK_SET);
149 static int avi_write_header(AVFormatContext *s)
151 AVIContext *avi = s->priv_data;
152 AVIOContext *pb = s->pb;
153 int bitrate, n, i, nb_frames, au_byterate, au_ssize, au_scale;
154 AVCodecContext *stream, *video_enc;
155 int64_t list1, list2, strh, strf;
156 AVDictionaryEntry *t = NULL;
159 if (s->nb_streams > AVI_MAX_STREAM_COUNT) {
160 av_log(s, AV_LOG_ERROR, "AVI does not support >%d streams\n",
161 AVI_MAX_STREAM_COUNT);
162 return AVERROR(EINVAL);
165 for(n=0;n<s->nb_streams;n++) {
166 s->streams[n]->priv_data= av_mallocz(sizeof(AVIStream));
167 if(!s->streams[n]->priv_data)
168 return AVERROR(ENOMEM);
173 list1 = avi_start_new_riff(s, pb, "AVI ", "hdrl");
176 ffio_wfourcc(pb, "avih");
177 avio_wl32(pb, 14 * 4);
181 for(n=0;n<s->nb_streams;n++) {
182 stream = s->streams[n]->codec;
183 bitrate += stream->bit_rate;
184 if (stream->codec_type == AVMEDIA_TYPE_VIDEO)
191 avio_wl32(pb, (uint32_t)(INT64_C(1000000) * video_enc->time_base.num / video_enc->time_base.den));
195 avio_wl32(pb, bitrate / 8); /* XXX: not quite exact */
196 avio_wl32(pb, 0); /* padding */
198 avio_wl32(pb, AVIF_TRUSTCKTYPE | AVIF_ISINTERLEAVED); /* flags */
200 avio_wl32(pb, AVIF_TRUSTCKTYPE | AVIF_HASINDEX | AVIF_ISINTERLEAVED); /* flags */
201 avi->frames_hdr_all = avio_tell(pb); /* remember this offset to fill later */
202 avio_wl32(pb, nb_frames); /* nb frames, filled later */
203 avio_wl32(pb, 0); /* initial frame */
204 avio_wl32(pb, s->nb_streams); /* nb streams */
205 avio_wl32(pb, 1024 * 1024); /* suggested buffer size */
207 avio_wl32(pb, video_enc->width);
208 avio_wl32(pb, video_enc->height);
213 avio_wl32(pb, 0); /* reserved */
214 avio_wl32(pb, 0); /* reserved */
215 avio_wl32(pb, 0); /* reserved */
216 avio_wl32(pb, 0); /* reserved */
220 AVIStream *avist= s->streams[i]->priv_data;
221 list2 = ff_start_tag(pb, "LIST");
222 ffio_wfourcc(pb, "strl");
224 stream = s->streams[i]->codec;
226 /* stream generic header */
227 strh = ff_start_tag(pb, "strh");
228 switch(stream->codec_type) {
229 case AVMEDIA_TYPE_SUBTITLE:
230 // XSUB subtitles behave like video tracks, other subtitles
231 // are not (yet) supported.
232 if (stream->codec_id != AV_CODEC_ID_XSUB) {
233 av_log(s, AV_LOG_ERROR, "Subtitle streams other than DivX XSUB are not supported by the AVI muxer.\n");
234 return AVERROR_PATCHWELCOME;
236 case AVMEDIA_TYPE_VIDEO: ffio_wfourcc(pb, "vids"); break;
237 case AVMEDIA_TYPE_AUDIO: ffio_wfourcc(pb, "auds"); break;
238 // case AVMEDIA_TYPE_TEXT : ffio_wfourcc(pb, "txts"); break;
239 case AVMEDIA_TYPE_DATA : ffio_wfourcc(pb, "dats"); break;
241 if(stream->codec_type == AVMEDIA_TYPE_VIDEO ||
242 stream->codec_id == AV_CODEC_ID_XSUB)
243 avio_wl32(pb, stream->codec_tag);
246 avio_wl32(pb, 0); /* flags */
247 avio_wl16(pb, 0); /* priority */
248 avio_wl16(pb, 0); /* language */
249 avio_wl32(pb, 0); /* initial frame */
251 ff_parse_specific_params(stream, &au_byterate, &au_ssize, &au_scale);
253 if ( stream->codec_type == AVMEDIA_TYPE_VIDEO
254 && stream->codec_id != AV_CODEC_ID_XSUB
255 && au_byterate > 1000LL*au_scale) {
259 avpriv_set_pts_info(s->streams[i], 64, au_scale, au_byterate);
260 if(stream->codec_id == AV_CODEC_ID_XSUB)
261 au_scale = au_byterate = 0;
263 avio_wl32(pb, au_scale); /* scale */
264 avio_wl32(pb, au_byterate); /* rate */
266 avio_wl32(pb, 0); /* start */
267 avist->frames_hdr_strm = avio_tell(pb); /* remember this offset to fill later */
269 avio_wl32(pb, AVI_MAX_RIFF_SIZE); /* FIXME: this may be broken, but who cares */
271 avio_wl32(pb, 0); /* length, XXX: filled later */
273 /* suggested buffer size */ //FIXME set at the end to largest chunk
274 if(stream->codec_type == AVMEDIA_TYPE_VIDEO)
275 avio_wl32(pb, 1024 * 1024);
276 else if(stream->codec_type == AVMEDIA_TYPE_AUDIO)
277 avio_wl32(pb, 12 * 1024);
280 avio_wl32(pb, -1); /* quality */
281 avio_wl32(pb, au_ssize); /* sample size */
283 avio_wl16(pb, stream->width);
284 avio_wl16(pb, stream->height);
285 ff_end_tag(pb, strh);
287 if(stream->codec_type != AVMEDIA_TYPE_DATA){
290 strf = ff_start_tag(pb, "strf");
291 switch(stream->codec_type) {
292 case AVMEDIA_TYPE_SUBTITLE:
293 // XSUB subtitles behave like video tracks, other subtitles
294 // are not (yet) supported.
295 if (stream->codec_id != AV_CODEC_ID_XSUB) break;
296 case AVMEDIA_TYPE_VIDEO:
297 ff_put_bmp_header(pb, stream, ff_codec_bmp_tags, 0, 0);
299 case AVMEDIA_TYPE_AUDIO:
300 if ((ret = ff_put_wav_header(pb, stream)) < 0) {
305 av_log(s, AV_LOG_ERROR,
306 "Invalid or not supported codec type '%s' found in the input\n",
307 (char *)av_x_if_null(av_get_media_type_string(stream->codec_type), "?"));
308 return AVERROR(EINVAL);
310 ff_end_tag(pb, strf);
311 if ((t = av_dict_get(s->streams[i]->metadata, "title", NULL, 0))) {
312 ff_riff_write_info_tag(s->pb, "strn", t->value);
315 if(stream->codec_id == AV_CODEC_ID_XSUB
316 && (t = av_dict_get(s->streams[i]->metadata, "language", NULL, 0))) {
317 const char* langstr = av_convert_lang_to(t->value, AV_LANG_ISO639_1);
320 char* str = av_asprintf("Subtitle - %s-xx;02", langstr);
321 ff_riff_write_info_tag(s->pb, "strn", str);
328 unsigned char tag[5];
331 /* Starting to lay out AVI OpenDML master index.
332 * We want to make it JUNK entry for now, since we'd
333 * like to get away without making AVI an OpenDML one
334 * for compatibility reasons.
336 avist->indexes.entry = avist->indexes.ents_allocated = 0;
337 avist->indexes.indx_start = ff_start_tag(pb, "JUNK");
338 avio_wl16(pb, 4); /* wLongsPerEntry */
339 avio_w8(pb, 0); /* bIndexSubType (0 == frame index) */
340 avio_w8(pb, 0); /* bIndexType (0 == AVI_INDEX_OF_INDEXES) */
341 avio_wl32(pb, 0); /* nEntriesInUse (will fill out later on) */
342 ffio_wfourcc(pb, avi_stream2fourcc(tag, i, stream->codec_type));
344 avio_wl64(pb, 0); /* dwReserved[3]
345 avio_wl32(pb, 0); Must be 0. */
346 for (j=0; j < AVI_MASTER_INDEX_SIZE * 2; j++)
348 ff_end_tag(pb, avist->indexes.indx_start);
351 if( stream->codec_type == AVMEDIA_TYPE_VIDEO
352 && s->streams[i]->sample_aspect_ratio.num>0
353 && s->streams[i]->sample_aspect_ratio.den>0){
354 int vprp= ff_start_tag(pb, "vprp");
355 AVRational dar = av_mul_q(s->streams[i]->sample_aspect_ratio,
356 (AVRational){stream->width, stream->height});
358 av_reduce(&num, &den, dar.num, dar.den, 0xFFFF);
360 avio_wl32(pb, 0); //video format = unknown
361 avio_wl32(pb, 0); //video standard= unknown
362 avio_wl32(pb, lrintf(1.0/av_q2d(stream->time_base)));
363 avio_wl32(pb, stream->width );
364 avio_wl32(pb, stream->height);
367 avio_wl32(pb, stream->width );
368 avio_wl32(pb, stream->height);
369 avio_wl32(pb, 1); //progressive FIXME
371 avio_wl32(pb, stream->height);
372 avio_wl32(pb, stream->width );
373 avio_wl32(pb, stream->height);
374 avio_wl32(pb, stream->width );
380 ff_end_tag(pb, vprp);
383 ff_end_tag(pb, list2);
387 /* AVI could become an OpenDML one, if it grows beyond 2Gb range */
388 avi->odml_list = ff_start_tag(pb, "JUNK");
389 ffio_wfourcc(pb, "odml");
390 ffio_wfourcc(pb, "dmlh");
392 for (i = 0; i < 248; i+= 4)
394 ff_end_tag(pb, avi->odml_list);
397 ff_end_tag(pb, list1);
399 ff_riff_write_info(s);
402 padding = s->metadata_header_padding;
406 /* some padding for easier tag editing */
408 list2 = ff_start_tag(pb, "JUNK");
409 for (i = padding; i > 0; i -= 4)
411 ff_end_tag(pb, list2);
414 avi->movi_list = ff_start_tag(pb, "LIST");
415 ffio_wfourcc(pb, "movi");
422 static int avi_write_ix(AVFormatContext *s)
424 AVIOContext *pb = s->pb;
425 AVIContext *avi = s->priv_data;
427 char ix_tag[] = "ix00";
430 av_assert0(pb->seekable);
432 if (avi->riff_id > AVI_MASTER_INDEX_SIZE) {
433 av_log(s, AV_LOG_ERROR, "Invalid riff index %d > %d\n",
434 avi->riff_id, AVI_MASTER_INDEX_SIZE);
435 return AVERROR(EINVAL);
438 for (i=0;i<s->nb_streams;i++) {
439 AVIStream *avist= s->streams[i]->priv_data;
442 avi_stream2fourcc(tag, i, s->streams[i]->codec->codec_type);
445 /* Writing AVI OpenDML leaf index chunk */
447 ffio_wfourcc(pb, ix_tag); /* ix?? */
448 avio_wl32(pb, avist->indexes.entry * 8 + 24);
450 avio_wl16(pb, 2); /* wLongsPerEntry */
451 avio_w8(pb, 0); /* bIndexSubType (0 == frame index) */
452 avio_w8(pb, 1); /* bIndexType (1 == AVI_INDEX_OF_CHUNKS) */
453 avio_wl32(pb, avist->indexes.entry);
455 ffio_wfourcc(pb, tag); /* dwChunkId */
456 avio_wl64(pb, avi->movi_list);/* qwBaseOffset */
457 avio_wl32(pb, 0); /* dwReserved_3 (must be 0) */
459 for (j=0; j<avist->indexes.entry; j++) {
460 AVIIentry* ie = avi_get_ientry(&avist->indexes, j);
461 avio_wl32(pb, ie->pos + 8);
462 avio_wl32(pb, ((uint32_t)ie->len & ~0x80000000) |
463 (ie->flags & 0x10 ? 0 : 0x80000000));
468 /* Updating one entry in the AVI OpenDML master index */
469 avio_seek(pb, avist->indexes.indx_start - 8, SEEK_SET);
470 ffio_wfourcc(pb, "indx"); /* enabling this entry */
472 avio_wl32(pb, avi->riff_id); /* nEntriesInUse */
473 avio_skip(pb, 16*avi->riff_id);
474 avio_wl64(pb, ix); /* qwOffset */
475 avio_wl32(pb, pos - ix); /* dwSize */
476 avio_wl32(pb, avist->indexes.entry); /* dwDuration */
478 avio_seek(pb, pos, SEEK_SET);
483 static int avi_write_idx1(AVFormatContext *s)
485 AVIOContext *pb = s->pb;
486 AVIContext *avi = s->priv_data;
493 AVIIentry* ie = 0, *tie;
494 int empty, stream_id = -1;
496 idx_chunk = ff_start_tag(pb, "idx1");
497 for(i=0; i<s->nb_streams; i++){
498 avist= s->streams[i]->priv_data;
504 for (i=0; i<s->nb_streams; i++) {
505 avist= s->streams[i]->priv_data;
506 if (avist->indexes.entry <= avist->entry)
509 tie = avi_get_ientry(&avist->indexes, avist->entry);
510 if (empty || tie->pos < ie->pos) {
517 avist= s->streams[stream_id]->priv_data;
518 avi_stream2fourcc(tag, stream_id,
519 s->streams[stream_id]->codec->codec_type);
520 ffio_wfourcc(pb, tag);
521 avio_wl32(pb, ie->flags);
522 avio_wl32(pb, ie->pos);
523 avio_wl32(pb, ie->len);
527 ff_end_tag(pb, idx_chunk);
529 avi_write_counters(s, avi->riff_id);
534 static int avi_write_packet(AVFormatContext *s, AVPacket *pkt)
536 AVIContext *avi = s->priv_data;
537 AVIOContext *pb = s->pb;
538 unsigned char tag[5];
539 unsigned int flags=0;
540 const int stream_index= pkt->stream_index;
541 AVIStream *avist= s->streams[stream_index]->priv_data;
542 AVCodecContext *enc= s->streams[stream_index]->codec;
545 av_dlog(s, "dts:%s packet_count:%d stream_index:%d\n", av_ts2str(pkt->dts), avist->packet_count, stream_index);
546 while(enc->block_align==0 && pkt->dts != AV_NOPTS_VALUE && pkt->dts > avist->packet_count && enc->codec_id != AV_CODEC_ID_XSUB && avist->packet_count){
547 AVPacket empty_packet;
549 if(pkt->dts - avist->packet_count > 60000){
550 av_log(s, AV_LOG_ERROR, "Too large number of skipped frames %"PRId64" > 60000\n", pkt->dts - avist->packet_count);
551 return AVERROR(EINVAL);
554 av_init_packet(&empty_packet);
555 empty_packet.size= 0;
556 empty_packet.data= NULL;
557 empty_packet.stream_index= stream_index;
558 avi_write_packet(s, &empty_packet);
559 av_dlog(s, "dup dts:%s packet_count:%d\n", av_ts2str(pkt->dts), avist->packet_count);
561 avist->packet_count++;
563 // Make sure to put an OpenDML chunk when the file size exceeds the limits
565 (avio_tell(pb) - avi->riff_start > AVI_MAX_RIFF_SIZE)) {
568 ff_end_tag(pb, avi->movi_list);
570 if (avi->riff_id == 1)
573 ff_end_tag(pb, avi->riff_start);
574 avi->movi_list = avi_start_new_riff(s, pb, "AVIX", "movi");
577 avi_stream2fourcc(tag, stream_index, enc->codec_type);
578 if(pkt->flags&AV_PKT_FLAG_KEY)
580 if (enc->codec_type == AVMEDIA_TYPE_AUDIO) {
581 avist->audio_strm_length += size;
584 if (s->pb->seekable) {
585 AVIIndex* idx = &avist->indexes;
586 int cl = idx->entry / AVI_INDEX_CLUSTER_SIZE;
587 int id = idx->entry % AVI_INDEX_CLUSTER_SIZE;
588 if (idx->ents_allocated <= idx->entry) {
589 idx->cluster = av_realloc_f(idx->cluster, sizeof(void*), cl+1);
591 idx->ents_allocated = 0;
593 return AVERROR(ENOMEM);
595 idx->cluster[cl] = av_malloc(AVI_INDEX_CLUSTER_SIZE*sizeof(AVIIentry));
596 if (!idx->cluster[cl])
597 return AVERROR(ENOMEM);
598 idx->ents_allocated += AVI_INDEX_CLUSTER_SIZE;
601 idx->cluster[cl][id].flags = flags;
602 idx->cluster[cl][id].pos = avio_tell(pb) - avi->movi_list;
603 idx->cluster[cl][id].len = size;
607 avio_write(pb, tag, 4);
609 avio_write(pb, pkt->data, size);
616 static int avi_write_trailer(AVFormatContext *s)
618 AVIContext *avi = s->priv_data;
619 AVIOContext *pb = s->pb;
621 int i, j, n, nb_frames;
625 if (avi->riff_id == 1) {
626 ff_end_tag(pb, avi->movi_list);
627 res = avi_write_idx1(s);
628 ff_end_tag(pb, avi->riff_start);
631 ff_end_tag(pb, avi->movi_list);
632 ff_end_tag(pb, avi->riff_start);
634 file_size = avio_tell(pb);
635 avio_seek(pb, avi->odml_list - 8, SEEK_SET);
636 ffio_wfourcc(pb, "LIST"); /* Making this AVI OpenDML one */
639 for (n=nb_frames=0;n<s->nb_streams;n++) {
640 AVCodecContext *stream = s->streams[n]->codec;
641 AVIStream *avist= s->streams[n]->priv_data;
643 if (stream->codec_type == AVMEDIA_TYPE_VIDEO) {
644 if (nb_frames < avist->packet_count)
645 nb_frames = avist->packet_count;
647 if (stream->codec_id == AV_CODEC_ID_MP2 || stream->codec_id == AV_CODEC_ID_MP3) {
648 nb_frames += avist->packet_count;
652 avio_wl32(pb, nb_frames);
653 avio_seek(pb, file_size, SEEK_SET);
655 avi_write_counters(s, avi->riff_id);
659 for (i=0; i<s->nb_streams; i++) {
660 AVIStream *avist= s->streams[i]->priv_data;
661 for (j=0; j<avist->indexes.ents_allocated/AVI_INDEX_CLUSTER_SIZE; j++)
662 av_freep(&avist->indexes.cluster[j]);
663 av_freep(&avist->indexes.cluster);
664 avist->indexes.ents_allocated = avist->indexes.entry = 0;
670 AVOutputFormat ff_avi_muxer = {
672 .long_name = NULL_IF_CONFIG_SMALL("AVI (Audio Video Interleaved)"),
673 .mime_type = "video/x-msvideo",
675 .priv_data_size = sizeof(AVIContext),
676 .audio_codec = CONFIG_LIBMP3LAME ? AV_CODEC_ID_MP3 : AV_CODEC_ID_AC3,
677 .video_codec = AV_CODEC_ID_MPEG4,
678 .write_header = avi_write_header,
679 .write_packet = avi_write_packet,
680 .write_trailer = avi_write_trailer,
681 .codec_tag = (const AVCodecTag* const []){
682 ff_codec_bmp_tags, ff_codec_wav_tags, 0