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

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