Merge commit 'e4dc1000d7bbbcb5b45cf9849fc5315f19578e37'
[ffmpeg.git] / libavformat / oggparsevorbis.c
1 /*
2  * Copyright (C) 2005  Michael Ahlberg, Måns Rullgård
3  *
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:
11  *
12  *  The above copyright notice and this permission notice shall be
13  *  included in all copies or substantial portions of the Software.
14  *
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.
23  */
24
25 #include <stdlib.h>
26
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"
34 #include "avformat.h"
35 #include "flac_picture.h"
36 #include "internal.h"
37 #include "oggdec.h"
38 #include "vorbiscomment.h"
39 #include "replaygain.h"
40
41 static int ogm_chapter(AVFormatContext *as, uint8_t *key, uint8_t *val)
42 {
43     int i, cnum, h, m, s, ms, keylen = strlen(key);
44     AVChapter *chapter = NULL;
45
46     if (keylen < 9 || sscanf(key, "CHAPTER%03d", &cnum) != 1)
47         return 0;
48
49     if (keylen <= 10) {
50         if (sscanf(val, "%02d:%02d:%02d.%03d", &h, &m, &s, &ms) < 4)
51             return 0;
52
53         avpriv_new_chapter(as, cnum, (AVRational) { 1, 1000 },
54                            ms + 1000 * (s + 60 * (m + 60 * h)),
55                            AV_NOPTS_VALUE, NULL);
56         av_free(val);
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];
61                 break;
62             }
63         if (!chapter)
64             return 0;
65
66         av_dict_set(&chapter->metadata, "title", val, AV_DICT_DONT_STRDUP_VAL);
67     } else
68         return 0;
69
70     av_free(key);
71     return 1;
72 }
73
74 int ff_vorbis_comment(AVFormatContext *as, AVDictionary **m,
75                       const uint8_t *buf, int size)
76 {
77     const uint8_t *p   = buf;
78     const uint8_t *end = buf + size;
79     unsigned n, j;
80     int s;
81
82     /* must have vendor_length and user_comment_list_length */
83     if (size < 8)
84         return AVERROR_INVALIDDATA;
85
86     s = bytestream_get_le32(&p);
87
88     if (end - p - 4 < s || s < 0)
89         return AVERROR_INVALIDDATA;
90
91     p += s;
92
93     n = bytestream_get_le32(&p);
94
95     while (end - p >= 4 && n > 0) {
96         const char *t, *v;
97         int tl, vl;
98
99         s = bytestream_get_le32(&p);
100
101         if (end - p < s || s < 0)
102             break;
103
104         t  = p;
105         p += s;
106         n--;
107
108         v = memchr(t, '=', s);
109         if (!v)
110             continue;
111
112         tl = v - t;
113         vl = s - tl - 1;
114         v++;
115
116         if (tl && vl) {
117             char *tt, *ct;
118
119             tt = av_malloc(tl + 1);
120             ct = av_malloc(vl + 1);
121             if (!tt || !ct) {
122                 av_freep(&tt);
123                 av_freep(&ct);
124                 return AVERROR(ENOMEM);
125             }
126
127             for (j = 0; j < tl; j++)
128                 tt[j] = av_toupper(t[j]);
129             tt[tl] = 0;
130
131             memcpy(ct, v, vl);
132             ct[vl] = 0;
133
134             /* The format in which the pictures are stored is the FLAC format.
135              * Xiph says: "The binary FLAC picture structure is base64 encoded
136              * and placed within a VorbisComment with the tag name
137              * 'METADATA_BLOCK_PICTURE'. This is the preferred and
138              * recommended way of embedding cover art within VorbisComments."
139              */
140             if (!strcmp(tt, "METADATA_BLOCK_PICTURE")) {
141                 int ret;
142                 char *pict = av_malloc(vl);
143
144                 if (!pict) {
145                     av_log(as, AV_LOG_WARNING, "out-of-memory error. Skipping cover art block.\n");
146                     av_freep(&tt);
147                     av_freep(&ct);
148                     continue;
149                 }
150                 if ((ret = av_base64_decode(pict, ct, vl)) > 0)
151                     ret = ff_flac_parse_picture(as, pict, ret);
152                 av_freep(&tt);
153                 av_freep(&ct);
154                 av_freep(&pict);
155                 if (ret < 0) {
156                     av_log(as, AV_LOG_WARNING, "Failed to parse cover art block.\n");
157                     continue;
158                 }
159             } else if (!ogm_chapter(as, tt, ct)) {
160                 if (av_dict_get(*m, tt, NULL, 0)) {
161                     av_dict_set(m, tt, ";", AV_DICT_APPEND);
162                 }
163                 av_dict_set(m, tt, ct,
164                             AV_DICT_DONT_STRDUP_KEY |
165                             AV_DICT_APPEND);
166                 av_freep(&ct);
167             }
168         }
169     }
170
171     if (p != end)
172         av_log(as, AV_LOG_INFO,
173                "%"PTRDIFF_SPECIFIER" bytes of comment header remain\n", end - p);
174     if (n > 0)
175         av_log(as, AV_LOG_INFO,
176                "truncated comment header, %i comments not found\n", n);
177
178     ff_metadata_conv(m, NULL, ff_vorbiscomment_metadata_conv);
179
180     return 0;
181 }
182
183 /*
184  * Parse the vorbis header
185  *
186  * Vorbis Identification header from Vorbis_I_spec.html#vorbis-spec-codec
187  * [vorbis_version] = read 32 bits as unsigned integer | Not used
188  * [audio_channels] = read 8 bit integer as unsigned | Used
189  * [audio_sample_rate] = read 32 bits as unsigned integer | Used
190  * [bitrate_maximum] = read 32 bits as signed integer | Not used yet
191  * [bitrate_nominal] = read 32 bits as signed integer | Not used yet
192  * [bitrate_minimum] = read 32 bits as signed integer | Used as bitrate
193  * [blocksize_0] = read 4 bits as unsigned integer | Not Used
194  * [blocksize_1] = read 4 bits as unsigned integer | Not Used
195  * [framing_flag] = read one bit | Not Used
196  */
197
198 struct oggvorbis_private {
199     unsigned int len[3];
200     unsigned char *packet[3];
201     VorbisParseContext vp;
202     int64_t final_pts;
203     int final_duration;
204 };
205
206 static int fixup_vorbis_headers(AVFormatContext *as,
207                                 struct oggvorbis_private *priv,
208                                 uint8_t **buf)
209 {
210     int i, offset, len, err;
211     int buf_len;
212     unsigned char *ptr;
213
214     len = priv->len[0] + priv->len[1] + priv->len[2];
215     buf_len = len + len / 255 + 64;
216     ptr = *buf = av_realloc(NULL, buf_len);
217     if (!ptr)
218         return AVERROR(ENOMEM);
219     memset(*buf, '\0', buf_len);
220
221     ptr[0]  = 2;
222     offset  = 1;
223     offset += av_xiphlacing(&ptr[offset], priv->len[0]);
224     offset += av_xiphlacing(&ptr[offset], priv->len[1]);
225     for (i = 0; i < 3; i++) {
226         memcpy(&ptr[offset], priv->packet[i], priv->len[i]);
227         offset += priv->len[i];
228         av_freep(&priv->packet[i]);
229     }
230     if ((err = av_reallocp(buf, offset + FF_INPUT_BUFFER_PADDING_SIZE)) < 0)
231         return err;
232     return offset;
233 }
234
235 static void vorbis_cleanup(AVFormatContext *s, int idx)
236 {
237     struct ogg *ogg = s->priv_data;
238     struct ogg_stream *os = ogg->streams + idx;
239     struct oggvorbis_private *priv = os->private;
240     int i;
241     if (os->private)
242         for (i = 0; i < 3; i++)
243             av_freep(&priv->packet[i]);
244 }
245
246 static int vorbis_update_metadata(AVFormatContext *s, int idx)
247 {
248     struct ogg *ogg = s->priv_data;
249     struct ogg_stream *os = ogg->streams + idx;
250     AVStream *st = s->streams[idx];
251     int ret;
252
253     if (os->psize <= 8)
254         return 0;
255
256     /* New metadata packet; release old data. */
257     av_dict_free(&st->metadata);
258     ret = ff_vorbis_comment(s, &st->metadata, os->buf + os->pstart + 7,
259                             os->psize - 8);
260     if (ret < 0)
261         return ret;
262
263     /* Update the metadata if possible. */
264     av_freep(&os->new_metadata);
265     if (st->metadata) {
266         os->new_metadata = av_packet_pack_dictionary(st->metadata, &os->new_metadata_size);
267     /* Send an empty dictionary to indicate that metadata has been cleared. */
268     } else {
269         os->new_metadata = av_malloc(1);
270         os->new_metadata_size = 0;
271     }
272
273     return ret;
274 }
275
276 static int vorbis_header(AVFormatContext *s, int idx)
277 {
278     struct ogg *ogg = s->priv_data;
279     AVStream *st    = s->streams[idx];
280     struct ogg_stream *os = ogg->streams + idx;
281     struct oggvorbis_private *priv;
282     int pkt_type = os->buf[os->pstart];
283
284     if (!os->private) {
285         os->private = av_mallocz(sizeof(struct oggvorbis_private));
286         if (!os->private)
287             return AVERROR(ENOMEM);
288     }
289
290     if (!(pkt_type & 1))
291         return 0;
292
293     if (os->psize < 1 || pkt_type > 5)
294         return AVERROR_INVALIDDATA;
295
296     priv = os->private;
297
298     if (priv->packet[pkt_type >> 1])
299         return AVERROR_INVALIDDATA;
300     if (pkt_type > 1 && !priv->packet[0] || pkt_type > 3 && !priv->packet[1])
301         return AVERROR_INVALIDDATA;
302
303     priv->len[pkt_type >> 1]    = os->psize;
304     priv->packet[pkt_type >> 1] = av_mallocz(os->psize);
305     if (!priv->packet[pkt_type >> 1])
306         return AVERROR(ENOMEM);
307     memcpy(priv->packet[pkt_type >> 1], os->buf + os->pstart, os->psize);
308     if (os->buf[os->pstart] == 1) {
309         const uint8_t *p = os->buf + os->pstart + 7; /* skip "\001vorbis" tag */
310         unsigned blocksize, bs0, bs1;
311         int srate;
312         int channels;
313
314         if (os->psize != 30)
315             return AVERROR_INVALIDDATA;
316
317         if (bytestream_get_le32(&p) != 0) /* vorbis_version */
318             return AVERROR_INVALIDDATA;
319
320         channels = bytestream_get_byte(&p);
321         if (st->codec->channels && channels != st->codec->channels) {
322             av_log(s, AV_LOG_ERROR, "Channel change is not supported\n");
323             return AVERROR_PATCHWELCOME;
324         }
325         st->codec->channels = channels;
326         srate               = bytestream_get_le32(&p);
327         p += 4; // skip maximum bitrate
328         st->codec->bit_rate = bytestream_get_le32(&p); // nominal bitrate
329         p += 4; // skip minimum bitrate
330
331         blocksize = bytestream_get_byte(&p);
332         bs0       = blocksize & 15;
333         bs1       = blocksize >> 4;
334
335         if (bs0 > bs1)
336             return AVERROR_INVALIDDATA;
337         if (bs0 < 6 || bs1 > 13)
338             return AVERROR_INVALIDDATA;
339
340         if (bytestream_get_byte(&p) != 1) /* framing_flag */
341             return AVERROR_INVALIDDATA;
342
343         st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
344         st->codec->codec_id   = AV_CODEC_ID_VORBIS;
345
346         if (srate > 0) {
347             st->codec->sample_rate = srate;
348             avpriv_set_pts_info(st, 64, 1, srate);
349         }
350     } else if (os->buf[os->pstart] == 3) {
351         if (vorbis_update_metadata(s, idx) >= 0 && priv->len[1] > 10) {
352             unsigned new_len;
353
354             int ret = ff_replaygain_export(st, st->metadata);
355             if (ret < 0)
356                 return ret;
357
358             // drop all metadata we parsed and which is not required by libvorbis
359             new_len = 7 + 4 + AV_RL32(priv->packet[1] + 7) + 4 + 1;
360             if (new_len >= 16 && new_len < os->psize) {
361                 AV_WL32(priv->packet[1] + new_len - 5, 0);
362                 priv->packet[1][new_len - 1] = 1;
363                 priv->len[1]                 = new_len;
364             }
365         }
366     } else {
367         int ret = fixup_vorbis_headers(s, priv, &st->codec->extradata);
368         if (ret < 0) {
369             st->codec->extradata_size = 0;
370             return ret;
371         }
372         st->codec->extradata_size = ret;
373         if ((ret = avpriv_vorbis_parse_extradata(st->codec, &priv->vp))) {
374             av_freep(&st->codec->extradata);
375             st->codec->extradata_size = 0;
376             return ret;
377         }
378     }
379
380     return 1;
381 }
382
383 static int vorbis_packet(AVFormatContext *s, int idx)
384 {
385     struct ogg *ogg = s->priv_data;
386     struct ogg_stream *os = ogg->streams + idx;
387     struct oggvorbis_private *priv = os->private;
388     int duration, flags = 0;
389
390     /* first packet handling
391      * here we parse the duration of each packet in the first page and compare
392      * the total duration to the page granule to find the encoder delay and
393      * set the first timestamp */
394     if ((!os->lastpts || os->lastpts == AV_NOPTS_VALUE) && !(os->flags & OGG_FLAG_EOS) && (int64_t)os->granule>=0) {
395         int seg, d;
396         uint8_t *last_pkt  = os->buf + os->pstart;
397         uint8_t *next_pkt  = last_pkt;
398
399         avpriv_vorbis_parse_reset(&priv->vp);
400         duration = 0;
401         seg = os->segp;
402         d = avpriv_vorbis_parse_frame_flags(&priv->vp, last_pkt, 1, &flags);
403         if (d < 0) {
404             os->pflags |= AV_PKT_FLAG_CORRUPT;
405             return 0;
406         } else if (flags & VORBIS_FLAG_COMMENT) {
407             vorbis_update_metadata(s, idx);
408             flags = 0;
409         }
410         duration += d;
411         last_pkt = next_pkt =  next_pkt + os->psize;
412         for (; seg < os->nsegs; seg++) {
413             if (os->segments[seg] < 255) {
414                 int d = avpriv_vorbis_parse_frame_flags(&priv->vp, last_pkt, 1, &flags);
415                 if (d < 0) {
416                     duration = os->granule;
417                     break;
418                 } else if (flags & VORBIS_FLAG_COMMENT) {
419                     vorbis_update_metadata(s, idx);
420                     flags = 0;
421                 }
422                 duration += d;
423                 last_pkt  = next_pkt + os->segments[seg];
424             }
425             next_pkt += os->segments[seg];
426         }
427         os->lastpts                 =
428         os->lastdts                 = os->granule - duration;
429         if (s->streams[idx]->start_time == AV_NOPTS_VALUE) {
430             s->streams[idx]->start_time = FFMAX(os->lastpts, 0);
431             if (s->streams[idx]->duration != AV_NOPTS_VALUE)
432                 s->streams[idx]->duration -= s->streams[idx]->start_time;
433         }
434         priv->final_pts          = AV_NOPTS_VALUE;
435         avpriv_vorbis_parse_reset(&priv->vp);
436     }
437
438     /* parse packet duration */
439     if (os->psize > 0) {
440         duration = avpriv_vorbis_parse_frame_flags(&priv->vp, os->buf + os->pstart, 1, &flags);
441         if (duration < 0) {
442             os->pflags |= AV_PKT_FLAG_CORRUPT;
443             return 0;
444         } else if (flags & VORBIS_FLAG_COMMENT) {
445             vorbis_update_metadata(s, idx);
446             flags = 0;
447         }
448         os->pduration = duration;
449     }
450
451     /* final packet handling
452      * here we save the pts of the first packet in the final page, sum up all
453      * packet durations in the final page except for the last one, and compare
454      * to the page granule to find the duration of the final packet */
455     if (os->flags & OGG_FLAG_EOS) {
456         if (os->lastpts != AV_NOPTS_VALUE) {
457             priv->final_pts      = os->lastpts;
458             priv->final_duration = 0;
459         }
460         if (os->segp == os->nsegs)
461             os->pduration = os->granule - priv->final_pts - priv->final_duration;
462         priv->final_duration += os->pduration;
463     }
464
465     return 0;
466 }
467
468 const struct ogg_codec ff_vorbis_codec = {
469     .magic     = "\001vorbis",
470     .magicsize = 7,
471     .header    = vorbis_header,
472     .packet    = vorbis_packet,
473     .cleanup   = vorbis_cleanup,
474     .nb_header = 3,
475 };