e49178290e8030c2e234ec627c4b1f86088cf3cd
[ffmpeg.git] / libavformat / omadec.c
1 /*
2  * Sony OpenMG (OMA) demuxer
3  *
4  * Copyright (c) 2008 Maxim Poliakovski
5  *               2008 Benjamin Larsson
6  *               2011 David Goldwich
7  *
8  * This file is part of Libav.
9  *
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.
14  *
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.
19  *
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
23  */
24
25 /**
26  * @file
27  * This is a demuxer for Sony OpenMG Music files
28  *
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!).
39  *
40  * CODEC SUPPORT: Only ATRAC3 codec is currently supported!
41  */
42
43 #include "libavutil/channel_layout.h"
44 #include "avformat.h"
45 #include "internal.h"
46 #include "libavutil/intreadwrite.h"
47 #include "libavutil/des.h"
48 #include "oma.h"
49 #include "pcm.h"
50 #include "id3v2.h"
51
52
53 static const uint64_t leaf_table[] = {
54     0xd79e8283acea4620, 0x7a9762f445afd0d8,
55     0x354d60a60b8c79f1, 0x584e1cde00b07aee,
56     0x1573cd93da7df623, 0x47f98d79620dd535
57 };
58
59 typedef struct OMAContext {
60     uint64_t content_start;
61     int encrypted;
62     uint16_t k_size;
63     uint16_t e_size;
64     uint16_t i_size;
65     uint16_t s_size;
66     uint32_t rid;
67     uint8_t r_val[24];
68     uint8_t n_val[24];
69     uint8_t m_val[8];
70     uint8_t s_val[8];
71     uint8_t sm_val[8];
72     uint8_t e_val[8];
73     uint8_t iv[8];
74     struct AVDES av_des;
75 } OMAContext;
76
77 static void hex_log(AVFormatContext *s, int level,
78                     const char *name, const uint8_t *value, int len)
79 {
80     char buf[33];
81     len = FFMIN(len, 16);
82     if (av_log_get_level() < level)
83         return;
84     ff_data_to_hex(buf, value, len, 1);
85     buf[len << 1] = '\0';
86     av_log(s, level, "%s: %s\n", name, buf);
87 }
88
89 static int kset(AVFormatContext *s, const uint8_t *r_val, const uint8_t *n_val,
90                 int len)
91 {
92     OMAContext *oc = s->priv_data;
93
94     if (!r_val && !n_val)
95         return -1;
96
97     len = FFMIN(len, 16);
98
99     /* use first 64 bits in the third round again */
100     if (r_val) {
101         if (r_val != oc->r_val) {
102             memset(oc->r_val, 0, 24);
103             memcpy(oc->r_val, r_val, len);
104         }
105         memcpy(&oc->r_val[16], r_val, 8);
106     }
107     if (n_val) {
108         if (n_val != oc->n_val) {
109             memset(oc->n_val, 0, 24);
110             memcpy(oc->n_val, n_val, len);
111         }
112         memcpy(&oc->n_val[16], n_val, 8);
113     }
114
115     return 0;
116 }
117
118 #define OMA_RPROBE_M_VAL 48 + 1
119
120 static int rprobe(AVFormatContext *s, uint8_t *enc_header, unsigned size,
121                   const uint8_t *r_val)
122 {
123     OMAContext *oc = s->priv_data;
124     unsigned int pos;
125     struct AVDES av_des;
126
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)
130         return -1;
131
132     /* 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);
135
136     /* s_val */
137     av_des_init(&av_des, oc->m_val, 64, 0);
138     av_des_crypt(&av_des, oc->s_val, NULL, 1, NULL, 0);
139
140     /* sm_val */
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));
144
145     pos += oc->i_size;
146
147     return memcmp(&enc_header[pos], oc->sm_val, 8) ? -1 : 0;
148 }
149
150 static int nprobe(AVFormatContext *s, uint8_t *enc_header, unsigned size,
151                   const uint8_t *n_val)
152 {
153     OMAContext *oc = s->priv_data;
154     uint64_t pos;
155     uint32_t taglen, datalen;
156     struct AVDES av_des;
157
158     if (!enc_header || !n_val ||
159         size < OMA_ENC_HEADER_SIZE + oc->k_size + 4)
160         return -1;
161
162     pos = OMA_ENC_HEADER_SIZE + oc->k_size;
163     if (!memcmp(&enc_header[pos], "EKB ", 4))
164         pos += 32;
165
166     if (size < pos + 44)
167         return -1;
168
169     if (AV_RB32(&enc_header[pos]) != oc->rid)
170         av_log(s, AV_LOG_DEBUG, "Mismatching RID\n");
171
172     taglen  = AV_RB32(&enc_header[pos + 32]);
173     datalen = AV_RB32(&enc_header[pos + 36]) >> 4;
174
175     pos += 44 + taglen;
176
177     if (datalen << 4 > size - pos)
178         return -1;
179
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))
185             return 0;
186         pos += 16;
187     }
188
189     return -1;
190 }
191
192 static int decrypt_init(AVFormatContext *s, ID3v2ExtraMeta *em, uint8_t *header)
193 {
194     OMAContext *oc = s->priv_data;
195     ID3v2ExtraMetaGEOB *geob = NULL;
196     uint8_t *gdata;
197
198     oc->encrypted = 1;
199     av_log(s, AV_LOG_INFO, "File is encrypted\n");
200
201     /* find GEOB metadata */
202     while (em) {
203         if (!strcmp(em->tag, "GEOB") &&
204             (geob = em->data) &&
205             (!strcmp(geob->description, "OMG_LSI") ||
206              !strcmp(geob->description, "OMG_BKLSI"))) {
207             break;
208         }
209         em = em->next;
210     }
211     if (!em) {
212         av_log(s, AV_LOG_ERROR, "No encryption header found\n");
213         return AVERROR_INVALIDDATA;
214     }
215
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;
220     }
221
222     gdata = geob->data;
223
224     if (AV_RB16(gdata) != 1)
225         av_log(s, AV_LOG_WARNING, "Unknown version in encryption header\n");
226
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]);
231
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;
235     }
236     oc->rid = AV_RB32(&gdata[OMA_ENC_HEADER_SIZE + 28]);
237     av_log(s, AV_LOG_DEBUG, "RID: %.8x\n", oc->rid);
238
239     memcpy(oc->iv, &header[0x58], 8);
240     hex_log(s, AV_LOG_DEBUG, "IV", oc->iv, 8);
241
242     hex_log(s, AV_LOG_DEBUG, "CBC-MAC",
243             &gdata[OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size + oc->i_size],
244             8);
245
246     if (s->keylen > 0) {
247         kset(s, s->key, s->key, s->keylen);
248     }
249     if (!memcmp(oc->r_val, (const uint8_t[8]){0}, 8) ||
250         rprobe(s, gdata, geob->datasize, oc->r_val) < 0 &&
251         nprobe(s, gdata, geob->datasize, oc->n_val) < 0) {
252         int i;
253         for (i = 0; i < FF_ARRAY_ELEMS(leaf_table); i += 2) {
254             uint8_t buf[16];
255             AV_WL64(buf,     leaf_table[i]);
256             AV_WL64(&buf[8], leaf_table[i + 1]);
257             kset(s, buf, buf, 16);
258             if (!rprobe(s, gdata, geob->datasize, oc->r_val) ||
259                 !nprobe(s, gdata, geob->datasize, oc->n_val))
260                 break;
261         }
262         if (i >= sizeof(leaf_table)) {
263             av_log(s, AV_LOG_ERROR, "Invalid key\n");
264             return AVERROR_INVALIDDATA;
265         }
266     }
267
268     /* e_val */
269     av_des_init(&oc->av_des, oc->m_val, 64, 0);
270     av_des_crypt(&oc->av_des, oc->e_val,
271                  &gdata[OMA_ENC_HEADER_SIZE + 40], 1, NULL, 0);
272     hex_log(s, AV_LOG_DEBUG, "EK", oc->e_val, 8);
273
274     /* init e_val */
275     av_des_init(&oc->av_des, oc->e_val, 64, 1);
276
277     return 0;
278 }
279
280 static int oma_read_header(AVFormatContext *s)
281 {
282     int     ret, framesize, jsflag, samplerate;
283     uint32_t codec_params;
284     int16_t eid;
285     uint8_t buf[EA3_HEADER_SIZE];
286     uint8_t *edata;
287     AVStream *st;
288     ID3v2ExtraMeta *extra_meta = NULL;
289     OMAContext *oc = s->priv_data;
290
291     ff_id3v2_read(s, ID3v2_EA3_MAGIC, &extra_meta);
292     ret = avio_read(s->pb, buf, EA3_HEADER_SIZE);
293     if (ret < EA3_HEADER_SIZE)
294         return -1;
295
296     if (memcmp(buf, ((const uint8_t[]){'E', 'A', '3'}), 3) ||
297         buf[4] != 0 || buf[5] != EA3_HEADER_SIZE) {
298         av_log(s, AV_LOG_ERROR, "Couldn't find the EA3 header !\n");
299         return AVERROR_INVALIDDATA;
300     }
301
302     oc->content_start = avio_tell(s->pb);
303
304     /* encrypted file */
305     eid = AV_RB16(&buf[6]);
306     if (eid != -1 && eid != -128 && decrypt_init(s, extra_meta, buf) < 0) {
307         ff_id3v2_free_extra_meta(&extra_meta);
308         return -1;
309     }
310
311     ff_id3v2_free_extra_meta(&extra_meta);
312
313     codec_params = AV_RB24(&buf[33]);
314
315     st = avformat_new_stream(s, NULL);
316     if (!st)
317         return AVERROR(ENOMEM);
318
319     st->start_time = 0;
320     st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
321     st->codec->codec_tag  = buf[32];
322     st->codec->codec_id   = ff_codec_get_id(ff_oma_codec_tags,
323                                             st->codec->codec_tag);
324
325     switch (buf[32]) {
326     case OMA_CODECID_ATRAC3:
327         samplerate = ff_oma_srate_tab[(codec_params >> 13) & 7] * 100;
328         if (!samplerate) {
329             av_log(s, AV_LOG_ERROR, "Unsupported sample rate\n");
330             return AVERROR_INVALIDDATA;
331         }
332         if (samplerate != 44100)
333             avpriv_request_sample(s, "Sample rate %d", samplerate);
334
335         framesize = (codec_params & 0x3FF) * 8;
336
337         /* get stereo coding mode, 1 for joint-stereo */
338         jsflag = (codec_params >> 17) & 1;
339
340         st->codec->channels    = 2;
341         st->codec->channel_layout = AV_CH_LAYOUT_STEREO;
342         st->codec->sample_rate = samplerate;
343         st->codec->bit_rate    = st->codec->sample_rate * framesize * 8 / 1024;
344
345         /* fake the ATRAC3 extradata
346          * (wav format, makes stream copy to wav work) */
347         st->codec->extradata_size = 14;
348         edata = av_mallocz(14 + FF_INPUT_BUFFER_PADDING_SIZE);
349         if (!edata)
350             return AVERROR(ENOMEM);
351
352         st->codec->extradata = edata;
353         AV_WL16(&edata[0],  1);             // always 1
354         AV_WL32(&edata[2],  samplerate);    // samples rate
355         AV_WL16(&edata[6],  jsflag);        // coding mode
356         AV_WL16(&edata[8],  jsflag);        // coding mode
357         AV_WL16(&edata[10], 1);             // always 1
358         // AV_WL16(&edata[12], 0);          // always 0
359
360         avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
361         break;
362     case OMA_CODECID_ATRAC3P:
363         st->codec->channels = (codec_params >> 10) & 7;
364         framesize = ((codec_params & 0x3FF) * 8) + 8;
365         samplerate = ff_oma_srate_tab[(codec_params >> 13) & 7] * 100;
366         if (!samplerate) {
367             av_log(s, AV_LOG_ERROR, "Unsupported sample rate\n");
368             return AVERROR_INVALIDDATA;
369         }
370         st->codec->sample_rate = samplerate;
371         st->codec->bit_rate    = samplerate * framesize * 8 / 1024;
372         avpriv_set_pts_info(st, 64, 1, samplerate);
373         av_log(s, AV_LOG_ERROR, "Unsupported codec ATRAC3+!\n");
374         break;
375     case OMA_CODECID_MP3:
376         st->need_parsing = AVSTREAM_PARSE_FULL;
377         framesize = 1024;
378         break;
379     case OMA_CODECID_LPCM:
380         /* PCM 44.1 kHz 16 bit stereo big-endian */
381         st->codec->channels = 2;
382         st->codec->channel_layout = AV_CH_LAYOUT_STEREO;
383         st->codec->sample_rate = 44100;
384         framesize = 1024;
385         /* bit rate = sample rate x PCM block align (= 4) x 8 */
386         st->codec->bit_rate = st->codec->sample_rate * 32;
387         st->codec->bits_per_coded_sample =
388             av_get_bits_per_sample(st->codec->codec_id);
389         avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
390         break;
391     default:
392         av_log(s, AV_LOG_ERROR, "Unsupported codec %d!\n", buf[32]);
393         return AVERROR(ENOSYS);
394     }
395
396     st->codec->block_align = framesize;
397
398     return 0;
399 }
400
401
402 static int oma_read_packet(AVFormatContext *s, AVPacket *pkt)
403 {
404     OMAContext *oc = s->priv_data;
405     int packet_size = s->streams[0]->codec->block_align;
406     int ret = av_get_packet(s->pb, pkt, packet_size);
407
408     if (ret < packet_size)
409         pkt->flags |= AV_PKT_FLAG_CORRUPT;
410
411     if (ret < 0)
412         return ret;
413     if (!ret)
414         return AVERROR_EOF;
415
416     pkt->stream_index = 0;
417
418     if (oc->encrypted) {
419         /* previous unencrypted block saved in IV for
420          * the next packet (CBC mode) */
421         if (ret == packet_size)
422             av_des_crypt(&oc->av_des, pkt->data, pkt->data,
423                          (packet_size >> 3), oc->iv, 1);
424         else
425             memset(oc->iv, 0, 8);
426     }
427
428     return ret;
429 }
430
431 static int oma_read_probe(AVProbeData *p)
432 {
433     const uint8_t *buf;
434     unsigned tag_len = 0;
435
436     buf = p->buf;
437
438     if (p->buf_size < ID3v2_HEADER_SIZE ||
439         !ff_id3v2_match(buf, ID3v2_EA3_MAGIC) ||
440         buf[3] != 3 || // version must be 3
441         buf[4]) // flags byte zero
442         return 0;
443
444     tag_len = ff_id3v2_tag_len(buf);
445
446     /* This check cannot overflow as tag_len has at most 28 bits */
447     if (p->buf_size < tag_len + 5)
448         /* EA3 header comes late, might be outside of the probe buffer */
449         return AVPROBE_SCORE_EXTENSION;
450
451     buf += tag_len;
452
453     if (!memcmp(buf, "EA3", 3) && !buf[4] && buf[5] == EA3_HEADER_SIZE)
454         return AVPROBE_SCORE_MAX;
455     else
456         return 0;
457 }
458
459 static int oma_read_seek(struct AVFormatContext *s,
460                          int stream_index, int64_t timestamp, int flags)
461 {
462     OMAContext *oc = s->priv_data;
463     int err = ff_pcm_read_seek(s, stream_index, timestamp, flags);
464
465     if (!oc->encrypted)
466         return err;
467
468     /* readjust IV for CBC */
469     if (err || avio_tell(s->pb) < oc->content_start)
470         goto wipe;
471     if ((err = avio_seek(s->pb, -8, SEEK_CUR)) < 0)
472         goto wipe;
473     if ((err = avio_read(s->pb, oc->iv, 8)) < 8) {
474         if (err >= 0)
475             err = AVERROR_EOF;
476         goto wipe;
477     }
478
479     return 0;
480 wipe:
481     memset(oc->iv, 0, 8);
482     return err;
483 }
484
485 AVInputFormat ff_oma_demuxer = {
486     .name           = "oma",
487     .long_name      = NULL_IF_CONFIG_SMALL("Sony OpenMG audio"),
488     .priv_data_size = sizeof(OMAContext),
489     .read_probe     = oma_read_probe,
490     .read_header    = oma_read_header,
491     .read_packet    = oma_read_packet,
492     .read_seek      = oma_read_seek,
493     .flags          = AVFMT_GENERIC_INDEX,
494     .extensions     = "oma,omg,aa3",
495     .codec_tag      = (const AVCodecTag* const []){ff_oma_codec_tags, 0},
496 };