dv: fix null ptr dereference
[ffmpeg.git] / libavformat / dv.c
1 /*
2  * General DV muxer/demuxer
3  * Copyright (c) 2003 Roman Shaposhnik
4  *
5  * Many thanks to Dan Dennedy <dan@dennedy.org> for providing wealth
6  * of DV technical info.
7  *
8  * Raw DV format
9  * Copyright (c) 2002 Fabrice Bellard
10  *
11  * 50 Mbps (DVCPRO50) and 100 Mbps (DVCPRO HD) support
12  * Copyright (c) 2006 Daniel Maas <dmaas@maasdigital.com>
13  * Funded by BBC Research & Development
14  *
15  * This file is part of FFmpeg.
16  *
17  * FFmpeg is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  *
22  * FFmpeg is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with FFmpeg; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31 #include <time.h>
32 #include "avformat.h"
33 #include "internal.h"
34 #include "libavcodec/dv_profile.h"
35 #include "libavcodec/dvdata.h"
36 #include "libavutil/intreadwrite.h"
37 #include "libavutil/mathematics.h"
38 #include "libavutil/timecode.h"
39 #include "dv.h"
40 #include "libavutil/avassert.h"
41
42 struct DVDemuxContext {
43     const DVprofile*  sys;    /* Current DV profile. E.g.: 525/60, 625/50 */
44     AVFormatContext*  fctx;
45     AVStream*         vst;
46     AVStream*         ast[4];
47     AVPacket          audio_pkt[4];
48     uint8_t           audio_buf[4][8192];
49     int               ach;
50     int               frames;
51     uint64_t          abytes;
52 };
53
54 static inline uint16_t dv_audio_12to16(uint16_t sample)
55 {
56     uint16_t shift, result;
57
58     sample = (sample < 0x800) ? sample : sample | 0xf000;
59     shift  = (sample & 0xf00) >> 8;
60
61     if (shift < 0x2 || shift > 0xd) {
62         result = sample;
63     } else if (shift < 0x8) {
64         shift--;
65         result = (sample - (256 * shift)) << shift;
66     } else {
67         shift = 0xe - shift;
68         result = ((sample + ((256 * shift) + 1)) << shift) - 1;
69     }
70
71     return result;
72 }
73
74 /*
75  * This is the dumbest implementation of all -- it simply looks at
76  * a fixed offset and if pack isn't there -- fails. We might want
77  * to have a fallback mechanism for complete search of missing packs.
78  */
79 static const uint8_t* dv_extract_pack(uint8_t* frame, enum dv_pack_type t)
80 {
81     int offs;
82
83     switch (t) {
84     case dv_audio_source:
85         offs = (80*6 + 80*16*3 + 3);
86         break;
87     case dv_audio_control:
88         offs = (80*6 + 80*16*4 + 3);
89         break;
90     case dv_video_control:
91         offs = (80*5 + 48 + 5);
92         break;
93     case dv_timecode:
94         offs = (80*1 + 3 + 3);
95         break;
96     default:
97         return NULL;
98     }
99
100     return frame[offs] == t ? &frame[offs] : NULL;
101 }
102
103 static const int dv_audio_frequency[3] = {
104     48000, 44100, 32000,
105 };
106
107 /*
108  * There's a couple of assumptions being made here:
109  * 1. By default we silence erroneous (0x8000/16bit 0x800/12bit) audio samples.
110  *    We can pass them upwards when libavcodec will be ready to deal with them.
111  * 2. We don't do software emphasis.
112  * 3. Audio is always returned as 16bit linear samples: 12bit nonlinear samples
113  *    are converted into 16bit linear ones.
114  */
115 static int dv_extract_audio(uint8_t* frame, uint8_t* ppcm[4],
116                             const DVprofile *sys)
117 {
118     int size, chan, i, j, d, of, smpls, freq, quant, half_ch;
119     uint16_t lc, rc;
120     const uint8_t* as_pack;
121     uint8_t *pcm, ipcm;
122
123     as_pack = dv_extract_pack(frame, dv_audio_source);
124     if (!as_pack)    /* No audio ? */
125         return 0;
126
127     smpls =  as_pack[1] & 0x3f;       /* samples in this frame - min. samples */
128     freq  = (as_pack[4] >> 3) & 0x07; /* 0 - 48kHz, 1 - 44,1kHz, 2 - 32kHz */
129     quant =  as_pack[4] & 0x07;       /* 0 - 16bit linear, 1 - 12bit nonlinear */
130
131     if (quant > 1)
132         return -1; /* unsupported quantization */
133
134     if (freq >= FF_ARRAY_ELEMS(dv_audio_frequency))
135         return AVERROR_INVALIDDATA;
136
137     size = (sys->audio_min_samples[freq] + smpls) * 4; /* 2ch, 2bytes */
138     half_ch = sys->difseg_size / 2;
139
140     /* We work with 720p frames split in half, thus even frames have
141      * channels 0,1 and odd 2,3. */
142     ipcm = (sys->height == 720 && !(frame[1] & 0x0C)) ? 2 : 0;
143
144     /* for each DIF channel */
145     for (chan = 0; chan < sys->n_difchan; chan++) {
146         av_assert0(ipcm<4);
147         pcm = ppcm[ipcm++];
148         if (!pcm)
149             break;
150
151         /* for each DIF segment */
152         for (i = 0; i < sys->difseg_size; i++) {
153             frame += 6 * 80; /* skip DIF segment header */
154             if (quant == 1 && i == half_ch) {
155                 /* next stereo channel (12bit mode only) */
156                 av_assert0(ipcm<4);
157                 pcm = ppcm[ipcm++];
158                 if (!pcm)
159                     break;
160             }
161
162             /* for each AV sequence */
163             for (j = 0; j < 9; j++) {
164                 for (d = 8; d < 80; d += 2) {
165                     if (quant == 0) {  /* 16bit quantization */
166                         of = sys->audio_shuffle[i][j] + (d - 8) / 2 * sys->audio_stride;
167                         if (of*2 >= size)
168                             continue;
169
170                         pcm[of*2]   = frame[d+1]; // FIXME: maybe we have to admit
171                         pcm[of*2+1] = frame[d];   //        that DV is a big-endian PCM
172                         if (pcm[of*2+1] == 0x80 && pcm[of*2] == 0x00)
173                             pcm[of*2+1] = 0;
174                     } else {           /* 12bit quantization */
175                         lc = ((uint16_t)frame[d]   << 4) |
176                              ((uint16_t)frame[d+2] >> 4);
177                         rc = ((uint16_t)frame[d+1] << 4) |
178                              ((uint16_t)frame[d+2] & 0x0f);
179                         lc = (lc == 0x800 ? 0 : dv_audio_12to16(lc));
180                         rc = (rc == 0x800 ? 0 : dv_audio_12to16(rc));
181
182                         of = sys->audio_shuffle[i%half_ch][j] + (d - 8) / 3 * sys->audio_stride;
183                         if (of*2 >= size)
184                             continue;
185
186                         pcm[of*2]   = lc & 0xff; // FIXME: maybe we have to admit
187                         pcm[of*2+1] = lc >> 8;   //        that DV is a big-endian PCM
188                         of = sys->audio_shuffle[i%half_ch+half_ch][j] +
189                             (d - 8) / 3 * sys->audio_stride;
190                         pcm[of*2]   = rc & 0xff; // FIXME: maybe we have to admit
191                         pcm[of*2+1] = rc >> 8;   //        that DV is a big-endian PCM
192                         ++d;
193                     }
194                 }
195
196                 frame += 16 * 80; /* 15 Video DIFs + 1 Audio DIF */
197             }
198         }
199     }
200
201     return size;
202 }
203
204 static int dv_extract_audio_info(DVDemuxContext* c, uint8_t* frame)
205 {
206     const uint8_t* as_pack;
207     int freq, stype, smpls, quant, i, ach;
208
209     as_pack = dv_extract_pack(frame, dv_audio_source);
210     if (!as_pack || !c->sys) {    /* No audio ? */
211         c->ach = 0;
212         return 0;
213     }
214
215     smpls =  as_pack[1] & 0x3f;       /* samples in this frame - min. samples */
216     freq  = (as_pack[4] >> 3) & 0x07; /* 0 - 48kHz, 1 - 44,1kHz, 2 - 32kHz */
217     stype = (as_pack[3] & 0x1f);      /* 0 - 2CH, 2 - 4CH, 3 - 8CH */
218     quant =  as_pack[4] & 0x07;       /* 0 - 16bit linear, 1 - 12bit nonlinear */
219
220     if (freq >= FF_ARRAY_ELEMS(dv_audio_frequency)) {
221         av_log(c->fctx, AV_LOG_ERROR,
222                "Unrecognized audio sample rate index (%d)\n", freq);
223         return 0;
224     }
225
226     if (stype > 3) {
227         av_log(c->fctx, AV_LOG_ERROR, "stype %d is invalid\n", stype);
228         c->ach = 0;
229         return 0;
230     }
231
232     /* note: ach counts PAIRS of channels (i.e. stereo channels) */
233     ach = ((int[4]){  1,  0,  2,  4})[stype];
234     if (ach == 1 && quant && freq == 2)
235         ach = 2;
236
237     /* Dynamic handling of the audio streams in DV */
238     for (i = 0; i < ach; i++) {
239        if (!c->ast[i]) {
240            c->ast[i] = avformat_new_stream(c->fctx, NULL);
241            if (!c->ast[i])
242                break;
243            avpriv_set_pts_info(c->ast[i], 64, 1, 30000);
244            c->ast[i]->codec->codec_type = AVMEDIA_TYPE_AUDIO;
245            c->ast[i]->codec->codec_id   = AV_CODEC_ID_PCM_S16LE;
246
247            av_init_packet(&c->audio_pkt[i]);
248            c->audio_pkt[i].size         = 0;
249            c->audio_pkt[i].data         = c->audio_buf[i];
250            c->audio_pkt[i].stream_index = c->ast[i]->index;
251            c->audio_pkt[i].flags       |= AV_PKT_FLAG_KEY;
252        }
253        c->ast[i]->codec->sample_rate = dv_audio_frequency[freq];
254        c->ast[i]->codec->channels    = 2;
255        c->ast[i]->codec->bit_rate    = 2 * dv_audio_frequency[freq] * 16;
256        c->ast[i]->start_time         = 0;
257     }
258     c->ach = i;
259
260     return (c->sys->audio_min_samples[freq] + smpls) * 4; /* 2ch, 2bytes */;
261 }
262
263 static int dv_extract_video_info(DVDemuxContext *c, uint8_t* frame)
264 {
265     const uint8_t* vsc_pack;
266     AVCodecContext* avctx;
267     int apt, is16_9;
268     int size = 0;
269
270     if (c->sys) {
271         avctx = c->vst->codec;
272
273         avpriv_set_pts_info(c->vst, 64, c->sys->time_base.num,
274                         c->sys->time_base.den);
275         avctx->time_base= c->sys->time_base;
276
277         /* finding out SAR is a little bit messy */
278         vsc_pack = dv_extract_pack(frame, dv_video_control);
279         apt      = frame[4] & 0x07;
280         is16_9   = (vsc_pack && ((vsc_pack[2] & 0x07) == 0x02 ||
281                                 (!apt && (vsc_pack[2] & 0x07) == 0x07)));
282         c->vst->sample_aspect_ratio = c->sys->sar[is16_9];
283         avctx->bit_rate = av_rescale_q(c->sys->frame_size, (AVRational){8,1},
284                                        c->sys->time_base);
285         size = c->sys->frame_size;
286     }
287     return size;
288 }
289
290 static int dv_extract_timecode(DVDemuxContext* c, uint8_t* frame, char *tc)
291 {
292     const uint8_t *tc_pack;
293
294     // For PAL systems, drop frame bit is replaced by an arbitrary
295     // bit so its value should not be considered. Drop frame timecode
296     // is only relevant for NTSC systems.
297     int prevent_df = c->sys->ltc_divisor == 25 || c->sys->ltc_divisor == 50;
298
299     tc_pack = dv_extract_pack(frame, dv_timecode);
300     if (!tc_pack)
301         return 0;
302     av_timecode_make_smpte_tc_string(tc, AV_RB32(tc_pack + 1), prevent_df);
303     return 1;
304 }
305
306 /*
307  * The following 3 functions constitute our interface to the world
308  */
309
310 DVDemuxContext* avpriv_dv_init_demux(AVFormatContext *s)
311 {
312     DVDemuxContext *c;
313
314     c = av_mallocz(sizeof(DVDemuxContext));
315     if (!c)
316         return NULL;
317
318     c->vst = avformat_new_stream(s, NULL);
319     if (!c->vst) {
320         av_free(c);
321         return NULL;
322     }
323
324     c->fctx                   = s;
325     c->vst->codec->codec_type = AVMEDIA_TYPE_VIDEO;
326     c->vst->codec->codec_id   = AV_CODEC_ID_DVVIDEO;
327     c->vst->codec->bit_rate   = 25000000;
328     c->vst->start_time        = 0;
329
330     return c;
331 }
332
333 int avpriv_dv_get_packet(DVDemuxContext *c, AVPacket *pkt)
334 {
335     int size = -1;
336     int i;
337
338     for (i = 0; i < c->ach; i++) {
339        if (c->ast[i] && c->audio_pkt[i].size) {
340            *pkt = c->audio_pkt[i];
341            c->audio_pkt[i].size = 0;
342            size = pkt->size;
343            break;
344        }
345     }
346
347     return size;
348 }
349
350 int avpriv_dv_produce_packet(DVDemuxContext *c, AVPacket *pkt,
351                       uint8_t* buf, int buf_size, int64_t pos)
352 {
353     int size, i;
354     uint8_t *ppcm[4] = {0};
355
356     if (buf_size < DV_PROFILE_BYTES ||
357         !(c->sys = avpriv_dv_frame_profile(c->sys, buf, buf_size)) ||
358         buf_size < c->sys->frame_size) {
359           return -1;   /* Broken frame, or not enough data */
360     }
361
362     /* Queueing audio packet */
363     /* FIXME: in case of no audio/bad audio we have to do something */
364     size = dv_extract_audio_info(c, buf);
365     for (i = 0; i < c->ach; i++) {
366        c->audio_pkt[i].pos  = pos;
367        c->audio_pkt[i].size = size;
368        c->audio_pkt[i].pts  = c->abytes * 30000*8 / c->ast[i]->codec->bit_rate;
369        ppcm[i] = c->audio_buf[i];
370     }
371     if (c->ach)
372         dv_extract_audio(buf, ppcm, c->sys);
373
374     /* We work with 720p frames split in half, thus even frames have
375      * channels 0,1 and odd 2,3. */
376     if (c->sys->height == 720) {
377         if (buf[1] & 0x0C) {
378             c->audio_pkt[2].size = c->audio_pkt[3].size = 0;
379         } else {
380             c->audio_pkt[0].size = c->audio_pkt[1].size = 0;
381             c->abytes += size;
382         }
383     } else {
384         c->abytes += size;
385     }
386
387     /* Now it's time to return video packet */
388     size = dv_extract_video_info(c, buf);
389     av_init_packet(pkt);
390     pkt->data         = buf;
391     pkt->pos          = pos;
392     pkt->size         = size;
393     pkt->flags       |= AV_PKT_FLAG_KEY;
394     pkt->stream_index = c->vst->id;
395     pkt->pts          = c->frames;
396
397     c->frames++;
398
399     return size;
400 }
401
402 static int64_t dv_frame_offset(AVFormatContext *s, DVDemuxContext *c,
403                               int64_t timestamp, int flags)
404 {
405     // FIXME: sys may be wrong if last dv_read_packet() failed (buffer is junk)
406     const DVprofile* sys = avpriv_dv_codec_profile(c->vst->codec);
407     int64_t offset;
408     int64_t size = avio_size(s->pb) - s->data_offset;
409     int64_t max_offset = ((size-1) / sys->frame_size) * sys->frame_size;
410
411     offset = sys->frame_size * timestamp;
412
413     if (size >= 0 && offset > max_offset) offset = max_offset;
414     else if (offset < 0) offset = 0;
415
416     return offset + s->data_offset;
417 }
418
419 void ff_dv_offset_reset(DVDemuxContext *c, int64_t frame_offset)
420 {
421     c->frames= frame_offset;
422     if (c->ach) {
423         if (c->sys) {
424         c->abytes= av_rescale_q(c->frames, c->sys->time_base,
425                                 (AVRational){8, c->ast[0]->codec->bit_rate});
426         }else
427             av_log(c->fctx, AV_LOG_ERROR, "cannot adjust audio bytes\n");
428     }
429     c->audio_pkt[0].size = c->audio_pkt[1].size = 0;
430     c->audio_pkt[2].size = c->audio_pkt[3].size = 0;
431 }
432
433 /************************************************************
434  * Implementation of the easiest DV storage of all -- raw DV.
435  ************************************************************/
436
437 typedef struct RawDVContext {
438     DVDemuxContext* dv_demux;
439     uint8_t         buf[DV_MAX_FRAME_SIZE];
440 } RawDVContext;
441
442 static int dv_read_timecode(AVFormatContext *s) {
443     int ret;
444     char timecode[AV_TIMECODE_STR_SIZE];
445     int64_t pos = avio_tell(s->pb);
446
447     // Read 3 DIF blocks: Header block and 2 Subcode blocks.
448     int partial_frame_size = 3 * 80;
449     uint8_t *partial_frame = av_mallocz(sizeof(*partial_frame) *
450                                         partial_frame_size);
451
452     RawDVContext *c = s->priv_data;
453     ret = avio_read(s->pb, partial_frame, partial_frame_size);
454     if (ret < 0)
455         goto finish;
456
457     if (ret < partial_frame_size) {
458         ret = -1;
459         goto finish;
460     }
461
462     ret = dv_extract_timecode(c->dv_demux, partial_frame, timecode);
463     if (ret)
464         av_dict_set(&s->metadata, "timecode", timecode, 0);
465     else if (ret < 0)
466         av_log(s, AV_LOG_ERROR, "Detected timecode is invalid");
467
468 finish:
469     av_free(partial_frame);
470     avio_seek(s->pb, pos, SEEK_SET);
471     return ret;
472 }
473
474 static int dv_read_header(AVFormatContext *s)
475 {
476     unsigned state, marker_pos = 0;
477     RawDVContext *c = s->priv_data;
478
479     c->dv_demux = avpriv_dv_init_demux(s);
480     if (!c->dv_demux)
481         return -1;
482
483     state = avio_rb32(s->pb);
484     while ((state & 0xffffff7f) != 0x1f07003f) {
485         if (url_feof(s->pb)) {
486             av_log(s, AV_LOG_ERROR, "Cannot find DV header.\n");
487             return -1;
488         }
489         if (state == 0x003f0700 || state == 0xff3f0700)
490             marker_pos = avio_tell(s->pb);
491         if (state == 0xff3f0701 && avio_tell(s->pb) - marker_pos == 80) {
492             avio_seek(s->pb, -163, SEEK_CUR);
493             state = avio_rb32(s->pb);
494             break;
495         }
496         state = (state << 8) | avio_r8(s->pb);
497     }
498     AV_WB32(c->buf, state);
499
500     if (avio_read(s->pb, c->buf + 4, DV_PROFILE_BYTES - 4) != DV_PROFILE_BYTES - 4 ||
501         avio_seek(s->pb, -DV_PROFILE_BYTES, SEEK_CUR) < 0)
502         return AVERROR(EIO);
503
504     c->dv_demux->sys = avpriv_dv_frame_profile(c->dv_demux->sys, c->buf, DV_PROFILE_BYTES);
505     if (!c->dv_demux->sys) {
506         av_log(s, AV_LOG_ERROR, "Can't determine profile of DV input stream.\n");
507         return -1;
508     }
509
510     s->bit_rate = av_rescale_q(c->dv_demux->sys->frame_size, (AVRational){8,1},
511                                c->dv_demux->sys->time_base);
512
513     if (s->pb->seekable)
514         dv_read_timecode(s);
515
516     return 0;
517 }
518
519
520 static int dv_read_packet(AVFormatContext *s, AVPacket *pkt)
521 {
522     int size;
523     RawDVContext *c = s->priv_data;
524
525     size = avpriv_dv_get_packet(c->dv_demux, pkt);
526
527     if (size < 0) {
528         int64_t pos = avio_tell(s->pb);
529         if (!c->dv_demux->sys)
530             return AVERROR(EIO);
531         size = c->dv_demux->sys->frame_size;
532         if (avio_read(s->pb, c->buf, size) <= 0)
533             return AVERROR(EIO);
534
535         size = avpriv_dv_produce_packet(c->dv_demux, pkt, c->buf, size, pos);
536     }
537
538     return size;
539 }
540
541 static int dv_read_seek(AVFormatContext *s, int stream_index,
542                        int64_t timestamp, int flags)
543 {
544     RawDVContext *r   = s->priv_data;
545     DVDemuxContext *c = r->dv_demux;
546     int64_t offset    = dv_frame_offset(s, c, timestamp, flags);
547
548     if (avio_seek(s->pb, offset, SEEK_SET) < 0)
549         return -1;
550
551     ff_dv_offset_reset(c, offset / c->sys->frame_size);
552     return 0;
553 }
554
555 static int dv_read_close(AVFormatContext *s)
556 {
557     RawDVContext *c = s->priv_data;
558     av_free(c->dv_demux);
559     return 0;
560 }
561
562 static int dv_probe(AVProbeData *p)
563 {
564     unsigned state, marker_pos = 0;
565     int i;
566     int matches = 0;
567     int secondary_matches = 0;
568
569     if (p->buf_size < 5)
570         return 0;
571
572     state = AV_RB32(p->buf);
573     for (i = 4; i < p->buf_size; i++) {
574         if ((state & 0xffffff7f) == 0x1f07003f)
575             matches++;
576         // any section header, also with seq/chan num != 0,
577         // should appear around every 12000 bytes, at least 10 per frame
578         if ((state & 0xff07ff7f) == 0x1f07003f)
579             secondary_matches++;
580         if (state == 0x003f0700 || state == 0xff3f0700)
581             marker_pos = i;
582         if (state == 0xff3f0701 && i - marker_pos == 80)
583             matches++;
584         state = (state << 8) | p->buf[i];
585     }
586
587     if (matches && p->buf_size / matches < 1024*1024) {
588         if (matches > 4 || (secondary_matches >= 10 && p->buf_size / secondary_matches < 24000))
589             return AVPROBE_SCORE_MAX*3/4; // not max to avoid dv in mov to match
590         return AVPROBE_SCORE_MAX/4;
591     }
592     return 0;
593 }
594
595 #if CONFIG_DV_DEMUXER
596 AVInputFormat ff_dv_demuxer = {
597     .name           = "dv",
598     .long_name      = NULL_IF_CONFIG_SMALL("DV (Digital Video)"),
599     .priv_data_size = sizeof(RawDVContext),
600     .read_probe     = dv_probe,
601     .read_header    = dv_read_header,
602     .read_packet    = dv_read_packet,
603     .read_close     = dv_read_close,
604     .read_seek      = dv_read_seek,
605     .extensions     = "dv,dif",
606 };
607 #endif