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