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/ptree.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/producer/color/color_producer.h>
46 #include <core/consumer/output.h>
47 #include <core/consumer/syncto/syncto_consumer.h>
48 #include <core/mixer/mixer.h>
49 #include <core/mixer/image/image_mixer.h>
50 #include <core/thumbnail_generator.h>
51 #include <core/producer/media_info/media_info.h>
52 #include <core/producer/media_info/media_info_repository.h>
53 #include <core/producer/media_info/in_memory_media_info_repository.h>
54 #include <core/producer/cg_proxy.h>
55 #include <core/diagnostics/subject_diagnostics.h>
56 #include <core/diagnostics/call_context.h>
57 #include <core/diagnostics/osd_graph.h>
58 #include <core/diagnostics/graph_to_log_sink.h>
59 #include <core/system_info_provider.h>
60 #include <core/help/help_repository.h>
62 #include <modules/image/consumer/image_consumer.h>
64 #include <protocol/amcp/AMCPProtocolStrategy.h>
65 #include <protocol/amcp/amcp_command_repository.h>
66 #include <protocol/amcp/AMCPCommandsImpl.h>
67 #include <protocol/cii/CIIProtocolStrategy.h>
68 #include <protocol/clk/CLKProtocolStrategy.h>
69 #include <protocol/util/AsyncEventServer.h>
70 #include <protocol/util/strategy_adapters.h>
71 #include <protocol/osc/client.h>
72 #include <protocol/log/tcp_logger_protocol_strategy.h>
74 #include <boost/algorithm/string.hpp>
75 #include <boost/thread.hpp>
76 #include <boost/lexical_cast.hpp>
77 #include <boost/property_tree/ptree.hpp>
78 #include <boost/property_tree/xml_parser.hpp>
79 #include <boost/asio.hpp>
81 #include <tbb/atomic.h>
88 using namespace protocol;
90 std::shared_ptr<boost::asio::io_service> create_running_io_service()
92 auto service = std::make_shared<boost::asio::io_service>();
93 // To keep the io_service::run() running although no pending async
94 // operations are posted.
95 auto work = std::make_shared<boost::asio::io_service::work>(*service);
96 auto weak_work = std::weak_ptr<boost::asio::io_service::work>(work);
97 auto thread = std::make_shared<boost::thread>([service, weak_work]
99 ensure_gpf_handler_installed_for_thread("asio-thread");
101 while (auto strong = weak_work.lock())
109 CASPAR_LOG_CURRENT_EXCEPTION();
114 return std::shared_ptr<boost::asio::io_service>(
116 [service, work, thread](void*) mutable
120 if (thread->get_id() != boost::this_thread::get_id())
127 struct server::impl : boost::noncopyable
129 std::shared_ptr<boost::asio::io_service> io_service_ = create_running_io_service();
130 spl::shared_ptr<monitor::subject> monitor_subject_;
131 spl::shared_ptr<monitor::subject> diag_subject_ = core::diagnostics::get_or_create_subject();
132 accelerator::accelerator accelerator_;
133 spl::shared_ptr<help_repository> help_repo_;
134 std::shared_ptr<amcp::amcp_command_repository> amcp_command_repo_;
135 std::vector<spl::shared_ptr<IO::AsyncEventServer>> async_servers_;
136 std::shared_ptr<IO::AsyncEventServer> primary_amcp_server_;
137 std::shared_ptr<osc::client> osc_client_ = std::make_shared<osc::client>(io_service_);
138 std::vector<std::shared_ptr<void>> predefined_osc_subscriptions_;
139 std::vector<spl::shared_ptr<video_channel>> channels_;
140 spl::shared_ptr<media_info_repository> media_info_repo_;
141 boost::thread initial_media_info_thread_;
142 spl::shared_ptr<system_info_provider_repository> system_info_provider_repo_;
143 spl::shared_ptr<core::cg_producer_registry> cg_registry_;
144 spl::shared_ptr<core::frame_producer_registry> producer_registry_;
145 spl::shared_ptr<core::frame_consumer_registry> consumer_registry_;
146 tbb::atomic<bool> running_;
147 std::shared_ptr<thumbnail_generator> thumbnail_generator_;
148 std::promise<bool>& shutdown_server_now_;
150 explicit impl(std::promise<bool>& shutdown_server_now)
151 : accelerator_(env::properties().get(L"configuration.accelerator", L"auto"))
152 , media_info_repo_(create_in_memory_media_info_repository())
153 , producer_registry_(spl::make_shared<core::frame_producer_registry>(help_repo_))
154 , consumer_registry_(spl::make_shared<core::frame_consumer_registry>(help_repo_))
155 , shutdown_server_now_(shutdown_server_now)
158 core::diagnostics::register_graph_to_log_sink();
159 caspar::core::diagnostics::osd::register_sink();
160 diag_subject_->attach_parent(monitor_subject_);
162 module_dependencies dependencies(
163 system_info_provider_repo_,
169 initialize_modules(dependencies);
170 core::text::init(dependencies);
171 core::scene::init(dependencies);
172 core::syncto::init(dependencies);
173 help_repo_->register_item({ L"producer" }, L"Color Producer", &core::describe_color_producer);
180 setup_audio_config(env::properties());
181 CASPAR_LOG(info) << L"Initialized audio config.";
183 setup_channels(env::properties());
184 CASPAR_LOG(info) << L"Initialized channels.";
186 setup_thumbnail_generation(env::properties());
187 CASPAR_LOG(info) << L"Initialized thumbnail generator.";
189 setup_controllers(env::properties());
190 CASPAR_LOG(info) << L"Initialized controllers.";
192 setup_osc(env::properties());
193 CASPAR_LOG(info) << L"Initialized osc.";
195 start_initial_media_info_scan();
196 CASPAR_LOG(info) << L"Started initial media information retrieval.";
204 initial_media_info_thread_.join();
207 std::weak_ptr<boost::asio::io_service> weak_io_service = io_service_;
210 thumbnail_generator_.reset();
211 amcp_command_repo_.reset();
212 primary_amcp_server_.reset();
213 async_servers_.clear();
214 destroy_producers_synchronously();
215 destroy_consumers_synchronously();
218 while (weak_io_service.lock())
219 boost::this_thread::sleep_for(boost::chrono::milliseconds(100));
221 uninitialize_modules();
222 core::diagnostics::osd::shutdown();
225 void setup_audio_config(const boost::property_tree::wptree& pt)
227 using boost::property_tree::wptree;
229 auto default_config = get_default_audio_config();
231 // Start with the defaults
232 audio_channel_layout_repository::get_default()->register_all_layouts(default_config.get_child(L"audio.channel-layouts"));
233 audio_mix_config_repository::get_default()->register_all_configs(default_config.get_child(L"audio.mix-configs"));
235 // Merge with user configuration (adds to or overwrites the defaults)
236 auto custom_channel_layouts = pt.get_child_optional(L"configuration.audio.channel-layouts");
237 auto custom_mix_configs = pt.get_child_optional(L"configuration.audio.mix-configs");
239 if (custom_channel_layouts)
241 CASPAR_SCOPED_CONTEXT_MSG("/configuration/audio/channel-layouts");
242 audio_channel_layout_repository::get_default()->register_all_layouts(*custom_channel_layouts);
245 if (custom_mix_configs)
247 CASPAR_SCOPED_CONTEXT_MSG("/configuration/audio/mix-configs");
248 audio_mix_config_repository::get_default()->register_all_configs(*custom_mix_configs);
252 void setup_channels(const boost::property_tree::wptree& pt)
254 using boost::property_tree::wptree;
256 std::vector<wptree> xml_channels;
258 for (auto& xml_channel : pt | witerate_children(L"configuration.channels") | welement_context_iteration)
260 xml_channels.push_back(xml_channel.second);
261 ptree_verify_element_name(xml_channel, L"channel");
263 auto format_desc_str = xml_channel.second.get(L"video-mode", L"PAL");
264 auto format_desc = video_format_desc(format_desc_str);
265 if(format_desc.format == video_format::invalid)
266 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Invalid video-mode: " + format_desc_str));
268 auto channel_layout_str = xml_channel.second.get(L"channel-layout", L"stereo");
269 auto channel_layout = core::audio_channel_layout_repository::get_default()->get_layout(channel_layout_str);
271 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Unknown channel-layout: " + channel_layout_str));
273 auto channel_id = static_cast<int>(channels_.size() + 1);
274 auto channel = spl::make_shared<video_channel>(channel_id, format_desc, *channel_layout, accelerator_.create_image_mixer(channel_id));
276 channel->monitor_output().attach_parent(monitor_subject_);
277 channel->mixer().set_straight_alpha_output(xml_channel.second.get(L"straight-alpha-output", false));
278 channels_.push_back(channel);
281 for (auto& channel : channels_)
283 core::diagnostics::scoped_call_context save;
284 core::diagnostics::call_context::for_thread().video_channel = channel->index();
286 for (auto& xml_consumer : xml_channels.at(channel->index() - 1) | witerate_children(L"consumers") | welement_context_iteration)
288 auto name = xml_consumer.first;
292 if (name != L"<xmlcomment>")
293 channel->output().add(consumer_registry_->create_consumer(name, xml_consumer.second, &channel->stage(), channels_));
295 catch (const user_error& e)
297 CASPAR_LOG_CURRENT_EXCEPTION_AT_LEVEL(debug);
298 CASPAR_LOG(error) << get_message_and_context(e) << " Turn on log level debug for stacktrace.";
302 CASPAR_LOG_CURRENT_EXCEPTION();
307 // Dummy diagnostics channel
308 if (env::properties().get(L"configuration.channel-grid", false))
310 auto channel_id = static_cast<int>(channels_.size() + 1);
311 channels_.push_back(spl::make_shared<video_channel>(
313 core::video_format_desc(core::video_format::x576p2500),
314 *core::audio_channel_layout_repository::get_default()->get_layout(L"stereo"),
315 accelerator_.create_image_mixer(channel_id)));
316 channels_.back()->monitor_output().attach_parent(monitor_subject_);
320 void setup_osc(const boost::property_tree::wptree& pt)
322 using boost::property_tree::wptree;
323 using namespace boost::asio::ip;
325 monitor_subject_->attach_parent(osc_client_->sink());
328 pt.get<unsigned short>(L"configuration.osc.default-port", 6250);
329 auto disable_send_to_amcp_clients =
330 pt.get(L"configuration.osc.disable-send-to-amcp-clients", false);
331 auto predefined_clients =
332 pt.get_child_optional(L"configuration.osc.predefined-clients");
334 if (predefined_clients)
336 for (auto& predefined_client : pt | witerate_children(L"configuration.osc.predefined-clients") | welement_context_iteration)
338 ptree_verify_element_name(predefined_client, L"predefined-client");
341 ptree_get<std::wstring>(predefined_client.second, L"address");
343 ptree_get<unsigned short>(predefined_client.second, L"port");
344 predefined_osc_subscriptions_.push_back(
345 osc_client_->get_subscription_token(udp::endpoint(
346 address_v4::from_string(u8(address)),
351 if (!disable_send_to_amcp_clients && primary_amcp_server_)
352 primary_amcp_server_->add_client_lifecycle_object_factory(
353 [=] (const std::string& ipv4_address)
354 -> std::pair<std::wstring, std::shared_ptr<void>>
356 using namespace boost::asio::ip;
358 return std::make_pair(
359 std::wstring(L"osc_subscribe"),
360 osc_client_->get_subscription_token(
362 address_v4::from_string(
368 void setup_thumbnail_generation(const boost::property_tree::wptree& pt)
370 if (!pt.get(L"configuration.thumbnails.generate-thumbnails", true))
373 auto scan_interval_millis = pt.get(L"configuration.thumbnails.scan-interval-millis", 5000);
375 polling_filesystem_monitor_factory monitor_factory(io_service_, scan_interval_millis);
376 thumbnail_generator_.reset(new thumbnail_generator(
379 env::thumbnails_folder(),
380 pt.get(L"configuration.thumbnails.width", 256),
381 pt.get(L"configuration.thumbnails.height", 144),
382 core::video_format_desc(pt.get(L"configuration.thumbnails.video-mode", L"720p2500")),
383 accelerator_.create_image_mixer(0),
384 pt.get(L"configuration.thumbnails.generate-delay-millis", 2000),
385 &image::write_cropped_png,
388 pt.get(L"configuration.thumbnails.mipmap", true)));
391 void setup_controllers(const boost::property_tree::wptree& pt)
393 amcp_command_repo_ = spl::make_shared<amcp::amcp_command_repository>(
395 thumbnail_generator_,
397 system_info_provider_repo_,
402 accelerator_.get_ogl_device(),
403 shutdown_server_now_);
404 amcp::register_commands(*amcp_command_repo_);
406 using boost::property_tree::wptree;
407 for (auto& xml_controller : pt | witerate_children(L"configuration.controllers") | welement_context_iteration)
409 auto name = xml_controller.first;
410 auto protocol = ptree_get<std::wstring>(xml_controller.second, L"protocol");
414 auto port = ptree_get<unsigned int>(xml_controller.second, L"port");
415 auto asyncbootstrapper = spl::make_shared<IO::AsyncEventServer>(
417 create_protocol(protocol, L"TCP Port " + boost::lexical_cast<std::wstring>(port)),
419 async_servers_.push_back(asyncbootstrapper);
421 if (!primary_amcp_server_ && boost::iequals(protocol, L"AMCP"))
422 primary_amcp_server_ = asyncbootstrapper;
425 CASPAR_LOG(warning) << "Invalid controller: " << name;
429 IO::protocol_strategy_factory<char>::ptr create_protocol(const std::wstring& name, const std::wstring& port_description) const
433 if(boost::iequals(name, L"AMCP"))
434 return wrap_legacy_protocol("\r\n", spl::make_shared<amcp::AMCPProtocolStrategy>(port_description, spl::make_shared_ptr(amcp_command_repo_)));
435 else if(boost::iequals(name, L"CII"))
436 return wrap_legacy_protocol("\r\n", spl::make_shared<cii::CIIProtocolStrategy>(channels_, cg_registry_, producer_registry_));
437 else if(boost::iequals(name, L"CLOCK"))
438 return spl::make_shared<to_unicode_adapter_factory>(
440 spl::make_shared<CLK::clk_protocol_strategy_factory>(channels_, cg_registry_, producer_registry_));
441 else if (boost::iequals(name, L"LOG"))
442 return spl::make_shared<protocol::log::tcp_logger_protocol_strategy_factory>();
444 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Invalid protocol: " + name));
447 void start_initial_media_info_scan()
449 initial_media_info_thread_ = boost::thread([this]
453 ensure_gpf_handler_installed_for_thread("initial media scan");
455 for (boost::filesystem::wrecursive_directory_iterator iter(env::media_folder()), end; iter != end; ++iter)
459 if (boost::filesystem::is_regular_file(iter->path()))
460 media_info_repo_->get(iter->path().wstring());
464 CASPAR_LOG(info) << L"Initial media information retrieval aborted.";
469 CASPAR_LOG(info) << L"Initial media information retrieval finished.";
473 CASPAR_LOG_CURRENT_EXCEPTION();
479 server::server(std::promise<bool>& shutdown_server_now) : impl_(new impl(shutdown_server_now)){}
480 void server::start() { impl_->start(); }
481 spl::shared_ptr<core::system_info_provider_repository> server::get_system_info_provider_repo() const { return impl_->system_info_provider_repo_; }
482 spl::shared_ptr<protocol::amcp::amcp_command_repository> server::get_amcp_command_repository() const { return spl::make_shared_ptr(impl_->amcp_command_repo_); }
483 core::monitor::subject& server::monitor_output() { return *impl_->monitor_subject_; }