2
* Sony OpenMG (OMA) demuxer
4
* Copyright (c) 2008 Maxim Poliakovski
5
* 2008 Benjamin Larsson
8
* This file is part of Libav.
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.
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.
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
27
* This is a demuxer for Sony OpenMG Music files
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!).
40
* CODEC SUPPORT: Only ATRAC3 codec is currently supported!
45
#include "libavutil/intreadwrite.h"
46
#include "libavutil/des.h"
53
static const uint64_t leaf_table[] = {
54
0xd79e8283acea4620, 0x7a9762f445afd0d8,
55
0x354d60a60b8c79f1, 0x584e1cde00b07aee,
56
0x1573cd93da7df623, 0x47f98d79620dd535
59
typedef struct OMAContext {
60
uint64_t content_start;
77
static void hex_log(AVFormatContext *s, int level, const char *name, const uint8_t *value, int len)
81
if (av_log_get_level() < level)
83
ff_data_to_hex(buf, value, len, 1);
85
av_log(s, level, "%s: %s\n", name, buf);
88
static int kset(AVFormatContext *s, const uint8_t *r_val, const uint8_t *n_val, int len)
90
OMAContext *oc = s->priv_data;
97
/* use first 64 bits in the third round again */
99
if (r_val != oc->r_val) {
100
memset(oc->r_val, 0, 24);
101
memcpy(oc->r_val, r_val, len);
103
memcpy(&oc->r_val[16], r_val, 8);
106
if (n_val != oc->n_val) {
107
memset(oc->n_val, 0, 24);
108
memcpy(oc->n_val, n_val, len);
110
memcpy(&oc->n_val[16], n_val, 8);
116
static int rprobe(AVFormatContext *s, uint8_t *enc_header, const uint8_t *r_val)
118
OMAContext *oc = s->priv_data;
122
if (!enc_header || !r_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);
130
av_des_init(&av_des, oc->m_val, 64, 0);
131
av_des_crypt(&av_des, oc->s_val, NULL, 1, NULL, 0);
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));
140
return memcmp(&enc_header[pos], oc->sm_val, 8) ? -1 : 0;
143
static int nprobe(AVFormatContext *s, uint8_t *enc_header, const uint8_t *n_val)
145
OMAContext *oc = s->priv_data;
146
uint32_t pos, taglen, datalen;
149
if (!enc_header || !n_val)
152
pos = OMA_ENC_HEADER_SIZE + oc->k_size;
153
if (!memcmp(&enc_header[pos], "EKB ", 4))
156
if (AV_RB32(&enc_header[pos]) != oc->rid)
157
av_log(s, AV_LOG_DEBUG, "Mismatching RID\n");
159
taglen = AV_RB32(&enc_header[pos+32]);
160
datalen = AV_RB32(&enc_header[pos+36]) >> 4;
164
av_des_init(&av_des, n_val, 192, 1);
165
while (datalen-- > 0) {
166
av_des_crypt(&av_des, oc->r_val, &enc_header[pos], 2, NULL, 1);
167
kset(s, oc->r_val, NULL, 16);
168
if (!rprobe(s, enc_header, oc->r_val))
176
static int decrypt_init(AVFormatContext *s, ID3v2ExtraMeta *em, uint8_t *header)
178
OMAContext *oc = s->priv_data;
179
ID3v2ExtraMetaGEOB *geob = NULL;
183
av_log(s, AV_LOG_INFO, "File is encrypted\n");
185
/* find GEOB metadata */
187
if (!strcmp(em->tag, "GEOB") &&
189
(!strcmp(geob->description, "OMG_LSI") ||
190
!strcmp(geob->description, "OMG_BKLSI"))) {
196
av_log(s, AV_LOG_ERROR, "No encryption header found\n");
200
if (geob->datasize < 64) {
201
av_log(s, AV_LOG_ERROR, "Invalid GEOB data size: %u\n", geob->datasize);
207
if (AV_RB16(gdata) != 1)
208
av_log(s, AV_LOG_WARNING, "Unknown version in encryption header\n");
210
oc->k_size = AV_RB16(&gdata[2]);
211
oc->e_size = AV_RB16(&gdata[4]);
212
oc->i_size = AV_RB16(&gdata[6]);
213
oc->s_size = AV_RB16(&gdata[8]);
215
if (memcmp(&gdata[OMA_ENC_HEADER_SIZE], "KEYRING ", 12)) {
216
av_log(s, AV_LOG_ERROR, "Invalid encryption header\n");
219
oc->rid = AV_RB32(&gdata[OMA_ENC_HEADER_SIZE + 28]);
220
av_log(s, AV_LOG_DEBUG, "RID: %.8x\n", oc->rid);
222
memcpy(oc->iv, &header[0x58], 8);
223
hex_log(s, AV_LOG_DEBUG, "IV", oc->iv, 8);
225
hex_log(s, AV_LOG_DEBUG, "CBC-MAC", &gdata[OMA_ENC_HEADER_SIZE+oc->k_size+oc->e_size+oc->i_size], 8);
228
kset(s, s->key, s->key, s->keylen);
230
if (!memcmp(oc->r_val, (const uint8_t[8]){0}, 8) ||
231
rprobe(s, gdata, oc->r_val) < 0 &&
232
nprobe(s, gdata, oc->n_val) < 0) {
234
for (i = 0; i < sizeof(leaf_table); i += 2) {
236
AV_WL64(buf, leaf_table[i]);
237
AV_WL64(&buf[8], leaf_table[i+1]);
238
kset(s, buf, buf, 16);
239
if (!rprobe(s, gdata, oc->r_val) || !nprobe(s, gdata, oc->n_val))
242
if (i >= sizeof(leaf_table)) {
243
av_log(s, AV_LOG_ERROR, "Invalid key\n");
249
av_des_init(&oc->av_des, oc->m_val, 64, 0);
250
av_des_crypt(&oc->av_des, oc->e_val, &gdata[OMA_ENC_HEADER_SIZE + 40], 1, NULL, 0);
251
hex_log(s, AV_LOG_DEBUG, "EK", oc->e_val, 8);
254
av_des_init(&oc->av_des, oc->e_val, 64, 1);
259
static int oma_read_header(AVFormatContext *s,
260
AVFormatParameters *ap)
262
int ret, framesize, jsflag, samplerate;
263
uint32_t codec_params;
265
uint8_t buf[EA3_HEADER_SIZE];
268
ID3v2ExtraMeta *extra_meta = NULL;
269
OMAContext *oc = s->priv_data;
271
ff_id3v2_read_all(s, ID3v2_EA3_MAGIC, &extra_meta);
272
ret = avio_read(s->pb, buf, EA3_HEADER_SIZE);
273
if (ret < EA3_HEADER_SIZE)
276
if (memcmp(buf, ((const uint8_t[]){'E', 'A', '3'}),3) || buf[4] != 0 || buf[5] != EA3_HEADER_SIZE) {
277
av_log(s, AV_LOG_ERROR, "Couldn't find the EA3 header !\n");
281
oc->content_start = avio_tell(s->pb);
284
eid = AV_RB16(&buf[6]);
285
if (eid != -1 && eid != -128 && decrypt_init(s, extra_meta, buf) < 0) {
286
ff_id3v2_free_extra_meta(&extra_meta);
290
ff_id3v2_free_extra_meta(&extra_meta);
292
codec_params = AV_RB24(&buf[33]);
294
st = avformat_new_stream(s, NULL);
296
return AVERROR(ENOMEM);
299
st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
300
st->codec->codec_tag = buf[32];
301
st->codec->codec_id = ff_codec_get_id(ff_oma_codec_tags, st->codec->codec_tag);
304
case OMA_CODECID_ATRAC3:
305
samplerate = ff_oma_srate_tab[(codec_params >> 13) & 7]*100;
306
if (samplerate != 44100)
307
av_log_ask_for_sample(s, "Unsupported sample rate: %d\n",
310
framesize = (codec_params & 0x3FF) * 8;
311
jsflag = (codec_params >> 17) & 1; /* get stereo coding mode, 1 for joint-stereo */
312
st->codec->channels = 2;
313
st->codec->sample_rate = samplerate;
314
st->codec->bit_rate = st->codec->sample_rate * framesize * 8 / 1024;
316
/* fake the atrac3 extradata (wav format, makes stream copy to wav work) */
317
st->codec->extradata_size = 14;
318
edata = av_mallocz(14 + FF_INPUT_BUFFER_PADDING_SIZE);
320
return AVERROR(ENOMEM);
322
st->codec->extradata = edata;
323
AV_WL16(&edata[0], 1); // always 1
324
AV_WL32(&edata[2], samplerate); // samples rate
325
AV_WL16(&edata[6], jsflag); // coding mode
326
AV_WL16(&edata[8], jsflag); // coding mode
327
AV_WL16(&edata[10], 1); // always 1
328
// AV_WL16(&edata[12], 0); // always 0
330
avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
332
case OMA_CODECID_ATRAC3P:
333
st->codec->channels = (codec_params >> 10) & 7;
334
framesize = ((codec_params & 0x3FF) * 8) + 8;
335
st->codec->sample_rate = ff_oma_srate_tab[(codec_params >> 13) & 7]*100;
336
st->codec->bit_rate = st->codec->sample_rate * framesize * 8 / 1024;
337
avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
338
av_log(s, AV_LOG_ERROR, "Unsupported codec ATRAC3+!\n");
340
case OMA_CODECID_MP3:
341
st->need_parsing = AVSTREAM_PARSE_FULL;
344
case OMA_CODECID_LPCM:
345
/* PCM 44.1 kHz 16 bit stereo big-endian */
346
st->codec->channels = 2;
347
st->codec->sample_rate = 44100;
349
/* bit rate = sample rate x PCM block align (= 4) x 8 */
350
st->codec->bit_rate = st->codec->sample_rate * 32;
351
st->codec->bits_per_coded_sample = av_get_bits_per_sample(st->codec->codec_id);
352
avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
355
av_log(s, AV_LOG_ERROR, "Unsupported codec %d!\n",buf[32]);
359
st->codec->block_align = framesize;
365
static int oma_read_packet(AVFormatContext *s, AVPacket *pkt)
367
OMAContext *oc = s->priv_data;
368
int packet_size = s->streams[0]->codec->block_align;
369
int ret = av_get_packet(s->pb, pkt, packet_size);
374
pkt->stream_index = 0;
377
/* previous unencrypted block saved in IV for the next packet (CBC mode) */
378
av_des_crypt(&oc->av_des, pkt->data, pkt->data, (packet_size >> 3), oc->iv, 1);
384
static int oma_read_probe(AVProbeData *p)
387
unsigned tag_len = 0;
391
if (p->buf_size < ID3v2_HEADER_SIZE ||
392
!ff_id3v2_match(buf, ID3v2_EA3_MAGIC) ||
393
buf[3] != 3 || // version must be 3
394
buf[4]) // flags byte zero
397
tag_len = ff_id3v2_tag_len(buf);
399
/* This check cannot overflow as tag_len has at most 28 bits */
400
if (p->buf_size < tag_len + 5)
401
/* EA3 header comes late, might be outside of the probe buffer */
402
return AVPROBE_SCORE_MAX / 2;
406
if (!memcmp(buf, "EA3", 3) && !buf[4] && buf[5] == EA3_HEADER_SIZE)
407
return AVPROBE_SCORE_MAX;
412
static int oma_read_seek(struct AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
414
OMAContext *oc = s->priv_data;
416
pcm_read_seek(s, stream_index, timestamp, flags);
419
/* readjust IV for CBC */
420
int64_t pos = avio_tell(s->pb);
421
if (pos < oc->content_start)
422
memset(oc->iv, 0, 8);
424
if (avio_seek(s->pb, -8, SEEK_CUR) < 0 || avio_read(s->pb, oc->iv, 8) < 8) {
425
memset(oc->iv, 0, 8);
434
AVInputFormat ff_oma_demuxer = {
436
.long_name = NULL_IF_CONFIG_SMALL("Sony OpenMG audio"),
437
.priv_data_size = sizeof(OMAContext),
438
.read_probe = oma_read_probe,
439
.read_header = oma_read_header,
440
.read_packet = oma_read_packet,
441
.read_seek = oma_read_seek,
442
.flags = AVFMT_GENERIC_INDEX,
443
.extensions = "oma,omg,aa3",
444
.codec_tag = (const AVCodecTag* const []){ff_oma_codec_tags, 0},