git.sesse.net Git - casparcg/blob - 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/consumer/synchronizing/synchronizing_consumer.h>\r
  39 #include <core/thumbnail_generator.h>\r
  40 #include <core/producer/media_info/media_info_repository.h>\r
  41 #include <core/producer/media_info/file_based_media_info_repository.h>\r
  42 \r
  43 #include <modules/bluefish/bluefish.h>\r
  44 #include <modules/decklink/decklink.h>\r
  45 #include <modules/ffmpeg/ffmpeg.h>\r
  46 #include <modules/flash/flash.h>\r
  47 #include <modules/oal/oal.h>\r
  48 #include <modules/ogl/ogl.h>\r
  49 #include <modules/newtek/newtek.h>\r
  50 #include <modules/silverlight/silverlight.h>\r
  51 #include <modules/image/image.h>\r
  52 #include <modules/image/consumer/image_consumer.h>\r
  53 \r
  54 #include <modules/oal/consumer/oal_consumer.h>\r
  55 #include <modules/bluefish/consumer/bluefish_consumer.h>\r
  56 #include <modules/newtek/consumer/newtek_ivga_consumer.h>\r
  57 #include <modules/decklink/consumer/decklink_consumer.h>\r
  58 #include <modules/decklink/consumer/blocking_decklink_consumer.h>\r
  59 #include <modules/ogl/consumer/ogl_consumer.h>\r
  60 #include <modules/ffmpeg/consumer/ffmpeg_consumer.h>\r
  61 \r
  62 #include <protocol/amcp/AMCPProtocolStrategy.h>\r
  63 #include <protocol/cii/CIIProtocolStrategy.h>\r
  64 #include <protocol/CLK/CLKProtocolStrategy.h>\r
  65 #include <protocol/util/AsyncEventServer.h>\r
  66 #include <protocol/util/stateful_protocol_strategy_wrapper.h>\r
  67 #include <protocol/osc/client.h>\r
  68 \r
  69 #include <boost/algorithm/string.hpp>\r
  70 #include <boost/lexical_cast.hpp>\r
  71 #include <boost/foreach.hpp>\r
  72 #include <boost/property_tree/ptree.hpp>\r
  73 #include <boost/property_tree/xml_parser.hpp>\r
  74 #include <boost/asio.hpp>\r
  75 \r
  76 namespace caspar {\r
  77 \r
  78 using namespace core;\r
  79 using namespace protocol;\r
  80 \r
  81 std::shared_ptr<boost::asio::io_service> create_running_io_service()\r
  82 {\r
  83         auto service = std::make_shared<boost::asio::io_service>();\r
  84         // To keep the io_service::run() running although no pending async\r
  85         // operations are posted.\r
  86         auto work = std::make_shared<boost::asio::io_service::work>(*service);\r
  87         auto thread = std::make_shared<boost::thread>([service]\r
  88         {\r
  89                 win32_exception::ensure_handler_installed_for_thread("asio-thread");\r
  90 \r
  91                 service->run();\r
  92         });\r
  93 \r
  94         return std::shared_ptr<boost::asio::io_service>(\r
  95                         service.get(),\r
  96                         [service, work, thread] (void*) mutable\r
  97                         {\r
  98                                 work.reset();\r
  99                                 service->stop();\r
 100                                 thread->join();\r
 101                         });\r
 102 }\r
 103 \r
 104 struct server::implementation : boost::noncopyable\r
 105 {\r
 106         std::shared_ptr<boost::asio::io_service>        io_service_;\r
 107         safe_ptr<core::monitor::subject>                        monitor_subject_;\r
 108         boost::promise<bool>&                                           shutdown_server_now_;\r
 109         safe_ptr<ogl_device>                                            ogl_;\r
 110         std::vector<safe_ptr<IO::AsyncEventServer>> async_servers_;     \r
 111         std::shared_ptr<IO::AsyncEventServer>           primary_amcp_server_;\r
 112         osc::client                                                                     osc_client_;\r
 113         std::vector<std::shared_ptr<void>>                      predefined_osc_subscriptions_;\r
 114         std::vector<safe_ptr<video_channel>>            channels_;\r
 115         safe_ptr<media_info_repository>                         media_info_repo_;\r
 116         std::shared_ptr<thumbnail_generator>            thumbnail_generator_;\r
 117 \r
 118         implementation(boost::promise<bool>& shutdown_server_now)\r
 119                 : io_service_(create_running_io_service())\r
 120                 , shutdown_server_now_(shutdown_server_now)\r
 121                 , ogl_(ogl_device::create())\r
 122                 , osc_client_(io_service_)\r
 123                 , media_info_repo_(create_file_based_media_info_repository(\r
 124                                 env::thumbnails_folder() + L"media_info.csv"))\r
 125         {\r
 126                 setup_audio(env::properties());\r
 127 \r
 128                 ffmpeg::init();\r
 129                 CASPAR_LOG(info) << L"Initialized ffmpeg module.";\r
 130                                                           \r
 131                 bluefish::init();         \r
 132                 CASPAR_LOG(info) << L"Initialized bluefish module.";\r
 133                                                           \r
 134                 decklink::init();         \r
 135                 CASPAR_LOG(info) << L"Initialized decklink module.";\r
 136 \r
 137                 oal::init();\r
 138                 CASPAR_LOG(info) << L"Initialized oal module.";\r
 139                                                           \r
 140                 newtek::init();\r
 141                 CASPAR_LOG(info) << L"Initialized newtek module.";\r
 142 \r
 143                 ogl::init();              \r
 144                 CASPAR_LOG(info) << L"Initialized ogl module.";\r
 145 \r
 146                 flash::init();            \r
 147                 CASPAR_LOG(info) << L"Initialized flash module.";\r
 148 \r
 149                 image::init();            \r
 150                 CASPAR_LOG(info) << L"Initialized image module.";\r
 151 \r
 152                 setup_channels(env::properties());\r
 153                 CASPAR_LOG(info) << L"Initialized channels.";\r
 154 \r
 155                 setup_thumbnail_generation(env::properties());\r
 156 \r
 157                 setup_controllers(env::properties());\r
 158                 CASPAR_LOG(info) << L"Initialized controllers.";\r
 159 \r
 160                 setup_osc(env::properties());\r
 161                 CASPAR_LOG(info) << L"Initialized osc.";\r
 162         }\r
 163 \r
 164         ~implementation()\r
 165         {\r
 166                 thumbnail_generator_.reset();\r
 167                 primary_amcp_server_.reset();\r
 168                 async_servers_.clear();\r
 169                 destroy_producers_synchronously();\r
 170                 channels_.clear();\r
 171 \r
 172                 ffmpeg::uninit();\r
 173         }\r
 174 \r
 175         void setup_audio(const boost::property_tree::wptree& pt)\r
 176         {\r
 177                 register_default_channel_layouts(default_channel_layout_repository());\r
 178                 register_default_mix_configs(default_mix_config_repository());\r
 179 \r
 180                 auto channel_layouts =\r
 181                         pt.get_child_optional(L"configuration.audio.channel-layouts");\r
 182                 auto mix_configs =\r
 183                         pt.get_child_optional(L"configuration.audio.mix-configs");\r
 184 \r
 185                 if (channel_layouts)\r
 186                         parse_channel_layouts(\r
 187                                         default_channel_layout_repository(), *channel_layouts);\r
 188 \r
 189                 if (mix_configs)\r
 190                         parse_mix_configs(\r
 191                                         default_mix_config_repository(), *mix_configs);\r
 192         }\r
 193                                 \r
 194         void setup_channels(const boost::property_tree::wptree& pt)\r
 195         {   \r
 196                 using boost::property_tree::wptree;\r
 197                 BOOST_FOREACH(auto& xml_channel, pt.get_child(L"configuration.channels"))\r
 198                 {               \r
 199                         auto format_desc = video_format_desc::get(widen(xml_channel.second.get(L"video-mode", L"PAL")));                \r
 200                         if(format_desc.format == video_format::invalid)\r
 201                                 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("Invalid video-mode."));\r
 202                         auto audio_channel_layout = default_channel_layout_repository().get_by_name(\r
 203                                         boost::to_upper_copy(xml_channel.second.get(L"channel-layout", L"STEREO")));\r
 204                         \r
 205                         channels_.push_back(make_safe<video_channel>(channels_.size()+1, format_desc, ogl_, audio_channel_layout));\r
 206                         \r
 207                         channels_.back()->monitor_output().attach_parent(monitor_subject_);\r
 208                         channels_.back()->mixer()->set_straight_alpha_output(\r
 209                                         xml_channel.second.get(L"straight-alpha-output", false));\r
 210 \r
 211                         create_consumers(\r
 212                                 xml_channel.second.get_child(L"consumers"),\r
 213                                 [&] (const safe_ptr<core::frame_consumer>& consumer)\r
 214                                 {\r
 215                                         channels_.back()->output()->add(consumer);\r
 216                                 });\r
 217                 }\r
 218 \r
 219                 // Dummy diagnostics channel\r
 220                 if(env::properties().get(L"configuration.channel-grid", false))\r
 221                         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
 222         }\r
 223 \r
 224         template<typename Base>\r
 225         std::vector<safe_ptr<Base>> create_consumers(const boost::property_tree::wptree& pt)\r
 226         {\r
 227                 std::vector<safe_ptr<Base>> consumers;\r
 228 \r
 229                 create_consumers(pt, [&] (const safe_ptr<core::frame_consumer>& consumer)\r
 230                 {\r
 231                         consumers.push_back(dynamic_pointer_cast<Base>(consumer));\r
 232                 });\r
 233 \r
 234                 return consumers;\r
 235         }\r
 236 \r
 237         template<class Func>\r
 238         void create_consumers(const boost::property_tree::wptree& pt, const Func& on_consumer)\r
 239         {\r
 240                 BOOST_FOREACH(auto& xml_consumer, pt)\r
 241                 {\r
 242                         try\r
 243                         {\r
 244                                 auto name = xml_consumer.first;\r
 245 \r
 246                                 if (name == L"screen")\r
 247                                         on_consumer(ogl::create_consumer(xml_consumer.second));\r
 248                                 else if (name == L"bluefish")                                   \r
 249                                         on_consumer(bluefish::create_consumer(xml_consumer.second));                                    \r
 250                                 else if (name == L"decklink")                                   \r
 251                                         on_consumer(decklink::create_consumer(xml_consumer.second));                            \r
 252                                 else if (name == L"newtek-ivga")                                        \r
 253                                         on_consumer(newtek::create_ivga_consumer(xml_consumer.second));                 \r
 254                                 else if (name == L"blocking-decklink")\r
 255                                         on_consumer(decklink::create_blocking_consumer(xml_consumer.second));                           \r
 256                                 else if (name == L"file" || name == L"stream")                                  \r
 257                                         on_consumer(ffmpeg::create_consumer(xml_consumer.second));                                              \r
 258                                 else if (name == L"system-audio")\r
 259                                         on_consumer(oal::create_consumer());\r
 260                                 else if (name == L"synchronizing")\r
 261                                         on_consumer(make_safe<core::synchronizing_consumer>(\r
 262                                                         create_consumers<core::frame_consumer>(\r
 263                                                                         xml_consumer.second)));\r
 264                                 else if (name != L"<xmlcomment>")\r
 265                                         CASPAR_LOG(warning) << "Invalid consumer: " << widen(name);     \r
 266                         }\r
 267                         catch(...)\r
 268                         {\r
 269                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
 270                         }\r
 271                 }\r
 272         }\r
 273                 \r
 274         void setup_controllers(const boost::property_tree::wptree& pt)\r
 275         {               \r
 276                 using boost::property_tree::wptree;\r
 277                 BOOST_FOREACH(auto& xml_controller, pt.get_child(L"configuration.controllers"))\r
 278                 {\r
 279                         try\r
 280                         {\r
 281                                 auto name = xml_controller.first;\r
 282                                 auto protocol = xml_controller.second.get<std::wstring>(L"protocol");   \r
 283 \r
 284                                 if(name == L"tcp")\r
 285                                 {                                       \r
 286                                         unsigned int port = xml_controller.second.get(L"port", 5250);\r
 287                                         auto asyncbootstrapper = make_safe<IO::AsyncEventServer>(create_protocol(protocol), port);\r
 288                                         asyncbootstrapper->Start();\r
 289                                         async_servers_.push_back(asyncbootstrapper);\r
 290 \r
 291                                         if (!primary_amcp_server_ && boost::iequals(protocol, L"AMCP"))\r
 292                                                 primary_amcp_server_ = asyncbootstrapper;\r
 293                                 }\r
 294                                 else\r
 295                                         CASPAR_LOG(warning) << "Invalid controller: " << widen(name);   \r
 296                         }\r
 297                         catch(...)\r
 298                         {\r
 299                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
 300                         }\r
 301                 }\r
 302         }\r
 303 \r
 304         void setup_osc(const boost::property_tree::wptree& pt)\r
 305         {               \r
 306                 using boost::property_tree::wptree;\r
 307                 using namespace boost::asio::ip;\r
 308 \r
 309                 monitor_subject_->attach_parent(osc_client_.sink());\r
 310                 \r
 311                 auto default_port =\r
 312                                 pt.get<unsigned short>(L"configuration.osc.default-port", 6250);\r
 313                 auto predefined_clients =\r
 314                                 pt.get_child_optional(L"configuration.osc.predefined-clients");\r
 315 \r
 316                 if (predefined_clients)\r
 317                 {\r
 318                         BOOST_FOREACH(auto& predefined_client, *predefined_clients)\r
 319                         {\r
 320                                 const auto address =\r
 321                                                 predefined_client.second.get<std::wstring>(L"address");\r
 322                                 const auto port =\r
 323                                                 predefined_client.second.get<unsigned short>(L"port");\r
 324                                 predefined_osc_subscriptions_.push_back(\r
 325                                                 osc_client_.get_subscription_token(udp::endpoint(\r
 326                                                                 address_v4::from_string(narrow(address)),\r
 327                                                                 port)));\r
 328                         }\r
 329                 }\r
 330 \r
 331                 if (primary_amcp_server_)\r
 332                         primary_amcp_server_->add_lifecycle_factory(\r
 333                                         [=] (const std::string& ipv4_address)\r
 334                                                         -> std::shared_ptr<void>\r
 335                                         {\r
 336                                                 using namespace boost::asio::ip;\r
 337 \r
 338                                                 return osc_client_.get_subscription_token(\r
 339                                                                 udp::endpoint(\r
 340                                                                                 address_v4::from_string(ipv4_address),\r
 341                                                                                 default_port));\r
 342                                         });\r
 343         }\r
 344 \r
 345         void setup_thumbnail_generation(const boost::property_tree::wptree& pt)\r
 346         {\r
 347                 if (!pt.get(L"configuration.thumbnails.generate-thumbnails", true))\r
 348                         return;\r
 349 \r
 350                 auto scan_interval_millis = pt.get(L"configuration.thumbnails.scan-interval-millis", 5000);\r
 351 \r
 352                 polling_filesystem_monitor_factory monitor_factory(\r
 353                                 io_service_, scan_interval_millis);\r
 354                 thumbnail_generator_.reset(new thumbnail_generator(\r
 355                                 monitor_factory, \r
 356                                 env::media_folder(),\r
 357                                 env::thumbnails_folder(),\r
 358                                 pt.get(L"configuration.thumbnails.width", 256),\r
 359                                 pt.get(L"configuration.thumbnails.height", 144),\r
 360                                 core::video_format_desc::get(pt.get(L"configuration.thumbnails.video-mode", L"720p2500")),\r
 361                                 ogl_,\r
 362                                 pt.get(L"configuration.thumbnails.generate-delay-millis", 2000),\r
 363                                 &image::write_cropped_png,\r
 364                                 media_info_repo_));\r
 365 \r
 366                 CASPAR_LOG(info) << L"Initialized thumbnail generator.";\r
 367         }\r
 368 \r
 369         safe_ptr<IO::IProtocolStrategy> create_protocol(const std::wstring& name) const\r
 370         {\r
 371                 if(boost::iequals(name, L"AMCP"))\r
 372                         return make_safe<amcp::AMCPProtocolStrategy>(channels_, thumbnail_generator_, media_info_repo_, shutdown_server_now_);\r
 373                 else if(boost::iequals(name, L"CII"))\r
 374                         return make_safe<cii::CIIProtocolStrategy>(channels_);\r
 375                 else if(boost::iequals(name, L"CLOCK"))\r
 376                         //return make_safe<CLK::CLKProtocolStrategy>(channels_);\r
 377                         return make_safe<IO::stateful_protocol_strategy_wrapper>([=]\r
 378                         {\r
 379                                 return std::make_shared<CLK::CLKProtocolStrategy>(channels_);\r
 380                         });\r
 381                 \r
 382                 BOOST_THROW_EXCEPTION(caspar_exception() << arg_name_info("name") << arg_value_info(narrow(name)) << msg_info("Invalid protocol"));\r
 383         }\r
 384 };\r
 385 \r
 386 server::server(boost::promise<bool>& shutdown_server_now) : impl_(new implementation(shutdown_server_now)){}\r
 387 \r
 388 const std::vector<safe_ptr<video_channel>> server::get_channels() const\r
 389 {\r
 390         return impl_->channels_;\r
 391 }\r
 392 \r
 393 std::shared_ptr<thumbnail_generator> server::get_thumbnail_generator() const\r
 394 {\r
 395         return impl_->thumbnail_generator_;\r
 396 }\r
 397 \r
 398 safe_ptr<media_info_repository> server::get_media_info_repo() const\r
 399 {\r
 400         return impl_->media_info_repo_;\r
 401 }\r
 402 \r
 403 core::monitor::subject& server::monitor_output()\r
 404 {\r
 405         return *impl_->monitor_subject_;\r
 406 }\r
 407 \r
 408 }