rename AVMetaData to AVMetadata and meta_data to metadata
[ffmpeg.git] / libavformat / avienc.c
1 /*
2  * AVI muxer
3  * Copyright (c) 2000 Fabrice Bellard.
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21 #include "avformat.h"
22 #include "avi.h"
23 #include "riff.h"
24
25 /*
26  * TODO:
27  *  - fill all fields if non streamed (nb_frames for example)
28  */
29
30 #ifdef CONFIG_AVI_MUXER
31 typedef struct AVIIentry {
32     unsigned int flags, pos, len;
33 } AVIIentry;
34
35 #define AVI_INDEX_CLUSTER_SIZE 16384
36
37 typedef struct AVIIndex {
38     int64_t     indx_start;
39     int         entry;
40     int         ents_allocated;
41     AVIIentry** cluster;
42 } AVIIndex;
43
44 typedef struct {
45     int64_t riff_start, movi_list, odml_list;
46     int64_t frames_hdr_all, frames_hdr_strm[MAX_STREAMS];
47     int audio_strm_length[MAX_STREAMS];
48     int riff_id;
49     int packet_count[MAX_STREAMS];
50
51     AVIIndex indexes[MAX_STREAMS];
52 } AVIContext;
53
54 static inline AVIIentry* avi_get_ientry(AVIIndex* idx, int ent_id)
55 {
56     int cl = ent_id / AVI_INDEX_CLUSTER_SIZE;
57     int id = ent_id % AVI_INDEX_CLUSTER_SIZE;
58     return &idx->cluster[cl][id];
59 }
60
61 static int64_t avi_start_new_riff(AVIContext *avi, ByteIOContext *pb,
62                                   const char* riff_tag, const char* list_tag)
63 {
64     int64_t loff;
65     int i;
66
67     avi->riff_id++;
68     for (i=0; i<MAX_STREAMS; i++)
69          avi->indexes[i].entry = 0;
70
71     avi->riff_start = start_tag(pb, "RIFF");
72     put_tag(pb, riff_tag);
73     loff = start_tag(pb, "LIST");
74     put_tag(pb, list_tag);
75     return loff;
76 }
77
78 static char* avi_stream2fourcc(char* tag, int index, enum CodecType type)
79 {
80     tag[0] = '0';
81     tag[1] = '0' + index;
82     if (type == CODEC_TYPE_VIDEO) {
83         tag[2] = 'd';
84         tag[3] = 'c';
85     } else {
86         tag[2] = 'w';
87         tag[3] = 'b';
88     }
89     tag[4] = '\0';
90     return tag;
91 }
92
93 static void avi_write_info_tag(ByteIOContext *pb, const char *tag, const char *str)
94 {
95     int len = strlen(str);
96     if (len > 0) {
97         len++;
98         put_tag(pb, tag);
99         put_le32(pb, len);
100         put_strz(pb, str);
101         if (len & 1)
102             put_byte(pb, 0);
103     }
104 }
105
106 static void avi_write_info_tag2(AVFormatContext *s, const char *fourcc, const char *key1, const char *key2)
107 {
108     AVMetadataTag *tag= av_metadata_get(s->metadata, key1, NULL, AV_METADATA_IGNORE_CASE);
109     if(!tag && key2)
110         tag= av_metadata_get(s->metadata, key2, NULL, AV_METADATA_IGNORE_CASE);
111     if(tag)
112         avi_write_info_tag(s->pb, fourcc, tag->value);
113 }
114
115 static int avi_write_counters(AVFormatContext* s, int riff_id)
116 {
117     ByteIOContext *pb = s->pb;
118     AVIContext *avi = s->priv_data;
119     int n, au_byterate, au_ssize, au_scale, nb_frames = 0;
120     int64_t file_size;
121     AVCodecContext* stream;
122
123     file_size = url_ftell(pb);
124     for(n = 0; n < s->nb_streams; n++) {
125         assert(avi->frames_hdr_strm[n]);
126         stream = s->streams[n]->codec;
127         url_fseek(pb, avi->frames_hdr_strm[n], SEEK_SET);
128         ff_parse_specific_params(stream, &au_byterate, &au_ssize, &au_scale);
129         if(au_ssize == 0) {
130             put_le32(pb, avi->packet_count[n]);
131         } else {
132             put_le32(pb, avi->audio_strm_length[n] / au_ssize);
133         }
134         if(stream->codec_type == CODEC_TYPE_VIDEO)
135             nb_frames = FFMAX(nb_frames, avi->packet_count[n]);
136     }
137     if(riff_id == 1) {
138         assert(avi->frames_hdr_all);
139         url_fseek(pb, avi->frames_hdr_all, SEEK_SET);
140         put_le32(pb, nb_frames);
141     }
142     url_fseek(pb, file_size, SEEK_SET);
143
144     return 0;
145 }
146
147 static int avi_write_header(AVFormatContext *s)
148 {
149     AVIContext *avi = s->priv_data;
150     ByteIOContext *pb = s->pb;
151     int bitrate, n, i, nb_frames, au_byterate, au_ssize, au_scale;
152     AVCodecContext *stream, *video_enc;
153     int64_t list1, list2, strh, strf;
154
155     /* header list */
156     avi->riff_id = 0;
157     list1 = avi_start_new_riff(avi, pb, "AVI ", "hdrl");
158
159     /* avi header */
160     put_tag(pb, "avih");
161     put_le32(pb, 14 * 4);
162     bitrate = 0;
163
164     video_enc = NULL;
165     for(n=0;n<s->nb_streams;n++) {
166         stream = s->streams[n]->codec;
167         bitrate += stream->bit_rate;
168         if (stream->codec_type == CODEC_TYPE_VIDEO)
169             video_enc = stream;
170     }
171
172     nb_frames = 0;
173
174     if(video_enc){
175         put_le32(pb, (uint32_t)(INT64_C(1000000) * video_enc->time_base.num / video_enc->time_base.den));
176     } else {
177         put_le32(pb, 0);
178     }
179     put_le32(pb, bitrate / 8); /* XXX: not quite exact */
180     put_le32(pb, 0); /* padding */
181     if (url_is_streamed(pb))
182         put_le32(pb, AVIF_TRUSTCKTYPE | AVIF_ISINTERLEAVED); /* flags */
183     else
184         put_le32(pb, AVIF_TRUSTCKTYPE | AVIF_HASINDEX | AVIF_ISINTERLEAVED); /* flags */
185     avi->frames_hdr_all = url_ftell(pb); /* remember this offset to fill later */
186     put_le32(pb, nb_frames); /* nb frames, filled later */
187     put_le32(pb, 0); /* initial frame */
188     put_le32(pb, s->nb_streams); /* nb streams */
189     put_le32(pb, 1024 * 1024); /* suggested buffer size */
190     if(video_enc){
191         put_le32(pb, video_enc->width);
192         put_le32(pb, video_enc->height);
193     } else {
194         put_le32(pb, 0);
195         put_le32(pb, 0);
196     }
197     put_le32(pb, 0); /* reserved */
198     put_le32(pb, 0); /* reserved */
199     put_le32(pb, 0); /* reserved */
200     put_le32(pb, 0); /* reserved */
201
202     /* stream list */
203     for(i=0;i<n;i++) {
204         list2 = start_tag(pb, "LIST");
205         put_tag(pb, "strl");
206
207         stream = s->streams[i]->codec;
208
209         /* stream generic header */
210         strh = start_tag(pb, "strh");
211         switch(stream->codec_type) {
212         case CODEC_TYPE_VIDEO: put_tag(pb, "vids"); break;
213         case CODEC_TYPE_AUDIO: put_tag(pb, "auds"); break;
214 //        case CODEC_TYPE_TEXT : put_tag(pb, "txts"); break;
215         case CODEC_TYPE_DATA : put_tag(pb, "dats"); break;
216         }
217         if(stream->codec_type == CODEC_TYPE_VIDEO)
218             put_le32(pb, stream->codec_tag);
219         else
220             put_le32(pb, 1);
221         put_le32(pb, 0); /* flags */
222         put_le16(pb, 0); /* priority */
223         put_le16(pb, 0); /* language */
224         put_le32(pb, 0); /* initial frame */
225
226         ff_parse_specific_params(stream, &au_byterate, &au_ssize, &au_scale);
227
228         put_le32(pb, au_scale); /* scale */
229         put_le32(pb, au_byterate); /* rate */
230         av_set_pts_info(s->streams[i], 64, au_scale, au_byterate);
231
232         put_le32(pb, 0); /* start */
233         avi->frames_hdr_strm[i] = url_ftell(pb); /* remember this offset to fill later */
234         if (url_is_streamed(pb))
235             put_le32(pb, AVI_MAX_RIFF_SIZE); /* FIXME: this may be broken, but who cares */
236         else
237             put_le32(pb, 0); /* length, XXX: filled later */
238
239         /* suggested buffer size */ //FIXME set at the end to largest chunk
240         if(stream->codec_type == CODEC_TYPE_VIDEO)
241             put_le32(pb, 1024 * 1024);
242         else if(stream->codec_type == CODEC_TYPE_AUDIO)
243             put_le32(pb, 12 * 1024);
244         else
245             put_le32(pb, 0);
246         put_le32(pb, -1); /* quality */
247         put_le32(pb, au_ssize); /* sample size */
248         put_le32(pb, 0);
249         put_le16(pb, stream->width);
250         put_le16(pb, stream->height);
251         end_tag(pb, strh);
252
253       if(stream->codec_type != CODEC_TYPE_DATA){
254         strf = start_tag(pb, "strf");
255         switch(stream->codec_type) {
256         case CODEC_TYPE_VIDEO:
257             put_bmp_header(pb, stream, codec_bmp_tags, 0);
258             break;
259         case CODEC_TYPE_AUDIO:
260             if (put_wav_header(pb, stream) < 0) {
261                 return -1;
262             }
263             break;
264         default:
265             return -1;
266         }
267         end_tag(pb, strf);
268       }
269
270         if (!url_is_streamed(pb)) {
271             unsigned char tag[5];
272             int j;
273
274             /* Starting to lay out AVI OpenDML master index.
275              * We want to make it JUNK entry for now, since we'd
276              * like to get away without making AVI an OpenDML one
277              * for compatibility reasons.
278              */
279             avi->indexes[i].entry = avi->indexes[i].ents_allocated = 0;
280             avi->indexes[i].indx_start = start_tag(pb, "JUNK");
281             put_le16(pb, 4);        /* wLongsPerEntry */
282             put_byte(pb, 0);        /* bIndexSubType (0 == frame index) */
283             put_byte(pb, 0);        /* bIndexType (0 == AVI_INDEX_OF_INDEXES) */
284             put_le32(pb, 0);        /* nEntriesInUse (will fill out later on) */
285             put_tag(pb, avi_stream2fourcc(&tag[0], i, stream->codec_type));
286                                     /* dwChunkId */
287             put_le64(pb, 0);        /* dwReserved[3]
288             put_le32(pb, 0);           Must be 0.    */
289             for (j=0; j < AVI_MASTER_INDEX_SIZE * 2; j++)
290                  put_le64(pb, 0);
291             end_tag(pb, avi->indexes[i].indx_start);
292         }
293
294         if(   stream->codec_type == CODEC_TYPE_VIDEO
295            && s->streams[i]->sample_aspect_ratio.num>0
296            && s->streams[i]->sample_aspect_ratio.den>0){
297             int vprp= start_tag(pb, "vprp");
298             AVRational dar = av_mul_q(s->streams[i]->sample_aspect_ratio,
299                                       (AVRational){stream->width, stream->height});
300             int num, den;
301             av_reduce(&num, &den, dar.num, dar.den, 0xFFFF);
302
303             put_le32(pb, 0); //video format  = unknown
304             put_le32(pb, 0); //video standard= unknown
305             put_le32(pb, lrintf(1.0/av_q2d(stream->time_base)));
306             put_le32(pb, stream->width );
307             put_le32(pb, stream->height);
308             put_le16(pb, den);
309             put_le16(pb, num);
310             put_le32(pb, stream->width );
311             put_le32(pb, stream->height);
312             put_le32(pb, 1); //progressive FIXME
313
314             put_le32(pb, stream->height);
315             put_le32(pb, stream->width );
316             put_le32(pb, stream->height);
317             put_le32(pb, stream->width );
318             put_le32(pb, 0);
319             put_le32(pb, 0);
320
321             put_le32(pb, 0);
322             put_le32(pb, 0);
323             end_tag(pb, vprp);
324         }
325
326         end_tag(pb, list2);
327     }
328
329     if (!url_is_streamed(pb)) {
330         /* AVI could become an OpenDML one, if it grows beyond 2Gb range */
331         avi->odml_list = start_tag(pb, "JUNK");
332         put_tag(pb, "odml");
333         put_tag(pb, "dmlh");
334         put_le32(pb, 248);
335         for (i = 0; i < 248; i+= 4)
336              put_le32(pb, 0);
337         end_tag(pb, avi->odml_list);
338     }
339
340     end_tag(pb, list1);
341
342     list2 = start_tag(pb, "LIST");
343     put_tag(pb, "INFO");
344     avi_write_info_tag2(s, "INAM", "Title", NULL);
345     avi_write_info_tag2(s, "IART", "Artist", "Author");
346     avi_write_info_tag2(s, "ICOP", "Copyright", NULL);
347     avi_write_info_tag2(s, "ICMT", "Comment", NULL);
348     avi_write_info_tag2(s, "IPRD", "Album", NULL);
349     avi_write_info_tag2(s, "IGNR", "Genre", NULL);
350     avi_write_info_tag2(s, "IPRT", "Track", NULL);
351     if(!(s->streams[0]->codec->flags & CODEC_FLAG_BITEXACT))
352         avi_write_info_tag(pb, "ISFT", LIBAVFORMAT_IDENT);
353     end_tag(pb, list2);
354
355     /* some padding for easier tag editing */
356     list2 = start_tag(pb, "JUNK");
357     for (i = 0; i < 1016; i += 4)
358         put_le32(pb, 0);
359     end_tag(pb, list2);
360
361     avi->movi_list = start_tag(pb, "LIST");
362     put_tag(pb, "movi");
363
364     put_flush_packet(pb);
365
366     return 0;
367 }
368
369 static int avi_write_ix(AVFormatContext *s)
370 {
371     ByteIOContext *pb = s->pb;
372     AVIContext *avi = s->priv_data;
373     char tag[5];
374     char ix_tag[] = "ix00";
375     int i, j;
376
377     assert(!url_is_streamed(pb));
378
379     if (avi->riff_id > AVI_MASTER_INDEX_SIZE)
380         return -1;
381
382     for (i=0;i<s->nb_streams;i++) {
383          int64_t ix, pos;
384
385          avi_stream2fourcc(&tag[0], i, s->streams[i]->codec->codec_type);
386          ix_tag[3] = '0' + i;
387
388          /* Writing AVI OpenDML leaf index chunk */
389          ix = url_ftell(pb);
390          put_tag(pb, &ix_tag[0]);     /* ix?? */
391          put_le32(pb, avi->indexes[i].entry * 8 + 24);
392                                       /* chunk size */
393          put_le16(pb, 2);             /* wLongsPerEntry */
394          put_byte(pb, 0);             /* bIndexSubType (0 == frame index) */
395          put_byte(pb, 1);             /* bIndexType (1 == AVI_INDEX_OF_CHUNKS) */
396          put_le32(pb, avi->indexes[i].entry);
397                                       /* nEntriesInUse */
398          put_tag(pb, &tag[0]);        /* dwChunkId */
399          put_le64(pb, avi->movi_list);/* qwBaseOffset */
400          put_le32(pb, 0);             /* dwReserved_3 (must be 0) */
401
402          for (j=0; j<avi->indexes[i].entry; j++) {
403              AVIIentry* ie = avi_get_ientry(&avi->indexes[i], j);
404              put_le32(pb, ie->pos + 8);
405              put_le32(pb, ((uint32_t)ie->len & ~0x80000000) |
406                           (ie->flags & 0x10 ? 0 : 0x80000000));
407          }
408          put_flush_packet(pb);
409          pos = url_ftell(pb);
410
411          /* Updating one entry in the AVI OpenDML master index */
412          url_fseek(pb, avi->indexes[i].indx_start - 8, SEEK_SET);
413          put_tag(pb, "indx");                 /* enabling this entry */
414          url_fskip(pb, 8);
415          put_le32(pb, avi->riff_id);          /* nEntriesInUse */
416          url_fskip(pb, 16*avi->riff_id);
417          put_le64(pb, ix);                    /* qwOffset */
418          put_le32(pb, pos - ix);              /* dwSize */
419          put_le32(pb, avi->indexes[i].entry); /* dwDuration */
420
421          url_fseek(pb, pos, SEEK_SET);
422     }
423     return 0;
424 }
425
426 static int avi_write_idx1(AVFormatContext *s)
427 {
428     ByteIOContext *pb = s->pb;
429     AVIContext *avi = s->priv_data;
430     int64_t idx_chunk;
431     int i;
432     char tag[5];
433
434     if (!url_is_streamed(pb)) {
435         AVIIentry* ie = 0, *tie;
436         int entry[MAX_STREAMS];
437         int empty, stream_id = -1;
438
439         idx_chunk = start_tag(pb, "idx1");
440         memset(&entry[0], 0, sizeof(entry));
441         do {
442             empty = 1;
443             for (i=0; i<s->nb_streams; i++) {
444                  if (avi->indexes[i].entry <= entry[i])
445                      continue;
446
447                  tie = avi_get_ientry(&avi->indexes[i], entry[i]);
448                  if (empty || tie->pos < ie->pos) {
449                      ie = tie;
450                      stream_id = i;
451                  }
452                  empty = 0;
453             }
454             if (!empty) {
455                 avi_stream2fourcc(&tag[0], stream_id,
456                                   s->streams[stream_id]->codec->codec_type);
457                 put_tag(pb, &tag[0]);
458                 put_le32(pb, ie->flags);
459                 put_le32(pb, ie->pos);
460                 put_le32(pb, ie->len);
461                 entry[stream_id]++;
462             }
463         } while (!empty);
464         end_tag(pb, idx_chunk);
465
466         avi_write_counters(s, avi->riff_id);
467     }
468     return 0;
469 }
470
471 static int avi_write_packet(AVFormatContext *s, AVPacket *pkt)
472 {
473     AVIContext *avi = s->priv_data;
474     ByteIOContext *pb = s->pb;
475     unsigned char tag[5];
476     unsigned int flags=0;
477     const int stream_index= pkt->stream_index;
478     AVCodecContext *enc= s->streams[stream_index]->codec;
479     int size= pkt->size;
480
481 //    av_log(s, AV_LOG_DEBUG, "%"PRId64" %d %d\n", pkt->dts, avi->packet_count[stream_index], stream_index);
482     while(enc->block_align==0 && pkt->dts != AV_NOPTS_VALUE && pkt->dts > avi->packet_count[stream_index]){
483         AVPacket empty_packet;
484
485         av_init_packet(&empty_packet);
486         empty_packet.size= 0;
487         empty_packet.data= NULL;
488         empty_packet.stream_index= stream_index;
489         avi_write_packet(s, &empty_packet);
490 //        av_log(s, AV_LOG_DEBUG, "dup %"PRId64" %d\n", pkt->dts, avi->packet_count[stream_index]);
491     }
492     avi->packet_count[stream_index]++;
493
494     // Make sure to put an OpenDML chunk when the file size exceeds the limits
495     if (!url_is_streamed(pb) &&
496         (url_ftell(pb) - avi->riff_start > AVI_MAX_RIFF_SIZE)) {
497
498         avi_write_ix(s);
499         end_tag(pb, avi->movi_list);
500
501         if (avi->riff_id == 1)
502             avi_write_idx1(s);
503
504         end_tag(pb, avi->riff_start);
505         avi->movi_list = avi_start_new_riff(avi, pb, "AVIX", "movi");
506     }
507
508     avi_stream2fourcc(&tag[0], stream_index, enc->codec_type);
509     if(pkt->flags&PKT_FLAG_KEY)
510         flags = 0x10;
511     if (enc->codec_type == CODEC_TYPE_AUDIO) {
512        avi->audio_strm_length[stream_index] += size;
513     }
514
515     if (!url_is_streamed(s->pb)) {
516         AVIIndex* idx = &avi->indexes[stream_index];
517         int cl = idx->entry / AVI_INDEX_CLUSTER_SIZE;
518         int id = idx->entry % AVI_INDEX_CLUSTER_SIZE;
519         if (idx->ents_allocated <= idx->entry) {
520             idx->cluster = av_realloc(idx->cluster, (cl+1)*sizeof(void*));
521             if (!idx->cluster)
522                 return -1;
523             idx->cluster[cl] = av_malloc(AVI_INDEX_CLUSTER_SIZE*sizeof(AVIIentry));
524             if (!idx->cluster[cl])
525                 return -1;
526             idx->ents_allocated += AVI_INDEX_CLUSTER_SIZE;
527         }
528
529         idx->cluster[cl][id].flags = flags;
530         idx->cluster[cl][id].pos = url_ftell(pb) - avi->movi_list;
531         idx->cluster[cl][id].len = size;
532         idx->entry++;
533     }
534
535     put_buffer(pb, tag, 4);
536     put_le32(pb, size);
537     put_buffer(pb, pkt->data, size);
538     if (size & 1)
539         put_byte(pb, 0);
540
541     put_flush_packet(pb);
542     return 0;
543 }
544
545 static int avi_write_trailer(AVFormatContext *s)
546 {
547     AVIContext *avi = s->priv_data;
548     ByteIOContext *pb = s->pb;
549     int res = 0;
550     int i, j, n, nb_frames;
551     int64_t file_size;
552
553     if (!url_is_streamed(pb)){
554         if (avi->riff_id == 1) {
555             end_tag(pb, avi->movi_list);
556             res = avi_write_idx1(s);
557             end_tag(pb, avi->riff_start);
558         } else {
559             avi_write_ix(s);
560             end_tag(pb, avi->movi_list);
561             end_tag(pb, avi->riff_start);
562
563             file_size = url_ftell(pb);
564             url_fseek(pb, avi->odml_list - 8, SEEK_SET);
565             put_tag(pb, "LIST"); /* Making this AVI OpenDML one */
566             url_fskip(pb, 16);
567
568             for (n=nb_frames=0;n<s->nb_streams;n++) {
569                 AVCodecContext *stream = s->streams[n]->codec;
570                 if (stream->codec_type == CODEC_TYPE_VIDEO) {
571                     if (nb_frames < avi->packet_count[n])
572                         nb_frames = avi->packet_count[n];
573                 } else {
574                     if (stream->codec_id == CODEC_ID_MP2 || stream->codec_id == CODEC_ID_MP3) {
575                         nb_frames += avi->packet_count[n];
576                     }
577                 }
578             }
579             put_le32(pb, nb_frames);
580             url_fseek(pb, file_size, SEEK_SET);
581
582             avi_write_counters(s, avi->riff_id);
583         }
584     }
585     put_flush_packet(pb);
586
587     for (i=0; i<MAX_STREAMS; i++) {
588          for (j=0; j<avi->indexes[i].ents_allocated/AVI_INDEX_CLUSTER_SIZE; j++)
589               av_free(avi->indexes[i].cluster[j]);
590          av_free(avi->indexes[i].cluster);
591          avi->indexes[i].cluster = NULL;
592          avi->indexes[i].ents_allocated = avi->indexes[i].entry = 0;
593     }
594
595     return res;
596 }
597
598 AVOutputFormat avi_muxer = {
599     "avi",
600     NULL_IF_CONFIG_SMALL("AVI format"),
601     "video/x-msvideo",
602     "avi",
603     sizeof(AVIContext),
604     CODEC_ID_MP2,
605     CODEC_ID_MPEG4,
606     avi_write_header,
607     avi_write_packet,
608     avi_write_trailer,
609     .codec_tag= (const AVCodecTag* const []){codec_bmp_tags, codec_wav_tags, 0},
610 };
611 #endif //CONFIG_AVI_MUXER