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