libavformat/wv.c

   1 /*
   2  * WavPack demuxer
   3  * Copyright (c) 2006,2011 Konstantin Shishkov
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #include "libavutil/audioconvert.h"
  23 #include "libavutil/intreadwrite.h"
  24 #include "libavutil/dict.h"
  25 #include "avformat.h"
  26 #include "apetag.h"
  27 #include "id3v1.h"
  28
  29 // specs say that maximum block size is 1Mb
  30 #define WV_BLOCK_LIMIT 1047576
  31
  32 #define WV_EXTRA_SIZE 12
  33
  34 #define WV_START_BLOCK  0x0800
  35 #define WV_END_BLOCK    0x1000
  36 #define WV_SINGLE_BLOCK (WV_START_BLOCK | WV_END_BLOCK)
  37
  38 enum WV_FLAGS{
  39     WV_MONO   = 0x0004,
  40     WV_HYBRID = 0x0008,
  41     WV_JOINT  = 0x0010,
  42     WV_CROSSD = 0x0020,
  43     WV_HSHAPE = 0x0040,
  44     WV_FLOAT  = 0x0080,
  45     WV_INT32  = 0x0100,
  46     WV_HBR    = 0x0200,
  47     WV_HBAL   = 0x0400,
  48     WV_MCINIT = 0x0800,
  49     WV_MCEND  = 0x1000,
  50 };
  51
  52 static const int wv_rates[16] = {
  53      6000,  8000,  9600, 11025, 12000, 16000, 22050, 24000,
  54     32000, 44100, 48000, 64000, 88200, 96000, 192000, -1
  55 };
  56
  57 typedef struct{
  58     uint32_t blksize, flags;
  59     int rate, chan, bpp;
  60     uint32_t chmask;
  61     uint32_t samples, soff;
  62     int multichannel;
  63     int block_parsed;
  64     uint8_t extra[WV_EXTRA_SIZE];
  65     int64_t pos;
  66 }WVContext;
  67
  68 static int wv_probe(AVProbeData *p)
  69 {
  70     /* check file header */
  71     if (p->buf_size <= 32)
  72         return 0;
  73     if (p->buf[0] == 'w' && p->buf[1] == 'v' &&
  74         p->buf[2] == 'p' && p->buf[3] == 'k')
  75         return AVPROBE_SCORE_MAX;
  76     else
  77         return 0;
  78 }
  79
  80 static int wv_read_block_header(AVFormatContext *ctx, AVIOContext *pb, int append)
  81 {
  82     WVContext *wc = ctx->priv_data;
  83     uint32_t tag, ver;
  84     int size;
  85     int rate, bpp, chan;
  86     uint32_t chmask;
  87
  88     wc->pos = avio_tell(pb);
  89     if(!append){
  90         tag = avio_rl32(pb);
  91         if (tag != MKTAG('w', 'v', 'p', 'k'))
  92             return -1;
  93         size = avio_rl32(pb);
  94         if(size < 24 || size > WV_BLOCK_LIMIT){
  95             av_log(ctx, AV_LOG_ERROR, "Incorrect block size %i\n", size);
  96             return -1;
  97         }
  98         wc->blksize = size;
  99         ver = avio_rl16(pb);
 100         if(ver < 0x402 || ver > 0x410){
 101             av_log(ctx, AV_LOG_ERROR, "Unsupported version %03X\n", ver);
 102             return -1;
 103         }
 104         avio_r8(pb); // track no
 105         avio_r8(pb); // track sub index
 106         wc->samples = avio_rl32(pb); // total samples in file
 107         wc->soff = avio_rl32(pb); // offset in samples of current block
 108         avio_read(pb, wc->extra, WV_EXTRA_SIZE);
 109     }else{
 110         size = wc->blksize;
 111     }
 112     wc->flags = AV_RL32(wc->extra + 4);
 113     // blocks with zero samples don't contain actual audio information and should be ignored
 114     if (!AV_RN32(wc->extra))
 115         return 0;
 116     //parse flags
 117     bpp = ((wc->flags & 3) + 1) << 3;
 118     chan = 1 + !(wc->flags & WV_MONO);
 119     chmask = wc->flags & WV_MONO ? AV_CH_LAYOUT_MONO : AV_CH_LAYOUT_STEREO;
 120     rate = wv_rates[(wc->flags >> 23) & 0xF];
 121     wc->multichannel = !!((wc->flags & WV_SINGLE_BLOCK) != WV_SINGLE_BLOCK);
 122     if(wc->multichannel){
 123         chan = wc->chan;
 124         chmask = wc->chmask;
 125     }
 126     if((rate == -1 || !chan) && !wc->block_parsed){
 127         int64_t block_end = avio_tell(pb) + wc->blksize - 24;
 128         if(!pb->seekable){
 129             av_log(ctx, AV_LOG_ERROR, "Cannot determine additional parameters\n");
 130             return -1;
 131         }
 132         while(avio_tell(pb) < block_end){
 133             int id, size;
 134             id = avio_r8(pb);
 135             size = (id & 0x80) ? avio_rl24(pb) : avio_r8(pb);
 136             size <<= 1;
 137             if(id&0x40)
 138                 size--;
 139             switch(id&0x3F){
 140             case 0xD:
 141                 if(size <= 1){
 142                     av_log(ctx, AV_LOG_ERROR, "Insufficient channel information\n");
 143                     return -1;
 144                 }
 145                 chan = avio_r8(pb);
 146                 switch(size - 2){
 147                 case 0:
 148                     chmask = avio_r8(pb);
 149                     break;
 150                 case 1:
 151                     chmask = avio_rl16(pb);
 152                     break;
 153                 case 2:
 154                     chmask = avio_rl24(pb);
 155                     break;
 156                 case 3:
 157                     chmask = avio_rl32(pb);
 158                     break;
 159                 case 5:
 160                     avio_skip(pb, 1);
 161                     chan |= (avio_r8(pb) & 0xF) << 8;
 162                     chmask = avio_rl24(pb);
 163                     break;
 164                 default:
 165                     av_log(ctx, AV_LOG_ERROR, "Invalid channel info size %d\n", size);
 166                     return -1;
 167                 }
 168                 break;
 169             case 0x27:
 170                 rate = avio_rl24(pb);
 171                 break;
 172             default:
 173                 avio_skip(pb, size);
 174             }
 175             if(id&0x40)
 176                 avio_skip(pb, 1);
 177         }
 178         if(rate == -1){
 179             av_log(ctx, AV_LOG_ERROR, "Cannot determine custom sampling rate\n");
 180             return -1;
 181         }
 182         avio_seek(pb, block_end - wc->blksize + 24, SEEK_SET);
 183     }
 184     if(!wc->bpp) wc->bpp = bpp;
 185     if(!wc->chan) wc->chan = chan;
 186     if(!wc->chmask) wc->chmask = chmask;
 187     if(!wc->rate) wc->rate = rate;
 188
 189     if(wc->flags && bpp != wc->bpp){
 190         av_log(ctx, AV_LOG_ERROR, "Bits per sample differ, this block: %i, header block: %i\n", bpp, wc->bpp);
 191         return -1;
 192     }
 193     if(wc->flags && !wc->multichannel && chan != wc->chan){
 194         av_log(ctx, AV_LOG_ERROR, "Channels differ, this block: %i, header block: %i\n", chan, wc->chan);
 195         return -1;
 196     }
 197     if(wc->flags && rate != -1 && rate != wc->rate){
 198         av_log(ctx, AV_LOG_ERROR, "Sampling rate differ, this block: %i, header block: %i\n", rate, wc->rate);
 199         return -1;
 200     }
 201     wc->blksize = size - 24;
 202     return 0;
 203 }
 204
 205 static int wv_read_header(AVFormatContext *s,
 206                           AVFormatParameters *ap)
 207 {
 208     AVIOContext *pb = s->pb;
 209     WVContext *wc = s->priv_data;
 210     AVStream *st;
 211
 212     wc->block_parsed = 0;
 213     for(;;){
 214         if(wv_read_block_header(s, pb, 0) < 0)
 215             return -1;
 216         if(!AV_RN32(wc->extra))
 217             avio_skip(pb, wc->blksize - 24);
 218         else
 219             break;
 220     }
 221
 222     /* now we are ready: build format streams */
 223     st = av_new_stream(s, 0);
 224     if (!st)
 225         return -1;
 226     st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
 227     st->codec->codec_id = CODEC_ID_WAVPACK;
 228     st->codec->channels = wc->chan;
 229     st->codec->channel_layout = wc->chmask;
 230     st->codec->sample_rate = wc->rate;
 231     st->codec->bits_per_coded_sample = wc->bpp;
 232     av_set_pts_info(st, 64, 1, wc->rate);
 233     st->start_time = 0;
 234     st->duration = wc->samples;
 235
 236     if(s->pb->seekable) {
 237         int64_t cur = avio_tell(s->pb);
 238         ff_ape_parse_tag(s);
 239         if(!av_dict_get(s->metadata, "", NULL, AV_DICT_IGNORE_SUFFIX))
 240             ff_id3v1_read(s);
 241         avio_seek(s->pb, cur, SEEK_SET);
 242     }
 243
 244     return 0;
 245 }
 246
 247 static int wv_read_packet(AVFormatContext *s,
 248                           AVPacket *pkt)
 249 {
 250     WVContext *wc = s->priv_data;
 251     int ret;
 252     int size, ver, off;
 253     int64_t pos;
 254
 255     if (url_feof(s->pb))
 256         return AVERROR(EIO);
 257     if(wc->block_parsed){
 258         if(wv_read_block_header(s, s->pb, 0) < 0)
 259             return -1;
 260     }
 261
 262     pos = wc->pos;
 263     off = wc->multichannel ? 4 : 0;
 264     if(av_new_packet(pkt, wc->blksize + WV_EXTRA_SIZE + off) < 0)
 265         return AVERROR(ENOMEM);
 266     if(wc->multichannel)
 267         AV_WL32(pkt->data, wc->blksize + WV_EXTRA_SIZE + 12);
 268     memcpy(pkt->data + off, wc->extra, WV_EXTRA_SIZE);
 269     ret = avio_read(s->pb, pkt->data + WV_EXTRA_SIZE + off, wc->blksize);
 270     if(ret != wc->blksize){
 271         av_free_packet(pkt);
 272         return AVERROR(EIO);
 273     }
 274     while(!(wc->flags & WV_END_BLOCK)){
 275         if(avio_rl32(s->pb) != MKTAG('w', 'v', 'p', 'k')){
 276             av_free_packet(pkt);
 277             return -1;
 278         }
 279         if((ret = av_append_packet(s->pb, pkt, 4)) < 0){
 280             av_free_packet(pkt);
 281             return ret;
 282         }
 283         size = AV_RL32(pkt->data + pkt->size - 4);
 284         if(size < 24 || size > WV_BLOCK_LIMIT){
 285             av_free_packet(pkt);
 286             av_log(s, AV_LOG_ERROR, "Incorrect block size %d\n", size);
 287             return -1;
 288         }
 289         wc->blksize = size;
 290         ver = avio_rl16(s->pb);
 291         if(ver < 0x402 || ver > 0x410){
 292             av_free_packet(pkt);
 293             av_log(s, AV_LOG_ERROR, "Unsupported version %03X\n", ver);
 294             return -1;
 295         }
 296         avio_r8(s->pb); // track no
 297         avio_r8(s->pb); // track sub index
 298         wc->samples = avio_rl32(s->pb); // total samples in file
 299         wc->soff = avio_rl32(s->pb); // offset in samples of current block
 300         if((ret = av_append_packet(s->pb, pkt, WV_EXTRA_SIZE)) < 0){
 301             av_free_packet(pkt);
 302             return ret;
 303         }
 304         memcpy(wc->extra, pkt->data + pkt->size - WV_EXTRA_SIZE, WV_EXTRA_SIZE);
 305
 306         if(wv_read_block_header(s, s->pb, 1) < 0){
 307             av_free_packet(pkt);
 308             return -1;
 309         }
 310         ret = av_append_packet(s->pb, pkt, wc->blksize);
 311         if(ret < 0){
 312             av_free_packet(pkt);
 313             return ret;
 314         }
 315     }
 316     pkt->stream_index = 0;
 317     wc->block_parsed = 1;
 318     pkt->pts = wc->soff;
 319     av_add_index_entry(s->streams[0], pos, pkt->pts, 0, 0, AVINDEX_KEYFRAME);
 320     return 0;
 321 }
 322
 323 static int wv_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
 324 {
 325     AVStream *st = s->streams[stream_index];
 326     WVContext *wc = s->priv_data;
 327     AVPacket pkt1, *pkt = &pkt1;
 328     int ret;
 329     int index = av_index_search_timestamp(st, timestamp, flags);
 330     int64_t pos, pts;
 331
 332     /* if found, seek there */
 333     if (index >= 0 &&
 334         timestamp <= st->index_entries[st->nb_index_entries - 1].timestamp) {
 335         wc->block_parsed = 1;
 336         avio_seek(s->pb, st->index_entries[index].pos, SEEK_SET);
 337         return 0;
 338     }
 339     /* if timestamp is out of bounds, return error */
 340     if(timestamp < 0 || timestamp >= s->duration)
 341         return -1;
 342
 343     pos = avio_tell(s->pb);
 344     do{
 345         ret = av_read_frame(s, pkt);
 346         if (ret < 0){
 347             avio_seek(s->pb, pos, SEEK_SET);
 348             return -1;
 349         }
 350         pts = pkt->pts;
 351         av_free_packet(pkt);
 352     }while(pts < timestamp);
 353     return 0;
 354 }
 355
 356 AVInputFormat ff_wv_demuxer = {
 357     .name           = "wv",
 358     .long_name      = NULL_IF_CONFIG_SMALL("WavPack"),
 359     .priv_data_size = sizeof(WVContext),
 360     .read_probe     = wv_probe,
 361     .read_header    = wv_read_header,
 362     .read_packet    = wv_read_packet,
 363     .read_seek      = wv_read_seek,
 364 };