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>
52 #include <core/help/help_repository.h>
54 #include <modules/image/consumer/image_consumer.h>
56 #include <protocol/asio/io_service_manager.h>
57 #include <protocol/amcp/AMCPProtocolStrategy.h>
58 #include <protocol/amcp/amcp_command_repository.h>
59 #include <protocol/amcp/AMCPCommandsImpl.h>
60 #include <protocol/cii/CIIProtocolStrategy.h>
61 #include <protocol/clk/CLKProtocolStrategy.h>
62 #include <protocol/util/AsyncEventServer.h>
63 #include <protocol/util/strategy_adapters.h>
64 #include <protocol/osc/client.h>
66 #include <boost/algorithm/string.hpp>
67 #include <boost/thread.hpp>
68 #include <boost/lexical_cast.hpp>
69 #include <boost/property_tree/ptree.hpp>
70 #include <boost/property_tree/xml_parser.hpp>
72 #include <tbb/atomic.h>
79 using namespace protocol;
81 struct server::impl : boost::noncopyable
83 protocol::asio::io_service_manager io_service_manager_;
84 spl::shared_ptr<monitor::subject> monitor_subject_;
85 spl::shared_ptr<monitor::subject> diag_subject_ = core::diagnostics::get_or_create_subject();
86 accelerator::accelerator accelerator_;
87 spl::shared_ptr<help_repository> help_repo_;
88 std::shared_ptr<amcp::amcp_command_repository> amcp_command_repo_;
89 std::vector<spl::shared_ptr<IO::AsyncEventServer>> async_servers_;
90 std::shared_ptr<IO::AsyncEventServer> primary_amcp_server_;
91 osc::client osc_client_;
92 std::vector<std::shared_ptr<void>> predefined_osc_subscriptions_;
93 std::vector<spl::shared_ptr<video_channel>> channels_;
94 spl::shared_ptr<media_info_repository> media_info_repo_;
95 boost::thread initial_media_info_thread_;
96 spl::shared_ptr<system_info_provider_repository> system_info_provider_repo_;
97 spl::shared_ptr<core::cg_producer_registry> cg_registry_;
98 spl::shared_ptr<core::frame_producer_registry> producer_registry_;
99 tbb::atomic<bool> running_;
100 std::shared_ptr<thumbnail_generator> thumbnail_generator_;
101 std::promise<bool>& shutdown_server_now_;
103 explicit impl(std::promise<bool>& shutdown_server_now)
104 : accelerator_(env::properties().get(L"configuration.accelerator", L"auto"))
105 , osc_client_(io_service_manager_.service())
106 , media_info_repo_(create_in_memory_media_info_repository())
107 , shutdown_server_now_(shutdown_server_now)
110 core::diagnostics::osd::register_sink();
111 diag_subject_->attach_parent(monitor_subject_);
113 module_dependencies dependencies(
114 system_info_provider_repo_,
119 initialize_modules(dependencies);
120 core::text::init(dependencies);
121 core::scene::init(dependencies);
128 setup_channels(env::properties());
129 CASPAR_LOG(info) << L"Initialized channels.";
131 setup_thumbnail_generation(env::properties());
132 CASPAR_LOG(info) << L"Initialized thumbnail generator.";
134 setup_controllers(env::properties());
135 CASPAR_LOG(info) << L"Initialized controllers.";
137 setup_osc(env::properties());
138 CASPAR_LOG(info) << L"Initialized osc.";
140 start_initial_media_info_scan();
141 CASPAR_LOG(info) << L"Started initial media information retrieval.";
149 initial_media_info_thread_.join();
152 thumbnail_generator_.reset();
153 primary_amcp_server_.reset();
154 async_servers_.clear();
157 boost::this_thread::sleep_for(boost::chrono::milliseconds(500));
158 //Sleep(500); // HACK: Wait for asynchronous destruction of producers and consumers.
160 uninitialize_modules();
161 core::diagnostics::osd::shutdown();
164 void setup_channels(const boost::property_tree::wptree& pt)
166 using boost::property_tree::wptree;
167 for (auto& xml_channel : pt.get_child(L"configuration.channels"))
169 auto format_desc = video_format_desc(xml_channel.second.get(L"video-mode", L"PAL"));
170 if(format_desc.format == video_format::invalid)
171 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Invalid video-mode."));
173 auto channel = spl::make_shared<video_channel>(static_cast<int>(channels_.size()+1), format_desc, accelerator_.create_image_mixer());
175 core::diagnostics::scoped_call_context save;
176 core::diagnostics::call_context::for_thread().video_channel = channel->index();
178 for (auto& xml_consumer : xml_channel.second.get_child(L"consumers"))
182 auto name = xml_consumer.first;
184 if (name != L"<xmlcomment>")
185 channel->output().add(create_consumer(name, xml_consumer.second, &channel->stage()));
189 CASPAR_LOG_CURRENT_EXCEPTION();
193 channel->monitor_output().attach_parent(monitor_subject_);
194 channels_.push_back(channel);
197 // Dummy diagnostics channel
198 if(env::properties().get(L"configuration.channel-grid", false))
199 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()));
202 void setup_osc(const boost::property_tree::wptree& pt)
204 using boost::property_tree::wptree;
205 using namespace boost::asio::ip;
207 monitor_subject_->attach_parent(osc_client_.sink());
210 pt.get<unsigned short>(L"configuration.osc.default-port", 6250);
211 auto predefined_clients =
212 pt.get_child_optional(L"configuration.osc.predefined-clients");
214 if (predefined_clients)
216 for (auto& predefined_client : *predefined_clients)
219 predefined_client.second.get<std::wstring>(L"address");
221 predefined_client.second.get<unsigned short>(L"port");
222 predefined_osc_subscriptions_.push_back(
223 osc_client_.get_subscription_token(udp::endpoint(
224 address_v4::from_string(u8(address)),
229 if (primary_amcp_server_)
230 primary_amcp_server_->add_client_lifecycle_object_factory(
231 [=] (const std::string& ipv4_address)
232 -> std::pair<std::wstring, std::shared_ptr<void>>
234 using namespace boost::asio::ip;
236 return std::make_pair(
237 std::wstring(L"osc_subscribe"),
238 osc_client_.get_subscription_token(
240 address_v4::from_string(
246 void setup_thumbnail_generation(const boost::property_tree::wptree& pt)
248 if (!pt.get(L"configuration.thumbnails.generate-thumbnails", true))
251 auto scan_interval_millis = pt.get(L"configuration.thumbnails.scan-interval-millis", 5000);
253 polling_filesystem_monitor_factory monitor_factory(scan_interval_millis);
254 thumbnail_generator_.reset(new thumbnail_generator(
257 env::thumbnails_folder(),
258 pt.get(L"configuration.thumbnails.width", 256),
259 pt.get(L"configuration.thumbnails.height", 144),
260 core::video_format_desc(pt.get(L"configuration.thumbnails.video-mode", L"720p2500")),
261 accelerator_.create_image_mixer(),
262 pt.get(L"configuration.thumbnails.generate-delay-millis", 2000),
263 &image::write_cropped_png,
266 pt.get(L"configuration.thumbnails.mipmap", true)));
268 CASPAR_LOG(info) << L"Initialized thumbnail generator.";
271 void setup_controllers(const boost::property_tree::wptree& pt)
273 amcp_command_repo_ = spl::make_shared<amcp::amcp_command_repository>(
275 thumbnail_generator_,
277 system_info_provider_repo_,
281 shutdown_server_now_);
282 amcp::register_commands(*amcp_command_repo_);
284 using boost::property_tree::wptree;
285 for (auto& xml_controller : pt.get_child(L"configuration.controllers"))
289 auto name = xml_controller.first;
290 auto protocol = xml_controller.second.get<std::wstring>(L"protocol");
294 unsigned int port = xml_controller.second.get(L"port", 5250);
295 auto asyncbootstrapper = spl::make_shared<IO::AsyncEventServer>(create_protocol(protocol), port);
296 async_servers_.push_back(asyncbootstrapper);
298 if (!primary_amcp_server_ && boost::iequals(protocol, L"AMCP"))
299 primary_amcp_server_ = asyncbootstrapper;
302 CASPAR_LOG(warning) << "Invalid controller: " << name;
306 CASPAR_LOG_CURRENT_EXCEPTION();
311 IO::protocol_strategy_factory<char>::ptr create_protocol(const std::wstring& name) const
315 if(boost::iequals(name, L"AMCP"))
316 return wrap_legacy_protocol("\r\n", spl::make_shared<amcp::AMCPProtocolStrategy>(spl::make_shared_ptr(amcp_command_repo_)));
317 else if(boost::iequals(name, L"CII"))
318 return wrap_legacy_protocol("\r\n", spl::make_shared<cii::CIIProtocolStrategy>(channels_, cg_registry_, producer_registry_));
319 else if(boost::iequals(name, L"CLOCK"))
320 return spl::make_shared<to_unicode_adapter_factory>(
322 spl::make_shared<CLK::clk_protocol_strategy_factory>(channels_, cg_registry_, producer_registry_));
324 CASPAR_THROW_EXCEPTION(caspar_exception() << arg_name_info(L"name") << arg_value_info(name) << msg_info(L"Invalid protocol"));
327 void start_initial_media_info_scan()
329 initial_media_info_thread_ = boost::thread([this]
331 for (boost::filesystem::wrecursive_directory_iterator iter(env::media_folder()), end; iter != end; ++iter)
335 if (boost::filesystem::is_regular_file(iter->path()))
336 media_info_repo_->get(iter->path().wstring());
340 CASPAR_LOG(info) << L"Initial media information retrieval aborted.";
345 CASPAR_LOG(info) << L"Initial media information retrieval finished.";
350 server::server(std::promise<bool>& shutdown_server_now) : impl_(new impl(shutdown_server_now)){}
351 void server::start() { impl_->start(); }
352 spl::shared_ptr<core::system_info_provider_repository> server::get_system_info_provider_repo() const { return impl_->system_info_provider_repo_; }
353 spl::shared_ptr<protocol::amcp::amcp_command_repository> server::get_amcp_command_repository() const { return spl::make_shared_ptr(impl_->amcp_command_repo_); }
354 core::monitor::subject& server::monitor_output() { return *impl_->monitor_subject_; }