3 * Copyright (c) 2000 Fabrice Bellard
5 * This file is part of Libav.
7 * Libav 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 * Libav 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 Libav; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #include "avio_internal.h"
26 #include "libavutil/intreadwrite.h"
27 #include "libavutil/dict.h"
31 * - fill all fields if non streamed (nb_frames for example)
34 typedef struct AVIIentry {
35 unsigned int flags, pos, len;
38 #define AVI_INDEX_CLUSTER_SIZE 16384
40 typedef struct AVIIndex {
47 typedef struct AVIContext {
48 int64_t riff_start, movi_list, odml_list;
49 int64_t frames_hdr_all;
53 typedef struct AVIStream {
54 int64_t frames_hdr_strm;
55 int audio_strm_length;
62 static inline AVIIentry *avi_get_ientry(AVIIndex *idx, int ent_id)
64 int cl = ent_id / AVI_INDEX_CLUSTER_SIZE;
65 int id = ent_id % AVI_INDEX_CLUSTER_SIZE;
66 return &idx->cluster[cl][id];
69 static int64_t avi_start_new_riff(AVFormatContext *s, AVIOContext *pb,
70 const char *riff_tag, const char *list_tag)
72 AVIContext *avi = s->priv_data;
77 for (i = 0; i < s->nb_streams; i++) {
78 AVIStream *avist = s->streams[i]->priv_data;
79 avist->indexes.entry = 0;
82 avi->riff_start = ff_start_tag(pb, "RIFF");
83 ffio_wfourcc(pb, riff_tag);
84 loff = ff_start_tag(pb, "LIST");
85 ffio_wfourcc(pb, list_tag);
89 static char *avi_stream2fourcc(char *tag, int index, enum AVMediaType type)
91 tag[0] = '0' + index / 10;
92 tag[1] = '0' + index % 10;
93 if (type == AVMEDIA_TYPE_VIDEO) {
96 } else if (type == AVMEDIA_TYPE_SUBTITLE) {
97 // note: this is not an official code
108 static int avi_write_counters(AVFormatContext *s, int riff_id)
110 AVIOContext *pb = s->pb;
111 AVIContext *avi = s->priv_data;
112 int n, au_byterate, au_ssize, au_scale, nb_frames = 0;
114 AVCodecContext *stream;
116 file_size = avio_tell(pb);
117 for (n = 0; n < s->nb_streams; n++) {
118 AVIStream *avist = s->streams[n]->priv_data;
120 assert(avist->frames_hdr_strm);
121 stream = s->streams[n]->codec;
122 avio_seek(pb, avist->frames_hdr_strm, SEEK_SET);
123 ff_parse_specific_params(s->streams[n], &au_byterate, &au_ssize, &au_scale);
125 avio_wl32(pb, avist->packet_count);
127 avio_wl32(pb, avist->audio_strm_length / au_ssize);
128 if (stream->codec_type == AVMEDIA_TYPE_VIDEO)
129 nb_frames = FFMAX(nb_frames, avist->packet_count);
132 assert(avi->frames_hdr_all);
133 avio_seek(pb, avi->frames_hdr_all, SEEK_SET);
134 avio_wl32(pb, nb_frames);
136 avio_seek(pb, file_size, SEEK_SET);
141 static int avi_write_header(AVFormatContext *s)
143 AVIContext *avi = s->priv_data;
144 AVIOContext *pb = s->pb;
145 int bitrate, n, i, nb_frames, au_byterate, au_ssize, au_scale;
146 AVCodecContext *video_enc;
147 AVStream *video_st = NULL;
148 int64_t list1, list2, strh, strf;
149 AVDictionaryEntry *t = NULL;
151 if (s->nb_streams > AVI_MAX_STREAM_COUNT) {
152 av_log(s, AV_LOG_ERROR, "AVI does not support >%d streams\n",
153 AVI_MAX_STREAM_COUNT);
157 for (n = 0; n < s->nb_streams; n++) {
158 s->streams[n]->priv_data = av_mallocz(sizeof(AVIStream));
159 if (!s->streams[n]->priv_data)
160 return AVERROR(ENOMEM);
165 list1 = avi_start_new_riff(s, pb, "AVI ", "hdrl");
168 ffio_wfourcc(pb, "avih");
169 avio_wl32(pb, 14 * 4);
173 for (n = 0; n < s->nb_streams; n++) {
174 AVCodecContext *codec = s->streams[n]->codec;
175 bitrate += codec->bit_rate;
176 if (codec->codec_type == AVMEDIA_TYPE_VIDEO) {
178 video_st = s->streams[n];
184 // TODO: should be avg_frame_rate
186 avio_wl32(pb, (uint32_t) (INT64_C(1000000) * video_st->time_base.num /
187 video_st->time_base.den));
190 avio_wl32(pb, bitrate / 8); /* XXX: not quite exact */
191 avio_wl32(pb, 0); /* padding */
193 avio_wl32(pb, AVIF_TRUSTCKTYPE | AVIF_ISINTERLEAVED); /* flags */
195 avio_wl32(pb, AVIF_TRUSTCKTYPE | AVIF_HASINDEX | AVIF_ISINTERLEAVED); /* flags */
196 avi->frames_hdr_all = avio_tell(pb); /* remember this offset to fill later */
197 avio_wl32(pb, nb_frames); /* nb frames, filled later */
198 avio_wl32(pb, 0); /* initial frame */
199 avio_wl32(pb, s->nb_streams); /* nb streams */
200 avio_wl32(pb, 1024 * 1024); /* suggested buffer size */
202 avio_wl32(pb, video_enc->width);
203 avio_wl32(pb, video_enc->height);
208 avio_wl32(pb, 0); /* reserved */
209 avio_wl32(pb, 0); /* reserved */
210 avio_wl32(pb, 0); /* reserved */
211 avio_wl32(pb, 0); /* reserved */
214 for (i = 0; i < n; i++) {
215 AVStream *st = s->streams[i];
216 AVCodecContext *enc = st->codec;
217 AVIStream *avist = st->priv_data;
218 list2 = ff_start_tag(pb, "LIST");
219 ffio_wfourcc(pb, "strl");
221 /* stream generic header */
222 strh = ff_start_tag(pb, "strh");
223 switch (enc->codec_type) {
224 case AVMEDIA_TYPE_SUBTITLE:
225 // XSUB subtitles behave like video tracks, other subtitles
226 // are not (yet) supported.
227 if (enc->codec_id != AV_CODEC_ID_XSUB) {
228 av_log(s, AV_LOG_ERROR,
229 "Subtitle streams other than DivX XSUB are not supported by the AVI muxer.\n");
230 return AVERROR_PATCHWELCOME;
232 case AVMEDIA_TYPE_VIDEO:
233 ffio_wfourcc(pb, "vids");
235 case AVMEDIA_TYPE_AUDIO:
236 ffio_wfourcc(pb, "auds");
238 // case AVMEDIA_TYPE_TEXT:
239 // ffio_wfourcc(pb, "txts");
241 case AVMEDIA_TYPE_DATA:
242 ffio_wfourcc(pb, "dats");
245 if (enc->codec_type == AVMEDIA_TYPE_VIDEO ||
246 enc->codec_id == AV_CODEC_ID_XSUB)
247 avio_wl32(pb, enc->codec_tag);
250 avio_wl32(pb, 0); /* flags */
251 avio_wl16(pb, 0); /* priority */
252 avio_wl16(pb, 0); /* language */
253 avio_wl32(pb, 0); /* initial frame */
255 ff_parse_specific_params(st, &au_byterate, &au_ssize, &au_scale);
257 avio_wl32(pb, au_scale); /* scale */
258 avio_wl32(pb, au_byterate); /* rate */
259 avpriv_set_pts_info(st, 64, au_scale, au_byterate);
261 avio_wl32(pb, 0); /* start */
262 /* remember this offset to fill later */
263 avist->frames_hdr_strm = avio_tell(pb);
265 /* FIXME: this may be broken, but who cares */
266 avio_wl32(pb, AVI_MAX_RIFF_SIZE);
268 avio_wl32(pb, 0); /* length, XXX: filled later */
270 /* suggested buffer size */ //FIXME set at the end to largest chunk
271 if (enc->codec_type == AVMEDIA_TYPE_VIDEO)
272 avio_wl32(pb, 1024 * 1024);
273 else if (enc->codec_type == AVMEDIA_TYPE_AUDIO)
274 avio_wl32(pb, 12 * 1024);
277 avio_wl32(pb, -1); /* quality */
278 avio_wl32(pb, au_ssize); /* sample size */
280 avio_wl16(pb, enc->width);
281 avio_wl16(pb, enc->height);
282 ff_end_tag(pb, strh);
284 if (enc->codec_type != AVMEDIA_TYPE_DATA) {
285 strf = ff_start_tag(pb, "strf");
286 switch (enc->codec_type) {
287 case AVMEDIA_TYPE_SUBTITLE:
288 /* XSUB subtitles behave like video tracks, other subtitles
289 * are not (yet) supported. */
290 if (enc->codec_id != AV_CODEC_ID_XSUB)
292 case AVMEDIA_TYPE_VIDEO:
293 ff_put_bmp_header(pb, enc, ff_codec_bmp_tags, 0);
295 case AVMEDIA_TYPE_AUDIO:
296 if (ff_put_wav_header(pb, enc) < 0)
302 ff_end_tag(pb, strf);
303 if ((t = av_dict_get(st->metadata, "title", NULL, 0))) {
304 ff_riff_write_info_tag(s->pb, "strn", t->value);
310 unsigned char tag[5];
313 /* Starting to lay out AVI OpenDML master index.
314 * We want to make it JUNK entry for now, since we'd
315 * like to get away without making AVI an OpenDML one
316 * for compatibility reasons. */
317 avist->indexes.entry = avist->indexes.ents_allocated = 0;
318 avist->indexes.indx_start = ff_start_tag(pb, "JUNK");
319 avio_wl16(pb, 4); /* wLongsPerEntry */
320 avio_w8(pb, 0); /* bIndexSubType (0 == frame index) */
321 avio_w8(pb, 0); /* bIndexType (0 == AVI_INDEX_OF_INDEXES) */
322 avio_wl32(pb, 0); /* nEntriesInUse (will fill out later on) */
323 ffio_wfourcc(pb, avi_stream2fourcc(tag, i, enc->codec_type));
325 avio_wl64(pb, 0); /* dwReserved[3] */
326 // avio_wl32(pb, 0); /* Must be 0. */
327 for (j = 0; j < AVI_MASTER_INDEX_SIZE * 2; j++)
329 ff_end_tag(pb, avist->indexes.indx_start);
332 if (enc->codec_type == AVMEDIA_TYPE_VIDEO &&
333 st->sample_aspect_ratio.num > 0 &&
334 st->sample_aspect_ratio.den > 0) {
335 int vprp = ff_start_tag(pb, "vprp");
336 AVRational dar = av_mul_q(st->sample_aspect_ratio,
337 (AVRational) { enc->width,
340 av_reduce(&num, &den, dar.num, dar.den, 0xFFFF);
342 avio_wl32(pb, 0); // video format = unknown
343 avio_wl32(pb, 0); // video standard = unknown
344 // TODO: should be avg_frame_rate
345 avio_wl32(pb, lrintf(1.0 / av_q2d(st->time_base)));
346 avio_wl32(pb, enc->width);
347 avio_wl32(pb, enc->height);
350 avio_wl32(pb, enc->width);
351 avio_wl32(pb, enc->height);
352 avio_wl32(pb, 1); // progressive FIXME
354 avio_wl32(pb, enc->height);
355 avio_wl32(pb, enc->width);
356 avio_wl32(pb, enc->height);
357 avio_wl32(pb, enc->width);
363 ff_end_tag(pb, vprp);
366 ff_end_tag(pb, list2);
370 /* AVI could become an OpenDML one, if it grows beyond 2Gb range */
371 avi->odml_list = ff_start_tag(pb, "JUNK");
372 ffio_wfourcc(pb, "odml");
373 ffio_wfourcc(pb, "dmlh");
375 for (i = 0; i < 248; i += 4)
377 ff_end_tag(pb, avi->odml_list);
380 ff_end_tag(pb, list1);
382 ff_riff_write_info(s);
384 /* some padding for easier tag editing */
385 list2 = ff_start_tag(pb, "JUNK");
386 for (i = 0; i < 1016; i += 4)
388 ff_end_tag(pb, list2);
390 avi->movi_list = ff_start_tag(pb, "LIST");
391 ffio_wfourcc(pb, "movi");
398 static int avi_write_ix(AVFormatContext *s)
400 AVIOContext *pb = s->pb;
401 AVIContext *avi = s->priv_data;
403 char ix_tag[] = "ix00";
406 assert(pb->seekable);
408 if (avi->riff_id > AVI_MASTER_INDEX_SIZE)
411 for (i = 0; i < s->nb_streams; i++) {
412 AVIStream *avist = s->streams[i]->priv_data;
415 avi_stream2fourcc(tag, i, s->streams[i]->codec->codec_type);
418 /* Writing AVI OpenDML leaf index chunk */
420 ffio_wfourcc(pb, ix_tag); /* ix?? */
421 avio_wl32(pb, avist->indexes.entry * 8 + 24);
423 avio_wl16(pb, 2); /* wLongsPerEntry */
424 avio_w8(pb, 0); /* bIndexSubType (0 == frame index) */
425 avio_w8(pb, 1); /* bIndexType (1 == AVI_INDEX_OF_CHUNKS) */
426 avio_wl32(pb, avist->indexes.entry);
428 ffio_wfourcc(pb, tag); /* dwChunkId */
429 avio_wl64(pb, avi->movi_list); /* qwBaseOffset */
430 avio_wl32(pb, 0); /* dwReserved_3 (must be 0) */
432 for (j = 0; j < avist->indexes.entry; j++) {
433 AVIIentry *ie = avi_get_ientry(&avist->indexes, j);
434 avio_wl32(pb, ie->pos + 8);
435 avio_wl32(pb, ((uint32_t) ie->len & ~0x80000000) |
436 (ie->flags & 0x10 ? 0 : 0x80000000));
441 /* Updating one entry in the AVI OpenDML master index */
442 avio_seek(pb, avist->indexes.indx_start - 8, SEEK_SET);
443 ffio_wfourcc(pb, "indx"); /* enabling this entry */
445 avio_wl32(pb, avi->riff_id); /* nEntriesInUse */
446 avio_skip(pb, 16 * avi->riff_id);
447 avio_wl64(pb, ix); /* qwOffset */
448 avio_wl32(pb, pos - ix); /* dwSize */
449 avio_wl32(pb, avist->indexes.entry); /* dwDuration */
451 avio_seek(pb, pos, SEEK_SET);
456 static int avi_write_idx1(AVFormatContext *s)
458 AVIOContext *pb = s->pb;
459 AVIContext *avi = s->priv_data;
466 AVIIentry *ie = 0, *tie;
467 int empty, stream_id = -1;
469 idx_chunk = ff_start_tag(pb, "idx1");
470 for (i = 0; i < s->nb_streams; i++) {
471 avist = s->streams[i]->priv_data;
477 for (i = 0; i < s->nb_streams; i++) {
478 avist = s->streams[i]->priv_data;
479 if (avist->indexes.entry <= avist->entry)
482 tie = avi_get_ientry(&avist->indexes, avist->entry);
483 if (empty || tie->pos < ie->pos) {
490 avist = s->streams[stream_id]->priv_data;
491 avi_stream2fourcc(tag, stream_id,
492 s->streams[stream_id]->codec->codec_type);
493 ffio_wfourcc(pb, tag);
494 avio_wl32(pb, ie->flags);
495 avio_wl32(pb, ie->pos);
496 avio_wl32(pb, ie->len);
500 ff_end_tag(pb, idx_chunk);
502 avi_write_counters(s, avi->riff_id);
507 static int avi_write_packet(AVFormatContext *s, AVPacket *pkt)
509 unsigned char tag[5];
510 unsigned int flags = 0;
511 const int stream_index = pkt->stream_index;
512 int size = pkt->size;
513 AVIContext *avi = s->priv_data;
514 AVIOContext *pb = s->pb;
515 AVIStream *avist = s->streams[stream_index]->priv_data;
516 AVCodecContext *enc = s->streams[stream_index]->codec;
518 while (enc->block_align == 0 && pkt->dts != AV_NOPTS_VALUE &&
519 pkt->dts > avist->packet_count) {
520 AVPacket empty_packet;
522 av_init_packet(&empty_packet);
523 empty_packet.size = 0;
524 empty_packet.data = NULL;
525 empty_packet.stream_index = stream_index;
526 avi_write_packet(s, &empty_packet);
528 avist->packet_count++;
530 // Make sure to put an OpenDML chunk when the file size exceeds the limits
532 (avio_tell(pb) - avi->riff_start > AVI_MAX_RIFF_SIZE)) {
534 ff_end_tag(pb, avi->movi_list);
536 if (avi->riff_id == 1)
539 ff_end_tag(pb, avi->riff_start);
540 avi->movi_list = avi_start_new_riff(s, pb, "AVIX", "movi");
543 avi_stream2fourcc(tag, stream_index, enc->codec_type);
544 if (pkt->flags & AV_PKT_FLAG_KEY)
546 if (enc->codec_type == AVMEDIA_TYPE_AUDIO)
547 avist->audio_strm_length += size;
549 if (s->pb->seekable) {
551 AVIIndex *idx = &avist->indexes;
552 int cl = idx->entry / AVI_INDEX_CLUSTER_SIZE;
553 int id = idx->entry % AVI_INDEX_CLUSTER_SIZE;
554 if (idx->ents_allocated <= idx->entry) {
555 if ((err = av_reallocp(&idx->cluster,
556 (cl + 1) * sizeof(*idx->cluster))) < 0) {
557 idx->ents_allocated = 0;
562 av_malloc(AVI_INDEX_CLUSTER_SIZE * sizeof(AVIIentry));
563 if (!idx->cluster[cl])
565 idx->ents_allocated += AVI_INDEX_CLUSTER_SIZE;
568 idx->cluster[cl][id].flags = flags;
569 idx->cluster[cl][id].pos = avio_tell(pb) - avi->movi_list;
570 idx->cluster[cl][id].len = size;
574 avio_write(pb, tag, 4);
576 avio_write(pb, pkt->data, size);
583 static int avi_write_trailer(AVFormatContext *s)
585 AVIContext *avi = s->priv_data;
586 AVIOContext *pb = s->pb;
588 int i, j, n, nb_frames;
592 if (avi->riff_id == 1) {
593 ff_end_tag(pb, avi->movi_list);
594 res = avi_write_idx1(s);
595 ff_end_tag(pb, avi->riff_start);
598 ff_end_tag(pb, avi->movi_list);
599 ff_end_tag(pb, avi->riff_start);
601 file_size = avio_tell(pb);
602 avio_seek(pb, avi->odml_list - 8, SEEK_SET);
603 ffio_wfourcc(pb, "LIST"); /* Making this AVI OpenDML one */
606 for (n = nb_frames = 0; n < s->nb_streams; n++) {
607 AVCodecContext *stream = s->streams[n]->codec;
608 AVIStream *avist = s->streams[n]->priv_data;
610 if (stream->codec_type == AVMEDIA_TYPE_VIDEO) {
611 if (nb_frames < avist->packet_count)
612 nb_frames = avist->packet_count;
614 if (stream->codec_id == AV_CODEC_ID_MP2 ||
615 stream->codec_id == AV_CODEC_ID_MP3)
616 nb_frames += avist->packet_count;
619 avio_wl32(pb, nb_frames);
620 avio_seek(pb, file_size, SEEK_SET);
622 avi_write_counters(s, avi->riff_id);
626 for (i = 0; i < s->nb_streams; i++) {
627 AVIStream *avist = s->streams[i]->priv_data;
628 for (j = 0; j < avist->indexes.ents_allocated / AVI_INDEX_CLUSTER_SIZE; j++)
629 av_free(avist->indexes.cluster[j]);
630 av_freep(&avist->indexes.cluster);
631 avist->indexes.ents_allocated = avist->indexes.entry = 0;
637 AVOutputFormat ff_avi_muxer = {
639 .long_name = NULL_IF_CONFIG_SMALL("AVI (Audio Video Interleaved)"),
640 .mime_type = "video/x-msvideo",
642 .priv_data_size = sizeof(AVIContext),
643 .audio_codec = CONFIG_LIBMP3LAME ? AV_CODEC_ID_MP3 : AV_CODEC_ID_AC3,
644 .video_codec = AV_CODEC_ID_MPEG4,
645 .write_header = avi_write_header,
646 .write_packet = avi_write_packet,
647 .write_trailer = avi_write_trailer,
648 .codec_tag = (const AVCodecTag * const []) {
649 ff_codec_bmp_tags, ff_codec_wav_tags, 0