]> git.sesse.net Git - casparcg/blob - shell/server.cpp
Experimental support for switching output between premultiplied / straight alpha
[casparcg] / shell / server.cpp
1 /*\r
2 * Copyright 2013 Sveriges Television AB http://casparcg.com/\r
3 *\r
4 * This file is part of CasparCG (www.casparcg.com).\r
5 *\r
6 * CasparCG is free software: you can redistribute it and/or modify\r
7 * it under the terms of the GNU General Public License as published by\r
8 * the Free Software Foundation, either version 3 of the License, or\r
9 * (at your option) any later version.\r
10 *\r
11 * CasparCG is distributed in the hope that it will be useful,\r
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
14 * GNU General Public License for more details.\r
15 *\r
16 * You should have received a copy of the GNU General Public License\r
17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.\r
18 *\r
19 * Author: Robert Nagy, ronag89@gmail.com\r
20 */\r
21 \r
22 \r
23 #include "server.h"\r
24 \r
25 #include <memory>\r
26 \r
27 #include <common/env.h>\r
28 #include <common/exception/exceptions.h>\r
29 #include <common/utility/string.h>\r
30 #include <common/filesystem/polling_filesystem_monitor.h>\r
31 \r
32 #include <core/mixer/gpu/ogl_device.h>\r
33 #include <core/mixer/audio/audio_util.h>\r
34 #include <core/mixer/mixer.h>\r
35 #include <core/video_channel.h>\r
36 #include <core/producer/stage.h>\r
37 #include <core/consumer/output.h>\r
38 #include <core/thumbnail_generator.h>\r
39 \r
40 #include <modules/bluefish/bluefish.h>\r
41 #include <modules/decklink/decklink.h>\r
42 #include <modules/ffmpeg/ffmpeg.h>\r
43 #include <modules/flash/flash.h>\r
44 #include <modules/oal/oal.h>\r
45 #include <modules/ogl/ogl.h>\r
46 #include <modules/silverlight/silverlight.h>\r
47 #include <modules/image/image.h>\r
48 #include <modules/image/consumer/image_consumer.h>\r
49 \r
50 #include <modules/oal/consumer/oal_consumer.h>\r
51 #include <modules/bluefish/consumer/bluefish_consumer.h>\r
52 #include <modules/decklink/consumer/decklink_consumer.h>\r
53 #include <modules/ogl/consumer/ogl_consumer.h>\r
54 #include <modules/ffmpeg/consumer/ffmpeg_consumer.h>\r
55 \r
56 #include <protocol/amcp/AMCPProtocolStrategy.h>\r
57 #include <protocol/cii/CIIProtocolStrategy.h>\r
58 #include <protocol/CLK/CLKProtocolStrategy.h>\r
59 #include <protocol/util/AsyncEventServer.h>\r
60 #include <protocol/util/stateful_protocol_strategy_wrapper.h>\r
61 #include <protocol/osc/client.h>\r
62 #include <protocol/asio/io_service_manager.h>\r
63 \r
64 #include <boost/algorithm/string.hpp>\r
65 #include <boost/lexical_cast.hpp>\r
66 #include <boost/foreach.hpp>\r
67 #include <boost/property_tree/ptree.hpp>\r
68 #include <boost/property_tree/xml_parser.hpp>\r
69 \r
70 namespace caspar {\r
71 \r
72 using namespace core;\r
73 using namespace protocol;\r
74 \r
75 struct server::implementation : boost::noncopyable\r
76 {\r
77         protocol::asio::io_service_manager                      io_service_manager_;\r
78         core::monitor::subject                                          monitor_subject_;\r
79         boost::promise<bool>&                                           shutdown_server_now_;\r
80         safe_ptr<ogl_device>                                            ogl_;\r
81         std::vector<safe_ptr<IO::AsyncEventServer>> async_servers_;     \r
82         std::shared_ptr<IO::AsyncEventServer>           primary_amcp_server_;\r
83         osc::client                                                                     osc_client_;\r
84         std::vector<std::shared_ptr<void>>                      predefined_osc_subscriptions_;\r
85         std::vector<safe_ptr<video_channel>>            channels_;\r
86         std::shared_ptr<thumbnail_generator>            thumbnail_generator_;\r
87 \r
88         implementation(boost::promise<bool>& shutdown_server_now)\r
89                 : shutdown_server_now_(shutdown_server_now)\r
90                 , ogl_(ogl_device::create())\r
91                 , osc_client_(io_service_manager_.service(), monitor_subject_)\r
92         {\r
93                 setup_audio(env::properties());\r
94 \r
95                 ffmpeg::init();\r
96                 CASPAR_LOG(info) << L"Initialized ffmpeg module.";\r
97                                                           \r
98                 bluefish::init();         \r
99                 CASPAR_LOG(info) << L"Initialized bluefish module.";\r
100                                                           \r
101                 decklink::init();         \r
102                 CASPAR_LOG(info) << L"Initialized decklink module.";\r
103                                                                                                                   \r
104                 oal::init();              \r
105                 CASPAR_LOG(info) << L"Initialized oal module.";\r
106                                                           \r
107                 ogl::init();              \r
108                 CASPAR_LOG(info) << L"Initialized ogl module.";\r
109 \r
110                 image::init();            \r
111                 CASPAR_LOG(info) << L"Initialized image module.";\r
112 \r
113                 flash::init();            \r
114                 CASPAR_LOG(info) << L"Initialized flash module.";\r
115 \r
116                 setup_channels(env::properties());\r
117                 CASPAR_LOG(info) << L"Initialized channels.";\r
118 \r
119                 setup_thumbnail_generation(env::properties());\r
120 \r
121                 setup_controllers(env::properties());\r
122                 CASPAR_LOG(info) << L"Initialized controllers.";\r
123 \r
124                 setup_osc(env::properties());\r
125                 CASPAR_LOG(info) << L"Initialized osc.";\r
126         }\r
127 \r
128         ~implementation()\r
129         {               \r
130                 ffmpeg::uninit();\r
131 \r
132                 thumbnail_generator_.reset();\r
133                 primary_amcp_server_.reset();\r
134                 async_servers_.clear();\r
135                 channels_.clear();\r
136         }\r
137 \r
138         void setup_audio(const boost::property_tree::wptree& pt)\r
139         {\r
140                 register_default_channel_layouts(default_channel_layout_repository());\r
141                 register_default_mix_configs(default_mix_config_repository());\r
142 \r
143                 auto channel_layouts =\r
144                         pt.get_child_optional(L"configuration.audio.channel-layouts");\r
145                 auto mix_configs =\r
146                         pt.get_child_optional(L"configuration.audio.mix-configs");\r
147 \r
148                 if (channel_layouts)\r
149                         parse_channel_layouts(\r
150                                         default_channel_layout_repository(), *channel_layouts);\r
151 \r
152                 if (mix_configs)\r
153                         parse_mix_configs(\r
154                                         default_mix_config_repository(), *mix_configs);\r
155         }\r
156                                 \r
157         void setup_channels(const boost::property_tree::wptree& pt)\r
158         {   \r
159                 using boost::property_tree::wptree;\r
160                 BOOST_FOREACH(auto& xml_channel, pt.get_child(L"configuration.channels"))\r
161                 {               \r
162                         auto format_desc = video_format_desc::get(widen(xml_channel.second.get(L"video-mode", L"PAL")));                \r
163                         if(format_desc.format == video_format::invalid)\r
164                                 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("Invalid video-mode."));\r
165                         auto audio_channel_layout = default_channel_layout_repository().get_by_name(\r
166                                         boost::to_upper_copy(xml_channel.second.get(L"channel-layout", L"STEREO")));\r
167                         \r
168                         channels_.push_back(make_safe<video_channel>(channels_.size()+1, format_desc, ogl_, audio_channel_layout));\r
169                         \r
170                         channels_.back()->monitor_output().link_target(&monitor_subject_);\r
171                         channels_.back()->mixer()->set_straight_alpha_output(\r
172                                         xml_channel.second.get(L"straight-alpha-output", false));\r
173 \r
174                         create_consumers(\r
175                                 xml_channel.second.get_child(L"consumers"),\r
176                                 [&] (const safe_ptr<core::frame_consumer>& consumer)\r
177                                 {\r
178                                         channels_.back()->output()->add(consumer);\r
179                                 });\r
180                 }\r
181 \r
182                 // Dummy diagnostics channel\r
183                 if(env::properties().get(L"configuration.channel-grid", false))\r
184                         channels_.push_back(make_safe<video_channel>(channels_.size()+1, core::video_format_desc::get(core::video_format::x576p2500), ogl_, default_channel_layout_repository().get_by_name(L"STEREO")));\r
185         }\r
186 \r
187         template<typename Base>\r
188         std::vector<safe_ptr<Base>> create_consumers(const boost::property_tree::wptree& pt)\r
189         {\r
190                 std::vector<safe_ptr<Base>> consumers;\r
191 \r
192                 create_consumers(pt, [&] (const safe_ptr<core::frame_consumer>& consumer)\r
193                 {\r
194                         consumers.push_back(dynamic_pointer_cast<Base>(consumer));\r
195                 });\r
196 \r
197                 return consumers;\r
198         }\r
199 \r
200         template<class Func>\r
201         void create_consumers(const boost::property_tree::wptree& pt, const Func& on_consumer)\r
202         {\r
203                 BOOST_FOREACH(auto& xml_consumer, pt)\r
204                 {\r
205                         try\r
206                         {\r
207                                 auto name = xml_consumer.first;\r
208 \r
209                                 if (name == L"screen")\r
210                                         on_consumer(ogl::create_consumer(xml_consumer.second));\r
211                                 else if (name == L"bluefish")                                   \r
212                                         on_consumer(bluefish::create_consumer(xml_consumer.second));                                    \r
213                                 else if (name == L"decklink")                                   \r
214                                         on_consumer(decklink::create_consumer(xml_consumer.second));                            \r
215                                 else if (name == L"file" || name == L"stream")                                  \r
216                                         on_consumer(ffmpeg::create_consumer(xml_consumer.second));                                              \r
217                                 else if (name == L"system-audio")\r
218                                         on_consumer(oal::create_consumer());\r
219                                 else if (name != L"<xmlcomment>")\r
220                                         CASPAR_LOG(warning) << "Invalid consumer: " << widen(name);     \r
221                         }\r
222                         catch(...)\r
223                         {\r
224                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
225                         }\r
226                 }\r
227         }\r
228                 \r
229         void setup_controllers(const boost::property_tree::wptree& pt)\r
230         {               \r
231                 using boost::property_tree::wptree;\r
232                 BOOST_FOREACH(auto& xml_controller, pt.get_child(L"configuration.controllers"))\r
233                 {\r
234                         try\r
235                         {\r
236                                 auto name = xml_controller.first;\r
237                                 auto protocol = xml_controller.second.get<std::wstring>(L"protocol");   \r
238 \r
239                                 if(name == L"tcp")\r
240                                 {                                       \r
241                                         unsigned int port = xml_controller.second.get(L"port", 5250);\r
242                                         auto asyncbootstrapper = make_safe<IO::AsyncEventServer>(create_protocol(protocol), port);\r
243                                         asyncbootstrapper->Start();\r
244                                         async_servers_.push_back(asyncbootstrapper);\r
245 \r
246                                         if (!primary_amcp_server_ && boost::iequals(protocol, L"AMCP"))\r
247                                                 primary_amcp_server_ = asyncbootstrapper;\r
248                                 }\r
249                                 else\r
250                                         CASPAR_LOG(warning) << "Invalid controller: " << widen(name);   \r
251                         }\r
252                         catch(...)\r
253                         {\r
254                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
255                         }\r
256                 }\r
257         }\r
258 \r
259         void setup_osc(const boost::property_tree::wptree& pt)\r
260         {               \r
261                 using boost::property_tree::wptree;\r
262                 using namespace boost::asio::ip;\r
263                 \r
264                 auto default_port =\r
265                                 pt.get<unsigned short>(L"configuration.osc.default-port", 6250);\r
266                 auto predefined_clients =\r
267                                 pt.get_child_optional(L"configuration.osc.predefined-clients");\r
268 \r
269                 if (predefined_clients)\r
270                 {\r
271                         BOOST_FOREACH(auto& predefined_client, *predefined_clients)\r
272                         {\r
273                                 const auto address =\r
274                                                 predefined_client.second.get<std::wstring>(L"address");\r
275                                 const auto port =\r
276                                                 predefined_client.second.get<unsigned short>(L"port");\r
277                                 predefined_osc_subscriptions_.push_back(\r
278                                                 osc_client_.get_subscription_token(udp::endpoint(\r
279                                                                 address_v4::from_string(narrow(address)),\r
280                                                                 port)));\r
281                         }\r
282                 }\r
283 \r
284                 if (primary_amcp_server_)\r
285                         primary_amcp_server_->add_lifecycle_factory(\r
286                                         [=] (const std::string& ipv4_address)\r
287                                                         -> std::shared_ptr<void>\r
288                                         {\r
289                                                 using namespace boost::asio::ip;\r
290 \r
291                                                 return osc_client_.get_subscription_token(\r
292                                                                 udp::endpoint(\r
293                                                                                 address_v4::from_string(ipv4_address),\r
294                                                                                 default_port));\r
295                                         });\r
296         }\r
297 \r
298         void setup_thumbnail_generation(const boost::property_tree::wptree& pt)\r
299         {\r
300                 if (!pt.get(L"configuration.thumbnails.generate-thumbnails", true))\r
301                         return;\r
302 \r
303                 auto scan_interval_millis = pt.get(L"configuration.thumbnails.scan-interval-millis", 5000);\r
304 \r
305                 polling_filesystem_monitor_factory monitor_factory(\r
306                                 io_service_manager_.service(),\r
307                                 scan_interval_millis);\r
308                 thumbnail_generator_.reset(new thumbnail_generator(\r
309                                 monitor_factory, \r
310                                 env::media_folder(),\r
311                                 env::thumbnails_folder(),\r
312                                 pt.get(L"configuration.thumbnails.width", 256),\r
313                                 pt.get(L"configuration.thumbnails.height", 144),\r
314                                 core::video_format_desc::get(pt.get(L"configuration.thumbnails.video-mode", L"720p2500")),\r
315                                 ogl_,\r
316                                 pt.get(L"configuration.thumbnails.generate-delay-millis", 2000),\r
317                                 &image::write_cropped_png));\r
318 \r
319                 CASPAR_LOG(info) << L"Initialized thumbnail generator.";\r
320         }\r
321 \r
322         safe_ptr<IO::IProtocolStrategy> create_protocol(const std::wstring& name) const\r
323         {\r
324                 if(boost::iequals(name, L"AMCP"))\r
325                         return make_safe<amcp::AMCPProtocolStrategy>(channels_, thumbnail_generator_, shutdown_server_now_);\r
326                 else if(boost::iequals(name, L"CII"))\r
327                         return make_safe<cii::CIIProtocolStrategy>(channels_);\r
328                 else if(boost::iequals(name, L"CLOCK"))\r
329                         //return make_safe<CLK::CLKProtocolStrategy>(channels_);\r
330                         return make_safe<IO::stateful_protocol_strategy_wrapper>([=]\r
331                         {\r
332                                 return std::make_shared<CLK::CLKProtocolStrategy>(channels_);\r
333                         });\r
334                 \r
335                 BOOST_THROW_EXCEPTION(caspar_exception() << arg_name_info("name") << arg_value_info(narrow(name)) << msg_info("Invalid protocol"));\r
336         }\r
337 };\r
338 \r
339 server::server(boost::promise<bool>& shutdown_server_now) : impl_(new implementation(shutdown_server_now)){}\r
340 \r
341 const std::vector<safe_ptr<video_channel>> server::get_channels() const\r
342 {\r
343         return impl_->channels_;\r
344 }\r
345 \r
346 std::shared_ptr<thumbnail_generator> server::get_thumbnail_generator() const\r
347 {\r
348         return impl_->thumbnail_generator_;\r
349 }\r
350 \r
351 core::monitor::source& server::monitor_output()\r
352 {\r
353         return impl_->monitor_subject_;\r
354 }\r
355 \r
356 }