dv: Split profile handling code into a separate file.
[ffmpeg.git] / libavformat / dvenc.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) support
12  * Copyright (c) 2006 Daniel Maas <dmaas@maasdigital.com>
13  *
14  * This file is part of Libav.
15  *
16  * Libav is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  *
21  * Libav is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  *
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with Libav; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30 #include <time.h>
31 #include <stdarg.h>
32
33 #include "avformat.h"
34 #include "internal.h"
35 #include "libavcodec/dv_profile.h"
36 #include "libavcodec/dvdata.h"
37 #include "dv.h"
38 #include "libavutil/fifo.h"
39 #include "libavutil/mathematics.h"
40
41 struct DVMuxContext {
42     const DVprofile*  sys;           /* current DV profile, e.g.: 525/60, 625/50 */
43     int               n_ast;         /* number of stereo audio streams (up to 2) */
44     AVStream         *ast[2];        /* stereo audio streams */
45     AVFifoBuffer     *audio_data[2]; /* FIFO for storing excessive amounts of PCM */
46     int               frames;        /* current frame number */
47     int64_t           start_time;    /* recording start time */
48     int               has_audio;     /* frame under contruction has audio */
49     int               has_video;     /* frame under contruction has video */
50     uint8_t           frame_buf[DV_MAX_FRAME_SIZE]; /* frame under contruction */
51 };
52
53 static const int dv_aaux_packs_dist[12][9] = {
54     { 0xff, 0xff, 0xff, 0x50, 0x51, 0x52, 0x53, 0xff, 0xff },
55     { 0x50, 0x51, 0x52, 0x53, 0xff, 0xff, 0xff, 0xff, 0xff },
56     { 0xff, 0xff, 0xff, 0x50, 0x51, 0x52, 0x53, 0xff, 0xff },
57     { 0x50, 0x51, 0x52, 0x53, 0xff, 0xff, 0xff, 0xff, 0xff },
58     { 0xff, 0xff, 0xff, 0x50, 0x51, 0x52, 0x53, 0xff, 0xff },
59     { 0x50, 0x51, 0x52, 0x53, 0xff, 0xff, 0xff, 0xff, 0xff },
60     { 0xff, 0xff, 0xff, 0x50, 0x51, 0x52, 0x53, 0xff, 0xff },
61     { 0x50, 0x51, 0x52, 0x53, 0xff, 0xff, 0xff, 0xff, 0xff },
62     { 0xff, 0xff, 0xff, 0x50, 0x51, 0x52, 0x53, 0xff, 0xff },
63     { 0x50, 0x51, 0x52, 0x53, 0xff, 0xff, 0xff, 0xff, 0xff },
64     { 0xff, 0xff, 0xff, 0x50, 0x51, 0x52, 0x53, 0xff, 0xff },
65     { 0x50, 0x51, 0x52, 0x53, 0xff, 0xff, 0xff, 0xff, 0xff },
66 };
67
68 static int dv_audio_frame_size(const DVprofile* sys, int frame)
69 {
70     return sys->audio_samples_dist[frame % (sizeof(sys->audio_samples_dist) /
71                                             sizeof(sys->audio_samples_dist[0]))];
72 }
73
74 static int dv_write_pack(enum dv_pack_type pack_id, DVMuxContext *c, uint8_t* buf, ...)
75 {
76     struct tm tc;
77     time_t ct;
78     int ltc_frame;
79     va_list ap;
80
81     buf[0] = (uint8_t)pack_id;
82     switch (pack_id) {
83     case dv_timecode:
84         ct = (time_t)av_rescale_rnd(c->frames, c->sys->time_base.num,
85                                     c->sys->time_base.den, AV_ROUND_DOWN);
86         ff_brktimegm(ct, &tc);
87         /*
88          * LTC drop-frame frame counter drops two frames (0 and 1) every
89          * minute, unless it is exactly divisible by 10
90          */
91         ltc_frame = (c->frames + 2 * ct / 60 - 2 * ct / 600) % c->sys->ltc_divisor;
92         buf[1] = (0                 << 7) | /* color frame: 0 - unsync; 1 - sync mode */
93                  (1                 << 6) | /* drop frame timecode: 0 - nondrop; 1 - drop */
94                  ((ltc_frame / 10)  << 4) | /* tens of frames */
95                  (ltc_frame % 10);          /* units of frames */
96         buf[2] = (1                 << 7) | /* biphase mark polarity correction: 0 - even; 1 - odd */
97                  ((tc.tm_sec / 10)  << 4) | /* tens of seconds */
98                  (tc.tm_sec % 10);          /* units of seconds */
99         buf[3] = (1                 << 7) | /* binary group flag BGF0 */
100                  ((tc.tm_min / 10)  << 4) | /* tens of minutes */
101                  (tc.tm_min % 10);          /* units of minutes */
102         buf[4] = (1                 << 7) | /* binary group flag BGF2 */
103                  (1                 << 6) | /* binary group flag BGF1 */
104                  ((tc.tm_hour / 10) << 4) | /* tens of hours */
105                  (tc.tm_hour % 10);         /* units of hours */
106         break;
107     case dv_audio_source:  /* AAUX source pack */
108         va_start(ap, buf);
109         buf[1] = (1 << 7) | /* locked mode -- SMPTE only supports locked mode */
110                  (1 << 6) | /* reserved -- always 1 */
111                  (dv_audio_frame_size(c->sys, c->frames) -
112                   c->sys->audio_min_samples[0]);
113                             /* # of samples      */
114         buf[2] = (0 << 7) | /* multi-stereo      */
115                  (0 << 5) | /* #of audio channels per block: 0 -- 1 channel */
116                  (0 << 4) | /* pair bit: 0 -- one pair of channels */
117                  !!va_arg(ap, int); /* audio mode        */
118         buf[3] = (1 << 7) | /* res               */
119                  (1 << 6) | /* multi-language flag */
120                  (c->sys->dsf << 5) | /*  system: 60fields/50fields */
121                  (c->sys->n_difchan & 2); /* definition: 0 -- 25Mbps, 2 -- 50Mbps */
122         buf[4] = (1 << 7) | /* emphasis: 1 -- off */
123                  (0 << 6) | /* emphasis time constant: 0 -- reserved */
124                  (0 << 3) | /* frequency: 0 -- 48kHz, 1 -- 44,1kHz, 2 -- 32kHz */
125                   0;        /* quantization: 0 -- 16bit linear, 1 -- 12bit nonlinear */
126         va_end(ap);
127         break;
128     case dv_audio_control:
129         buf[1] = (0 << 6) | /* copy protection: 0 -- unrestricted */
130                  (1 << 4) | /* input source: 1 -- digital input */
131                  (3 << 2) | /* compression: 3 -- no information */
132                   0;        /* misc. info/SMPTE emphasis off */
133         buf[2] = (1 << 7) | /* recording start point: 1 -- no */
134                  (1 << 6) | /* recording end point: 1 -- no */
135                  (1 << 3) | /* recording mode: 1 -- original */
136                   7;
137         buf[3] = (1 << 7) | /* direction: 1 -- forward */
138                  (c->sys->pix_fmt == PIX_FMT_YUV420P ? 0x20 : /* speed */
139                                                        c->sys->ltc_divisor * 4);
140         buf[4] = (1 << 7) | /* reserved -- always 1 */
141                   0x7f;     /* genre category */
142         break;
143     case dv_audio_recdate:
144     case dv_video_recdate:  /* VAUX recording date */
145         ct = c->start_time + av_rescale_rnd(c->frames, c->sys->time_base.num,
146                                             c->sys->time_base.den, AV_ROUND_DOWN);
147         ff_brktimegm(ct, &tc);
148         buf[1] = 0xff; /* ds, tm, tens of time zone, units of time zone */
149                        /* 0xff is very likely to be "unknown" */
150         buf[2] = (3 << 6) | /* reserved -- always 1 */
151                  ((tc.tm_mday / 10) << 4) | /* Tens of day */
152                  (tc.tm_mday % 10);         /* Units of day */
153         buf[3] = /* we set high 4 bits to 0, shouldn't we set them to week? */
154                  ((tc.tm_mon / 10) << 4) |    /* Tens of month */
155                  (tc.tm_mon  % 10);           /* Units of month */
156         buf[4] = (((tc.tm_year % 100) / 10) << 4) | /* Tens of year */
157                  (tc.tm_year % 10);                 /* Units of year */
158         break;
159     case dv_audio_rectime:  /* AAUX recording time */
160     case dv_video_rectime:  /* VAUX recording time */
161         ct = c->start_time + av_rescale_rnd(c->frames, c->sys->time_base.num,
162                                                        c->sys->time_base.den, AV_ROUND_DOWN);
163         ff_brktimegm(ct, &tc);
164         buf[1] = (3 << 6) | /* reserved -- always 1 */
165                  0x3f; /* tens of frame, units of frame: 0x3f - "unknown" ? */
166         buf[2] = (1 << 7) | /* reserved -- always 1 */
167                  ((tc.tm_sec / 10) << 4) | /* Tens of seconds */
168                  (tc.tm_sec % 10);         /* Units of seconds */
169         buf[3] = (1 << 7) | /* reserved -- always 1 */
170                  ((tc.tm_min / 10) << 4) | /* Tens of minutes */
171                  (tc.tm_min % 10);         /* Units of minutes */
172         buf[4] = (3 << 6) | /* reserved -- always 1 */
173                  ((tc.tm_hour / 10) << 4) | /* Tens of hours */
174                  (tc.tm_hour % 10);         /* Units of hours */
175         break;
176     default:
177         buf[1] = buf[2] = buf[3] = buf[4] = 0xff;
178     }
179     return 5;
180 }
181
182 static void dv_inject_audio(DVMuxContext *c, int channel, uint8_t* frame_ptr)
183 {
184     int i, j, d, of, size;
185     size = 4 * dv_audio_frame_size(c->sys, c->frames);
186     frame_ptr += channel * c->sys->difseg_size * 150 * 80;
187     for (i = 0; i < c->sys->difseg_size; i++) {
188         frame_ptr += 6 * 80; /* skip DIF segment header */
189         for (j = 0; j < 9; j++) {
190             dv_write_pack(dv_aaux_packs_dist[i][j], c, &frame_ptr[3], i >= c->sys->difseg_size/2);
191             for (d = 8; d < 80; d+=2) {
192                 of = c->sys->audio_shuffle[i][j] + (d - 8)/2 * c->sys->audio_stride;
193                 if (of*2 >= size)
194                     continue;
195
196                 frame_ptr[d]   = *av_fifo_peek2(c->audio_data[channel], of*2+1); // FIXME: maybe we have to admit
197                 frame_ptr[d+1] = *av_fifo_peek2(c->audio_data[channel], of*2);   //        that DV is a big-endian PCM
198             }
199             frame_ptr += 16 * 80; /* 15 Video DIFs + 1 Audio DIF */
200         }
201     }
202 }
203
204 static void dv_inject_metadata(DVMuxContext *c, uint8_t* frame)
205 {
206     int j, k;
207     uint8_t* buf;
208
209     for (buf = frame; buf < frame + c->sys->frame_size; buf += 150 * 80) {
210         /* DV subcode: 2nd and 3d DIFs */
211         for (j = 80; j < 80 * 3; j += 80) {
212             for (k = 6; k < 6 * 8; k += 8)
213                 dv_write_pack(dv_timecode, c, &buf[j+k]);
214
215             if (((long)(buf-frame)/(c->sys->frame_size/(c->sys->difseg_size*c->sys->n_difchan))%c->sys->difseg_size) > 5) { /* FIXME: is this really needed ? */
216                 dv_write_pack(dv_video_recdate, c, &buf[j+14]);
217                 dv_write_pack(dv_video_rectime, c, &buf[j+22]);
218                 dv_write_pack(dv_video_recdate, c, &buf[j+38]);
219                 dv_write_pack(dv_video_rectime, c, &buf[j+46]);
220             }
221         }
222
223         /* DV VAUX: 4th, 5th and 6th 3DIFs */
224         for (j = 80*3 + 3; j < 80*6; j += 80) {
225             dv_write_pack(dv_video_recdate, c, &buf[j+5*2]);
226             dv_write_pack(dv_video_rectime, c, &buf[j+5*3]);
227             dv_write_pack(dv_video_recdate, c, &buf[j+5*11]);
228             dv_write_pack(dv_video_rectime, c, &buf[j+5*12]);
229         }
230     }
231 }
232
233 /*
234  * The following 3 functions constitute our interface to the world
235  */
236
237 static int dv_assemble_frame(DVMuxContext *c, AVStream* st,
238                              uint8_t* data, int data_size, uint8_t** frame)
239 {
240     int i, reqasize;
241
242     *frame = &c->frame_buf[0];
243     reqasize = 4 * dv_audio_frame_size(c->sys, c->frames);
244
245     switch (st->codec->codec_type) {
246     case AVMEDIA_TYPE_VIDEO:
247         /* FIXME: we have to have more sensible approach than this one */
248         if (c->has_video)
249             av_log(st->codec, AV_LOG_ERROR, "Can't process DV frame #%d. Insufficient audio data or severe sync problem.\n", c->frames);
250
251         memcpy(*frame, data, c->sys->frame_size);
252         c->has_video = 1;
253         break;
254     case AVMEDIA_TYPE_AUDIO:
255         for (i = 0; i < c->n_ast && st != c->ast[i]; i++);
256
257           /* FIXME: we have to have more sensible approach than this one */
258         if (av_fifo_size(c->audio_data[i]) + data_size >= 100*AVCODEC_MAX_AUDIO_FRAME_SIZE)
259             av_log(st->codec, AV_LOG_ERROR, "Can't process DV frame #%d. Insufficient video data or severe sync problem.\n", c->frames);
260         av_fifo_generic_write(c->audio_data[i], data, data_size, NULL);
261
262         /* Let us see if we've got enough audio for one DV frame. */
263         c->has_audio |= ((reqasize <= av_fifo_size(c->audio_data[i])) << i);
264
265         break;
266     default:
267         break;
268     }
269
270     /* Let us see if we have enough data to construct one DV frame. */
271     if (c->has_video == 1 && c->has_audio + 1 == 1 << c->n_ast) {
272         dv_inject_metadata(c, *frame);
273         c->has_audio = 0;
274         for (i=0; i < c->n_ast; i++) {
275             dv_inject_audio(c, i, *frame);
276             av_fifo_drain(c->audio_data[i], reqasize);
277             c->has_audio |= ((reqasize <= av_fifo_size(c->audio_data[i])) << i);
278         }
279
280         c->has_video = 0;
281
282         c->frames++;
283
284         return c->sys->frame_size;
285     }
286
287     return 0;
288 }
289
290 static DVMuxContext* dv_init_mux(AVFormatContext* s)
291 {
292     DVMuxContext *c = s->priv_data;
293     AVStream *vst = NULL;
294     AVDictionaryEntry *t;
295     int i;
296
297     /* we support at most 1 video and 2 audio streams */
298     if (s->nb_streams > 3)
299         return NULL;
300
301     c->n_ast  = 0;
302     c->ast[0] = c->ast[1] = NULL;
303
304     /* We have to sort out where audio and where video stream is */
305     for (i=0; i<s->nb_streams; i++) {
306         switch (s->streams[i]->codec->codec_type) {
307         case AVMEDIA_TYPE_VIDEO:
308             if (vst) return NULL;
309             vst = s->streams[i];
310             break;
311         case AVMEDIA_TYPE_AUDIO:
312             if (c->n_ast > 1) return NULL;
313             c->ast[c->n_ast++] = s->streams[i];
314             break;
315         default:
316             goto bail_out;
317         }
318     }
319
320     /* Some checks -- DV format is very picky about its incoming streams */
321     if (!vst || vst->codec->codec_id != CODEC_ID_DVVIDEO)
322         goto bail_out;
323     for (i=0; i<c->n_ast; i++) {
324         if (c->ast[i] && (c->ast[i]->codec->codec_id    != CODEC_ID_PCM_S16LE ||
325                           c->ast[i]->codec->sample_rate != 48000 ||
326                           c->ast[i]->codec->channels    != 2))
327             goto bail_out;
328     }
329     c->sys = avpriv_dv_codec_profile(vst->codec);
330     if (!c->sys)
331         goto bail_out;
332
333     if ((c->n_ast > 1) && (c->sys->n_difchan < 2)) {
334         /* only 1 stereo pair is allowed in 25Mbps mode */
335         goto bail_out;
336     }
337
338     /* Ok, everything seems to be in working order */
339     c->frames     = 0;
340     c->has_audio  = 0;
341     c->has_video  = 0;
342     if (t = av_dict_get(s->metadata, "creation_time", NULL, 0))
343         c->start_time = ff_iso8601_to_unix_time(t->value);
344
345     for (i=0; i < c->n_ast; i++) {
346         if (c->ast[i] && !(c->audio_data[i]=av_fifo_alloc(100*AVCODEC_MAX_AUDIO_FRAME_SIZE))) {
347             while (i > 0) {
348                 i--;
349                 av_fifo_free(c->audio_data[i]);
350             }
351             goto bail_out;
352         }
353     }
354
355     return c;
356
357 bail_out:
358     return NULL;
359 }
360
361 static void dv_delete_mux(DVMuxContext *c)
362 {
363     int i;
364     for (i=0; i < c->n_ast; i++)
365         av_fifo_free(c->audio_data[i]);
366 }
367
368 static int dv_write_header(AVFormatContext *s)
369 {
370     if (!dv_init_mux(s)) {
371         av_log(s, AV_LOG_ERROR, "Can't initialize DV format!\n"
372                     "Make sure that you supply exactly two streams:\n"
373                     "     video: 25fps or 29.97fps, audio: 2ch/48kHz/PCM\n"
374                     "     (50Mbps allows an optional second audio stream)\n");
375         return -1;
376     }
377     return 0;
378 }
379
380 static int dv_write_packet(struct AVFormatContext *s, AVPacket *pkt)
381 {
382     uint8_t* frame;
383     int fsize;
384
385     fsize = dv_assemble_frame(s->priv_data, s->streams[pkt->stream_index],
386                               pkt->data, pkt->size, &frame);
387     if (fsize > 0) {
388         avio_write(s->pb, frame, fsize);
389         avio_flush(s->pb);
390     }
391     return 0;
392 }
393
394 /*
395  * We might end up with some extra A/V data without matching counterpart.
396  * E.g. video data without enough audio to write the complete frame.
397  * Currently we simply drop the last frame. I don't know whether this
398  * is the best strategy of all
399  */
400 static int dv_write_trailer(struct AVFormatContext *s)
401 {
402     dv_delete_mux(s->priv_data);
403     return 0;
404 }
405
406 AVOutputFormat ff_dv_muxer = {
407     .name              = "dv",
408     .long_name         = NULL_IF_CONFIG_SMALL("DV video format"),
409     .extensions        = "dv",
410     .priv_data_size    = sizeof(DVMuxContext),
411     .audio_codec       = CODEC_ID_PCM_S16LE,
412     .video_codec       = CODEC_ID_DVVIDEO,
413     .write_header      = dv_write_header,
414     .write_packet      = dv_write_packet,
415     .write_trailer     = dv_write_trailer,
416 };