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 <accelerator/accelerator.h>
27 #include <common/env.h>
28 #include <common/except.h>
29 #include <common/utf.h>
30 #include <common/memory.h>
31 #include <common/polling_filesystem_monitor.h>
32 #include <common/diagnostics/graph.h>
34 #include <core/video_channel.h>
35 #include <core/video_format.h>
36 #include <core/producer/stage.h>
37 #include <core/producer/frame_producer.h>
38 #include <core/producer/scene/scene_producer.h>
39 #include <core/producer/scene/xml_scene_producer.h>
40 #include <core/producer/text/text_producer.h>
41 #include <core/consumer/output.h>
42 #include <core/thumbnail_generator.h>
44 #include <modules/bluefish/bluefish.h>
45 #include <modules/decklink/decklink.h>
46 #include <modules/ffmpeg/ffmpeg.h>
47 #include <modules/flash/flash.h>
48 #include <modules/oal/oal.h>
49 #include <modules/screen/screen.h>
50 #include <modules/image/image.h>
51 #include <modules/image/consumer/image_consumer.h>
52 #include <modules/psd/psd_scene_producer.h>
54 #include <modules/oal/consumer/oal_consumer.h>
55 #include <modules/bluefish/consumer/bluefish_consumer.h>
56 #include <modules/decklink/consumer/decklink_consumer.h>
57 #include <modules/screen/consumer/screen_consumer.h>
58 #include <modules/ffmpeg/consumer/ffmpeg_consumer.h>
60 #include <protocol/asio/io_service_manager.h>
61 #include <protocol/amcp/AMCPProtocolStrategy.h>
62 #include <protocol/cii/CIIProtocolStrategy.h>
63 #include <protocol/CLK/CLKProtocolStrategy.h>
64 #include <protocol/util/AsyncEventServer.h>
65 #include <protocol/util/strategy_adapters.h>
66 #include <protocol/osc/client.h>
68 #include <boost/algorithm/string.hpp>
69 #include <boost/thread.hpp>
70 #include <boost/lexical_cast.hpp>
71 #include <boost/property_tree/ptree.hpp>
72 #include <boost/property_tree/xml_parser.hpp>
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 accelerator::accelerator accelerator_;
86 std::vector<spl::shared_ptr<IO::AsyncEventServer>> async_servers_;
87 std::shared_ptr<IO::AsyncEventServer> primary_amcp_server_;
88 osc::client osc_client_;
89 std::vector<std::shared_ptr<void>> predefined_osc_subscriptions_;
90 std::vector<spl::shared_ptr<video_channel>> channels_;
91 std::shared_ptr<thumbnail_generator> thumbnail_generator_;
92 std::promise<bool>& shutdown_server_now_;
94 explicit impl(std::promise<bool>& shutdown_server_now)
95 : accelerator_(env::properties().get(L"configuration.accelerator", L"auto"))
96 , osc_client_(io_service_manager_.service())
97 , shutdown_server_now_(shutdown_server_now)
101 CASPAR_LOG(info) << L"Initialized ffmpeg module.";
104 CASPAR_LOG(info) << L"Initialized bluefish module.";
107 CASPAR_LOG(info) << L"Initialized decklink module.";
110 CASPAR_LOG(info) << L"Initialized oal module.";
113 CASPAR_LOG(info) << L"Initialized ogl module.";
116 CASPAR_LOG(info) << L"Initialized image module.";
119 CASPAR_LOG(info) << L"Initialized flash module.";
122 CASPAR_LOG(info) << L"Initialized psd module.";
126 register_producer_factory(&core::scene::create_dummy_scene_producer);
127 register_producer_factory(&core::scene::create_xml_scene_producer);
129 setup_channels(env::properties());
130 CASPAR_LOG(info) << L"Initialized channels.";
132 setup_thumbnail_generation(env::properties());
133 CASPAR_LOG(info) << L"Initialized thumbnail generator.";
135 setup_controllers(env::properties());
136 CASPAR_LOG(info) << L"Initialized controllers.";
138 setup_osc(env::properties());
139 CASPAR_LOG(info) << L"Initialized osc.";
144 thumbnail_generator_.reset();
145 primary_amcp_server_.reset();
146 async_servers_.clear();
149 boost::this_thread::sleep(boost::posix_time::milliseconds(500));
150 //Sleep(500); // HACK: Wait for asynchronous destruction of producers and consumers.
154 diagnostics::shutdown();
157 void setup_channels(const boost::property_tree::wptree& pt)
159 using boost::property_tree::wptree;
160 for (auto& xml_channel : pt.get_child(L"configuration.channels"))
162 auto format_desc = video_format_desc(xml_channel.second.get(L"video-mode", L"PAL"));
163 if(format_desc.format == video_format::invalid)
164 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Invalid video-mode."));
166 auto channel = spl::make_shared<video_channel>(static_cast<int>(channels_.size()+1), format_desc, accelerator_.create_image_mixer());
168 for (auto& xml_consumer : xml_channel.second.get_child(L"consumers"))
172 auto name = xml_consumer.first;
173 if(name == L"screen")
174 channel->output().add(caspar::screen::create_consumer(xml_consumer.second, &channel->stage()));
175 else if(name == L"bluefish")
176 channel->output().add(bluefish::create_consumer(xml_consumer.second));
177 else if(name == L"decklink")
178 channel->output().add(decklink::create_consumer(xml_consumer.second));
179 else if(name == L"file")
180 channel->output().add(ffmpeg::create_consumer(xml_consumer.second));
181 else if(name == L"system-audio")
182 channel->output().add(oal::create_consumer());
183 else if(name != L"<xmlcomment>")
184 CASPAR_LOG(warning) << "Invalid consumer: " << name;
188 CASPAR_LOG_CURRENT_EXCEPTION();
192 channel->monitor_output().attach_parent(monitor_subject_);
193 channels_.push_back(channel);
196 // Dummy diagnostics channel
197 if(env::properties().get(L"configuration.channel-grid", false))
198 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()));
201 void setup_osc(const boost::property_tree::wptree& pt)
203 using boost::property_tree::wptree;
204 using namespace boost::asio::ip;
206 monitor_subject_->attach_parent(osc_client_.sink());
209 pt.get<unsigned short>(L"configuration.osc.default-port", 6250);
210 auto predefined_clients =
211 pt.get_child_optional(L"configuration.osc.predefined-clients");
213 if (predefined_clients)
215 for (auto& predefined_client : *predefined_clients)
218 predefined_client.second.get<std::wstring>(L"address");
220 predefined_client.second.get<unsigned short>(L"port");
221 predefined_osc_subscriptions_.push_back(
222 osc_client_.get_subscription_token(udp::endpoint(
223 address_v4::from_string(u8(address)),
228 if (primary_amcp_server_)
229 primary_amcp_server_->add_client_lifecycle_object_factory(
230 [=] (const std::string& ipv4_address)
231 -> std::pair<std::wstring, std::shared_ptr<void>>
233 using namespace boost::asio::ip;
235 return std::make_pair(
236 std::wstring(L"osc_subscribe"),
237 osc_client_.get_subscription_token(
239 address_v4::from_string(
245 void setup_thumbnail_generation(const boost::property_tree::wptree& pt)
247 if (!pt.get(L"configuration.thumbnails.generate-thumbnails", true))
250 auto scan_interval_millis = pt.get(L"configuration.thumbnails.scan-interval-millis", 5000);
252 polling_filesystem_monitor_factory monitor_factory(scan_interval_millis);
253 thumbnail_generator_.reset(new thumbnail_generator(
256 env::thumbnails_folder(),
257 pt.get(L"configuration.thumbnails.width", 256),
258 pt.get(L"configuration.thumbnails.height", 144),
259 core::video_format_desc(pt.get(L"configuration.thumbnails.video-mode", L"720p2500")),
260 accelerator_.create_image_mixer(),
261 pt.get(L"configuration.thumbnails.generate-delay-millis", 2000),
262 &image::write_cropped_png));
264 CASPAR_LOG(info) << L"Initialized thumbnail generator.";
267 void setup_controllers(const boost::property_tree::wptree& pt)
269 using boost::property_tree::wptree;
270 for (auto& xml_controller : pt.get_child(L"configuration.controllers"))
274 auto name = xml_controller.first;
275 auto protocol = xml_controller.second.get<std::wstring>(L"protocol");
279 unsigned int port = xml_controller.second.get(L"port", 5250);
280 auto asyncbootstrapper = spl::make_shared<IO::AsyncEventServer>(create_protocol(protocol), port);
281 async_servers_.push_back(asyncbootstrapper);
283 if (!primary_amcp_server_ && boost::iequals(protocol, L"AMCP"))
284 primary_amcp_server_ = asyncbootstrapper;
287 CASPAR_LOG(warning) << "Invalid controller: " << name;
291 CASPAR_LOG_CURRENT_EXCEPTION();
296 IO::protocol_strategy_factory<char>::ptr create_protocol(const std::wstring& name) const
300 if(boost::iequals(name, L"AMCP"))
301 return wrap_legacy_protocol("\r\n", spl::make_shared<amcp::AMCPProtocolStrategy>(channels_, thumbnail_generator_, shutdown_server_now_));
302 else if(boost::iequals(name, L"CII"))
303 return wrap_legacy_protocol("\r\n", spl::make_shared<cii::CIIProtocolStrategy>(channels_));
304 else if(boost::iequals(name, L"CLOCK"))
305 return spl::make_shared<to_unicode_adapter_factory>(
307 spl::make_shared<CLK::clk_protocol_strategy_factory>(channels_));
309 CASPAR_THROW_EXCEPTION(caspar_exception() << arg_name_info(L"name") << arg_value_info(name) << msg_info(L"Invalid protocol"));
314 server::server(std::promise<bool>& shutdown_server_now) : impl_(new impl(shutdown_server_now)){}
316 const std::vector<spl::shared_ptr<video_channel>> server::channels() const
318 return impl_->channels_;
320 std::shared_ptr<core::thumbnail_generator> server::get_thumbnail_generator() const {return impl_->thumbnail_generator_; }
321 core::monitor::subject& server::monitor_output() { return *impl_->monitor_subject_; }