libavcodec/vorbis_parser.c
5602a464
 /*
  * Copyright (c) 2012 Justin Ruggles
  *
d814a839
  * This file is part of FFmpeg.
5602a464
  *
d814a839
  * FFmpeg is free software; you can redistribute it and/or
5602a464
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
d814a839
  * FFmpeg is distributed in the hope that it will be useful,
5602a464
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
d814a839
  * License along with FFmpeg; if not, write to the Free Software
5602a464
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
  * @file
  * Vorbis audio parser
  *
  * Determines the duration for each packet.
  */
 
87479264
 #include "libavutil/log.h"
 
5602a464
 #include "get_bits.h"
 #include "parser.h"
 #include "xiph.h"
5e80fb7f
 #include "vorbis_parser_internal.h"
5602a464
 
87479264
 static const AVClass vorbis_parser_class = {
     .class_name = "Vorbis parser",
     .item_name  = av_default_item_name,
     .version    = LIBAVUTIL_VERSION_INT,
 };
 
6896f95b
 static int parse_id_header(AVVorbisParseContext *s,
5602a464
                            const uint8_t *buf, int buf_size)
 {
     /* Id header should be 30 bytes */
     if (buf_size < 30) {
87479264
         av_log(s, AV_LOG_ERROR, "Id header is too short\n");
5602a464
         return AVERROR_INVALIDDATA;
     }
 
     /* make sure this is the Id header */
     if (buf[0] != 1) {
87479264
         av_log(s, AV_LOG_ERROR, "Wrong packet type in Id header\n");
5602a464
         return AVERROR_INVALIDDATA;
     }
 
     /* check for header signature */
     if (memcmp(&buf[1], "vorbis", 6)) {
87479264
         av_log(s, AV_LOG_ERROR, "Invalid packet signature in Id header\n");
5602a464
         return AVERROR_INVALIDDATA;
     }
 
     if (!(buf[29] & 0x1)) {
87479264
         av_log(s, AV_LOG_ERROR, "Invalid framing bit in Id header\n");
5602a464
         return AVERROR_INVALIDDATA;
     }
 
     s->blocksize[0] = 1 << (buf[28] & 0xF);
     s->blocksize[1] = 1 << (buf[28] >>  4);
 
     return 0;
 }
 
