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