2 * Sony OpenMG (OMA) demuxer
4 * Copyright (c) 2008, 2013 Maxim Poliakovski
5 * 2008 Benjamin Larsson
8 * This file is part of FFmpeg.
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.
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.
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
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;
79 int (*read_packet)(AVFormatContext *s, AVPacket *pkt);
82 static void hex_log(AVFormatContext *s, int level,
83 const char *name, const uint8_t *value, int len)
87 if (av_log_get_level() < level)
89 ff_data_to_hex(buf, value, len, 1);
91 av_log(s, level, "%s: %s\n", name, buf);
94 static int kset(AVFormatContext *s, const uint8_t *r_val, const uint8_t *n_val,
97 OMAContext *oc = s->priv_data;
102 len = FFMIN(len, 16);
104 /* use first 64 bits in the third round again */
106 if (r_val != oc->r_val) {
107 memset(oc->r_val, 0, 24);
108 memcpy(oc->r_val, r_val, len);
110 memcpy(&oc->r_val[16], r_val, 8);
113 if (n_val != oc->n_val) {
114 memset(oc->n_val, 0, 24);
115 memcpy(oc->n_val, n_val, len);
117 memcpy(&oc->n_val[16], n_val, 8);
123 #define OMA_RPROBE_M_VAL 48 + 1
125 static int rprobe(AVFormatContext *s, uint8_t *enc_header, unsigned size,
126 const uint8_t *r_val)
128 OMAContext *oc = s->priv_data;
130 struct AVDES *av_des;
132 if (!enc_header || !r_val ||
133 size < OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size + oc->i_size ||
134 size < OMA_RPROBE_M_VAL)
137 av_des = av_des_alloc();
139 return AVERROR(ENOMEM);
142 av_des_init(av_des, r_val, 192, 1);
143 av_des_crypt(av_des, oc->m_val, &enc_header[48], 1, NULL, 1);
146 av_des_init(av_des, oc->m_val, 64, 0);
147 av_des_crypt(av_des, oc->s_val, NULL, 1, NULL, 0);
150 pos = OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size;
151 av_des_init(av_des, oc->s_val, 64, 0);
152 av_des_mac(av_des, oc->sm_val, &enc_header[pos], (oc->i_size >> 3));
158 return memcmp(&enc_header[pos], oc->sm_val, 8) ? -1 : 0;
161 static int nprobe(AVFormatContext *s, uint8_t *enc_header, unsigned size,
162 const uint8_t *n_val)
164 OMAContext *oc = s->priv_data;
166 uint32_t taglen, datalen;
167 struct AVDES *av_des;
169 if (!enc_header || !n_val ||
170 size < OMA_ENC_HEADER_SIZE + oc->k_size + 4)
173 pos = OMA_ENC_HEADER_SIZE + oc->k_size;
174 if (!memcmp(&enc_header[pos], "EKB ", 4))
180 if (AV_RB32(&enc_header[pos]) != oc->rid)
181 av_log(s, AV_LOG_DEBUG, "Mismatching RID\n");
183 taglen = AV_RB32(&enc_header[pos + 32]);
184 datalen = AV_RB32(&enc_header[pos + 36]) >> 4;
186 pos += 44LL + taglen;
188 if (pos + (((uint64_t)datalen) << 4) > size)
191 av_des = av_des_alloc();
193 return AVERROR(ENOMEM);
195 av_des_init(av_des, n_val, 192, 1);
196 while (datalen-- > 0) {
197 av_des_crypt(av_des, oc->r_val, &enc_header[pos], 2, NULL, 1);
198 kset(s, oc->r_val, NULL, 16);
199 if (!rprobe(s, enc_header, size, oc->r_val)) {
210 static int decrypt_init(AVFormatContext *s, ID3v2ExtraMeta *em, uint8_t *header)
212 OMAContext *oc = s->priv_data;
213 ID3v2ExtraMetaGEOB *geob = NULL;
217 av_log(s, AV_LOG_INFO, "File is encrypted\n");
219 /* find GEOB metadata */
221 if (!strcmp(em->tag, "GEOB") &&
223 (!strcmp(geob->description, "OMG_LSI") ||
224 !strcmp(geob->description, "OMG_BKLSI"))) {
230 av_log(s, AV_LOG_ERROR, "No encryption header found\n");
231 return AVERROR_INVALIDDATA;
234 if (geob->datasize < 64) {
235 av_log(s, AV_LOG_ERROR,
236 "Invalid GEOB data size: %"PRIu32"\n", geob->datasize);
237 return AVERROR_INVALIDDATA;
242 if (AV_RB16(gdata) != 1)
243 av_log(s, AV_LOG_WARNING, "Unknown version in encryption header\n");
245 oc->k_size = AV_RB16(&gdata[2]);
246 oc->e_size = AV_RB16(&gdata[4]);
247 oc->i_size = AV_RB16(&gdata[6]);
248 oc->s_size = AV_RB16(&gdata[8]);
250 if (memcmp(&gdata[OMA_ENC_HEADER_SIZE], "KEYRING ", 12)) {
251 av_log(s, AV_LOG_ERROR, "Invalid encryption header\n");
252 return AVERROR_INVALIDDATA;
254 if (OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size + oc->i_size + 8 > geob->datasize ||
255 OMA_ENC_HEADER_SIZE + 48 > geob->datasize) {
256 av_log(s, AV_LOG_ERROR, "Too little GEOB data\n");
257 return AVERROR_INVALIDDATA;
259 oc->rid = AV_RB32(&gdata[OMA_ENC_HEADER_SIZE + 28]);
260 av_log(s, AV_LOG_DEBUG, "RID: %.8"PRIx32"\n", oc->rid);
262 memcpy(oc->iv, &header[0x58], 8);
263 hex_log(s, AV_LOG_DEBUG, "IV", oc->iv, 8);
265 hex_log(s, AV_LOG_DEBUG, "CBC-MAC",
266 &gdata[OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size + oc->i_size],
270 kset(s, s->key, s->key, s->keylen);
272 if (!memcmp(oc->r_val, (const uint8_t[8]){0}, 8) ||
273 rprobe(s, gdata, geob->datasize, oc->r_val) < 0 &&
274 nprobe(s, gdata, geob->datasize, oc->n_val) < 0) {
276 for (i = 0; i < FF_ARRAY_ELEMS(leaf_table); i += 2) {
278 AV_WL64(buf, leaf_table[i]);
279 AV_WL64(&buf[8], leaf_table[i + 1]);
280 kset(s, buf, buf, 16);
281 if (!rprobe(s, gdata, geob->datasize, oc->r_val) ||
282 !nprobe(s, gdata, geob->datasize, oc->n_val))
285 if (i >= FF_ARRAY_ELEMS(leaf_table)) {
286 av_log(s, AV_LOG_ERROR, "Invalid key\n");
287 return AVERROR_INVALIDDATA;
291 oc->av_des = av_des_alloc();
293 return AVERROR(ENOMEM);
296 av_des_init(oc->av_des, oc->m_val, 64, 0);
297 av_des_crypt(oc->av_des, oc->e_val,
298 &gdata[OMA_ENC_HEADER_SIZE + 40], 1, NULL, 0);
299 hex_log(s, AV_LOG_DEBUG, "EK", oc->e_val, 8);
302 av_des_init(oc->av_des, oc->e_val, 64, 1);
307 static int read_packet(AVFormatContext *s, AVPacket *pkt)
309 OMAContext *oc = s->priv_data;
310 AVStream *st = s->streams[0];
311 int packet_size = st->codecpar->block_align;
312 int byte_rate = st->codecpar->bit_rate >> 3;
313 int64_t pos = avio_tell(s->pb);
314 int ret = av_get_packet(s->pb, pkt, packet_size);
316 if (ret < packet_size)
317 pkt->flags |= AV_PKT_FLAG_CORRUPT;
324 pkt->stream_index = 0;
326 if (pos >= oc->content_start && byte_rate > 0) {
328 pkt->dts = av_rescale(pos - oc->content_start, st->time_base.den,
329 byte_rate * (int64_t)st->time_base.num);
333 /* previous unencrypted block saved in IV for
334 * the next packet (CBC mode) */
335 if (ret == packet_size)
336 av_des_crypt(oc->av_des, pkt->data, pkt->data,
337 (packet_size >> 3), oc->iv, 1);
339 memset(oc->iv, 0, 8);
345 static int aal_read_packet(AVFormatContext *s, AVPacket *pkt)
347 int64_t pos = avio_tell(s->pb);
352 if (avio_feof(s->pb))
355 tag = avio_rb24(s->pb);
358 else if (tag != MKBETAG(0,'B','L','K'))
359 return AVERROR_INVALIDDATA;
362 packet_size = avio_rb16(s->pb);
364 pts = avio_rb32(s->pb);
365 avio_skip(s->pb, 12);
366 ret = av_get_packet(s->pb, pkt, packet_size);
367 if (ret < packet_size)
368 pkt->flags |= AV_PKT_FLAG_CORRUPT;
375 pkt->stream_index = 0;
377 if (s->streams[0]->codecpar->codec_id == AV_CODEC_ID_ATRAC3AL) {
378 pkt->duration = 1024;
379 pkt->pts = pts * 1024LL;
381 pkt->duration = 2048;
382 pkt->pts = pts * 2048LL;
388 static int oma_read_header(AVFormatContext *s)
390 int ret, framesize, jsflag, samplerate;
391 uint32_t codec_params, channel_id;
393 uint8_t buf[EA3_HEADER_SIZE];
396 ID3v2ExtraMeta *extra_meta = NULL;
397 OMAContext *oc = s->priv_data;
399 ff_id3v2_read(s, ID3v2_EA3_MAGIC, &extra_meta, 0);
400 if ((ret = ff_id3v2_parse_chapters(s, &extra_meta)) < 0) {
401 ff_id3v2_free_extra_meta(&extra_meta);
405 ret = avio_read(s->pb, buf, EA3_HEADER_SIZE);
406 if (ret < EA3_HEADER_SIZE)
409 if (memcmp(buf, ((const uint8_t[]){'E', 'A', '3'}), 3) ||
410 buf[4] != 0 || buf[5] != EA3_HEADER_SIZE) {
411 av_log(s, AV_LOG_ERROR, "Couldn't find the EA3 header !\n");
412 return AVERROR_INVALIDDATA;
415 oc->content_start = avio_tell(s->pb);
418 eid = AV_RB16(&buf[6]);
419 if (eid != -1 && eid != -128 && decrypt_init(s, extra_meta, buf) < 0) {
420 ff_id3v2_free_extra_meta(&extra_meta);
424 ff_id3v2_free_extra_meta(&extra_meta);
426 codec_params = AV_RB24(&buf[33]);
428 st = avformat_new_stream(s, NULL);
430 return AVERROR(ENOMEM);
433 st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
434 st->codecpar->codec_tag = buf[32];
435 st->codecpar->codec_id = ff_codec_get_id(ff_oma_codec_tags,
436 st->codecpar->codec_tag);
438 oc->read_packet = read_packet;
441 case OMA_CODECID_ATRAC3:
442 samplerate = ff_oma_srate_tab[(codec_params >> 13) & 7] * 100;
444 av_log(s, AV_LOG_ERROR, "Unsupported sample rate\n");
445 return AVERROR_INVALIDDATA;
447 if (samplerate != 44100)
448 avpriv_request_sample(s, "Sample rate %d", samplerate);
450 framesize = (codec_params & 0x3FF) * 8;
452 /* get stereo coding mode, 1 for joint-stereo */
453 jsflag = (codec_params >> 17) & 1;
455 st->codecpar->channels = 2;
456 st->codecpar->channel_layout = AV_CH_LAYOUT_STEREO;
457 st->codecpar->sample_rate = samplerate;
458 st->codecpar->bit_rate = st->codecpar->sample_rate * framesize / (1024 / 8);
460 /* fake the ATRAC3 extradata
461 * (wav format, makes stream copy to wav work) */
462 if (ff_alloc_extradata(st->codecpar, 14))
463 return AVERROR(ENOMEM);
465 edata = st->codecpar->extradata;
466 AV_WL16(&edata[0], 1); // always 1
467 AV_WL32(&edata[2], samplerate); // samples rate
468 AV_WL16(&edata[6], jsflag); // coding mode
469 AV_WL16(&edata[8], jsflag); // coding mode
470 AV_WL16(&edata[10], 1); // always 1
471 // AV_WL16(&edata[12], 0); // always 0
473 avpriv_set_pts_info(st, 64, 1, st->codecpar->sample_rate);
475 case OMA_CODECID_ATRAC3P:
476 channel_id = (codec_params >> 10) & 7;
478 av_log(s, AV_LOG_ERROR,
479 "Invalid ATRAC-X channel id: %"PRIu32"\n", channel_id);
480 return AVERROR_INVALIDDATA;
482 st->codecpar->channel_layout = ff_oma_chid_to_native_layout[channel_id - 1];
483 st->codecpar->channels = ff_oma_chid_to_num_channels[channel_id - 1];
484 framesize = ((codec_params & 0x3FF) * 8) + 8;
485 samplerate = ff_oma_srate_tab[(codec_params >> 13) & 7] * 100;
487 av_log(s, AV_LOG_ERROR, "Unsupported sample rate\n");
488 return AVERROR_INVALIDDATA;
490 st->codecpar->sample_rate = samplerate;
491 st->codecpar->bit_rate = samplerate * framesize / (2048 / 8);
492 avpriv_set_pts_info(st, 64, 1, samplerate);
494 case OMA_CODECID_MP3:
495 st->need_parsing = AVSTREAM_PARSE_FULL_RAW;
498 case OMA_CODECID_LPCM:
499 /* PCM 44.1 kHz 16 bit stereo big-endian */
500 st->codecpar->channels = 2;
501 st->codecpar->channel_layout = AV_CH_LAYOUT_STEREO;
502 st->codecpar->sample_rate = 44100;
504 /* bit rate = sample rate x PCM block align (= 4) x 8 */
505 st->codecpar->bit_rate = st->codecpar->sample_rate * 32;
506 st->codecpar->bits_per_coded_sample =
507 av_get_bits_per_sample(st->codecpar->codec_id);
508 avpriv_set_pts_info(st, 64, 1, st->codecpar->sample_rate);
510 case OMA_CODECID_ATRAC3AL:
511 st->codecpar->channels = 2;
512 st->codecpar->channel_layout = AV_CH_LAYOUT_STEREO;
513 st->codecpar->sample_rate = 44100;
514 avpriv_set_pts_info(st, 64, 1, 44100);
515 oc->read_packet = aal_read_packet;
518 case OMA_CODECID_ATRAC3PAL:
519 st->codecpar->channel_layout = AV_CH_LAYOUT_STEREO;
520 st->codecpar->channels = 2;
521 st->codecpar->sample_rate = 44100;
522 avpriv_set_pts_info(st, 64, 1, 44100);
523 oc->read_packet = aal_read_packet;
527 av_log(s, AV_LOG_ERROR, "Unsupported codec %d!\n", buf[32]);
528 return AVERROR(ENOSYS);
531 st->codecpar->block_align = framesize;
536 static int oma_read_packet(AVFormatContext *s, AVPacket *pkt)
538 OMAContext *oc = s->priv_data;
539 return oc->read_packet(s, pkt);
542 static int oma_read_probe(AVProbeData *p)
544 const uint8_t *buf = p->buf;
545 unsigned tag_len = 0;
547 if (p->buf_size >= ID3v2_HEADER_SIZE && ff_id3v2_match(buf, ID3v2_EA3_MAGIC))
548 tag_len = ff_id3v2_tag_len(buf);
550 /* This check cannot overflow as tag_len has at most 28 bits */
551 if (p->buf_size < tag_len + 5)
552 /* EA3 header comes late, might be outside of the probe buffer */
553 return tag_len ? AVPROBE_SCORE_EXTENSION/2 : 0;
557 if (!memcmp(buf, "EA3", 3) && !buf[4] && buf[5] == EA3_HEADER_SIZE)
558 return AVPROBE_SCORE_MAX;
563 static int oma_read_seek(struct AVFormatContext *s,
564 int stream_index, int64_t timestamp, int flags)
566 OMAContext *oc = s->priv_data;
567 AVStream *st = s->streams[0];
570 if (st->codecpar->codec_id == AV_CODEC_ID_ATRAC3PAL ||
571 st->codecpar->codec_id == AV_CODEC_ID_ATRAC3AL)
574 err = ff_pcm_read_seek(s, stream_index, timestamp, flags);
578 /* readjust IV for CBC */
579 if (err || avio_tell(s->pb) < oc->content_start)
581 if ((err = avio_seek(s->pb, -8, SEEK_CUR)) < 0)
583 if ((err = avio_read(s->pb, oc->iv, 8)) < 8) {
591 memset(oc->iv, 0, 8);
595 static int oma_read_close(AVFormatContext *s)
597 OMAContext *oc = s->priv_data;
602 AVInputFormat ff_oma_demuxer = {
604 .long_name = NULL_IF_CONFIG_SMALL("Sony OpenMG audio"),
605 .priv_data_size = sizeof(OMAContext),
606 .read_probe = oma_read_probe,
607 .read_header = oma_read_header,
608 .read_packet = oma_read_packet,
609 .read_seek = oma_read_seek,
610 .read_close = oma_read_close,
611 .flags = AVFMT_GENERIC_INDEX,
612 .extensions = "oma,omg,aa3",
613 .codec_tag = (const AVCodecTag* const []){ff_oma_codec_tags, 0},