decklink: Header cleanup
[ffmpeg.git] / libavdevice / decklink_enc.cpp
1 /*
2  * Blackmagic DeckLink output
3  * Copyright (c) 2013-2014 Ramiro Polla
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include <DeckLinkAPI.h>
23
24 extern "C" {
25 #include "libavformat/internal.h"
26 #include "libavutil/imgutils.h"
27 }
28
29 #include "decklink_common.h"
30 #include "decklink_enc.h"
31
32
33 /* DeckLink callback class declaration */
34 class decklink_frame : public IDeckLinkVideoFrame
35 {
36 public:
37     decklink_frame(struct decklink_ctx *ctx, AVFrame *avframe, long width,
38                    long height, void *buffer) :
39                    _ctx(ctx), _avframe(avframe), _width(width),
40                    _height(height), _buffer(buffer), _refs(0) { }
41
42     virtual long           STDMETHODCALLTYPE GetWidth      (void)          { return _width; }
43     virtual long           STDMETHODCALLTYPE GetHeight     (void)          { return _height; }
44     virtual long           STDMETHODCALLTYPE GetRowBytes   (void)          { return _width<<1; }
45     virtual BMDPixelFormat STDMETHODCALLTYPE GetPixelFormat(void)          { return bmdFormat8BitYUV; }
46     virtual BMDFrameFlags  STDMETHODCALLTYPE GetFlags      (void)          { return bmdVideoOutputFlagDefault; }
47     virtual HRESULT        STDMETHODCALLTYPE GetBytes      (void **buffer) { *buffer = _buffer; return S_OK; }
48
49     virtual HRESULT STDMETHODCALLTYPE GetTimecode     (BMDTimecodeFormat format, IDeckLinkTimecode **timecode) { return S_FALSE; }
50     virtual HRESULT STDMETHODCALLTYPE GetAncillaryData(IDeckLinkVideoFrameAncillary **ancillary)               { return S_FALSE; }
51
52     virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, LPVOID *ppv) { return E_NOINTERFACE; }
53     virtual ULONG   STDMETHODCALLTYPE AddRef(void)                            { return ++_refs; }
54     virtual ULONG   STDMETHODCALLTYPE Release(void)                           { if (!--_refs) delete this; return _refs; }
55
56     struct decklink_ctx *_ctx;
57     AVFrame *_avframe;
58
59 private:
60     long  _width;
61     long  _height;
62     void *_buffer;
63     int   _refs;
64 };
65
66 class decklink_output_callback : public IDeckLinkVideoOutputCallback
67 {
68 public:
69     virtual HRESULT STDMETHODCALLTYPE ScheduledFrameCompleted(IDeckLinkVideoFrame *_frame, BMDOutputFrameCompletionResult result)
70     {
71         decklink_frame *frame = static_cast<decklink_frame *>(_frame);
72         struct decklink_ctx *ctx = frame->_ctx;
73         AVFrame *avframe = frame->_avframe;
74
75         av_frame_free(&avframe);
76
77         sem_post(&ctx->semaphore);
78
79         return S_OK;
80     }
81     virtual HRESULT STDMETHODCALLTYPE ScheduledPlaybackHasStopped(void)       { return S_OK; }
82     virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, LPVOID *ppv) { return E_NOINTERFACE; }
83     virtual ULONG   STDMETHODCALLTYPE AddRef(void)                            { return 1; }
84     virtual ULONG   STDMETHODCALLTYPE Release(void)                           { return 1; }
85 };
86
87 static int decklink_setup_video(AVFormatContext *avctx, AVStream *st)
88 {
89     struct decklink_cctx *cctx = (struct decklink_cctx *) avctx->priv_data;
90     struct decklink_ctx *ctx = (struct decklink_ctx *) cctx->ctx;
91     AVCodecContext *c = st->codec;
92
93     if (ctx->video) {
94         av_log(avctx, AV_LOG_ERROR, "Only one video stream is supported!\n");
95         return -1;
96     }
97
98     if (c->pix_fmt != AV_PIX_FMT_UYVY422) {
99         av_log(avctx, AV_LOG_ERROR, "Unsupported pixel format!"
100                " Only AV_PIX_FMT_UYVY422 is supported.\n");
101         return -1;
102     }
103     if (ff_decklink_set_format(avctx, c->width, c->height,
104                             c->time_base.num, c->time_base.den)) {
105         av_log(avctx, AV_LOG_ERROR, "Unsupported video size or framerate!"
106                " Check available formats with -list_formats 1.\n");
107         return -1;
108     }
109     if (ctx->dlo->EnableVideoOutput(ctx->bmd_mode,
110                                     bmdVideoOutputFlagDefault) != S_OK) {
111         av_log(avctx, AV_LOG_ERROR, "Could not enable video output!\n");
112         return -1;
113     }
114
115     /* Set callback. */
116     ctx->output_callback = new decklink_output_callback();
117     ctx->dlo->SetScheduledFrameCompletionCallback(ctx->output_callback);
118
119     /* Start video semaphore. */
120     ctx->frames_preroll = c->time_base.den * ctx->preroll;
121     if (c->time_base.den > 1000)
122         ctx->frames_preroll /= 1000;
123
124     /* Buffer twice as many frames as the preroll. */
125     ctx->frames_buffer = ctx->frames_preroll * 2;
126     ctx->frames_buffer = FFMIN(ctx->frames_buffer, 60);
127     sem_init(&ctx->semaphore, 0, ctx->frames_buffer);
128
129     /* The device expects the framerate to be fixed. */
130     avpriv_set_pts_info(st, 64, c->time_base.num, c->time_base.den);
131
132     ctx->video = 1;
133
134     return 0;
135 }
136
137 static int decklink_setup_audio(AVFormatContext *avctx, AVStream *st)
138 {
139     struct decklink_cctx *cctx = (struct decklink_cctx *) avctx->priv_data;
140     struct decklink_ctx *ctx = (struct decklink_ctx *) cctx->ctx;
141     AVCodecContext *c = st->codec;
142
143     if (ctx->audio) {
144         av_log(avctx, AV_LOG_ERROR, "Only one audio stream is supported!\n");
145         return -1;
146     }
147     if (c->sample_rate != 48000) {
148         av_log(avctx, AV_LOG_ERROR, "Unsupported sample rate!"
149                " Only 48kHz is supported.\n");
150         return -1;
151     }
152     if (c->channels != 2 && c->channels != 8) {
153         av_log(avctx, AV_LOG_ERROR, "Unsupported number of channels!"
154                " Only stereo and 7.1 are supported.\n");
155         return -1;
156     }
157     if (ctx->dlo->EnableAudioOutput(bmdAudioSampleRate48kHz,
158                                     bmdAudioSampleType16bitInteger,
159                                     c->channels,
160                                     bmdAudioOutputStreamTimestamped) != S_OK) {
161         av_log(avctx, AV_LOG_ERROR, "Could not enable audio output!\n");
162         return -1;
163     }
164     if (ctx->dlo->BeginAudioPreroll() != S_OK) {
165         av_log(avctx, AV_LOG_ERROR, "Could not begin audio preroll!\n");
166         return -1;
167     }
168
169     /* The device expects the sample rate to be fixed. */
170     avpriv_set_pts_info(st, 64, 1, c->sample_rate);
171     ctx->channels = c->channels;
172
173     ctx->audio = 1;
174
175     return 0;
176 }
177
178 av_cold int ff_decklink_write_trailer(AVFormatContext *avctx)
179 {
180     struct decklink_cctx *cctx = (struct decklink_cctx *) avctx->priv_data;
181     struct decklink_ctx *ctx = (struct decklink_ctx *) cctx->ctx;
182
183     if (ctx->playback_started) {
184         BMDTimeValue actual;
185         ctx->dlo->StopScheduledPlayback(ctx->last_pts * ctx->bmd_tb_num,
186                                         &actual, ctx->bmd_tb_den);
187         ctx->dlo->DisableVideoOutput();
188         if (ctx->audio)
189             ctx->dlo->DisableAudioOutput();
190     }
191
192     if (ctx->dlo)
193         ctx->dlo->Release();
194     if (ctx->dl)
195         ctx->dl->Release();
196
197     if (ctx->output_callback)
198         delete ctx->output_callback;
199
200     sem_destroy(&ctx->semaphore);
201
202     av_freep(&cctx->ctx);
203
204     return 0;
205 }
206
207 static int decklink_write_video_packet(AVFormatContext *avctx, AVPacket *pkt)
208 {
209     struct decklink_cctx *cctx = (struct decklink_cctx *) avctx->priv_data;
210     struct decklink_ctx *ctx = (struct decklink_ctx *) cctx->ctx;
211     AVPicture *avpicture = (AVPicture *) pkt->data;
212     AVFrame *avframe, *tmp;
213     decklink_frame *frame;
214     buffercount_type buffered;
215     HRESULT hr;
216
217     /* HACK while av_uncoded_frame() isn't implemented */
218     int ret;
219
220     tmp = av_frame_alloc();
221     if (!tmp)
222         return AVERROR(ENOMEM);
223     tmp->format = AV_PIX_FMT_UYVY422;
224     tmp->width  = ctx->bmd_width;
225     tmp->height = ctx->bmd_height;
226     ret = av_frame_get_buffer(tmp, 32);
227     if (ret < 0) {
228         av_frame_free(&tmp);
229         return ret;
230     }
231     av_image_copy(tmp->data, tmp->linesize, (const uint8_t **) avpicture->data,
232                   avpicture->linesize, (AVPixelFormat) tmp->format, tmp->width,
233                   tmp->height);
234     avframe = av_frame_clone(tmp);
235     av_frame_free(&tmp);
236     if (!avframe) {
237         av_log(avctx, AV_LOG_ERROR, "Could not clone video frame.\n");
238         return AVERROR(EIO);
239     }
240     /* end HACK */
241
242     frame = new decklink_frame(ctx, avframe, ctx->bmd_width, ctx->bmd_height,
243                                (void *) avframe->data[0]);
244     if (!frame) {
245         av_log(avctx, AV_LOG_ERROR, "Could not create new frame.\n");
246         return AVERROR(EIO);
247     }
248
249     /* Always keep at most one second of frames buffered. */
250     sem_wait(&ctx->semaphore);
251
252     /* Schedule frame for playback. */
253     hr = ctx->dlo->ScheduleVideoFrame((struct IDeckLinkVideoFrame *) frame,
254                                       pkt->pts * ctx->bmd_tb_num,
255                                       ctx->bmd_tb_num, ctx->bmd_tb_den);
256     if (hr != S_OK) {
257         av_log(avctx, AV_LOG_ERROR, "Could not schedule video frame."
258                 " error %08x.\n", (uint32_t) hr);
259         frame->Release();
260         return AVERROR(EIO);
261     }
262
263     ctx->dlo->GetBufferedVideoFrameCount(&buffered);
264     av_log(avctx, AV_LOG_DEBUG, "Buffered video frames: %d.\n", (int) buffered);
265     if (pkt->pts > 2 && buffered <= 2)
266         av_log(avctx, AV_LOG_WARNING, "There are not enough buffered video frames."
267                " Video may misbehave!\n");
268
269     /* Preroll video frames. */
270     if (!ctx->playback_started && pkt->pts > ctx->frames_preroll) {
271         av_log(avctx, AV_LOG_DEBUG, "Ending audio preroll.\n");
272         if (ctx->audio && ctx->dlo->EndAudioPreroll() != S_OK) {
273             av_log(avctx, AV_LOG_ERROR, "Could not end audio preroll!\n");
274             return AVERROR(EIO);
275         }
276         av_log(avctx, AV_LOG_DEBUG, "Starting scheduled playback.\n");
277         if (ctx->dlo->StartScheduledPlayback(0, ctx->bmd_tb_den, 1.0) != S_OK) {
278             av_log(avctx, AV_LOG_ERROR, "Could not start scheduled playback!\n");
279             return AVERROR(EIO);
280         }
281         ctx->playback_started = 1;
282     }
283
284     return 0;
285 }
286
287 static int decklink_write_audio_packet(AVFormatContext *avctx, AVPacket *pkt)
288 {
289     struct decklink_cctx *cctx = (struct decklink_cctx *) avctx->priv_data;
290     struct decklink_ctx *ctx = (struct decklink_ctx *) cctx->ctx;
291     int sample_count = pkt->size / (ctx->channels << 1);
292     buffercount_type buffered;
293
294     ctx->dlo->GetBufferedAudioSampleFrameCount(&buffered);
295     if (pkt->pts > 1 && !buffered)
296         av_log(avctx, AV_LOG_WARNING, "There's no buffered audio."
297                " Audio will misbehave!\n");
298
299     if (ctx->dlo->ScheduleAudioSamples(pkt->data, sample_count, pkt->pts,
300                                        bmdAudioSampleRate48kHz, NULL) != S_OK) {
301         av_log(avctx, AV_LOG_ERROR, "Could not schedule audio samples.\n");
302         return AVERROR(EIO);
303     }
304
305     return 0;
306 }
307
308 extern "C" {
309
310 av_cold int ff_decklink_write_header(AVFormatContext *avctx)
311 {
312     struct decklink_cctx *cctx = (struct decklink_cctx *) avctx->priv_data;
313     struct decklink_ctx *ctx;
314     IDeckLinkDisplayModeIterator *itermode;
315     IDeckLinkIterator *iter;
316     IDeckLink *dl = NULL;
317     unsigned int n;
318
319     ctx = (struct decklink_ctx *) av_mallocz(sizeof(struct decklink_ctx));
320     if (!ctx)
321         return AVERROR(ENOMEM);
322     ctx->list_devices = cctx->list_devices;
323     ctx->list_formats = cctx->list_formats;
324     ctx->preroll      = cctx->preroll;
325     cctx->ctx = ctx;
326
327     iter = CreateDeckLinkIteratorInstance();
328     if (!iter) {
329         av_log(avctx, AV_LOG_ERROR, "Could not create DeckLink iterator\n");
330         return AVERROR(EIO);
331     }
332
333     /* List available devices. */
334     if (ctx->list_devices) {
335         ff_decklink_list_devices(avctx);
336         return AVERROR_EXIT;
337     }
338
339     /* Open device. */
340     while (iter->Next(&dl) == S_OK) {
341         const char *displayName;
342         ff_decklink_get_display_name(dl, &displayName);
343         if (!strcmp(avctx->filename, displayName)) {
344             av_free((void *) displayName);
345             ctx->dl = dl;
346             break;
347         }
348         av_free((void *) displayName);
349         dl->Release();
350     }
351     iter->Release();
352     if (!ctx->dl) {
353         av_log(avctx, AV_LOG_ERROR, "Could not open '%s'\n", avctx->filename);
354         return AVERROR(EIO);
355     }
356
357     /* Get output device. */
358     if (ctx->dl->QueryInterface(IID_IDeckLinkOutput, (void **) &ctx->dlo) != S_OK) {
359         av_log(avctx, AV_LOG_ERROR, "Could not open output device from '%s'\n",
360                avctx->filename);
361         ctx->dl->Release();
362         return AVERROR(EIO);
363     }
364
365     /* List supported formats. */
366     if (ctx->list_formats) {
367         ff_decklink_list_formats(avctx);
368         ctx->dlo->Release();
369         ctx->dl->Release();
370         return AVERROR_EXIT;
371     }
372
373     if (ctx->dlo->GetDisplayModeIterator(&itermode) != S_OK) {
374         av_log(avctx, AV_LOG_ERROR, "Could not get Display Mode Iterator\n");
375         ctx->dl->Release();
376         return AVERROR(EIO);
377     }
378
379     /* Setup streams. */
380     for (n = 0; n < avctx->nb_streams; n++) {
381         AVStream *st = avctx->streams[n];
382         AVCodecContext *c = st->codec;
383         if        (c->codec_type == AVMEDIA_TYPE_AUDIO) {
384             if (decklink_setup_audio(avctx, st))
385                 goto error;
386         } else if (c->codec_type == AVMEDIA_TYPE_VIDEO) {
387             if (decklink_setup_video(avctx, st))
388                 goto error;
389         } else {
390             av_log(avctx, AV_LOG_ERROR, "Unsupported stream type.\n");
391             goto error;
392         }
393     }
394     itermode->Release();
395
396     return 0;
397
398 error:
399
400     ctx->dlo->Release();
401     ctx->dl->Release();
402
403     return AVERROR(EIO);
404 }
405
406 int ff_decklink_write_packet(AVFormatContext *avctx, AVPacket *pkt)
407 {
408     struct decklink_cctx *cctx = (struct decklink_cctx *) avctx->priv_data;
409     struct decklink_ctx *ctx = (struct decklink_ctx *) cctx->ctx;
410     AVStream *st = avctx->streams[pkt->stream_index];
411
412     ctx->last_pts = FFMAX(ctx->last_pts, pkt->pts);
413
414     if      (st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
415         return decklink_write_video_packet(avctx, pkt);
416     else if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO)
417         return decklink_write_audio_packet(avctx, pkt);
418
419     return AVERROR(EIO);
420 }
421
422 } /* extern "C" */