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.
26 #include "libavutil/avstring.h"
27 #include "libavutil/base64.h"
28 #include "libavutil/bswap.h"
29 #include "libavutil/dict.h"
30 #include "libavcodec/get_bits.h"
31 #include "libavcodec/bytestream.h"
32 #include "libavcodec/vorbis_parser.h"
37 #include "vorbiscomment.h"
39 static int ogm_chapter(AVFormatContext *as, uint8_t *key, uint8_t *val)
41 int i, cnum, h, m, s, ms, keylen = strlen(key);
42 AVChapter *chapter = NULL;
44 if (keylen < 9 || sscanf(key, "CHAPTER%03d", &cnum) != 1)
48 if (sscanf(val, "%02d:%02d:%02d.%03d", &h, &m, &s, &ms) < 4)
51 avpriv_new_chapter(as, cnum, (AVRational){1,1000},
52 ms + 1000*(s + 60*(m + 60*h)),
53 AV_NOPTS_VALUE, NULL);
55 } else if (!strcmp(key+(keylen-4), "NAME")) {
56 for(i = 0; i < as->nb_chapters; i++)
57 if (as->chapters[i]->id == cnum) {
58 chapter = as->chapters[i];
64 av_dict_set(&chapter->metadata, "title", val,
65 AV_DICT_DONT_STRDUP_VAL);
74 ff_vorbis_comment(AVFormatContext * as, AVDictionary **m, const uint8_t *buf, int size)
76 const uint8_t *p = buf;
77 const uint8_t *end = buf + size;
81 if (size < 8) /* must have vendor_length and user_comment_list_length */
84 s = bytestream_get_le32(&p);
86 if (end - p - 4 < s || s < 0)
91 n = bytestream_get_le32(&p);
93 while (end - p >= 4 && n > 0) {
97 s = bytestream_get_le32(&p);
99 if (end - p < s || s < 0)
106 v = memchr(t, '=', s);
117 tt = av_malloc(tl + 1);
118 ct = av_malloc(vl + 1);
122 av_log(as, AV_LOG_WARNING, "out-of-memory error. skipping VorbisComment tag.\n");
126 for (j = 0; j < tl; j++)
127 tt[j] = av_toupper(t[j]);
133 if (!strcmp(tt, "METADATA_BLOCK_PICTURE")) {
135 char *pict = av_malloc(vl);
138 av_log(as, AV_LOG_WARNING, "out-of-memory error. Skipping cover art block.\n");
141 if ((ret = av_base64_decode(pict, ct, vl)) > 0)
142 ret = ff_flac_parse_picture(as, pict, ret);
145 av_log(as, AV_LOG_WARNING, "Failed to parse cover art block.\n");
148 } else if (!ogm_chapter(as, tt, ct))
149 av_dict_set(m, tt, ct,
150 AV_DICT_DONT_STRDUP_KEY |
151 AV_DICT_DONT_STRDUP_VAL);
156 av_log(as, AV_LOG_INFO, "%ti bytes of comment header remain\n", end-p);
158 av_log(as, AV_LOG_INFO,
159 "truncated comment header, %i comments not found\n", n);
161 ff_metadata_conv(m, NULL, ff_vorbiscomment_metadata_conv);
167 /** Parse the vorbis header
168 * Vorbis Identification header from Vorbis_I_spec.html#vorbis-spec-codec
169 * [vorbis_version] = read 32 bits as unsigned integer | Not used
170 * [audio_channels] = read 8 bit integer as unsigned | Used
171 * [audio_sample_rate] = read 32 bits as unsigned integer | Used
172 * [bitrate_maximum] = read 32 bits as signed integer | Not used yet
173 * [bitrate_nominal] = read 32 bits as signed integer | Not used yet
174 * [bitrate_minimum] = read 32 bits as signed integer | Used as bitrate
175 * [blocksize_0] = read 4 bits as unsigned integer | Not Used
176 * [blocksize_1] = read 4 bits as unsigned integer | Not Used
177 * [framing_flag] = read one bit | Not Used
180 struct oggvorbis_private {
182 unsigned char *packet[3];
183 VorbisParseContext vp;
190 fixup_vorbis_headers(AVFormatContext * as, struct oggvorbis_private *priv,
193 int i,offset, len, buf_len;
196 len = priv->len[0] + priv->len[1] + priv->len[2];
197 buf_len = len + len/255 + 64;
198 ptr = *buf = av_realloc(NULL, buf_len);
201 memset(*buf, '\0', buf_len);
205 offset += av_xiphlacing(&ptr[offset], priv->len[0]);
206 offset += av_xiphlacing(&ptr[offset], priv->len[1]);
207 for (i = 0; i < 3; i++) {
208 memcpy(&ptr[offset], priv->packet[i], priv->len[i]);
209 offset += priv->len[i];
210 av_freep(&priv->packet[i]);
212 *buf = av_realloc(*buf, offset + FF_INPUT_BUFFER_PADDING_SIZE);
216 static void vorbis_cleanup(AVFormatContext *s, int idx)
218 struct ogg *ogg = s->priv_data;
219 struct ogg_stream *os = ogg->streams + idx;
220 struct oggvorbis_private *priv = os->private;
223 for (i = 0; i < 3; i++)
224 av_freep(&priv->packet[i]);
228 vorbis_header (AVFormatContext * s, int idx)
230 struct ogg *ogg = s->priv_data;
231 struct ogg_stream *os = ogg->streams + idx;
232 AVStream *st = s->streams[idx];
233 struct oggvorbis_private *priv;
234 int pkt_type = os->buf[os->pstart];
237 return os->private ? 0 : -1;
240 os->private = av_mallocz(sizeof(struct oggvorbis_private));
245 if (os->psize < 1 || pkt_type > 5)
250 if (priv->packet[pkt_type>>1])
252 if (pkt_type > 1 && !priv->packet[0] || pkt_type > 3 && !priv->packet[1])
255 priv->len[pkt_type >> 1] = os->psize;
256 priv->packet[pkt_type >> 1] = av_mallocz(os->psize);
257 if (!priv->packet[pkt_type >> 1])
258 return AVERROR(ENOMEM);
259 memcpy(priv->packet[pkt_type >> 1], os->buf + os->pstart, os->psize);
260 if (os->buf[os->pstart] == 1) {
261 const uint8_t *p = os->buf + os->pstart + 7; /* skip "\001vorbis" tag */
262 unsigned blocksize, bs0, bs1;
269 if (bytestream_get_le32(&p) != 0) /* vorbis_version */
272 channels= bytestream_get_byte(&p);
273 if (st->codec->channels && channels != st->codec->channels) {
274 av_log(s, AV_LOG_ERROR, "Channel change is not supported\n");
275 return AVERROR_PATCHWELCOME;
277 st->codec->channels = channels;
278 srate = bytestream_get_le32(&p);
279 p += 4; // skip maximum bitrate
280 st->codec->bit_rate = bytestream_get_le32(&p); // nominal bitrate
281 p += 4; // skip minimum bitrate
283 blocksize = bytestream_get_byte(&p);
284 bs0 = blocksize & 15;
285 bs1 = blocksize >> 4;
289 if (bs0 < 6 || bs1 > 13)
292 if (bytestream_get_byte(&p) != 1) /* framing_flag */
295 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
296 st->codec->codec_id = AV_CODEC_ID_VORBIS;
299 st->codec->sample_rate = srate;
300 avpriv_set_pts_info(st, 64, 1, srate);
302 } else if (os->buf[os->pstart] == 3) {
304 ff_vorbis_comment(s, &st->metadata, os->buf + os->pstart + 7, os->psize - 8) >= 0) {
305 // drop all metadata we parsed and which is not required by libvorbis
306 unsigned new_len = 7 + 4 + AV_RL32(priv->packet[1] + 7) + 4 + 1;
307 if (new_len >= 16 && new_len < os->psize) {
308 AV_WL32(priv->packet[1] + new_len - 5, 0);
309 priv->packet[1][new_len - 1] = 1;
310 priv->len[1] = new_len;
315 st->codec->extradata_size =
316 fixup_vorbis_headers(s, priv, &st->codec->extradata);
317 if ((ret = avpriv_vorbis_parse_extradata(st->codec, &priv->vp))) {
318 av_freep(&st->codec->extradata);
319 st->codec->extradata_size = 0;
327 static int vorbis_packet(AVFormatContext *s, int idx)
329 struct ogg *ogg = s->priv_data;
330 struct ogg_stream *os = ogg->streams + idx;
331 struct oggvorbis_private *priv = os->private;
334 /* first packet handling
335 here we parse the duration of each packet in the first page and compare
336 the total duration to the page granule to find the encoder delay and
337 set the first timestamp */
338 if ((!os->lastpts || os->lastpts == AV_NOPTS_VALUE) && !(os->flags & OGG_FLAG_EOS)) {
340 uint8_t *last_pkt = os->buf + os->pstart;
341 uint8_t *next_pkt = last_pkt;
343 avpriv_vorbis_parse_reset(&priv->vp);
346 d = avpriv_vorbis_parse_frame(&priv->vp, last_pkt, 1);
348 os->pflags |= AV_PKT_FLAG_CORRUPT;
352 last_pkt = next_pkt = next_pkt + os->psize;
353 for (; seg < os->nsegs; seg++) {
354 if (os->segments[seg] < 255) {
355 int d = avpriv_vorbis_parse_frame(&priv->vp, last_pkt, 1);
357 duration = os->granule;
361 last_pkt = next_pkt + os->segments[seg];
363 next_pkt += os->segments[seg];
365 os->lastpts = os->lastdts = os->granule - duration;
366 if(s->streams[idx]->start_time == AV_NOPTS_VALUE) {
367 s->streams[idx]->start_time = FFMAX(os->lastpts, 0);
368 if (s->streams[idx]->duration)
369 s->streams[idx]->duration -= s->streams[idx]->start_time;
371 priv->final_pts = AV_NOPTS_VALUE;
372 avpriv_vorbis_parse_reset(&priv->vp);
375 /* parse packet duration */
377 duration = avpriv_vorbis_parse_frame(&priv->vp, os->buf + os->pstart, 1);
379 os->pflags |= AV_PKT_FLAG_CORRUPT;
382 os->pduration = duration;
385 /* final packet handling
386 here we save the pts of the first packet in the final page, sum up all
387 packet durations in the final page except for the last one, and compare
388 to the page granule to find the duration of the final packet */
389 if (os->flags & OGG_FLAG_EOS) {
390 if (os->lastpts != AV_NOPTS_VALUE) {
391 priv->final_pts = os->lastpts;
392 priv->final_duration = 0;
394 if (os->segp == os->nsegs)
395 os->pduration = os->granule - priv->final_pts - priv->final_duration;
396 priv->final_duration += os->pduration;
402 const struct ogg_codec ff_vorbis_codec = {
403 .magic = "\001vorbis",
405 .header = vorbis_header,
406 .packet = vorbis_packet,
407 .cleanup= vorbis_cleanup,