3 * Copyright (c) 2006-2009 Justin Ruggles
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
22 #include "libavutil/channel_layout.h"
23 #include "libavutil/opt.h"
24 #include "libavutil/pixdesc.h"
25 #include "libavcodec/flac.h"
27 #include "avio_internal.h"
31 #include "vorbiscomment.h"
32 #include "libavcodec/bytestream.h"
35 typedef struct FlacMuxerContext {
41 /* audio packets are queued here until we get all the attached pictures */
42 AVPacketList *queue, *queue_end;
44 /* updated streaminfo sent by the encoder at the end */
47 unsigned attached_types;
50 static int flac_write_block_padding(AVIOContext *pb, unsigned int n_padding_bytes,
53 avio_w8(pb, last_block ? 0x81 : 0x01);
54 avio_wb24(pb, n_padding_bytes);
55 ffio_fill(pb, 0, n_padding_bytes);
59 static int flac_write_block_comment(AVIOContext *pb, AVDictionary **m,
60 int last_block, int bitexact)
62 const char *vendor = bitexact ? "ffmpeg" : LIBAVFORMAT_IDENT;
66 ff_metadata_conv(m, ff_vorbiscomment_metadata_conv, NULL);
68 len = ff_vorbiscomment_length(*m, vendor, NULL, 0);
69 if (len >= ((1<<24) - 4))
70 return AVERROR(EINVAL);
71 p0 = av_malloc(len+4);
73 return AVERROR(ENOMEM);
76 bytestream_put_byte(&p, last_block ? 0x84 : 0x04);
77 bytestream_put_be24(&p, len);
78 ff_vorbiscomment_write(&p, m, vendor, NULL, 0);
80 avio_write(pb, p0, len+4);
87 static int flac_write_picture(struct AVFormatContext *s, AVPacket *pkt)
89 FlacMuxerContext *c = s->priv_data;
90 AVIOContext *pb = s->pb;
91 const AVPixFmtDescriptor *pixdesc;
92 const CodecMime *mime = ff_id3v2_mime_tags;
94 const char *mimetype = NULL, *desc = "";
95 const AVStream *st = s->streams[pkt->stream_index];
96 int i, mimelen, desclen, type = 0, blocklen;
101 while (mime->id != AV_CODEC_ID_NONE) {
102 if (mime->id == st->codecpar->codec_id) {
103 mimetype = mime->str;
109 av_log(s, AV_LOG_ERROR, "No mimetype is known for stream %d, cannot "
110 "write an attached picture.\n", st->index);
111 return AVERROR(EINVAL);
113 mimelen = strlen(mimetype);
115 /* get the picture type */
116 e = av_dict_get(st->metadata, "comment", NULL, 0);
117 for (i = 0; e && i < FF_ARRAY_ELEMS(ff_id3v2_picture_types); i++) {
118 if (!av_strcasecmp(e->value, ff_id3v2_picture_types[i])) {
124 if ((c->attached_types & (1 << type)) & 0x6) {
125 av_log(s, AV_LOG_ERROR, "Duplicate attachment for type '%s'\n", ff_id3v2_picture_types[type]);
126 return AVERROR(EINVAL);
129 if (type == 1 && (st->codecpar->codec_id != AV_CODEC_ID_PNG ||
130 st->codecpar->width != 32 ||
131 st->codecpar->height != 32)) {
132 av_log(s, AV_LOG_ERROR, "File icon attachment must be a 32x32 PNG");
133 return AVERROR(EINVAL);
136 c->attached_types |= (1 << type);
138 /* get the description */
139 if ((e = av_dict_get(st->metadata, "title", NULL, 0)))
141 desclen = strlen(desc);
143 blocklen = 4 + 4 + mimelen + 4 + desclen + 4 + 4 + 4 + 4 + 4 + pkt->size;
144 if (blocklen >= 1<<24) {
145 av_log(s, AV_LOG_ERROR, "Picture block too big %d >= %d\n", blocklen, 1<<24);
146 return AVERROR(EINVAL);
150 avio_wb24(pb, blocklen);
154 avio_wb32(pb, mimelen);
155 avio_write(pb, mimetype, mimelen);
157 avio_wb32(pb, desclen);
158 avio_write(pb, desc, desclen);
160 avio_wb32(pb, st->codecpar->width);
161 avio_wb32(pb, st->codecpar->height);
162 if ((pixdesc = av_pix_fmt_desc_get(st->codecpar->format)))
163 avio_wb32(pb, av_get_bits_per_pixel(pixdesc));
168 avio_wb32(pb, pkt->size);
169 avio_write(pb, pkt->data, pkt->size);
173 static int flac_finish_header(struct AVFormatContext *s)
175 int i, ret, padding = s->metadata_header_padding;
178 /* The FLAC specification states that 24 bits are used to represent the
179 * size of a metadata block so we must clip this value to 2^24-1. */
180 padding = av_clip_uintp2(padding, 24);
182 for (i = 0; i < s->nb_streams; i++) {
183 AVStream *st = s->streams[i];
184 AVPacket *pkt = st->priv_data;
187 ret = flac_write_picture(s, pkt);
188 av_packet_unref(pkt);
189 if (ret < 0 && (s->error_recognition & AV_EF_EXPLODE))
193 ret = flac_write_block_comment(s->pb, &s->metadata, !padding,
194 s->flags & AVFMT_FLAG_BITEXACT);
198 /* The command line flac encoder defaults to placing a seekpoint
199 * every 10s. So one might add padding to allow that later
200 * but there seems to be no simple way to get the duration here.
201 * So just add the amount requested by the user. */
203 flac_write_block_padding(s->pb, padding, 1);
208 static int flac_init(struct AVFormatContext *s)
210 AVCodecParameters *par;
211 FlacMuxerContext *c = s->priv_data;
214 c->audio_stream_idx = -1;
215 for (i = 0; i < s->nb_streams; i++) {
216 AVStream *st = s->streams[i];
217 if (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO) {
218 if (c->audio_stream_idx >= 0 || st->codecpar->codec_id != AV_CODEC_ID_FLAC) {
219 av_log(s, AV_LOG_ERROR, "Invalid audio stream. Exactly one FLAC "
220 "audio stream is required.\n");
221 return AVERROR(EINVAL);
223 par = s->streams[i]->codecpar;
224 c->audio_stream_idx = i;
225 } else if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO) {
226 if (!(st->disposition & AV_DISPOSITION_ATTACHED_PIC)) {
227 av_log(s, AV_LOG_WARNING, "Video stream #%d is not an attached picture. Ignoring\n", i);
229 } else if (st->codecpar->codec_id == AV_CODEC_ID_GIF) {
230 av_log(s, AV_LOG_ERROR, "GIF image support is not implemented.\n");
231 return AVERROR_PATCHWELCOME;
232 } else if (!c->write_header) {
233 av_log(s, AV_LOG_ERROR, "Can't write attached pictures without a header.\n");
234 return AVERROR(EINVAL);
238 av_log(s, AV_LOG_ERROR, "Only audio streams and pictures are allowed in FLAC.\n");
239 return AVERROR(EINVAL);
242 if (c->audio_stream_idx < 0) {
243 av_log(s, AV_LOG_ERROR, "No audio stream present.\n");
244 return AVERROR(EINVAL);
247 /* add the channel layout tag */
248 if (par->channel_layout &&
249 !(par->channel_layout & ~0x3ffffULL) &&
250 !ff_flac_is_native_layout(par->channel_layout)) {
251 AVDictionaryEntry *chmask = av_dict_get(s->metadata, "WAVEFORMATEXTENSIBLE_CHANNEL_MASK",
255 av_log(s, AV_LOG_WARNING, "A WAVEFORMATEXTENSIBLE_CHANNEL_MASK is "
256 "already present, this muxer will not overwrite it.\n");
259 snprintf(buf, sizeof(buf), "0x%"PRIx64, par->channel_layout);
260 av_dict_set(&s->metadata, "WAVEFORMATEXTENSIBLE_CHANNEL_MASK", buf, 0);
267 static int flac_write_header(struct AVFormatContext *s)
269 FlacMuxerContext *c = s->priv_data;
270 AVCodecParameters *par = s->streams[c->audio_stream_idx]->codecpar;
273 if (!c->write_header)
276 ret = ff_flac_write_header(s->pb, par->extradata,
277 par->extradata_size, 0);
281 if (!c->waiting_pics)
282 ret = flac_finish_header(s);
287 static int flac_write_audio_packet(struct AVFormatContext *s, AVPacket *pkt)
289 FlacMuxerContext *c = s->priv_data;
293 /* check for updated streaminfo */
294 streaminfo = av_packet_get_side_data(pkt, AV_PKT_DATA_NEW_EXTRADATA,
296 if (streaminfo && streaminfo_size == FLAC_STREAMINFO_SIZE) {
297 av_freep(&c->streaminfo);
299 c->streaminfo = av_malloc(FLAC_STREAMINFO_SIZE);
301 return AVERROR(ENOMEM);
302 memcpy(c->streaminfo, streaminfo, FLAC_STREAMINFO_SIZE);
306 avio_write(s->pb, pkt->data, pkt->size);
310 static int flac_queue_flush(AVFormatContext *s)
312 FlacMuxerContext *c = s->priv_data;
316 ret = flac_finish_header(s);
321 ff_packet_list_get(&c->queue, &c->queue_end, &pkt);
322 if (write && (ret = flac_write_audio_packet(s, &pkt)) < 0)
324 av_packet_unref(&pkt);
329 static int flac_write_trailer(struct AVFormatContext *s)
331 AVIOContext *pb = s->pb;
333 FlacMuxerContext *c = s->priv_data;
334 uint8_t *streaminfo = c->streaminfo ? c->streaminfo :
335 s->streams[c->audio_stream_idx]->codecpar->extradata;
337 if (c->waiting_pics) {
338 av_log(s, AV_LOG_WARNING, "No packets were sent for some of the "
339 "attached pictures.\n");
343 if (!c->write_header || !streaminfo)
346 if (pb->seekable & AVIO_SEEKABLE_NORMAL) {
347 /* rewrite the STREAMINFO header block data */
348 file_size = avio_tell(pb);
349 avio_seek(pb, 8, SEEK_SET);
350 avio_write(pb, streaminfo, FLAC_STREAMINFO_SIZE);
351 avio_seek(pb, file_size, SEEK_SET);
354 av_log(s, AV_LOG_WARNING, "unable to rewrite FLAC header.\n");
360 static void flac_deinit(struct AVFormatContext *s)
362 FlacMuxerContext *c = s->priv_data;
364 ff_packet_list_free(&c->queue, &c->queue_end);
365 av_freep(&c->streaminfo);
368 static int flac_write_packet(struct AVFormatContext *s, AVPacket *pkt)
370 FlacMuxerContext *c = s->priv_data;
373 if (pkt->stream_index == c->audio_stream_idx) {
374 if (c->waiting_pics) {
375 /* buffer audio packets until we get all the pictures */
376 ret = ff_packet_list_put(&c->queue, &c->queue_end, pkt, FF_PACKETLIST_FLAG_REF_PACKET);
378 av_log(s, AV_LOG_ERROR, "Out of memory in packet queue; skipping attached pictures\n");
380 ret = flac_queue_flush(s);
383 return flac_write_audio_packet(s, pkt);
386 return flac_write_audio_packet(s, pkt);
388 AVStream *st = s->streams[pkt->stream_index];
390 if (!c->waiting_pics ||
391 !(st->disposition & AV_DISPOSITION_ATTACHED_PIC))
394 /* warn only once for each stream */
395 if (st->nb_frames == 1) {
396 av_log(s, AV_LOG_WARNING, "Got more than one picture in stream %d,"
397 " ignoring.\n", pkt->stream_index);
399 if (st->nb_frames >= 1)
402 st->priv_data = av_packet_clone(pkt);
404 av_log(s, AV_LOG_ERROR, "Out of memory queueing an attached picture; skipping\n");
407 /* flush the buffered audio packets */
408 if (!c->waiting_pics &&
409 (ret = flac_queue_flush(s)) < 0)
416 static const AVOption flacenc_options[] = {
417 { "write_header", "Write the file header", offsetof(FlacMuxerContext, write_header), AV_OPT_TYPE_BOOL, {.i64 = 1}, 0, 1, AV_OPT_FLAG_ENCODING_PARAM },
421 static const AVClass flac_muxer_class = {
422 .class_name = "flac muxer",
423 .item_name = av_default_item_name,
424 .option = flacenc_options,
425 .version = LIBAVUTIL_VERSION_INT,
428 AVOutputFormat ff_flac_muxer = {
430 .long_name = NULL_IF_CONFIG_SMALL("raw FLAC"),
431 .priv_data_size = sizeof(FlacMuxerContext),
432 .mime_type = "audio/x-flac",
433 .extensions = "flac",
434 .audio_codec = AV_CODEC_ID_FLAC,
435 .video_codec = AV_CODEC_ID_PNG,
437 .write_header = flac_write_header,
438 .write_packet = flac_write_packet,
439 .write_trailer = flac_write_trailer,
440 .deinit = flac_deinit,
441 .flags = AVFMT_NOTIMESTAMPS,
442 .priv_class = &flac_muxer_class,