oma: Fix out of array read.
[ffmpeg.git] / libavformat / oma.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 FFmpeg.
9  *
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.
14  *
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.
19  *
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
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 "avformat.h"
44 #include "internal.h"
45 #include "libavutil/intreadwrite.h"
46 #include "libavutil/des.h"
47 #include "pcm.h"
48 #include "riff.h"
49 #include "id3v2.h"
50
51 #define EA3_HEADER_SIZE 96
52 #define ID3v2_EA3_MAGIC "ea3"
53 #define OMA_ENC_HEADER_SIZE 16
54
55 enum {
56     OMA_CODECID_ATRAC3  = 0,
57     OMA_CODECID_ATRAC3P = 1,
58     OMA_CODECID_MP3     = 3,
59     OMA_CODECID_LPCM    = 4,
60     OMA_CODECID_WMA     = 5,
61 };
62
63 static const AVCodecTag codec_oma_tags[] = {
64     { CODEC_ID_ATRAC3,  OMA_CODECID_ATRAC3 },
65     { CODEC_ID_ATRAC3P, OMA_CODECID_ATRAC3P },
66     { CODEC_ID_MP3,     OMA_CODECID_MP3 },
67 };
68
69 static const uint64_t leaf_table[] = {
70     0xd79e8283acea4620, 0x7a9762f445afd0d8,
71     0x354d60a60b8c79f1, 0x584e1cde00b07aee,
72     0x1573cd93da7df623, 0x47f98d79620dd535
73 };
74
75 typedef struct OMAContext {
76     uint64_t content_start;
77     int encrypted;
78     uint16_t k_size;
79     uint16_t e_size;
80     uint16_t i_size;
81     uint16_t s_size;
82     uint32_t rid;
83     uint8_t r_val[24];
84     uint8_t n_val[24];
85     uint8_t m_val[8];
86     uint8_t s_val[8];
87     uint8_t sm_val[8];
88     uint8_t e_val[8];
89     uint8_t iv[8];
90     struct AVDES av_des;
91 } OMAContext;
92
93 static void hex_log(AVFormatContext *s, int level, const char *name, const uint8_t *value, int len)
94 {
95     char buf[33];
96     len = FFMIN(len, 16);
97     if (av_log_get_level() < level)
98         return;
99     ff_data_to_hex(buf, value, len, 1);
100     buf[len<<1] = '\0';
101     av_log(s, level, "%s: %s\n", name, buf);
102 }
103
104 static int kset(AVFormatContext *s, const uint8_t *r_val, const uint8_t *n_val, int len)
105 {
106     OMAContext *oc = s->priv_data;
107
108     if (!r_val && !n_val)
109         return -1;
110
111     len = FFMIN(len, 16);
112
113     /* use first 64 bits in the third round again */
114     if (r_val) {
115         if (r_val != oc->r_val) {
116             memset(oc->r_val, 0, 24);
117             memcpy(oc->r_val, r_val, len);
118         }
119         memcpy(&oc->r_val[16], r_val, 8);
120     }
121     if (n_val) {
122         if (n_val != oc->n_val) {
123             memset(oc->n_val, 0, 24);
124             memcpy(oc->n_val, n_val, len);
125         }
126         memcpy(&oc->n_val[16], n_val, 8);
127     }
128
129     return 0;
130 }
131
132 static int rprobe(AVFormatContext *s, uint8_t *enc_header, const uint8_t *r_val)
133 {
134     OMAContext *oc = s->priv_data;
135     unsigned int pos;
136     struct AVDES av_des;
137
138     if (!enc_header || !r_val)
139         return -1;
140
141     /* m_val */
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);
144
145     /* s_val */
146     av_des_init(&av_des, oc->m_val, 64, 0);
147     av_des_crypt(&av_des, oc->s_val, NULL, 1, NULL, 0);
148
149     /* sm_val */
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));
153
154     pos += oc->i_size;
155
156     return memcmp(&enc_header[pos], oc->sm_val, 8) ? -1 : 0;
157 }
158
159 static int nprobe(AVFormatContext *s, uint8_t *enc_header, int size, const uint8_t *n_val)
160 {
161     OMAContext *oc = s->priv_data;
162     uint32_t pos, taglen, datalen;
163     struct AVDES av_des;
164
165     if (!enc_header || !n_val)
166         return -1;
167
168     pos = OMA_ENC_HEADER_SIZE + oc->k_size;
169     if (!memcmp(&enc_header[pos], "EKB ", 4))
170         pos += 32;
171
172     if (AV_RB32(&enc_header[pos]) != oc->rid)
173         av_log(s, AV_LOG_DEBUG, "Mismatching RID\n");
174
175     taglen = AV_RB32(&enc_header[pos+32]);
176     datalen = AV_RB32(&enc_header[pos+36]) >> 4;
177
178     if(taglen + (((uint64_t)datalen)<<4) + 44 > size)
179         return -1;
180
181     pos += 44 + taglen;
182
183     av_des_init(&av_des, n_val, 192, 1);
184     while (datalen-- > 0) {
185         av_des_crypt(&av_des, oc->r_val, &enc_header[pos], 2, NULL, 1);
186         kset(s, oc->r_val, NULL, 16);
187         if (!rprobe(s, enc_header, oc->r_val))
188             return 0;
189         pos += 16;
190     }
191
192     return -1;
193 }
194
195 static int decrypt_init(AVFormatContext *s, ID3v2ExtraMeta *em, uint8_t *header)
196 {
197     OMAContext *oc = s->priv_data;
198     ID3v2ExtraMetaGEOB *geob = NULL;
199     uint8_t *gdata;
200
201     oc->encrypted = 1;
202     av_log(s, AV_LOG_INFO, "File is encrypted\n");
203
204     /* find GEOB metadata */
205     while (em) {
206         if (!strcmp(em->tag, "GEOB") &&
207             (geob = em->data) &&
208             !strcmp(geob->description, "OMG_LSI") ||
209             !strcmp(geob->description, "OMG_BKLSI")) {
210             break;
211         }
212         em = em->next;
213     }
214     if (!em) {
215         av_log(s, AV_LOG_ERROR, "No encryption header found\n");
216         return -1;
217     }
218
219     if (geob->datasize < 64) {
220         av_log(s, AV_LOG_ERROR, "Invalid GEOB data size: %u\n", geob->datasize);
221         return -1;
222     }
223
224     gdata = geob->data;
225
226     if (AV_RB16(gdata) != 1)
227         av_log(s, AV_LOG_WARNING, "Unknown version in encryption header\n");
228
229     oc->k_size = AV_RB16(&gdata[2]);
230     oc->e_size = AV_RB16(&gdata[4]);
231     oc->i_size = AV_RB16(&gdata[6]);
232     oc->s_size = AV_RB16(&gdata[8]);
233
234     if (memcmp(&gdata[OMA_ENC_HEADER_SIZE], "KEYRING     ", 12)) {
235         av_log(s, AV_LOG_ERROR, "Invalid encryption header\n");
236         return -1;
237     }
238     oc->rid = AV_RB32(&gdata[OMA_ENC_HEADER_SIZE + 28]);
239     av_log(s, AV_LOG_DEBUG, "RID: %.8x\n", oc->rid);
240
241     memcpy(oc->iv, &header[0x58], 8);
242     hex_log(s, AV_LOG_DEBUG, "IV", oc->iv, 8);
243
244     hex_log(s, AV_LOG_DEBUG, "CBC-MAC", &gdata[OMA_ENC_HEADER_SIZE+oc->k_size+oc->e_size+oc->i_size], 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, oc->r_val) < 0 &&
251         nprobe(s, gdata, geob->datasize, oc->n_val) < 0) {
252         int i;
253         for (i = 0; i < sizeof(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, oc->r_val) || !nprobe(s, gdata, geob->datasize, oc->n_val))
259                 break;
260         }
261         if (i >= sizeof(leaf_table)) {
262             av_log(s, AV_LOG_ERROR, "Invalid key\n");
263             return -1;
264         }
265     }
266
267     /* e_val */
268     av_des_init(&oc->av_des, oc->m_val, 64, 0);
269     av_des_crypt(&oc->av_des, oc->e_val, &gdata[OMA_ENC_HEADER_SIZE + 40], 1, NULL, 0);
270     hex_log(s, AV_LOG_DEBUG, "EK", oc->e_val, 8);
271
272     /* init e_val */
273     av_des_init(&oc->av_des, oc->e_val, 64, 1);
274
275     return 0;
276 }
277
278 static int oma_read_header(AVFormatContext *s,
279                            AVFormatParameters *ap)
280 {
281     static const uint16_t srate_tab[6] = {320,441,480,882,960,0};
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_all(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) || buf[4] != 0 || buf[5] != EA3_HEADER_SIZE) {
297         av_log(s, AV_LOG_ERROR, "Couldn't find the EA3 header !\n");
298         return -1;
299     }
300
301     oc->content_start = avio_tell(s->pb);
302
303     /* encrypted file */
304     eid = AV_RB16(&buf[6]);
305     if (eid != -1 && eid != -128 && decrypt_init(s, extra_meta, buf) < 0) {
306         ff_id3v2_free_extra_meta(&extra_meta);
307         return -1;
308     }
309
310     ff_id3v2_free_extra_meta(&extra_meta);
311
312     codec_params = AV_RB24(&buf[33]);
313
314     st = avformat_new_stream(s, NULL);
315     if (!st)
316         return AVERROR(ENOMEM);
317
318     st->start_time = 0;
319     st->codec->codec_type  = AVMEDIA_TYPE_AUDIO;
320     st->codec->codec_tag   = buf[32];
321     st->codec->codec_id    = ff_codec_get_id(codec_oma_tags, st->codec->codec_tag);
322
323     switch (buf[32]) {
324         case OMA_CODECID_ATRAC3:
325             samplerate = srate_tab[(codec_params >> 13) & 7]*100;
326             if (samplerate != 44100)
327                 av_log_ask_for_sample(s, "Unsupported sample rate: %d\n",
328                                       samplerate);
329
330             framesize = (codec_params & 0x3FF) * 8;
331             jsflag = (codec_params >> 17) & 1; /* get stereo coding mode, 1 for joint-stereo */
332             st->codec->channels    = 2;
333             st->codec->sample_rate = samplerate;
334             st->codec->bit_rate    = st->codec->sample_rate * framesize * 8 / 1024;
335
336             /* fake the atrac3 extradata (wav format, makes stream copy to wav work) */
337             st->codec->extradata_size = 14;
338             edata = av_mallocz(14 + FF_INPUT_BUFFER_PADDING_SIZE);
339             if (!edata)
340                 return AVERROR(ENOMEM);
341
342             st->codec->extradata = edata;
343             AV_WL16(&edata[0],  1);             // always 1
344             AV_WL32(&edata[2],  samplerate);    // samples rate
345             AV_WL16(&edata[6],  jsflag);        // coding mode
346             AV_WL16(&edata[8],  jsflag);        // coding mode
347             AV_WL16(&edata[10], 1);             // always 1
348             // AV_WL16(&edata[12], 0);          // always 0
349
350             avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
351             break;
352         case OMA_CODECID_ATRAC3P:
353             st->codec->channels = (codec_params >> 10) & 7;
354             framesize = ((codec_params & 0x3FF) * 8) + 8;
355             st->codec->sample_rate = srate_tab[(codec_params >> 13) & 7]*100;
356             st->codec->bit_rate    = st->codec->sample_rate * framesize * 8 / 1024;
357             avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
358             av_log(s, AV_LOG_ERROR, "Unsupported codec ATRAC3+!\n");
359             break;
360         case OMA_CODECID_MP3:
361             st->need_parsing = AVSTREAM_PARSE_FULL;
362             framesize = 1024;
363             break;
364         default:
365             av_log(s, AV_LOG_ERROR, "Unsupported codec %d!\n",buf[32]);
366             return -1;
367     }
368
369     st->codec->block_align = framesize;
370
371     return 0;
372 }
373
374
375 static int oma_read_packet(AVFormatContext *s, AVPacket *pkt)
376 {
377     OMAContext *oc = s->priv_data;
378     int packet_size = s->streams[0]->codec->block_align;
379     int ret = av_get_packet(s->pb, pkt, packet_size);
380
381     if (ret <= 0)
382         return AVERROR(EIO);
383
384     pkt->stream_index = 0;
385
386     if (oc->encrypted) {
387         /* previous unencrypted block saved in IV for the next packet (CBC mode) */
388         av_des_crypt(&oc->av_des, pkt->data, pkt->data, (packet_size >> 3), oc->iv, 1);
389     }
390
391     return ret;
392 }
393
394 static int oma_read_probe(AVProbeData *p)
395 {
396     const uint8_t *buf;
397     unsigned tag_len = 0;
398
399     buf = p->buf;
400     /* version must be 3 and flags byte zero */
401     if (ff_id3v2_match(buf, ID3v2_EA3_MAGIC) && buf[3] == 3 && !buf[4])
402         tag_len = ff_id3v2_tag_len(buf);
403
404     // This check cannot overflow as tag_len has at most 28 bits
405     if (p->buf_size < tag_len + 5)
406         return 0;
407
408     buf += tag_len;
409
410     if (!memcmp(buf, "EA3", 3) && !buf[4] && buf[5] == EA3_HEADER_SIZE)
411         return AVPROBE_SCORE_MAX;
412     else
413         return 0;
414 }
415
416 static int oma_read_seek(struct AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
417 {
418     OMAContext *oc = s->priv_data;
419
420     pcm_read_seek(s, stream_index, timestamp, flags);
421
422     if (oc->encrypted) {
423         /* readjust IV for CBC */
424         int64_t pos = avio_tell(s->pb);
425         if (pos < oc->content_start)
426             memset(oc->iv, 0, 8);
427         else {
428             if (avio_seek(s->pb, -8, SEEK_CUR) < 0 || avio_read(s->pb, oc->iv, 8) < 8) {
429                 memset(oc->iv, 0, 8);
430                 return -1;
431             }
432         }
433     }
434
435     return 0;
436 }
437
438 AVInputFormat ff_oma_demuxer = {
439     .name           = "oma",
440     .long_name      = NULL_IF_CONFIG_SMALL("Sony OpenMG audio"),
441     .priv_data_size = sizeof(OMAContext),
442     .read_probe     = oma_read_probe,
443     .read_header    = oma_read_header,
444     .read_packet    = oma_read_packet,
445     .read_seek      = oma_read_seek,
446     .flags          = AVFMT_GENERIC_INDEX,
447     .extensions     = "oma,omg,aa3",
448     .codec_tag      = (const AVCodecTag* const []){codec_oma_tags, 0},
449 };
450