git.sesse.net Git - casparcg/blob - shell/server.cpp

   1 /*
   2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
   3 *
   4 * This file is part of CasparCG (www.casparcg.com).
   5 *
   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.
  10 *
  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.
  15 *
  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/>.
  18 *
  19 * Author: Robert Nagy, ronag89@gmail.com
  20 */
  21
  22 #include "stdafx.h"
  23
  24 #include "server.h"
  25 #include "included_modules.h"
  26 #include "default_audio_config.h"
  27
  28 #include <accelerator/accelerator.h>
  29
  30 #include <common/env.h>
  31 #include <common/except.h>
  32 #include <common/utf.h>
  33 #include <common/memory.h>
  34 #include <common/polling_filesystem_monitor.h>
  35 #include <common/ptree.h>
  36
  37 #include <core/video_channel.h>
  38 #include <core/video_format.h>
  39 #include <core/frame/audio_channel_layout.h>
  40 #include <core/producer/stage.h>
  41 #include <core/producer/frame_producer.h>
  42 #include <core/producer/scene/scene_producer.h>
  43 #include <core/producer/scene/xml_scene_producer.h>
  44 #include <core/producer/text/text_producer.h>
  45 #include <core/producer/color/color_producer.h>
  46 #include <core/consumer/output.h>
  47 #include <core/consumer/syncto/syncto_consumer.h>
  48 #include <core/mixer/mixer.h>
  49 #include <core/mixer/image/image_mixer.h>
  50 #include <core/thumbnail_generator.h>
  51 #include <core/producer/media_info/media_info.h>
  52 #include <core/producer/media_info/media_info_repository.h>
  53 #include <core/producer/media_info/in_memory_media_info_repository.h>
  54 #include <core/producer/cg_proxy.h>
  55 #include <core/diagnostics/subject_diagnostics.h>
  56 #include <core/diagnostics/call_context.h>
  57 #include <core/diagnostics/osd_graph.h>
  58 #include <core/diagnostics/graph_to_log_sink.h>
  59 #include <core/system_info_provider.h>
  60 #include <core/help/help_repository.h>
  61
  62 #include <modules/image/consumer/image_consumer.h>
  63
  64 #include <protocol/amcp/AMCPProtocolStrategy.h>
  65 #include <protocol/amcp/amcp_command_repository.h>
  66 #include <protocol/amcp/AMCPCommandsImpl.h>
  67 #include <protocol/cii/CIIProtocolStrategy.h>
  68 #include <protocol/clk/CLKProtocolStrategy.h>
  69 #include <protocol/util/AsyncEventServer.h>
  70 #include <protocol/util/strategy_adapters.h>
  71 #include <protocol/osc/client.h>
  72 #include <protocol/log/tcp_logger_protocol_strategy.h>
  73
  74 #include <boost/algorithm/string.hpp>
  75 #include <boost/thread.hpp>
  76 #include <boost/lexical_cast.hpp>
  77 #include <boost/property_tree/ptree.hpp>
  78 #include <boost/property_tree/xml_parser.hpp>
  79 #include <boost/asio.hpp>
  80
  81 #include <tbb/atomic.h>
  82
  83 #include <future>
  84
  85 namespace caspar {
  86
  87 using namespace core;
  88 using namespace protocol;
  89
  90 std::shared_ptr<boost::asio::io_service> create_running_io_service()
  91 {
  92         auto service = std::make_shared<boost::asio::io_service>();
  93         // To keep the io_service::run() running although no pending async
  94         // operations are posted.
  95         auto work = std::make_shared<boost::asio::io_service::work>(*service);
  96         auto weak_work = std::weak_ptr<boost::asio::io_service::work>(work);
  97         auto thread = std::make_shared<boost::thread>([service, weak_work]
  98         {
  99                 ensure_gpf_handler_installed_for_thread("asio-thread");
 100
 101                 while (auto strong = weak_work.lock())
 102                 {
 103                         try
 104                         {
 105                                 service->run();
 106                         }
 107                         catch (...)
 108                         {
 109                                 CASPAR_LOG_CURRENT_EXCEPTION();
 110                         }
 111                 }
 112
 113                 CASPAR_LOG(info) << "[asio] Global io_service uninitialized.";
 114         });
 115
 116         return std::shared_ptr<boost::asio::io_service>(
 117                         service.get(),
 118                         [service, work, thread](void*) mutable
 119                         {
 120                                 CASPAR_LOG(info) << "[asio] Shutting down global io_service.";
 121                                 work.reset();
 122                                 service->stop();
 123                                 if (thread->get_id() != boost::this_thread::get_id())
 124                                         thread->join();
 125                                 else
 126                                         thread->detach();
 127                         });
 128 }
 129
 130 struct server::impl : boost::noncopyable
 131 {
 132         std::shared_ptr<boost::asio::io_service>                        io_service_                                             = create_running_io_service();
 133         spl::shared_ptr<monitor::subject>                                       monitor_subject_;
 134         spl::shared_ptr<monitor::subject>                                       diag_subject_                                   = core::diagnostics::get_or_create_subject();
 135         accelerator::accelerator                                                        accelerator_;
 136         spl::shared_ptr<help_repository>                                        help_repo_;
 137         std::shared_ptr<amcp::amcp_command_repository>          amcp_command_repo_;
 138         std::vector<spl::shared_ptr<IO::AsyncEventServer>>      async_servers_;
 139         std::shared_ptr<IO::AsyncEventServer>                           primary_amcp_server_;
 140         std::shared_ptr<osc::client>                                            osc_client_                                             = std::make_shared<osc::client>(io_service_);
 141         std::vector<std::shared_ptr<void>>                                      predefined_osc_subscriptions_;
 142         std::vector<spl::shared_ptr<video_channel>>                     channels_;
 143         spl::shared_ptr<media_info_repository>                          media_info_repo_;
 144         boost::thread                                                                           initial_media_info_thread_;
 145         spl::shared_ptr<system_info_provider_repository>        system_info_provider_repo_;
 146         spl::shared_ptr<core::cg_producer_registry>                     cg_registry_;
 147         spl::shared_ptr<core::frame_producer_registry>          producer_registry_;
 148         spl::shared_ptr<core::frame_consumer_registry>          consumer_registry_;
 149         tbb::atomic<bool>                                                                       running_;
 150         std::shared_ptr<thumbnail_generator>                            thumbnail_generator_;
 151         std::promise<bool>&                                                                     shutdown_server_now_;
 152
 153         explicit impl(std::promise<bool>& shutdown_server_now)
 154                 : accelerator_(env::properties().get(L"configuration.accelerator", L"auto"))
 155                 , media_info_repo_(create_in_memory_media_info_repository())
 156                 , producer_registry_(spl::make_shared<core::frame_producer_registry>(help_repo_))
 157                 , consumer_registry_(spl::make_shared<core::frame_consumer_registry>(help_repo_))
 158                 , shutdown_server_now_(shutdown_server_now)
 159         {
 160                 running_ = false;
 161                 core::diagnostics::register_graph_to_log_sink();
 162                 caspar::core::diagnostics::osd::register_sink();
 163                 diag_subject_->attach_parent(monitor_subject_);
 164
 165                 module_dependencies dependencies(
 166                                 system_info_provider_repo_,
 167                                 cg_registry_,
 168                                 media_info_repo_,
 169                                 producer_registry_,
 170                                 consumer_registry_);
 171
 172                 initialize_modules(dependencies);
 173                 core::text::init(dependencies);
 174                 core::scene::init(dependencies);
 175                 core::syncto::init(dependencies);
 176                 help_repo_->register_item({ L"producer" }, L"Color Producer", &core::describe_color_producer);
 177         }
 178
 179         void start()
 180         {
 181                 running_ = true;
 182
 183                 setup_audio_config(env::properties());
 184                 CASPAR_LOG(info) << L"Initialized audio config.";
 185
 186                 setup_channels(env::properties());
 187                 CASPAR_LOG(info) << L"Initialized channels.";
 188
 189                 setup_thumbnail_generation(env::properties());
 190                 CASPAR_LOG(info) << L"Initialized thumbnail generator.";
 191
 192                 setup_controllers(env::properties());
 193                 CASPAR_LOG(info) << L"Initialized controllers.";
 194
 195                 setup_osc(env::properties());
 196                 CASPAR_LOG(info) << L"Initialized osc.";
 197
 198                 start_initial_media_info_scan();
 199                 CASPAR_LOG(info) << L"Started initial media information retrieval.";
 200         }
 201
 202         ~impl()
 203         {
 204                 if (running_)
 205                 {
 206                         running_ = false;
 207                         initial_media_info_thread_.join();
 208                 }
 209
 210                 std::weak_ptr<boost::asio::io_service> weak_io_service = io_service_;
 211                 io_service_.reset();
 212                 osc_client_.reset();
 213                 thumbnail_generator_.reset();
 214                 amcp_command_repo_.reset();
 215                 primary_amcp_server_.reset();
 216                 async_servers_.clear();
 217                 destroy_producers_synchronously();
 218                 destroy_consumers_synchronously();
 219                 channels_.clear();
 220
 221                 while (weak_io_service.lock())
 222                         boost::this_thread::sleep_for(boost::chrono::milliseconds(100));
 223
 224                 uninitialize_modules();
 225                 core::diagnostics::osd::shutdown();
 226         }
 227
 228         void setup_audio_config(const boost::property_tree::wptree& pt)
 229         {
 230                 using boost::property_tree::wptree;
 231
 232                 auto default_config = get_default_audio_config();
 233
 234                 // Start with the defaults
 235                 audio_channel_layout_repository::get_default()->register_all_layouts(default_config.get_child(L"audio.channel-layouts"));
 236                 audio_mix_config_repository::get_default()->register_all_configs(default_config.get_child(L"audio.mix-configs"));
 237
 238                 // Merge with user configuration (adds to or overwrites the defaults)
 239                 auto custom_channel_layouts     = pt.get_child_optional(L"configuration.audio.channel-layouts");
 240                 auto custom_mix_configs         = pt.get_child_optional(L"configuration.audio.mix-configs");
 241
 242                 if (custom_channel_layouts)
 243                 {
 244                         CASPAR_SCOPED_CONTEXT_MSG("/configuration/audio/channel-layouts");
 245                         audio_channel_layout_repository::get_default()->register_all_layouts(*custom_channel_layouts);
 246                 }
 247
 248                 if (custom_mix_configs)
 249                 {
 250                         CASPAR_SCOPED_CONTEXT_MSG("/configuration/audio/mix-configs");
 251                         audio_mix_config_repository::get_default()->register_all_configs(*custom_mix_configs);
 252                 }
 253         }
 254
 255         void setup_channels(const boost::property_tree::wptree& pt)
 256         {
 257                 using boost::property_tree::wptree;
 258
 259                 std::vector<wptree> xml_channels;
 260
 261                 for (auto& xml_channel : pt | witerate_children(L"configuration.channels") | welement_context_iteration)
 262                 {
 263                         xml_channels.push_back(xml_channel.second);
 264                         ptree_verify_element_name(xml_channel, L"channel");
 265
 266                         auto format_desc_str = xml_channel.second.get(L"video-mode", L"PAL");
 267                         auto format_desc = video_format_desc(format_desc_str);
 268                         if(format_desc.format == video_format::invalid)
 269                                 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Invalid video-mode: " + format_desc_str));
 270
 271                         auto channel_layout_str = xml_channel.second.get(L"channel-layout", L"stereo");
 272                         auto channel_layout = core::audio_channel_layout_repository::get_default()->get_layout(channel_layout_str);
 273                         if (!channel_layout)
 274                                 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Unknown channel-layout: " + channel_layout_str));
 275
 276                         auto channel_id = static_cast<int>(channels_.size() + 1);
 277                         auto channel = spl::make_shared<video_channel>(channel_id, format_desc, *channel_layout, accelerator_.create_image_mixer(channel_id));
 278
 279                         channel->monitor_output().attach_parent(monitor_subject_);
 280                         channel->mixer().set_straight_alpha_output(xml_channel.second.get(L"straight-alpha-output", false));
 281                         channels_.push_back(channel);
 282                 }
 283
 284                 for (auto& channel : channels_)
 285                 {
 286                         core::diagnostics::scoped_call_context save;
 287                         core::diagnostics::call_context::for_thread().video_channel = channel->index();
 288
 289                         for (auto& xml_consumer : xml_channels.at(channel->index() - 1) | witerate_children(L"consumers") | welement_context_iteration)
 290                         {
 291                                 auto name = xml_consumer.first;
 292
 293                                 try
 294                                 {
 295                                         if (name != L"<xmlcomment>")
 296                                                 channel->output().add(consumer_registry_->create_consumer(name, xml_consumer.second, &channel->stage(), channels_));
 297                                 }
 298                                 catch (const user_error& e)
 299                                 {
 300                                         CASPAR_LOG_CURRENT_EXCEPTION_AT_LEVEL(debug);
 301                                         CASPAR_LOG(error) << get_message_and_context(e) << " Turn on log level debug for stacktrace.";
 302                                 }
 303                                 catch (...)
 304                                 {
 305                                         CASPAR_LOG_CURRENT_EXCEPTION();
 306                                 }
 307                         }
 308                 }
 309
 310                 // Dummy diagnostics channel
 311                 if (env::properties().get(L"configuration.channel-grid", false))
 312                 {
 313                         auto channel_id = static_cast<int>(channels_.size() + 1);
 314                         channels_.push_back(spl::make_shared<video_channel>(
 315                                         channel_id,
 316                                         core::video_format_desc(core::video_format::x576p2500),
 317                                         *core::audio_channel_layout_repository::get_default()->get_layout(L"stereo"),
 318                                         accelerator_.create_image_mixer(channel_id)));
 319                         channels_.back()->monitor_output().attach_parent(monitor_subject_);
 320                 }
 321         }
 322
 323         void setup_osc(const boost::property_tree::wptree& pt)
 324         {
 325                 using boost::property_tree::wptree;
 326                 using namespace boost::asio::ip;
 327
 328                 monitor_subject_->attach_parent(osc_client_->sink());
 329
 330                 auto default_port =
 331                                 pt.get<unsigned short>(L"configuration.osc.default-port", 6250);
 332                 auto disable_send_to_amcp_clients =
 333                                 pt.get(L"configuration.osc.disable-send-to-amcp-clients", false);
 334                 auto predefined_clients =
 335                                 pt.get_child_optional(L"configuration.osc.predefined-clients");
 336
 337                 if (predefined_clients)
 338                 {
 339                         for (auto& predefined_client : pt | witerate_children(L"configuration.osc.predefined-clients") | welement_context_iteration)
 340                         {
 341                                 ptree_verify_element_name(predefined_client, L"predefined-client");
 342
 343                                 const auto address =
 344                                                 ptree_get<std::wstring>(predefined_client.second, L"address");
 345                                 const auto port =
 346                                                 ptree_get<unsigned short>(predefined_client.second, L"port");
 347                                 predefined_osc_subscriptions_.push_back(
 348                                                 osc_client_->get_subscription_token(udp::endpoint(
 349                                                                 address_v4::from_string(u8(address)),
 350                                                                 port)));
 351                         }
 352                 }
 353
 354                 if (!disable_send_to_amcp_clients && primary_amcp_server_)
 355                         primary_amcp_server_->add_client_lifecycle_object_factory(
 356                                         [=] (const std::string& ipv4_address)
 357                                                         -> std::pair<std::wstring, std::shared_ptr<void>>
 358                                         {
 359                                                 using namespace boost::asio::ip;
 360
 361                                                 return std::make_pair(
 362                                                                 std::wstring(L"osc_subscribe"),
 363                                                                 osc_client_->get_subscription_token(
 364                                                                                 udp::endpoint(
 365                                                                                                 address_v4::from_string(
 366                                                                                                                 ipv4_address),
 367                                                                                                 default_port)));
 368                                         });
 369         }
 370
 371         void setup_thumbnail_generation(const boost::property_tree::wptree& pt)
 372         {
 373                 if (!pt.get(L"configuration.thumbnails.generate-thumbnails", true))
 374                         return;
 375
 376                 auto scan_interval_millis = pt.get(L"configuration.thumbnails.scan-interval-millis", 5000);
 377
 378                 polling_filesystem_monitor_factory monitor_factory(io_service_, scan_interval_millis);
 379                 thumbnail_generator_.reset(new thumbnail_generator(
 380                         monitor_factory,
 381                         env::media_folder(),
 382                         env::thumbnail_folder(),
 383                         pt.get(L"configuration.thumbnails.width", 256),
 384                         pt.get(L"configuration.thumbnails.height", 144),
 385                         core::video_format_desc(pt.get(L"configuration.thumbnails.video-mode", L"720p2500")),
 386                         accelerator_.create_image_mixer(0),
 387                         pt.get(L"configuration.thumbnails.generate-delay-millis", 2000),
 388                         &image::write_cropped_png,
 389                         media_info_repo_,
 390                         producer_registry_,
 391                         pt.get(L"configuration.thumbnails.mipmap", true)));
 392         }
 393
 394         void setup_controllers(const boost::property_tree::wptree& pt)
 395         {
 396                 amcp_command_repo_ = spl::make_shared<amcp::amcp_command_repository>(
 397                                 channels_,
 398                                 thumbnail_generator_,
 399                                 media_info_repo_,
 400                                 system_info_provider_repo_,
 401                                 cg_registry_,
 402                                 help_repo_,
 403                                 producer_registry_,
 404                                 consumer_registry_,
 405                                 accelerator_.get_ogl_device(),
 406                                 shutdown_server_now_);
 407                 amcp::register_commands(*amcp_command_repo_);
 408
 409                 using boost::property_tree::wptree;
 410                 for (auto& xml_controller : pt | witerate_children(L"configuration.controllers") | welement_context_iteration)
 411                 {
 412                         auto name = xml_controller.first;
 413                         auto protocol = ptree_get<std::wstring>(xml_controller.second, L"protocol");
 414
 415                         if(name == L"tcp")
 416                         {
 417                                 auto port = ptree_get<unsigned int>(xml_controller.second, L"port");
 418                                 auto asyncbootstrapper = spl::make_shared<IO::AsyncEventServer>(
 419                                                 io_service_,
 420                                                 create_protocol(protocol, L"TCP Port " + boost::lexical_cast<std::wstring>(port)),
 421                                                 port);
 422                                 async_servers_.push_back(asyncbootstrapper);
 423
 424                                 if (!primary_amcp_server_ && boost::iequals(protocol, L"AMCP"))
 425                                         primary_amcp_server_ = asyncbootstrapper;
 426                         }
 427                         else
 428                                 CASPAR_LOG(warning) << "Invalid controller: " << name;
 429                 }
 430         }
 431
 432         IO::protocol_strategy_factory<char>::ptr create_protocol(const std::wstring& name, const std::wstring& port_description) const
 433         {
 434                 using namespace IO;
 435
 436                 if(boost::iequals(name, L"AMCP"))
 437                         return wrap_legacy_protocol("\r\n", spl::make_shared<amcp::AMCPProtocolStrategy>(port_description, spl::make_shared_ptr(amcp_command_repo_)));
 438                 else if(boost::iequals(name, L"CII"))
 439                         return wrap_legacy_protocol("\r\n", spl::make_shared<cii::CIIProtocolStrategy>(channels_, cg_registry_, producer_registry_));
 440                 else if(boost::iequals(name, L"CLOCK"))
 441                         return spl::make_shared<to_unicode_adapter_factory>(
 442                                         "ISO-8859-1",
 443                                         spl::make_shared<CLK::clk_protocol_strategy_factory>(channels_, cg_registry_, producer_registry_));
 444                 else if (boost::iequals(name, L"LOG"))
 445                         return spl::make_shared<protocol::log::tcp_logger_protocol_strategy_factory>();
 446
 447                 CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Invalid protocol: " + name));
 448         }
 449
 450         void start_initial_media_info_scan()
 451         {
 452                 initial_media_info_thread_ = boost::thread([this]
 453                 {
 454                         try
 455                         {
 456                                 ensure_gpf_handler_installed_for_thread("initial media scan");
 457
 458                                 for (boost::filesystem::wrecursive_directory_iterator iter(env::media_folder()), end; iter != end; ++iter)
 459                                 {
 460                                         if (running_)
 461                                         {
 462                                                 if (boost::filesystem::is_regular_file(iter->path()))
 463                                                         media_info_repo_->get(iter->path().wstring());
 464                                         }
 465                                         else
 466                                         {
 467                                                 CASPAR_LOG(info) << L"Initial media information retrieval aborted.";
 468                                                 return;
 469                                         }
 470                                 }
 471
 472                                 CASPAR_LOG(info) << L"Initial media information retrieval finished.";
 473                         }
 474                         catch (...)
 475                         {
 476                                 CASPAR_LOG_CURRENT_EXCEPTION();
 477                         }
 478                 });
 479         }
 480 };
 481
 482 server::server(std::promise<bool>& shutdown_server_now) : impl_(new impl(shutdown_server_now)){}
 483 void server::start() { impl_->start(); }
 484 spl::shared_ptr<core::system_info_provider_repository> server::get_system_info_provider_repo() const { return impl_->system_info_provider_repo_; }
 485 spl::shared_ptr<protocol::amcp::amcp_command_repository> server::get_amcp_command_repository() const { return spl::make_shared_ptr(impl_->amcp_command_repo_); }
 486 core::monitor::subject& server::monitor_output() { return *impl_->monitor_subject_; }
 487
 488 }