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