dv: add timecode to metadata
[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/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     case dv_timecode:
91         offs = (80*1 + 3 + 3);
92         break;
93     default:
94         return NULL;
95     }
96
97     return frame[offs] == t ? &frame[offs] : NULL;
98 }
99
100 /*
101  * There's a couple of assumptions being made here:
102  * 1. By default we silence erroneous (0x8000/16bit 0x800/12bit) audio samples.
103  *    We can pass them upwards when libavcodec will be ready to deal with them.
104  * 2. We don't do software emphasis.
105  * 3. Audio is always returned as 16bit linear samples: 12bit nonlinear samples
106  *    are converted into 16bit linear ones.
107  */
108 static int dv_extract_audio(uint8_t* frame, uint8_t* ppcm[4],
109                             const DVprofile *sys)
110 {
111     int size, chan, i, j, d, of, smpls, freq, quant, half_ch;
112     uint16_t lc, rc;
113     const uint8_t* as_pack;
114     uint8_t *pcm, ipcm;
115
116     as_pack = dv_extract_pack(frame, dv_audio_source);
117     if (!as_pack)    /* No audio ? */
118         return 0;
119
120     smpls =  as_pack[1] & 0x3f;       /* samples in this frame - min. samples */
121     freq  = (as_pack[4] >> 3) & 0x07; /* 0 - 48kHz, 1 - 44,1kHz, 2 - 32kHz */
122     quant =  as_pack[4] & 0x07;       /* 0 - 16bit linear, 1 - 12bit nonlinear */
123
124     if (quant > 1)
125         return -1; /* unsupported quantization */
126
127     size = (sys->audio_min_samples[freq] + smpls) * 4; /* 2ch, 2bytes */
128     half_ch = sys->difseg_size / 2;
129
130     /* We work with 720p frames split in half, thus even frames have
131      * channels 0,1 and odd 2,3. */
132     ipcm = (sys->height == 720 && !(frame[1] & 0x0C)) ? 2 : 0;
133     pcm  = ppcm[ipcm++];
134
135     /* for each DIF channel */
136     for (chan = 0; chan < sys->n_difchan; chan++) {
137         /* for each DIF segment */
138         for (i = 0; i < sys->difseg_size; i++) {
139             frame += 6 * 80; /* skip DIF segment header */
140             if (quant == 1 && i == half_ch) {
141                 /* next stereo channel (12bit mode only) */
142                 pcm = ppcm[ipcm++];
143                 if (!pcm)
144                     break;
145             }
146
147             /* for each AV sequence */
148             for (j = 0; j < 9; j++) {
149                 for (d = 8; d < 80; d += 2) {
150                     if (quant == 0) {  /* 16bit quantization */
151                         of = sys->audio_shuffle[i][j] + (d - 8) / 2 * sys->audio_stride;
152                         if (of*2 >= size)
153                             continue;
154
155                         pcm[of*2]   = frame[d+1]; // FIXME: maybe we have to admit
156                         pcm[of*2+1] = frame[d];   //        that DV is a big-endian PCM
157                         if (pcm[of*2+1] == 0x80 && pcm[of*2] == 0x00)
158                             pcm[of*2+1] = 0;
159                     } else {           /* 12bit quantization */
160                         lc = ((uint16_t)frame[d]   << 4) |
161                              ((uint16_t)frame[d+2] >> 4);
162                         rc = ((uint16_t)frame[d+1] << 4) |
163                              ((uint16_t)frame[d+2] & 0x0f);
164                         lc = (lc == 0x800 ? 0 : dv_audio_12to16(lc));
165                         rc = (rc == 0x800 ? 0 : dv_audio_12to16(rc));
166
167                         of = sys->audio_shuffle[i%half_ch][j] + (d - 8) / 3 * sys->audio_stride;
168                         if (of*2 >= size)
169                             continue;
170
171                         pcm[of*2]   = lc & 0xff; // FIXME: maybe we have to admit
172                         pcm[of*2+1] = lc >> 8;   //        that DV is a big-endian PCM
173                         of = sys->audio_shuffle[i%half_ch+half_ch][j] +
174                             (d - 8) / 3 * sys->audio_stride;
175                         pcm[of*2]   = rc & 0xff; // FIXME: maybe we have to admit
176                         pcm[of*2+1] = rc >> 8;   //        that DV is a big-endian PCM
177                         ++d;
178                     }
179                 }
180
181                 frame += 16 * 80; /* 15 Video DIFs + 1 Audio DIF */
182             }
183         }
184
185         /* next stereo channel (50Mbps and 100Mbps only) */
186         pcm = ppcm[ipcm++];
187         if (!pcm)
188             break;
189     }
190
191     return size;
192 }
193
194 static int dv_extract_audio_info(DVDemuxContext* c, uint8_t* frame)
195 {
196     const uint8_t* as_pack;
197     int freq, stype, smpls, quant, i, ach;
198
199     as_pack = dv_extract_pack(frame, dv_audio_source);
200     if (!as_pack || !c->sys) {    /* No audio ? */
201         c->ach = 0;
202         return 0;
203     }
204
205     smpls =  as_pack[1] & 0x3f;       /* samples in this frame - min. samples */
206     freq  = (as_pack[4] >> 3) & 0x07; /* 0 - 48kHz, 1 - 44,1kHz, 2 - 32kHz */
207     stype = (as_pack[3] & 0x1f);      /* 0 - 2CH, 2 - 4CH, 3 - 8CH */
208     quant =  as_pack[4] & 0x07;       /* 0 - 16bit linear, 1 - 12bit nonlinear */
209
210     /* note: ach counts PAIRS of channels (i.e. stereo channels) */
211     ach = ((int[4]){  1,  0,  2,  4})[stype];
212     if (ach == 1 && quant && freq == 2)
213         ach = 2;
214
215     /* Dynamic handling of the audio streams in DV */
216     for (i = 0; i < ach; i++) {
217        if (!c->ast[i]) {
218            c->ast[i] = avformat_new_stream(c->fctx, NULL);
219            if (!c->ast[i])
220                break;
221            avpriv_set_pts_info(c->ast[i], 64, 1, 30000);
222            c->ast[i]->codec->codec_type = AVMEDIA_TYPE_AUDIO;
223            c->ast[i]->codec->codec_id   = CODEC_ID_PCM_S16LE;
224
225            av_init_packet(&c->audio_pkt[i]);
226            c->audio_pkt[i].size         = 0;
227            c->audio_pkt[i].data         = c->audio_buf[i];
228            c->audio_pkt[i].stream_index = c->ast[i]->index;
229            c->audio_pkt[i].flags       |= AV_PKT_FLAG_KEY;
230        }
231        c->ast[i]->codec->sample_rate = dv_audio_frequency[freq];
232        c->ast[i]->codec->channels    = 2;
233        c->ast[i]->codec->bit_rate    = 2 * dv_audio_frequency[freq] * 16;
234        c->ast[i]->start_time         = 0;
235     }
236     c->ach = i;
237
238     return (c->sys->audio_min_samples[freq] + smpls) * 4; /* 2ch, 2bytes */;
239 }
240
241 static int dv_extract_video_info(DVDemuxContext *c, uint8_t* frame)
242 {
243     const uint8_t* vsc_pack;
244     AVCodecContext* avctx;
245     int apt, is16_9;
246     int size = 0;
247
248     if (c->sys) {
249         avctx = c->vst->codec;
250
251         avpriv_set_pts_info(c->vst, 64, c->sys->time_base.num,
252                         c->sys->time_base.den);
253         avctx->time_base= c->sys->time_base;
254         if (!avctx->width){
255             avctx->width = c->sys->width;
256             avctx->height = c->sys->height;
257         }
258         avctx->pix_fmt = c->sys->pix_fmt;
259
260         /* finding out SAR is a little bit messy */
261         vsc_pack = dv_extract_pack(frame, dv_video_control);
262         apt      = frame[4] & 0x07;
263         is16_9   = (vsc_pack && ((vsc_pack[2] & 0x07) == 0x02 ||
264                                 (!apt && (vsc_pack[2] & 0x07) == 0x07)));
265         c->vst->sample_aspect_ratio = c->sys->sar[is16_9];
266         avctx->bit_rate = av_rescale_q(c->sys->frame_size, (AVRational){8,1},
267                                        c->sys->time_base);
268         size = c->sys->frame_size;
269     }
270     return size;
271 }
272
273 static int bcd2int(uint8_t bcd)
274 {
275    int low  = bcd & 0xf;
276    int high = bcd >> 4;
277    if (low > 9 || high > 9)
278        return -1;
279    return low + 10*high;
280 }
281
282 static int dv_extract_timecode(DVDemuxContext* c, uint8_t* frame, char tc[32])
283 {
284     int hh, mm, ss, ff, drop_frame;
285     const uint8_t *tc_pack;
286
287     tc_pack = dv_extract_pack(frame, dv_timecode);
288     if (!tc_pack)
289         return 0;
290
291     ff = bcd2int(tc_pack[1] & 0x3f);
292     ss = bcd2int(tc_pack[2] & 0x7f);
293     mm = bcd2int(tc_pack[3] & 0x7f);
294     hh = bcd2int(tc_pack[4] & 0x3f);
295     drop_frame = tc_pack[1] >> 6 & 0x1;
296
297     if (ff < 0 || ss < 0 || mm < 0 || hh < 0)
298         return -1;
299
300     // For PAL systems, drop frame bit is replaced by an arbitrary
301     // bit so its value should not be considered. Drop frame timecode
302     // is only relevant for NTSC systems.
303     if(c->sys->ltc_divisor == 25 || c->sys->ltc_divisor == 50) {
304         drop_frame = 0;
305     }
306
307     snprintf(tc, 32, "%02d:%02d:%02d%c%02d",
308              hh, mm, ss, drop_frame ? ';' : ':', ff);
309     return 1;
310 }
311
312 /*
313  * The following 3 functions constitute our interface to the world
314  */
315
316 DVDemuxContext* avpriv_dv_init_demux(AVFormatContext *s)
317 {
318     DVDemuxContext *c;
319
320     c = av_mallocz(sizeof(DVDemuxContext));
321     if (!c)
322         return NULL;
323
324     c->vst = avformat_new_stream(s, NULL);
325     if (!c->vst) {
326         av_free(c);
327         return NULL;
328     }
329
330     c->sys  = NULL;
331     c->fctx = s;
332     memset(c->ast, 0, sizeof(c->ast));
333     c->ach    = 0;
334     c->frames = 0;
335     c->abytes = 0;
336
337     c->vst->codec->codec_type = AVMEDIA_TYPE_VIDEO;
338     c->vst->codec->codec_id   = CODEC_ID_DVVIDEO;
339     c->vst->codec->bit_rate   = 25000000;
340     c->vst->start_time        = 0;
341
342     return c;
343 }
344
345 int avpriv_dv_get_packet(DVDemuxContext *c, AVPacket *pkt)
346 {
347     int size = -1;
348     int i;
349
350     for (i = 0; i < c->ach; i++) {
351        if (c->ast[i] && c->audio_pkt[i].size) {
352            *pkt = c->audio_pkt[i];
353            c->audio_pkt[i].size = 0;
354            size = pkt->size;
355            break;
356        }
357     }
358
359     return size;
360 }
361
362 int avpriv_dv_produce_packet(DVDemuxContext *c, AVPacket *pkt,
363                       uint8_t* buf, int buf_size, int64_t pos)
364 {
365     int size, i;
366     uint8_t *ppcm[4] = {0};
367
368     if (buf_size < DV_PROFILE_BYTES ||
369         !(c->sys = avpriv_dv_frame_profile(c->sys, buf, buf_size)) ||
370         buf_size < c->sys->frame_size) {
371           return -1;   /* Broken frame, or not enough data */
372     }
373
374     /* Queueing audio packet */
375     /* FIXME: in case of no audio/bad audio we have to do something */
376     size = dv_extract_audio_info(c, buf);
377     for (i = 0; i < c->ach; i++) {
378        c->audio_pkt[i].pos  = pos;
379        c->audio_pkt[i].size = size;
380        c->audio_pkt[i].pts  = c->abytes * 30000*8 / c->ast[i]->codec->bit_rate;
381        ppcm[i] = c->audio_buf[i];
382     }
383     dv_extract_audio(buf, ppcm, c->sys);
384
385     /* We work with 720p frames split in half, thus even frames have
386      * channels 0,1 and odd 2,3. */
387     if (c->sys->height == 720) {
388         if (buf[1] & 0x0C) {
389             c->audio_pkt[2].size = c->audio_pkt[3].size = 0;
390         } else {
391             c->audio_pkt[0].size = c->audio_pkt[1].size = 0;
392             c->abytes += size;
393         }
394     } else {
395         c->abytes += size;
396     }
397
398     /* Now it's time to return video packet */
399     size = dv_extract_video_info(c, buf);
400     av_init_packet(pkt);
401     pkt->data         = buf;
402     pkt->pos          = pos;
403     pkt->size         = size;
404     pkt->flags       |= AV_PKT_FLAG_KEY;
405     pkt->stream_index = c->vst->id;
406     pkt->pts          = c->frames;
407
408     c->frames++;
409
410     return size;
411 }
412
413 static int64_t dv_frame_offset(AVFormatContext *s, DVDemuxContext *c,
414                               int64_t timestamp, int flags)
415 {
416     // FIXME: sys may be wrong if last dv_read_packet() failed (buffer is junk)
417     const DVprofile* sys = avpriv_dv_codec_profile(c->vst->codec);
418     int64_t offset;
419     int64_t size = avio_size(s->pb) - s->data_offset;
420     int64_t max_offset = ((size-1) / sys->frame_size) * sys->frame_size;
421
422     offset = sys->frame_size * timestamp;
423
424     if (size >= 0 && offset > max_offset) offset = max_offset;
425     else if (offset < 0) offset = 0;
426
427     return offset + s->data_offset;
428 }
429
430 void dv_offset_reset(DVDemuxContext *c, int64_t frame_offset)
431 {
432     c->frames= frame_offset;
433     if (c->ach)
434         c->abytes= av_rescale_q(c->frames, c->sys->time_base,
435                                 (AVRational){8, c->ast[0]->codec->bit_rate});
436     c->audio_pkt[0].size = c->audio_pkt[1].size = 0;
437     c->audio_pkt[2].size = c->audio_pkt[3].size = 0;
438 }
439
440 /************************************************************
441  * Implementation of the easiest DV storage of all -- raw DV.
442  ************************************************************/
443
444 typedef struct RawDVContext {
445     DVDemuxContext* dv_demux;
446     uint8_t         buf[DV_MAX_FRAME_SIZE];
447 } RawDVContext;
448
449 static int dv_read_timecode(AVFormatContext *s) {
450     int ret;
451     char timecode[32];
452     int64_t pos = avio_tell(s->pb);
453
454     // Read 3 DIF blocks: Header block and 2 Subcode blocks.
455     int partial_frame_size = 3 * 80;
456     uint8_t *partial_frame = av_mallocz(sizeof(*partial_frame) *
457                                         partial_frame_size);
458
459     RawDVContext *c = s->priv_data;
460     ret = avio_read(s->pb, partial_frame, partial_frame_size);
461     if (ret < 0)
462         goto finish;
463
464     if (ret < partial_frame_size) {
465         ret = -1;
466         goto finish;
467     }
468
469     ret = dv_extract_timecode(c->dv_demux, partial_frame, timecode);
470     if (ret)
471         av_dict_set(&s->metadata, "timecode", timecode, 0);
472     else if (ret < 0)
473         av_log(s, AV_LOG_ERROR, "Detected timecode is invalid");
474
475 finish:
476     av_free(partial_frame);
477     avio_seek(s->pb, pos, SEEK_SET);
478     return ret;
479 }
480
481 static int dv_read_header(AVFormatContext *s,
482                           AVFormatParameters *ap)
483 {
484     unsigned state, marker_pos = 0;
485     RawDVContext *c = s->priv_data;
486
487     c->dv_demux = avpriv_dv_init_demux(s);
488     if (!c->dv_demux)
489         return -1;
490
491     state = avio_rb32(s->pb);
492     while ((state & 0xffffff7f) != 0x1f07003f) {
493         if (url_feof(s->pb)) {
494             av_log(s, AV_LOG_ERROR, "Cannot find DV header.\n");
495             return -1;
496         }
497         if (state == 0x003f0700 || state == 0xff3f0700)
498             marker_pos = avio_tell(s->pb);
499         if (state == 0xff3f0701 && avio_tell(s->pb) - marker_pos == 80) {
500             avio_seek(s->pb, -163, SEEK_CUR);
501             state = avio_rb32(s->pb);
502             break;
503         }
504         state = (state << 8) | avio_r8(s->pb);
505     }
506     AV_WB32(c->buf, state);
507
508     if (avio_read(s->pb, c->buf + 4, DV_PROFILE_BYTES - 4) <= 0 ||
509         avio_seek(s->pb, -DV_PROFILE_BYTES, SEEK_CUR) < 0)
510         return AVERROR(EIO);
511
512     c->dv_demux->sys = avpriv_dv_frame_profile(c->dv_demux->sys, c->buf, DV_PROFILE_BYTES);
513     if (!c->dv_demux->sys) {
514         av_log(s, AV_LOG_ERROR, "Can't determine profile of DV input stream.\n");
515         return -1;
516     }
517
518     s->bit_rate = av_rescale_q(c->dv_demux->sys->frame_size, (AVRational){8,1},
519                                c->dv_demux->sys->time_base);
520
521     if (s->pb->seekable)
522         dv_read_timecode(s);
523
524     return 0;
525 }
526
527
528 static int dv_read_packet(AVFormatContext *s, AVPacket *pkt)
529 {
530     int size;
531     RawDVContext *c = s->priv_data;
532
533     size = avpriv_dv_get_packet(c->dv_demux, pkt);
534
535     if (size < 0) {
536         int64_t pos = avio_tell(s->pb);
537         if (!c->dv_demux->sys)
538             return AVERROR(EIO);
539         size = c->dv_demux->sys->frame_size;
540         if (avio_read(s->pb, c->buf, size) <= 0)
541             return AVERROR(EIO);
542
543         size = avpriv_dv_produce_packet(c->dv_demux, pkt, c->buf, size, pos);
544     }
545
546     return size;
547 }
548
549 static int dv_read_seek(AVFormatContext *s, int stream_index,
550                        int64_t timestamp, int flags)
551 {
552     RawDVContext *r   = s->priv_data;
553     DVDemuxContext *c = r->dv_demux;
554     int64_t offset    = dv_frame_offset(s, c, timestamp, flags);
555
556     if (avio_seek(s->pb, offset, SEEK_SET) < 0)
557         return -1;
558
559     dv_offset_reset(c, offset / c->sys->frame_size);
560     return 0;
561 }
562
563 static int dv_read_close(AVFormatContext *s)
564 {
565     RawDVContext *c = s->priv_data;
566     av_free(c->dv_demux);
567     return 0;
568 }
569
570 static int dv_probe(AVProbeData *p)
571 {
572     unsigned state, marker_pos = 0;
573     int i;
574     int matches = 0;
575     int secondary_matches = 0;
576
577     if (p->buf_size < 5)
578         return 0;
579
580     state = AV_RB32(p->buf);
581     for (i = 4; i < p->buf_size; i++) {
582         if ((state & 0xffffff7f) == 0x1f07003f)
583             matches++;
584         // any section header, also with seq/chan num != 0,
585         // should appear around every 12000 bytes, at least 10 per frame
586         if ((state & 0xff07ff7f) == 0x1f07003f)
587             secondary_matches++;
588         if (state == 0x003f0700 || state == 0xff3f0700)
589             marker_pos = i;
590         if (state == 0xff3f0701 && i - marker_pos == 80)
591             matches++;
592         state = (state << 8) | p->buf[i];
593     }
594
595     if (matches && p->buf_size / matches < 1024*1024) {
596         if (matches > 4 || (secondary_matches >= 10 && p->buf_size / secondary_matches < 24000))
597             return AVPROBE_SCORE_MAX*3/4; // not max to avoid dv in mov to match
598         return AVPROBE_SCORE_MAX/4;
599     }
600     return 0;
601 }
602
603 #if CONFIG_DV_DEMUXER
604 AVInputFormat ff_dv_demuxer = {
605     .name           = "dv",
606     .long_name      = NULL_IF_CONFIG_SMALL("DV video format"),
607     .priv_data_size = sizeof(RawDVContext),
608     .read_probe     = dv_probe,
609     .read_header    = dv_read_header,
610     .read_packet    = dv_read_packet,
611     .read_close     = dv_read_close,
612     .read_seek      = dv_read_seek,
613     .extensions = "dv,dif",
614 };
615 #endif