6896f95b
 static int parse_setup_header(AVVorbisParseContext *s,
5602a464
                               const uint8_t *buf, int buf_size)
 {
     GetBitContext gb, gb0;
     uint8_t *rev_buf;
     int i, ret = 0;
     int got_framing_bit, mode_count, got_mode_header, last_mode_count = 0;
 
     /* avoid overread */
     if (buf_size < 7) {
87479264
         av_log(s, AV_LOG_ERROR, "Setup header is too short\n");
5602a464
         return AVERROR_INVALIDDATA;
     }
 
     /* make sure this is the Setup header */
     if (buf[0] != 5) {
87479264
         av_log(s, AV_LOG_ERROR, "Wrong packet type in Setup header\n");
5602a464
         return AVERROR_INVALIDDATA;
     }
 
     /* check for header signature */
     if (memcmp(&buf[1], "vorbis", 6)) {
87479264
         av_log(s, AV_LOG_ERROR, "Invalid packet signature in Setup header\n");
5602a464
         return AVERROR_INVALIDDATA;
     }
 
     /* reverse bytes so we can easily read backwards with get_bits() */
     if (!(rev_buf = av_malloc(buf_size))) {
87479264
         av_log(s, AV_LOG_ERROR, "Out of memory\n");
5602a464
         return AVERROR(ENOMEM);
     }
     for (i = 0; i < buf_size; i++)
         rev_buf[i] = buf[buf_size - 1 - i];
     init_get_bits(&gb, rev_buf, buf_size * 8);
 
     got_framing_bit = 0;
     while (get_bits_left(&gb) > 97) {
         if (get_bits1(&gb)) {
             got_framing_bit = get_bits_count(&gb);
             break;
         }
     }
     if (!got_framing_bit) {
87479264
         av_log(s, AV_LOG_ERROR, "Invalid Setup header\n");
5602a464
         ret = AVERROR_INVALIDDATA;
         goto bad_header;
     }
 
     /* Now we search backwards to find possible valid mode counts. This is not
      * fool-proof because we could have false positive matches and read too
      * far, but there isn't really any way to be sure without parsing through
      * all the many variable-sized fields before the modes. This approach seems
      * to work well in testing, and it is similar to how it is handled in
      * liboggz. */
     mode_count = 0;
     got_mode_header = 0;
     while (get_bits_left(&gb) >= 97) {
         if (get_bits(&gb, 8) > 63 || get_bits(&gb, 16) || get_bits(&gb, 16))
             break;
         skip_bits(&gb, 1);
         mode_count++;
         if (mode_count > 64)
             break;
         gb0 = gb;
         if (get_bits(&gb0, 6) + 1 == mode_count) {
             got_mode_header = 1;
             last_mode_count = mode_count;
         }
     }
     if (!got_mode_header) {
87479264
         av_log(s, AV_LOG_ERROR, "Invalid Setup header\n");
5602a464
         ret = AVERROR_INVALIDDATA;
         goto bad_header;
     }
     /* All samples I've seen use <= 2 modes, so ask for a sample if we find
      * more than that, as it is most likely a false positive. If we get any
      * we may need to approach this the long way and parse the whole Setup
      * header, but I hope very much that it never comes to that. */
     if (last_mode_count > 2) {
87479264
         avpriv_request_sample(s,
6d97484d
                               "%d modes (either a false positive or a "
                               "sample from an unknown encoder)",
5602a464
                               last_mode_count);
     }
     /* We're limiting the mode count to 63 so that we know that the previous
      * block flag will be in the first packet byte. */
     if (last_mode_count > 63) {
87479264
         av_log(s, AV_LOG_ERROR, "Unsupported mode count: %d\n",
5602a464
                last_mode_count);
         ret = AVERROR_INVALIDDATA;
         goto bad_header;
     }
     s->mode_count = mode_count = last_mode_count;
     /* Determine the number of bits required to code the mode and turn that
      * into a bitmask to directly access the mode from the first frame byte. */
     s->mode_mask = ((1 << (av_log2(mode_count - 1) + 1)) - 1) << 1;
     /* The previous window flag is the next bit after the mode */
     s->prev_mask = (s->mode_mask | 0x1) + 1;
 
     init_get_bits(&gb, rev_buf, buf_size * 8);
     skip_bits_long(&gb, got_framing_bit);
     for (i = mode_count - 1; i >= 0; i--) {
         skip_bits_long(&gb, 40);
16db88a0
         s->mode_blocksize[i] = get_bits1(&gb);
5602a464
     }
 
 bad_header:
     av_free(rev_buf);
     return ret;
 }
 
5e80fb7f
 static int vorbis_parse_init(AVVorbisParseContext *s,
                              const uint8_t *extradata, int extradata_size)
5602a464
 {
ad2deb02
     const uint8_t *header_start[3];
5602a464
     int header_len[3];
     int ret;
 
87479264
     s->class = &vorbis_parser_class;
5602a464
     s->extradata_parsed = 1;
 
5e80fb7f
     if ((ret = avpriv_split_xiph_headers(extradata,
                                          extradata_size, 30,
5602a464
                                          header_start, header_len)) < 0) {
87479264
         av_log(s, AV_LOG_ERROR, "Extradata corrupt.\n");
5602a464
         return ret;
     }
 
87479264
     if ((ret = parse_id_header(s, header_start[0], header_len[0])) < 0)
5602a464
         return ret;
 
87479264
     if ((ret = parse_setup_header(s, header_start[2], header_len[2])) < 0)
5602a464
         return ret;
 
     s->valid_extradata = 1;
16db88a0
     s->previous_blocksize = s->blocksize[s->mode_blocksize[0]];
5602a464
 
     return 0;
 }
 
7ffdc7be
 int av_vorbis_parse_frame_flags(AVVorbisParseContext *s, const uint8_t *buf,
                                 int buf_size, int *flags)
