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"
26 #include "default_audio_config.h"
28 #include <accelerator/accelerator.h>
30 #include <common/env.h>
31 #include <common/except.h>
32 #include <common/utf.h>
33 #include <common/memory.h>
34 #include <common/polling_filesystem_monitor.h>
35 #include <common/diagnostics/graph_to_log_sink.h>
37 #include <core/video_channel.h>
38 #include <core/video_format.h>
39 #include <core/frame/audio_channel_layout.h>
40 #include <core/producer/stage.h>
41 #include <core/producer/frame_producer.h>
42 #include <core/producer/scene/scene_producer.h>
43 #include <core/producer/scene/xml_scene_producer.h>
44 #include <core/producer/text/text_producer.h>
45 #include <core/consumer/output.h>
46 #include <core/mixer/mixer.h>
47 #include <core/thumbnail_generator.h>
48 #include <core/producer/media_info/media_info.h>
49 #include <core/producer/media_info/media_info_repository.h>
50 #include <core/producer/media_info/in_memory_media_info_repository.h>
51 #include <core/producer/cg_proxy.h>
52 #include <core/diagnostics/subject_diagnostics.h>
53 #include <core/diagnostics/call_context.h>
54 #include <core/diagnostics/osd_graph.h>
55 #include <core/system_info_provider.h>
56 #include <core/help/help_repository.h>
58 #include <modules/image/consumer/image_consumer.h>
60 #include <protocol/amcp/AMCPProtocolStrategy.h>
61 #include <protocol/amcp/amcp_command_repository.h>
62 #include <protocol/amcp/AMCPCommandsImpl.h>
63 #include <protocol/cii/CIIProtocolStrategy.h>
64 #include <protocol/clk/CLKProtocolStrategy.h>
65 #include <protocol/util/AsyncEventServer.h>
66 #include <protocol/util/strategy_adapters.h>
67 #include <protocol/osc/client.h>
69 #include <boost/algorithm/string.hpp>
70 #include <boost/thread.hpp>
71 #include <boost/lexical_cast.hpp>
72 #include <boost/property_tree/ptree.hpp>
73 #include <boost/property_tree/xml_parser.hpp>
74 #include <boost/asio.hpp>
76 #include <tbb/atomic.h>
83 using namespace protocol;
85 std::shared_ptr<boost::asio::io_service> create_running_io_service()
87 auto service = std::make_shared<boost::asio::io_service>();
88 // To keep the io_service::run() running although no pending async
89 // operations are posted.
90 auto work = std::make_shared<boost::asio::io_service::work>(*service);
91 auto weak_work = std::weak_ptr<boost::asio::io_service::work>(work);
92 auto thread = std::make_shared<boost::thread>([service, weak_work]
94 ensure_gpf_handler_installed_for_thread("asio-thread");
96 while (auto strong = weak_work.lock())
104 CASPAR_LOG_CURRENT_EXCEPTION();
109 return std::shared_ptr<boost::asio::io_service>(
111 [service, work, thread](void*) mutable
115 if (thread->get_id() != boost::this_thread::get_id())
122 struct server::impl : boost::noncopyable
124 std::shared_ptr<boost::asio::io_service> io_service_ = create_running_io_service();
125 spl::shared_ptr<monitor::subject> monitor_subject_;
126 spl::shared_ptr<monitor::subject> diag_subject_ = core::diagnostics::get_or_create_subject();
127 accelerator::accelerator accelerator_;
128 spl::shared_ptr<help_repository> help_repo_;
129 std::shared_ptr<amcp::amcp_command_repository> amcp_command_repo_;
130 std::vector<spl::shared_ptr<IO::AsyncEventServer>> async_servers_;
131 std::shared_ptr<IO::AsyncEventServer> primary_amcp_server_;
132 std::shared_ptr<osc::client> osc_client_ = std::make_shared<osc::client>(io_service_);
133 std::vector<std::shared_ptr<void>> predefined_osc_subscriptions_;
134 std::vector<spl::shared_ptr<video_channel>> channels_;
135 spl::shared_ptr<media_info_repository> media_info_repo_;
136 boost::thread initial_media_info_thread_;
137 spl::shared_ptr<system_info_provider_repository> system_info_provider_repo_;
138 spl::shared_ptr<core::cg_producer_registry> cg_registry_;
139 spl::shared_ptr<core::frame_producer_registry> producer_registry_;
140 spl::shared_ptr<core::frame_consumer_registry> consumer_registry_;
141 tbb::atomic<bool> running_;
142 std::shared_ptr<thumbnail_generator> thumbnail_generator_;
143 std::promise<bool>& shutdown_server_now_;
145 explicit impl(std::promise<bool>& shutdown_server_now)
146 : accelerator_(env::properties().get(L"configuration.accelerator", L"auto"))
147 , media_info_repo_(create_in_memory_media_info_repository())
148 , producer_registry_(spl::make_shared<core::frame_producer_registry>(help_repo_))
149 , consumer_registry_(spl::make_shared<core::frame_consumer_registry>(help_repo_))
150 , shutdown_server_now_(shutdown_server_now)
153 caspar::diagnostics::register_graph_to_log_sink();
154 caspar::core::diagnostics::osd::register_sink();
155 diag_subject_->attach_parent(monitor_subject_);
157 module_dependencies dependencies(
158 system_info_provider_repo_,
164 initialize_modules(dependencies);
165 core::text::init(dependencies);
166 core::scene::init(dependencies);
173 setup_audio_config(env::properties());
174 CASPAR_LOG(info) << L"Initialized audio config.";
176 setup_channels(env::properties());
177 CASPAR_LOG(info) << L"Initialized channels.";
179 setup_thumbnail_generation(env::properties());
180 CASPAR_LOG(info) << L"Initialized thumbnail generator.";
182 setup_controllers(env::properties());
183 CASPAR_LOG(info) << L"Initialized controllers.";
185 setup_osc(env::properties());
186 CASPAR_LOG(info) << L"Initialized osc.";
188 start_initial_media_info_scan();
189 CASPAR_LOG(info) << L"Started initial media information retrieval.";
197 initial_media_info_thread_.join();
200 std::weak_ptr<boost::asio::io_service> weak_io_service = io_service_;
203 thumbnail_generator_.reset();
204 amcp_command_repo_.reset();
205 primary_amcp_server_.reset();
206 async_servers_.clear();
207 destroy_producers_synchronously();
208 destroy_consumers_synchronously();
211 while (weak_io_service.lock())
212 boost::this_thread::sleep_for(boost::chrono::milliseconds(100));
214 uninitialize_modules();
215 core::diagnostics::osd::shutdown();
218 void setup_audio_config(const boost::property_tree::wptree& pt)
220 using boost::property_tree::wptree;
222 auto default_config = get_default_audio_config();
224 // Start with the defaults
225 audio_channel_layout_repository::get_default()->register_all_layouts(default_config.get_child(L"audio.channel-layouts"));
226 audio_mix_config_repository::get_default()->register_all_configs(default_config.get_child(L"audio.mix-configs"));
228 // Merge with user configuration (adds to or overwrites the defaults)
229 auto custom_channel_layouts = pt.get_child_optional(L"configuration.audio.channel-layouts");
230 auto custom_mix_configs = pt.get_child_optional(L"configuration.audio.mix-configs");
232 if (custom_channel_layouts)
233 audio_channel_layout_repository::get_default()->register_all_layouts(*custom_channel_layouts);
235 if (custom_mix_configs)
236 audio_mix_config_repository::get_default()->register_all_configs(*custom_mix_configs);
239 void setup_channels(const boost::property_tree::wptree& pt)
241 using boost::property_tree::wptree;
242 for (auto& xml_channel : pt.get_child(L"configuration.channels"))
244 auto format_desc = video_format_desc(xml_channel.second.get(L"video-mode", L"PAL"));
245 if(format_desc.format == video_format::invalid)
246 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Invalid video-mode."));
248 auto channel_layout = core::audio_channel_layout_repository::get_default()->get_layout(xml_channel.second.get(L"channel-layout", L"stereo"));
250 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Unknown channel-layout."));
252 auto channel = spl::make_shared<video_channel>(static_cast<int>(channels_.size()+1), format_desc, *channel_layout, accelerator_.create_image_mixer());
254 core::diagnostics::scoped_call_context save;
255 core::diagnostics::call_context::for_thread().video_channel = channel->index();
257 for (auto& xml_consumer : xml_channel.second.get_child(L"consumers"))
261 auto name = xml_consumer.first;
263 if (name != L"<xmlcomment>")
264 channel->output().add(consumer_registry_->create_consumer(name, xml_consumer.second, &channel->stage()));
268 CASPAR_LOG_CURRENT_EXCEPTION();
272 channel->monitor_output().attach_parent(monitor_subject_);
273 channel->mixer().set_straight_alpha_output(xml_channel.second.get(L"straight-alpha-output", false));
274 channels_.push_back(channel);
277 // Dummy diagnostics channel
278 if (env::properties().get(L"configuration.channel-grid", false))
280 channels_.push_back(spl::make_shared<video_channel>(
281 static_cast<int>(channels_.size() + 1),
282 core::video_format_desc(core::video_format::x576p2500),
283 *core::audio_channel_layout_repository::get_default()->get_layout(L"stereo"),
284 accelerator_.create_image_mixer()));
285 channels_.back()->monitor_output().attach_parent(monitor_subject_);
289 void setup_osc(const boost::property_tree::wptree& pt)
291 using boost::property_tree::wptree;
292 using namespace boost::asio::ip;
294 monitor_subject_->attach_parent(osc_client_->sink());
297 pt.get<unsigned short>(L"configuration.osc.default-port", 6250);
298 auto predefined_clients =
299 pt.get_child_optional(L"configuration.osc.predefined-clients");
301 if (predefined_clients)
303 for (auto& predefined_client : *predefined_clients)
306 predefined_client.second.get<std::wstring>(L"address");
308 predefined_client.second.get<unsigned short>(L"port");
309 predefined_osc_subscriptions_.push_back(
310 osc_client_->get_subscription_token(udp::endpoint(
311 address_v4::from_string(u8(address)),
316 if (primary_amcp_server_)
317 primary_amcp_server_->add_client_lifecycle_object_factory(
318 [=] (const std::string& ipv4_address)
319 -> std::pair<std::wstring, std::shared_ptr<void>>
321 using namespace boost::asio::ip;
323 return std::make_pair(
324 std::wstring(L"osc_subscribe"),
325 osc_client_->get_subscription_token(
327 address_v4::from_string(
333 void setup_thumbnail_generation(const boost::property_tree::wptree& pt)
335 if (!pt.get(L"configuration.thumbnails.generate-thumbnails", true))
338 auto scan_interval_millis = pt.get(L"configuration.thumbnails.scan-interval-millis", 5000);
340 polling_filesystem_monitor_factory monitor_factory(io_service_, scan_interval_millis);
341 thumbnail_generator_.reset(new thumbnail_generator(
344 env::thumbnails_folder(),
345 pt.get(L"configuration.thumbnails.width", 256),
346 pt.get(L"configuration.thumbnails.height", 144),
347 core::video_format_desc(pt.get(L"configuration.thumbnails.video-mode", L"720p2500")),
348 accelerator_.create_image_mixer(),
349 pt.get(L"configuration.thumbnails.generate-delay-millis", 2000),
350 &image::write_cropped_png,
353 pt.get(L"configuration.thumbnails.mipmap", true)));
356 void setup_controllers(const boost::property_tree::wptree& pt)
358 amcp_command_repo_ = spl::make_shared<amcp::amcp_command_repository>(
360 thumbnail_generator_,
362 system_info_provider_repo_,
367 shutdown_server_now_);
368 amcp::register_commands(*amcp_command_repo_);
370 using boost::property_tree::wptree;
371 for (auto& xml_controller : pt.get_child(L"configuration.controllers"))
375 auto name = xml_controller.first;
376 auto protocol = xml_controller.second.get<std::wstring>(L"protocol");
380 unsigned int port = xml_controller.second.get(L"port", 5250);
381 auto asyncbootstrapper = spl::make_shared<IO::AsyncEventServer>(
383 create_protocol(protocol, L"TCP Port " + boost::lexical_cast<std::wstring>(port)),
385 async_servers_.push_back(asyncbootstrapper);
387 if (!primary_amcp_server_ && boost::iequals(protocol, L"AMCP"))
388 primary_amcp_server_ = asyncbootstrapper;
391 CASPAR_LOG(warning) << "Invalid controller: " << name;
395 CASPAR_LOG_CURRENT_EXCEPTION();
400 IO::protocol_strategy_factory<char>::ptr create_protocol(const std::wstring& name, const std::wstring& port_description) const
404 if(boost::iequals(name, L"AMCP"))
405 return wrap_legacy_protocol("\r\n", spl::make_shared<amcp::AMCPProtocolStrategy>(port_description, spl::make_shared_ptr(amcp_command_repo_)));
406 else if(boost::iequals(name, L"CII"))
407 return wrap_legacy_protocol("\r\n", spl::make_shared<cii::CIIProtocolStrategy>(channels_, cg_registry_, producer_registry_));
408 else if(boost::iequals(name, L"CLOCK"))
409 return spl::make_shared<to_unicode_adapter_factory>(
411 spl::make_shared<CLK::clk_protocol_strategy_factory>(channels_, cg_registry_, producer_registry_));
413 CASPAR_THROW_EXCEPTION(caspar_exception() << arg_name_info(L"name") << arg_value_info(name) << msg_info(L"Invalid protocol"));
416 void start_initial_media_info_scan()
418 initial_media_info_thread_ = boost::thread([this]
422 ensure_gpf_handler_installed_for_thread("initial media scan");
424 for (boost::filesystem::wrecursive_directory_iterator iter(env::media_folder()), end; iter != end; ++iter)
428 if (boost::filesystem::is_regular_file(iter->path()))
429 media_info_repo_->get(iter->path().wstring());
433 CASPAR_LOG(info) << L"Initial media information retrieval aborted.";
438 CASPAR_LOG(info) << L"Initial media information retrieval finished.";
442 CASPAR_LOG_CURRENT_EXCEPTION();
448 server::server(std::promise<bool>& shutdown_server_now) : impl_(new impl(shutdown_server_now)){}
449 void server::start() { impl_->start(); }
450 spl::shared_ptr<core::system_info_provider_repository> server::get_system_info_provider_repo() const { return impl_->system_info_provider_repo_; }
451 spl::shared_ptr<protocol::amcp::amcp_command_repository> server::get_amcp_command_repository() const { return spl::make_shared_ptr(impl_->amcp_command_repo_); }
452 core::monitor::subject& server::monitor_output() { return *impl_->monitor_subject_; }