3 * Copyright (c) 2001, 2002 Fabrice Bellard
6 * Copyright (c) 2012 Paul B Mahol
8 * WAV muxer RF64 support
9 * Copyright (c) 2013 Daniel Verkamp <daniel@drv.nu>
11 * This file is part of FFmpeg.
13 * FFmpeg is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU Lesser General Public
15 * License as published by the Free Software Foundation; either
16 * version 2.1 of the License, or (at your option) any later version.
18 * FFmpeg is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 * Lesser General Public License for more details.
23 * You should have received a copy of the GNU Lesser General Public
24 * License along with FFmpeg; if not, write to the Free Software
25 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
31 #include "libavutil/dict.h"
32 #include "libavutil/common.h"
33 #include "libavutil/mathematics.h"
34 #include "libavutil/opt.h"
38 #include "avio_internal.h"
42 #define RF64_AUTO (-1)
46 typedef struct WAVMuxContext {
59 static inline void bwf_write_bext_string(AVFormatContext *s, const char *key, int maxlen)
61 AVDictionaryEntry *tag;
64 if (tag = av_dict_get(s->metadata, key, NULL, 0)) {
65 len = strlen(tag->value);
66 len = FFMIN(len, maxlen);
67 avio_write(s->pb, tag->value, len);
70 ffio_fill(s->pb, 0, maxlen - len);
73 static void bwf_write_bext_chunk(AVFormatContext *s)
75 AVDictionaryEntry *tmp_tag;
76 uint64_t time_reference = 0;
77 int64_t bext = ff_start_tag(s->pb, "bext");
79 bwf_write_bext_string(s, "description", 256);
80 bwf_write_bext_string(s, "originator", 32);
81 bwf_write_bext_string(s, "originator_reference", 32);
82 bwf_write_bext_string(s, "origination_date", 10);
83 bwf_write_bext_string(s, "origination_time", 8);
85 if (tmp_tag = av_dict_get(s->metadata, "time_reference", NULL, 0))
86 time_reference = strtoll(tmp_tag->value, NULL, 10);
87 avio_wl64(s->pb, time_reference);
88 avio_wl16(s->pb, 1); // set version to 1
90 if (tmp_tag = av_dict_get(s->metadata, "umid", NULL, 0)) {
91 unsigned char umidpart_str[17] = {0};
94 int len = strlen(tmp_tag->value+2);
96 for (i = 0; i < len/16; i++) {
97 memcpy(umidpart_str, tmp_tag->value + 2 + (i*16), 16);
98 umidpart = strtoll(umidpart_str, NULL, 16);
99 avio_wb64(s->pb, umidpart);
101 ffio_fill(s->pb, 0, 64 - i*8);
103 ffio_fill(s->pb, 0, 64); // zero UMID
105 ffio_fill(s->pb, 0, 190); // Reserved
107 if (tmp_tag = av_dict_get(s->metadata, "coding_history", NULL, 0))
108 avio_put_str(s->pb, tmp_tag->value);
110 ff_end_tag(s->pb, bext);
113 static int wav_write_header(AVFormatContext *s)
115 WAVMuxContext *wav = s->priv_data;
116 AVIOContext *pb = s->pb;
119 if (s->nb_streams != 1) {
120 av_log(s, AV_LOG_ERROR, "WAVE files have exactly one stream\n");
121 return AVERROR(EINVAL);
124 if (wav->rf64 == RF64_ALWAYS) {
125 ffio_wfourcc(pb, "RF64");
126 avio_wl32(pb, -1); /* RF64 chunk size: use size in ds64 */
128 ffio_wfourcc(pb, "RIFF");
129 avio_wl32(pb, 0); /* file length */
132 ffio_wfourcc(pb, "WAVE");
134 if (wav->rf64 != RF64_NEVER) {
135 /* write empty ds64 chunk or JUNK chunk to reserve space for ds64 */
136 ffio_wfourcc(pb, wav->rf64 == RF64_ALWAYS ? "ds64" : "JUNK");
137 avio_wl32(pb, 28); /* chunk size */
138 wav->ds64 = avio_tell(pb);
139 ffio_fill(pb, 0, 28);
143 fmt = ff_start_tag(pb, "fmt ");
144 if (ff_put_wav_header(pb, s->streams[0]->codec) < 0) {
145 av_log(s, AV_LOG_ERROR, "%s codec not supported in WAVE format\n",
146 s->streams[0]->codec->codec ? s->streams[0]->codec->codec->name : "NONE");
151 if (s->streams[0]->codec->codec_tag != 0x01 /* hence for all other than PCM */
152 && s->pb->seekable) {
153 wav->fact_pos = ff_start_tag(pb, "fact");
155 ff_end_tag(pb, wav->fact_pos);
159 bwf_write_bext_chunk(s);
161 avpriv_set_pts_info(s->streams[0], 64, 1, s->streams[0]->codec->sample_rate);
162 wav->maxpts = wav->last_duration = 0;
163 wav->minpts = INT64_MAX;
166 ff_riff_write_info(s);
169 wav->data = ff_start_tag(pb, "data");
176 static int wav_write_packet(AVFormatContext *s, AVPacket *pkt)
178 AVIOContext *pb = s->pb;
179 WAVMuxContext *wav = s->priv_data;
180 avio_write(pb, pkt->data, pkt->size);
181 if(pkt->pts != AV_NOPTS_VALUE) {
182 wav->minpts = FFMIN(wav->minpts, pkt->pts);
183 wav->maxpts = FFMAX(wav->maxpts, pkt->pts);
184 wav->last_duration = pkt->duration;
186 av_log(s, AV_LOG_ERROR, "wav_write_packet: NOPTS\n");
190 static int wav_write_trailer(AVFormatContext *s)
192 AVIOContext *pb = s->pb;
193 WAVMuxContext *wav = s->priv_data;
194 int64_t file_size, data_size;
195 int64_t number_of_samples = 0;
200 if (s->pb->seekable) {
201 /* update file size */
202 file_size = avio_tell(pb);
203 data_size = file_size - wav->data;
204 if (wav->rf64 == RF64_ALWAYS || (wav->rf64 == RF64_AUTO && file_size - 8 > UINT32_MAX)) {
207 avio_seek(pb, 4, SEEK_SET);
208 avio_wl32(pb, (uint32_t)(file_size - 8));
209 avio_seek(pb, file_size, SEEK_SET);
211 ff_end_tag(pb, wav->data);
215 number_of_samples = av_rescale(wav->maxpts - wav->minpts + wav->last_duration,
216 s->streams[0]->codec->sample_rate * (int64_t)s->streams[0]->time_base.num,
217 s->streams[0]->time_base.den);
219 if(s->streams[0]->codec->codec_tag != 0x01) {
220 /* Update num_samps in fact chunk */
221 avio_seek(pb, wav->fact_pos, SEEK_SET);
222 if (rf64 || (wav->rf64 == RF64_AUTO && number_of_samples > UINT32_MAX)) {
226 avio_wl32(pb, number_of_samples);
227 avio_seek(pb, file_size, SEEK_SET);
233 /* overwrite RIFF with RF64 */
234 avio_seek(pb, 0, SEEK_SET);
235 ffio_wfourcc(pb, "RF64");
238 /* write ds64 chunk (overwrite JUNK if rf64 == RF64_AUTO) */
239 avio_seek(pb, wav->ds64 - 8, SEEK_SET);
240 ffio_wfourcc(pb, "ds64");
241 avio_wl32(pb, 28); /* ds64 chunk size */
242 avio_wl64(pb, file_size - 8); /* RF64 chunk size */
243 avio_wl64(pb, data_size); /* data chunk size */
244 avio_wl64(pb, number_of_samples); /* fact chunk number of samples */
245 avio_wl32(pb, 0); /* number of table entries for non-'data' chunks */
247 /* write -1 in data chunk size */
248 avio_seek(pb, wav->data - 4, SEEK_SET);
251 avio_seek(pb, file_size, SEEK_SET);
258 #define OFFSET(x) offsetof(WAVMuxContext, x)
259 #define ENC AV_OPT_FLAG_ENCODING_PARAM
260 static const AVOption options[] = {
261 { "write_bext", "Write BEXT chunk.", OFFSET(write_bext), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, ENC },
262 { "rf64", "Use RF64 header rather than RIFF for large files.", OFFSET(rf64), AV_OPT_TYPE_INT, { .i64 = RF64_NEVER },-1, 1, ENC, "rf64" },
263 { "auto", "Write RF64 header if file grows large enough.", 0, AV_OPT_TYPE_CONST, { .i64 = RF64_AUTO }, 0, 0, ENC, "rf64" },
264 { "always", "Always write RF64 header regardless of file size.", 0, AV_OPT_TYPE_CONST, { .i64 = RF64_ALWAYS }, 0, 0, ENC, "rf64" },
265 { "never", "Never write RF64 header regardless of file size.", 0, AV_OPT_TYPE_CONST, { .i64 = RF64_NEVER }, 0, 0, ENC, "rf64" },
269 static const AVClass wav_muxer_class = {
270 .class_name = "WAV muxer",
271 .item_name = av_default_item_name,
273 .version = LIBAVUTIL_VERSION_INT,
276 AVOutputFormat ff_wav_muxer = {
278 .long_name = NULL_IF_CONFIG_SMALL("WAV / WAVE (Waveform Audio)"),
279 .mime_type = "audio/x-wav",
281 .priv_data_size = sizeof(WAVMuxContext),
282 .audio_codec = AV_CODEC_ID_PCM_S16LE,
283 .video_codec = AV_CODEC_ID_NONE,
284 .write_header = wav_write_header,
285 .write_packet = wav_write_packet,
286 .write_trailer = wav_write_trailer,
287 .flags = AVFMT_TS_NONSTRICT,
288 .codec_tag = (const AVCodecTag* const []){ ff_codec_wav_tags, 0 },
289 .priv_class = &wav_muxer_class,
291 #endif /* CONFIG_WAV_MUXER */
296 static void start_guid(AVIOContext *pb, const uint8_t *guid, int64_t *pos)
298 *pos = avio_tell(pb);
300 avio_write(pb, guid, 16);
301 avio_wl64(pb, INT64_MAX);
304 static void end_guid(AVIOContext *pb, int64_t start)
306 int64_t end, pos = avio_tell(pb);
308 end = FFALIGN(pos, 8);
309 ffio_fill(pb, 0, end - pos);
310 avio_seek(pb, start + 16, SEEK_SET);
311 avio_wl64(pb, end - start);
312 avio_seek(pb, end, SEEK_SET);
315 static int w64_write_header(AVFormatContext *s)
317 WAVMuxContext *wav = s->priv_data;
318 AVIOContext *pb = s->pb;
322 avio_write(pb, ff_w64_guid_riff, sizeof(ff_w64_guid_riff));
324 avio_write(pb, ff_w64_guid_wave, sizeof(ff_w64_guid_wave));
325 start_guid(pb, ff_w64_guid_fmt, &start);
326 if ((ret = ff_put_wav_header(pb, s->streams[0]->codec)) < 0) {
327 av_log(s, AV_LOG_ERROR, "%s codec not supported\n",
328 s->streams[0]->codec->codec ? s->streams[0]->codec->codec->name : "NONE");
333 if (s->streams[0]->codec->codec_tag != 0x01 /* hence for all other than PCM */
334 && s->pb->seekable) {
335 start_guid(pb, ff_w64_guid_fact, &wav->fact_pos);
337 end_guid(pb, wav->fact_pos);
340 start_guid(pb, ff_w64_guid_data, &wav->data);
345 static int w64_write_trailer(AVFormatContext *s)
347 AVIOContext *pb = s->pb;
348 WAVMuxContext *wav = s->priv_data;
352 end_guid(pb, wav->data);
354 file_size = avio_tell(pb);
355 avio_seek(pb, 16, SEEK_SET);
356 avio_wl64(pb, file_size);
358 if (s->streams[0]->codec->codec_tag != 0x01) {
359 int64_t number_of_samples;
361 number_of_samples = av_rescale(wav->maxpts - wav->minpts + wav->last_duration,
362 s->streams[0]->codec->sample_rate * (int64_t)s->streams[0]->time_base.num,
363 s->streams[0]->time_base.den);
364 avio_seek(pb, wav->fact_pos + 24, SEEK_SET);
365 avio_wl64(pb, number_of_samples);
368 avio_seek(pb, file_size, SEEK_SET);
375 AVOutputFormat ff_w64_muxer = {
377 .long_name = NULL_IF_CONFIG_SMALL("Sony Wave64"),
379 .priv_data_size = sizeof(WAVMuxContext),
380 .audio_codec = AV_CODEC_ID_PCM_S16LE,
381 .video_codec = AV_CODEC_ID_NONE,
382 .write_header = w64_write_header,
383 .write_packet = wav_write_packet,
384 .write_trailer = w64_write_trailer,
385 .flags = AVFMT_TS_NONSTRICT,
386 .codec_tag = (const AVCodecTag* const []){ ff_codec_wav_tags, 0 },
388 #endif /* CONFIG_W64_MUXER */