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