5602a464
 {
     int duration = 0;
 
     if (s->valid_extradata && buf_size > 0) {
         int mode, current_blocksize;
         int previous_blocksize = s->previous_blocksize;
 
         if (buf[0] & 1) {
255302da
             /* If the user doesn't care about special packets, it's a bad one. */
             if (!flags)
                 goto bad_packet;
 
             /* Set the flag for which kind of special packet it is. */
             if (buf[0] == 1)
                 *flags |= VORBIS_FLAG_HEADER;
             else if (buf[0] == 3)
                 *flags |= VORBIS_FLAG_COMMENT;
1fe94ea7
             else if (buf[0] == 5)
                 *flags |= VORBIS_FLAG_SETUP;
255302da
             else
                 goto bad_packet;
 
             /* Special packets have no duration. */
             return 0;
 
 bad_packet:
87479264
             av_log(s, AV_LOG_ERROR, "Invalid packet\n");
5602a464
             return AVERROR_INVALIDDATA;
         }
         if (s->mode_count == 1)
             mode = 0;
         else
             mode = (buf[0] & s->mode_mask) >> 1;
         if (mode >= s->mode_count) {
87479264
             av_log(s, AV_LOG_ERROR, "Invalid mode in packet\n");
5602a464
             return AVERROR_INVALIDDATA;
         }
16db88a0
         if(s->mode_blocksize[mode]){
5602a464
             int flag = !!(buf[0] & s->prev_mask);
             previous_blocksize = s->blocksize[flag];
         }
16db88a0
         current_blocksize     = s->blocksize[s->mode_blocksize[mode]];
441dce21
         duration              = (previous_blocksize + current_blocksize) >> 2;
5602a464
         s->previous_blocksize = current_blocksize;
     }
 
     return duration;
 }
 
44fa2671
 int av_vorbis_parse_frame(AVVorbisParseContext *s, const uint8_t *buf,
                           int buf_size)
255302da
 {
7ffdc7be
     return av_vorbis_parse_frame_flags(s, buf, buf_size, NULL);
255302da
 }
 
5e80fb7f
 void av_vorbis_parse_reset(AVVorbisParseContext *s)
5602a464
 {
     if (s->valid_extradata)
16db88a0
         s->previous_blocksize = s->blocksize[0];
5602a464
 }
 
5e80fb7f
 void av_vorbis_parse_free(AVVorbisParseContext **s)
 {
     av_freep(s);
 }
 
 AVVorbisParseContext *av_vorbis_parse_init(const uint8_t *extradata,
                                            int extradata_size)
 {
     AVVorbisParseContext *s = av_mallocz(sizeof(*s));
     int ret;
 
     if (!s)
         return NULL;
 
     ret = vorbis_parse_init(s, extradata, extradata_size);
     if (ret < 0) {
         av_vorbis_parse_free(&s);
         return NULL;
     }
 
     return s;
 }
 
5602a464
 #if CONFIG_VORBIS_PARSER
2f3fadfb
 
 typedef struct VorbisParseContext {
     AVVorbisParseContext *vp;
 } VorbisParseContext;
 
5602a464
 static int vorbis_parse(AVCodecParserContext *s1, AVCodecContext *avctx,
                         const uint8_t **poutbuf, int *poutbuf_size,
                         const uint8_t *buf, int buf_size)
 {
2f3fadfb
     VorbisParseContext *s = s1->priv_data;
5602a464
     int duration;
 
2f3fadfb
     if (!s->vp && avctx->extradata && avctx->extradata_size) {
         s->vp = av_vorbis_parse_init(avctx->extradata, avctx->extradata_size);
     }
374c907f
     if (!s->vp)
         goto end;
5602a464
 
2f3fadfb
     if ((duration = av_vorbis_parse_frame(s->vp, buf, buf_size)) >= 0)
5602a464
         s1->duration = duration;
 
 end:
     /* always return the full packet. this parser isn't doing any splitting or
        combining, only packet analysis */
     *poutbuf      = buf;
     *poutbuf_size = buf_size;
     return buf_size;
 }
 
2f3fadfb
 static void vorbis_parser_close(AVCodecParserContext *ctx)
 {
     VorbisParseContext *s = ctx->priv_data;
     av_vorbis_parse_free(&s->vp);
 }
 
5602a464
 AVCodecParser ff_vorbis_parser = {
36ef5369
     .codec_ids      = { AV_CODEC_ID_VORBIS },
2f3fadfb
     .priv_data_size = sizeof(VorbisParseContext),
5602a464
     .parser_parse   = vorbis_parse,
2f3fadfb
     .parser_close   = vorbis_parser_close,
5602a464
 };
 #endif /* CONFIG_VORBIS_PARSER */