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 /** map ATRAC-X channel id to internal channel layout */
63 static const uint64_t oma_chid_to_native_layout[7] = {
66 AV_CH_LAYOUT_SURROUND,
68 AV_CH_LAYOUT_5POINT1_BACK,
69 AV_CH_LAYOUT_6POINT1_BACK,
73 /** map ATRAC-X channel id to total number of channels */
74 static const int oma_chid_to_num_channels[7] = { 1, 2, 3, 4, 6, 7, 8 };
76 typedef struct OMAContext {
77 uint64_t content_start;
93 int (*read_packet)(AVFormatContext *s, AVPacket *pkt);
96 static int oma_read_close(AVFormatContext *s)
98 OMAContext *oc = s->priv_data;
99 av_freep(&oc->av_des);
103 static void hex_log(AVFormatContext *s, int level,
104 const char *name, const uint8_t *value, int len)
107 len = FFMIN(len, 16);
108 if (av_log_get_level() < level)
110 ff_data_to_hex(buf, value, len, 1);
111 buf[len << 1] = '\0';
112 av_log(s, level, "%s: %s\n", name, buf);
115 static int kset(AVFormatContext *s, const uint8_t *r_val, const uint8_t *n_val,
118 OMAContext *oc = s->priv_data;
120 if (!r_val && !n_val)
123 len = FFMIN(len, 16);
125 /* use first 64 bits in the third round again */
127 if (r_val != oc->r_val) {
128 memset(oc->r_val, 0, 24);
129 memcpy(oc->r_val, r_val, len);
131 memcpy(&oc->r_val[16], r_val, 8);
134 if (n_val != oc->n_val) {
135 memset(oc->n_val, 0, 24);
136 memcpy(oc->n_val, n_val, len);
138 memcpy(&oc->n_val[16], n_val, 8);
144 #define OMA_RPROBE_M_VAL 48 + 1
146 static int rprobe(AVFormatContext *s, uint8_t *enc_header, unsigned size,
147 const uint8_t *r_val)
149 OMAContext *oc = s->priv_data;
151 struct AVDES *av_des;
153 if (!enc_header || !r_val ||
154 size < OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size + oc->i_size ||
155 size < OMA_RPROBE_M_VAL)
158 av_des = av_des_alloc();
160 return AVERROR(ENOMEM);
163 av_des_init(av_des, r_val, 192, 1);
164 av_des_crypt(av_des, oc->m_val, &enc_header[48], 1, NULL, 1);
167 av_des_init(av_des, oc->m_val, 64, 0);
168 av_des_crypt(av_des, oc->s_val, NULL, 1, NULL, 0);
171 pos = OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size;
172 av_des_init(av_des, oc->s_val, 64, 0);
173 av_des_mac(av_des, oc->sm_val, &enc_header[pos], (oc->i_size >> 3));
179 return memcmp(&enc_header[pos], oc->sm_val, 8) ? -1 : 0;
182 static int nprobe(AVFormatContext *s, uint8_t *enc_header, unsigned size,
183 const uint8_t *n_val)
185 OMAContext *oc = s->priv_data;
187 uint32_t taglen, datalen;
188 struct AVDES *av_des;
190 if (!enc_header || !n_val ||
191 size < OMA_ENC_HEADER_SIZE + oc->k_size + 4)
194 pos = OMA_ENC_HEADER_SIZE + oc->k_size;
195 if (!memcmp(&enc_header[pos], "EKB ", 4))
201 if (AV_RB32(&enc_header[pos]) != oc->rid)
202 av_log(s, AV_LOG_DEBUG, "Mismatching RID\n");
204 taglen = AV_RB32(&enc_header[pos + 32]);
205 datalen = AV_RB32(&enc_header[pos + 36]) >> 4;
207 pos += 44LL + taglen;
209 if (pos + (((uint64_t)datalen) << 4) > size)
212 av_des = av_des_alloc();
214 return AVERROR(ENOMEM);
216 av_des_init(av_des, n_val, 192, 1);
217 while (datalen-- > 0) {
218 av_des_crypt(av_des, oc->r_val, &enc_header[pos], 2, NULL, 1);
219 kset(s, oc->r_val, NULL, 16);
220 if (!rprobe(s, enc_header, size, oc->r_val)) {
231 static int decrypt_init(AVFormatContext *s, ID3v2ExtraMeta *em, uint8_t *header)
233 OMAContext *oc = s->priv_data;
234 ID3v2ExtraMetaGEOB *geob = NULL;
238 av_log(s, AV_LOG_INFO, "File is encrypted\n");
240 /* find GEOB metadata */
241 for (; em; em = em->next) {
242 if (strcmp(em->tag, "GEOB"))
244 geob = &em->data.geob;
245 if (!strcmp(geob->description, "OMG_LSI") ||
246 !strcmp(geob->description, "OMG_BKLSI"))
250 av_log(s, AV_LOG_ERROR, "No encryption header found\n");
251 return AVERROR_INVALIDDATA;
254 if (geob->datasize < 64) {
255 av_log(s, AV_LOG_ERROR,
256 "Invalid GEOB data size: %"PRIu32"\n", geob->datasize);
257 return AVERROR_INVALIDDATA;
262 if (AV_RB16(gdata) != 1)
263 av_log(s, AV_LOG_WARNING, "Unknown version in encryption header\n");
265 oc->k_size = AV_RB16(&gdata[2]);
266 oc->e_size = AV_RB16(&gdata[4]);
267 oc->i_size = AV_RB16(&gdata[6]);
268 oc->s_size = AV_RB16(&gdata[8]);
270 if (memcmp(&gdata[OMA_ENC_HEADER_SIZE], "KEYRING ", 12)) {
271 av_log(s, AV_LOG_ERROR, "Invalid encryption header\n");
272 return AVERROR_INVALIDDATA;
274 if (OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size + oc->i_size + 8 > geob->datasize ||
275 OMA_ENC_HEADER_SIZE + 48 > geob->datasize) {
276 av_log(s, AV_LOG_ERROR, "Too little GEOB data\n");
277 return AVERROR_INVALIDDATA;
279 oc->rid = AV_RB32(&gdata[OMA_ENC_HEADER_SIZE + 28]);
280 av_log(s, AV_LOG_DEBUG, "RID: %.8"PRIx32"\n", oc->rid);
282 memcpy(oc->iv, &header[0x58], 8);
283 hex_log(s, AV_LOG_DEBUG, "IV", oc->iv, 8);
285 hex_log(s, AV_LOG_DEBUG, "CBC-MAC",
286 &gdata[OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size + oc->i_size],
290 kset(s, s->key, s->key, s->keylen);
292 if (!memcmp(oc->r_val, (const uint8_t[8]){0}, 8) ||
293 rprobe(s, gdata, geob->datasize, oc->r_val) < 0 &&
294 nprobe(s, gdata, geob->datasize, oc->n_val) < 0) {
296 for (i = 0; i < FF_ARRAY_ELEMS(leaf_table); i += 2) {
298 AV_WL64(buf, leaf_table[i]);
299 AV_WL64(&buf[8], leaf_table[i + 1]);
300 kset(s, buf, buf, 16);
301 if (!rprobe(s, gdata, geob->datasize, oc->r_val) ||
302 !nprobe(s, gdata, geob->datasize, oc->n_val))
305 if (i >= FF_ARRAY_ELEMS(leaf_table)) {
306 av_log(s, AV_LOG_ERROR, "Invalid key\n");
307 return AVERROR_INVALIDDATA;
311 oc->av_des = av_des_alloc();
313 return AVERROR(ENOMEM);
316 av_des_init(oc->av_des, oc->m_val, 64, 0);
317 av_des_crypt(oc->av_des, oc->e_val,
318 &gdata[OMA_ENC_HEADER_SIZE + 40], 1, NULL, 0);
319 hex_log(s, AV_LOG_DEBUG, "EK", oc->e_val, 8);
322 av_des_init(oc->av_des, oc->e_val, 64, 1);
327 static int read_packet(AVFormatContext *s, AVPacket *pkt)
329 OMAContext *oc = s->priv_data;
330 AVStream *st = s->streams[0];
331 int packet_size = st->codecpar->block_align;
332 int byte_rate = st->codecpar->bit_rate >> 3;
333 int64_t pos = avio_tell(s->pb);
334 int ret = av_get_packet(s->pb, pkt, packet_size);
336 if (ret < packet_size)
337 pkt->flags |= AV_PKT_FLAG_CORRUPT;
344 pkt->stream_index = 0;
346 if (pos >= oc->content_start && byte_rate > 0) {
348 pkt->dts = av_rescale(pos - oc->content_start, st->time_base.den,
349 byte_rate * (int64_t)st->time_base.num);
353 /* previous unencrypted block saved in IV for
354 * the next packet (CBC mode) */
355 if (ret == packet_size)
356 av_des_crypt(oc->av_des, pkt->data, pkt->data,
357 (packet_size >> 3), oc->iv, 1);
359 memset(oc->iv, 0, 8);
365 static int aal_read_packet(AVFormatContext *s, AVPacket *pkt)
367 int64_t pos = avio_tell(s->pb);
372 if (avio_feof(s->pb))
375 tag = avio_rb24(s->pb);
378 else if (tag != MKBETAG(0,'B','L','K'))
379 return AVERROR_INVALIDDATA;
382 packet_size = avio_rb16(s->pb);
384 pts = avio_rb32(s->pb);
385 avio_skip(s->pb, 12);
386 ret = av_get_packet(s->pb, pkt, packet_size);
387 if (ret < packet_size)
388 pkt->flags |= AV_PKT_FLAG_CORRUPT;
395 pkt->stream_index = 0;
397 if (s->streams[0]->codecpar->codec_id == AV_CODEC_ID_ATRAC3AL) {
398 pkt->duration = 1024;
399 pkt->pts = pts * 1024LL;
401 pkt->duration = 2048;
402 pkt->pts = pts * 2048LL;
408 static int oma_read_header(AVFormatContext *s)
410 int ret, framesize, jsflag, samplerate;
411 uint32_t codec_params, channel_id;
413 uint8_t buf[EA3_HEADER_SIZE];
416 ID3v2ExtraMeta *extra_meta;
417 OMAContext *oc = s->priv_data;
419 ff_id3v2_read(s, ID3v2_EA3_MAGIC, &extra_meta, 0);
420 if ((ret = ff_id3v2_parse_chapters(s, extra_meta)) < 0) {
421 ff_id3v2_free_extra_meta(&extra_meta);
425 ret = avio_read(s->pb, buf, EA3_HEADER_SIZE);
426 if (ret < EA3_HEADER_SIZE) {
427 ff_id3v2_free_extra_meta(&extra_meta);
431 if (memcmp(buf, ((const uint8_t[]){'E', 'A', '3'}), 3) ||
432 buf[4] != 0 || buf[5] != EA3_HEADER_SIZE) {
433 ff_id3v2_free_extra_meta(&extra_meta);
434 av_log(s, AV_LOG_ERROR, "Couldn't find the EA3 header !\n");
435 return AVERROR_INVALIDDATA;
438 oc->content_start = avio_tell(s->pb);
441 eid = AV_RB16(&buf[6]);
442 if (eid != -1 && eid != -128 && decrypt_init(s, extra_meta, buf) < 0) {
443 ff_id3v2_free_extra_meta(&extra_meta);
447 ff_id3v2_free_extra_meta(&extra_meta);
449 codec_params = AV_RB24(&buf[33]);
451 st = avformat_new_stream(s, NULL);
453 ret = AVERROR(ENOMEM);
458 st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
459 st->codecpar->codec_tag = buf[32];
460 st->codecpar->codec_id = ff_codec_get_id(ff_oma_codec_tags,
461 st->codecpar->codec_tag);
463 oc->read_packet = read_packet;
466 case OMA_CODECID_ATRAC3:
467 samplerate = ff_oma_srate_tab[(codec_params >> 13) & 7] * 100;
469 av_log(s, AV_LOG_ERROR, "Unsupported sample rate\n");
470 ret = AVERROR_INVALIDDATA;
473 if (samplerate != 44100)
474 avpriv_request_sample(s, "Sample rate %d", samplerate);
476 framesize = (codec_params & 0x3FF) * 8;
478 /* get stereo coding mode, 1 for joint-stereo */
479 jsflag = (codec_params >> 17) & 1;
481 st->codecpar->channels = 2;
482 st->codecpar->channel_layout = AV_CH_LAYOUT_STEREO;
483 st->codecpar->sample_rate = samplerate;
484 st->codecpar->bit_rate = st->codecpar->sample_rate * framesize / (1024 / 8);
486 /* fake the ATRAC3 extradata
487 * (wav format, makes stream copy to wav work) */
488 if ((ret = ff_alloc_extradata(st->codecpar, 14)) < 0)
491 edata = st->codecpar->extradata;
492 AV_WL16(&edata[0], 1); // always 1
493 AV_WL32(&edata[2], samplerate); // samples rate
494 AV_WL16(&edata[6], jsflag); // coding mode
495 AV_WL16(&edata[8], jsflag); // coding mode
496 AV_WL16(&edata[10], 1); // always 1
497 // AV_WL16(&edata[12], 0); // always 0
499 avpriv_set_pts_info(st, 64, 1, st->codecpar->sample_rate);
501 case OMA_CODECID_ATRAC3P:
502 channel_id = (codec_params >> 10) & 7;
504 av_log(s, AV_LOG_ERROR,
505 "Invalid ATRAC-X channel id: %"PRIu32"\n", channel_id);
506 ret = AVERROR_INVALIDDATA;
509 st->codecpar->channel_layout = oma_chid_to_native_layout[channel_id - 1];
510 st->codecpar->channels = oma_chid_to_num_channels[channel_id - 1];
511 framesize = ((codec_params & 0x3FF) * 8) + 8;
512 samplerate = ff_oma_srate_tab[(codec_params >> 13) & 7] * 100;
514 av_log(s, AV_LOG_ERROR, "Unsupported sample rate\n");
515 ret = AVERROR_INVALIDDATA;
518 st->codecpar->sample_rate = samplerate;
519 st->codecpar->bit_rate = samplerate * framesize / (2048 / 8);
520 avpriv_set_pts_info(st, 64, 1, samplerate);
522 case OMA_CODECID_MP3:
523 st->need_parsing = AVSTREAM_PARSE_FULL_RAW;
526 case OMA_CODECID_LPCM:
527 /* PCM 44.1 kHz 16 bit stereo big-endian */
528 st->codecpar->channels = 2;
529 st->codecpar->channel_layout = AV_CH_LAYOUT_STEREO;
530 st->codecpar->sample_rate = 44100;
532 /* bit rate = sample rate x PCM block align (= 4) x 8 */
533 st->codecpar->bit_rate = st->codecpar->sample_rate * 32;
534 st->codecpar->bits_per_coded_sample =
535 av_get_bits_per_sample(st->codecpar->codec_id);
536 avpriv_set_pts_info(st, 64, 1, st->codecpar->sample_rate);
538 case OMA_CODECID_ATRAC3AL:
539 st->codecpar->channels = 2;
540 st->codecpar->channel_layout = AV_CH_LAYOUT_STEREO;
541 st->codecpar->sample_rate = 44100;
542 avpriv_set_pts_info(st, 64, 1, 44100);
543 oc->read_packet = aal_read_packet;
546 case OMA_CODECID_ATRAC3PAL:
547 st->codecpar->channel_layout = AV_CH_LAYOUT_STEREO;
548 st->codecpar->channels = 2;
549 st->codecpar->sample_rate = 44100;
550 avpriv_set_pts_info(st, 64, 1, 44100);
551 oc->read_packet = aal_read_packet;
555 av_log(s, AV_LOG_ERROR, "Unsupported codec %d!\n", buf[32]);
556 ret = AVERROR(ENOSYS);
560 st->codecpar->block_align = framesize;
568 static int oma_read_packet(AVFormatContext *s, AVPacket *pkt)
570 OMAContext *oc = s->priv_data;
571 return oc->read_packet(s, pkt);
574 static int oma_read_probe(const AVProbeData *p)
576 const uint8_t *buf = p->buf;
577 unsigned tag_len = 0;
579 if (p->buf_size >= ID3v2_HEADER_SIZE && ff_id3v2_match(buf, ID3v2_EA3_MAGIC))
580 tag_len = ff_id3v2_tag_len(buf);
582 /* This check cannot overflow as tag_len has at most 28 bits */
583 if (p->buf_size < tag_len + 5)
584 /* EA3 header comes late, might be outside of the probe buffer */
585 return tag_len ? AVPROBE_SCORE_EXTENSION/2 : 0;
589 if (!memcmp(buf, "EA3", 3) && !buf[4] && buf[5] == EA3_HEADER_SIZE)
590 return AVPROBE_SCORE_MAX;
595 static int oma_read_seek(struct AVFormatContext *s,
596 int stream_index, int64_t timestamp, int flags)
598 OMAContext *oc = s->priv_data;
599 AVStream *st = s->streams[0];
602 if (st->codecpar->codec_id == AV_CODEC_ID_ATRAC3PAL ||
603 st->codecpar->codec_id == AV_CODEC_ID_ATRAC3AL)
606 err = ff_pcm_read_seek(s, stream_index, timestamp, flags);
610 /* readjust IV for CBC */
611 if (err || avio_tell(s->pb) < oc->content_start)
613 if ((err = avio_seek(s->pb, -8, SEEK_CUR)) < 0)
615 if ((err = avio_read(s->pb, oc->iv, 8)) < 8) {
623 memset(oc->iv, 0, 8);
627 const AVInputFormat ff_oma_demuxer = {
629 .long_name = NULL_IF_CONFIG_SMALL("Sony OpenMG audio"),
630 .priv_data_size = sizeof(OMAContext),
631 .read_probe = oma_read_probe,
632 .read_header = oma_read_header,
633 .read_packet = oma_read_packet,
634 .read_seek = oma_read_seek,
635 .read_close = oma_read_close,
636 .flags = AVFMT_GENERIC_INDEX,
637 .extensions = "oma,omg,aa3",
638 .codec_tag = ff_oma_codec_tags_list,