git.sesse.net Git - casparcg/blob - modules/decklink/producer/decklink_producer.cpp

   1 /*
   2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
   3 *
   4 * This file is part of CasparCG (www.casparcg.com).
   5 *
   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.
  10 *
  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.
  15 *
  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/>.
  18 *
  19 * Author: Robert Nagy, ronag89@gmail.com
  20 */
  21
  22 #include "../StdAfx.h"
  23
  24 #include "decklink_producer.h"
  25
  26 #include "../util/util.h"
  27
  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"
  32
  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>
  39
  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/producer/framerate/framerate_producer.h>
  47 #include <core/monitor/monitor.h>
  48 #include <core/diagnostics/call_context.h>
  49 #include <core/mixer/audio/audio_mixer.h>
  50 #include <core/help/help_repository.h>
  51 #include <core/help/help_sink.h>
  52
  53 #include <tbb/concurrent_queue.h>
  54
  55 #include <boost/algorithm/string.hpp>
  56 #include <boost/property_tree/ptree.hpp>
  57 #include <boost/range/adaptor/transformed.hpp>
  58
  59 #if defined(_MSC_VER)
  60 #pragma warning (push)
  61 #pragma warning (disable : 4244)
  62 #endif
  63 extern "C"
  64 {
  65         #define __STDC_CONSTANT_MACROS
  66         #define __STDC_LIMIT_MACROS
  67         #include <libavcodec/avcodec.h>
  68 }
  69 #if defined(_MSC_VER)
  70 #pragma warning (pop)
  71 #endif
  72
  73 #include "../decklink_api.h"
  74
  75 #include <functional>
  76
  77 namespace caspar { namespace decklink {
  78 core::audio_channel_layout get_adjusted_channel_layout(core::audio_channel_layout layout)
  79 {
  80         if (layout.num_channels <= 2)
  81                 layout.num_channels = 2;
  82         else if (layout.num_channels <= 8)
  83                 layout.num_channels = 8;
  84         else
  85                 layout.num_channels = 16;
  86
  87         return layout;
  88 }
  89
  90 template <typename T>
  91 std::wstring to_string(const T& cadence)
  92 {
  93         return boost::join(cadence | boost::adaptors::transformed([](size_t i) { return boost::lexical_cast<std::wstring>(i); }), L", ");
  94 }
  95
  96 class decklink_producer : boost::noncopyable, public IDeckLinkInputCallback
  97 {
  98         const int                                                                               device_index_;
  99         core::monitor::subject                                                  monitor_subject_;
 100         spl::shared_ptr<diagnostics::graph>                             graph_;
 101         caspar::timer                                                                   tick_timer_;
 102
 103         com_ptr<IDeckLink>                                                              decklink_                       = get_device(device_index_);
 104         com_iface_ptr<IDeckLinkInput>                                   input_                          = iface_cast<IDeckLinkInput>(decklink_);
 105         com_iface_ptr<IDeckLinkAttributes>                              attributes_                     = iface_cast<IDeckLinkAttributes>(decklink_);
 106
 107         const std::wstring                                                              model_name_                     = get_model_name(decklink_);
 108         const std::wstring                                                              filter_;
 109
 110         core::video_format_desc                                                 in_format_desc_;
 111         core::video_format_desc                                                 out_format_desc_;
 112         std::vector<int>                                                                audio_cadence_          = in_format_desc_.audio_cadence;
 113         boost::circular_buffer<size_t>                                  sync_buffer_            { audio_cadence_.size() };
 114         spl::shared_ptr<core::frame_factory>                    frame_factory_;
 115         core::audio_channel_layout                                              channel_layout_;
 116         ffmpeg::frame_muxer                                                             muxer_                          { in_format_desc_.framerate, frame_factory_, out_format_desc_, channel_layout_, filter_, ffmpeg::filter::is_deinterlacing(filter_) };
 117
 118         core::constraints                                                               constraints_            { in_format_desc_.width, in_format_desc_.height };
 119
 120         tbb::concurrent_bounded_queue<core::draw_frame> frame_buffer_;
 121         core::draw_frame                                                                last_frame_                     = core::draw_frame::empty();
 122
 123         std::exception_ptr                                                              exception_;
 124
 125 public:
 126         decklink_producer(
 127                         const core::video_format_desc& in_format_desc,
 128                         int device_index,
 129                         const spl::shared_ptr<core::frame_factory>& frame_factory,
 130                         const core::video_format_desc& out_format_desc,
 131                         const core::audio_channel_layout& channel_layout,
 132                         const std::wstring& filter)
 133                 : device_index_(device_index)
 134                 , filter_(filter)
 135                 , in_format_desc_(in_format_desc)
 136                 , out_format_desc_(out_format_desc)
 137                 , frame_factory_(frame_factory)
 138                 , channel_layout_(get_adjusted_channel_layout(channel_layout))
 139         {
 140                 frame_buffer_.set_capacity(4);
 141
 142                 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));
 143                 graph_->set_color("late-frame", diagnostics::color(0.6f, 0.3f, 0.3f));
 144                 graph_->set_color("frame-time", diagnostics::color(1.0f, 0.0f, 0.0f));
 145                 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
 146                 graph_->set_color("output-buffer", diagnostics::color(0.0f, 1.0f, 0.0f));
 147                 graph_->set_text(print());
 148                 diagnostics::register_graph(graph_);
 149
 150                 bool will_attempt_dma;
 151                 auto display_mode = get_display_mode(input_, in_format_desc.format, bmdFormat8BitYUV, bmdVideoInputFlagDefault, will_attempt_dma);
 152
 153                 // NOTE: bmdFormat8BitARGB is currently not supported by any decklink card. (2011-05-08)
 154                 if(FAILED(input_->EnableVideoInput(display_mode, bmdFormat8BitYUV, 0)))
 155                         CASPAR_THROW_EXCEPTION(caspar_exception()
 156                                                                         << msg_info(print() + L" Could not enable video input.")
 157                                                                         << boost::errinfo_api_function("EnableVideoInput"));
 158
 159                 if(FAILED(input_->EnableAudioInput(bmdAudioSampleRate48kHz, bmdAudioSampleType32bitInteger, static_cast<int>(channel_layout_.num_channels))))
 160                         CASPAR_THROW_EXCEPTION(caspar_exception()
 161                                                                         << msg_info(print() + L" Could not enable audio input.")
 162                                                                         << boost::errinfo_api_function("EnableAudioInput"));
 163
 164                 if (FAILED(input_->SetCallback(this)) != S_OK)
 165                         CASPAR_THROW_EXCEPTION(caspar_exception()
 166                                                                         << msg_info(print() + L" Failed to set input callback.")
 167                                                                         << boost::errinfo_api_function("SetCallback"));
 168
 169                 if(FAILED(input_->StartStreams()))
 170                         CASPAR_THROW_EXCEPTION(caspar_exception()
 171                                                                         << msg_info(print() + L" Failed to start input stream.")
 172                                                                         << boost::errinfo_api_function("StartStreams"));
 173
 174                 CASPAR_LOG(info) << print() << L" Initialized";
 175         }
 176
 177         ~decklink_producer()
 178         {
 179                 if(input_ != nullptr)
 180                 {
 181                         input_->StopStreams();
 182                         input_->DisableVideoInput();
 183                 }
 184         }
 185
 186         core::constraints& pixel_constraints()
 187         {
 188                 return constraints_;
 189         }
 190
 191         virtual HRESULT STDMETHODCALLTYPE       QueryInterface (REFIID, LPVOID*)        {return E_NOINTERFACE;}
 192         virtual ULONG STDMETHODCALLTYPE         AddRef ()                                                       {return 1;}
 193         virtual ULONG STDMETHODCALLTYPE         Release ()                                                      {return 1;}
 194
 195         virtual HRESULT STDMETHODCALLTYPE VideoInputFormatChanged(BMDVideoInputFormatChangedEvents /*notificationEvents*/, IDeckLinkDisplayMode* newDisplayMode, BMDDetectedVideoInputFormatFlags /*detectedSignalFlags*/)
 196         {
 197                 return S_OK;
 198         }
 199
 200         virtual HRESULT STDMETHODCALLTYPE VideoInputFrameArrived(IDeckLinkVideoInputFrame* video, IDeckLinkAudioInputPacket* audio)
 201         {
 202                 ensure_gpf_handler_installed_for_thread("decklink-VideoInputFrameArrived");
 203                 if(!video)
 204                         return S_OK;
 205
 206                 try
 207                 {
 208                         graph_->set_value("tick-time", tick_timer_.elapsed()*out_format_desc_.fps*0.5);
 209                         tick_timer_.restart();
 210
 211                         caspar::timer frame_timer;
 212
 213                         // Video
 214
 215                         void* video_bytes = nullptr;
 216                         if(FAILED(video->GetBytes(&video_bytes)) || !video_bytes)
 217                                 return S_OK;
 218
 219                         auto video_frame = ffmpeg::create_frame();
 220
 221                         video_frame->data[0]                    = reinterpret_cast<uint8_t*>(video_bytes);
 222                         video_frame->linesize[0]                = video->GetRowBytes();
 223                         video_frame->format                             = PIX_FMT_UYVY422;
 224                         video_frame->width                              = video->GetWidth();
 225                         video_frame->height                             = video->GetHeight();
 226                         video_frame->interlaced_frame   = in_format_desc_.field_mode != core::field_mode::progressive;
 227                         video_frame->top_field_first    = in_format_desc_.field_mode == core::field_mode::upper ? 1 : 0;
 228                         video_frame->key_frame                  = 1;
 229
 230                         monitor_subject_
 231                                         << core::monitor::message("/file/name")                                 % model_name_
 232                                         << core::monitor::message("/file/path")                                 % device_index_
 233                                         << core::monitor::message("/file/video/width")                  % video->GetWidth()
 234                                         << core::monitor::message("/file/video/height")                 % video->GetHeight()
 235                                         << core::monitor::message("/file/video/field")                  % u8(!video_frame->interlaced_frame ? "progressive" : (video_frame->top_field_first ? "upper" : "lower"))
 236                                         << core::monitor::message("/file/audio/sample-rate")    % 48000
 237                                         << core::monitor::message("/file/audio/channels")               % 2
 238                                         << core::monitor::message("/file/audio/format")                 % u8(av_get_sample_fmt_name(AV_SAMPLE_FMT_S32))
 239                                         << core::monitor::message("/file/fps")                                  % in_format_desc_.fps;
 240
 241                         // Audio
 242
 243                         std::shared_ptr<core::mutable_audio_buffer>     audio_buffer;
 244                         void*                                                                           audio_bytes             = nullptr;
 245
 246                         // It is assumed that audio is always equal or ahead of video.
 247                         if (audio && SUCCEEDED(audio->GetBytes(&audio_bytes)) && audio_bytes)
 248                         {
 249                                 auto sample_frame_count = audio->GetSampleFrameCount();
 250                                 auto audio_data = reinterpret_cast<int32_t*>(audio_bytes);
 251
 252                                 audio_buffer = std::make_shared<core::mutable_audio_buffer>(
 253                                         audio_data,
 254                                         audio_data + sample_frame_count * channel_layout_.num_channels);
 255                         }
 256                         else
 257                                 audio_buffer = std::make_shared<core::mutable_audio_buffer>(audio_cadence_.front() * channel_layout_.num_channels, 0);
 258
 259                         // Note: Uses 1 step rotated cadence for 1001 modes (1602, 1602, 1601, 1602, 1601)
 260                         // This cadence fills the audio mixer most optimally.
 261
 262                         sync_buffer_.push_back(audio_buffer->size() / channel_layout_.num_channels);
 263                         if(!boost::range::equal(sync_buffer_, audio_cadence_))
 264                         {
 265                                 CASPAR_LOG(trace) << print() << L" Syncing audio. Expected cadence: " << to_string(audio_cadence_) << L" Got cadence: " << to_string(sync_buffer_);
 266                                 return S_OK;
 267                         }
 268                         boost::range::rotate(audio_cadence_, std::begin(audio_cadence_)+1);
 269
 270                         // PUSH
 271
 272                         muxer_.push(audio_buffer);
 273                         muxer_.push(static_cast<std::shared_ptr<AVFrame>>(video_frame));
 274
 275                         // POLL
 276
 277                         for (auto frame = muxer_.poll(); frame != core::draw_frame::empty(); frame = muxer_.poll())
 278                         {
 279                                 if (!frame_buffer_.try_push(frame))
 280                                 {
 281                                         auto dummy = core::draw_frame::empty();
 282                                         frame_buffer_.try_pop(dummy);
 283
 284                                         frame_buffer_.try_push(frame);
 285
 286                                         graph_->set_tag(diagnostics::tag_severity::WARNING, "dropped-frame");
 287                                 }
 288                         }
 289
 290                         graph_->set_value("frame-time", frame_timer.elapsed()*out_format_desc_.fps*0.5);
 291                         monitor_subject_ << core::monitor::message("/profiler/time") % frame_timer.elapsed() % out_format_desc_.fps;
 292
 293                         graph_->set_value("output-buffer", static_cast<float>(frame_buffer_.size())/static_cast<float>(frame_buffer_.capacity()));
 294                         monitor_subject_ << core::monitor::message("/buffer") % frame_buffer_.size() % frame_buffer_.capacity();
 295                 }
 296                 catch(...)
 297                 {
 298                         exception_ = std::current_exception();
 299                         return E_FAIL;
 300                 }
 301
 302                 return S_OK;
 303         }
 304
 305         core::draw_frame get_frame()
 306         {
 307                 if(exception_ != nullptr)
 308                         std::rethrow_exception(exception_);
 309
 310                 core::draw_frame frame = last_frame_;
 311
 312                 if (!frame_buffer_.try_pop(frame))
 313                         graph_->set_tag(diagnostics::tag_severity::WARNING, "late-frame");
 314                 else
 315                         last_frame_ = frame;
 316
 317                 graph_->set_value("output-buffer", static_cast<float>(frame_buffer_.size()) / static_cast<float>(frame_buffer_.capacity()));
 318
 319                 return frame;
 320         }
 321
 322         std::wstring print() const
 323         {
 324                 return model_name_ + L" [" + boost::lexical_cast<std::wstring>(device_index_) + L"|" + in_format_desc_.name + L"]";
 325         }
 326
 327         boost::rational<int> get_out_framerate() const
 328         {
 329                 return muxer_.out_framerate();
 330         }
 331
 332         core::monitor::subject& monitor_output()
 333         {
 334                 return monitor_subject_;
 335         }
 336 };
 337
 338 class decklink_producer_proxy : public core::frame_producer_base
 339 {
 340         std::unique_ptr<decklink_producer>      producer_;
 341         const uint32_t                                          length_;
 342         executor                                                        executor_;
 343 public:
 344         explicit decklink_producer_proxy(
 345                         const core::video_format_desc& in_format_desc,
 346                         const spl::shared_ptr<core::frame_factory>& frame_factory,
 347                         const core::video_format_desc& out_format_desc,
 348                         const core::audio_channel_layout& channel_layout,
 349                         int device_index,
 350                         const std::wstring& filter_str,
 351                         uint32_t length)
 352                 : executor_(L"decklink_producer[" + boost::lexical_cast<std::wstring>(device_index) + L"]")
 353                 , length_(length)
 354         {
 355                 auto ctx = core::diagnostics::call_context::for_thread();
 356                 executor_.invoke([=]
 357                 {
 358                         core::diagnostics::call_context::for_thread() = ctx;
 359                         com_initialize();
 360                         producer_.reset(new decklink_producer(in_format_desc, device_index, frame_factory, out_format_desc, channel_layout, filter_str));
 361                 });
 362         }
 363
 364         ~decklink_producer_proxy()
 365         {
 366                 executor_.invoke([=]
 367                 {
 368                         producer_.reset();
 369                         com_uninitialize();
 370                 });
 371         }
 372
 373         core::monitor::subject& monitor_output()
 374         {
 375                 return producer_->monitor_output();
 376         }
 377
 378         // frame_producer
 379
 380         core::draw_frame receive_impl() override
 381         {
 382                 return producer_->get_frame();
 383         }
 384
 385         core::constraints& pixel_constraints() override
 386         {
 387                 return producer_->pixel_constraints();
 388         }
 389
 390         uint32_t nb_frames() const override
 391         {
 392                 return length_;
 393         }
 394
 395         std::wstring print() const override
 396         {
 397                 return producer_->print();
 398         }
 399
 400         std::wstring name() const override
 401         {
 402                 return L"decklink";
 403         }
 404
 405         boost::property_tree::wptree info() const override
 406         {
 407                 boost::property_tree::wptree info;
 408                 info.add(L"type", L"decklink");
 409                 return info;
 410         }
 411
 412         boost::rational<int> get_out_framerate() const
 413         {
 414                 return producer_->get_out_framerate();
 415         }
 416 };
 417
 418 void describe_producer(core::help_sink& sink, const core::help_repository& repo)
 419 {
 420         sink.short_description(L"Allows video sources to be input from BlackMagic Design cards.");
 421         sink.syntax(L"DECKLINK [device:int],DEVICE [device:int] {FILTER [filter:string]} {LENGTH [length:int]} {FORMAT [format:string]} {CHANNEL_LAYOUT [channel_layout:string]}");
 422         sink.para()->text(L"Allows video sources to be input from BlackMagic Design cards. Parameters:");
 423         sink.definitions()
 424                 ->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.")
 425                 ->item(L"filter", L"If specified, sets an FFmpeg video filter to use.")
 426                 ->item(L"length", L"Optionally specify a limit on how many frames to produce.")
 427                 ->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.")
 428                 ->item(L"channel_layout", L"Specifies what audio channel layout to expect on the incoming SDI/HDMI signal. If not specified, stereo is assumed.");
 429         sink.para()->text(L"Examples:");
 430         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.");
 431         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.");
 432         sink.example(L">> PLAY 1-10 DECKLINK DEVICE 2 LENGTH 1000", L"Play using decklink device 2 but only produce 1000 frames.");
 433         sink.example(L">> PLAY 1-10 DECKLINK DEVICE 2 CHANNEL_LAYOUT smpte", L"Play using decklink device 2 and expect smpte surround sound.");
 434 }
 435
 436 spl::shared_ptr<core::frame_producer> create_producer(const core::frame_producer_dependencies& dependencies, const std::vector<std::wstring>& params)
 437 {
 438         if(params.empty() || !boost::iequals(params.at(0), "decklink"))
 439                 return core::frame_producer::empty();
 440
 441         auto device_index       = get_param(L"DEVICE", params, -1);
 442         if(device_index == -1)
 443                 device_index = boost::lexical_cast<int>(params.at(1));
 444
 445         auto filter_str         = get_param(L"FILTER", params);
 446         auto length                     = get_param(L"LENGTH", params, std::numeric_limits<uint32_t>::max());
 447         auto in_format_desc = core::video_format_desc(get_param(L"FORMAT", params, L"INVALID"));
 448
 449         if(in_format_desc.format == core::video_format::invalid)
 450                 in_format_desc = dependencies.format_desc;
 451
 452         auto channel_layout_spec        = get_param(L"CHANNEL_LAYOUT", params);
 453         auto channel_layout                     = *core::audio_channel_layout_repository::get_default()->get_layout(L"stereo");
 454
 455         if (!channel_layout_spec.empty())
 456         {
 457                 auto found_layout = core::audio_channel_layout_repository::get_default()->get_layout(channel_layout_spec);
 458
 459                 if (!found_layout)
 460                         CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Channel layout not found."));
 461
 462                 channel_layout = *found_layout;
 463         }
 464
 465         boost::ireplace_all(filter_str, L"DEINTERLACE_BOB",     L"YADIF=1:-1");
 466         boost::ireplace_all(filter_str, L"DEINTERLACE_LQ",      L"SEPARATEFIELDS");
 467         boost::ireplace_all(filter_str, L"DEINTERLACE",         L"YADIF=0:-1");
 468
 469         auto producer = spl::make_shared<decklink_producer_proxy>(
 470                         in_format_desc,
 471                         dependencies.frame_factory,
 472                         dependencies.format_desc,
 473                         channel_layout,
 474                         device_index,
 475                         filter_str,
 476                         length);
 477
 478         auto get_source_framerate       = [=] { return producer->get_out_framerate(); };
 479         auto target_framerate           = dependencies.format_desc.framerate;
 480
 481         return core::create_destroy_proxy(core::create_framerate_producer(
 482                         producer,
 483                         get_source_framerate,
 484                         target_framerate,
 485                         dependencies.format_desc.field_mode,
 486                         dependencies.format_desc.audio_cadence));
 487 }
 488 }}