2 * Copyright (C) 2005 Michael Ahlberg, Måns Rullgård
4 * Permission is hereby granted, free of charge, to any person
5 * obtaining a copy of this software and associated documentation
6 * files (the "Software"), to deal in the Software without
7 * restriction, including without limitation the rights to use, copy,
8 * modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be
13 * included in all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
27 #include "libavutil/avstring.h"
28 #include "libavutil/base64.h"
29 #include "libavutil/bswap.h"
30 #include "libavutil/dict.h"
31 #include "libavcodec/bytestream.h"
32 #include "libavcodec/get_bits.h"
33 #include "libavcodec/vorbis_parser.h"
35 #include "flac_picture.h"
38 #include "vorbiscomment.h"
39 #include "replaygain.h"
41 static int ogm_chapter(AVFormatContext *as, uint8_t *key, uint8_t *val)
43 int i, cnum, h, m, s, ms, keylen = strlen(key);
44 AVChapter *chapter = NULL;
46 if (keylen < 9 || sscanf(key, "CHAPTER%03d", &cnum) != 1)
50 if (sscanf(val, "%02d:%02d:%02d.%03d", &h, &m, &s, &ms) < 4)
53 avpriv_new_chapter(as, cnum, (AVRational) { 1, 1000 },
54 ms + 1000 * (s + 60 * (m + 60 * h)),
55 AV_NOPTS_VALUE, NULL);
57 } else if (!strcmp(key + keylen - 4, "NAME")) {
58 for (i = 0; i < as->nb_chapters; i++)
59 if (as->chapters[i]->id == cnum) {
60 chapter = as->chapters[i];
66 av_dict_set(&chapter->metadata, "title", val, AV_DICT_DONT_STRDUP_VAL);
74 int ff_vorbis_comment(AVFormatContext *as, AVDictionary **m,
75 const uint8_t *buf, int size,
78 const uint8_t *p = buf;
79 const uint8_t *end = buf + size;
83 /* must have vendor_length and user_comment_list_length */
85 return AVERROR_INVALIDDATA;
87 s = bytestream_get_le32(&p);
89 if (end - p - 4 < s || s < 0)
90 return AVERROR_INVALIDDATA;
94 n = bytestream_get_le32(&p);
96 while (end - p >= 4 && n > 0) {
100 s = bytestream_get_le32(&p);
102 if (end - p < s || s < 0)
109 v = memchr(t, '=', s);
120 tt = av_malloc(tl + 1);
121 ct = av_malloc(vl + 1);
125 return AVERROR(ENOMEM);
128 for (j = 0; j < tl; j++)
129 tt[j] = av_toupper(t[j]);
135 /* The format in which the pictures are stored is the FLAC format.
136 * Xiph says: "The binary FLAC picture structure is base64 encoded
137 * and placed within a VorbisComment with the tag name
138 * 'METADATA_BLOCK_PICTURE'. This is the preferred and
139 * recommended way of embedding cover art within VorbisComments."
141 if (!strcmp(tt, "METADATA_BLOCK_PICTURE") && parse_picture) {
143 char *pict = av_malloc(vl);
146 av_log(as, AV_LOG_WARNING, "out-of-memory error. Skipping cover art block.\n");
151 if ((ret = av_base64_decode(pict, ct, vl)) > 0)
152 ret = ff_flac_parse_picture(as, pict, ret);
157 av_log(as, AV_LOG_WARNING, "Failed to parse cover art block.\n");
160 } else if (!ogm_chapter(as, tt, ct)) {
161 if (av_dict_get(*m, tt, NULL, 0)) {
162 av_dict_set(m, tt, ";", AV_DICT_APPEND);
164 av_dict_set(m, tt, ct,
165 AV_DICT_DONT_STRDUP_KEY |
173 av_log(as, AV_LOG_INFO,
174 "%"PTRDIFF_SPECIFIER" bytes of comment header remain\n", end - p);
176 av_log(as, AV_LOG_INFO,
177 "truncated comment header, %i comments not found\n", n);
179 ff_metadata_conv(m, NULL, ff_vorbiscomment_metadata_conv);
185 * Parse the vorbis header
187 * Vorbis Identification header from Vorbis_I_spec.html#vorbis-spec-codec
188 * [vorbis_version] = read 32 bits as unsigned integer | Not used
189 * [audio_channels] = read 8 bit integer as unsigned | Used
190 * [audio_sample_rate] = read 32 bits as unsigned integer | Used
191 * [bitrate_maximum] = read 32 bits as signed integer | Not used yet
192 * [bitrate_nominal] = read 32 bits as signed integer | Not used yet
193 * [bitrate_minimum] = read 32 bits as signed integer | Used as bitrate
194 * [blocksize_0] = read 4 bits as unsigned integer | Not Used
195 * [blocksize_1] = read 4 bits as unsigned integer | Not Used
196 * [framing_flag] = read one bit | Not Used
199 struct oggvorbis_private {
201 unsigned char *packet[3];
202 VorbisParseContext vp;
207 static int fixup_vorbis_headers(AVFormatContext *as,
208 struct oggvorbis_private *priv,
211 int i, offset, len, err;
215 len = priv->len[0] + priv->len[1] + priv->len[2];
216 buf_len = len + len / 255 + 64;
217 ptr = *buf = av_realloc(NULL, buf_len);
219 return AVERROR(ENOMEM);
220 memset(*buf, '\0', buf_len);
224 offset += av_xiphlacing(&ptr[offset], priv->len[0]);
225 offset += av_xiphlacing(&ptr[offset], priv->len[1]);
226 for (i = 0; i < 3; i++) {
227 memcpy(&ptr[offset], priv->packet[i], priv->len[i]);
228 offset += priv->len[i];
229 av_freep(&priv->packet[i]);
231 if ((err = av_reallocp(buf, offset + FF_INPUT_BUFFER_PADDING_SIZE)) < 0)
236 static void vorbis_cleanup(AVFormatContext *s, int idx)
238 struct ogg *ogg = s->priv_data;
239 struct ogg_stream *os = ogg->streams + idx;
240 struct oggvorbis_private *priv = os->private;
243 for (i = 0; i < 3; i++)
244 av_freep(&priv->packet[i]);
247 static int vorbis_update_metadata(AVFormatContext *s, int idx)
249 struct ogg *ogg = s->priv_data;
250 struct ogg_stream *os = ogg->streams + idx;
251 AVStream *st = s->streams[idx];
257 /* New metadata packet; release old data. */
258 av_dict_free(&st->metadata);
259 ret = ff_vorbis_comment(s, &st->metadata, os->buf + os->pstart + 7,
264 /* Update the metadata if possible. */
265 av_freep(&os->new_metadata);
267 os->new_metadata = av_packet_pack_dictionary(st->metadata, &os->new_metadata_size);
268 /* Send an empty dictionary to indicate that metadata has been cleared. */
270 os->new_metadata = av_malloc(1);
271 os->new_metadata_size = 0;
277 static int vorbis_header(AVFormatContext *s, int idx)
279 struct ogg *ogg = s->priv_data;
280 AVStream *st = s->streams[idx];
281 struct ogg_stream *os = ogg->streams + idx;
282 struct oggvorbis_private *priv;
283 int pkt_type = os->buf[os->pstart];
286 os->private = av_mallocz(sizeof(struct oggvorbis_private));
288 return AVERROR(ENOMEM);
294 if (os->psize < 1 || pkt_type > 5)
295 return AVERROR_INVALIDDATA;
299 if (priv->packet[pkt_type >> 1])
300 return AVERROR_INVALIDDATA;
301 if (pkt_type > 1 && !priv->packet[0] || pkt_type > 3 && !priv->packet[1])
302 return AVERROR_INVALIDDATA;
304 priv->len[pkt_type >> 1] = os->psize;
305 priv->packet[pkt_type >> 1] = av_mallocz(os->psize);
306 if (!priv->packet[pkt_type >> 1])
307 return AVERROR(ENOMEM);
308 memcpy(priv->packet[pkt_type >> 1], os->buf + os->pstart, os->psize);
309 if (os->buf[os->pstart] == 1) {
310 const uint8_t *p = os->buf + os->pstart + 7; /* skip "\001vorbis" tag */
311 unsigned blocksize, bs0, bs1;
316 return AVERROR_INVALIDDATA;
318 if (bytestream_get_le32(&p) != 0) /* vorbis_version */
319 return AVERROR_INVALIDDATA;
321 channels = bytestream_get_byte(&p);
322 if (st->codec->channels && channels != st->codec->channels) {
323 av_log(s, AV_LOG_ERROR, "Channel change is not supported\n");
324 return AVERROR_PATCHWELCOME;
326 st->codec->channels = channels;
327 srate = bytestream_get_le32(&p);
328 p += 4; // skip maximum bitrate
329 st->codec->bit_rate = bytestream_get_le32(&p); // nominal bitrate
330 p += 4; // skip minimum bitrate
332 blocksize = bytestream_get_byte(&p);
333 bs0 = blocksize & 15;
334 bs1 = blocksize >> 4;
337 return AVERROR_INVALIDDATA;
338 if (bs0 < 6 || bs1 > 13)
339 return AVERROR_INVALIDDATA;
341 if (bytestream_get_byte(&p) != 1) /* framing_flag */
342 return AVERROR_INVALIDDATA;
344 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
345 st->codec->codec_id = AV_CODEC_ID_VORBIS;
348 st->codec->sample_rate = srate;
349 avpriv_set_pts_info(st, 64, 1, srate);
351 } else if (os->buf[os->pstart] == 3) {
352 if (vorbis_update_metadata(s, idx) >= 0 && priv->len[1] > 10) {
355 int ret = ff_replaygain_export(st, st->metadata);
359 // drop all metadata we parsed and which is not required by libvorbis
360 new_len = 7 + 4 + AV_RL32(priv->packet[1] + 7) + 4 + 1;
361 if (new_len >= 16 && new_len < os->psize) {
362 AV_WL32(priv->packet[1] + new_len - 5, 0);
363 priv->packet[1][new_len - 1] = 1;
364 priv->len[1] = new_len;
368 int ret = fixup_vorbis_headers(s, priv, &st->codec->extradata);
370 st->codec->extradata_size = 0;
373 st->codec->extradata_size = ret;
374 if ((ret = avpriv_vorbis_parse_extradata(st->codec, &priv->vp))) {
375 av_freep(&st->codec->extradata);
376 st->codec->extradata_size = 0;
384 static int vorbis_packet(AVFormatContext *s, int idx)
386 struct ogg *ogg = s->priv_data;
387 struct ogg_stream *os = ogg->streams + idx;
388 struct oggvorbis_private *priv = os->private;
389 int duration, flags = 0;
391 /* first packet handling
392 * here we parse the duration of each packet in the first page and compare
393 * the total duration to the page granule to find the encoder delay and
394 * set the first timestamp */
395 if ((!os->lastpts || os->lastpts == AV_NOPTS_VALUE) && !(os->flags & OGG_FLAG_EOS) && (int64_t)os->granule>=0) {
397 uint8_t *last_pkt = os->buf + os->pstart;
398 uint8_t *next_pkt = last_pkt;
400 avpriv_vorbis_parse_reset(&priv->vp);
403 d = avpriv_vorbis_parse_frame_flags(&priv->vp, last_pkt, 1, &flags);
405 os->pflags |= AV_PKT_FLAG_CORRUPT;
407 } else if (flags & VORBIS_FLAG_COMMENT) {
408 vorbis_update_metadata(s, idx);
412 last_pkt = next_pkt = next_pkt + os->psize;
413 for (; seg < os->nsegs; seg++) {
414 if (os->segments[seg] < 255) {
415 int d = avpriv_vorbis_parse_frame_flags(&priv->vp, last_pkt, 1, &flags);
417 duration = os->granule;
419 } else if (flags & VORBIS_FLAG_COMMENT) {
420 vorbis_update_metadata(s, idx);
424 last_pkt = next_pkt + os->segments[seg];
426 next_pkt += os->segments[seg];
429 os->lastdts = os->granule - duration;
431 if (!os->granule && duration) //hack to deal with broken files (Ticket3710)
432 os->lastpts = os->lastdts = AV_NOPTS_VALUE;
434 if (s->streams[idx]->start_time == AV_NOPTS_VALUE) {
435 s->streams[idx]->start_time = FFMAX(os->lastpts, 0);
436 if (s->streams[idx]->duration != AV_NOPTS_VALUE)
437 s->streams[idx]->duration -= s->streams[idx]->start_time;
439 priv->final_pts = AV_NOPTS_VALUE;
440 avpriv_vorbis_parse_reset(&priv->vp);
443 /* parse packet duration */
445 duration = avpriv_vorbis_parse_frame_flags(&priv->vp, os->buf + os->pstart, 1, &flags);
447 os->pflags |= AV_PKT_FLAG_CORRUPT;
449 } else if (flags & VORBIS_FLAG_COMMENT) {
450 vorbis_update_metadata(s, idx);
453 os->pduration = duration;
456 /* final packet handling
457 * here we save the pts of the first packet in the final page, sum up all
458 * packet durations in the final page except for the last one, and compare
459 * to the page granule to find the duration of the final packet */
460 if (os->flags & OGG_FLAG_EOS) {
461 if (os->lastpts != AV_NOPTS_VALUE) {
462 priv->final_pts = os->lastpts;
463 priv->final_duration = 0;
465 if (os->segp == os->nsegs)
466 os->pduration = os->granule - priv->final_pts - priv->final_duration;
467 priv->final_duration += os->pduration;
473 const struct ogg_codec ff_vorbis_codec = {
474 .magic = "\001vorbis",
476 .header = vorbis_header,
477 .packet = vorbis_packet,
478 .cleanup = vorbis_cleanup,