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_producer.h"
26 #include "../frame/draw_frame.h"
27 #include "../frame/frame_transform.h"
29 #include "color/color_producer.h"
30 #include "draw/freehand_producer.h"
31 #include "separated/separated_producer.h"
34 #include <common/assert.h>
35 #include <common/except.h>
36 #include <common/executor.h>
37 #include <common/future.h>
38 #include <common/memory.h>
40 #include <boost/thread.hpp>
42 namespace caspar { namespace core {
44 std::vector<producer_factory_t> g_producer_factories;
45 std::vector<producer_factory_t> g_thumbnail_factories;
47 void register_producer_factory(const producer_factory_t& factory)
49 g_producer_factories.push_back(factory);
51 void register_thumbnail_producer_factory(const producer_factory_t& factory)
53 g_thumbnail_factories.push_back(factory);
56 constraints::constraints(double width, double height)
57 : width(width), height(height)
61 constraints::constraints()
65 struct frame_producer_base::impl
67 tbb::atomic<uint32_t> frame_number_;
68 tbb::atomic<bool> paused_;
69 frame_producer_base& self_;
70 draw_frame last_frame_;
72 impl(frame_producer_base& self)
74 , last_frame_(draw_frame::empty())
83 return self_.last_frame();
85 auto frame = self_.receive_impl();
86 if(frame == draw_frame::late())
87 return self_.last_frame();
91 return last_frame_ = draw_frame::push(frame);
94 void paused(bool value)
99 draw_frame last_frame()
101 return draw_frame::still(last_frame_);
103 draw_frame create_thumbnail_frame()
105 return draw_frame::empty();
109 frame_producer_base::frame_producer_base() : impl_(new impl(*this))
113 draw_frame frame_producer_base::receive()
115 return impl_->receive();
118 void frame_producer_base::paused(bool value)
120 impl_->paused(value);
123 draw_frame frame_producer_base::last_frame()
125 return impl_->last_frame();
127 draw_frame frame_producer_base::create_thumbnail_frame()
129 return impl_->create_thumbnail_frame();
132 std::future<std::wstring> frame_producer_base::call(const std::vector<std::wstring>&)
134 CASPAR_THROW_EXCEPTION(not_supported());
137 uint32_t frame_producer_base::nb_frames() const
139 return std::numeric_limits<uint32_t>::max();
142 uint32_t frame_producer_base::frame_number() const
144 return impl_->frame_number_;
147 variable& frame_producer_base::get_variable(const std::wstring& name)
149 CASPAR_THROW_EXCEPTION(caspar_exception()
150 << msg_info(L"No variable called " + name + L" found in " + print()));
153 const std::vector<std::wstring>& frame_producer_base::get_variables() const
155 static std::vector<std::wstring> empty;
160 const spl::shared_ptr<frame_producer>& frame_producer::empty()
162 class empty_frame_producer : public frame_producer
165 empty_frame_producer(){}
166 draw_frame receive() override{return draw_frame::empty();}
167 void paused(bool value) override{}
168 uint32_t nb_frames() const override {return 0;}
169 std::wstring print() const override { return L"empty";}
170 monitor::subject& monitor_output() override {static monitor::subject monitor_subject(""); return monitor_subject;}
171 std::wstring name() const override {return L"empty";}
172 uint32_t frame_number() const override {return 0;}
173 std::future<std::wstring> call(const std::vector<std::wstring>& params) override{CASPAR_THROW_EXCEPTION(not_supported());}
174 variable& get_variable(const std::wstring& name) override { CASPAR_THROW_EXCEPTION(not_supported()); }
175 const std::vector<std::wstring>& get_variables() const override { static std::vector<std::wstring> empty; return empty; }
176 draw_frame last_frame() {return draw_frame::empty();}
177 draw_frame create_thumbnail_frame() {return draw_frame::empty();}
178 constraints& pixel_constraints() override { static constraints c; return c; }
180 boost::property_tree::wptree info() const override
182 boost::property_tree::wptree info;
183 info.add(L"type", L"empty-producer");
188 static spl::shared_ptr<frame_producer> producer = spl::make_shared<empty_frame_producer>();
192 class destroy_producer_proxy : public frame_producer
194 std::shared_ptr<frame_producer> producer_;
196 destroy_producer_proxy(spl::shared_ptr<frame_producer>&& producer)
197 : producer_(std::move(producer))
201 virtual ~destroy_producer_proxy()
203 static tbb::atomic<int> counter;
204 static std::once_flag counter_init_once;
205 std::call_once(counter_init_once, []{ counter = 0; });
207 if(producer_ == core::frame_producer::empty())
211 CASPAR_VERIFY(counter < 8);
213 auto producer = new spl::shared_ptr<frame_producer>(std::move(producer_));
216 std::unique_ptr<spl::shared_ptr<frame_producer>> pointer_guard(producer);
217 auto str = (*producer)->print();
220 if(!producer->unique())
221 CASPAR_LOG(trace) << str << L" Not destroyed on asynchronous destruction thread: " << producer->use_count();
223 CASPAR_LOG(trace) << str << L" Destroying on asynchronous destruction thread.";
229 pointer_guard.reset();
230 CASPAR_LOG(info) << str << L" Destroyed.";
234 CASPAR_LOG_CURRENT_EXCEPTION();
241 draw_frame receive() override {return producer_->receive();}
242 std::wstring print() const override {return producer_->print();}
243 void paused(bool value) override {producer_->paused(value);}
244 std::wstring name() const override {return producer_->name();}
245 uint32_t frame_number() const override {return producer_->frame_number();}
246 boost::property_tree::wptree info() const override {return producer_->info();}
247 std::future<std::wstring> call(const std::vector<std::wstring>& params) override {return producer_->call(params);}
248 variable& get_variable(const std::wstring& name) override {return producer_->get_variable(name);}
249 const std::vector<std::wstring>& get_variables() const override {return producer_->get_variables();}
250 void leading_producer(const spl::shared_ptr<frame_producer>& producer) override {return producer_->leading_producer(producer);}
251 uint32_t nb_frames() const override {return producer_->nb_frames();}
252 class draw_frame last_frame() {return producer_->last_frame();}
253 draw_frame create_thumbnail_frame() {return producer_->create_thumbnail_frame();}
254 monitor::subject& monitor_output() override {return producer_->monitor_output();}
255 bool collides(double x, double y) const override {return producer_->collides(x, y);}
256 void on_interaction(const interaction_event::ptr& event) override {return producer_->on_interaction(event);}
257 constraints& pixel_constraints() override {return producer_->pixel_constraints();}
260 spl::shared_ptr<core::frame_producer> create_destroy_proxy(spl::shared_ptr<core::frame_producer> producer)
262 return spl::make_shared<destroy_producer_proxy>(std::move(producer));
265 spl::shared_ptr<core::frame_producer> do_create_producer(const spl::shared_ptr<frame_factory>& my_frame_factory, const video_format_desc& format_desc, const std::vector<std::wstring>& params, const std::vector<producer_factory_t>& factories, bool throw_on_fail = false)
268 CASPAR_THROW_EXCEPTION(invalid_argument() << arg_name_info("params") << arg_value_info(""));
270 auto producer = frame_producer::empty();
271 std::any_of(factories.begin(), factories.end(), [&](const producer_factory_t& factory) -> bool
275 producer = factory(my_frame_factory, format_desc, params);
282 CASPAR_LOG_CURRENT_EXCEPTION();
284 return producer != frame_producer::empty();
287 if(producer == frame_producer::empty())
288 producer = create_color_producer(my_frame_factory, params);
290 if (producer == frame_producer::empty())
291 producer = create_freehand_producer(my_frame_factory, params);
293 if(producer == frame_producer::empty())
299 spl::shared_ptr<core::frame_producer> create_thumbnail_producer(const spl::shared_ptr<frame_factory>& my_frame_factory, const video_format_desc& format_desc, const std::wstring& media_file)
301 std::vector<std::wstring> params;
302 params.push_back(media_file);
304 auto producer = do_create_producer(my_frame_factory, format_desc, params, g_thumbnail_factories, true);
305 auto key_producer = frame_producer::empty();
307 try // to find a key file.
309 auto params_copy = params;
310 if (params_copy.size() > 0)
312 params_copy[0] += L"_A";
313 key_producer = do_create_producer(my_frame_factory, format_desc, params_copy, g_thumbnail_factories, true);
314 if (key_producer == frame_producer::empty())
316 params_copy[0] += L"LPHA";
317 key_producer = do_create_producer(my_frame_factory, format_desc, params_copy, g_thumbnail_factories, true);
323 if (producer != frame_producer::empty() && key_producer != frame_producer::empty())
324 return create_separated_producer(producer, key_producer);
329 spl::shared_ptr<core::frame_producer> create_producer(const spl::shared_ptr<frame_factory>& my_frame_factory, const video_format_desc& format_desc, const std::vector<std::wstring>& params)
331 auto producer = do_create_producer(my_frame_factory, format_desc, params, g_producer_factories);
332 auto key_producer = frame_producer::empty();
334 try // to find a key file.
336 auto params_copy = params;
337 if(params_copy.size() > 0)
339 params_copy[0] += L"_A";
340 key_producer = do_create_producer(my_frame_factory, format_desc, params_copy, g_producer_factories);
341 if(key_producer == frame_producer::empty())
343 params_copy[0] += L"LPHA";
344 key_producer = do_create_producer(my_frame_factory, format_desc, params_copy, g_producer_factories);
350 if(producer != frame_producer::empty() && key_producer != frame_producer::empty())
351 return create_separated_producer(producer, key_producer);
353 if(producer == frame_producer::empty())
356 for (auto& param : params)
358 CASPAR_THROW_EXCEPTION(file_not_found() << msg_info("No match found for supplied commands. Check syntax.") << arg_value_info(u8(str)));
365 spl::shared_ptr<core::frame_producer> create_producer(const spl::shared_ptr<frame_factory>& factory, const video_format_desc& format_desc, const std::wstring& params)
367 std::wstringstream iss(params);
368 std::vector<std::wstring> tokens;
369 typedef std::istream_iterator<std::wstring, wchar_t, std::char_traits<wchar_t> > iterator;
370 std::copy(iterator(iss), iterator(), std::back_inserter(tokens));
371 return create_producer(factory, format_desc, tokens);