dv: Do not redundantly initialize struct members to zero.
[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 Libav.
16  *
17  * Libav 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  * Libav 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 Libav; 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/dvdata.h"
35 #include "libavutil/intreadwrite.h"
36 #include "libavutil/mathematics.h"
37 #include "dv.h"
38
39 struct DVDemuxContext {
40     const DVprofile*  sys;    /* Current DV profile. E.g.: 525/60, 625/50 */
41     AVFormatContext*  fctx;
42     AVStream*         vst;
43     AVStream*         ast[4];
44     AVPacket          audio_pkt[4];
45     uint8_t           audio_buf[4][8192];
46     int               ach;
47     int               frames;
48     uint64_t          abytes;
49 };
50
51 static inline uint16_t dv_audio_12to16(uint16_t sample)
52 {
53     uint16_t shift, result;
54
55     sample = (sample < 0x800) ? sample : sample | 0xf000;
56     shift  = (sample & 0xf00) >> 8;
57
58     if (shift < 0x2 || shift > 0xd) {
59         result = sample;
60     } else if (shift < 0x8) {
61         shift--;
62         result = (sample - (256 * shift)) << shift;
63     } else {
64         shift = 0xe - shift;
65         result = ((sample + ((256 * shift) + 1)) << shift) - 1;
66     }
67
68     return result;
69 }
70
71 /*
72  * This is the dumbest implementation of all -- it simply looks at
73  * a fixed offset and if pack isn't there -- fails. We might want
74  * to have a fallback mechanism for complete search of missing packs.
75  */
76 static const uint8_t* dv_extract_pack(uint8_t* frame, enum dv_pack_type t)
77 {
78     int offs;
79
80     switch (t) {
81     case dv_audio_source:
82         offs = (80*6 + 80*16*3 + 3);
83         break;
84     case dv_audio_control:
85         offs = (80*6 + 80*16*4 + 3);
86         break;
87     case dv_video_control:
88         offs = (80*5 + 48 + 5);
89         break;
90     default:
91         return NULL;
92     }
93
94     return frame[offs] == t ? &frame[offs] : NULL;
95 }
96
97 static const int dv_audio_frequency[3] = {
98     48000, 44100, 32000,
99 };
100
101 /*
102  * There's a couple of assumptions being made here:
103  * 1. By default we silence erroneous (0x8000/16bit 0x800/12bit) audio samples.
104  *    We can pass them upwards when libavcodec will be ready to deal with them.
105  * 2. We don't do software emphasis.
106  * 3. Audio is always returned as 16bit linear samples: 12bit nonlinear samples
107  *    are converted into 16bit linear ones.
108  */
109 static int dv_extract_audio(uint8_t* frame, uint8_t* ppcm[4],
110                             const DVprofile *sys)
111 {
112     int size, chan, i, j, d, of, smpls, freq, quant, half_ch;
113     uint16_t lc, rc;
114     const uint8_t* as_pack;
115     uint8_t *pcm, ipcm;
116
117     as_pack = dv_extract_pack(frame, dv_audio_source);
118     if (!as_pack)    /* No audio ? */
119         return 0;
120
121     smpls =  as_pack[1] & 0x3f;       /* samples in this frame - min. samples */
122     freq  = (as_pack[4] >> 3) & 0x07; /* 0 - 48kHz, 1 - 44,1kHz, 2 - 32kHz */
123     quant =  as_pack[4] & 0x07;       /* 0 - 16bit linear, 1 - 12bit nonlinear */
124
125     if (quant > 1)
126         return -1; /* unsupported quantization */
127
128     if (freq >= FF_ARRAY_ELEMS(dv_audio_frequency))
129         return AVERROR_INVALIDDATA;
130
131     size = (sys->audio_min_samples[freq] + smpls) * 4; /* 2ch, 2bytes */
132     half_ch = sys->difseg_size / 2;
133
134     /* We work with 720p frames split in half, thus even frames have
135      * channels 0,1 and odd 2,3. */
136     ipcm = (sys->height == 720 && !(frame[1] & 0x0C)) ? 2 : 0;
137
138     /* for each DIF channel */
139     for (chan = 0; chan < sys->n_difchan; chan++) {
140         /* next stereo channel (50Mbps and 100Mbps only) */
141         pcm = ppcm[ipcm++];
142         if (!pcm)
143             break;
144
145         /* for each DIF segment */
146         for (i = 0; i < sys->difseg_size; i++) {
147             frame += 6 * 80; /* skip DIF segment header */
148             if (quant == 1 && i == half_ch) {
149                 /* next stereo channel (12bit mode only) */
150                 pcm = ppcm[ipcm++];
151                 if (!pcm)
152                     break;
153             }
154
155             /* for each AV sequence */
156             for (j = 0; j < 9; j++) {
157                 for (d = 8; d < 80; d += 2) {
158                     if (quant == 0) {  /* 16bit quantization */
159                         of = sys->audio_shuffle[i][j] + (d - 8) / 2 * sys->audio_stride;
160                         if (of*2 >= size)
161                             continue;
162
163                         pcm[of*2]   = frame[d+1]; // FIXME: maybe we have to admit
164                         pcm[of*2+1] = frame[d];   //        that DV is a big-endian PCM
165                         if (pcm[of*2+1] == 0x80 && pcm[of*2] == 0x00)
166                             pcm[of*2+1] = 0;
167                     } else {           /* 12bit quantization */
168                         lc = ((uint16_t)frame[d]   << 4) |
169                              ((uint16_t)frame[d+2] >> 4);
170                         rc = ((uint16_t)frame[d+1] << 4) |
171                              ((uint16_t)frame[d+2] & 0x0f);
172                         lc = (lc == 0x800 ? 0 : dv_audio_12to16(lc));
173                         rc = (rc == 0x800 ? 0 : dv_audio_12to16(rc));
174
175                         of = sys->audio_shuffle[i%half_ch][j] + (d - 8) / 3 * sys->audio_stride;
176                         if (of*2 >= size)
177                             continue;
178
179                         pcm[of*2]   = lc & 0xff; // FIXME: maybe we have to admit
180                         pcm[of*2+1] = lc >> 8;   //        that DV is a big-endian PCM
181                         of = sys->audio_shuffle[i%half_ch+half_ch][j] +
182                             (d - 8) / 3 * sys->audio_stride;
183                         pcm[of*2]   = rc & 0xff; // FIXME: maybe we have to admit
184                         pcm[of*2+1] = rc >> 8;   //        that DV is a big-endian PCM
185                         ++d;
186                     }
187                 }
188
189                 frame += 16 * 80; /* 15 Video DIFs + 1 Audio DIF */
190             }
191         }
192     }
193
194     return size;
195 }
196
197 static int dv_extract_audio_info(DVDemuxContext* c, uint8_t* frame)
198 {
199     const uint8_t* as_pack;
200     int freq, stype, smpls, quant, i, ach;
201
202     as_pack = dv_extract_pack(frame, dv_audio_source);
203     if (!as_pack || !c->sys) {    /* No audio ? */
204         c->ach = 0;
205         return 0;
206     }
207
208     smpls =  as_pack[1] & 0x3f;       /* samples in this frame - min. samples */
209     freq  = (as_pack[4] >> 3) & 0x07; /* 0 - 48kHz, 1 - 44,1kHz, 2 - 32kHz */
210     stype = (as_pack[3] & 0x1f);      /* 0 - 2CH, 2 - 4CH, 3 - 8CH */
211     quant =  as_pack[4] & 0x07;       /* 0 - 16bit linear, 1 - 12bit nonlinear */
212
213     if (freq >= FF_ARRAY_ELEMS(dv_audio_frequency)) {
214         av_log(c->fctx, AV_LOG_ERROR,
215                "Unrecognized audio sample rate index (%d)\n", freq);
216         return 0;
217     }
218
219     if (stype > 3) {
220         av_log(c->fctx, AV_LOG_ERROR, "stype %d is invalid\n", stype);
221         c->ach = 0;
222         return 0;
223     }
224
225     /* note: ach counts PAIRS of channels (i.e. stereo channels) */
226     ach = ((int[4]){  1,  0,  2,  4})[stype];
227     if (ach == 1 && quant && freq == 2)
228         ach = 2;
229
230     /* Dynamic handling of the audio streams in DV */
231     for (i = 0; i < ach; i++) {
232        if (!c->ast[i]) {
233            c->ast[i] = avformat_new_stream(c->fctx, NULL);
234            if (!c->ast[i])
235                break;
236            avpriv_set_pts_info(c->ast[i], 64, 1, 30000);
237            c->ast[i]->codec->codec_type = AVMEDIA_TYPE_AUDIO;
238            c->ast[i]->codec->codec_id   = CODEC_ID_PCM_S16LE;
239
240            av_init_packet(&c->audio_pkt[i]);
241            c->audio_pkt[i].size         = 0;
242            c->audio_pkt[i].data         = c->audio_buf[i];
243            c->audio_pkt[i].stream_index = c->ast[i]->index;
244            c->audio_pkt[i].flags       |= AV_PKT_FLAG_KEY;
245        }
246        c->ast[i]->codec->sample_rate = dv_audio_frequency[freq];
247        c->ast[i]->codec->channels    = 2;
248        c->ast[i]->codec->bit_rate    = 2 * dv_audio_frequency[freq] * 16;
249        c->ast[i]->start_time         = 0;
250     }
251     c->ach = i;
252
253     return (c->sys->audio_min_samples[freq] + smpls) * 4; /* 2ch, 2bytes */;
254 }
255
256 static int dv_extract_video_info(DVDemuxContext *c, uint8_t* frame)
257 {
258     const uint8_t* vsc_pack;
259     AVCodecContext* avctx;
260     int apt, is16_9;
261     int size = 0;
262
263     if (c->sys) {
264         avctx = c->vst->codec;
265
266         avpriv_set_pts_info(c->vst, 64, c->sys->time_base.num,
267                         c->sys->time_base.den);
268         avctx->time_base= c->sys->time_base;
269         if (!avctx->width){
270             avctx->width = c->sys->width;
271             avctx->height = c->sys->height;
272         }
273         avctx->pix_fmt = c->sys->pix_fmt;
274
275         /* finding out SAR is a little bit messy */
276         vsc_pack = dv_extract_pack(frame, dv_video_control);
277         apt      = frame[4] & 0x07;
278         is16_9   = (vsc_pack && ((vsc_pack[2] & 0x07) == 0x02 ||
279                                 (!apt && (vsc_pack[2] & 0x07) == 0x07)));
280         c->vst->sample_aspect_ratio = c->sys->sar[is16_9];
281         avctx->bit_rate = av_rescale_q(c->sys->frame_size, (AVRational){8,1},
282                                        c->sys->time_base);
283         size = c->sys->frame_size;
284     }
285     return size;
286 }
287
288 /*
289  * The following 3 functions constitute our interface to the world
290  */
291
292 DVDemuxContext* avpriv_dv_init_demux(AVFormatContext *s)
293 {
294     DVDemuxContext *c;
295
296     c = av_mallocz(sizeof(DVDemuxContext));
297     if (!c)
298         return NULL;
299
300     c->vst = avformat_new_stream(s, NULL);
301     if (!c->vst) {
302         av_free(c);
303         return NULL;
304     }
305
306     c->fctx                   = s;
307     c->vst->codec->codec_type = AVMEDIA_TYPE_VIDEO;
308     c->vst->codec->codec_id   = CODEC_ID_DVVIDEO;
309     c->vst->codec->bit_rate   = 25000000;
310     c->vst->start_time        = 0;
311
312     return c;
313 }
314
315 int avpriv_dv_get_packet(DVDemuxContext *c, AVPacket *pkt)
316 {
317     int size = -1;
318     int i;
319
320     for (i = 0; i < c->ach; i++) {
321        if (c->ast[i] && c->audio_pkt[i].size) {
322            *pkt = c->audio_pkt[i];
323            c->audio_pkt[i].size = 0;
324            size = pkt->size;
325            break;
326        }
327     }
328
329     return size;
330 }
331
332 int avpriv_dv_produce_packet(DVDemuxContext *c, AVPacket *pkt,
333                       uint8_t* buf, int buf_size)
334 {
335     int size, i;
336     uint8_t *ppcm[4] = {0};
337
338     if (buf_size < DV_PROFILE_BYTES ||
339         !(c->sys = avpriv_dv_frame_profile(c->sys, buf, buf_size)) ||
340         buf_size < c->sys->frame_size) {
341           return -1;   /* Broken frame, or not enough data */
342     }
343
344     /* Queueing audio packet */
345     /* FIXME: in case of no audio/bad audio we have to do something */
346     size = dv_extract_audio_info(c, buf);
347     for (i = 0; i < c->ach; i++) {
348        c->audio_pkt[i].size = size;
349        c->audio_pkt[i].pts  = c->abytes * 30000*8 / c->ast[i]->codec->bit_rate;
350        ppcm[i] = c->audio_buf[i];
351     }
352     if (c->ach)
353         dv_extract_audio(buf, ppcm, c->sys);
354
355     /* We work with 720p frames split in half, thus even frames have
356      * channels 0,1 and odd 2,3. */
357     if (c->sys->height == 720) {
358         if (buf[1] & 0x0C) {
359             c->audio_pkt[2].size = c->audio_pkt[3].size = 0;
360         } else {
361             c->audio_pkt[0].size = c->audio_pkt[1].size = 0;
362             c->abytes += size;
363         }
364     } else {
365         c->abytes += size;
366     }
367
368     /* Now it's time to return video packet */
369     size = dv_extract_video_info(c, buf);
370     av_init_packet(pkt);
371     pkt->data         = buf;
372     pkt->size         = size;
373     pkt->flags       |= AV_PKT_FLAG_KEY;
374     pkt->stream_index = c->vst->id;
375     pkt->pts          = c->frames;
376
377     c->frames++;
378
379     return size;
380 }
381
382 static int64_t dv_frame_offset(AVFormatContext *s, DVDemuxContext *c,
383                               int64_t timestamp, int flags)
384 {
385     // FIXME: sys may be wrong if last dv_read_packet() failed (buffer is junk)
386     const DVprofile* sys = avpriv_dv_codec_profile(c->vst->codec);
387     int64_t offset;
388     int64_t size = avio_size(s->pb) - s->data_offset;
389     int64_t max_offset = ((size-1) / sys->frame_size) * sys->frame_size;
390
391     offset = sys->frame_size * timestamp;
392
393     if (size >= 0 && offset > max_offset) offset = max_offset;
394     else if (offset < 0) offset = 0;
395
396     return offset + s->data_offset;
397 }
398
399 void ff_dv_offset_reset(DVDemuxContext *c, int64_t frame_offset)
400 {
401     c->frames= frame_offset;
402     if (c->ach)
403         c->abytes= av_rescale_q(c->frames, c->sys->time_base,
404                                 (AVRational){8, c->ast[0]->codec->bit_rate});
405     c->audio_pkt[0].size = c->audio_pkt[1].size = 0;
406     c->audio_pkt[2].size = c->audio_pkt[3].size = 0;
407 }
408
409 /************************************************************
410  * Implementation of the easiest DV storage of all -- raw DV.
411  ************************************************************/
412
413 typedef struct RawDVContext {
414     DVDemuxContext* dv_demux;
415     uint8_t         buf[DV_MAX_FRAME_SIZE];
416 } RawDVContext;
417
418 static int dv_read_header(AVFormatContext *s)
419 {
420     unsigned state, marker_pos = 0;
421     RawDVContext *c = s->priv_data;
422
423     c->dv_demux = avpriv_dv_init_demux(s);
424     if (!c->dv_demux)
425         return -1;
426
427     state = avio_rb32(s->pb);
428     while ((state & 0xffffff7f) != 0x1f07003f) {
429         if (s->pb->eof_reached) {
430             av_log(s, AV_LOG_ERROR, "Cannot find DV header.\n");
431             return -1;
432         }
433         if (state == 0x003f0700 || state == 0xff3f0700)
434             marker_pos = avio_tell(s->pb);
435         if (state == 0xff3f0701 && avio_tell(s->pb) - marker_pos == 80) {
436             avio_seek(s->pb, -163, SEEK_CUR);
437             state = avio_rb32(s->pb);
438             break;
439         }
440         state = (state << 8) | avio_r8(s->pb);
441     }
442     AV_WB32(c->buf, state);
443
444     if (avio_read(s->pb, c->buf + 4, DV_PROFILE_BYTES - 4) <= 0 ||
445         avio_seek(s->pb, -DV_PROFILE_BYTES, SEEK_CUR) < 0)
446         return AVERROR(EIO);
447
448     c->dv_demux->sys = avpriv_dv_frame_profile(c->dv_demux->sys, c->buf, DV_PROFILE_BYTES);
449     if (!c->dv_demux->sys) {
450         av_log(s, AV_LOG_ERROR, "Can't determine profile of DV input stream.\n");
451         return -1;
452     }
453
454     s->bit_rate = av_rescale_q(c->dv_demux->sys->frame_size, (AVRational){8,1},
455                                c->dv_demux->sys->time_base);
456
457     return 0;
458 }
459
460
461 static int dv_read_packet(AVFormatContext *s, AVPacket *pkt)
462 {
463     int size;
464     RawDVContext *c = s->priv_data;
465
466     size = avpriv_dv_get_packet(c->dv_demux, pkt);
467
468     if (size < 0) {
469         if (!c->dv_demux->sys)
470             return AVERROR(EIO);
471         size = c->dv_demux->sys->frame_size;
472         if (avio_read(s->pb, c->buf, size) <= 0)
473             return AVERROR(EIO);
474
475         size = avpriv_dv_produce_packet(c->dv_demux, pkt, c->buf, size);
476     }
477
478     return size;
479 }
480
481 static int dv_read_seek(AVFormatContext *s, int stream_index,
482                        int64_t timestamp, int flags)
483 {
484     RawDVContext *r   = s->priv_data;
485     DVDemuxContext *c = r->dv_demux;
486     int64_t offset    = dv_frame_offset(s, c, timestamp, flags);
487
488     if (avio_seek(s->pb, offset, SEEK_SET) < 0)
489         return -1;
490
491     ff_dv_offset_reset(c, offset / c->sys->frame_size);
492     return 0;
493 }
494
495 static int dv_read_close(AVFormatContext *s)
496 {
497     RawDVContext *c = s->priv_data;
498     av_free(c->dv_demux);
499     return 0;
500 }
501
502 static int dv_probe(AVProbeData *p)
503 {
504     unsigned state, marker_pos = 0;
505     int i;
506     int matches = 0;
507     int secondary_matches = 0;
508
509     if (p->buf_size < 5)
510         return 0;
511
512     state = AV_RB32(p->buf);
513     for (i = 4; i < p->buf_size; i++) {
514         if ((state & 0xffffff7f) == 0x1f07003f)
515             matches++;
516         // any section header, also with seq/chan num != 0,
517         // should appear around every 12000 bytes, at least 10 per frame
518         if ((state & 0xff07ff7f) == 0x1f07003f)
519             secondary_matches++;
520         if (state == 0x003f0700 || state == 0xff3f0700)
521             marker_pos = i;
522         if (state == 0xff3f0701 && i - marker_pos == 80)
523             matches++;
524         state = (state << 8) | p->buf[i];
525     }
526
527     if (matches && p->buf_size / matches < 1024*1024) {
528         if (matches > 4 || (secondary_matches >= 10 && p->buf_size / secondary_matches < 24000))
529             return AVPROBE_SCORE_MAX*3/4; // not max to avoid dv in mov to match
530         return AVPROBE_SCORE_MAX/4;
531     }
532     return 0;
533 }
534
535 #if CONFIG_DV_DEMUXER
536 AVInputFormat ff_dv_demuxer = {
537     .name           = "dv",
538     .long_name      = NULL_IF_CONFIG_SMALL("DV video format"),
539     .priv_data_size = sizeof(RawDVContext),
540     .read_probe     = dv_probe,
541     .read_header    = dv_read_header,
542     .read_packet    = dv_read_packet,
543     .read_close     = dv_read_close,
544     .read_seek      = dv_read_seek,
545     .extensions = "dv,dif",
546 };
547 #endif