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