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