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