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/thumbnail_generator.h>
  44 #include <core/producer/media_info/media_info.h>
  45 #include <core/producer/media_info/media_info_repository.h>
  46 #include <core/producer/media_info/in_memory_media_info_repository.h>
  47 #include <core/producer/cg_proxy.h>
  48 #include <core/diagnostics/subject_diagnostics.h>
  49 #include <core/diagnostics/call_context.h>
  50 #include <core/diagnostics/osd_graph.h>
  51 #include <core/system_info_provider.h>
  52 #include <core/help/help_repository.h>
  53
  54 #include <modules/image/consumer/image_consumer.h>
  55
  56 #include <protocol/asio/io_service_manager.h>
  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
  72 #include <tbb/atomic.h>
  73
  74 #include <future>
  75
  76 namespace caspar {
  77
  78 using namespace core;
  79 using namespace protocol;
  80
  81 struct server::impl : boost::noncopyable
  82 {
  83         protocol::asio::io_service_manager                                      io_service_manager_;
  84         spl::shared_ptr<monitor::subject>                                       monitor_subject_;
  85         spl::shared_ptr<monitor::subject>                                       diag_subject_                                   = core::diagnostics::get_or_create_subject();
  86         accelerator::accelerator                                                        accelerator_;
  87         spl::shared_ptr<help_repository>                                        help_repo_;
  88         std::shared_ptr<amcp::amcp_command_repository>          amcp_command_repo_;
  89         std::vector<spl::shared_ptr<IO::AsyncEventServer>>      async_servers_;
  90         std::shared_ptr<IO::AsyncEventServer>                           primary_amcp_server_;
  91         osc::client                                                                                     osc_client_;
  92         std::vector<std::shared_ptr<void>>                                      predefined_osc_subscriptions_;
  93         std::vector<spl::shared_ptr<video_channel>>                     channels_;
  94         spl::shared_ptr<media_info_repository>                          media_info_repo_;
  95         boost::thread                                                                           initial_media_info_thread_;
  96         spl::shared_ptr<system_info_provider_repository>        system_info_provider_repo_;
  97         spl::shared_ptr<core::cg_producer_registry>                     cg_registry_;
  98         spl::shared_ptr<core::frame_producer_registry>          producer_registry_;
  99         spl::shared_ptr<core::frame_consumer_registry>          consumer_registry_;
 100         tbb::atomic<bool>                                                                       running_;
 101         std::shared_ptr<thumbnail_generator>                            thumbnail_generator_;
 102         std::promise<bool>&                                                                     shutdown_server_now_;
 103
 104         explicit impl(std::promise<bool>& shutdown_server_now)
 105                 : accelerator_(env::properties().get(L"configuration.accelerator", L"auto"))
 106                 , osc_client_(io_service_manager_.service())
 107                 , media_info_repo_(create_in_memory_media_info_repository())
 108                 , producer_registry_(spl::make_shared<core::frame_producer_registry>(help_repo_))
 109                 , consumer_registry_(spl::make_shared<core::frame_consumer_registry>(help_repo_))
 110                 , shutdown_server_now_(shutdown_server_now)
 111         {
 112                 running_ = false;
 113                 core::diagnostics::osd::register_sink();
 114                 diag_subject_->attach_parent(monitor_subject_);
 115
 116                 module_dependencies dependencies(
 117                                 system_info_provider_repo_,
 118                                 cg_registry_,
 119                                 media_info_repo_,
 120                                 producer_registry_,
 121                                 consumer_registry_);
 122
 123                 initialize_modules(dependencies);
 124                 core::text::init(dependencies);
 125                 core::scene::init(dependencies);
 126         }
 127
 128         void start()
 129         {
 130                 running_ = true;
 131
 132                 setup_channels(env::properties());
 133                 CASPAR_LOG(info) << L"Initialized channels.";
 134
 135                 setup_thumbnail_generation(env::properties());
 136                 CASPAR_LOG(info) << L"Initialized thumbnail generator.";
 137
 138                 setup_controllers(env::properties());
 139                 CASPAR_LOG(info) << L"Initialized controllers.";
 140
 141                 setup_osc(env::properties());
 142                 CASPAR_LOG(info) << L"Initialized osc.";
 143
 144                 start_initial_media_info_scan();
 145                 CASPAR_LOG(info) << L"Started initial media information retrieval.";
 146         }
 147
 148         ~impl()
 149         {
 150                 if (running_)
 151                 {
 152                         running_ = false;
 153                         initial_media_info_thread_.join();
 154                 }
 155
 156                 thumbnail_generator_.reset();
 157                 primary_amcp_server_.reset();
 158                 async_servers_.clear();
 159                 channels_.clear();
 160
 161                 boost::this_thread::sleep_for(boost::chrono::milliseconds(500));
 162                 //Sleep(500); // HACK: Wait for asynchronous destruction of producers and consumers.
 163
 164                 uninitialize_modules();
 165                 core::diagnostics::osd::shutdown();
 166         }
 167
 168         void setup_channels(const boost::property_tree::wptree& pt)
 169         {
 170                 using boost::property_tree::wptree;
 171                 for (auto& xml_channel : pt.get_child(L"configuration.channels"))
 172                 {
 173                         auto format_desc = video_format_desc(xml_channel.second.get(L"video-mode", L"PAL"));
 174                         if(format_desc.format == video_format::invalid)
 175                                 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info("Invalid video-mode."));
 176
 177                         auto channel = spl::make_shared<video_channel>(static_cast<int>(channels_.size()+1), format_desc, accelerator_.create_image_mixer());
 178
 179                         core::diagnostics::scoped_call_context save;
 180                         core::diagnostics::call_context::for_thread().video_channel = channel->index();
 181
 182                         for (auto& xml_consumer : xml_channel.second.get_child(L"consumers"))
 183                         {
 184                                 try
 185                                 {
 186                                         auto name = xml_consumer.first;
 187
 188                                         if (name != L"<xmlcomment>")
 189                                                 channel->output().add(consumer_registry_->create_consumer(name, xml_consumer.second, &channel->stage()));
 190                                 }
 191                                 catch(...)
 192                                 {
 193                                         CASPAR_LOG_CURRENT_EXCEPTION();
 194                                 }
 195                         }
 196
 197                     channel->monitor_output().attach_parent(monitor_subject_);
 198                         channels_.push_back(channel);
 199                 }
 200
 201                 // Dummy diagnostics channel
 202                 if(env::properties().get(L"configuration.channel-grid", false))
 203                         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()));
 204         }
 205
 206         void setup_osc(const boost::property_tree::wptree& pt)
 207         {
 208                 using boost::property_tree::wptree;
 209                 using namespace boost::asio::ip;
 210
 211                 monitor_subject_->attach_parent(osc_client_.sink());
 212
 213                 auto default_port =
 214                                 pt.get<unsigned short>(L"configuration.osc.default-port", 6250);
 215                 auto predefined_clients =
 216                                 pt.get_child_optional(L"configuration.osc.predefined-clients");
 217
 218                 if (predefined_clients)
 219                 {
 220                         for (auto& predefined_client : *predefined_clients)
 221                         {
 222                                 const auto address =
 223                                                 predefined_client.second.get<std::wstring>(L"address");
 224                                 const auto port =
 225                                                 predefined_client.second.get<unsigned short>(L"port");
 226                                 predefined_osc_subscriptions_.push_back(
 227                                                 osc_client_.get_subscription_token(udp::endpoint(
 228                                                                 address_v4::from_string(u8(address)),
 229                                                                 port)));
 230                         }
 231                 }
 232
 233                 if (primary_amcp_server_)
 234                         primary_amcp_server_->add_client_lifecycle_object_factory(
 235                                         [=] (const std::string& ipv4_address)
 236                                                         -> std::pair<std::wstring, std::shared_ptr<void>>
 237                                         {
 238                                                 using namespace boost::asio::ip;
 239
 240                                                 return std::make_pair(
 241                                                                 std::wstring(L"osc_subscribe"),
 242                                                                 osc_client_.get_subscription_token(
 243                                                                                 udp::endpoint(
 244                                                                                                 address_v4::from_string(
 245                                                                                                                 ipv4_address),
 246                                                                                                 default_port)));
 247                                         });
 248         }
 249
 250         void setup_thumbnail_generation(const boost::property_tree::wptree& pt)
 251         {
 252                 if (!pt.get(L"configuration.thumbnails.generate-thumbnails", true))
 253                         return;
 254
 255                 auto scan_interval_millis = pt.get(L"configuration.thumbnails.scan-interval-millis", 5000);
 256
 257                 polling_filesystem_monitor_factory monitor_factory(scan_interval_millis);
 258                 thumbnail_generator_.reset(new thumbnail_generator(
 259                         monitor_factory,
 260                         env::media_folder(),
 261                         env::thumbnails_folder(),
 262                         pt.get(L"configuration.thumbnails.width", 256),
 263                         pt.get(L"configuration.thumbnails.height", 144),
 264                         core::video_format_desc(pt.get(L"configuration.thumbnails.video-mode", L"720p2500")),
 265                         accelerator_.create_image_mixer(),
 266                         pt.get(L"configuration.thumbnails.generate-delay-millis", 2000),
 267                         &image::write_cropped_png,
 268                         media_info_repo_,
 269                         producer_registry_,
 270                         pt.get(L"configuration.thumbnails.mipmap", true)));
 271
 272                 CASPAR_LOG(info) << L"Initialized thumbnail generator.";
 273         }
 274
 275         void setup_controllers(const boost::property_tree::wptree& pt)
 276         {
 277                 amcp_command_repo_ = spl::make_shared<amcp::amcp_command_repository>(
 278                                 channels_,
 279                                 thumbnail_generator_,
 280                                 media_info_repo_,
 281                                 system_info_provider_repo_,
 282                                 cg_registry_,
 283                                 help_repo_,
 284                                 producer_registry_,
 285                                 consumer_registry_,
 286                                 shutdown_server_now_);
 287                 amcp::register_commands(*amcp_command_repo_);
 288
 289                 using boost::property_tree::wptree;
 290                 for (auto& xml_controller : pt.get_child(L"configuration.controllers"))
 291                 {
 292                         try
 293                         {
 294                                 auto name = xml_controller.first;
 295                                 auto protocol = xml_controller.second.get<std::wstring>(L"protocol");
 296
 297                                 if(name == L"tcp")
 298                                 {
 299                                         unsigned int port = xml_controller.second.get(L"port", 5250);
 300                                         auto asyncbootstrapper = spl::make_shared<IO::AsyncEventServer>(
 301                                                         create_protocol(protocol, L"TCP Port " + boost::lexical_cast<std::wstring>(port)),
 302                                                         port);
 303                                         async_servers_.push_back(asyncbootstrapper);
 304
 305                                         if (!primary_amcp_server_ && boost::iequals(protocol, L"AMCP"))
 306                                                 primary_amcp_server_ = asyncbootstrapper;
 307                                 }
 308                                 else
 309                                         CASPAR_LOG(warning) << "Invalid controller: " << name;
 310                         }
 311                         catch(...)
 312                         {
 313                                 CASPAR_LOG_CURRENT_EXCEPTION();
 314                         }
 315                 }
 316         }
 317
 318         IO::protocol_strategy_factory<char>::ptr create_protocol(const std::wstring& name, const std::wstring& port_description) const
 319         {
 320                 using namespace IO;
 321
 322                 if(boost::iequals(name, L"AMCP"))
 323                         return wrap_legacy_protocol("\r\n", spl::make_shared<amcp::AMCPProtocolStrategy>(port_description, spl::make_shared_ptr(amcp_command_repo_)));
 324                 else if(boost::iequals(name, L"CII"))
 325                         return wrap_legacy_protocol("\r\n", spl::make_shared<cii::CIIProtocolStrategy>(channels_, cg_registry_, producer_registry_));
 326                 else if(boost::iequals(name, L"CLOCK"))
 327                         return spl::make_shared<to_unicode_adapter_factory>(
 328                                         "ISO-8859-1",
 329                                         spl::make_shared<CLK::clk_protocol_strategy_factory>(channels_, cg_registry_, producer_registry_));
 330
 331                 CASPAR_THROW_EXCEPTION(caspar_exception() << arg_name_info(L"name") << arg_value_info(name) << msg_info(L"Invalid protocol"));
 332         }
 333
 334         void start_initial_media_info_scan()
 335         {
 336                 initial_media_info_thread_ = boost::thread([this]
 337                 {
 338                         for (boost::filesystem::wrecursive_directory_iterator iter(env::media_folder()), end; iter != end; ++iter)
 339                         {
 340                                 if (running_)
 341                                 {
 342                                         if (boost::filesystem::is_regular_file(iter->path()))
 343                                                 media_info_repo_->get(iter->path().wstring());
 344                                 }
 345                                 else
 346                                 {
 347                                         CASPAR_LOG(info) << L"Initial media information retrieval aborted.";
 348                                         return;
 349                                 }
 350                         }
 351
 352                         CASPAR_LOG(info) << L"Initial media information retrieval finished.";
 353                 });
 354         }
 355 };
 356
 357 server::server(std::promise<bool>& shutdown_server_now) : impl_(new impl(shutdown_server_now)){}
 358 void server::start() { impl_->start(); }
 359 spl::shared_ptr<core::system_info_provider_repository> server::get_system_info_provider_repo() const { return impl_->system_info_provider_repo_; }
 360 spl::shared_ptr<protocol::amcp::amcp_command_repository> server::get_amcp_command_repository() const { return spl::make_shared_ptr(impl_->amcp_command_repo_); }
 361 core::monitor::subject& server::monitor_output() { return *impl_->monitor_subject_; }
 362
 363 }