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
43 #include "libavutil/channel_layout.h"
46 #include "libavutil/intreadwrite.h"
47 #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,
78 const char *name, const uint8_t *value, int len)
82 if (av_log_get_level() < level)
84 ff_data_to_hex(buf, value, len, 1);
86 av_log(s, level, "%s: %s\n", name, buf);
89 static int kset(AVFormatContext *s, const uint8_t *r_val, const uint8_t *n_val,
92 OMAContext *oc = s->priv_data;
99 /* use first 64 bits in the third round again */
101 if (r_val != oc->r_val) {
102 memset(oc->r_val, 0, 24);
103 memcpy(oc->r_val, r_val, len);
105 memcpy(&oc->r_val[16], r_val, 8);
108 if (n_val != oc->n_val) {
109 memset(oc->n_val, 0, 24);
110 memcpy(oc->n_val, n_val, len);
112 memcpy(&oc->n_val[16], n_val, 8);
118 #define OMA_RPROBE_M_VAL 48 + 1
120 static int rprobe(AVFormatContext *s, uint8_t *enc_header, unsigned size,
121 const uint8_t *r_val)
123 OMAContext *oc = s->priv_data;
127 if (!enc_header || !r_val ||
128 size < OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size + oc->i_size ||
129 size < OMA_RPROBE_M_VAL)
133 av_des_init(&av_des, r_val, 192, 1);
134 av_des_crypt(&av_des, oc->m_val, &enc_header[48], 1, NULL, 1);
137 av_des_init(&av_des, oc->m_val, 64, 0);
138 av_des_crypt(&av_des, oc->s_val, NULL, 1, NULL, 0);
141 pos = OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size;
142 av_des_init(&av_des, oc->s_val, 64, 0);
143 av_des_mac(&av_des, oc->sm_val, &enc_header[pos], (oc->i_size >> 3));
147 return memcmp(&enc_header[pos], oc->sm_val, 8) ? -1 : 0;
150 static int nprobe(AVFormatContext *s, uint8_t *enc_header, unsigned size,
151 const uint8_t *n_val)
153 OMAContext *oc = s->priv_data;
155 uint32_t taglen, datalen;
158 if (!enc_header || !n_val ||
159 size < OMA_ENC_HEADER_SIZE + oc->k_size + 4)
162 pos = OMA_ENC_HEADER_SIZE + oc->k_size;
163 if (!memcmp(&enc_header[pos], "EKB ", 4))
169 if (AV_RB32(&enc_header[pos]) != oc->rid)
170 av_log(s, AV_LOG_DEBUG, "Mismatching RID\n");
172 taglen = AV_RB32(&enc_header[pos + 32]);
173 datalen = AV_RB32(&enc_header[pos + 36]) >> 4;
177 if (pos + (((uint64_t)datalen) << 4) > size)
180 av_des_init(&av_des, n_val, 192, 1);
181 while (datalen-- > 0) {
182 av_des_crypt(&av_des, oc->r_val, &enc_header[pos], 2, NULL, 1);
183 kset(s, oc->r_val, NULL, 16);
184 if (!rprobe(s, enc_header, size, oc->r_val))
192 static int decrypt_init(AVFormatContext *s, ID3v2ExtraMeta *em, uint8_t *header)
194 OMAContext *oc = s->priv_data;
195 ID3v2ExtraMetaGEOB *geob = NULL;
199 av_log(s, AV_LOG_INFO, "File is encrypted\n");
201 /* find GEOB metadata */
203 if (!strcmp(em->tag, "GEOB") &&
205 (!strcmp(geob->description, "OMG_LSI") ||
206 !strcmp(geob->description, "OMG_BKLSI"))) {
212 av_log(s, AV_LOG_ERROR, "No encryption header found\n");
213 return AVERROR_INVALIDDATA;
216 if (geob->datasize < 64) {
217 av_log(s, AV_LOG_ERROR,
218 "Invalid GEOB data size: %u\n", geob->datasize);
219 return AVERROR_INVALIDDATA;
224 if (AV_RB16(gdata) != 1)
225 av_log(s, AV_LOG_WARNING, "Unknown version in encryption header\n");
227 oc->k_size = AV_RB16(&gdata[2]);
228 oc->e_size = AV_RB16(&gdata[4]);
229 oc->i_size = AV_RB16(&gdata[6]);
230 oc->s_size = AV_RB16(&gdata[8]);
232 if (memcmp(&gdata[OMA_ENC_HEADER_SIZE], "KEYRING ", 12)) {
233 av_log(s, AV_LOG_ERROR, "Invalid encryption header\n");
234 return AVERROR_INVALIDDATA;
236 if (OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size + oc->i_size + 8 > geob->datasize ||
237 OMA_ENC_HEADER_SIZE + 48 > geob->datasize) {
238 av_log(s, AV_LOG_ERROR, "Too little GEOB data\n");
239 return AVERROR_INVALIDDATA;
241 oc->rid = AV_RB32(&gdata[OMA_ENC_HEADER_SIZE + 28]);
242 av_log(s, AV_LOG_DEBUG, "RID: %.8x\n", oc->rid);
244 memcpy(oc->iv, &header[0x58], 8);
245 hex_log(s, AV_LOG_DEBUG, "IV", oc->iv, 8);
247 hex_log(s, AV_LOG_DEBUG, "CBC-MAC",
248 &gdata[OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size + oc->i_size],
252 kset(s, s->key, s->key, s->keylen);
254 if (!memcmp(oc->r_val, (const uint8_t[8]){0}, 8) ||
255 rprobe(s, gdata, geob->datasize, oc->r_val) < 0 &&
256 nprobe(s, gdata, geob->datasize, oc->n_val) < 0) {
258 for (i = 0; i < FF_ARRAY_ELEMS(leaf_table); i += 2) {
260 AV_WL64(buf, leaf_table[i]);
261 AV_WL64(&buf[8], leaf_table[i + 1]);
262 kset(s, buf, buf, 16);
263 if (!rprobe(s, gdata, geob->datasize, oc->r_val) ||
264 !nprobe(s, gdata, geob->datasize, oc->n_val))
267 if (i >= FF_ARRAY_ELEMS(leaf_table)) {
268 av_log(s, AV_LOG_ERROR, "Invalid key\n");
269 return AVERROR_INVALIDDATA;
274 av_des_init(&oc->av_des, oc->m_val, 64, 0);
275 av_des_crypt(&oc->av_des, oc->e_val,
276 &gdata[OMA_ENC_HEADER_SIZE + 40], 1, NULL, 0);
277 hex_log(s, AV_LOG_DEBUG, "EK", oc->e_val, 8);
280 av_des_init(&oc->av_des, oc->e_val, 64, 1);
285 static int oma_read_header(AVFormatContext *s)
287 int ret, framesize, jsflag, samplerate;
288 uint32_t codec_params, channel_id;
290 uint8_t buf[EA3_HEADER_SIZE];
293 ID3v2ExtraMeta *extra_meta = NULL;
294 OMAContext *oc = s->priv_data;
296 ff_id3v2_read(s, ID3v2_EA3_MAGIC, &extra_meta);
297 ret = avio_read(s->pb, buf, EA3_HEADER_SIZE);
298 if (ret < EA3_HEADER_SIZE)
301 if (memcmp(buf, ((const uint8_t[]){'E', 'A', '3'}), 3) ||
302 buf[4] != 0 || buf[5] != EA3_HEADER_SIZE) {
303 av_log(s, AV_LOG_ERROR, "Couldn't find the EA3 header !\n");
304 return AVERROR_INVALIDDATA;
307 oc->content_start = avio_tell(s->pb);
310 eid = AV_RB16(&buf[6]);
311 if (eid != -1 && eid != -128 && decrypt_init(s, extra_meta, buf) < 0) {
312 ff_id3v2_free_extra_meta(&extra_meta);
316 ff_id3v2_free_extra_meta(&extra_meta);
318 codec_params = AV_RB24(&buf[33]);
320 st = avformat_new_stream(s, NULL);
322 return AVERROR(ENOMEM);
325 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
326 st->codec->codec_tag = buf[32];
327 st->codec->codec_id = ff_codec_get_id(ff_oma_codec_tags,
328 st->codec->codec_tag);
331 case OMA_CODECID_ATRAC3:
332 samplerate = ff_oma_srate_tab[(codec_params >> 13) & 7] * 100;
334 av_log(s, AV_LOG_ERROR, "Unsupported sample rate\n");
335 return AVERROR_INVALIDDATA;
337 if (samplerate != 44100)
338 avpriv_request_sample(s, "Sample rate %d", samplerate);
340 framesize = (codec_params & 0x3FF) * 8;
342 /* get stereo coding mode, 1 for joint-stereo */
343 jsflag = (codec_params >> 17) & 1;
345 st->codec->channels = 2;
346 st->codec->channel_layout = AV_CH_LAYOUT_STEREO;
347 st->codec->sample_rate = samplerate;
348 st->codec->bit_rate = st->codec->sample_rate * framesize * 8 / 1024;
350 /* fake the ATRAC3 extradata
351 * (wav format, makes stream copy to wav work) */
352 if (ff_alloc_extradata(st->codec, 14))
353 return AVERROR(ENOMEM);
355 edata = st->codec->extradata;
356 AV_WL16(&edata[0], 1); // always 1
357 AV_WL32(&edata[2], samplerate); // samples rate
358 AV_WL16(&edata[6], jsflag); // coding mode
359 AV_WL16(&edata[8], jsflag); // coding mode
360 AV_WL16(&edata[10], 1); // always 1
361 // AV_WL16(&edata[12], 0); // always 0
363 avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
365 case OMA_CODECID_ATRAC3P:
366 channel_id = (codec_params >> 10) & 7;
368 av_log(s, AV_LOG_ERROR,
369 "Invalid ATRAC-X channel id: %d\n", channel_id);
370 return AVERROR_INVALIDDATA;
372 st->codec->channel_layout = ff_oma_chid_to_native_layout[channel_id - 1];
373 st->codec->channels = ff_oma_chid_to_num_channels[channel_id - 1];
374 framesize = ((codec_params & 0x3FF) * 8) + 8;
375 samplerate = ff_oma_srate_tab[(codec_params >> 13) & 7] * 100;
377 av_log(s, AV_LOG_ERROR, "Unsupported sample rate\n");
378 return AVERROR_INVALIDDATA;
380 st->codec->sample_rate = samplerate;
381 st->codec->bit_rate = samplerate * framesize * 8 / 2048;
382 avpriv_set_pts_info(st, 64, 1, samplerate);
384 case OMA_CODECID_MP3:
385 st->need_parsing = AVSTREAM_PARSE_FULL_RAW;
388 case OMA_CODECID_LPCM:
389 /* PCM 44.1 kHz 16 bit stereo big-endian */
390 st->codec->channels = 2;
391 st->codec->channel_layout = AV_CH_LAYOUT_STEREO;
392 st->codec->sample_rate = 44100;
394 /* bit rate = sample rate x PCM block align (= 4) x 8 */
395 st->codec->bit_rate = st->codec->sample_rate * 32;
396 st->codec->bits_per_coded_sample =
397 av_get_bits_per_sample(st->codec->codec_id);
398 avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
401 av_log(s, AV_LOG_ERROR, "Unsupported codec %d!\n", buf[32]);
402 return AVERROR(ENOSYS);
405 st->codec->block_align = framesize;
411 static int oma_read_packet(AVFormatContext *s, AVPacket *pkt)
413 OMAContext *oc = s->priv_data;
414 int packet_size = s->streams[0]->codec->block_align;
415 int ret = av_get_packet(s->pb, pkt, packet_size);
417 if (ret < packet_size)
418 pkt->flags |= AV_PKT_FLAG_CORRUPT;
425 pkt->stream_index = 0;
428 /* previous unencrypted block saved in IV for
429 * the next packet (CBC mode) */
430 if (ret == packet_size)
431 av_des_crypt(&oc->av_des, pkt->data, pkt->data,
432 (packet_size >> 3), oc->iv, 1);
434 memset(oc->iv, 0, 8);
440 static int oma_read_probe(AVProbeData *p)
442 const uint8_t *buf = p->buf;
443 unsigned tag_len = 0;
445 if (p->buf_size >= ID3v2_HEADER_SIZE && ff_id3v2_match(buf, ID3v2_EA3_MAGIC))
446 tag_len = ff_id3v2_tag_len(buf);
448 /* This check cannot overflow as tag_len has at most 28 bits */
449 if (p->buf_size < tag_len + 5)
450 /* EA3 header comes late, might be outside of the probe buffer */
451 return tag_len ? AVPROBE_SCORE_EXTENSION : 0;
455 if (!memcmp(buf, "EA3", 3) && !buf[4] && buf[5] == EA3_HEADER_SIZE)
456 return AVPROBE_SCORE_MAX;
461 static int oma_read_seek(struct AVFormatContext *s,
462 int stream_index, int64_t timestamp, int flags)
464 OMAContext *oc = s->priv_data;
465 int err = ff_pcm_read_seek(s, stream_index, timestamp, flags);
470 /* readjust IV for CBC */
471 if (err || avio_tell(s->pb) < oc->content_start)
473 if ((err = avio_seek(s->pb, -8, SEEK_CUR)) < 0)
475 if ((err = avio_read(s->pb, oc->iv, 8)) < 8) {
483 memset(oc->iv, 0, 8);
487 AVInputFormat ff_oma_demuxer = {
489 .long_name = NULL_IF_CONFIG_SMALL("Sony OpenMG audio"),
490 .priv_data_size = sizeof(OMAContext),
491 .read_probe = oma_read_probe,
492 .read_header = oma_read_header,
493 .read_packet = oma_read_packet,
494 .read_seek = oma_read_seek,
495 .flags = AVFMT_GENERIC_INDEX,
496 .extensions = "oma,omg,aa3",
497 .codec_tag = (const AVCodecTag* const []){ff_oma_codec_tags, 0},