2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
4 * This file is part of CasparCG (www.casparcg.com).
6 * CasparCG is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * CasparCG is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
19 * Author: Robert Nagy, ronag89@gmail.com
22 #include "../StdAfx.h"
24 #include "decklink_producer.h"
26 #include "../util/util.h"
28 #include "../../ffmpeg/producer/filter/filter.h"
29 #include "../../ffmpeg/producer/util/util.h"
30 #include "../../ffmpeg/producer/muxer/frame_muxer.h"
31 #include "../../ffmpeg/producer/muxer/display_mode.h"
33 #include <common/executor.h>
34 #include <common/diagnostics/graph.h>
35 #include <common/except.h>
36 #include <common/log.h>
37 #include <common/param.h>
38 #include <common/timer.h>
40 #include <core/frame/audio_channel_layout.h>
41 #include <core/frame/frame.h>
42 #include <core/frame/draw_frame.h>
43 #include <core/frame/frame_transform.h>
44 #include <core/frame/frame_factory.h>
45 #include <core/producer/frame_producer.h>
46 #include <core/monitor/monitor.h>
47 #include <core/mixer/audio/audio_mixer.h>
48 #include <core/help/help_repository.h>
49 #include <core/help/help_sink.h>
51 #include <tbb/concurrent_queue.h>
53 #include <boost/algorithm/string.hpp>
54 #include <boost/property_tree/ptree.hpp>
55 #include <boost/range/adaptor/transformed.hpp>
58 #pragma warning (push)
59 #pragma warning (disable : 4244)
63 #define __STDC_CONSTANT_MACROS
64 #define __STDC_LIMIT_MACROS
65 #include <libavcodec/avcodec.h>
71 #include "../decklink_api.h"
75 namespace caspar { namespace decklink {
77 core::audio_channel_layout get_adjusted_channel_layout(core::audio_channel_layout layout)
79 if (layout.num_channels <= 2)
80 layout.num_channels = 2;
81 else if (layout.num_channels <= 8)
82 layout.num_channels = 8;
84 layout.num_channels = 16;
90 std::wstring to_string(const T& cadence)
92 return boost::join(cadence | boost::adaptors::transformed([](size_t i) { return boost::lexical_cast<std::wstring>(i); }), L", ");
95 class decklink_producer : boost::noncopyable, public IDeckLinkInputCallback
97 const int device_index_;
98 core::monitor::subject monitor_subject_;
99 spl::shared_ptr<diagnostics::graph> graph_;
100 caspar::timer tick_timer_;
102 com_ptr<IDeckLink> decklink_ = get_device(device_index_);
103 com_iface_ptr<IDeckLinkInput> input_ = iface_cast<IDeckLinkInput>(decklink_);
104 com_iface_ptr<IDeckLinkAttributes> attributes_ = iface_cast<IDeckLinkAttributes>(decklink_);
106 const std::wstring model_name_ = get_model_name(decklink_);
107 const std::wstring filter_;
109 core::video_format_desc in_format_desc_;
110 core::video_format_desc out_format_desc_;
111 std::vector<int> audio_cadence_ = out_format_desc_.audio_cadence;
112 boost::circular_buffer<size_t> sync_buffer_ { audio_cadence_.size() };
113 spl::shared_ptr<core::frame_factory> frame_factory_;
114 core::audio_channel_layout channel_layout_;
115 ffmpeg::frame_muxer muxer_ { in_format_desc_.fps, frame_factory_, out_format_desc_, channel_layout_, filter_ };
117 core::constraints constraints_ { in_format_desc_.width, in_format_desc_.height };
119 tbb::concurrent_bounded_queue<core::draw_frame> frame_buffer_;
121 std::exception_ptr exception_;
125 const core::video_format_desc& in_format_desc,
127 const spl::shared_ptr<core::frame_factory>& frame_factory,
128 const core::video_format_desc& out_format_desc,
129 const core::audio_channel_layout& channel_layout,
130 const std::wstring& filter)
131 : device_index_(device_index)
133 , in_format_desc_(in_format_desc)
134 , out_format_desc_(out_format_desc)
135 , frame_factory_(frame_factory)
136 , channel_layout_(get_adjusted_channel_layout(channel_layout))
138 frame_buffer_.set_capacity(2);
140 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));
141 graph_->set_color("late-frame", diagnostics::color(0.6f, 0.3f, 0.3f));
142 graph_->set_color("frame-time", diagnostics::color(1.0f, 0.0f, 0.0f));
143 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
144 graph_->set_color("output-buffer", diagnostics::color(0.0f, 1.0f, 0.0f));
145 graph_->set_text(print());
146 diagnostics::register_graph(graph_);
148 bool will_attempt_dma;
149 auto display_mode = get_display_mode(input_, in_format_desc.format, bmdFormat8BitYUV, bmdVideoInputFlagDefault, will_attempt_dma);
151 // NOTE: bmdFormat8BitARGB is currently not supported by any decklink card. (2011-05-08)
152 if(FAILED(input_->EnableVideoInput(display_mode, bmdFormat8BitYUV, 0)))
153 CASPAR_THROW_EXCEPTION(caspar_exception()
154 << msg_info(print() + L" Could not enable video input.")
155 << boost::errinfo_api_function("EnableVideoInput"));
157 if(FAILED(input_->EnableAudioInput(bmdAudioSampleRate48kHz, bmdAudioSampleType32bitInteger, static_cast<int>(channel_layout_.num_channels))))
158 CASPAR_THROW_EXCEPTION(caspar_exception()
159 << msg_info(print() + L" Could not enable audio input.")
160 << boost::errinfo_api_function("EnableAudioInput"));
162 if (FAILED(input_->SetCallback(this)) != S_OK)
163 CASPAR_THROW_EXCEPTION(caspar_exception()
164 << msg_info(print() + L" Failed to set input callback.")
165 << boost::errinfo_api_function("SetCallback"));
167 if(FAILED(input_->StartStreams()))
168 CASPAR_THROW_EXCEPTION(caspar_exception()
169 << msg_info(print() + L" Failed to start input stream.")
170 << boost::errinfo_api_function("StartStreams"));
172 CASPAR_LOG(info) << print() << L" Initialized";
177 if(input_ != nullptr)
179 input_->StopStreams();
180 input_->DisableVideoInput();
184 core::constraints& pixel_constraints()
189 virtual HRESULT STDMETHODCALLTYPE QueryInterface (REFIID, LPVOID*) {return E_NOINTERFACE;}
190 virtual ULONG STDMETHODCALLTYPE AddRef () {return 1;}
191 virtual ULONG STDMETHODCALLTYPE Release () {return 1;}
193 virtual HRESULT STDMETHODCALLTYPE VideoInputFormatChanged(BMDVideoInputFormatChangedEvents /*notificationEvents*/, IDeckLinkDisplayMode* newDisplayMode, BMDDetectedVideoInputFormatFlags /*detectedSignalFlags*/)
198 virtual HRESULT STDMETHODCALLTYPE VideoInputFrameArrived(IDeckLinkVideoInputFrame* video, IDeckLinkAudioInputPacket* audio)
205 graph_->set_value("tick-time", tick_timer_.elapsed()*out_format_desc_.fps*0.5);
206 tick_timer_.restart();
208 caspar::timer frame_timer;
212 void* video_bytes = nullptr;
213 if(FAILED(video->GetBytes(&video_bytes)) || !video_bytes)
216 auto video_frame = ffmpeg::create_frame();
218 video_frame->data[0] = reinterpret_cast<uint8_t*>(video_bytes);
219 video_frame->linesize[0] = video->GetRowBytes();
220 video_frame->format = PIX_FMT_UYVY422;
221 video_frame->width = video->GetWidth();
222 video_frame->height = video->GetHeight();
223 video_frame->interlaced_frame = in_format_desc_.field_mode != core::field_mode::progressive;
224 video_frame->top_field_first = in_format_desc_.field_mode == core::field_mode::upper ? 1 : 0;
227 << core::monitor::message("/file/name") % model_name_
228 << core::monitor::message("/file/path") % device_index_
229 << core::monitor::message("/file/video/width") % video->GetWidth()
230 << core::monitor::message("/file/video/height") % video->GetHeight()
231 << core::monitor::message("/file/video/field") % u8(!video_frame->interlaced_frame ? "progressive" : (video_frame->top_field_first ? "upper" : "lower"))
232 << core::monitor::message("/file/audio/sample-rate") % 48000
233 << core::monitor::message("/file/audio/channels") % 2
234 << core::monitor::message("/file/audio/format") % u8(av_get_sample_fmt_name(AV_SAMPLE_FMT_S32))
235 << core::monitor::message("/file/fps") % in_format_desc_.fps;
239 auto audio_frame = ffmpeg::create_frame();
240 audio_frame->format = AV_SAMPLE_FMT_S32;
241 core::mutable_audio_buffer audio_buf;
245 void* audio_bytes = nullptr;
246 if (FAILED(audio->GetBytes(&audio_bytes)) || !audio_bytes)
250 audio_frame->data[0] = reinterpret_cast<uint8_t*>(audio_bytes);
251 audio_frame->linesize[0] = audio->GetSampleFrameCount() * channel_layout_.num_channels * sizeof(int32_t);
252 audio_frame->nb_samples = audio->GetSampleFrameCount();
256 audio_buf.resize(audio_cadence_.front() * channel_layout_.num_channels, 0);
257 audio_frame->data[0] = reinterpret_cast<uint8_t*>(audio_buf.data());
258 audio_frame->linesize[0] = audio_cadence_.front() * channel_layout_.num_channels * sizeof(int32_t);
259 audio_frame->nb_samples = audio_cadence_.front();
262 // Note: Uses 1 step rotated cadence for 1001 modes (1602, 1602, 1601, 1602, 1601)
263 // This cadence fills the audio mixer most optimally.
265 sync_buffer_.push_back(audio_frame->nb_samples);
266 if(!boost::range::equal(sync_buffer_, audio_cadence_))
268 CASPAR_LOG(trace) << print() << L" Syncing audio. Expected cadence: " << to_string(audio_cadence_) << L" Got cadence: " << to_string(sync_buffer_);
271 boost::range::rotate(audio_cadence_, std::begin(audio_cadence_)+1);
275 muxer_.push_video(video_frame);
276 muxer_.push_audio(audio_frame);
280 auto frame = core::draw_frame::late();
283 frame = std::move(muxer_.front());
286 if(!frame_buffer_.try_push(frame))
288 auto dummy = core::draw_frame::empty();
289 frame_buffer_.try_pop(dummy);
290 frame_buffer_.try_push(frame);
292 graph_->set_tag(diagnostics::tag_severity::WARNING, "dropped-frame");
296 graph_->set_value("frame-time", frame_timer.elapsed()*out_format_desc_.fps*0.5);
297 monitor_subject_ << core::monitor::message("/profiler/time") % frame_timer.elapsed() % out_format_desc_.fps;
299 graph_->set_value("output-buffer", static_cast<float>(frame_buffer_.size())/static_cast<float>(frame_buffer_.capacity()));
300 monitor_subject_ << core::monitor::message("/buffer") % frame_buffer_.size() % frame_buffer_.capacity();
304 exception_ = std::current_exception();
311 core::draw_frame get_frame()
313 if(exception_ != nullptr)
314 std::rethrow_exception(exception_);
316 core::draw_frame frame = core::draw_frame::late();
317 if(!frame_buffer_.try_pop(frame))
318 graph_->set_tag(diagnostics::tag_severity::WARNING, "late-frame");
319 graph_->set_value("output-buffer", static_cast<float>(frame_buffer_.size())/static_cast<float>(frame_buffer_.capacity()));
323 std::wstring print() const
325 return model_name_ + L" [" + boost::lexical_cast<std::wstring>(device_index_) + L"|" + in_format_desc_.name + L"]";
328 core::monitor::subject& monitor_output()
330 return monitor_subject_;
334 class decklink_producer_proxy : public core::frame_producer_base
336 std::unique_ptr<decklink_producer> producer_;
337 const uint32_t length_;
340 explicit decklink_producer_proxy(
341 const core::video_format_desc& in_format_desc,
342 const spl::shared_ptr<core::frame_factory>& frame_factory,
343 const core::video_format_desc& out_format_desc,
344 const core::audio_channel_layout& channel_layout,
346 const std::wstring& filter_str,
348 : executor_(L"decklink_producer[" + boost::lexical_cast<std::wstring>(device_index) + L"]")
354 producer_.reset(new decklink_producer(in_format_desc, device_index, frame_factory, out_format_desc, channel_layout, filter_str));
358 ~decklink_producer_proxy()
367 core::monitor::subject& monitor_output()
369 return producer_->monitor_output();
374 core::draw_frame receive_impl() override
376 return producer_->get_frame();
379 core::constraints& pixel_constraints() override
381 return producer_->pixel_constraints();
384 uint32_t nb_frames() const override
389 std::wstring print() const override
391 return producer_->print();
394 std::wstring name() const override
399 boost::property_tree::wptree info() const override
401 boost::property_tree::wptree info;
402 info.add(L"type", L"decklink");
407 void describe_producer(core::help_sink& sink, const core::help_repository& repo)
409 sink.short_description(L"Allows video sources to be input from BlackMagic Design cards.");
410 sink.syntax(L"DECKLINK [device:int],DEVICE [device:int] {FILTER [filter:string]} {LENGTH [length:int]} {FORMAT [format:string]} {CHANNEL_LAYOUT [channel_layout:string]}");
411 sink.para()->text(L"Allows video sources to be input from BlackMagic Design cards. Parameters:");
413 ->item(L"device", L"The decklink device to stream the input from. See the Blackmagic control panel for the order of devices in your system.")
414 ->item(L"filter", L"If specified, sets an FFmpeg video filter to use.")
415 ->item(L"length", L"Optionally specify a limit on how many frames to produce.")
416 ->item(L"format", L"Specifies what video format to expect on the incoming SDI/HDMI signal. If not specified the video format of the channel is assumed.")
417 ->item(L"channel_layout", L"Specifies what audio channel layout to expect on the incoming SDI/HDMI signal. If not specified, stereo is assumed.");
418 sink.para()->text(L"Examples:");
419 sink.example(L">> PLAY 1-10 DECKLINK DEVICE 2", L"Play using decklink device 2 expecting the video signal to have the same video format as the channel.");
420 sink.example(L">> PLAY 1-10 DECKLINK DEVICE 2 FORMAT PAL FILTER yadif=1:-1", L"Play using decklink device 2 expecting the video signal to be in PAL and deinterlace it.");
421 sink.example(L">> PLAY 1-10 DECKLINK DEVICE 2 LENGTH 1000", L"Play using decklink device 2 but only produce 1000 frames.");
422 sink.example(L">> PLAY 1-10 DECKLINK DEVICE 2 CHANNEL_LAYOUT smpte", L"Play using decklink device 2 and expect smpte surround sound.");
425 spl::shared_ptr<core::frame_producer> create_producer(const core::frame_producer_dependencies& dependencies, const std::vector<std::wstring>& params)
427 if(params.empty() || !boost::iequals(params.at(0), "decklink"))
428 return core::frame_producer::empty();
430 auto device_index = get_param(L"DEVICE", params, -1);
431 if(device_index == -1)
432 device_index = boost::lexical_cast<int>(params.at(1));
434 auto filter_str = get_param(L"FILTER", params);
435 auto length = get_param(L"LENGTH", params, std::numeric_limits<uint32_t>::max());
436 auto in_format_desc = core::video_format_desc(get_param(L"FORMAT", params, L"INVALID"));
438 if(in_format_desc.format == core::video_format::invalid)
439 in_format_desc = dependencies.format_desc;
441 auto channel_layout_spec = get_param(L"CHANNEL_LAYOUT", params);
442 auto channel_layout = *core::audio_channel_layout_repository::get_default()->get_layout(L"stereo");
444 if (!channel_layout_spec.empty())
446 auto found_layout = core::audio_channel_layout_repository::get_default()->get_layout(channel_layout_spec);
449 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Channel layout not found."));
451 channel_layout = *found_layout;
454 return create_destroy_proxy(spl::make_shared<decklink_producer_proxy>(
456 dependencies.frame_factory,
457 dependencies.format_desc,