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