git.sesse.net Git - casparcg/blob - modules/decklink/consumer/decklink_consumer.cpp

   1 /*\r
   2 * copyright (c) 2010 Sveriges Television AB <info@casparcg.com>\r
   3 *\r
   4 *  This file is part of CasparCG.\r
   5 *\r
   6 *    CasparCG is free software: you can redistribute it and/or modify\r
   7 *    it under the terms of the GNU General Public License as published by\r
   8 *    the Free Software Foundation, either version 3 of the License, or\r
   9 *    (at your option) any later version.\r
  10 *\r
  11 *    CasparCG is distributed in the hope that it will be useful,\r
  12 *    but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14 *    GNU General Public License for more details.\r
  15 \r
  16 *    You should have received a copy of the GNU General Public License\r
  17 *    along with CasparCG.  If not, see <http://www.gnu.org/licenses/>.\r
  18 *\r
  19 */\r
  20 \r
  21 #include "../StdAfx.h"\r
  22  \r
  23 #include "decklink_consumer.h"\r
  24 \r
  25 #include "../util/util.h"\r
  26 \r
  27 #include "../interop/DeckLinkAPI_h.h"\r
  28 \r
  29 #include <core/video_format.h>\r
  30 \r
  31 #include <core/consumer/frame/read_frame.h>\r
  32 \r
  33 #include <common/concurrency/executor.h>\r
  34 #include <common/diagnostics/graph.h>\r
  35 #include <common/exception/exceptions.h>\r
  36 #include <common/utility/timer.h>\r
  37 \r
  38 #include <tbb/concurrent_queue.h>\r
  39 \r
  40 #include <boost/circular_buffer.hpp>\r
  41 #include <boost/timer.hpp>\r
  42 \r
  43 #include <array>\r
  44 \r
  45 #pragma warning(push)\r
  46 #pragma warning(disable : 4996)\r
  47 \r
  48         #include <atlbase.h>\r
  49 \r
  50         #include <atlcom.h>\r
  51         #include <atlhost.h>\r
  52 \r
  53 #pragma warning(push)\r
  54 \r
  55 namespace caspar { \r
  56         \r
  57 struct decklink_output : public IDeckLinkVideoOutputCallback, public IDeckLinkAudioOutputCallback, boost::noncopyable\r
  58 {               \r
  59         struct co_init\r
  60         {\r
  61                 co_init(){CoInitialize(nullptr);}\r
  62                 ~co_init(){CoUninitialize();}\r
  63         } co_;\r
  64         \r
  65         const size_t    device_index_;\r
  66         const bool              embed_audio_;\r
  67         const decklink_consumer::key            key_;\r
  68 \r
  69         std::wstring    model_name_;\r
  70         tbb::atomic<bool> is_running_;\r
  71 \r
  72         std::shared_ptr<diagnostics::graph> graph_;\r
  73         boost::timer perf_timer_;\r
  74 \r
  75         std::array<std::pair<void*, CComPtr<IDeckLinkMutableVideoFrame>>, 3> reserved_frames_;\r
  76         boost::circular_buffer<std::vector<short>> audio_container_;\r
  77         \r
  78         CComPtr<IDeckLink>                      decklink_;\r
  79         CComQIPtr<IDeckLinkOutput>      output_;\r
  80         \r
  81         core::video_format_desc format_desc_;\r
  82 \r
  83         BMDTimeScale frame_time_scale_;\r
  84         BMDTimeValue frame_duration_;\r
  85         unsigned long frames_scheduled_;\r
  86         unsigned long audio_scheduled_;\r
  87         \r
  88         tbb::concurrent_bounded_queue<std::shared_ptr<const core::read_frame>> video_frame_buffer_;\r
  89         tbb::concurrent_bounded_queue<std::shared_ptr<const core::read_frame>> audio_frame_buffer_;\r
  90 \r
  91 public:\r
  92         decklink_output(const core::video_format_desc& format_desc,size_t device_index, bool embed_audio, decklink_consumer::key key) \r
  93                 :  model_name_(L"DECKLINK")\r
  94                 , device_index_(device_index)\r
  95                 , audio_container_(5)\r
  96                 , embed_audio_(embed_audio)\r
  97                 , key_(key)\r
  98                 , frames_scheduled_(0)\r
  99                 , audio_scheduled_(0)\r
 100                 , format_desc_(format_desc)\r
 101         {\r
 102                 is_running_ = true;\r
 103                 format_desc_ = format_desc;\r
 104                 CComPtr<IDeckLinkIterator> pDecklinkIterator;\r
 105                 if(FAILED(pDecklinkIterator.CoCreateInstance(CLSID_CDeckLinkIterator)))\r
 106                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " No Decklink drivers installed."));\r
 107                 \r
 108                 size_t n = 0;\r
 109                 while(n < device_index_ && pDecklinkIterator->Next(&decklink_) == S_OK){++n;}   \r
 110 \r
 111                 if(n != device_index_ || !decklink_)\r
 112                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Decklink card not found.") << arg_name_info("device_index") << arg_value_info(boost::lexical_cast<std::string>(device_index_)));\r
 113                 \r
 114                 BSTR pModelName;\r
 115                 decklink_->GetModelName(&pModelName);\r
 116                 model_name_ = std::wstring(pModelName);\r
 117                                 \r
 118                 graph_ = diagnostics::create_graph(narrow(print()));\r
 119                 graph_->add_guide("tick-time", 0.5);\r
 120                 graph_->set_color("tick-time", diagnostics::color(0.1f, 0.7f, 0.8f));\r
 121                 \r
 122                 output_ = decklink_;\r
 123 \r
 124                 auto display_mode = get_display_mode(output_.p, format_desc_.format);\r
 125                 if(display_mode == nullptr) \r
 126                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Card does not support requested videoformat."));\r
 127                 \r
 128                 display_mode->GetFrameRate(&frame_duration_, &frame_time_scale_);\r
 129 \r
 130                 BMDDisplayModeSupport displayModeSupport;\r
 131                 if(FAILED(output_->DoesSupportVideoMode(display_mode->GetDisplayMode(), bmdFormat8BitBGRA, bmdVideoOutputFlagDefault, &displayModeSupport, nullptr)))\r
 132                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Card does not support requested videoformat."));\r
 133                 \r
 134                 if(embed_audio_)\r
 135                 {\r
 136                         if(FAILED(output_->EnableAudioOutput(bmdAudioSampleRate48kHz, bmdAudioSampleType16bitInteger, 2, bmdAudioOutputStreamTimestamped)))\r
 137                                 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Could not enable audio output."));\r
 138                                 \r
 139                         if(FAILED(output_->SetAudioCallback(this)))\r
 140                                 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Could not set audio callback."));\r
 141 \r
 142                         CASPAR_LOG(info) << print() << L" Enabled embedded-audio.";\r
 143                 }\r
 144 \r
 145                 if(FAILED(output_->EnableVideoOutput(display_mode->GetDisplayMode(), bmdVideoOutputFlagDefault))) \r
 146                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Could not enable video output."));\r
 147 \r
 148                 if(FAILED(output_->SetScheduledFrameCompletionCallback(this)))\r
 149                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to set playback completion callback."));\r
 150                         \r
 151                 CComQIPtr<IDeckLinkKeyer> keyer = decklink_;\r
 152                 if(key_ == decklink_consumer::internal_key) \r
 153                 {\r
 154                         if(FAILED(keyer->Enable(FALSE)))                        \r
 155                                 CASPAR_LOG(error) << print() << L" Failed to enable internal keyer.";                   \r
 156                         else if(FAILED(keyer->SetLevel(255)))                   \r
 157                                 CASPAR_LOG(error) << print() << L" Failed to set key-level to max.";\r
 158                         else\r
 159                                 CASPAR_LOG(info) << print() << L" Successfully configured internal keyer.";             \r
 160                 }\r
 161                 else if(key_ == decklink_consumer::external_key)\r
 162                 {\r
 163                         if(FAILED(keyer->Enable(TRUE)))                 \r
 164                                 CASPAR_LOG(error) << print() << L" Failed to enable external keyer.";   \r
 165                         else if(FAILED(keyer->SetLevel(255)))                   \r
 166                                 CASPAR_LOG(error) << print() << L" Failed to set key-level to max.";\r
 167                         else\r
 168                                 CASPAR_LOG(info) << print() << L" Successfully configured external keyer.";                     \r
 169                 }\r
 170                 else\r
 171                                 CASPAR_LOG(info) << print() << L" Uses default keyer settings.";        \r
 172 \r
 173                 \r
 174                 for(size_t n = 0; n < reserved_frames_.size(); ++n)\r
 175                 {\r
 176                         if(FAILED(output_->CreateVideoFrame(format_desc_.width, format_desc_.height, format_desc_.size/format_desc_.height, bmdFormat8BitBGRA, bmdFrameFlagDefault, &reserved_frames_[n].second)))\r
 177                                 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to create frame."));\r
 178 \r
 179                         if(FAILED(reserved_frames_[n].second->GetBytes(&reserved_frames_[n].first)))\r
 180                                 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to get frame bytes."));\r
 181                 }\r
 182                                         \r
 183                 auto buffer_size = static_cast<size_t>(frame_time_scale_/frame_duration_)/4;\r
 184                 for(size_t n = 0; n < buffer_size; ++n)\r
 185                         schedule_next_video(core::read_frame::empty());\r
 186 \r
 187                 video_frame_buffer_.set_capacity(buffer_size);\r
 188                 audio_frame_buffer_.set_capacity(buffer_size);\r
 189                 for(size_t n = 0; n < std::max<size_t>(2, buffer_size-2); ++n)\r
 190                 {\r
 191                         video_frame_buffer_.try_push(core::read_frame::empty());\r
 192                         if(embed_audio_)\r
 193                                 audio_frame_buffer_.try_push(core::read_frame::empty());\r
 194                 }\r
 195                 \r
 196                 if(FAILED(output_->StartScheduledPlayback(0, frame_time_scale_, 1.0))) \r
 197                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to schedule playback."));\r
 198                 \r
 199                 CASPAR_LOG(info) << print() << L" Successfully initialized for " << format_desc_.name;  \r
 200         }\r
 201 \r
 202         ~decklink_output()\r
 203         {               \r
 204                 is_running_ = false;\r
 205                 video_frame_buffer_.try_push(core::read_frame::empty());\r
 206                 audio_frame_buffer_.try_push(core::read_frame::empty());\r
 207 \r
 208                 if(output_ != nullptr) \r
 209                 {\r
 210                         output_->StopScheduledPlayback(0, nullptr, 0);\r
 211                         if(embed_audio_)\r
 212                                 output_->DisableAudioOutput();\r
 213                         output_->DisableVideoOutput();\r
 214                 }\r
 215                 CASPAR_LOG(info) << print() << L" Shutting down.";      \r
 216         }\r
 217                         \r
 218         virtual HRESULT STDMETHODCALLTYPE       QueryInterface (REFIID, LPVOID*)        {return E_NOINTERFACE;}\r
 219         virtual ULONG STDMETHODCALLTYPE         AddRef ()                                                       {return 1;}\r
 220         virtual ULONG STDMETHODCALLTYPE         Release ()                                                      {return 1;}\r
 221         \r
 222         virtual HRESULT STDMETHODCALLTYPE ScheduledFrameCompleted (IDeckLinkVideoFrame* /*completedFrame*/, BMDOutputFrameCompletionResult /*result*/)\r
 223         {\r
 224                 if(!is_running_)\r
 225                         return S_OK;\r
 226 \r
 227                 std::shared_ptr<const core::read_frame> frame;  \r
 228                 video_frame_buffer_.pop(frame);         \r
 229                 schedule_next_video(safe_ptr<const core::read_frame>(frame));\r
 230 \r
 231                 return S_OK;\r
 232         }\r
 233 \r
 234         virtual HRESULT STDMETHODCALLTYPE ScheduledPlaybackHasStopped (void)\r
 235         {\r
 236                 return S_OK;\r
 237         }\r
 238                 \r
 239         virtual HRESULT STDMETHODCALLTYPE RenderAudioSamples (BOOL /*preroll*/)\r
 240         {\r
 241                 if(!is_running_)\r
 242                         return S_OK;\r
 243 \r
 244                 std::shared_ptr<const core::read_frame> frame;\r
 245                 audio_frame_buffer_.pop(frame);\r
 246                 schedule_next_audio(safe_ptr<const core::read_frame>(frame));\r
 247 \r
 248                 return S_OK;\r
 249         }\r
 250 \r
 251         void schedule_next_audio(const safe_ptr<const core::read_frame>& frame)\r
 252         {\r
 253                 static std::vector<short> silence(48000, 0);\r
 254 \r
 255                 int audio_samples = static_cast<size_t>(48000.0 / format_desc_.fps);\r
 256 \r
 257                 auto frame_audio_data = frame->audio_data().empty() ? silence.data() : const_cast<short*>(frame->audio_data().begin());\r
 258 \r
 259                 audio_container_.push_back(std::vector<short>(frame_audio_data, frame_audio_data+audio_samples*2));\r
 260 \r
 261                 if(FAILED(output_->ScheduleAudioSamples(audio_container_.back().data(), audio_samples, (audio_scheduled_++) * audio_samples, 48000, nullptr)))\r
 262                         CASPAR_LOG(error) << print() << L" Failed to schedule audio.";\r
 263         }\r
 264                         \r
 265         void schedule_next_video(const safe_ptr<const core::read_frame>& frame)\r
 266         {\r
 267                 if(!frame->image_data().empty())\r
 268                         std::copy(frame->image_data().begin(), frame->image_data().end(), static_cast<char*>(reserved_frames_.front().first));\r
 269                 else\r
 270                         std::fill_n(static_cast<int*>(reserved_frames_.front().first), 0, format_desc_.size/4);\r
 271 \r
 272                 if(FAILED(output_->ScheduleVideoFrame(reserved_frames_.front().second, (frames_scheduled_++) * frame_duration_, frame_duration_, frame_time_scale_)))\r
 273                         CASPAR_LOG(error) << print() << L" Failed to schedule video.";\r
 274 \r
 275                 std::rotate(reserved_frames_.begin(), reserved_frames_.begin() + 1, reserved_frames_.end());\r
 276                 graph_->update_value("tick-time", static_cast<float>(perf_timer_.elapsed()/format_desc_.interval*0.5));\r
 277                 perf_timer_.restart();\r
 278         }\r
 279 \r
 280         void send(const safe_ptr<const core::read_frame>& frame)\r
 281         {\r
 282                 video_frame_buffer_.push(frame);\r
 283                 if(embed_audio_)\r
 284                         audio_frame_buffer_.push(frame);\r
 285         }\r
 286 \r
 287         std::wstring print() const\r
 288         {\r
 289                 return model_name_ + L" [" + boost::lexical_cast<std::wstring>(device_index_) + L"]";\r
 290         }\r
 291 };\r
 292 \r
 293 struct decklink_consumer::implementation\r
 294 {\r
 295         std::unique_ptr<decklink_output> input_;\r
 296         size_t device_index_;\r
 297         bool embed_audio_;\r
 298         decklink_consumer::key key_;\r
 299 \r
 300         executor executor_;\r
 301 public:\r
 302 \r
 303         implementation(size_t device_index, bool embed_audio, decklink_consumer::key key)\r
 304                 : device_index_(device_index)\r
 305                 , embed_audio_(embed_audio)\r
 306                 , key_(key)\r
 307                 , executor_(L"DECKLINK[" + boost::lexical_cast<std::wstring>(device_index) + L"]")\r
 308         {\r
 309                 executor_.start();\r
 310         }\r
 311 \r
 312         ~implementation()\r
 313         {\r
 314                 executor_.invoke([&]\r
 315                 {\r
 316                         input_ = nullptr;\r
 317                 });\r
 318         }\r
 319 \r
 320         void initialize(const core::video_format_desc& format_desc)\r
 321         {\r
 322                 executor_.invoke([&]\r
 323                 {\r
 324                         input_.reset(new decklink_output(format_desc, device_index_, embed_audio_, key_));\r
 325                 });\r
 326         }\r
 327         \r
 328         void send(const safe_ptr<const core::read_frame>& frame)\r
 329         {\r
 330                 input_->send(frame);\r
 331         }\r
 332 \r
 333         size_t buffer_depth() const\r
 334         {\r
 335                 return 1;\r
 336         }\r
 337 \r
 338         std::wstring print() const\r
 339         {\r
 340                 return input_->print();\r
 341         }\r
 342 };\r
 343 \r
 344 decklink_consumer::decklink_consumer(size_t device_index, bool embed_audio, key key) : impl_(new implementation(device_index, embed_audio, key)){}\r
 345 decklink_consumer::decklink_consumer(decklink_consumer&& other) : impl_(std::move(other.impl_)){}\r
 346 void decklink_consumer::initialize(const core::video_format_desc& format_desc){impl_->initialize(format_desc);}\r
 347 void decklink_consumer::send(const safe_ptr<const core::read_frame>& frame){impl_->send(frame);}\r
 348 size_t decklink_consumer::buffer_depth() const{return impl_->buffer_depth();}\r
 349 std::wstring decklink_consumer::print() const{return impl_->print();}\r
 350         \r
 351 safe_ptr<core::frame_consumer> create_decklink_consumer(const std::vector<std::wstring>& params)\r
 352 {\r
 353         if(params.size() < 1 || params[0] != L"DECKLINK")\r
 354                 return core::frame_consumer::empty();\r
 355         \r
 356         int device_index = 1;\r
 357         bool embed_audio = false;\r
 358         auto key = decklink_consumer::default_key;\r
 359 \r
 360         if(params.size() > 1) \r
 361                 device_index = lexical_cast_or_default<int>(params[2], device_index);\r
 362 \r
 363         if(params.size() > 2)\r
 364                 embed_audio = lexical_cast_or_default<bool>(params[3], embed_audio);\r
 365         \r
 366 \r
 367         if(params.size() > 3) \r
 368         {\r
 369                 if(params[4] == L"INTERNAL_KEY")\r
 370                         key = decklink_consumer::internal_key;\r
 371                 else if(params[4] == L"EXTERNAL_KEY")\r
 372                         key = decklink_consumer::external_key;\r
 373         }\r
 374 \r
 375         return make_safe<decklink_consumer>(device_index, embed_audio, key);\r
 376 }\r
 377 \r
 378 }