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
25 #include "included_modules.h"
27 #include <accelerator/accelerator.h>
29 #include <common/env.h>
30 #include <common/except.h>
31 #include <common/utf.h>
32 #include <common/memory.h>
33 #include <common/polling_filesystem_monitor.h>
35 #include <core/video_channel.h>
36 #include <core/video_format.h>
37 #include <core/producer/stage.h>
38 #include <core/producer/frame_producer.h>
39 #include <core/producer/scene/scene_producer.h>
40 #include <core/producer/scene/xml_scene_producer.h>
41 #include <core/producer/text/text_producer.h>
42 #include <core/consumer/output.h>
43 #include <core/thumbnail_generator.h>
44 #include <core/producer/media_info/media_info.h>
45 #include <core/producer/media_info/media_info_repository.h>
46 #include <core/producer/media_info/in_memory_media_info_repository.h>
47 #include <core/producer/cg_proxy.h>
48 #include <core/diagnostics/subject_diagnostics.h>
49 #include <core/diagnostics/call_context.h>
50 #include <core/diagnostics/osd_graph.h>
51 #include <core/system_info_provider.h>
53 #include <modules/image/consumer/image_consumer.h>
55 #include <protocol/asio/io_service_manager.h>
56 #include <protocol/amcp/AMCPProtocolStrategy.h>
57 #include <protocol/cii/CIIProtocolStrategy.h>
58 #include <protocol/clk/CLKProtocolStrategy.h>
59 #include <protocol/util/AsyncEventServer.h>
60 #include <protocol/util/strategy_adapters.h>
61 #include <protocol/osc/client.h>
63 #include <boost/algorithm/string.hpp>
64 #include <boost/thread.hpp>
65 #include <boost/lexical_cast.hpp>
66 #include <boost/property_tree/ptree.hpp>
67 #include <boost/property_tree/xml_parser.hpp>
69 #include <tbb/atomic.h>
76 using namespace protocol;
78 struct server::impl : boost::noncopyable
80 protocol::asio::io_service_manager io_service_manager_;
81 spl::shared_ptr<monitor::subject> monitor_subject_;
82 spl::shared_ptr<monitor::subject> diag_subject_ = core::diagnostics::get_or_create_subject();
83 accelerator::accelerator accelerator_;
84 std::vector<spl::shared_ptr<IO::AsyncEventServer>> async_servers_;
85 std::shared_ptr<IO::AsyncEventServer> primary_amcp_server_;
86 osc::client osc_client_;
87 std::vector<std::shared_ptr<void>> predefined_osc_subscriptions_;
88 std::vector<spl::shared_ptr<video_channel>> channels_;
89 spl::shared_ptr<media_info_repository> media_info_repo_;
90 boost::thread initial_media_info_thread_;
91 spl::shared_ptr<system_info_provider_repository> system_info_provider_repo_;
92 spl::shared_ptr<core::cg_producer_registry> cg_registry_;
93 tbb::atomic<bool> running_;
94 std::shared_ptr<thumbnail_generator> thumbnail_generator_;
95 std::promise<bool>& shutdown_server_now_;
97 explicit impl(std::promise<bool>& shutdown_server_now)
98 : accelerator_(env::properties().get(L"configuration.accelerator", L"auto"))
99 , osc_client_(io_service_manager_.service())
100 , media_info_repo_(create_in_memory_media_info_repository())
101 , shutdown_server_now_(shutdown_server_now)
104 core::diagnostics::osd::register_sink();
105 diag_subject_->attach_parent(monitor_subject_);
107 initialize_modules(module_dependencies(
108 system_info_provider_repo_,
114 register_producer_factory(&core::scene::create_dummy_scene_producer);
115 register_producer_factory(&core::scene::create_xml_scene_producer);
122 setup_channels(env::properties());
123 CASPAR_LOG(info) << L"Initialized channels.";
125 setup_thumbnail_generation(env::properties());
126 CASPAR_LOG(info) << L"Initialized thumbnail generator.";
128 setup_controllers(env::properties());
129 CASPAR_LOG(info) << L"Initialized controllers.";
131 setup_osc(env::properties());
132 CASPAR_LOG(info) << L"Initialized osc.";
134 start_initial_media_info_scan();
135 CASPAR_LOG(info) << L"Started initial media information retrieval.";
143 initial_media_info_thread_.join();
146 thumbnail_generator_.reset();
147 primary_amcp_server_.reset();
148 async_servers_.clear();
151 boost::this_thread::sleep_for(boost::chrono::milliseconds(500));
152 //Sleep(500); // HACK: Wait for asynchronous destruction of producers and consumers.
154 uninitialize_modules();
155 core::diagnostics::osd::shutdown();
158 void setup_channels(const boost::property_tree::wptree& pt)
160 using boost::property_tree::wptree;
161 for (auto& xml_channel : pt.get_child(L"configuration.channels"))
163 auto format_desc = video_format_desc(xml_channel.second.get(L"video-mode", L"PAL"));
164 if(format_desc.format == video_format::invalid)
165 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Invalid video-mode."));
167 auto channel = spl::make_shared<video_channel>(static_cast<int>(channels_.size()+1), format_desc, accelerator_.create_image_mixer());
169 core::diagnostics::scoped_call_context save;
170 core::diagnostics::call_context::for_thread().video_channel = channel->index();
172 for (auto& xml_consumer : xml_channel.second.get_child(L"consumers"))
176 auto name = xml_consumer.first;
178 if (name != L"<xmlcomment>")
179 channel->output().add(create_consumer(name, xml_consumer.second, &channel->stage()));
183 CASPAR_LOG_CURRENT_EXCEPTION();
187 channel->monitor_output().attach_parent(monitor_subject_);
188 channels_.push_back(channel);
191 // Dummy diagnostics channel
192 if(env::properties().get(L"configuration.channel-grid", false))
193 channels_.push_back(spl::make_shared<video_channel>(static_cast<int>(channels_.size()+1), core::video_format_desc(core::video_format::x576p2500), accelerator_.create_image_mixer()));
196 void setup_osc(const boost::property_tree::wptree& pt)
198 using boost::property_tree::wptree;
199 using namespace boost::asio::ip;
201 monitor_subject_->attach_parent(osc_client_.sink());
204 pt.get<unsigned short>(L"configuration.osc.default-port", 6250);
205 auto predefined_clients =
206 pt.get_child_optional(L"configuration.osc.predefined-clients");
208 if (predefined_clients)
210 for (auto& predefined_client : *predefined_clients)
213 predefined_client.second.get<std::wstring>(L"address");
215 predefined_client.second.get<unsigned short>(L"port");
216 predefined_osc_subscriptions_.push_back(
217 osc_client_.get_subscription_token(udp::endpoint(
218 address_v4::from_string(u8(address)),
223 if (primary_amcp_server_)
224 primary_amcp_server_->add_client_lifecycle_object_factory(
225 [=] (const std::string& ipv4_address)
226 -> std::pair<std::wstring, std::shared_ptr<void>>
228 using namespace boost::asio::ip;
230 return std::make_pair(
231 std::wstring(L"osc_subscribe"),
232 osc_client_.get_subscription_token(
234 address_v4::from_string(
240 void setup_thumbnail_generation(const boost::property_tree::wptree& pt)
242 if (!pt.get(L"configuration.thumbnails.generate-thumbnails", true))
245 auto scan_interval_millis = pt.get(L"configuration.thumbnails.scan-interval-millis", 5000);
247 polling_filesystem_monitor_factory monitor_factory(scan_interval_millis);
248 thumbnail_generator_.reset(new thumbnail_generator(
251 env::thumbnails_folder(),
252 pt.get(L"configuration.thumbnails.width", 256),
253 pt.get(L"configuration.thumbnails.height", 144),
254 core::video_format_desc(pt.get(L"configuration.thumbnails.video-mode", L"720p2500")),
255 accelerator_.create_image_mixer(),
256 pt.get(L"configuration.thumbnails.generate-delay-millis", 2000),
257 &image::write_cropped_png,
259 pt.get(L"configuration.thumbnails.mipmap", true)));
261 CASPAR_LOG(info) << L"Initialized thumbnail generator.";
264 void setup_controllers(const boost::property_tree::wptree& pt)
266 using boost::property_tree::wptree;
267 for (auto& xml_controller : pt.get_child(L"configuration.controllers"))
271 auto name = xml_controller.first;
272 auto protocol = xml_controller.second.get<std::wstring>(L"protocol");
276 unsigned int port = xml_controller.second.get(L"port", 5250);
277 auto asyncbootstrapper = spl::make_shared<IO::AsyncEventServer>(create_protocol(protocol), port);
278 async_servers_.push_back(asyncbootstrapper);
280 if (!primary_amcp_server_ && boost::iequals(protocol, L"AMCP"))
281 primary_amcp_server_ = asyncbootstrapper;
284 CASPAR_LOG(warning) << "Invalid controller: " << name;
288 CASPAR_LOG_CURRENT_EXCEPTION();
293 IO::protocol_strategy_factory<char>::ptr create_protocol(const std::wstring& name) const
297 if(boost::iequals(name, L"AMCP"))
298 return wrap_legacy_protocol("\r\n", spl::make_shared<amcp::AMCPProtocolStrategy>(
300 thumbnail_generator_,
302 system_info_provider_repo_,
304 shutdown_server_now_));
305 else if(boost::iequals(name, L"CII"))
306 return wrap_legacy_protocol("\r\n", spl::make_shared<cii::CIIProtocolStrategy>(channels_, cg_registry_));
307 else if(boost::iequals(name, L"CLOCK"))
308 return spl::make_shared<to_unicode_adapter_factory>(
310 spl::make_shared<CLK::clk_protocol_strategy_factory>(channels_, cg_registry_));
312 CASPAR_THROW_EXCEPTION(caspar_exception() << arg_name_info(L"name") << arg_value_info(name) << msg_info(L"Invalid protocol"));
315 void start_initial_media_info_scan()
317 initial_media_info_thread_ = boost::thread([this]
319 for (boost::filesystem::wrecursive_directory_iterator iter(env::media_folder()), end; iter != end; ++iter)
323 if (boost::filesystem::is_regular_file(iter->path()))
324 media_info_repo_->get(iter->path().wstring());
328 CASPAR_LOG(info) << L"Initial media information retrieval aborted.";
333 CASPAR_LOG(info) << L"Initial media information retrieval finished.";
338 server::server(std::promise<bool>& shutdown_server_now) : impl_(new impl(shutdown_server_now)){}
339 void server::start() { impl_->start(); }
340 const std::vector<spl::shared_ptr<video_channel>> server::channels() const
342 return impl_->channels_;
344 std::shared_ptr<core::thumbnail_generator> server::get_thumbnail_generator() const {return impl_->thumbnail_generator_; }
345 spl::shared_ptr<media_info_repository> server::get_media_info_repo() const { return impl_->media_info_repo_; }
346 spl::shared_ptr<core::system_info_provider_repository> server::get_system_info_provider_repo() const { return impl_->system_info_provider_repo_; }
347 spl::shared_ptr<core::cg_producer_registry> server::get_cg_registry() const { return impl_->cg_registry_; }
348 core::monitor::subject& server::monitor_output() { return *impl_->monitor_subject_; }