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/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>
  50
  51 #include <tbb/concurrent_queue.h>
  52
  53 #include <boost/algorithm/string.hpp>
  54 #include <boost/property_tree/ptree.hpp>
  55 #include <boost/range/adaptor/transformed.hpp>
  56
  57 #if defined(_MSC_VER)
  58 #pragma warning (push)
  59 #pragma warning (disable : 4244)
  60 #endif
  61 extern "C"
  62 {
  63         #define __STDC_CONSTANT_MACROS
  64         #define __STDC_LIMIT_MACROS
  65         #include <libavcodec/avcodec.h>
  66 }
  67 #if defined(_MSC_VER)
  68 #pragma warning (pop)
  69 #endif
  70
  71 #include "../decklink_api.h"
  72
  73 #include <functional>
  74
  75 namespace caspar { namespace decklink {
  76
  77 core::audio_channel_layout get_adjusted_channel_layout(core::audio_channel_layout layout)
  78 {
  79         if (layout.num_channels <= 2)
  80                 layout.num_channels = 2;
  81         else if (layout.num_channels <= 8)
  82                 layout.num_channels = 8;
  83         else
  84                 layout.num_channels = 16;
  85
  86         return layout;
  87 }
  88
  89 template <typename T>
  90 std::wstring to_string(const T& cadence)
  91 {
  92         return boost::join(cadence | boost::adaptors::transformed([](size_t i) { return boost::lexical_cast<std::wstring>(i); }), L", ");
  93 }
  94
  95 class decklink_producer : boost::noncopyable, public IDeckLinkInputCallback
  96 {
  97         const int                                                                               device_index_;
  98         core::monitor::subject                                                  monitor_subject_;
  99         spl::shared_ptr<diagnostics::graph>                             graph_;
 100         caspar::timer                                                                   tick_timer_;
 101
 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_);
 105
 106         const std::wstring                                                              model_name_                     = get_model_name(decklink_);
 107         const std::wstring                                                              filter_;
 108
 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_ };
 116
 117         core::constraints                                                               constraints_            { in_format_desc_.width, in_format_desc_.height };
 118
 119         tbb::concurrent_bounded_queue<core::draw_frame> frame_buffer_;
 120
 121         std::exception_ptr                                                              exception_;
 122
 123 public:
 124         decklink_producer(
 125                         const core::video_format_desc& in_format_desc,
 126                         int device_index,
 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)
 132                 , filter_(filter)
 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))
 137         {
 138                 frame_buffer_.set_capacity(2);
 139
 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_);
 147
 148                 bool will_attempt_dma;
 149                 auto display_mode = get_display_mode(input_, in_format_desc.format, bmdFormat8BitYUV, bmdVideoInputFlagDefault, will_attempt_dma);
 150
 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"));
 156
 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"));
 161
 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"));
 166
 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"));
 171
 172                 CASPAR_LOG(info) << print() << L" Initialized";
 173         }
 174
 175         ~decklink_producer()
 176         {
 177                 if(input_ != nullptr)
 178                 {
 179                         input_->StopStreams();
 180                         input_->DisableVideoInput();
 181                 }
 182         }
 183
 184         core::constraints& pixel_constraints()
 185         {
 186                 return constraints_;
 187         }
 188
 189         virtual HRESULT STDMETHODCALLTYPE       QueryInterface (REFIID, LPVOID*)        {return E_NOINTERFACE;}
 190         virtual ULONG STDMETHODCALLTYPE         AddRef ()                                                       {return 1;}
 191         virtual ULONG STDMETHODCALLTYPE         Release ()                                                      {return 1;}
 192
 193         virtual HRESULT STDMETHODCALLTYPE VideoInputFormatChanged(BMDVideoInputFormatChangedEvents /*notificationEvents*/, IDeckLinkDisplayMode* newDisplayMode, BMDDetectedVideoInputFormatFlags /*detectedSignalFlags*/)
 194         {
 195                 return S_OK;
 196         }
 197
 198         virtual HRESULT STDMETHODCALLTYPE VideoInputFrameArrived(IDeckLinkVideoInputFrame* video, IDeckLinkAudioInputPacket* audio)
 199         {
 200                 if(!video)
 201                         return S_OK;
 202
 203                 try
 204                 {
 205                         graph_->set_value("tick-time", tick_timer_.elapsed()*out_format_desc_.fps*0.5);
 206                         tick_timer_.restart();
 207
 208                         caspar::timer frame_timer;
 209
 210                         // Video
 211
 212                         void* video_bytes = nullptr;
 213                         if(FAILED(video->GetBytes(&video_bytes)) || !video_bytes)
 214                                 return S_OK;
 215
 216                         auto video_frame = ffmpeg::create_frame();
 217
 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;
 225
 226                         monitor_subject_
 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;
 236
 237                         // Audio
 238
 239                         auto audio_frame = ffmpeg::create_frame();
 240                         audio_frame->format = AV_SAMPLE_FMT_S32;
 241                         core::mutable_audio_buffer audio_buf;
 242
 243                         if (audio)
 244                         {
 245                                 void* audio_bytes = nullptr;
 246                                 if (FAILED(audio->GetBytes(&audio_bytes)) || !audio_bytes)
 247                                         return S_OK;
 248
 249
 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();
 253                         }
 254                         else
 255                         {
 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();
 260                         }
 261
 262                         // Note: Uses 1 step rotated cadence for 1001 modes (1602, 1602, 1601, 1602, 1601)
 263                         // This cadence fills the audio mixer most optimally.
 264
 265                         sync_buffer_.push_back(audio_frame->nb_samples);
 266                         if(!boost::range::equal(sync_buffer_, audio_cadence_))
 267                         {
 268                                 CASPAR_LOG(trace) << print() << L" Syncing audio. Expected cadence: " << to_string(audio_cadence_) << L" Got cadence: " << to_string(sync_buffer_);
 269                                 return S_OK;
 270                         }
 271                         boost::range::rotate(audio_cadence_, std::begin(audio_cadence_)+1);
 272
 273                         // PUSH
 274
 275                         muxer_.push_video(video_frame);
 276                         muxer_.push_audio(audio_frame);
 277
 278                         // POLL
 279
 280                         auto frame = core::draw_frame::late();
 281                         if(!muxer_.empty())
 282                         {
 283                                 frame = std::move(muxer_.front());
 284                                 muxer_.pop();
 285
 286                                 if(!frame_buffer_.try_push(frame))
 287                                 {
 288                                         auto dummy = core::draw_frame::empty();
 289                                         frame_buffer_.try_pop(dummy);
 290                                         frame_buffer_.try_push(frame);
 291
 292                                         graph_->set_tag(diagnostics::tag_severity::WARNING, "dropped-frame");
 293                                 }
 294                         }
 295
 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;
 298
 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();
 301                 }
 302                 catch(...)
 303                 {
 304                         exception_ = std::current_exception();
 305                         return E_FAIL;
 306                 }
 307
 308                 return S_OK;
 309         }
 310
 311         core::draw_frame get_frame()
 312         {
 313                 if(exception_ != nullptr)
 314                         std::rethrow_exception(exception_);
 315
 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()));
 320                 return frame;
 321         }
 322
 323         std::wstring print() const
 324         {
 325                 return model_name_ + L" [" + boost::lexical_cast<std::wstring>(device_index_) + L"|" + in_format_desc_.name + L"]";
 326         }
 327
 328         core::monitor::subject& monitor_output()
 329         {
 330                 return monitor_subject_;
 331         }
 332 };
 333
 334 class decklink_producer_proxy : public core::frame_producer_base
 335 {
 336         std::unique_ptr<decklink_producer>      producer_;
 337         const uint32_t                                          length_;
 338         executor                                                        executor_;
 339 public:
 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,
 345                         int device_index,
 346                         const std::wstring& filter_str,
 347                         uint32_t length)
 348                 : executor_(L"decklink_producer[" + boost::lexical_cast<std::wstring>(device_index) + L"]")
 349                 , length_(length)
 350         {
 351                 executor_.invoke([=]
 352                 {
 353                         com_initialize();
 354                         producer_.reset(new decklink_producer(in_format_desc, device_index, frame_factory, out_format_desc, channel_layout, filter_str));
 355                 });
 356         }
 357
 358         ~decklink_producer_proxy()
 359         {
 360                 executor_.invoke([=]
 361                 {
 362                         producer_.reset();
 363                         com_uninitialize();
 364                 });
 365         }
 366
 367         core::monitor::subject& monitor_output()
 368         {
 369                 return producer_->monitor_output();
 370         }
 371
 372         // frame_producer
 373
 374         core::draw_frame receive_impl() override
 375         {
 376                 return producer_->get_frame();
 377         }
 378
 379         core::constraints& pixel_constraints() override
 380         {
 381                 return producer_->pixel_constraints();
 382         }
 383
 384         uint32_t nb_frames() const override
 385         {
 386                 return length_;
 387         }
 388
 389         std::wstring print() const override
 390         {
 391                 return producer_->print();
 392         }
 393
 394         std::wstring name() const override
 395         {
 396                 return L"decklink";
 397         }
 398
 399         boost::property_tree::wptree info() const override
 400         {
 401                 boost::property_tree::wptree info;
 402                 info.add(L"type", L"decklink");
 403                 return info;
 404         }
 405 };
 406
 407 void describe_producer(core::help_sink& sink, const core::help_repository& repo)
 408 {
 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:");
 412         sink.definitions()
 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.");
 423 }
 424
 425 spl::shared_ptr<core::frame_producer> create_producer(const core::frame_producer_dependencies& dependencies, const std::vector<std::wstring>& params)
 426 {
 427         if(params.empty() || !boost::iequals(params.at(0), "decklink"))
 428                 return core::frame_producer::empty();
 429
 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));
 433
 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"));
 437
 438         if(in_format_desc.format == core::video_format::invalid)
 439                 in_format_desc = dependencies.format_desc;
 440
 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");
 443
 444         if (!channel_layout_spec.empty())
 445         {
 446                 auto found_layout = core::audio_channel_layout_repository::get_default()->get_layout(channel_layout_spec);
 447
 448                 if (!found_layout)
 449                         CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Channel layout not found."));
 450
 451                 channel_layout = *found_layout;
 452         }
 453
 454         return create_destroy_proxy(spl::make_shared<decklink_producer_proxy>(
 455                         in_format_desc,
 456                         dependencies.frame_factory,
 457                         dependencies.format_desc,
 458                         channel_layout,
 459                         device_index,
 460                         filter_str,
 461                         length));
 462 }
 463
 464 }}