git.sesse.net Git - ffmpeg/blob - libavformat/omadec.c

   1 /*
   2  * Sony OpenMG (OMA) demuxer
   3  *
   4  * Copyright (c) 2008 Maxim Poliakovski
   5  *               2008 Benjamin Larsson
   6  *               2011 David Goldwich
   7  *
   8  * This file is part of FFmpeg.
   9  *
  10  * FFmpeg is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2.1 of the License, or (at your option) any later version.
  14  *
  15  * FFmpeg is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with FFmpeg; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  23  */
  24
  25 /**
  26  * @file
  27  * This is a demuxer for Sony OpenMG Music files
  28  *
  29  * Known file extensions: ".oma", "aa3"
  30  * The format of such files consists of three parts:
  31  * - "ea3" header carrying overall info and metadata. Except for starting with
  32  *   "ea" instead of "ID", it's an ID3v2 header.
  33  * - "EA3" header is a Sony-specific header containing information about
  34  *   the OpenMG file: codec type (usually ATRAC, can also be MP3 or WMA),
  35  *   codec specific info (packet size, sample rate, channels and so on)
  36  *   and DRM related info (file encryption, content id).
  37  * - Sound data organized in packets follow the EA3 header
  38  *   (can be encrypted using the Sony DRM!).
  39  *
  40  * CODEC SUPPORT: Only ATRAC3 codec is currently supported!
  41  */
  42
  43 #include "avformat.h"
  44 #include "internal.h"
  45 #include "libavutil/intreadwrite.h"
  46 #include "libavutil/des.h"
  47 #include "oma.h"
  48 #include "pcm.h"
  49 #include "riff.h"
  50 #include "id3v2.h"
  51
  52
  53 static const uint64_t leaf_table[] = {
  54     0xd79e8283acea4620, 0x7a9762f445afd0d8,
  55     0x354d60a60b8c79f1, 0x584e1cde00b07aee,
  56     0x1573cd93da7df623, 0x47f98d79620dd535
  57 };
  58
  59 typedef struct OMAContext {
  60     uint64_t content_start;
  61     int encrypted;
  62     uint16_t k_size;
  63     uint16_t e_size;
  64     uint16_t i_size;
  65     uint16_t s_size;
  66     uint32_t rid;
  67     uint8_t r_val[24];
  68     uint8_t n_val[24];
  69     uint8_t m_val[8];
  70     uint8_t s_val[8];
  71     uint8_t sm_val[8];
  72     uint8_t e_val[8];
  73     uint8_t iv[8];
  74     struct AVDES av_des;
  75 } OMAContext;
  76
  77 static void hex_log(AVFormatContext *s, int level, const char *name, const uint8_t *value, int len)
  78 {
  79     char buf[33];
  80     len = FFMIN(len, 16);
  81     if (av_log_get_level() < level)
  82         return;
  83     ff_data_to_hex(buf, value, len, 1);
  84     buf[len<<1] = '\0';
  85     av_log(s, level, "%s: %s\n", name, buf);
  86 }
  87
  88 static int kset(AVFormatContext *s, const uint8_t *r_val, const uint8_t *n_val, int len)
  89 {
  90     OMAContext *oc = s->priv_data;
  91
  92     if (!r_val && !n_val)
  93         return -1;
  94
  95     len = FFMIN(len, 16);
  96
  97     /* use first 64 bits in the third round again */
  98     if (r_val) {
  99         if (r_val != oc->r_val) {
 100             memset(oc->r_val, 0, 24);
 101             memcpy(oc->r_val, r_val, len);
 102         }
 103         memcpy(&oc->r_val[16], r_val, 8);
 104     }
 105     if (n_val) {
 106         if (n_val != oc->n_val) {
 107             memset(oc->n_val, 0, 24);
 108             memcpy(oc->n_val, n_val, len);
 109         }
 110         memcpy(&oc->n_val[16], n_val, 8);
 111     }
 112
 113     return 0;
 114 }
 115
 116 static int rprobe(AVFormatContext *s, uint8_t *enc_header, const uint8_t *r_val)
 117 {
 118     OMAContext *oc = s->priv_data;
 119     unsigned int pos;
 120     struct AVDES av_des;
 121
 122     if (!enc_header || !r_val)
 123         return -1;
 124
 125     /* m_val */
 126     av_des_init(&av_des, r_val, 192, 1);
 127     av_des_crypt(&av_des, oc->m_val, &enc_header[48], 1, NULL, 1);
 128
 129     /* s_val */
 130     av_des_init(&av_des, oc->m_val, 64, 0);
 131     av_des_crypt(&av_des, oc->s_val, NULL, 1, NULL, 0);
 132
 133     /* sm_val */
 134     pos = OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size;
 135     av_des_init(&av_des, oc->s_val, 64, 0);
 136     av_des_mac(&av_des, oc->sm_val, &enc_header[pos], (oc->i_size >> 3));
 137
 138     pos += oc->i_size;
 139
 140     return memcmp(&enc_header[pos], oc->sm_val, 8) ? -1 : 0;
 141 }
 142
 143 static int nprobe(AVFormatContext *s, uint8_t *enc_header, int size, const uint8_t *n_val)
 144 {
 145     OMAContext *oc = s->priv_data;
 146     uint32_t pos, taglen, datalen;
 147     struct AVDES av_des;
 148
 149     if (!enc_header || !n_val)
 150         return -1;
 151
 152     pos = OMA_ENC_HEADER_SIZE + oc->k_size;
 153     if (!memcmp(&enc_header[pos], "EKB ", 4))
 154         pos += 32;
 155
 156     if (AV_RB32(&enc_header[pos]) != oc->rid)
 157         av_log(s, AV_LOG_DEBUG, "Mismatching RID\n");
 158
 159     taglen = AV_RB32(&enc_header[pos+32]);
 160     datalen = AV_RB32(&enc_header[pos+36]) >> 4;
 161
 162     if(taglen + (((uint64_t)datalen)<<4) + 44 > size)
 163         return -1;
 164
 165     pos += 44 + taglen;
 166
 167     av_des_init(&av_des, n_val, 192, 1);
 168     while (datalen-- > 0) {
 169         av_des_crypt(&av_des, oc->r_val, &enc_header[pos], 2, NULL, 1);
 170         kset(s, oc->r_val, NULL, 16);
 171         if (!rprobe(s, enc_header, oc->r_val))
 172             return 0;
 173         pos += 16;
 174     }
 175
 176     return -1;
 177 }
 178
 179 static int decrypt_init(AVFormatContext *s, ID3v2ExtraMeta *em, uint8_t *header)
 180 {
 181     OMAContext *oc = s->priv_data;
 182     ID3v2ExtraMetaGEOB *geob = NULL;
 183     uint8_t *gdata;
 184
 185     oc->encrypted = 1;
 186     av_log(s, AV_LOG_INFO, "File is encrypted\n");
 187
 188     /* find GEOB metadata */
 189     while (em) {
 190         if (!strcmp(em->tag, "GEOB") &&
 191             (geob = em->data) &&
 192             (!strcmp(geob->description, "OMG_LSI") ||
 193              !strcmp(geob->description, "OMG_BKLSI"))) {
 194             break;
 195         }
 196         em = em->next;
 197     }
 198     if (!em) {
 199         av_log(s, AV_LOG_ERROR, "No encryption header found\n");
 200         return -1;
 201     }
 202
 203     if (geob->datasize < 64) {
 204         av_log(s, AV_LOG_ERROR, "Invalid GEOB data size: %u\n", geob->datasize);
 205         return -1;
 206     }
 207
 208     gdata = geob->data;
 209
 210     if (AV_RB16(gdata) != 1)
 211         av_log(s, AV_LOG_WARNING, "Unknown version in encryption header\n");
 212
 213     oc->k_size = AV_RB16(&gdata[2]);
 214     oc->e_size = AV_RB16(&gdata[4]);
 215     oc->i_size = AV_RB16(&gdata[6]);
 216     oc->s_size = AV_RB16(&gdata[8]);
 217
 218     if (memcmp(&gdata[OMA_ENC_HEADER_SIZE], "KEYRING     ", 12)) {
 219         av_log(s, AV_LOG_ERROR, "Invalid encryption header\n");
 220         return -1;
 221     }
 222     oc->rid = AV_RB32(&gdata[OMA_ENC_HEADER_SIZE + 28]);
 223     av_log(s, AV_LOG_DEBUG, "RID: %.8x\n", oc->rid);
 224
 225     memcpy(oc->iv, &header[0x58], 8);
 226     hex_log(s, AV_LOG_DEBUG, "IV", oc->iv, 8);
 227
 228     hex_log(s, AV_LOG_DEBUG, "CBC-MAC", &gdata[OMA_ENC_HEADER_SIZE+oc->k_size+oc->e_size+oc->i_size], 8);
 229
 230     if (s->keylen > 0) {
 231         kset(s, s->key, s->key, s->keylen);
 232     }
 233     if (!memcmp(oc->r_val, (const uint8_t[8]){0}, 8) ||
 234         rprobe(s, gdata, oc->r_val) < 0 &&
 235         nprobe(s, gdata, geob->datasize, oc->n_val) < 0) {
 236         int i;
 237         for (i = 0; i < sizeof(leaf_table); i += 2) {
 238             uint8_t buf[16];
 239             AV_WL64(buf, leaf_table[i]);
 240             AV_WL64(&buf[8], leaf_table[i+1]);
 241             kset(s, buf, buf, 16);
 242             if (!rprobe(s, gdata, oc->r_val) || !nprobe(s, gdata, geob->datasize, oc->n_val))
 243                 break;
 244         }
 245         if (i >= sizeof(leaf_table)) {
 246             av_log(s, AV_LOG_ERROR, "Invalid key\n");
 247             return -1;
 248         }
 249     }
 250
 251     /* e_val */
 252     av_des_init(&oc->av_des, oc->m_val, 64, 0);
 253     av_des_crypt(&oc->av_des, oc->e_val, &gdata[OMA_ENC_HEADER_SIZE + 40], 1, NULL, 0);
 254     hex_log(s, AV_LOG_DEBUG, "EK", oc->e_val, 8);
 255
 256     /* init e_val */
 257     av_des_init(&oc->av_des, oc->e_val, 64, 1);
 258
 259     return 0;
 260 }
 261
 262 static int oma_read_header(AVFormatContext *s,
 263                            AVFormatParameters *ap)
 264 {
 265     int     ret, framesize, jsflag, samplerate;
 266     uint32_t codec_params;
 267     int16_t eid;
 268     uint8_t buf[EA3_HEADER_SIZE];
 269     uint8_t *edata;
 270     AVStream *st;
 271     ID3v2ExtraMeta *extra_meta = NULL;
 272     OMAContext *oc = s->priv_data;
 273
 274     ff_id3v2_read_all(s, ID3v2_EA3_MAGIC, &extra_meta);
 275     ret = avio_read(s->pb, buf, EA3_HEADER_SIZE);
 276     if (ret < EA3_HEADER_SIZE)
 277         return -1;
 278
 279     if (memcmp(buf, ((const uint8_t[]){'E', 'A', '3'}),3) || buf[4] != 0 || buf[5] != EA3_HEADER_SIZE) {
 280         av_log(s, AV_LOG_ERROR, "Couldn't find the EA3 header !\n");
 281         return -1;
 282     }
 283
 284     oc->content_start = avio_tell(s->pb);
 285
 286     /* encrypted file */
 287     eid = AV_RB16(&buf[6]);
 288     if (eid != -1 && eid != -128 && decrypt_init(s, extra_meta, buf) < 0) {
 289         ff_id3v2_free_extra_meta(&extra_meta);
 290         return -1;
 291     }
 292
 293     ff_id3v2_free_extra_meta(&extra_meta);
 294
 295     codec_params = AV_RB24(&buf[33]);
 296
 297     st = avformat_new_stream(s, NULL);
 298     if (!st)
 299         return AVERROR(ENOMEM);
 300
 301     st->start_time = 0;
 302     st->codec->codec_type  = AVMEDIA_TYPE_AUDIO;
 303     st->codec->codec_tag   = buf[32];
 304     st->codec->codec_id    = ff_codec_get_id(ff_oma_codec_tags, st->codec->codec_tag);
 305
 306     switch (buf[32]) {
 307         case OMA_CODECID_ATRAC3:
 308             samplerate = ff_oma_srate_tab[(codec_params >> 13) & 7]*100;
 309             if (samplerate != 44100)
 310                 av_log_ask_for_sample(s, "Unsupported sample rate: %d\n",
 311                                       samplerate);
 312
 313             framesize = (codec_params & 0x3FF) * 8;
 314             jsflag = (codec_params >> 17) & 1; /* get stereo coding mode, 1 for joint-stereo */
 315             st->codec->channels    = 2;
 316             st->codec->sample_rate = samplerate;
 317             st->codec->bit_rate    = st->codec->sample_rate * framesize * 8 / 1024;
 318
 319             /* fake the atrac3 extradata (wav format, makes stream copy to wav work) */
 320             st->codec->extradata_size = 14;
 321             edata = av_mallocz(14 + FF_INPUT_BUFFER_PADDING_SIZE);
 322             if (!edata)
 323                 return AVERROR(ENOMEM);
 324
 325             st->codec->extradata = edata;
 326             AV_WL16(&edata[0],  1);             // always 1
 327             AV_WL32(&edata[2],  samplerate);    // samples rate
 328             AV_WL16(&edata[6],  jsflag);        // coding mode
 329             AV_WL16(&edata[8],  jsflag);        // coding mode
 330             AV_WL16(&edata[10], 1);             // always 1
 331             // AV_WL16(&edata[12], 0);          // always 0
 332
 333             avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
 334             break;
 335         case OMA_CODECID_ATRAC3P:
 336             st->codec->channels = (codec_params >> 10) & 7;
 337             framesize = ((codec_params & 0x3FF) * 8) + 8;
 338             st->codec->sample_rate = ff_oma_srate_tab[(codec_params >> 13) & 7]*100;
 339             st->codec->bit_rate    = st->codec->sample_rate * framesize * 8 / 1024;
 340             avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
 341             av_log(s, AV_LOG_ERROR, "Unsupported codec ATRAC3+!\n");
 342             break;
 343         case OMA_CODECID_MP3:
 344             st->need_parsing = AVSTREAM_PARSE_FULL;
 345             framesize = 1024;
 346             break;
 347         case OMA_CODECID_LPCM:
 348             /* PCM 44.1 kHz 16 bit stereo big-endian */
 349             st->codec->channels = 2;
 350             st->codec->sample_rate = 44100;
 351             framesize = 1024;
 352             /* bit rate = sample rate x PCM block align (= 4) x 8 */
 353             st->codec->bit_rate = st->codec->sample_rate * 32;
 354             st->codec->bits_per_coded_sample = av_get_bits_per_sample(st->codec->codec_id);
 355             avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
 356             break;
 357         default:
 358             av_log(s, AV_LOG_ERROR, "Unsupported codec %d!\n",buf[32]);
 359             return -1;
 360     }
 361
 362     st->codec->block_align = framesize;
 363
 364     return 0;
 365 }
 366
 367
 368 static int oma_read_packet(AVFormatContext *s, AVPacket *pkt)
 369 {
 370     OMAContext *oc = s->priv_data;
 371     int packet_size = s->streams[0]->codec->block_align;
 372     int ret = av_get_packet(s->pb, pkt, packet_size);
 373
 374     if (ret <= 0)
 375         return AVERROR(EIO);
 376
 377     pkt->stream_index = 0;
 378
 379     if (oc->encrypted) {
 380         /* previous unencrypted block saved in IV for the next packet (CBC mode) */
 381         av_des_crypt(&oc->av_des, pkt->data, pkt->data, (packet_size >> 3), oc->iv, 1);
 382     }
 383
 384     return ret;
 385 }
 386
 387 static int oma_read_probe(AVProbeData *p)
 388 {
 389     const uint8_t *buf;
 390     unsigned tag_len = 0;
 391
 392     buf = p->buf;
 393
 394     if (p->buf_size < ID3v2_HEADER_SIZE ||
 395         !ff_id3v2_match(buf, ID3v2_EA3_MAGIC) ||
 396         buf[3] != 3 || // version must be 3
 397         buf[4]) // flags byte zero
 398         return 0;
 399
 400     tag_len = ff_id3v2_tag_len(buf);
 401
 402     /* This check cannot overflow as tag_len has at most 28 bits */
 403     if (p->buf_size < tag_len + 5)
 404         /* EA3 header comes late, might be outside of the probe buffer */
 405         return AVPROBE_SCORE_MAX / 2;
 406
 407     buf += tag_len;
 408
 409     if (!memcmp(buf, "EA3", 3) && !buf[4] && buf[5] == EA3_HEADER_SIZE)
 410         return AVPROBE_SCORE_MAX;
 411     else
 412         return 0;
 413 }
 414
 415 static int oma_read_seek(struct AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
 416 {
 417     OMAContext *oc = s->priv_data;
 418
 419     pcm_read_seek(s, stream_index, timestamp, flags);
 420
 421     if (oc->encrypted) {
 422         /* readjust IV for CBC */
 423         int64_t pos = avio_tell(s->pb);
 424         if (pos < oc->content_start)
 425             memset(oc->iv, 0, 8);
 426         else {
 427             if (avio_seek(s->pb, -8, SEEK_CUR) < 0 || avio_read(s->pb, oc->iv, 8) < 8) {
 428                 memset(oc->iv, 0, 8);
 429                 return -1;
 430             }
 431         }
 432     }
 433
 434     return 0;
 435 }
 436
 437 AVInputFormat ff_oma_demuxer = {
 438     .name           = "oma",
 439     .long_name      = NULL_IF_CONFIG_SMALL("Sony OpenMG audio"),
 440     .priv_data_size = sizeof(OMAContext),
 441     .read_probe     = oma_read_probe,
 442     .read_header    = oma_read_header,
 443     .read_packet    = oma_read_packet,
 444     .read_seek      = oma_read_seek,
 445     .flags          = AVFMT_GENERIC_INDEX,
 446     .extensions     = "oma,omg,aa3",
 447     .codec_tag      = (const AVCodecTag* const []){ff_oma_codec_tags, 0},
 448 };
 449