2 * Blackmagic DeckLink output
3 * Copyright (c) 2013-2014 Ramiro Polla
5 * This file is part of FFmpeg.
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.
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.
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
25 /* Include internal.h first to avoid conflict between winsock.h (used by
26 * DeckLink headers) and winsock2.h (used by libavformat) in MSVC++ builds */
28 #include "libavformat/internal.h"
31 #include <DeckLinkAPI.h>
34 #include "libavformat/avformat.h"
35 #include "libavutil/imgutils.h"
39 #include "decklink_common.h"
40 #include "decklink_enc.h"
43 /* DeckLink callback class declaration */
44 class decklink_frame : public IDeckLinkVideoFrame
47 decklink_frame(struct decklink_ctx *ctx, AVFrame *avframe, AVCodecID codec_id, int height, int width) :
48 _ctx(ctx), _avframe(avframe), _avpacket(NULL), _codec_id(codec_id), _height(height), _width(width), _refs(1) { }
49 decklink_frame(struct decklink_ctx *ctx, AVPacket *avpacket, AVCodecID codec_id, int height, int width) :
50 _ctx(ctx), _avframe(NULL), _avpacket(avpacket), _codec_id(codec_id), _height(height), _width(width), _refs(1) { }
52 virtual long STDMETHODCALLTYPE GetWidth (void) { return _width; }
53 virtual long STDMETHODCALLTYPE GetHeight (void) { return _height; }
54 virtual long STDMETHODCALLTYPE GetRowBytes (void)
56 if (_codec_id == AV_CODEC_ID_WRAPPED_AVFRAME)
57 return _avframe->linesize[0] < 0 ? -_avframe->linesize[0] : _avframe->linesize[0];
59 return ((GetWidth() + 47) / 48) * 128;
61 virtual BMDPixelFormat STDMETHODCALLTYPE GetPixelFormat(void)
63 if (_codec_id == AV_CODEC_ID_WRAPPED_AVFRAME)
64 return bmdFormat8BitYUV;
66 return bmdFormat10BitYUV;
68 virtual BMDFrameFlags STDMETHODCALLTYPE GetFlags (void)
70 if (_codec_id == AV_CODEC_ID_WRAPPED_AVFRAME)
71 return _avframe->linesize[0] < 0 ? bmdFrameFlagFlipVertical : bmdFrameFlagDefault;
73 return bmdFrameFlagDefault;
76 virtual HRESULT STDMETHODCALLTYPE GetBytes (void **buffer)
78 if (_codec_id == AV_CODEC_ID_WRAPPED_AVFRAME) {
79 if (_avframe->linesize[0] < 0)
80 *buffer = (void *)(_avframe->data[0] + _avframe->linesize[0] * (_avframe->height - 1));
82 *buffer = (void *)(_avframe->data[0]);
84 *buffer = (void *)(_avpacket->data);
89 virtual HRESULT STDMETHODCALLTYPE GetTimecode (BMDTimecodeFormat format, IDeckLinkTimecode **timecode) { return S_FALSE; }
90 virtual HRESULT STDMETHODCALLTYPE GetAncillaryData(IDeckLinkVideoFrameAncillary **ancillary) { return S_FALSE; }
92 virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, LPVOID *ppv) { return E_NOINTERFACE; }
93 virtual ULONG STDMETHODCALLTYPE AddRef(void) { return ++_refs; }
94 virtual ULONG STDMETHODCALLTYPE Release(void)
98 av_frame_free(&_avframe);
99 av_packet_free(&_avpacket);
105 struct decklink_ctx *_ctx;
113 std::atomic<int> _refs;
116 class decklink_output_callback : public IDeckLinkVideoOutputCallback
119 virtual HRESULT STDMETHODCALLTYPE ScheduledFrameCompleted(IDeckLinkVideoFrame *_frame, BMDOutputFrameCompletionResult result)
121 decklink_frame *frame = static_cast<decklink_frame *>(_frame);
122 struct decklink_ctx *ctx = frame->_ctx;
125 av_frame_unref(frame->_avframe);
126 if (frame->_avpacket)
127 av_packet_unref(frame->_avpacket);
129 pthread_mutex_lock(&ctx->mutex);
130 ctx->frames_buffer_available_spots++;
131 pthread_cond_broadcast(&ctx->cond);
132 pthread_mutex_unlock(&ctx->mutex);
136 virtual HRESULT STDMETHODCALLTYPE ScheduledPlaybackHasStopped(void) { return S_OK; }
137 virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, LPVOID *ppv) { return E_NOINTERFACE; }
138 virtual ULONG STDMETHODCALLTYPE AddRef(void) { return 1; }
139 virtual ULONG STDMETHODCALLTYPE Release(void) { return 1; }
142 static int decklink_setup_video(AVFormatContext *avctx, AVStream *st)
144 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
145 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
146 AVCodecParameters *c = st->codecpar;
149 av_log(avctx, AV_LOG_ERROR, "Only one video stream is supported!\n");
153 if (c->codec_id == AV_CODEC_ID_WRAPPED_AVFRAME) {
154 if (c->format != AV_PIX_FMT_UYVY422) {
155 av_log(avctx, AV_LOG_ERROR, "Unsupported pixel format!"
156 " Only AV_PIX_FMT_UYVY422 is supported.\n");
159 } else if (c->codec_id != AV_CODEC_ID_V210) {
160 av_log(avctx, AV_LOG_ERROR, "Unsupported codec type!"
161 " Only V210 and wrapped frame with AV_PIX_FMT_UYVY422 are supported.\n");
165 if (ff_decklink_set_format(avctx, c->width, c->height,
166 st->time_base.num, st->time_base.den, c->field_order)) {
167 av_log(avctx, AV_LOG_ERROR, "Unsupported video size, framerate or field order!"
168 " Check available formats with -list_formats 1.\n");
171 if (ctx->dlo->EnableVideoOutput(ctx->bmd_mode,
172 bmdVideoOutputFlagDefault) != S_OK) {
173 av_log(avctx, AV_LOG_ERROR, "Could not enable video output!\n");
178 ctx->output_callback = new decklink_output_callback();
179 ctx->dlo->SetScheduledFrameCompletionCallback(ctx->output_callback);
181 ctx->frames_preroll = st->time_base.den * ctx->preroll;
182 if (st->time_base.den > 1000)
183 ctx->frames_preroll /= 1000;
185 /* Buffer twice as many frames as the preroll. */
186 ctx->frames_buffer = ctx->frames_preroll * 2;
187 ctx->frames_buffer = FFMIN(ctx->frames_buffer, 60);
188 pthread_mutex_init(&ctx->mutex, NULL);
189 pthread_cond_init(&ctx->cond, NULL);
190 ctx->frames_buffer_available_spots = ctx->frames_buffer;
192 /* The device expects the framerate to be fixed. */
193 avpriv_set_pts_info(st, 64, st->time_base.num, st->time_base.den);
200 static int decklink_setup_audio(AVFormatContext *avctx, AVStream *st)
202 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
203 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
204 AVCodecParameters *c = st->codecpar;
207 av_log(avctx, AV_LOG_ERROR, "Only one audio stream is supported!\n");
210 if (c->sample_rate != 48000) {
211 av_log(avctx, AV_LOG_ERROR, "Unsupported sample rate!"
212 " Only 48kHz is supported.\n");
215 if (c->channels != 2 && c->channels != 8 && c->channels != 16) {
216 av_log(avctx, AV_LOG_ERROR, "Unsupported number of channels!"
217 " Only 2, 8 or 16 channels are supported.\n");
220 if (ctx->dlo->EnableAudioOutput(bmdAudioSampleRate48kHz,
221 bmdAudioSampleType16bitInteger,
223 bmdAudioOutputStreamTimestamped) != S_OK) {
224 av_log(avctx, AV_LOG_ERROR, "Could not enable audio output!\n");
227 if (ctx->dlo->BeginAudioPreroll() != S_OK) {
228 av_log(avctx, AV_LOG_ERROR, "Could not begin audio preroll!\n");
232 /* The device expects the sample rate to be fixed. */
233 avpriv_set_pts_info(st, 64, 1, c->sample_rate);
234 ctx->channels = c->channels;
241 av_cold int ff_decklink_write_trailer(AVFormatContext *avctx)
243 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
244 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
246 if (ctx->playback_started) {
248 ctx->dlo->StopScheduledPlayback(ctx->last_pts * ctx->bmd_tb_num,
249 &actual, ctx->bmd_tb_den);
250 ctx->dlo->DisableVideoOutput();
252 ctx->dlo->DisableAudioOutput();
255 ff_decklink_cleanup(avctx);
257 if (ctx->output_callback)
258 delete ctx->output_callback;
260 pthread_mutex_destroy(&ctx->mutex);
261 pthread_cond_destroy(&ctx->cond);
263 av_freep(&cctx->ctx);
268 static int decklink_write_video_packet(AVFormatContext *avctx, AVPacket *pkt)
270 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
271 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
272 AVStream *st = avctx->streams[pkt->stream_index];
273 AVFrame *avframe = NULL, *tmp = (AVFrame *)pkt->data;
274 AVPacket *avpacket = NULL;
275 decklink_frame *frame;
276 buffercount_type buffered;
279 if (st->codecpar->codec_id == AV_CODEC_ID_WRAPPED_AVFRAME) {
280 if (tmp->format != AV_PIX_FMT_UYVY422 ||
281 tmp->width != ctx->bmd_width ||
282 tmp->height != ctx->bmd_height) {
283 av_log(avctx, AV_LOG_ERROR, "Got a frame with invalid pixel format or dimension.\n");
284 return AVERROR(EINVAL);
287 avframe = av_frame_clone(tmp);
289 av_log(avctx, AV_LOG_ERROR, "Could not clone video frame.\n");
293 frame = new decklink_frame(ctx, avframe, st->codecpar->codec_id, avframe->height, avframe->width);
295 avpacket = av_packet_clone(pkt);
297 av_log(avctx, AV_LOG_ERROR, "Could not clone video frame.\n");
301 frame = new decklink_frame(ctx, avpacket, st->codecpar->codec_id, ctx->bmd_height, ctx->bmd_width);
305 av_log(avctx, AV_LOG_ERROR, "Could not create new frame.\n");
306 av_frame_free(&avframe);
307 av_packet_free(&avpacket);
311 /* Always keep at most one second of frames buffered. */
312 pthread_mutex_lock(&ctx->mutex);
313 while (ctx->frames_buffer_available_spots == 0) {
314 pthread_cond_wait(&ctx->cond, &ctx->mutex);
316 ctx->frames_buffer_available_spots--;
317 pthread_mutex_unlock(&ctx->mutex);
319 /* Schedule frame for playback. */
320 hr = ctx->dlo->ScheduleVideoFrame((struct IDeckLinkVideoFrame *) frame,
321 pkt->pts * ctx->bmd_tb_num,
322 ctx->bmd_tb_num, ctx->bmd_tb_den);
323 /* Pass ownership to DeckLink, or release on failure */
326 av_log(avctx, AV_LOG_ERROR, "Could not schedule video frame."
327 " error %08x.\n", (uint32_t) hr);
331 ctx->dlo->GetBufferedVideoFrameCount(&buffered);
332 av_log(avctx, AV_LOG_DEBUG, "Buffered video frames: %d.\n", (int) buffered);
333 if (pkt->pts > 2 && buffered <= 2)
334 av_log(avctx, AV_LOG_WARNING, "There are not enough buffered video frames."
335 " Video may misbehave!\n");
337 /* Preroll video frames. */
338 if (!ctx->playback_started && pkt->pts > ctx->frames_preroll) {
339 av_log(avctx, AV_LOG_DEBUG, "Ending audio preroll.\n");
340 if (ctx->audio && ctx->dlo->EndAudioPreroll() != S_OK) {
341 av_log(avctx, AV_LOG_ERROR, "Could not end audio preroll!\n");
344 av_log(avctx, AV_LOG_DEBUG, "Starting scheduled playback.\n");
345 if (ctx->dlo->StartScheduledPlayback(0, ctx->bmd_tb_den, 1.0) != S_OK) {
346 av_log(avctx, AV_LOG_ERROR, "Could not start scheduled playback!\n");
349 ctx->playback_started = 1;
355 static int decklink_write_audio_packet(AVFormatContext *avctx, AVPacket *pkt)
357 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
358 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
359 int sample_count = pkt->size / (ctx->channels << 1);
360 buffercount_type buffered;
362 ctx->dlo->GetBufferedAudioSampleFrameCount(&buffered);
363 if (pkt->pts > 1 && !buffered)
364 av_log(avctx, AV_LOG_WARNING, "There's no buffered audio."
365 " Audio will misbehave!\n");
367 if (ctx->dlo->ScheduleAudioSamples(pkt->data, sample_count, pkt->pts,
368 bmdAudioSampleRate48kHz, NULL) != S_OK) {
369 av_log(avctx, AV_LOG_ERROR, "Could not schedule audio samples.\n");
378 av_cold int ff_decklink_write_header(AVFormatContext *avctx)
380 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
381 struct decklink_ctx *ctx;
385 ctx = (struct decklink_ctx *) av_mallocz(sizeof(struct decklink_ctx));
387 return AVERROR(ENOMEM);
388 ctx->list_devices = cctx->list_devices;
389 ctx->list_formats = cctx->list_formats;
390 ctx->preroll = cctx->preroll;
393 /* List available devices and exit. */
394 if (ctx->list_devices) {
395 ff_decklink_list_devices_legacy(avctx, 0, 1);
399 ret = ff_decklink_init_device(avctx, avctx->filename);
403 /* Get output device. */
404 if (ctx->dl->QueryInterface(IID_IDeckLinkOutput, (void **) &ctx->dlo) != S_OK) {
405 av_log(avctx, AV_LOG_ERROR, "Could not open output device from '%s'\n",
411 /* List supported formats. */
412 if (ctx->list_formats) {
413 ff_decklink_list_formats(avctx);
420 for (n = 0; n < avctx->nb_streams; n++) {
421 AVStream *st = avctx->streams[n];
422 AVCodecParameters *c = st->codecpar;
423 if (c->codec_type == AVMEDIA_TYPE_AUDIO) {
424 if (decklink_setup_audio(avctx, st))
426 } else if (c->codec_type == AVMEDIA_TYPE_VIDEO) {
427 if (decklink_setup_video(avctx, st))
430 av_log(avctx, AV_LOG_ERROR, "Unsupported stream type.\n");
438 ff_decklink_cleanup(avctx);
442 int ff_decklink_write_packet(AVFormatContext *avctx, AVPacket *pkt)
444 struct decklink_cctx *cctx = (struct decklink_cctx *)avctx->priv_data;
445 struct decklink_ctx *ctx = (struct decklink_ctx *)cctx->ctx;
446 AVStream *st = avctx->streams[pkt->stream_index];
448 ctx->last_pts = FFMAX(ctx->last_pts, pkt->pts);
450 if (st->codecpar->codec_type == AVMEDIA_TYPE_VIDEO)
451 return decklink_write_video_packet(avctx, pkt);
452 else if (st->codecpar->codec_type == AVMEDIA_TYPE_AUDIO)
453 return decklink_write_audio_packet(avctx, pkt);
458 int ff_decklink_list_output_devices(AVFormatContext *avctx, struct AVDeviceInfoList *device_list)
460 return ff_decklink_list_devices(avctx, device_list, 0, 1);