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
24 #include "libavutil/intreadwrite.h"
28 * - fill all fields if non streamed (nb_frames for example)
31 typedef struct AVIIentry {
32 unsigned int flags, pos, len;
35 #define AVI_INDEX_CLUSTER_SIZE 16384
37 typedef struct AVIIndex {
45 int64_t riff_start, movi_list, odml_list;
46 int64_t frames_hdr_all;
51 int64_t frames_hdr_strm;
52 int audio_strm_length;
59 static inline AVIIentry* avi_get_ientry(AVIIndex* idx, int ent_id)
61 int cl = ent_id / AVI_INDEX_CLUSTER_SIZE;
62 int id = ent_id % AVI_INDEX_CLUSTER_SIZE;
63 return &idx->cluster[cl][id];
66 static int64_t avi_start_new_riff(AVFormatContext *s, ByteIOContext *pb,
67 const char* riff_tag, const char* list_tag)
69 AVIContext *avi= s->priv_data;
74 for (i=0; i<s->nb_streams; i++){
75 AVIStream *avist= s->streams[i]->priv_data;
76 avist->indexes.entry = 0;
79 avi->riff_start = ff_start_tag(pb, "RIFF");
80 put_tag(pb, riff_tag);
81 loff = ff_start_tag(pb, "LIST");
82 put_tag(pb, list_tag);
86 static char* avi_stream2fourcc(char* tag, int index, enum AVMediaType type)
90 if (type == AVMEDIA_TYPE_VIDEO) {
93 } else if (type == AVMEDIA_TYPE_SUBTITLE) {
94 // note: this is not an official code
105 static void avi_write_info_tag(ByteIOContext *pb, const char *tag, const char *str)
107 int len = strlen(str);
118 static int avi_write_counters(AVFormatContext* s, int riff_id)
120 ByteIOContext *pb = s->pb;
121 AVIContext *avi = s->priv_data;
122 int n, au_byterate, au_ssize, au_scale, nb_frames = 0;
124 AVCodecContext* stream;
126 file_size = url_ftell(pb);
127 for(n = 0; n < s->nb_streams; n++) {
128 AVIStream *avist= s->streams[n]->priv_data;
130 assert(avist->frames_hdr_strm);
131 stream = s->streams[n]->codec;
132 url_fseek(pb, avist->frames_hdr_strm, SEEK_SET);
133 ff_parse_specific_params(stream, &au_byterate, &au_ssize, &au_scale);
135 put_le32(pb, avist->packet_count);
137 put_le32(pb, avist->audio_strm_length / au_ssize);
139 if(stream->codec_type == AVMEDIA_TYPE_VIDEO)
140 nb_frames = FFMAX(nb_frames, avist->packet_count);
143 assert(avi->frames_hdr_all);
144 url_fseek(pb, avi->frames_hdr_all, SEEK_SET);
145 put_le32(pb, nb_frames);
147 url_fseek(pb, file_size, SEEK_SET);
152 static int avi_write_header(AVFormatContext *s)
154 AVIContext *avi = s->priv_data;
155 ByteIOContext *pb = s->pb;
156 int bitrate, n, i, nb_frames, au_byterate, au_ssize, au_scale;
157 AVCodecContext *stream, *video_enc;
158 int64_t list1, list2, strh, strf;
159 AVMetadataTag *t = NULL;
161 for(n=0;n<s->nb_streams;n++) {
162 s->streams[n]->priv_data= av_mallocz(sizeof(AVIStream));
163 if(!s->streams[n]->priv_data)
164 return AVERROR(ENOMEM);
169 list1 = avi_start_new_riff(s, pb, "AVI ", "hdrl");
173 put_le32(pb, 14 * 4);
177 for(n=0;n<s->nb_streams;n++) {
178 stream = s->streams[n]->codec;
179 bitrate += stream->bit_rate;
180 if (stream->codec_type == AVMEDIA_TYPE_VIDEO)
187 put_le32(pb, (uint32_t)(INT64_C(1000000) * video_enc->time_base.num / video_enc->time_base.den));
191 put_le32(pb, bitrate / 8); /* XXX: not quite exact */
192 put_le32(pb, 0); /* padding */
193 if (url_is_streamed(pb))
194 put_le32(pb, AVIF_TRUSTCKTYPE | AVIF_ISINTERLEAVED); /* flags */
196 put_le32(pb, AVIF_TRUSTCKTYPE | AVIF_HASINDEX | AVIF_ISINTERLEAVED); /* flags */
197 avi->frames_hdr_all = url_ftell(pb); /* remember this offset to fill later */
198 put_le32(pb, nb_frames); /* nb frames, filled later */
199 put_le32(pb, 0); /* initial frame */
200 put_le32(pb, s->nb_streams); /* nb streams */
201 put_le32(pb, 1024 * 1024); /* suggested buffer size */
203 put_le32(pb, video_enc->width);
204 put_le32(pb, video_enc->height);
209 put_le32(pb, 0); /* reserved */
210 put_le32(pb, 0); /* reserved */
211 put_le32(pb, 0); /* reserved */
212 put_le32(pb, 0); /* reserved */
216 AVIStream *avist= s->streams[i]->priv_data;
217 list2 = ff_start_tag(pb, "LIST");
220 stream = s->streams[i]->codec;
222 /* stream generic header */
223 strh = ff_start_tag(pb, "strh");
224 switch(stream->codec_type) {
225 case AVMEDIA_TYPE_SUBTITLE:
226 // XSUB subtitles behave like video tracks, other subtitles
227 // are not (yet) supported.
228 if (stream->codec_id != CODEC_ID_XSUB) {
229 av_log(s, AV_LOG_ERROR, "Subtitle streams other than DivX XSUB are not supported by the AVI muxer.\n");
230 return AVERROR_PATCHWELCOME;
232 case AVMEDIA_TYPE_VIDEO: put_tag(pb, "vids"); break;
233 case AVMEDIA_TYPE_AUDIO: put_tag(pb, "auds"); break;
234 // case AVMEDIA_TYPE_TEXT : put_tag(pb, "txts"); break;
235 case AVMEDIA_TYPE_DATA : put_tag(pb, "dats"); break;
237 if(stream->codec_type == AVMEDIA_TYPE_VIDEO ||
238 stream->codec_id == CODEC_ID_XSUB)
239 put_le32(pb, stream->codec_tag);
242 put_le32(pb, 0); /* flags */
243 put_le16(pb, 0); /* priority */
244 put_le16(pb, 0); /* language */
245 put_le32(pb, 0); /* initial frame */
247 ff_parse_specific_params(stream, &au_byterate, &au_ssize, &au_scale);
249 put_le32(pb, au_scale); /* scale */
250 put_le32(pb, au_byterate); /* rate */
251 av_set_pts_info(s->streams[i], 64, au_scale, au_byterate);
253 put_le32(pb, 0); /* start */
254 avist->frames_hdr_strm = url_ftell(pb); /* remember this offset to fill later */
255 if (url_is_streamed(pb))
256 put_le32(pb, AVI_MAX_RIFF_SIZE); /* FIXME: this may be broken, but who cares */
258 put_le32(pb, 0); /* length, XXX: filled later */
260 /* suggested buffer size */ //FIXME set at the end to largest chunk
261 if(stream->codec_type == AVMEDIA_TYPE_VIDEO)
262 put_le32(pb, 1024 * 1024);
263 else if(stream->codec_type == AVMEDIA_TYPE_AUDIO)
264 put_le32(pb, 12 * 1024);
267 put_le32(pb, -1); /* quality */
268 put_le32(pb, au_ssize); /* sample size */
270 put_le16(pb, stream->width);
271 put_le16(pb, stream->height);
272 ff_end_tag(pb, strh);
274 if(stream->codec_type != AVMEDIA_TYPE_DATA){
275 strf = ff_start_tag(pb, "strf");
276 switch(stream->codec_type) {
277 case AVMEDIA_TYPE_SUBTITLE:
278 // XSUB subtitles behave like video tracks, other subtitles
279 // are not (yet) supported.
280 if (stream->codec_id != CODEC_ID_XSUB) break;
281 case AVMEDIA_TYPE_VIDEO:
282 ff_put_bmp_header(pb, stream, ff_codec_bmp_tags, 0);
284 case AVMEDIA_TYPE_AUDIO:
285 if (ff_put_wav_header(pb, stream) < 0) {
292 ff_end_tag(pb, strf);
293 if ((t = av_metadata_get(s->streams[i]->metadata, "strn", NULL, 0))) {
294 avi_write_info_tag(s->pb, t->key, t->value);
297 //FIXME a limitation of metadata conversion system
298 else if ((t = av_metadata_get(s->streams[i]->metadata, "INAM", NULL, 0))) {
299 avi_write_info_tag(s->pb, "strn", t->value);
304 if (!url_is_streamed(pb)) {
305 unsigned char tag[5];
308 /* Starting to lay out AVI OpenDML master index.
309 * We want to make it JUNK entry for now, since we'd
310 * like to get away without making AVI an OpenDML one
311 * for compatibility reasons.
313 avist->indexes.entry = avist->indexes.ents_allocated = 0;
314 avist->indexes.indx_start = ff_start_tag(pb, "JUNK");
315 put_le16(pb, 4); /* wLongsPerEntry */
316 put_byte(pb, 0); /* bIndexSubType (0 == frame index) */
317 put_byte(pb, 0); /* bIndexType (0 == AVI_INDEX_OF_INDEXES) */
318 put_le32(pb, 0); /* nEntriesInUse (will fill out later on) */
319 put_tag(pb, avi_stream2fourcc(&tag[0], i, stream->codec_type));
321 put_le64(pb, 0); /* dwReserved[3]
322 put_le32(pb, 0); Must be 0. */
323 for (j=0; j < AVI_MASTER_INDEX_SIZE * 2; j++)
325 ff_end_tag(pb, avist->indexes.indx_start);
328 if( stream->codec_type == AVMEDIA_TYPE_VIDEO
329 && s->streams[i]->sample_aspect_ratio.num>0
330 && s->streams[i]->sample_aspect_ratio.den>0){
331 int vprp= ff_start_tag(pb, "vprp");
332 AVRational dar = av_mul_q(s->streams[i]->sample_aspect_ratio,
333 (AVRational){stream->width, stream->height});
335 av_reduce(&num, &den, dar.num, dar.den, 0xFFFF);
337 put_le32(pb, 0); //video format = unknown
338 put_le32(pb, 0); //video standard= unknown
339 put_le32(pb, lrintf(1.0/av_q2d(stream->time_base)));
340 put_le32(pb, stream->width );
341 put_le32(pb, stream->height);
344 put_le32(pb, stream->width );
345 put_le32(pb, stream->height);
346 put_le32(pb, 1); //progressive FIXME
348 put_le32(pb, stream->height);
349 put_le32(pb, stream->width );
350 put_le32(pb, stream->height);
351 put_le32(pb, stream->width );
357 ff_end_tag(pb, vprp);
360 ff_end_tag(pb, list2);
363 if (!url_is_streamed(pb)) {
364 /* AVI could become an OpenDML one, if it grows beyond 2Gb range */
365 avi->odml_list = ff_start_tag(pb, "JUNK");
369 for (i = 0; i < 248; i+= 4)
371 ff_end_tag(pb, avi->odml_list);
374 ff_end_tag(pb, list1);
376 list2 = ff_start_tag(pb, "LIST");
378 for (i = 0; *ff_avi_tags[i]; i++) {
379 if ((t = av_metadata_get(s->metadata, ff_avi_tags[i], NULL, AV_METADATA_MATCH_CASE)))
380 avi_write_info_tag(s->pb, t->key, t->value);
382 ff_end_tag(pb, list2);
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");
393 put_flush_packet(pb);
398 static int avi_write_ix(AVFormatContext *s)
400 ByteIOContext *pb = s->pb;
401 AVIContext *avi = s->priv_data;
403 char ix_tag[] = "ix00";
406 assert(!url_is_streamed(pb));
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[0], i, s->streams[i]->codec->codec_type);
418 /* Writing AVI OpenDML leaf index chunk */
420 put_tag(pb, &ix_tag[0]); /* ix?? */
421 put_le32(pb, avist->indexes.entry * 8 + 24);
423 put_le16(pb, 2); /* wLongsPerEntry */
424 put_byte(pb, 0); /* bIndexSubType (0 == frame index) */
425 put_byte(pb, 1); /* bIndexType (1 == AVI_INDEX_OF_CHUNKS) */
426 put_le32(pb, avist->indexes.entry);
428 put_tag(pb, &tag[0]); /* dwChunkId */
429 put_le64(pb, avi->movi_list);/* qwBaseOffset */
430 put_le32(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 put_le32(pb, ie->pos + 8);
435 put_le32(pb, ((uint32_t)ie->len & ~0x80000000) |
436 (ie->flags & 0x10 ? 0 : 0x80000000));
438 put_flush_packet(pb);
441 /* Updating one entry in the AVI OpenDML master index */
442 url_fseek(pb, avist->indexes.indx_start - 8, SEEK_SET);
443 put_tag(pb, "indx"); /* enabling this entry */
445 put_le32(pb, avi->riff_id); /* nEntriesInUse */
446 url_fskip(pb, 16*avi->riff_id);
447 put_le64(pb, ix); /* qwOffset */
448 put_le32(pb, pos - ix); /* dwSize */
449 put_le32(pb, avist->indexes.entry); /* dwDuration */
451 url_fseek(pb, pos, SEEK_SET);
456 static int avi_write_idx1(AVFormatContext *s)
458 ByteIOContext *pb = s->pb;
459 AVIContext *avi = s->priv_data;
464 if (!url_is_streamed(pb)) {
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[0], stream_id,
492 s->streams[stream_id]->codec->codec_type);
493 put_tag(pb, &tag[0]);
494 put_le32(pb, ie->flags);
495 put_le32(pb, ie->pos);
496 put_le32(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 AVIContext *avi = s->priv_data;
510 ByteIOContext *pb = s->pb;
511 unsigned char tag[5];
512 unsigned int flags=0;
513 const int stream_index= pkt->stream_index;
514 AVIStream *avist= s->streams[stream_index]->priv_data;
515 AVCodecContext *enc= s->streams[stream_index]->codec;
518 // av_log(s, AV_LOG_DEBUG, "%"PRId64" %d %d\n", pkt->dts, avi->packet_count[stream_index], stream_index);
519 while(enc->block_align==0 && pkt->dts != AV_NOPTS_VALUE && 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);
527 // av_log(s, AV_LOG_DEBUG, "dup %"PRId64" %d\n", pkt->dts, avi->packet_count[stream_index]);
529 avist->packet_count++;
531 // Make sure to put an OpenDML chunk when the file size exceeds the limits
532 if (!url_is_streamed(pb) &&
533 (url_ftell(pb) - avi->riff_start > AVI_MAX_RIFF_SIZE)) {
536 ff_end_tag(pb, avi->movi_list);
538 if (avi->riff_id == 1)
541 ff_end_tag(pb, avi->riff_start);
542 avi->movi_list = avi_start_new_riff(s, pb, "AVIX", "movi");
545 avi_stream2fourcc(&tag[0], stream_index, enc->codec_type);
546 if(pkt->flags&AV_PKT_FLAG_KEY)
548 if (enc->codec_type == AVMEDIA_TYPE_AUDIO) {
549 avist->audio_strm_length += size;
552 if (!url_is_streamed(s->pb)) {
553 AVIIndex* idx = &avist->indexes;
554 int cl = idx->entry / AVI_INDEX_CLUSTER_SIZE;
555 int id = idx->entry % AVI_INDEX_CLUSTER_SIZE;
556 if (idx->ents_allocated <= idx->entry) {
557 idx->cluster = av_realloc(idx->cluster, (cl+1)*sizeof(void*));
560 idx->cluster[cl] = av_malloc(AVI_INDEX_CLUSTER_SIZE*sizeof(AVIIentry));
561 if (!idx->cluster[cl])
563 idx->ents_allocated += AVI_INDEX_CLUSTER_SIZE;
566 idx->cluster[cl][id].flags = flags;
567 idx->cluster[cl][id].pos = url_ftell(pb) - avi->movi_list;
568 idx->cluster[cl][id].len = size;
572 put_buffer(pb, tag, 4);
574 put_buffer(pb, pkt->data, size);
578 put_flush_packet(pb);
582 static int avi_write_trailer(AVFormatContext *s)
584 AVIContext *avi = s->priv_data;
585 ByteIOContext *pb = s->pb;
587 int i, j, n, nb_frames;
590 if (!url_is_streamed(pb)){
591 if (avi->riff_id == 1) {
592 ff_end_tag(pb, avi->movi_list);
593 res = avi_write_idx1(s);
594 ff_end_tag(pb, avi->riff_start);
597 ff_end_tag(pb, avi->movi_list);
598 ff_end_tag(pb, avi->riff_start);
600 file_size = url_ftell(pb);
601 url_fseek(pb, avi->odml_list - 8, SEEK_SET);
602 put_tag(pb, "LIST"); /* Making this AVI OpenDML one */
605 for (n=nb_frames=0;n<s->nb_streams;n++) {
606 AVCodecContext *stream = s->streams[n]->codec;
607 AVIStream *avist= s->streams[n]->priv_data;
609 if (stream->codec_type == AVMEDIA_TYPE_VIDEO) {
610 if (nb_frames < avist->packet_count)
611 nb_frames = avist->packet_count;
613 if (stream->codec_id == CODEC_ID_MP2 || stream->codec_id == CODEC_ID_MP3) {
614 nb_frames += avist->packet_count;
618 put_le32(pb, nb_frames);
619 url_fseek(pb, file_size, SEEK_SET);
621 avi_write_counters(s, avi->riff_id);
624 put_flush_packet(pb);
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 avi_muxer = {
639 NULL_IF_CONFIG_SMALL("AVI format"),
648 .codec_tag= (const AVCodecTag* const []){ff_codec_bmp_tags, ff_codec_wav_tags, 0},
649 .flags= AVFMT_VARIABLE_FPS,
650 .metadata_conv = ff_avi_metadata_conv,