2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
4 * This file is part of CasparCG (www.casparcg.com).
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.
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.
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/>.
19 * Author: Robert Nagy, ronag89@gmail.com
22 #include "../StdAfx.h"
24 #include "frame_consumer.h"
26 #include <common/except.h>
27 #include <common/future.h>
29 #include <core/video_format.h>
30 #include <core/frame/frame.h>
32 #include <boost/thread.hpp>
34 namespace caspar { namespace core {
36 std::vector<const consumer_factory_t> g_factories;
38 void register_consumer_factory(const consumer_factory_t& factory)
40 g_factories.push_back(factory);
43 class destroy_consumer_proxy : public frame_consumer
45 std::shared_ptr<frame_consumer> consumer_;
47 destroy_consumer_proxy(spl::shared_ptr<frame_consumer>&& consumer)
48 : consumer_(std::move(consumer))
52 ~destroy_consumer_proxy()
54 static tbb::atomic<int> counter = tbb::atomic<int>();
57 CASPAR_VERIFY(counter < 8);
59 auto consumer = new std::shared_ptr<frame_consumer>(std::move(consumer_));
62 std::unique_ptr<std::shared_ptr<frame_consumer>> pointer_guard(consumer);
64 auto str = (*consumer)->print();
67 if(!consumer->unique())
68 CASPAR_LOG(trace) << str << L" Not destroyed on asynchronous destruction thread: " << consumer->use_count();
70 CASPAR_LOG(trace) << str << L" Destroying on asynchronous destruction thread.";
74 pointer_guard.reset();
80 boost::unique_future<bool> send(const_frame frame) override {return consumer_->send(std::move(frame));}
81 virtual void initialize(const struct video_format_desc& format_desc, int channel_index) override {return consumer_->initialize(format_desc, channel_index);}
82 std::wstring print() const override {return consumer_->print();}
83 std::wstring name() const override {return consumer_->name();}
84 boost::property_tree::wptree info() const override {return consumer_->info();}
85 bool has_synchronization_clock() const override {return consumer_->has_synchronization_clock();}
86 int buffer_depth() const override {return consumer_->buffer_depth();}
87 int index() const override {return consumer_->index();}
88 monitor::subject& monitor_output() override {return consumer_->monitor_output();}
91 class print_consumer_proxy : public frame_consumer
93 std::shared_ptr<frame_consumer> consumer_;
95 print_consumer_proxy(spl::shared_ptr<frame_consumer>&& consumer)
96 : consumer_(std::move(consumer))
98 CASPAR_LOG(info) << consumer_->print() << L" Initialized.";
101 ~print_consumer_proxy()
103 auto str = consumer_->print();
104 CASPAR_LOG(trace) << str << L" Uninitializing.";
106 CASPAR_LOG(info) << str << L" Uninitialized.";
109 boost::unique_future<bool> send(const_frame frame) override {return consumer_->send(std::move(frame));}
110 virtual void initialize(const struct video_format_desc& format_desc, int channel_index) override {return consumer_->initialize(format_desc, channel_index);}
111 std::wstring print() const override {return consumer_->print();}
112 std::wstring name() const override {return consumer_->name();}
113 boost::property_tree::wptree info() const override {return consumer_->info();}
114 bool has_synchronization_clock() const override {return consumer_->has_synchronization_clock();}
115 int buffer_depth() const override {return consumer_->buffer_depth();}
116 int index() const override {return consumer_->index();}
117 monitor::subject& monitor_output() override {return consumer_->monitor_output();}
120 class recover_consumer_proxy : public frame_consumer
122 std::shared_ptr<frame_consumer> consumer_;
124 video_format_desc format_desc_;
126 recover_consumer_proxy(spl::shared_ptr<frame_consumer>&& consumer)
127 : consumer_(std::move(consumer))
131 virtual boost::unique_future<bool> send(const_frame frame)
135 return consumer_->send(frame);
139 CASPAR_LOG_CURRENT_EXCEPTION();
142 consumer_->initialize(format_desc_, channel_index_);
143 return consumer_->send(frame);
147 CASPAR_LOG_CURRENT_EXCEPTION();
148 CASPAR_LOG(error) << print() << " Failed to recover consumer.";
149 return wrap_as_future(false);
154 virtual void initialize(const struct video_format_desc& format_desc, int channel_index)
156 format_desc_ = format_desc;
157 channel_index_ = channel_index;
158 return consumer_->initialize(format_desc, channel_index);
161 std::wstring print() const override {return consumer_->print();}
162 std::wstring name() const override {return consumer_->name();}
163 boost::property_tree::wptree info() const override {return consumer_->info();}
164 bool has_synchronization_clock() const override {return consumer_->has_synchronization_clock();}
165 int buffer_depth() const override {return consumer_->buffer_depth();}
166 int index() const override {return consumer_->index();}
167 monitor::subject& monitor_output() override {return consumer_->monitor_output();}
170 // This class is used to guarantee that audio cadence is correct. This is important for NTSC audio.
171 class cadence_guard : public frame_consumer
173 spl::shared_ptr<frame_consumer> consumer_;
174 std::vector<int> audio_cadence_;
175 video_format_desc format_desc_;
176 boost::circular_buffer<std::size_t> sync_buffer_;
178 cadence_guard(const spl::shared_ptr<frame_consumer>& consumer)
179 : consumer_(consumer)
183 void initialize(const video_format_desc& format_desc, int channel_index) override
185 audio_cadence_ = format_desc.audio_cadence;
186 sync_buffer_ = boost::circular_buffer<std::size_t>(format_desc.audio_cadence.size());
187 format_desc_ = format_desc;
188 consumer_->initialize(format_desc, channel_index);
191 boost::unique_future<bool> send(const_frame frame) override
193 if(audio_cadence_.size() == 1)
194 return consumer_->send(frame);
196 boost::unique_future<bool> result = wrap_as_future(true);
198 if(boost::range::equal(sync_buffer_, audio_cadence_) && audio_cadence_.front() * format_desc_.audio_channels == static_cast<int>(frame.audio_data().size()))
200 // Audio sent so far is in sync, now we can send the next chunk.
201 result = consumer_->send(frame);
202 boost::range::rotate(audio_cadence_, std::begin(audio_cadence_)+1);
205 CASPAR_LOG(trace) << print() << L" Syncing audio.";
207 sync_buffer_.push_back(static_cast<int>(frame.audio_data().size() / format_desc_.audio_channels));
209 return std::move(result);
212 std::wstring print() const override {return consumer_->print();}
213 std::wstring name() const override {return consumer_->name();}
214 boost::property_tree::wptree info() const override {return consumer_->info();}
215 bool has_synchronization_clock() const override {return consumer_->has_synchronization_clock();}
216 int buffer_depth() const override {return consumer_->buffer_depth();}
217 int index() const override {return consumer_->index();}
218 monitor::subject& monitor_output() override {return consumer_->monitor_output();}
221 spl::shared_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params)
224 CASPAR_THROW_EXCEPTION(invalid_argument() << arg_name_info("params") << arg_value_info(""));
226 auto consumer = frame_consumer::empty();
227 std::any_of(g_factories.begin(), g_factories.end(), [&](const consumer_factory_t& factory) -> bool
231 consumer = factory(params);
235 CASPAR_LOG_CURRENT_EXCEPTION();
237 return consumer != frame_consumer::empty();
240 if(consumer == frame_consumer::empty())
241 CASPAR_THROW_EXCEPTION(file_not_found() << msg_info("No match found for supplied commands. Check syntax."));
243 return spl::make_shared<destroy_consumer_proxy>(
244 spl::make_shared<print_consumer_proxy>(
245 spl::make_shared<recover_consumer_proxy>(
246 spl::make_shared<cadence_guard>(
247 std::move(consumer)))));
250 const spl::shared_ptr<frame_consumer>& frame_consumer::empty()
252 class empty_frame_consumer : public frame_consumer
255 boost::unique_future<bool> send(const_frame) override {return wrap_as_future(false);}
256 void initialize(const video_format_desc&, int) override{}
257 std::wstring print() const override {return L"empty";}
258 std::wstring name() const override {return L"empty";}
259 bool has_synchronization_clock() const override {return false;}
260 int buffer_depth() const override {return 0;};
261 virtual int index() const{return -1;}
262 monitor::subject& monitor_output() override {static monitor::subject monitor_subject(""); return monitor_subject;}
263 boost::property_tree::wptree info() const override
265 boost::property_tree::wptree info;
266 info.add(L"type", L"empty");
270 static spl::shared_ptr<frame_consumer> consumer = spl::make_shared<empty_frame_consumer>();