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"
35 #include "libavutil/pixdesc.h"
36 #include "libavcodec/raw.h"
40 * - fill all fields if non streamed (nb_frames for example)
43 typedef struct AVIIentry {
44 unsigned int flags, pos, len;
47 #define AVI_INDEX_CLUSTER_SIZE 16384
49 typedef struct AVIIndex {
57 int64_t riff_start, movi_list, odml_list;
58 int64_t frames_hdr_all;
63 int64_t frames_hdr_strm;
64 int64_t audio_strm_length;
71 static inline AVIIentry *avi_get_ientry(AVIIndex *idx, int ent_id)
73 int cl = ent_id / AVI_INDEX_CLUSTER_SIZE;
74 int id = ent_id % AVI_INDEX_CLUSTER_SIZE;
75 return &idx->cluster[cl][id];
78 static int64_t avi_start_new_riff(AVFormatContext *s, AVIOContext *pb,
79 const char *riff_tag, const char *list_tag)
81 AVIContext *avi = s->priv_data;
86 for (i = 0; i < s->nb_streams; i++) {
87 AVIStream *avist = s->streams[i]->priv_data;
88 avist->indexes.entry = 0;
91 avi->riff_start = ff_start_tag(pb, "RIFF");
92 ffio_wfourcc(pb, riff_tag);
93 loff = ff_start_tag(pb, "LIST");
94 ffio_wfourcc(pb, list_tag);
98 static char *avi_stream2fourcc(char *tag, int index, enum AVMediaType type)
100 tag[0] = '0' + index / 10;
101 tag[1] = '0' + index % 10;
102 if (type == AVMEDIA_TYPE_VIDEO) {
105 } else if (type == AVMEDIA_TYPE_SUBTITLE) {
106 // note: this is not an official code
117 static int avi_write_counters(AVFormatContext *s, int riff_id)
119 AVIOContext *pb = s->pb;
120 AVIContext *avi = s->priv_data;
121 int n, au_byterate, au_ssize, au_scale, nb_frames = 0;
123 AVCodecContext *stream;
125 file_size = avio_tell(pb);
126 for (n = 0; n < s->nb_streams; n++) {
127 AVIStream *avist = s->streams[n]->priv_data;
129 av_assert0(avist->frames_hdr_strm);
130 stream = s->streams[n]->codec;
131 avio_seek(pb, avist->frames_hdr_strm, SEEK_SET);
132 ff_parse_specific_params(stream, &au_byterate, &au_ssize, &au_scale);
134 avio_wl32(pb, avist->packet_count);
136 avio_wl32(pb, avist->audio_strm_length / au_ssize);
137 if (stream->codec_type == AVMEDIA_TYPE_VIDEO)
138 nb_frames = FFMAX(nb_frames, avist->packet_count);
141 av_assert0(avi->frames_hdr_all);
142 avio_seek(pb, avi->frames_hdr_all, SEEK_SET);
143 avio_wl32(pb, nb_frames);
145 avio_seek(pb, file_size, SEEK_SET);
150 static int avi_write_header(AVFormatContext *s)
152 AVIContext *avi = s->priv_data;
153 AVIOContext *pb = s->pb;
154 int bitrate, n, i, nb_frames, au_byterate, au_ssize, au_scale;
155 AVCodecContext *stream, *video_enc;
156 int64_t list1, list2, strh, strf;
157 AVDictionaryEntry *t = NULL;
160 if (s->nb_streams > AVI_MAX_STREAM_COUNT) {
161 av_log(s, AV_LOG_ERROR, "AVI does not support >%d streams\n",
162 AVI_MAX_STREAM_COUNT);
163 return AVERROR(EINVAL);
166 for (n = 0; n < s->nb_streams; n++) {
167 s->streams[n]->priv_data = av_mallocz(sizeof(AVIStream));
168 if (!s->streams[n]->priv_data)
169 return AVERROR(ENOMEM);
174 list1 = avi_start_new_riff(s, pb, "AVI ", "hdrl");
177 ffio_wfourcc(pb, "avih");
178 avio_wl32(pb, 14 * 4);
182 for (n = 0; n < s->nb_streams; n++) {
183 stream = s->streams[n]->codec;
184 bitrate += stream->bit_rate;
185 if (stream->codec_type == AVMEDIA_TYPE_VIDEO)
192 avio_wl32(pb, (uint32_t) (INT64_C(1000000) * video_enc->time_base.num /
193 video_enc->time_base.den));
196 avio_wl32(pb, bitrate / 8); /* XXX: not quite exact */
197 avio_wl32(pb, 0); /* padding */
199 avio_wl32(pb, AVIF_TRUSTCKTYPE | AVIF_ISINTERLEAVED); /* flags */
201 avio_wl32(pb, AVIF_TRUSTCKTYPE | AVIF_HASINDEX | AVIF_ISINTERLEAVED); /* flags */
202 avi->frames_hdr_all = avio_tell(pb); /* remember this offset to fill later */
203 avio_wl32(pb, nb_frames); /* nb frames, filled later */
204 avio_wl32(pb, 0); /* initial frame */
205 avio_wl32(pb, s->nb_streams); /* nb streams */
206 avio_wl32(pb, 1024 * 1024); /* suggested buffer size */
208 avio_wl32(pb, video_enc->width);
209 avio_wl32(pb, video_enc->height);
214 avio_wl32(pb, 0); /* reserved */
215 avio_wl32(pb, 0); /* reserved */
216 avio_wl32(pb, 0); /* reserved */
217 avio_wl32(pb, 0); /* reserved */
220 for (i = 0; i < n; i++) {
221 AVIStream *avist = s->streams[i]->priv_data;
222 list2 = ff_start_tag(pb, "LIST");
223 ffio_wfourcc(pb, "strl");
225 stream = s->streams[i]->codec;
227 /* stream generic header */
228 strh = ff_start_tag(pb, "strh");
229 switch (stream->codec_type) {
230 case AVMEDIA_TYPE_SUBTITLE:
231 // XSUB subtitles behave like video tracks, other subtitles
232 // are not (yet) supported.
233 if (stream->codec_id != AV_CODEC_ID_XSUB) {
234 av_log(s, AV_LOG_ERROR,
235 "Subtitle streams other than DivX XSUB are not supported by the AVI muxer.\n");
236 return AVERROR_PATCHWELCOME;
238 case AVMEDIA_TYPE_VIDEO:
239 ffio_wfourcc(pb, "vids");
241 case AVMEDIA_TYPE_AUDIO:
242 ffio_wfourcc(pb, "auds");
244 // case AVMEDIA_TYPE_TEXT:
245 // ffio_wfourcc(pb, "txts");
247 case AVMEDIA_TYPE_DATA:
248 ffio_wfourcc(pb, "dats");
251 if (stream->codec_type == AVMEDIA_TYPE_VIDEO ||
252 stream->codec_id == AV_CODEC_ID_XSUB)
253 avio_wl32(pb, stream->codec_tag);
256 avio_wl32(pb, 0); /* flags */
257 avio_wl16(pb, 0); /* priority */
258 avio_wl16(pb, 0); /* language */
259 avio_wl32(pb, 0); /* initial frame */
261 ff_parse_specific_params(stream, &au_byterate, &au_ssize, &au_scale);
263 if ( stream->codec_type == AVMEDIA_TYPE_VIDEO
264 && stream->codec_id != AV_CODEC_ID_XSUB
265 && au_byterate > 1000LL*au_scale) {
269 avpriv_set_pts_info(s->streams[i], 64, au_scale, au_byterate);
270 if (stream->codec_id == AV_CODEC_ID_XSUB)
271 au_scale = au_byterate = 0;
273 avio_wl32(pb, au_scale); /* scale */
274 avio_wl32(pb, au_byterate); /* rate */
276 avio_wl32(pb, 0); /* start */
277 /* remember this offset to fill later */
278 avist->frames_hdr_strm = avio_tell(pb);
280 /* FIXME: this may be broken, but who cares */
281 avio_wl32(pb, AVI_MAX_RIFF_SIZE);
283 avio_wl32(pb, 0); /* length, XXX: filled later */
285 /* suggested buffer size */ //FIXME set at the end to largest chunk
286 if (stream->codec_type == AVMEDIA_TYPE_VIDEO)
287 avio_wl32(pb, 1024 * 1024);
288 else if (stream->codec_type == AVMEDIA_TYPE_AUDIO)
289 avio_wl32(pb, 12 * 1024);
292 avio_wl32(pb, -1); /* quality */
293 avio_wl32(pb, au_ssize); /* sample size */
295 avio_wl16(pb, stream->width);
296 avio_wl16(pb, stream->height);
297 ff_end_tag(pb, strh);
299 if (stream->codec_type != AVMEDIA_TYPE_DATA) {
301 enum AVPixelFormat pix_fmt;
303 strf = ff_start_tag(pb, "strf");
304 switch (stream->codec_type) {
305 case AVMEDIA_TYPE_SUBTITLE:
306 /* XSUB subtitles behave like video tracks, other subtitles
307 * are not (yet) supported. */
308 if (stream->codec_id != AV_CODEC_ID_XSUB)
310 case AVMEDIA_TYPE_VIDEO:
311 /* WMP expects RGB 5:5:5 rawvideo in avi to have bpp set to 16. */
312 if ( !stream->codec_tag
313 && stream->codec_id == AV_CODEC_ID_RAWVIDEO
314 && stream->pix_fmt == AV_PIX_FMT_RGB555LE
315 && stream->bits_per_coded_sample == 15)
316 stream->bits_per_coded_sample = 16;
317 ff_put_bmp_header(pb, stream, ff_codec_bmp_tags, 0, 0);
318 pix_fmt = avpriv_find_pix_fmt(avpriv_pix_fmt_bps_avi,
319 stream->bits_per_coded_sample);
320 if ( !stream->codec_tag
321 && stream->codec_id == AV_CODEC_ID_RAWVIDEO
322 && stream->pix_fmt != pix_fmt
323 && stream->pix_fmt != AV_PIX_FMT_NONE)
324 av_log(s, AV_LOG_ERROR, "%s rawvideo cannot be written to avi, output file will be unreadable\n",
325 av_get_pix_fmt_name(stream->pix_fmt));
327 case AVMEDIA_TYPE_AUDIO:
328 if ((ret = ff_put_wav_header(pb, stream, 0)) < 0)
332 av_log(s, AV_LOG_ERROR,
333 "Invalid or not supported codec type '%s' found in the input\n",
334 (char *)av_x_if_null(av_get_media_type_string(stream->codec_type), "?"));
335 return AVERROR(EINVAL);
337 ff_end_tag(pb, strf);
338 if ((t = av_dict_get(s->streams[i]->metadata, "title", NULL, 0))) {
339 ff_riff_write_info_tag(s->pb, "strn", t->value);
342 if (stream->codec_id == AV_CODEC_ID_XSUB
343 && (t = av_dict_get(s->streams[i]->metadata, "language", NULL, 0))) {
344 const char* langstr = av_convert_lang_to(t->value, AV_LANG_ISO639_1);
347 char* str = av_asprintf("Subtitle - %s-xx;02", langstr);
348 ff_riff_write_info_tag(s->pb, "strn", str);
355 unsigned char tag[5];
358 /* Starting to lay out AVI OpenDML master index.
359 * We want to make it JUNK entry for now, since we'd
360 * like to get away without making AVI an OpenDML one
361 * for compatibility reasons. */
362 avist->indexes.entry = avist->indexes.ents_allocated = 0;
363 avist->indexes.indx_start = ff_start_tag(pb, "JUNK");
364 avio_wl16(pb, 4); /* wLongsPerEntry */
365 avio_w8(pb, 0); /* bIndexSubType (0 == frame index) */
366 avio_w8(pb, 0); /* bIndexType (0 == AVI_INDEX_OF_INDEXES) */
367 avio_wl32(pb, 0); /* nEntriesInUse (will fill out later on) */
368 ffio_wfourcc(pb, avi_stream2fourcc(tag, i, stream->codec_type));
370 avio_wl64(pb, 0); /* dwReserved[3] */
371 // avio_wl32(pb, 0); /* Must be 0. */
372 for (j = 0; j < AVI_MASTER_INDEX_SIZE * 2; j++)
374 ff_end_tag(pb, avist->indexes.indx_start);
377 if (stream->codec_type == AVMEDIA_TYPE_VIDEO &&
378 s->streams[i]->sample_aspect_ratio.num > 0 &&
379 s->streams[i]->sample_aspect_ratio.den > 0) {
380 int vprp = ff_start_tag(pb, "vprp");
381 AVRational dar = av_mul_q(s->streams[i]->sample_aspect_ratio,
382 (AVRational) { stream->width,
385 av_reduce(&num, &den, dar.num, dar.den, 0xFFFF);
387 avio_wl32(pb, 0); // video format = unknown
388 avio_wl32(pb, 0); // video standard = unknown
389 avio_wl32(pb, lrintf(1.0 / av_q2d(stream->time_base)));
390 avio_wl32(pb, stream->width);
391 avio_wl32(pb, stream->height);
394 avio_wl32(pb, stream->width);
395 avio_wl32(pb, stream->height);
396 avio_wl32(pb, 1); // progressive FIXME
398 avio_wl32(pb, stream->height);
399 avio_wl32(pb, stream->width);
400 avio_wl32(pb, stream->height);
401 avio_wl32(pb, stream->width);
407 ff_end_tag(pb, vprp);
410 ff_end_tag(pb, list2);
414 /* AVI could become an OpenDML one, if it grows beyond 2Gb range */
415 avi->odml_list = ff_start_tag(pb, "JUNK");
416 ffio_wfourcc(pb, "odml");
417 ffio_wfourcc(pb, "dmlh");
419 for (i = 0; i < 248; i += 4)
421 ff_end_tag(pb, avi->odml_list);
424 ff_end_tag(pb, list1);
426 ff_riff_write_info(s);
429 padding = s->metadata_header_padding;
433 /* some padding for easier tag editing */
435 list2 = ff_start_tag(pb, "JUNK");
436 for (i = padding; i > 0; i -= 4)
438 ff_end_tag(pb, list2);
441 avi->movi_list = ff_start_tag(pb, "LIST");
442 ffio_wfourcc(pb, "movi");
449 static int avi_write_ix(AVFormatContext *s)
451 AVIOContext *pb = s->pb;
452 AVIContext *avi = s->priv_data;
454 char ix_tag[] = "ix00";
457 av_assert0(pb->seekable);
459 if (avi->riff_id > AVI_MASTER_INDEX_SIZE) {
460 av_log(s, AV_LOG_ERROR, "Invalid riff index %d > %d\n",
461 avi->riff_id, AVI_MASTER_INDEX_SIZE);
462 return AVERROR(EINVAL);
465 for (i = 0; i < s->nb_streams; i++) {
466 AVIStream *avist = s->streams[i]->priv_data;
469 avi_stream2fourcc(tag, i, s->streams[i]->codec->codec_type);
472 /* Writing AVI OpenDML leaf index chunk */
474 ffio_wfourcc(pb, ix_tag); /* ix?? */
475 avio_wl32(pb, avist->indexes.entry * 8 + 24);
477 avio_wl16(pb, 2); /* wLongsPerEntry */
478 avio_w8(pb, 0); /* bIndexSubType (0 == frame index) */
479 avio_w8(pb, 1); /* bIndexType (1 == AVI_INDEX_OF_CHUNKS) */
480 avio_wl32(pb, avist->indexes.entry);
482 ffio_wfourcc(pb, tag); /* dwChunkId */
483 avio_wl64(pb, avi->movi_list); /* qwBaseOffset */
484 avio_wl32(pb, 0); /* dwReserved_3 (must be 0) */
486 for (j = 0; j < avist->indexes.entry; j++) {
487 AVIIentry *ie = avi_get_ientry(&avist->indexes, j);
488 avio_wl32(pb, ie->pos + 8);
489 avio_wl32(pb, ((uint32_t) ie->len & ~0x80000000) |
490 (ie->flags & 0x10 ? 0 : 0x80000000));
495 /* Updating one entry in the AVI OpenDML master index */
496 avio_seek(pb, avist->indexes.indx_start - 8, SEEK_SET);
497 ffio_wfourcc(pb, "indx"); /* enabling this entry */
499 avio_wl32(pb, avi->riff_id); /* nEntriesInUse */
500 avio_skip(pb, 16 * avi->riff_id);
501 avio_wl64(pb, ix); /* qwOffset */
502 avio_wl32(pb, pos - ix); /* dwSize */
503 avio_wl32(pb, avist->indexes.entry); /* dwDuration */
505 avio_seek(pb, pos, SEEK_SET);
510 static int avi_write_idx1(AVFormatContext *s)
512 AVIOContext *pb = s->pb;
513 AVIContext *avi = s->priv_data;
520 AVIIentry *ie = 0, *tie;
521 int empty, stream_id = -1;
523 idx_chunk = ff_start_tag(pb, "idx1");
524 for (i = 0; i < s->nb_streams; i++) {
525 avist = s->streams[i]->priv_data;
531 for (i = 0; i < s->nb_streams; i++) {
532 avist = s->streams[i]->priv_data;
533 if (avist->indexes.entry <= avist->entry)
536 tie = avi_get_ientry(&avist->indexes, avist->entry);
537 if (empty || tie->pos < ie->pos) {
544 avist = s->streams[stream_id]->priv_data;
545 avi_stream2fourcc(tag, stream_id,
546 s->streams[stream_id]->codec->codec_type);
547 ffio_wfourcc(pb, tag);
548 avio_wl32(pb, ie->flags);
549 avio_wl32(pb, ie->pos);
550 avio_wl32(pb, ie->len);
554 ff_end_tag(pb, idx_chunk);
556 avi_write_counters(s, avi->riff_id);
561 static int avi_write_packet(AVFormatContext *s, AVPacket *pkt)
563 unsigned char tag[5];
564 unsigned int flags = 0;
565 const int stream_index = pkt->stream_index;
566 int size = pkt->size;
567 AVIContext *avi = s->priv_data;
568 AVIOContext *pb = s->pb;
569 AVIStream *avist = s->streams[stream_index]->priv_data;
570 AVCodecContext *enc = s->streams[stream_index]->codec;
572 av_dlog(s, "dts:%s packet_count:%d stream_index:%d\n", av_ts2str(pkt->dts), avist->packet_count, stream_index);
573 while (enc->block_align == 0 && pkt->dts != AV_NOPTS_VALUE &&
574 pkt->dts > avist->packet_count && enc->codec_id != AV_CODEC_ID_XSUB && avist->packet_count) {
575 AVPacket empty_packet;
577 if (pkt->dts - avist->packet_count > 60000) {
578 av_log(s, AV_LOG_ERROR, "Too large number of skipped frames %"PRId64" > 60000\n", pkt->dts - avist->packet_count);
579 return AVERROR(EINVAL);
582 av_init_packet(&empty_packet);
583 empty_packet.size = 0;
584 empty_packet.data = NULL;
585 empty_packet.stream_index = stream_index;
586 avi_write_packet(s, &empty_packet);
587 av_dlog(s, "dup dts:%s packet_count:%d\n", av_ts2str(pkt->dts), avist->packet_count);
589 avist->packet_count++;
591 // Make sure to put an OpenDML chunk when the file size exceeds the limits
593 (avio_tell(pb) - avi->riff_start > AVI_MAX_RIFF_SIZE)) {
595 ff_end_tag(pb, avi->movi_list);
597 if (avi->riff_id == 1)
600 ff_end_tag(pb, avi->riff_start);
601 avi->movi_list = avi_start_new_riff(s, pb, "AVIX", "movi");
604 avi_stream2fourcc(tag, stream_index, enc->codec_type);
605 if (pkt->flags & AV_PKT_FLAG_KEY)
607 if (enc->codec_type == AVMEDIA_TYPE_AUDIO)
608 avist->audio_strm_length += size;
610 if (s->pb->seekable) {
611 AVIIndex *idx = &avist->indexes;
612 int cl = idx->entry / AVI_INDEX_CLUSTER_SIZE;
613 int id = idx->entry % AVI_INDEX_CLUSTER_SIZE;
614 if (idx->ents_allocated <= idx->entry) {
615 idx->cluster = av_realloc_f(idx->cluster, sizeof(void*), cl+1);
617 idx->ents_allocated = 0;
619 return AVERROR(ENOMEM);
622 av_malloc(AVI_INDEX_CLUSTER_SIZE * sizeof(AVIIentry));
623 if (!idx->cluster[cl])
624 return AVERROR(ENOMEM);
625 idx->ents_allocated += AVI_INDEX_CLUSTER_SIZE;
628 idx->cluster[cl][id].flags = flags;
629 idx->cluster[cl][id].pos = avio_tell(pb) - avi->movi_list;
630 idx->cluster[cl][id].len = size;
634 avio_write(pb, tag, 4);
636 avio_write(pb, pkt->data, size);
643 static int avi_write_trailer(AVFormatContext *s)
645 AVIContext *avi = s->priv_data;
646 AVIOContext *pb = s->pb;
648 int i, j, n, nb_frames;
652 if (avi->riff_id == 1) {
653 ff_end_tag(pb, avi->movi_list);
654 res = avi_write_idx1(s);
655 ff_end_tag(pb, avi->riff_start);
658 ff_end_tag(pb, avi->movi_list);
659 ff_end_tag(pb, avi->riff_start);
661 file_size = avio_tell(pb);
662 avio_seek(pb, avi->odml_list - 8, SEEK_SET);
663 ffio_wfourcc(pb, "LIST"); /* Making this AVI OpenDML one */
666 for (n = nb_frames = 0; n < s->nb_streams; n++) {
667 AVCodecContext *stream = s->streams[n]->codec;
668 AVIStream *avist = s->streams[n]->priv_data;
670 if (stream->codec_type == AVMEDIA_TYPE_VIDEO) {
671 if (nb_frames < avist->packet_count)
672 nb_frames = avist->packet_count;
674 if (stream->codec_id == AV_CODEC_ID_MP2 ||
675 stream->codec_id == AV_CODEC_ID_MP3)
676 nb_frames += avist->packet_count;
679 avio_wl32(pb, nb_frames);
680 avio_seek(pb, file_size, SEEK_SET);
682 avi_write_counters(s, avi->riff_id);
686 for (i = 0; i < s->nb_streams; i++) {
687 AVIStream *avist = s->streams[i]->priv_data;
688 for (j = 0; j < avist->indexes.ents_allocated / AVI_INDEX_CLUSTER_SIZE; j++)
689 av_freep(&avist->indexes.cluster[j]);
690 av_freep(&avist->indexes.cluster);
691 avist->indexes.ents_allocated = avist->indexes.entry = 0;
697 AVOutputFormat ff_avi_muxer = {
699 .long_name = NULL_IF_CONFIG_SMALL("AVI (Audio Video Interleaved)"),
700 .mime_type = "video/x-msvideo",
702 .priv_data_size = sizeof(AVIContext),
703 .audio_codec = CONFIG_LIBMP3LAME ? AV_CODEC_ID_MP3 : AV_CODEC_ID_AC3,
704 .video_codec = AV_CODEC_ID_MPEG4,
705 .write_header = avi_write_header,
706 .write_packet = avi_write_packet,
707 .write_trailer = avi_write_trailer,
708 .codec_tag = (const AVCodecTag * const []) {
709 ff_codec_bmp_tags, ff_codec_wav_tags, 0