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 \r
  42 #include <array>\r
  43 \r
  44 #pragma warning(push)\r
  45 #pragma warning(disable : 4996)\r
  46 \r
  47         #include <atlbase.h>\r
  48 \r
  49         #include <atlcom.h>\r
  50         #include <atlhost.h>\r
  51 \r
  52 #pragma warning(push)\r
  53 \r
  54 namespace caspar { \r
  55         \r
  56 struct decklink_output : public IDeckLinkVideoOutputCallback, public IDeckLinkAudioOutputCallback, boost::noncopyable\r
  57 {               \r
  58         struct co_init\r
  59         {\r
  60                 co_init(){CoInitialize(nullptr);}\r
  61                 ~co_init(){CoUninitialize();}\r
  62         } co_;\r
  63         \r
  64         const printer   parent_printer_;\r
  65         std::wstring    model_name_;\r
  66         const size_t    device_index_;\r
  67         tbb::atomic<bool> is_running_;\r
  68 \r
  69         std::shared_ptr<diagnostics::graph> graph_;\r
  70         timer perf_timer_;\r
  71 \r
  72         std::array<std::pair<void*, CComPtr<IDeckLinkMutableVideoFrame>>, 3> reserved_frames_;\r
  73         boost::circular_buffer<std::vector<short>> audio_container_;\r
  74         \r
  75         const bool              embed_audio_;\r
  76         const bool              internal_key;\r
  77 \r
  78         CComPtr<IDeckLink>                      decklink_;\r
  79         CComQIPtr<IDeckLinkOutput>      output_;\r
  80         CComQIPtr<IDeckLinkKeyer>       keyer_;\r
  81         \r
  82         core::video_format_desc format_desc_;\r
  83 \r
  84         BMDTimeScale frame_time_scale_;\r
  85         BMDTimeValue frame_duration_;\r
  86         unsigned long frames_scheduled_;\r
  87         unsigned long audio_scheduled_;\r
  88         \r
  89         tbb::concurrent_bounded_queue<safe_ptr<const core::read_frame>> video_frame_buffer_;\r
  90         tbb::concurrent_bounded_queue<safe_ptr<const core::read_frame>> audio_frame_buffer_;\r
  91 \r
  92 public:\r
  93         decklink_output(const core::video_format_desc& format_desc, const printer& parent_printer, size_t device_index, bool embed_audio, bool internalKey) \r
  94                 : parent_printer_(parent_printer)\r
  95                 , model_name_(L"DECKLINK")\r
  96                 , device_index_(device_index)\r
  97                 , audio_container_(5)\r
  98                 , embed_audio_(embed_audio)\r
  99                 , internal_key(internalKey)\r
 100                 , frames_scheduled_(0)\r
 101                 , audio_scheduled_(0)\r
 102                 , format_desc_(format_desc)\r
 103         {\r
 104                 is_running_ = true;\r
 105                 format_desc_ = format_desc;\r
 106                 CComPtr<IDeckLinkIterator> pDecklinkIterator;\r
 107                 if(FAILED(pDecklinkIterator.CoCreateInstance(CLSID_CDeckLinkIterator)))\r
 108                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " No Decklink drivers installed."));\r
 109                 \r
 110                 size_t n = 0;\r
 111                 while(n < device_index_ && pDecklinkIterator->Next(&decklink_) == S_OK){++n;}   \r
 112 \r
 113                 if(n != device_index_ || !decklink_)\r
 114                         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
 115 \r
 116                 output_ = decklink_;\r
 117                 keyer_ = decklink_;\r
 118 \r
 119                 BSTR pModelName;\r
 120                 decklink_->GetModelName(&pModelName);\r
 121                 model_name_ = std::wstring(pModelName);\r
 122                                 \r
 123                 graph_ = diagnostics::create_graph(narrow(print()));\r
 124                 graph_->add_guide("tick-time", 0.5);\r
 125                 graph_->set_color("tick-time", diagnostics::color(0.1f, 0.7f, 0.8f));\r
 126                 \r
 127                 auto display_mode = get_display_mode(output_.p, format_desc_.format);\r
 128                 if(display_mode == nullptr) \r
 129                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Card does not support requested videoformat."));\r
 130                 \r
 131                 display_mode->GetFrameRate(&frame_duration_, &frame_time_scale_);\r
 132 \r
 133                 BMDDisplayModeSupport displayModeSupport;\r
 134                 if(FAILED(output_->DoesSupportVideoMode(display_mode->GetDisplayMode(), bmdFormat8BitBGRA, bmdVideoOutputFlagDefault, &displayModeSupport, nullptr)))\r
 135                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Card does not support requested videoformat."));\r
 136                 \r
 137                 if(embed_audio_)\r
 138                 {\r
 139                         if(FAILED(output_->EnableAudioOutput(bmdAudioSampleRate48kHz, bmdAudioSampleType16bitInteger, 2, bmdAudioOutputStreamTimestamped)))\r
 140                                 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Could not enable audio output."));\r
 141                                 \r
 142                         if(FAILED(output_->SetAudioCallback(this)))\r
 143                                 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Could not set audio callback."));\r
 144 \r
 145                         CASPAR_LOG(info) << print() << L" Enabled embedded-audio.";\r
 146                 }\r
 147 \r
 148                 if(FAILED(output_->EnableVideoOutput(display_mode->GetDisplayMode(), bmdVideoOutputFlagDefault))) \r
 149                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Could not enable video output."));\r
 150 \r
 151                 if(FAILED(output_->SetScheduledFrameCompletionCallback(this)))\r
 152                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to set playback completion callback."));\r
 153                         \r
 154                 if(internal_key) \r
 155                 {\r
 156                         if(FAILED(keyer_->Enable(FALSE)))                       \r
 157                                 CASPAR_LOG(error) << print() << L" Failed to enable internal keyer.";                   \r
 158                         else if(FAILED(keyer_->SetLevel(255)))                  \r
 159                                 CASPAR_LOG(error) << print() << L" Failed to set key-level to max.";\r
 160                         else\r
 161                                 CASPAR_LOG(info) << print() << L" Successfully configured internal keyer.";             \r
 162                 }\r
 163                 else\r
 164                 {\r
 165                         if(FAILED(keyer_->Enable(TRUE)))                        \r
 166                                 CASPAR_LOG(error) << print() << L" Failed to enable external keyer.";   \r
 167                         else\r
 168                                 CASPAR_LOG(info) << print() << L" Successfully configured external keyer.";                     \r
 169                 }\r
 170                 \r
 171                 for(size_t n = 0; n < reserved_frames_.size(); ++n)\r
 172                 {\r
 173                         if(FAILED(output_->CreateVideoFrame(format_desc_.width, format_desc_.height, format_desc_.size/format_desc_.height, bmdFormat8BitBGRA, bmdFrameFlagDefault, &reserved_frames_[n].second)))\r
 174                                 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to create frame."));\r
 175 \r
 176                         if(FAILED(reserved_frames_[n].second->GetBytes(&reserved_frames_[n].first)))\r
 177                                 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to get frame bytes."));\r
 178                 }\r
 179                                         \r
 180                 auto buffer_size = static_cast<size_t>(frame_time_scale_/frame_duration_)/4;\r
 181                 for(size_t n = 0; n < buffer_size; ++n)\r
 182                         schedule_next_video(core::read_frame::empty());\r
 183 \r
 184                 video_frame_buffer_.set_capacity(buffer_size);\r
 185                 audio_frame_buffer_.set_capacity(buffer_size);\r
 186                 for(size_t n = 0; n < std::max<size_t>(2, buffer_size-2); ++n)\r
 187                 {\r
 188                         video_frame_buffer_.try_push(safe_ptr<const core::read_frame>());\r
 189                         if(embed_audio_)\r
 190                                 audio_frame_buffer_.try_push(safe_ptr<const core::read_frame>());\r
 191                 }\r
 192                 \r
 193                 if(FAILED(output_->StartScheduledPlayback(0, frame_time_scale_, 1.0))) \r
 194                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to schedule playback."));\r
 195                 \r
 196                 CASPAR_LOG(info) << print() << L" Successfully initialized for " << format_desc_.name;  \r
 197         }\r
 198 \r
 199         ~decklink_output()\r
 200         {               \r
 201                 is_running_ = false;\r
 202                 video_frame_buffer_.try_push(core::read_frame::empty());\r
 203                 audio_frame_buffer_.try_push(core::read_frame::empty());\r
 204 \r
 205                 if(output_ != nullptr) \r
 206                 {\r
 207                         output_->StopScheduledPlayback(0, nullptr, 0);\r
 208                         if(embed_audio_)\r
 209                                 output_->DisableAudioOutput();\r
 210                         output_->DisableVideoOutput();\r
 211                 }\r
 212                 CASPAR_LOG(info) << print() << L" Shutting down.";      \r
 213         }\r
 214                         \r
 215         virtual HRESULT STDMETHODCALLTYPE       QueryInterface (REFIID, LPVOID*)        {return E_NOINTERFACE;}\r
 216         virtual ULONG STDMETHODCALLTYPE         AddRef ()                                                       {return 1;}\r
 217         virtual ULONG STDMETHODCALLTYPE         Release ()                                                      {return 1;}\r
 218         \r
 219         virtual HRESULT STDMETHODCALLTYPE ScheduledFrameCompleted (IDeckLinkVideoFrame* /*completedFrame*/, BMDOutputFrameCompletionResult /*result*/)\r
 220         {\r
 221                 if(!is_running_)\r
 222                         return S_OK;\r
 223 \r
 224                 safe_ptr<const core::read_frame> frame;         \r
 225                 video_frame_buffer_.pop(frame);         \r
 226                 schedule_next_video(frame);\r
 227 \r
 228                 return S_OK;\r
 229         }\r
 230 \r
 231         virtual HRESULT STDMETHODCALLTYPE ScheduledPlaybackHasStopped (void)\r
 232         {\r
 233                 return S_OK;\r
 234         }\r
 235                 \r
 236         virtual HRESULT STDMETHODCALLTYPE RenderAudioSamples (BOOL /*preroll*/)\r
 237         {\r
 238                 if(!is_running_)\r
 239                         return S_OK;\r
 240 \r
 241                 safe_ptr<const core::read_frame> frame;\r
 242                 audio_frame_buffer_.pop(frame);\r
 243                 schedule_next_audio(frame);\r
 244 \r
 245                 return S_OK;\r
 246         }\r
 247 \r
 248         void schedule_next_audio(const safe_ptr<const core::read_frame>& frame)\r
 249         {\r
 250                 static std::vector<short> silence(48000, 0);\r
 251 \r
 252                 int audio_samples = static_cast<size_t>(48000.0 / format_desc_.fps);\r
 253 \r
 254                 auto frame_audio_data = frame->audio_data().empty() ? silence.data() : const_cast<short*>(frame->audio_data().begin());\r
 255 \r
 256                 audio_container_.push_back(std::vector<short>(frame_audio_data, frame_audio_data+audio_samples*2));\r
 257 \r
 258                 if(FAILED(output_->ScheduleAudioSamples(audio_container_.back().data(), audio_samples, (audio_scheduled_++) * audio_samples, 48000, nullptr)))\r
 259                         CASPAR_LOG(error) << print() << L" Failed to schedule audio.";\r
 260         }\r
 261                         \r
 262         void schedule_next_video(const safe_ptr<const core::read_frame>& frame)\r
 263         {\r
 264                 if(!frame->image_data().empty())\r
 265                         std::copy(frame->image_data().begin(), frame->image_data().end(), static_cast<char*>(reserved_frames_.front().first));\r
 266                 else\r
 267                         std::fill_n(static_cast<int*>(reserved_frames_.front().first), 0, format_desc_.size/4);\r
 268 \r
 269                 if(FAILED(output_->ScheduleVideoFrame(reserved_frames_.front().second, (frames_scheduled_++) * frame_duration_, frame_duration_, frame_time_scale_)))\r
 270                         CASPAR_LOG(error) << print() << L" Failed to schedule video.";\r
 271 \r
 272                 std::rotate(reserved_frames_.begin(), reserved_frames_.begin() + 1, reserved_frames_.end());\r
 273                 graph_->update_value("tick-time", static_cast<float>(perf_timer_.elapsed()/format_desc_.interval*0.5));\r
 274                 perf_timer_.reset();\r
 275         }\r
 276 \r
 277         void send(const safe_ptr<const core::read_frame>& frame)\r
 278         {\r
 279                 video_frame_buffer_.push(frame);\r
 280                 if(embed_audio_)\r
 281                         audio_frame_buffer_.push(frame);\r
 282         }\r
 283 \r
 284         std::wstring print() const\r
 285         {\r
 286                 return (parent_printer_ ? parent_printer_() + L"/" : L"") + model_name_ + L" [" + boost::lexical_cast<std::wstring>(device_index_) + L"]";\r
 287         }\r
 288 };\r
 289 \r
 290 struct decklink_consumer::implementation\r
 291 {\r
 292         std::unique_ptr<decklink_output> input_;\r
 293         size_t device_index_;\r
 294         bool embed_audio_;\r
 295         bool internal_key_;\r
 296 \r
 297         executor executor_;\r
 298 public:\r
 299 \r
 300         implementation(size_t device_index, bool embed_audio, bool internal_key)\r
 301                 : device_index_(device_index)\r
 302                 , embed_audio_(embed_audio)\r
 303                 , internal_key_(internal_key)\r
 304                 , executor_(L"DECKLINK[" + boost::lexical_cast<std::wstring>(device_index) + L"]")\r
 305         {\r
 306                 executor_.start();\r
 307         }\r
 308 \r
 309         ~implementation()\r
 310         {\r
 311                 executor_.invoke([&]\r
 312                 {\r
 313                         input_ = nullptr;\r
 314                 });\r
 315         }\r
 316 \r
 317         void initialize(const core::video_format_desc& format_desc, const printer& parent_printer)\r
 318         {\r
 319                 executor_.invoke([&]\r
 320                 {\r
 321                         input_.reset(new decklink_output(format_desc, parent_printer, device_index_, embed_audio_, internal_key_));\r
 322                 });\r
 323         }\r
 324         \r
 325         void send(const safe_ptr<const core::read_frame>& frame)\r
 326         {\r
 327                 input_->send(frame);\r
 328         }\r
 329 \r
 330         size_t buffer_depth() const\r
 331         {\r
 332                 return 1;\r
 333         }\r
 334 \r
 335         std::wstring print() const\r
 336         {\r
 337                 return input_->print();\r
 338         }\r
 339 };\r
 340 \r
 341 decklink_consumer::decklink_consumer(size_t device_index, bool embed_audio, bool internalKey) : impl_(new implementation(device_index, embed_audio, internalKey)){}\r
 342 decklink_consumer::decklink_consumer(decklink_consumer&& other) : impl_(std::move(other.impl_)){}\r
 343 void decklink_consumer::initialize(const core::video_format_desc& format_desc, const printer& parent_printer){impl_->initialize(format_desc, parent_printer);}\r
 344 void decklink_consumer::send(const safe_ptr<const core::read_frame>& frame){impl_->send(frame);}\r
 345 size_t decklink_consumer::buffer_depth() const{return impl_->buffer_depth();}\r
 346 std::wstring decklink_consumer::print() const{return impl_->print();}\r
 347         \r
 348 safe_ptr<core::frame_consumer> create_decklink_consumer(const std::vector<std::wstring>& params)\r
 349 {\r
 350         if(params.size() < 1 || params[0] != L"DECKLINK")\r
 351                 return core::frame_consumer::empty();\r
 352         \r
 353         int device_index = 1;\r
 354         bool embed_audio = false;\r
 355         bool internal_key = false;\r
 356 \r
 357         if(params.size() > 1) \r
 358                 device_index = lexical_cast_or_default<int>(params[2], device_index);\r
 359 \r
 360         if(params.size() > 2)\r
 361                 embed_audio = lexical_cast_or_default<bool>(params[3], embed_audio);\r
 362         \r
 363         if(params.size() > 3) \r
 364                 internal_key = lexical_cast_or_default<bool>(params[4], internal_key);\r
 365 \r
 366         return make_safe<decklink_consumer>(device_index, embed_audio, internal_key);\r
 367 }\r
 368 \r
 369 }