git.sesse.net Git - casparcg/blob - core/producer/frame_producer.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 "frame_producer.h"
  25
  26 #include "../frame/draw_frame.h"
  27 #include "../frame/frame_transform.h"
  28
  29 #include "color/color_producer.h"
  30 #include "draw/freehand_producer.h"
  31 #include "separated/separated_producer.h"
  32 #include "variable.h"
  33
  34 #include <common/assert.h>
  35 #include <common/except.h>
  36 #include <common/executor.h>
  37 #include <common/future.h>
  38 #include <common/memory.h>
  39
  40 #include <boost/thread.hpp>
  41
  42 namespace caspar { namespace core {
  43
  44 std::vector<producer_factory_t> g_producer_factories;
  45 std::vector<producer_factory_t> g_thumbnail_factories;
  46
  47 void register_producer_factory(const producer_factory_t& factory)
  48 {
  49         g_producer_factories.push_back(factory);
  50 }
  51 void register_thumbnail_producer_factory(const producer_factory_t& factory)
  52 {
  53         g_thumbnail_factories.push_back(factory);
  54 }
  55
  56 constraints::constraints(double width, double height)
  57         : width(width), height(height)
  58 {
  59 }
  60
  61 constraints::constraints()
  62 {
  63 }
  64
  65 struct frame_producer_base::impl
  66 {
  67         tbb::atomic<uint32_t>   frame_number_;
  68         tbb::atomic<bool>               paused_;
  69         frame_producer_base&    self_;
  70         draw_frame                              last_frame_;
  71
  72         impl(frame_producer_base& self)
  73                 : self_(self)
  74                 , last_frame_(draw_frame::empty())
  75         {
  76                 frame_number_ = 0;
  77                 paused_ = false;
  78         }
  79
  80         draw_frame receive()
  81         {
  82                 if(paused_)
  83                         return self_.last_frame();
  84
  85                 auto frame = self_.receive_impl();
  86                 if(frame == draw_frame::late())
  87                         return self_.last_frame();
  88
  89                 ++frame_number_;
  90
  91                 return last_frame_ = draw_frame::push(frame);
  92         }
  93
  94         void paused(bool value)
  95         {
  96                 paused_ = value;
  97         }
  98
  99         draw_frame last_frame()
 100         {
 101                 return draw_frame::still(last_frame_);
 102         }
 103         draw_frame create_thumbnail_frame()
 104         {
 105                 return draw_frame::empty();
 106         }
 107 };
 108
 109 frame_producer_base::frame_producer_base() : impl_(new impl(*this))
 110 {
 111 }
 112
 113 draw_frame frame_producer_base::receive()
 114 {
 115         return impl_->receive();
 116 }
 117
 118 void frame_producer_base::paused(bool value)
 119 {
 120         impl_->paused(value);
 121 }
 122
 123 draw_frame frame_producer_base::last_frame()
 124 {
 125         return impl_->last_frame();
 126 }
 127 draw_frame frame_producer_base::create_thumbnail_frame()
 128 {
 129         return impl_->create_thumbnail_frame();
 130 }
 131
 132 std::future<std::wstring> frame_producer_base::call(const std::vector<std::wstring>&)
 133 {
 134         CASPAR_THROW_EXCEPTION(not_supported());
 135 }
 136
 137 uint32_t frame_producer_base::nb_frames() const
 138 {
 139         return std::numeric_limits<uint32_t>::max();
 140 }
 141
 142 uint32_t frame_producer_base::frame_number() const
 143 {
 144         return impl_->frame_number_;
 145 }
 146
 147 variable& frame_producer_base::get_variable(const std::wstring& name)
 148 {
 149         CASPAR_THROW_EXCEPTION(caspar_exception()
 150                         << msg_info(L"No variable called " + name + L" found in " + print()));
 151 }
 152
 153 const std::vector<std::wstring>& frame_producer_base::get_variables() const
 154 {
 155         static std::vector<std::wstring> empty;
 156
 157         return empty;
 158 }
 159
 160 const spl::shared_ptr<frame_producer>& frame_producer::empty()
 161 {
 162         class empty_frame_producer : public frame_producer
 163         {
 164         public:
 165                 empty_frame_producer(){}
 166                 draw_frame receive() override{return draw_frame::empty();}
 167                 void paused(bool value) override{}
 168                 uint32_t nb_frames() const override {return 0;}
 169                 std::wstring print() const override { return L"empty";}
 170                 monitor::subject& monitor_output() override {static monitor::subject monitor_subject(""); return monitor_subject;}
 171                 std::wstring name() const override {return L"empty";}
 172                 uint32_t frame_number() const override {return 0;}
 173                 std::future<std::wstring> call(const std::vector<std::wstring>& params) override{CASPAR_THROW_EXCEPTION(not_supported());}
 174                 variable& get_variable(const std::wstring& name) override { CASPAR_THROW_EXCEPTION(not_supported()); }
 175                 const std::vector<std::wstring>& get_variables() const override { static std::vector<std::wstring> empty; return empty; }
 176                 draw_frame last_frame() {return draw_frame::empty();}
 177                 draw_frame create_thumbnail_frame() {return draw_frame::empty();}
 178                 constraints& pixel_constraints() override { static constraints c; return c; }
 179
 180                 boost::property_tree::wptree info() const override
 181                 {
 182                         boost::property_tree::wptree info;
 183                         info.add(L"type", L"empty-producer");
 184                         return info;
 185                 }
 186         };
 187
 188         static spl::shared_ptr<frame_producer> producer = spl::make_shared<empty_frame_producer>();
 189         return producer;
 190 }
 191
 192 class destroy_producer_proxy : public frame_producer
 193 {
 194         std::shared_ptr<frame_producer> producer_;
 195 public:
 196         destroy_producer_proxy(spl::shared_ptr<frame_producer>&& producer)
 197                 : producer_(std::move(producer))
 198         {
 199         }
 200
 201         virtual ~destroy_producer_proxy()
 202         {
 203                 static tbb::atomic<int> counter = tbb::atomic<int>();
 204
 205                 if(producer_ == core::frame_producer::empty())
 206                         return;
 207
 208                 ++counter;
 209                 CASPAR_VERIFY(counter < 8);
 210
 211                 auto producer = new spl::shared_ptr<frame_producer>(std::move(producer_));
 212                 boost::thread([=]
 213                 {
 214                         std::unique_ptr<spl::shared_ptr<frame_producer>> pointer_guard(producer);
 215                         auto str = (*producer)->print();
 216                         try
 217                         {
 218                                 if(!producer->unique())
 219                                         CASPAR_LOG(trace) << str << L" Not destroyed on asynchronous destruction thread: " << producer->use_count();
 220                                 else
 221                                         CASPAR_LOG(trace) << str << L" Destroying on asynchronous destruction thread.";
 222                         }
 223                         catch(...){}
 224
 225                         try
 226                         {
 227                                 pointer_guard.reset();
 228                                 CASPAR_LOG(info) << str << L" Destroyed.";
 229                         }
 230                         catch(...)
 231                         {
 232                                 CASPAR_LOG_CURRENT_EXCEPTION();
 233                         }
 234
 235                         --counter;
 236                 }).detach();
 237         }
 238
 239         draw_frame      receive() override                                                                                                                                                                                                              {return producer_->receive();}
 240         std::wstring                                                                            print() const override                                                                                                                  {return producer_->print();}
 241         void                                                                                            paused(bool value) override                                                                                                             {producer_->paused(value);}
 242         std::wstring                                                                            name() const override                                                                                                                   {return producer_->name();}
 243         uint32_t                                                                                        frame_number() const override                                                                                                   {return producer_->frame_number();}
 244         boost::property_tree::wptree                                            info() const override                                                                                                                   {return producer_->info();}
 245         std::future<std::wstring>                                                       call(const std::vector<std::wstring>& params) override                                                  {return producer_->call(params);}
 246         variable&                                                                                       get_variable(const std::wstring& name) override                                                                 {return producer_->get_variable(name);}
 247         const std::vector<std::wstring>&                                        get_variables() const override                                                                                                  {return producer_->get_variables();}
 248         void                                                                                            leading_producer(const spl::shared_ptr<frame_producer>& producer) override              {return producer_->leading_producer(producer);}
 249         uint32_t                                                                                        nb_frames() const override                                                                                                              {return producer_->nb_frames();}
 250         class draw_frame                                                                        last_frame()                                                                                                                                    {return producer_->last_frame();}
 251         draw_frame                                                                                      create_thumbnail_frame()                                                                                                                {return producer_->create_thumbnail_frame();}
 252         monitor::subject&                                                                       monitor_output() override                                                                                                               {return producer_->monitor_output();}
 253         bool                                                                                            collides(double x, double y) const override                                                                             {return producer_->collides(x, y);}
 254         void                                                                                            on_interaction(const interaction_event::ptr& event)     override                                        {return producer_->on_interaction(event);}
 255         constraints&                                                                            pixel_constraints() override                                                                                                    {return producer_->pixel_constraints();}
 256 };
 257
 258 spl::shared_ptr<core::frame_producer> create_destroy_proxy(spl::shared_ptr<core::frame_producer> producer)
 259 {
 260         return spl::make_shared<destroy_producer_proxy>(std::move(producer));
 261 }
 262
 263 spl::shared_ptr<core::frame_producer> do_create_producer(const spl::shared_ptr<frame_factory>& my_frame_factory, const video_format_desc& format_desc, const std::vector<std::wstring>& params, const std::vector<producer_factory_t>& factories, bool throw_on_fail = false)
 264 {
 265         if(params.empty())
 266                 CASPAR_THROW_EXCEPTION(invalid_argument() << arg_name_info("params") << arg_value_info(""));
 267
 268         auto producer = frame_producer::empty();
 269         std::any_of(factories.begin(), factories.end(), [&](const producer_factory_t& factory) -> bool
 270                 {
 271                         try
 272                         {
 273                                 producer = factory(my_frame_factory, format_desc, params);
 274                         }
 275                         catch(...)
 276                         {
 277                                 if(throw_on_fail)
 278                                         throw;
 279                                 else
 280                                         CASPAR_LOG_CURRENT_EXCEPTION();
 281                         }
 282                         return producer != frame_producer::empty();
 283                 });
 284
 285         if(producer == frame_producer::empty())
 286                 producer = create_color_producer(my_frame_factory, params);
 287
 288         if (producer == frame_producer::empty())
 289                 producer = create_freehand_producer(my_frame_factory, params);
 290
 291         if(producer == frame_producer::empty())
 292                 return producer;
 293
 294         return producer;
 295 }
 296
 297 spl::shared_ptr<core::frame_producer> create_thumbnail_producer(const spl::shared_ptr<frame_factory>& my_frame_factory, const video_format_desc& format_desc, const std::wstring& media_file)
 298 {
 299   std::vector<std::wstring> params;
 300   params.push_back(media_file);
 301
 302   auto producer = do_create_producer(my_frame_factory, format_desc, params, g_thumbnail_factories, true);
 303   auto key_producer = frame_producer::empty();
 304
 305   try // to find a key file.
 306   {
 307         auto params_copy = params;
 308         if (params_copy.size() > 0)
 309         {
 310           params_copy[0] += L"_A";
 311           key_producer = do_create_producer(my_frame_factory, format_desc, params_copy, g_thumbnail_factories, true);
 312           if (key_producer == frame_producer::empty())
 313           {
 314                 params_copy[0] += L"LPHA";
 315                 key_producer = do_create_producer(my_frame_factory, format_desc, params_copy, g_thumbnail_factories, true);
 316           }
 317         }
 318   }
 319   catch(...){}
 320
 321   if (producer != frame_producer::empty() && key_producer != frame_producer::empty())
 322         return create_separated_producer(producer, key_producer);
 323
 324   return producer;
 325 }
 326
 327 spl::shared_ptr<core::frame_producer> create_producer(const spl::shared_ptr<frame_factory>& my_frame_factory, const video_format_desc& format_desc, const std::vector<std::wstring>& params)
 328 {
 329         auto producer = do_create_producer(my_frame_factory, format_desc, params, g_producer_factories);
 330         auto key_producer = frame_producer::empty();
 331
 332         try // to find a key file.
 333         {
 334                 auto params_copy = params;
 335                 if(params_copy.size() > 0)
 336                 {
 337                         params_copy[0] += L"_A";
 338                         key_producer = do_create_producer(my_frame_factory, format_desc, params_copy, g_producer_factories);
 339                         if(key_producer == frame_producer::empty())
 340                         {
 341                                 params_copy[0] += L"LPHA";
 342                                 key_producer = do_create_producer(my_frame_factory, format_desc, params_copy, g_producer_factories);
 343                         }
 344                 }
 345         }
 346         catch(...){}
 347
 348         if(producer != frame_producer::empty() && key_producer != frame_producer::empty())
 349                 return create_separated_producer(producer, key_producer);
 350
 351         if(producer == frame_producer::empty())
 352         {
 353                 std::wstring str;
 354                 for (auto& param : params)
 355                         str += param + L" ";
 356                 CASPAR_THROW_EXCEPTION(file_not_found() << msg_info("No match found for supplied commands. Check syntax.") << arg_value_info(u8(str)));
 357         }
 358
 359         return producer;
 360 }
 361
 362
 363 spl::shared_ptr<core::frame_producer> create_producer(const spl::shared_ptr<frame_factory>& factory, const video_format_desc& format_desc, const std::wstring& params)
 364 {
 365         std::wstringstream iss(params);
 366         std::vector<std::wstring> tokens;
 367         typedef std::istream_iterator<std::wstring, wchar_t, std::char_traits<wchar_t> > iterator;
 368         std::copy(iterator(iss),  iterator(), std::back_inserter(tokens));
 369         return create_producer(factory, format_desc, tokens);
 370 }
 371
 372 }}