git.sesse.net Git - casparcg/blob - core/consumer/frame_consumer.cpp

   1 /*\r
   2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>\r
   3 *\r
   4 * This file is part of CasparCG (www.casparcg.com).\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 * Author: Robert Nagy, ronag89@gmail.com\r
  20 */\r
  21 \r
  22 #include "../StdAfx.h"\r
  23 \r
  24 #include "frame_consumer.h"\r
  25 \r
  26 #include <common/env.h>\r
  27 #include <common/memory/safe_ptr.h>\r
  28 #include <common/exception/exceptions.h>\r
  29 #include <common/concurrency/future_util.h>\r
  30 #include <core/video_format.h>\r
  31 #include <core/mixer/read_frame.h>\r
  32 \r
  33 #include <boost/circular_buffer.hpp>\r
  34 \r
  35 namespace caspar { namespace core {\r
  36                 \r
  37 std::vector<const consumer_factory_t> g_factories;\r
  38 \r
  39 void register_consumer_factory(const consumer_factory_t& factory)\r
  40 {\r
  41         g_factories.push_back(factory);\r
  42 }\r
  43 \r
  44 safe_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params)\r
  45 {\r
  46         if(params.empty())\r
  47                 BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("params") << arg_value_info(""));\r
  48         \r
  49         auto consumer = frame_consumer::empty();\r
  50         std::any_of(g_factories.begin(), g_factories.end(), [&](const consumer_factory_t& factory) -> bool\r
  51                 {\r
  52                         try\r
  53                         {\r
  54                                 consumer = factory(params);\r
  55                         }\r
  56                         catch(...)\r
  57                         {\r
  58                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
  59                         }\r
  60                         return consumer != frame_consumer::empty();\r
  61                 });\r
  62 \r
  63         if(consumer == frame_consumer::empty())\r
  64                 BOOST_THROW_EXCEPTION(file_not_found() << msg_info("No match found for supplied commands. Check syntax."));\r
  65 \r
  66         return consumer;\r
  67 }\r
  68 \r
  69 // This class is used to guarantee that audio cadence is correct. This is important for NTSC audio.\r
  70 class cadence_guard : public frame_consumer\r
  71 {\r
  72         safe_ptr<frame_consumer>                consumer_;\r
  73         std::vector<size_t>                             audio_cadence_;\r
  74         boost::circular_buffer<size_t>  sync_buffer_;\r
  75 public:\r
  76         cadence_guard(const safe_ptr<frame_consumer>& consumer)\r
  77                 : consumer_(consumer)\r
  78         {\r
  79         }\r
  80         \r
  81         virtual void initialize(const video_format_desc& format_desc, int channel_index) override\r
  82         {\r
  83                 audio_cadence_  = format_desc.audio_cadence;\r
  84                 sync_buffer_    = boost::circular_buffer<size_t>(format_desc.audio_cadence.size());\r
  85                 consumer_->initialize(format_desc, channel_index);\r
  86         }\r
  87 \r
  88         virtual boost::unique_future<bool> send(const safe_ptr<read_frame>& frame) override\r
  89         {               \r
  90                 if(audio_cadence_.size() == 1)\r
  91                         return consumer_->send(frame);\r
  92 \r
  93                 boost::unique_future<bool> result = caspar::wrap_as_future(true);\r
  94                 \r
  95                 if(boost::range::equal(sync_buffer_, audio_cadence_) && audio_cadence_.front() == static_cast<size_t>(frame->audio_data().size())) \r
  96                 {       \r
  97                         // Audio sent so far is in sync, now we can send the next chunk.\r
  98                         result = consumer_->send(frame);\r
  99                         boost::range::rotate(audio_cadence_, std::begin(audio_cadence_)+1);\r
 100                 }\r
 101                 else\r
 102                         CASPAR_LOG(trace) << print() << L" Syncing audio.";\r
 103 \r
 104                 sync_buffer_.push_back(static_cast<size_t>(frame->audio_data().size()));\r
 105                 \r
 106                 return std::move(result);\r
 107         }\r
 108 \r
 109         virtual std::wstring print() const override\r
 110         {\r
 111                 return consumer_->print();\r
 112         }\r
 113 \r
 114         virtual boost::property_tree::wptree info() const override\r
 115         {\r
 116                 return consumer_->info();\r
 117         }\r
 118 \r
 119         virtual bool has_synchronization_clock() const override\r
 120         {\r
 121                 return consumer_->has_synchronization_clock();\r
 122         }\r
 123 \r
 124         virtual size_t buffer_depth() const override\r
 125         {\r
 126                 return consumer_->buffer_depth();\r
 127         }\r
 128 \r
 129         virtual int index() const override\r
 130         {\r
 131                 return consumer_->index();\r
 132         }\r
 133 };\r
 134 \r
 135 safe_ptr<frame_consumer> create_consumer_cadence_guard(const safe_ptr<frame_consumer>& consumer)\r
 136 {\r
 137         return make_safe<cadence_guard>(std::move(consumer));\r
 138 }\r
 139 \r
 140 const safe_ptr<frame_consumer>& frame_consumer::empty()\r
 141 {\r
 142         struct empty_frame_consumer : public frame_consumer\r
 143         {\r
 144                 virtual boost::unique_future<bool> send(const safe_ptr<read_frame>&) override { return caspar::wrap_as_future(false); }\r
 145                 virtual void initialize(const video_format_desc&, int) override{}\r
 146                 virtual std::wstring print() const override {return L"empty";}\r
 147                 virtual bool has_synchronization_clock() const override {return false;}\r
 148                 virtual size_t buffer_depth() const override {return 0;};\r
 149                 virtual int index() const{return -1;}\r
 150                 virtual boost::property_tree::wptree info() const override\r
 151                 {\r
 152                         boost::property_tree::wptree info;\r
 153                         info.add(L"type", L"empty-consumer");\r
 154                         return info;\r
 155                 }\r
 156         };\r
 157         static safe_ptr<frame_consumer> consumer = make_safe<empty_frame_consumer>();\r
 158         return consumer;\r
 159 }\r
 160 \r
 161 }}