2 * Sony OpenMG (OMA) demuxer
4 * Copyright (c) 2008, 2013 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 * Supported decoders: ATRAC3, ATRAC3+, MP3, LPCM
45 #include "libavutil/channel_layout.h"
48 #include "libavutil/intreadwrite.h"
49 #include "libavutil/des.h"
50 #include "libavutil/mathematics.h"
56 static const uint64_t leaf_table[] = {
57 0xd79e8283acea4620, 0x7a9762f445afd0d8,
58 0x354d60a60b8c79f1, 0x584e1cde00b07aee,
59 0x1573cd93da7df623, 0x47f98d79620dd535
62 typedef struct OMAContext {
63 uint64_t content_start;
80 static void hex_log(AVFormatContext *s, int level,
81 const char *name, const uint8_t *value, int len)
85 if (av_log_get_level() < level)
87 ff_data_to_hex(buf, value, len, 1);
89 av_log(s, level, "%s: %s\n", name, buf);
92 static int kset(AVFormatContext *s, const uint8_t *r_val, const uint8_t *n_val,
95 OMAContext *oc = s->priv_data;
100 len = FFMIN(len, 16);
102 /* use first 64 bits in the third round again */
104 if (r_val != oc->r_val) {
105 memset(oc->r_val, 0, 24);
106 memcpy(oc->r_val, r_val, len);
108 memcpy(&oc->r_val[16], r_val, 8);
111 if (n_val != oc->n_val) {
112 memset(oc->n_val, 0, 24);
113 memcpy(oc->n_val, n_val, len);
115 memcpy(&oc->n_val[16], n_val, 8);
121 #define OMA_RPROBE_M_VAL 48 + 1
123 static int rprobe(AVFormatContext *s, uint8_t *enc_header, unsigned size,
124 const uint8_t *r_val)
126 OMAContext *oc = s->priv_data;
128 struct AVDES *av_des;
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)
135 av_des = av_des_alloc();
137 return AVERROR(ENOMEM);
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);
144 av_des_init(av_des, oc->m_val, 64, 0);
145 av_des_crypt(av_des, oc->s_val, NULL, 1, NULL, 0);
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));
156 return memcmp(&enc_header[pos], oc->sm_val, 8) ? -1 : 0;
159 static int nprobe(AVFormatContext *s, uint8_t *enc_header, unsigned size,
160 const uint8_t *n_val)
162 OMAContext *oc = s->priv_data;
164 uint32_t taglen, datalen;
165 struct AVDES *av_des;
167 if (!enc_header || !n_val ||
168 size < OMA_ENC_HEADER_SIZE + oc->k_size + 4)
171 pos = OMA_ENC_HEADER_SIZE + oc->k_size;
172 if (!memcmp(&enc_header[pos], "EKB ", 4))
178 if (AV_RB32(&enc_header[pos]) != oc->rid)
179 av_log(s, AV_LOG_DEBUG, "Mismatching RID\n");
181 taglen = AV_RB32(&enc_header[pos + 32]);
182 datalen = AV_RB32(&enc_header[pos + 36]) >> 4;
185 if (size - pos < taglen)
190 if (datalen << 4 > size - pos)
193 av_des = av_des_alloc();
195 return AVERROR(ENOMEM);
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)) {
212 static int decrypt_init(AVFormatContext *s, ID3v2ExtraMeta *em, uint8_t *header)
214 OMAContext *oc = s->priv_data;
215 ID3v2ExtraMetaGEOB *geob = NULL;
219 av_log(s, AV_LOG_INFO, "File is encrypted\n");
221 /* find GEOB metadata */
223 if (!strcmp(em->tag, "GEOB") &&
225 (!strcmp(geob->description, "OMG_LSI") ||
226 !strcmp(geob->description, "OMG_BKLSI"))) {
232 av_log(s, AV_LOG_ERROR, "No encryption header found\n");
233 return AVERROR_INVALIDDATA;
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;
244 if (AV_RB16(gdata) != 1)
245 av_log(s, AV_LOG_WARNING, "Unknown version in encryption header\n");
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]);
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;
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;
261 oc->rid = AV_RB32(&gdata[OMA_ENC_HEADER_SIZE + 28]);
262 av_log(s, AV_LOG_DEBUG, "RID: %.8"PRIx32"\n", oc->rid);
264 memcpy(oc->iv, &header[0x58], 8);
265 hex_log(s, AV_LOG_DEBUG, "IV", oc->iv, 8);
267 hex_log(s, AV_LOG_DEBUG, "CBC-MAC",
268 &gdata[OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size + oc->i_size],
272 kset(s, s->key, s->key, s->keylen);
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) {
278 for (i = 0; i < FF_ARRAY_ELEMS(leaf_table); i += 2) {
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))
287 if (i >= FF_ARRAY_ELEMS(leaf_table)) {
288 av_log(s, AV_LOG_ERROR, "Invalid key\n");
289 return AVERROR_INVALIDDATA;
293 oc->av_des = av_des_alloc();
295 return AVERROR(ENOMEM);
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);
304 av_des_init(oc->av_des, oc->e_val, 64, 1);
309 static int oma_read_header(AVFormatContext *s)
311 int ret, framesize, jsflag, samplerate;
312 uint32_t codec_params, channel_id;
314 uint8_t buf[EA3_HEADER_SIZE];
317 ID3v2ExtraMeta *extra_meta = NULL;
318 OMAContext *oc = s->priv_data;
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)
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;
331 oc->content_start = avio_tell(s->pb);
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);
340 ff_id3v2_free_extra_meta(&extra_meta);
342 codec_params = AV_RB24(&buf[33]);
344 st = avformat_new_stream(s, NULL);
346 return AVERROR(ENOMEM);
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);
355 case OMA_CODECID_ATRAC3:
356 samplerate = ff_oma_srate_tab[(codec_params >> 13) & 7] * 100;
358 av_log(s, AV_LOG_ERROR, "Unsupported sample rate\n");
359 return AVERROR_INVALIDDATA;
361 if (samplerate != 44100)
362 avpriv_request_sample(s, "Sample rate %d", samplerate);
364 framesize = (codec_params & 0x3FF) * 8;
366 /* get stereo coding mode, 1 for joint-stereo */
367 jsflag = (codec_params >> 17) & 1;
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;
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);
379 return AVERROR(ENOMEM);
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
389 avpriv_set_pts_info(st, 64, 1, st->codecpar->sample_rate);
391 case OMA_CODECID_ATRAC3P:
392 channel_id = (codec_params >> 10) & 7;
394 av_log(s, AV_LOG_ERROR,
395 "Invalid ATRAC-X channel id: %"PRIu32"\n", channel_id);
396 return AVERROR_INVALIDDATA;
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;
403 av_log(s, AV_LOG_ERROR, "Unsupported sample rate\n");
404 return AVERROR_INVALIDDATA;
406 st->codecpar->sample_rate = samplerate;
407 st->codecpar->bit_rate = samplerate * framesize * 8 / 2048;
408 avpriv_set_pts_info(st, 64, 1, samplerate);
410 case OMA_CODECID_MP3:
411 st->need_parsing = AVSTREAM_PARSE_FULL;
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;
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);
427 av_log(s, AV_LOG_ERROR, "Unsupported codec %d!\n", buf[32]);
428 return AVERROR(ENOSYS);
431 st->codecpar->block_align = framesize;
437 static int oma_read_packet(AVFormatContext *s, AVPacket *pkt)
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);
446 if (ret < packet_size)
447 pkt->flags |= AV_PKT_FLAG_CORRUPT;
454 pkt->stream_index = 0;
458 pkt->dts = av_rescale(pos, st->time_base.den,
459 byte_rate * (int64_t)st->time_base.num);
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);
469 memset(oc->iv, 0, 8);
475 static int oma_read_probe(AVProbeData *p)
477 const uint8_t *buf = p->buf;
478 unsigned tag_len = 0;
480 if (p->buf_size >= ID3v2_HEADER_SIZE && ff_id3v2_match(buf, ID3v2_EA3_MAGIC))
481 tag_len = ff_id3v2_tag_len(buf);
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;
490 if (!memcmp(buf, "EA3", 3) && !buf[4] && buf[5] == EA3_HEADER_SIZE)
491 return AVPROBE_SCORE_MAX;
496 static int oma_read_seek(struct AVFormatContext *s,
497 int stream_index, int64_t timestamp, int flags)
499 OMAContext *oc = s->priv_data;
500 int err = ff_pcm_read_seek(s, stream_index, timestamp, flags);
505 /* readjust IV for CBC */
506 if (err || avio_tell(s->pb) < oc->content_start)
508 if ((err = avio_seek(s->pb, -8, SEEK_CUR)) < 0)
510 if ((err = avio_read(s->pb, oc->iv, 8)) < 8) {
518 memset(oc->iv, 0, 8);
522 static int oma_read_close(AVFormatContext *s)
524 OMAContext *oc = s->priv_data;
529 AVInputFormat ff_oma_demuxer = {
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},