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