avformat/oggparsevorbis: Dont attempt to calculate timestamps from gp=0
[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                       int parse_picture)
77 {
78     const uint8_t *p   = buf;
79     const uint8_t *end = buf + size;
80     unsigned n, j;
81     int s;
82
83     /* must have vendor_length and user_comment_list_length */
84     if (size < 8)
85         return AVERROR_INVALIDDATA;
86
87     s = bytestream_get_le32(&p);
88
89     if (end - p - 4 < s || s < 0)
90         return AVERROR_INVALIDDATA;
91
92     p += s;
93
94     n = bytestream_get_le32(&p);
95
96     while (end - p >= 4 && n > 0) {
97         const char *t, *v;
98         int tl, vl;
99
100         s = bytestream_get_le32(&p);
101
102         if (end - p < s || s < 0)
103             break;
104
105         t  = p;
106         p += s;
107         n--;
108
109         v = memchr(t, '=', s);
110         if (!v)
111             continue;
112
113         tl = v - t;
114         vl = s - tl - 1;
115         v++;
116
117         if (tl && vl) {
118             char *tt, *ct;
119
120             tt = av_malloc(tl + 1);
121             ct = av_malloc(vl + 1);
122             if (!tt || !ct) {
123                 av_freep(&tt);
124                 av_freep(&ct);
125                 return AVERROR(ENOMEM);
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             /* 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."
140              */
141             if (!strcmp(tt, "METADATA_BLOCK_PICTURE") && parse_picture) {
142                 int ret;
143                 char *pict = av_malloc(vl);
144
145                 if (!pict) {
146                     av_log(as, AV_LOG_WARNING, "out-of-memory error. Skipping cover art block.\n");
147                     av_freep(&tt);
148                     av_freep(&ct);
149                     continue;
150                 }
151                 if ((ret = av_base64_decode(pict, ct, vl)) > 0)
152                     ret = ff_flac_parse_picture(as, pict, ret);
153                 av_freep(&tt);
154                 av_freep(&ct);
155                 av_freep(&pict);
156                 if (ret < 0) {
157                     av_log(as, AV_LOG_WARNING, "Failed to parse cover art block.\n");
158                     continue;
159                 }
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);
163                 }
164                 av_dict_set(m, tt, ct,
165                             AV_DICT_DONT_STRDUP_KEY |
166                             AV_DICT_APPEND);
167                 av_freep(&ct);
168             }
169         }
170     }
171
172     if (p != end)
173         av_log(as, AV_LOG_INFO,
174                "%"PTRDIFF_SPECIFIER" bytes of comment header remain\n", end - p);
175     if (n > 0)
176         av_log(as, AV_LOG_INFO,
177                "truncated comment header, %i comments not found\n", n);
178
179     ff_metadata_conv(m, NULL, ff_vorbiscomment_metadata_conv);
180
181     return 0;
182 }
183
184 /*
185  * Parse the vorbis header
186  *
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
197  */
198
199 struct oggvorbis_private {
200     unsigned int len[3];
201     unsigned char *packet[3];
202     VorbisParseContext vp;
203     int64_t final_pts;
204     int final_duration;
205 };
206
207 static int fixup_vorbis_headers(AVFormatContext *as,
208                                 struct oggvorbis_private *priv,
209                                 uint8_t **buf)
210 {
211     int i, offset, len, err;
212     int buf_len;
213     unsigned char *ptr;
214
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);
218     if (!ptr)
219         return AVERROR(ENOMEM);
220     memset(*buf, '\0', buf_len);
221
222     ptr[0]  = 2;
223     offset  = 1;
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]);
230     }
231     if ((err = av_reallocp(buf, offset + FF_INPUT_BUFFER_PADDING_SIZE)) < 0)
232         return err;
233     return offset;
234 }
235
236 static void vorbis_cleanup(AVFormatContext *s, int idx)
237 {
238     struct ogg *ogg = s->priv_data;
239     struct ogg_stream *os = ogg->streams + idx;
240     struct oggvorbis_private *priv = os->private;
241     int i;
242     if (os->private)
243         for (i = 0; i < 3; i++)
244             av_freep(&priv->packet[i]);
245 }
246
247 static int vorbis_update_metadata(AVFormatContext *s, int idx)
248 {
249     struct ogg *ogg = s->priv_data;
250     struct ogg_stream *os = ogg->streams + idx;
251     AVStream *st = s->streams[idx];
252     int ret;
253
254     if (os->psize <= 8)
255         return 0;
256
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,
260                             os->psize - 8, 1);
261     if (ret < 0)
262         return ret;
263
264     /* Update the metadata if possible. */
265     av_freep(&os->new_metadata);
266     if (st->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. */
269     } else {
270         os->new_metadata = av_malloc(1);
271         os->new_metadata_size = 0;
272     }
273
274     return ret;
275 }
276
277 static int vorbis_header(AVFormatContext *s, int idx)
278 {
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];
284
285     if (!os->private) {
286         os->private = av_mallocz(sizeof(struct oggvorbis_private));
287         if (!os->private)
288             return AVERROR(ENOMEM);
289     }
290
291     if (!(pkt_type & 1))
292         return 0;
293
294     if (os->psize < 1 || pkt_type > 5)
295         return AVERROR_INVALIDDATA;
296
297     priv = os->private;
298
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;
303
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;
312         int srate;
313         int channels;
314
315         if (os->psize != 30)
316             return AVERROR_INVALIDDATA;
317
318         if (bytestream_get_le32(&p) != 0) /* vorbis_version */
319             return AVERROR_INVALIDDATA;
320
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;
325         }
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
331
332         blocksize = bytestream_get_byte(&p);
333         bs0       = blocksize & 15;
334         bs1       = blocksize >> 4;
335
336         if (bs0 > bs1)
337             return AVERROR_INVALIDDATA;
338         if (bs0 < 6 || bs1 > 13)
339             return AVERROR_INVALIDDATA;
340
341         if (bytestream_get_byte(&p) != 1) /* framing_flag */
342             return AVERROR_INVALIDDATA;
343
344         st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
345         st->codec->codec_id   = AV_CODEC_ID_VORBIS;
346
347         if (srate > 0) {
348             st->codec->sample_rate = srate;
349             avpriv_set_pts_info(st, 64, 1, srate);
350         }
351     } else if (os->buf[os->pstart] == 3) {
352         if (vorbis_update_metadata(s, idx) >= 0 && priv->len[1] > 10) {
353             unsigned new_len;
354
355             int ret = ff_replaygain_export(st, st->metadata);
356             if (ret < 0)
357                 return ret;
358
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;
365             }
366         }
367     } else {
368         int ret = fixup_vorbis_headers(s, priv, &st->codec->extradata);
369         if (ret < 0) {
370             st->codec->extradata_size = 0;
371             return ret;
372         }
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;
377             return ret;
378         }
379     }
380
381     return 1;
382 }
383
384 static int vorbis_packet(AVFormatContext *s, int idx)
385 {
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;
390
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) {
396         int seg, d;
397         uint8_t *last_pkt  = os->buf + os->pstart;
398         uint8_t *next_pkt  = last_pkt;
399
400         avpriv_vorbis_parse_reset(&priv->vp);
401         duration = 0;
402         seg = os->segp;
403         d = avpriv_vorbis_parse_frame_flags(&priv->vp, last_pkt, 1, &flags);
404         if (d < 0) {
405             os->pflags |= AV_PKT_FLAG_CORRUPT;
406             return 0;
407         } else if (flags & VORBIS_FLAG_COMMENT) {
408             vorbis_update_metadata(s, idx);
409             flags = 0;
410         }
411         duration += d;
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);
416                 if (d < 0) {
417                     duration = os->granule;
418                     break;
419                 } else if (flags & VORBIS_FLAG_COMMENT) {
420                     vorbis_update_metadata(s, idx);
421                     flags = 0;
422                 }
423                 duration += d;
424                 last_pkt  = next_pkt + os->segments[seg];
425             }
426             next_pkt += os->segments[seg];
427         }
428         os->lastpts                 =
429         os->lastdts                 = os->granule - duration;
430
431         if (!os->granule && duration) //hack to deal with broken files (Ticket3710)
432             os->lastpts = os->lastdts = AV_NOPTS_VALUE;
433
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;
438         }
439         priv->final_pts          = AV_NOPTS_VALUE;
440         avpriv_vorbis_parse_reset(&priv->vp);
441     }
442
443     /* parse packet duration */
444     if (os->psize > 0) {
445         duration = avpriv_vorbis_parse_frame_flags(&priv->vp, os->buf + os->pstart, 1, &flags);
446         if (duration < 0) {
447             os->pflags |= AV_PKT_FLAG_CORRUPT;
448             return 0;
449         } else if (flags & VORBIS_FLAG_COMMENT) {
450             vorbis_update_metadata(s, idx);
451             flags = 0;
452         }
453         os->pduration = duration;
454     }
455
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;
464         }
465         if (os->segp == os->nsegs)
466             os->pduration = os->granule - priv->final_pts - priv->final_duration;
467         priv->final_duration += os->pduration;
468     }
469
470     return 0;
471 }
472
473 const struct ogg_codec ff_vorbis_codec = {
474     .magic     = "\001vorbis",
475     .magicsize = 7,
476     .header    = vorbis_header,
477     .packet    = vorbis_packet,
478     .cleanup   = vorbis_cleanup,
479     .nb_header = 3,
480 };