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