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 CodecType type)
90 if (type == CODEC_TYPE_VIDEO) {
93 } else if (type == CODEC_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 == CODEC_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 == CODEC_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 CODEC_TYPE_SUBTITLE:
226 // XSUB subtitles behave like video tracks, other subtitles
227 // are not (yet) supported.
228 if (stream->codec_id != CODEC_ID_XSUB) break;
229 case CODEC_TYPE_VIDEO: put_tag(pb, "vids"); break;
230 case CODEC_TYPE_AUDIO: put_tag(pb, "auds"); break;
231 // case CODEC_TYPE_TEXT : put_tag(pb, "txts"); break;
232 case CODEC_TYPE_DATA : put_tag(pb, "dats"); break;
234 if(stream->codec_type == CODEC_TYPE_VIDEO ||
235 stream->codec_id == CODEC_ID_XSUB)
236 put_le32(pb, stream->codec_tag);
239 put_le32(pb, 0); /* flags */
240 put_le16(pb, 0); /* priority */
241 put_le16(pb, 0); /* language */
242 put_le32(pb, 0); /* initial frame */
244 ff_parse_specific_params(stream, &au_byterate, &au_ssize, &au_scale);
246 put_le32(pb, au_scale); /* scale */
247 put_le32(pb, au_byterate); /* rate */
248 av_set_pts_info(s->streams[i], 64, au_scale, au_byterate);
250 put_le32(pb, 0); /* start */
251 avist->frames_hdr_strm = url_ftell(pb); /* remember this offset to fill later */
252 if (url_is_streamed(pb))
253 put_le32(pb, AVI_MAX_RIFF_SIZE); /* FIXME: this may be broken, but who cares */
255 put_le32(pb, 0); /* length, XXX: filled later */
257 /* suggested buffer size */ //FIXME set at the end to largest chunk
258 if(stream->codec_type == CODEC_TYPE_VIDEO)
259 put_le32(pb, 1024 * 1024);
260 else if(stream->codec_type == CODEC_TYPE_AUDIO)
261 put_le32(pb, 12 * 1024);
264 put_le32(pb, -1); /* quality */
265 put_le32(pb, au_ssize); /* sample size */
267 put_le16(pb, stream->width);
268 put_le16(pb, stream->height);
269 ff_end_tag(pb, strh);
271 if(stream->codec_type != CODEC_TYPE_DATA){
272 strf = ff_start_tag(pb, "strf");
273 switch(stream->codec_type) {
274 case CODEC_TYPE_SUBTITLE:
275 // XSUB subtitles behave like video tracks, other subtitles
276 // are not (yet) supported.
277 if (stream->codec_id != CODEC_ID_XSUB) break;
278 case CODEC_TYPE_VIDEO:
279 ff_put_bmp_header(pb, stream, ff_codec_bmp_tags, 0);
281 case CODEC_TYPE_AUDIO:
282 if (ff_put_wav_header(pb, stream) < 0) {
289 ff_end_tag(pb, strf);
290 if ((t = av_metadata_get(s->streams[i]->metadata, "strn", NULL, 0))) {
291 avi_write_info_tag(s->pb, t->key, t->value);
294 //FIXME a limitation of metadata conversion system
295 else if ((t = av_metadata_get(s->streams[i]->metadata, "INAM", NULL, 0))) {
296 avi_write_info_tag(s->pb, "strn", t->value);
301 if (!url_is_streamed(pb)) {
302 unsigned char tag[5];
305 /* Starting to lay out AVI OpenDML master index.
306 * We want to make it JUNK entry for now, since we'd
307 * like to get away without making AVI an OpenDML one
308 * for compatibility reasons.
310 avist->indexes.entry = avist->indexes.ents_allocated = 0;
311 avist->indexes.indx_start = ff_start_tag(pb, "JUNK");
312 put_le16(pb, 4); /* wLongsPerEntry */
313 put_byte(pb, 0); /* bIndexSubType (0 == frame index) */
314 put_byte(pb, 0); /* bIndexType (0 == AVI_INDEX_OF_INDEXES) */
315 put_le32(pb, 0); /* nEntriesInUse (will fill out later on) */
316 put_tag(pb, avi_stream2fourcc(&tag[0], i, stream->codec_type));
318 put_le64(pb, 0); /* dwReserved[3]
319 put_le32(pb, 0); Must be 0. */
320 for (j=0; j < AVI_MASTER_INDEX_SIZE * 2; j++)
322 ff_end_tag(pb, avist->indexes.indx_start);
325 if( stream->codec_type == CODEC_TYPE_VIDEO
326 && s->streams[i]->sample_aspect_ratio.num>0
327 && s->streams[i]->sample_aspect_ratio.den>0){
328 int vprp= ff_start_tag(pb, "vprp");
329 AVRational dar = av_mul_q(s->streams[i]->sample_aspect_ratio,
330 (AVRational){stream->width, stream->height});
332 av_reduce(&num, &den, dar.num, dar.den, 0xFFFF);
334 put_le32(pb, 0); //video format = unknown
335 put_le32(pb, 0); //video standard= unknown
336 put_le32(pb, lrintf(1.0/av_q2d(stream->time_base)));
337 put_le32(pb, stream->width );
338 put_le32(pb, stream->height);
341 put_le32(pb, stream->width );
342 put_le32(pb, stream->height);
343 put_le32(pb, 1); //progressive FIXME
345 put_le32(pb, stream->height);
346 put_le32(pb, stream->width );
347 put_le32(pb, stream->height);
348 put_le32(pb, stream->width );
354 ff_end_tag(pb, vprp);
357 ff_end_tag(pb, list2);
360 if (!url_is_streamed(pb)) {
361 /* AVI could become an OpenDML one, if it grows beyond 2Gb range */
362 avi->odml_list = ff_start_tag(pb, "JUNK");
366 for (i = 0; i < 248; i+= 4)
368 ff_end_tag(pb, avi->odml_list);
371 ff_end_tag(pb, list1);
373 list2 = ff_start_tag(pb, "LIST");
375 for (i = 0; *ff_avi_tags[i]; i++) {
376 if ((t = av_metadata_get(s->metadata, ff_avi_tags[i], NULL, AV_METADATA_MATCH_CASE)))
377 avi_write_info_tag(s->pb, t->key, t->value);
379 if(!(s->streams[0]->codec->flags & CODEC_FLAG_BITEXACT))
380 avi_write_info_tag(pb, "ISFT", LIBAVFORMAT_IDENT);
381 ff_end_tag(pb, list2);
383 /* some padding for easier tag editing */
384 list2 = ff_start_tag(pb, "JUNK");
385 for (i = 0; i < 1016; i += 4)
387 ff_end_tag(pb, list2);
389 avi->movi_list = ff_start_tag(pb, "LIST");
392 put_flush_packet(pb);
397 static int avi_write_ix(AVFormatContext *s)
399 ByteIOContext *pb = s->pb;
400 AVIContext *avi = s->priv_data;
402 char ix_tag[] = "ix00";
405 assert(!url_is_streamed(pb));
407 if (avi->riff_id > AVI_MASTER_INDEX_SIZE)
410 for (i=0;i<s->nb_streams;i++) {
411 AVIStream *avist= s->streams[i]->priv_data;
414 avi_stream2fourcc(&tag[0], i, s->streams[i]->codec->codec_type);
417 /* Writing AVI OpenDML leaf index chunk */
419 put_tag(pb, &ix_tag[0]); /* ix?? */
420 put_le32(pb, avist->indexes.entry * 8 + 24);
422 put_le16(pb, 2); /* wLongsPerEntry */
423 put_byte(pb, 0); /* bIndexSubType (0 == frame index) */
424 put_byte(pb, 1); /* bIndexType (1 == AVI_INDEX_OF_CHUNKS) */
425 put_le32(pb, avist->indexes.entry);
427 put_tag(pb, &tag[0]); /* dwChunkId */
428 put_le64(pb, avi->movi_list);/* qwBaseOffset */
429 put_le32(pb, 0); /* dwReserved_3 (must be 0) */
431 for (j=0; j<avist->indexes.entry; j++) {
432 AVIIentry* ie = avi_get_ientry(&avist->indexes, j);
433 put_le32(pb, ie->pos + 8);
434 put_le32(pb, ((uint32_t)ie->len & ~0x80000000) |
435 (ie->flags & 0x10 ? 0 : 0x80000000));
437 put_flush_packet(pb);
440 /* Updating one entry in the AVI OpenDML master index */
441 url_fseek(pb, avist->indexes.indx_start - 8, SEEK_SET);
442 put_tag(pb, "indx"); /* enabling this entry */
444 put_le32(pb, avi->riff_id); /* nEntriesInUse */
445 url_fskip(pb, 16*avi->riff_id);
446 put_le64(pb, ix); /* qwOffset */
447 put_le32(pb, pos - ix); /* dwSize */
448 put_le32(pb, avist->indexes.entry); /* dwDuration */
450 url_fseek(pb, pos, SEEK_SET);
455 static int avi_write_idx1(AVFormatContext *s)
457 ByteIOContext *pb = s->pb;
458 AVIContext *avi = s->priv_data;
463 if (!url_is_streamed(pb)) {
465 AVIIentry* ie = 0, *tie;
466 int empty, stream_id = -1;
468 idx_chunk = ff_start_tag(pb, "idx1");
469 for(i=0; i<s->nb_streams; i++){
470 avist= s->streams[i]->priv_data;
476 for (i=0; i<s->nb_streams; i++) {
477 avist= s->streams[i]->priv_data;
478 if (avist->indexes.entry <= avist->entry)
481 tie = avi_get_ientry(&avist->indexes, avist->entry);
482 if (empty || tie->pos < ie->pos) {
489 avist= s->streams[stream_id]->priv_data;
490 avi_stream2fourcc(&tag[0], stream_id,
491 s->streams[stream_id]->codec->codec_type);
492 put_tag(pb, &tag[0]);
493 put_le32(pb, ie->flags);
494 put_le32(pb, ie->pos);
495 put_le32(pb, ie->len);
499 ff_end_tag(pb, idx_chunk);
501 avi_write_counters(s, avi->riff_id);
506 static int avi_write_packet(AVFormatContext *s, AVPacket *pkt)
508 AVIContext *avi = s->priv_data;
509 ByteIOContext *pb = s->pb;
510 unsigned char tag[5];
511 unsigned int flags=0;
512 const int stream_index= pkt->stream_index;
513 AVIStream *avist= s->streams[stream_index]->priv_data;
514 AVCodecContext *enc= s->streams[stream_index]->codec;
517 // av_log(s, AV_LOG_DEBUG, "%"PRId64" %d %d\n", pkt->dts, avi->packet_count[stream_index], stream_index);
518 while(enc->block_align==0 && pkt->dts != AV_NOPTS_VALUE && pkt->dts > avist->packet_count){
519 AVPacket empty_packet;
521 av_init_packet(&empty_packet);
522 empty_packet.size= 0;
523 empty_packet.data= NULL;
524 empty_packet.stream_index= stream_index;
525 avi_write_packet(s, &empty_packet);
526 // av_log(s, AV_LOG_DEBUG, "dup %"PRId64" %d\n", pkt->dts, avi->packet_count[stream_index]);
528 avist->packet_count++;
530 // Make sure to put an OpenDML chunk when the file size exceeds the limits
531 if (!url_is_streamed(pb) &&
532 (url_ftell(pb) - avi->riff_start > AVI_MAX_RIFF_SIZE)) {
535 ff_end_tag(pb, avi->movi_list);
537 if (avi->riff_id == 1)
540 ff_end_tag(pb, avi->riff_start);
541 avi->movi_list = avi_start_new_riff(s, pb, "AVIX", "movi");
544 avi_stream2fourcc(&tag[0], stream_index, enc->codec_type);
545 if(pkt->flags&PKT_FLAG_KEY)
547 if (enc->codec_type == CODEC_TYPE_AUDIO) {
548 avist->audio_strm_length += size;
551 if (!url_is_streamed(s->pb)) {
552 AVIIndex* idx = &avist->indexes;
553 int cl = idx->entry / AVI_INDEX_CLUSTER_SIZE;
554 int id = idx->entry % AVI_INDEX_CLUSTER_SIZE;
555 if (idx->ents_allocated <= idx->entry) {
556 idx->cluster = av_realloc(idx->cluster, (cl+1)*sizeof(void*));
559 idx->cluster[cl] = av_malloc(AVI_INDEX_CLUSTER_SIZE*sizeof(AVIIentry));
560 if (!idx->cluster[cl])
562 idx->ents_allocated += AVI_INDEX_CLUSTER_SIZE;
565 idx->cluster[cl][id].flags = flags;
566 idx->cluster[cl][id].pos = url_ftell(pb) - avi->movi_list;
567 idx->cluster[cl][id].len = size;
571 put_buffer(pb, tag, 4);
573 put_buffer(pb, pkt->data, size);
577 put_flush_packet(pb);
581 static int avi_write_trailer(AVFormatContext *s)
583 AVIContext *avi = s->priv_data;
584 ByteIOContext *pb = s->pb;
586 int i, j, n, nb_frames;
589 if (!url_is_streamed(pb)){
590 if (avi->riff_id == 1) {
591 ff_end_tag(pb, avi->movi_list);
592 res = avi_write_idx1(s);
593 ff_end_tag(pb, avi->riff_start);
596 ff_end_tag(pb, avi->movi_list);
597 ff_end_tag(pb, avi->riff_start);
599 file_size = url_ftell(pb);
600 url_fseek(pb, avi->odml_list - 8, SEEK_SET);
601 put_tag(pb, "LIST"); /* Making this AVI OpenDML one */
604 for (n=nb_frames=0;n<s->nb_streams;n++) {
605 AVCodecContext *stream = s->streams[n]->codec;
606 AVIStream *avist= s->streams[n]->priv_data;
608 if (stream->codec_type == CODEC_TYPE_VIDEO) {
609 if (nb_frames < avist->packet_count)
610 nb_frames = avist->packet_count;
612 if (stream->codec_id == CODEC_ID_MP2 || stream->codec_id == CODEC_ID_MP3) {
613 nb_frames += avist->packet_count;
617 put_le32(pb, nb_frames);
618 url_fseek(pb, file_size, SEEK_SET);
620 avi_write_counters(s, avi->riff_id);
623 put_flush_packet(pb);
625 for (i=0; i<s->nb_streams; i++) {
626 AVIStream *avist= s->streams[i]->priv_data;
627 for (j=0; j<avist->indexes.ents_allocated/AVI_INDEX_CLUSTER_SIZE; j++)
628 av_free(avist->indexes.cluster[j]);
629 av_freep(&avist->indexes.cluster);
630 avist->indexes.ents_allocated = avist->indexes.entry = 0;
636 AVOutputFormat avi_muxer = {
638 NULL_IF_CONFIG_SMALL("AVI format"),
647 .codec_tag= (const AVCodecTag* const []){ff_codec_bmp_tags, ff_codec_wav_tags, 0},
648 .flags= AVFMT_VARIABLE_FPS,
649 .metadata_conv = ff_avi_metadata_conv,