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