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: Helge Norberg, helge.norberg@svt.se
22 #include "../StdAfx.h"
26 #include "frame_producer.h"
28 #include "../video_channel.h"
29 #include "../diagnostics/call_context.h"
31 #include <common/env.h>
32 #include <common/os/filesystem.h>
34 #include <boost/thread/mutex.hpp>
35 #include <boost/thread/lock_guard.hpp>
36 #include <boost/filesystem.hpp>
37 #include <boost/algorithm/string/predicate.hpp>
38 #include <boost/optional.hpp>
43 namespace caspar { namespace core {
45 const spl::shared_ptr<cg_proxy>& cg_proxy::empty()
47 class empty_proxy : public cg_proxy
49 void add(int, const std::wstring&, bool, const std::wstring&, const std::wstring&) override {}
50 void remove(int) override {}
51 void play(int) override {}
52 void stop(int, unsigned int) override {}
53 void next(int) override {}
54 void update(int, const std::wstring&) override {}
55 std::wstring invoke(int, const std::wstring&) override { return L""; }
56 std::wstring description(int) override { return L"empty cg producer"; }
57 std::wstring template_host_info() override { return L"empty cg producer"; }
60 static spl::shared_ptr<cg_proxy> instance = spl::make_shared<empty_proxy>();
64 using namespace boost::multi_index;
66 struct cg_producer_registry::impl
72 meta_info_extractor info_extractor;
73 cg_proxy_factory proxy_factory;
74 cg_producer_factory producer_factory;
75 bool reusable_producer_instance;
81 mutable boost::mutex mutex_;
82 std::map<std::wstring, record> records_by_extension_;
84 void register_cg_producer(
85 std::wstring cg_producer_name,
86 std::set<std::wstring> file_extensions,
87 meta_info_extractor info_extractor,
88 cg_proxy_factory proxy_factory,
89 cg_producer_factory producer_factory,
90 bool reusable_producer_instance)
92 boost::lock_guard<boost::mutex> lock(mutex_);
96 std::move(cg_producer_name),
97 std::move(info_extractor),
98 std::move(proxy_factory),
99 std::move(producer_factory),
100 reusable_producer_instance
103 for (auto& extension : file_extensions)
105 records_by_extension_.insert(std::make_pair(extension, rec));
109 spl::shared_ptr<frame_producer> create_producer(
110 const frame_producer_dependencies& dependencies,
111 const std::wstring& filename) const
113 auto found = find_record(filename);
116 return frame_producer::empty();
118 return found->producer_factory(dependencies, filename);
121 spl::shared_ptr<cg_proxy> get_proxy(const spl::shared_ptr<frame_producer>& producer) const
123 auto producer_name = producer->name();
125 boost::lock_guard<boost::mutex> lock(mutex_);
127 for (auto& elem : records_by_extension_)
129 if (elem.second.name == producer_name)
130 return elem.second.proxy_factory(producer);
133 return cg_proxy::empty();
136 spl::shared_ptr<cg_proxy> get_proxy(
137 const spl::shared_ptr<video_channel>& video_channel,
138 int render_layer) const
140 auto producer = spl::make_shared_ptr(video_channel->stage().foreground(render_layer).get());
142 return get_proxy(producer);
145 spl::shared_ptr<cg_proxy> get_or_create_proxy(
146 const spl::shared_ptr<video_channel>& video_channel,
147 const frame_producer_dependencies& dependencies,
149 const std::wstring& filename) const
151 using namespace boost::filesystem;
153 auto found = find_record(filename);
156 return cg_proxy::empty();
158 auto producer = spl::make_shared_ptr(video_channel->stage().foreground(render_layer).get());
159 auto current_producer_name = producer->name();
160 bool create_new = current_producer_name != found->name || !found->reusable_producer_instance;
164 diagnostics::scoped_call_context save;
165 diagnostics::call_context::for_thread().video_channel = video_channel->index();
166 diagnostics::call_context::for_thread().layer = render_layer;
168 producer = found->producer_factory(dependencies, filename);
169 video_channel->stage().load(render_layer, producer);
170 video_channel->stage().play(render_layer);
173 return found->proxy_factory(producer);
176 std::string read_meta_info(const std::wstring& filename) const
178 using namespace boost::filesystem;
180 auto basepath = path(env::template_folder()) / path(filename);
182 boost::lock_guard<boost::mutex> lock(mutex_);
184 for (auto& rec : records_by_extension_)
186 auto p = path(basepath.wstring() + rec.first);
187 auto found = find_case_insensitive(p.wstring());
190 return rec.second.info_extractor(*found);
193 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(L"No meta info extractor for " + filename));
196 bool is_cg_extension(const std::wstring& extension) const
198 boost::lock_guard<boost::mutex> lock(mutex_);
200 return records_by_extension_.find(extension) != records_by_extension_.end();
203 boost::optional<record> find_record(const std::wstring& filename) const
205 using namespace boost::filesystem;
207 auto basepath = path(env::template_folder()) / path(filename);
209 boost::lock_guard<boost::mutex> lock(mutex_);
211 for (auto& rec : records_by_extension_)
213 auto p = path(basepath.wstring() + rec.first);
215 if (find_case_insensitive(p.wstring()))
223 cg_producer_registry::cg_producer_registry() : impl_(new impl) { }
225 void cg_producer_registry::register_cg_producer(
226 std::wstring cg_producer_name,
227 std::set<std::wstring> file_extensions,
228 meta_info_extractor info_extractor,
229 cg_proxy_factory proxy_factory,
230 cg_producer_factory producer_factory,
231 bool reusable_producer_instance)
233 impl_->register_cg_producer(
234 std::move(cg_producer_name),
235 std::move(file_extensions),
236 std::move(info_extractor),
237 std::move(proxy_factory),
238 std::move(producer_factory),
239 reusable_producer_instance);
242 spl::shared_ptr<frame_producer> cg_producer_registry::create_producer(
243 const frame_producer_dependencies& dependencies,
244 const std::wstring& filename) const
246 return impl_->create_producer(dependencies, filename);
249 spl::shared_ptr<cg_proxy> cg_producer_registry::get_proxy(
250 const spl::shared_ptr<frame_producer>& producer) const
252 return impl_->get_proxy(producer);
255 spl::shared_ptr<cg_proxy> cg_producer_registry::get_proxy(
256 const spl::shared_ptr<video_channel>& video_channel,
257 int render_layer) const
259 return impl_->get_proxy(video_channel, render_layer);
262 spl::shared_ptr<cg_proxy> cg_producer_registry::get_or_create_proxy(
263 const spl::shared_ptr<video_channel>& video_channel,
264 const frame_producer_dependencies& dependencies,
266 const std::wstring& filename) const
268 return impl_->get_or_create_proxy(video_channel, dependencies, render_layer, filename);
271 std::string cg_producer_registry::read_meta_info(const std::wstring& filename) const
273 return impl_->read_meta_info(filename);
276 bool cg_producer_registry::is_cg_extension(const std::wstring& extension) const
278 return impl_->is_cg_extension(extension);