yading@11: /*
yading@11:  * Sony OpenMG (OMA) demuxer
yading@11:  *
yading@11:  * Copyright (c) 2008 Maxim Poliakovski
yading@11:  *               2008 Benjamin Larsson
yading@11:  *               2011 David Goldwich
yading@11:  *
yading@11:  * This file is part of FFmpeg.
yading@11:  *
yading@11:  * FFmpeg is free software; you can redistribute it and/or
yading@11:  * modify it under the terms of the GNU Lesser General Public
yading@11:  * License as published by the Free Software Foundation; either
yading@11:  * version 2.1 of the License, or (at your option) any later version.
yading@11:  *
yading@11:  * FFmpeg is distributed in the hope that it will be useful,
yading@11:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@11:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@11:  * Lesser General Public License for more details.
yading@11:  *
yading@11:  * You should have received a copy of the GNU Lesser General Public
yading@11:  * License along with FFmpeg; if not, write to the Free Software
yading@11:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@11:  */
yading@11: 
yading@11: /**
yading@11:  * @file
yading@11:  * This is a demuxer for Sony OpenMG Music files
yading@11:  *
yading@11:  * Known file extensions: ".oma", "aa3"
yading@11:  * The format of such files consists of three parts:
yading@11:  * - "ea3" header carrying overall info and metadata. Except for starting with
yading@11:  *   "ea" instead of "ID", it's an ID3v2 header.
yading@11:  * - "EA3" header is a Sony-specific header containing information about
yading@11:  *   the OpenMG file: codec type (usually ATRAC, can also be MP3 or WMA),
yading@11:  *   codec specific info (packet size, sample rate, channels and so on)
yading@11:  *   and DRM related info (file encryption, content id).
yading@11:  * - Sound data organized in packets follow the EA3 header
yading@11:  *   (can be encrypted using the Sony DRM!).
yading@11:  *
yading@11:  */
yading@11: 
yading@11: #include "libavutil/channel_layout.h"
yading@11: #include "avformat.h"
yading@11: #include "internal.h"
yading@11: #include "libavutil/intreadwrite.h"
yading@11: #include "libavutil/des.h"
yading@11: #include "oma.h"
yading@11: #include "pcm.h"
yading@11: #include "id3v2.h"
yading@11: 
yading@11: 
yading@11: static const uint64_t leaf_table[] = {
yading@11:     0xd79e8283acea4620, 0x7a9762f445afd0d8,
yading@11:     0x354d60a60b8c79f1, 0x584e1cde00b07aee,
yading@11:     0x1573cd93da7df623, 0x47f98d79620dd535
yading@11: };
yading@11: 
yading@11: typedef struct OMAContext {
yading@11:     uint64_t content_start;
yading@11:     int encrypted;
yading@11:     uint16_t k_size;
yading@11:     uint16_t e_size;
yading@11:     uint16_t i_size;
yading@11:     uint16_t s_size;
yading@11:     uint32_t rid;
yading@11:     uint8_t r_val[24];
yading@11:     uint8_t n_val[24];
yading@11:     uint8_t m_val[8];
yading@11:     uint8_t s_val[8];
yading@11:     uint8_t sm_val[8];
yading@11:     uint8_t e_val[8];
yading@11:     uint8_t iv[8];
yading@11:     struct AVDES av_des;
yading@11: } OMAContext;
yading@11: 
yading@11: static void hex_log(AVFormatContext *s, int level, const char *name, const uint8_t *value, int len)
yading@11: {
yading@11:     char buf[33];
yading@11:     len = FFMIN(len, 16);
yading@11:     if (av_log_get_level() < level)
yading@11:         return;
yading@11:     ff_data_to_hex(buf, value, len, 1);
yading@11:     buf[len<<1] = '\0';
yading@11:     av_log(s, level, "%s: %s\n", name, buf);
yading@11: }
yading@11: 
yading@11: static int kset(AVFormatContext *s, const uint8_t *r_val, const uint8_t *n_val, int len)
yading@11: {
yading@11:     OMAContext *oc = s->priv_data;
yading@11: 
yading@11:     if (!r_val && !n_val)
yading@11:         return -1;
yading@11: 
yading@11:     len = FFMIN(len, 16);
yading@11: 
yading@11:     /* use first 64 bits in the third round again */
yading@11:     if (r_val) {
yading@11:         if (r_val != oc->r_val) {
yading@11:             memset(oc->r_val, 0, 24);
yading@11:             memcpy(oc->r_val, r_val, len);
yading@11:         }
yading@11:         memcpy(&oc->r_val[16], r_val, 8);
yading@11:     }
yading@11:     if (n_val) {
yading@11:         if (n_val != oc->n_val) {
yading@11:             memset(oc->n_val, 0, 24);
yading@11:             memcpy(oc->n_val, n_val, len);
yading@11:         }
yading@11:         memcpy(&oc->n_val[16], n_val, 8);
yading@11:     }
yading@11: 
yading@11:     return 0;
yading@11: }
yading@11: 
yading@11: static int rprobe(AVFormatContext *s, uint8_t *enc_header, const uint8_t *r_val)
yading@11: {
yading@11:     OMAContext *oc = s->priv_data;
yading@11:     unsigned int pos;
yading@11:     struct AVDES av_des;
yading@11: 
yading@11:     if (!enc_header || !r_val)
yading@11:         return -1;
yading@11: 
yading@11:     /* m_val */
yading@11:     av_des_init(&av_des, r_val, 192, 1);
yading@11:     av_des_crypt(&av_des, oc->m_val, &enc_header[48], 1, NULL, 1);
yading@11: 
yading@11:     /* s_val */
yading@11:     av_des_init(&av_des, oc->m_val, 64, 0);
yading@11:     av_des_crypt(&av_des, oc->s_val, NULL, 1, NULL, 0);
yading@11: 
yading@11:     /* sm_val */
yading@11:     pos = OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size;
yading@11:     av_des_init(&av_des, oc->s_val, 64, 0);
yading@11:     av_des_mac(&av_des, oc->sm_val, &enc_header[pos], (oc->i_size >> 3));
yading@11: 
yading@11:     pos += oc->i_size;
yading@11: 
yading@11:     return memcmp(&enc_header[pos], oc->sm_val, 8) ? -1 : 0;
yading@11: }
yading@11: 
yading@11: static int nprobe(AVFormatContext *s, uint8_t *enc_header, int size, const uint8_t *n_val)
yading@11: {
yading@11:     OMAContext *oc = s->priv_data;
yading@11:     uint32_t pos, taglen, datalen;
yading@11:     struct AVDES av_des;
yading@11: 
yading@11:     if (!enc_header || !n_val)
yading@11:         return -1;
yading@11: 
yading@11:     pos = OMA_ENC_HEADER_SIZE + oc->k_size;
yading@11:     if (!memcmp(&enc_header[pos], "EKB ", 4))
yading@11:         pos += 32;
yading@11: 
yading@11:     if (AV_RB32(&enc_header[pos]) != oc->rid)
yading@11:         av_log(s, AV_LOG_DEBUG, "Mismatching RID\n");
yading@11: 
yading@11:     taglen = AV_RB32(&enc_header[pos+32]);
yading@11:     datalen = AV_RB32(&enc_header[pos+36]) >> 4;
yading@11: 
yading@11:     if(pos + (uint64_t)taglen + (((uint64_t)datalen)<<4) + 44 > size)
yading@11:         return -1;
yading@11: 
yading@11:     pos += 44 + taglen;
yading@11: 
yading@11:     av_des_init(&av_des, n_val, 192, 1);
yading@11:     while (datalen-- > 0) {
yading@11:         av_des_crypt(&av_des, oc->r_val, &enc_header[pos], 2, NULL, 1);
yading@11:         kset(s, oc->r_val, NULL, 16);
yading@11:         if (!rprobe(s, enc_header, oc->r_val))
yading@11:             return 0;
yading@11:         pos += 16;
yading@11:     }
yading@11: 
yading@11:     return -1;
yading@11: }
yading@11: 
yading@11: static int decrypt_init(AVFormatContext *s, ID3v2ExtraMeta *em, uint8_t *header)
yading@11: {
yading@11:     OMAContext *oc = s->priv_data;
yading@11:     ID3v2ExtraMetaGEOB *geob = NULL;
yading@11:     uint8_t *gdata;
yading@11: 
yading@11:     oc->encrypted = 1;
yading@11:     av_log(s, AV_LOG_INFO, "File is encrypted\n");
yading@11: 
yading@11:     /* find GEOB metadata */
yading@11:     while (em) {
yading@11:         if (!strcmp(em->tag, "GEOB") &&
yading@11:             (geob = em->data) &&
yading@11:             (!strcmp(geob->description, "OMG_LSI") ||
yading@11:              !strcmp(geob->description, "OMG_BKLSI"))) {
yading@11:             break;
yading@11:         }
yading@11:         em = em->next;
yading@11:     }
yading@11:     if (!em) {
yading@11:         av_log(s, AV_LOG_ERROR, "No encryption header found\n");
yading@11:         return -1;
yading@11:     }
yading@11: 
yading@11:     if (geob->datasize < 64) {
yading@11:         av_log(s, AV_LOG_ERROR, "Invalid GEOB data size: %u\n", geob->datasize);
yading@11:         return -1;
yading@11:     }
yading@11: 
yading@11:     gdata = geob->data;
yading@11: 
yading@11:     if (AV_RB16(gdata) != 1)
yading@11:         av_log(s, AV_LOG_WARNING, "Unknown version in encryption header\n");
yading@11: 
yading@11:     oc->k_size = AV_RB16(&gdata[2]);
yading@11:     oc->e_size = AV_RB16(&gdata[4]);
yading@11:     oc->i_size = AV_RB16(&gdata[6]);
yading@11:     oc->s_size = AV_RB16(&gdata[8]);
yading@11: 
yading@11:     if (memcmp(&gdata[OMA_ENC_HEADER_SIZE], "KEYRING     ", 12)) {
yading@11:         av_log(s, AV_LOG_ERROR, "Invalid encryption header\n");
yading@11:         return -1;
yading@11:     }
yading@11:     if (   OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size + oc->i_size + 8 > geob->datasize
yading@11:         || OMA_ENC_HEADER_SIZE + 48 > geob->datasize
yading@11:     ) {
yading@11:         av_log(s, AV_LOG_ERROR, "Too little GEOB data\n");
yading@11:         return AVERROR_INVALIDDATA;
yading@11:     }
yading@11:     oc->rid = AV_RB32(&gdata[OMA_ENC_HEADER_SIZE + 28]);
yading@11:     av_log(s, AV_LOG_DEBUG, "RID: %.8x\n", oc->rid);
yading@11: 
yading@11:     memcpy(oc->iv, &header[0x58], 8);
yading@11:     hex_log(s, AV_LOG_DEBUG, "IV", oc->iv, 8);
yading@11: 
yading@11:     hex_log(s, AV_LOG_DEBUG, "CBC-MAC", &gdata[OMA_ENC_HEADER_SIZE+oc->k_size+oc->e_size+oc->i_size], 8);
yading@11: 
yading@11:     if (s->keylen > 0) {
yading@11:         kset(s, s->key, s->key, s->keylen);
yading@11:     }
yading@11:     if (!memcmp(oc->r_val, (const uint8_t[8]){0}, 8) ||
yading@11:         rprobe(s, gdata, oc->r_val) < 0 &&
yading@11:         nprobe(s, gdata, geob->datasize, oc->n_val) < 0) {
yading@11:         int i;
yading@11:         for (i = 0; i < FF_ARRAY_ELEMS(leaf_table); i += 2) {
yading@11:             uint8_t buf[16];
yading@11:             AV_WL64(buf, leaf_table[i]);
yading@11:             AV_WL64(&buf[8], leaf_table[i+1]);
yading@11:             kset(s, buf, buf, 16);
yading@11:             if (!rprobe(s, gdata, oc->r_val) || !nprobe(s, gdata, geob->datasize, oc->n_val))
yading@11:                 break;
yading@11:         }
yading@11:         if (i >= FF_ARRAY_ELEMS(leaf_table)) {
yading@11:             av_log(s, AV_LOG_ERROR, "Invalid key\n");
yading@11:             return -1;
yading@11:         }
yading@11:     }
yading@11: 
yading@11:     /* e_val */
yading@11:     av_des_init(&oc->av_des, oc->m_val, 64, 0);
yading@11:     av_des_crypt(&oc->av_des, oc->e_val, &gdata[OMA_ENC_HEADER_SIZE + 40], 1, NULL, 0);
yading@11:     hex_log(s, AV_LOG_DEBUG, "EK", oc->e_val, 8);
yading@11: 
yading@11:     /* init e_val */
yading@11:     av_des_init(&oc->av_des, oc->e_val, 64, 1);
yading@11: 
yading@11:     return 0;
yading@11: }
yading@11: 
yading@11: static int oma_read_header(AVFormatContext *s)
yading@11: {
yading@11:     int     ret, framesize, jsflag, samplerate;
yading@11:     uint32_t codec_params;
yading@11:     int16_t eid;
yading@11:     uint8_t buf[EA3_HEADER_SIZE];
yading@11:     uint8_t *edata;
yading@11:     AVStream *st;
yading@11:     ID3v2ExtraMeta *extra_meta = NULL;
yading@11:     OMAContext *oc = s->priv_data;
yading@11: 
yading@11:     ff_id3v2_read(s, ID3v2_EA3_MAGIC, &extra_meta);
yading@11:     ret = avio_read(s->pb, buf, EA3_HEADER_SIZE);
yading@11:     if (ret < EA3_HEADER_SIZE)
yading@11:         return -1;
yading@11: 
yading@11:     if (memcmp(buf, ((const uint8_t[]){'E', 'A', '3'}),3) || buf[4] != 0 || buf[5] != EA3_HEADER_SIZE) {
yading@11:         av_log(s, AV_LOG_ERROR, "Couldn't find the EA3 header !\n");
yading@11:         return -1;
yading@11:     }
yading@11: 
yading@11:     oc->content_start = avio_tell(s->pb);
yading@11: 
yading@11:     /* encrypted file */
yading@11:     eid = AV_RB16(&buf[6]);
yading@11:     if (eid != -1 && eid != -128 && decrypt_init(s, extra_meta, buf) < 0) {
yading@11:         ff_id3v2_free_extra_meta(&extra_meta);
yading@11:         return -1;
yading@11:     }
yading@11: 
yading@11:     ff_id3v2_free_extra_meta(&extra_meta);
yading@11: 
yading@11:     codec_params = AV_RB24(&buf[33]);
yading@11: 
yading@11:     st = avformat_new_stream(s, NULL);
yading@11:     if (!st)
yading@11:         return AVERROR(ENOMEM);
yading@11: 
yading@11:     st->start_time = 0;
yading@11:     st->codec->codec_type  = AVMEDIA_TYPE_AUDIO;
yading@11:     st->codec->codec_tag   = buf[32];
yading@11:     st->codec->codec_id    = ff_codec_get_id(ff_oma_codec_tags, st->codec->codec_tag);
yading@11: 
yading@11:     switch (buf[32]) {
yading@11:         case OMA_CODECID_ATRAC3:
yading@11:             samplerate = ff_oma_srate_tab[(codec_params >> 13) & 7] * 100;
yading@11:             if (!samplerate) {
yading@11:                 av_log(s, AV_LOG_ERROR, "Unsupported sample rate\n");
yading@11:                 return AVERROR_INVALIDDATA;
yading@11:             }
yading@11:             if (samplerate != 44100)
yading@11:                 avpriv_request_sample(s, "Sample rate %d", samplerate);
yading@11: 
yading@11:             framesize = (codec_params & 0x3FF) * 8;
yading@11:             jsflag = (codec_params >> 17) & 1; /* get stereo coding mode, 1 for joint-stereo */
yading@11:             st->codec->channels    = 2;
yading@11:             st->codec->channel_layout = AV_CH_LAYOUT_STEREO;
yading@11:             st->codec->sample_rate = samplerate;
yading@11:             st->codec->bit_rate    = st->codec->sample_rate * framesize * 8 / 1024;
yading@11: 
yading@11:             /* fake the atrac3 extradata (wav format, makes stream copy to wav work) */
yading@11:             st->codec->extradata_size = 14;
yading@11:             edata = av_mallocz(14 + FF_INPUT_BUFFER_PADDING_SIZE);
yading@11:             if (!edata)
yading@11:                 return AVERROR(ENOMEM);
yading@11: 
yading@11:             st->codec->extradata = edata;
yading@11:             AV_WL16(&edata[0],  1);             // always 1
yading@11:             AV_WL32(&edata[2],  samplerate);    // samples rate
yading@11:             AV_WL16(&edata[6],  jsflag);        // coding mode
yading@11:             AV_WL16(&edata[8],  jsflag);        // coding mode
yading@11:             AV_WL16(&edata[10], 1);             // always 1
yading@11:             // AV_WL16(&edata[12], 0);          // always 0
yading@11: 
yading@11:             avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
yading@11:             break;
yading@11:         case OMA_CODECID_ATRAC3P:
yading@11:             st->codec->channels = (codec_params >> 10) & 7;
yading@11:             framesize = ((codec_params & 0x3FF) * 8) + 8;
yading@11:             samplerate = ff_oma_srate_tab[(codec_params >> 13) & 7] * 100;
yading@11:             if (!samplerate) {
yading@11:                 av_log(s, AV_LOG_ERROR, "Unsupported sample rate\n");
yading@11:                 return AVERROR_INVALIDDATA;
yading@11:             }
yading@11:             st->codec->sample_rate = samplerate;
yading@11:             st->codec->bit_rate    = samplerate * framesize * 8 / 1024;
yading@11:             avpriv_set_pts_info(st, 64, 1, samplerate);
yading@11:             av_log(s, AV_LOG_ERROR, "Unsupported codec ATRAC3+!\n");
yading@11:             break;
yading@11:         case OMA_CODECID_MP3:
yading@11:             st->need_parsing = AVSTREAM_PARSE_FULL_RAW;
yading@11:             framesize = 1024;
yading@11:             break;
yading@11:         case OMA_CODECID_LPCM:
yading@11:             /* PCM 44.1 kHz 16 bit stereo big-endian */
yading@11:             st->codec->channels = 2;
yading@11:             st->codec->channel_layout = AV_CH_LAYOUT_STEREO;
yading@11:             st->codec->sample_rate = 44100;
yading@11:             framesize = 1024;
yading@11:             /* bit rate = sample rate x PCM block align (= 4) x 8 */
yading@11:             st->codec->bit_rate = st->codec->sample_rate * 32;
yading@11:             st->codec->bits_per_coded_sample = av_get_bits_per_sample(st->codec->codec_id);
yading@11:             avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
yading@11:             break;
yading@11:         default:
yading@11:             av_log(s, AV_LOG_ERROR, "Unsupported codec %d!\n",buf[32]);
yading@11:             return -1;
yading@11:     }
yading@11: 
yading@11:     st->codec->block_align = framesize;
yading@11: 
yading@11:     return 0;
yading@11: }
yading@11: 
yading@11: 
yading@11: static int oma_read_packet(AVFormatContext *s, AVPacket *pkt)
yading@11: {
yading@11:     OMAContext *oc = s->priv_data;
yading@11:     int packet_size = s->streams[0]->codec->block_align;
yading@11:     int ret = av_get_packet(s->pb, pkt, packet_size);
yading@11: 
yading@11:     if (ret <= 0)
yading@11:         return AVERROR(EIO);
yading@11: 
yading@11:     pkt->stream_index = 0;
yading@11: 
yading@11:     if (oc->encrypted) {
yading@11:         /* previous unencrypted block saved in IV for the next packet (CBC mode) */
yading@11:         av_des_crypt(&oc->av_des, pkt->data, pkt->data, (ret >> 3), oc->iv, 1);
yading@11:     }
yading@11: 
yading@11:     return ret;
yading@11: }
yading@11: 
yading@11: static int oma_read_probe(AVProbeData *p)
yading@11: {
yading@11:     const uint8_t *buf;
yading@11:     unsigned tag_len = 0;
yading@11: 
yading@11:     buf = p->buf;
yading@11: 
yading@11:     if (p->buf_size < ID3v2_HEADER_SIZE ||
yading@11:         !ff_id3v2_match(buf, ID3v2_EA3_MAGIC) ||
yading@11:         buf[3] != 3 || // version must be 3
yading@11:         buf[4]) // flags byte zero
yading@11:         return 0;
yading@11: 
yading@11:     tag_len = ff_id3v2_tag_len(buf);
yading@11: 
yading@11:     /* This check cannot overflow as tag_len has at most 28 bits */
yading@11:     if (p->buf_size < tag_len + 5)
yading@11:         /* EA3 header comes late, might be outside of the probe buffer */
yading@11:         return AVPROBE_SCORE_MAX / 2;
yading@11: 
yading@11:     buf += tag_len;
yading@11: 
yading@11:     if (!memcmp(buf, "EA3", 3) && !buf[4] && buf[5] == EA3_HEADER_SIZE)
yading@11:         return AVPROBE_SCORE_MAX;
yading@11:     else
yading@11:         return 0;
yading@11: }
yading@11: 
yading@11: static int oma_read_seek(struct AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
yading@11: {
yading@11:     OMAContext *oc = s->priv_data;
yading@11: 
yading@11:     ff_pcm_read_seek(s, stream_index, timestamp, flags);
yading@11: 
yading@11:     if (oc->encrypted) {
yading@11:         /* readjust IV for CBC */
yading@11:         int64_t pos = avio_tell(s->pb);
yading@11:         if (pos < oc->content_start)
yading@11:             memset(oc->iv, 0, 8);
yading@11:         else {
yading@11:             if (avio_seek(s->pb, -8, SEEK_CUR) < 0 || avio_read(s->pb, oc->iv, 8) < 8) {
yading@11:                 memset(oc->iv, 0, 8);
yading@11:                 return -1;
yading@11:             }
yading@11:         }
yading@11:     }
yading@11: 
yading@11:     return 0;
yading@11: }
yading@11: 
yading@11: AVInputFormat ff_oma_demuxer = {
yading@11:     .name           = "oma",
yading@11:     .long_name      = NULL_IF_CONFIG_SMALL("Sony OpenMG audio"),
yading@11:     .priv_data_size = sizeof(OMAContext),
yading@11:     .read_probe     = oma_read_probe,
yading@11:     .read_header    = oma_read_header,
yading@11:     .read_packet    = oma_read_packet,
yading@11:     .read_seek      = oma_read_seek,
yading@11:     .flags          = AVFMT_GENERIC_INDEX,
yading@11:     .extensions     = "oma,omg,aa3",
yading@11:     .codec_tag      = (const AVCodecTag* const []){ff_oma_codec_tags, 0},
yading@11: };