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