git.sesse.net Git - casparcg/blob - core/producer/frame_producer.cpp

   1 /*\r
   2 * Copyright 2013 Sveriges Television AB http://casparcg.com/\r
   3 *\r
   4 * This file is part of CasparCG (www.casparcg.com).\r
   5 *\r
   6 * CasparCG is free software: you can redistribute it and/or modify\r
   7 * it under the terms of the GNU General Public License as published by\r
   8 * the Free Software Foundation, either version 3 of the License, or\r
   9 * (at your option) any later version.\r
  10 *\r
  11 * CasparCG is distributed in the hope that it will be useful,\r
  12 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14 * GNU General Public License for more details.\r
  15 *\r
  16 * You should have received a copy of the GNU General Public License\r
  17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.\r
  18 *\r
  19 * Author: Robert Nagy, ronag89@gmail.com\r
  20 */\r
  21 \r
  22 #include "../StdAfx.h"\r
  23 \r
  24 #include "frame_producer.h"\r
  25 #include "frame/basic_frame.h"\r
  26 #include "frame/frame_transform.h"\r
  27 \r
  28 #include "../parameters/parameters.h"\r
  29 \r
  30 #include "color/color_producer.h"\r
  31 #include "separated/separated_producer.h"\r
  32 \r
  33 #include <common/memory/safe_ptr.h>\r
  34 #include <common/concurrency/executor.h>\r
  35 #include <common/exception/exceptions.h>\r
  36 #include <common/utility/move_on_copy.h>\r
  37 \r
  38 namespace caspar { namespace core {\r
  39         \r
  40 std::vector<const producer_factory_t> g_factories;\r
  41 std::vector<const producer_factory_t> g_thumbnail_factories;\r
  42 \r
  43 tbb::atomic<bool>& destroy_producers_in_separate_thread()\r
  44 {\r
  45         static tbb::atomic<bool> state;\r
  46 \r
  47         return state;\r
  48 }\r
  49 \r
  50 void destroy_producers_synchronously()\r
  51 {\r
  52         destroy_producers_in_separate_thread() = false;\r
  53 }\r
  54         \r
  55 class destroy_producer_proxy : public frame_producer\r
  56 {       \r
  57         std::unique_ptr<std::shared_ptr<frame_producer>> producer_;\r
  58 public:\r
  59         destroy_producer_proxy(safe_ptr<frame_producer>&& producer) \r
  60                 : producer_(new std::shared_ptr<frame_producer>(std::move(producer)))\r
  61         {\r
  62                 destroy_producers_in_separate_thread() = true;\r
  63         }\r
  64 \r
  65         ~destroy_producer_proxy()\r
  66         {\r
  67                 static auto destroyers = std::make_shared<tbb::concurrent_bounded_queue<std::shared_ptr<executor>>>();\r
  68                 static tbb::atomic<int> destroyer_count;\r
  69 \r
  70                 if (!destroy_producers_in_separate_thread())\r
  71                 {\r
  72                         try\r
  73                         {\r
  74                                 producer_.reset();\r
  75 \r
  76                                 std::shared_ptr<executor> destroyer;\r
  77 \r
  78                                 // Destruct any executors, causing them to execute pending tasks\r
  79                                 while (destroyers->try_pop(destroyer))\r
  80                                         --destroyer_count;\r
  81                         }\r
  82                         catch (...)\r
  83                         {\r
  84                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
  85                         }\r
  86 \r
  87                         return;\r
  88                 }\r
  89 \r
  90                 try\r
  91                 {\r
  92                         std::shared_ptr<executor> destroyer;\r
  93                         if(!destroyers->try_pop(destroyer))\r
  94                         {\r
  95                                 destroyer.reset(new executor(L"destroyer"));\r
  96                                 destroyer->set_priority_class(below_normal_priority_class);\r
  97                                 if(++destroyer_count > 16)\r
  98                                         CASPAR_LOG(warning) << L"Potential destroyer dead-lock detected.";\r
  99                                 CASPAR_LOG(trace) << "Created destroyer: " << destroyer_count;\r
 100                         }\r
 101                                 \r
 102                         auto producer = producer_.release();\r
 103                         auto pool         = destroyers;\r
 104                         destroyer->begin_invoke([=]\r
 105                         {\r
 106                                 std::unique_ptr<std::shared_ptr<frame_producer>> producer2(producer);\r
 107 \r
 108                                 auto str = (*producer2)->print();\r
 109                                 try\r
 110                                 {\r
 111                                         if(!producer->unique())\r
 112                                                 CASPAR_LOG(trace) << str << L" Not destroyed on asynchronous destruction thread: " << producer->use_count();\r
 113                                         else\r
 114                                                 CASPAR_LOG(trace) << str << L" Destroying on asynchronous destruction thread.";\r
 115                                 }\r
 116                                 catch(...){}\r
 117                                                                 \r
 118                                 producer2.reset();\r
 119                                 pool->push(destroyer);\r
 120                         }); \r
 121                 }\r
 122                 catch(...)\r
 123                 {\r
 124                         CASPAR_LOG_CURRENT_EXCEPTION();\r
 125                         try\r
 126                         {\r
 127                                 producer_.reset();\r
 128                         }\r
 129                         catch(...){}\r
 130                 }\r
 131         }\r
 132 \r
 133         virtual safe_ptr<basic_frame>                                                           receive(int hints) override                                                                                             {return (*producer_)->receive(hints);}\r
 134         virtual safe_ptr<basic_frame>                                                           last_frame() const override                                                                                             {return (*producer_)->last_frame();}\r
 135         virtual safe_ptr<basic_frame>                                                           create_thumbnail_frame() override                                                                               {return (*producer_)->create_thumbnail_frame();}\r
 136         virtual std::wstring                                                                            print() const override                                                                                                  {return (*producer_)->print();}\r
 137         virtual boost::property_tree::wptree                                            info() const override                                                                                                   {return (*producer_)->info();}\r
 138         virtual boost::unique_future<std::wstring>                                      call(const std::wstring& str) override                                                                  {return (*producer_)->call(str);}\r
 139         virtual safe_ptr<frame_producer>                                                        get_following_producer() const override                                                                 {return (*producer_)->get_following_producer();}\r
 140         virtual void                                                                                            set_leading_producer(const safe_ptr<frame_producer>& producer) override {(*producer_)->set_leading_producer(producer);}\r
 141         virtual uint32_t                                                                                        nb_frames() const override                                                                                              {return (*producer_)->nb_frames();}\r
 142         virtual monitor::source&                                                                        monitor_output()                                                                                                                {return (*producer_)->monitor_output();}\r
 143 };\r
 144 \r
 145 safe_ptr<core::frame_producer> create_producer_destroy_proxy(safe_ptr<core::frame_producer> producer)\r
 146 {\r
 147         return make_safe<destroy_producer_proxy>(std::move(producer));\r
 148 }\r
 149 \r
 150 class print_producer_proxy : public frame_producer\r
 151 {       \r
 152         std::shared_ptr<frame_producer> producer_;\r
 153 public:\r
 154         print_producer_proxy(safe_ptr<frame_producer>&& producer) \r
 155                 : producer_(std::move(producer))\r
 156         {\r
 157                 CASPAR_LOG(info) << producer_->print() << L" Initialized.";\r
 158         }\r
 159 \r
 160         ~print_producer_proxy()\r
 161         {               \r
 162                 auto str = producer_->print();\r
 163                 CASPAR_LOG(trace) << str << L" Uninitializing.";\r
 164                 producer_.reset();\r
 165                 CASPAR_LOG(info) << str << L" Uninitialized.";\r
 166         }\r
 167 \r
 168         virtual safe_ptr<basic_frame>                                                           receive(int hints) override                                                                                             {return (producer_)->receive(hints);}\r
 169         virtual safe_ptr<basic_frame>                                                           last_frame() const override                                                                                             {return (producer_)->last_frame();}\r
 170         virtual safe_ptr<basic_frame>                                                           create_thumbnail_frame() override                                                                               {return (producer_)->create_thumbnail_frame();}\r
 171         virtual std::wstring                                                                            print() const override                                                                                                  {return (producer_)->print();}\r
 172         virtual boost::property_tree::wptree                                            info() const override                                                                                                   {return (producer_)->info();}\r
 173         virtual boost::unique_future<std::wstring>                                      call(const std::wstring& str) override                                                                  {return (producer_)->call(str);}\r
 174         virtual safe_ptr<frame_producer>                                                        get_following_producer() const override                                                                 {return (producer_)->get_following_producer();}\r
 175         virtual void                                                                                            set_leading_producer(const safe_ptr<frame_producer>& producer) override {(producer_)->set_leading_producer(producer);}\r
 176         virtual uint32_t                                                                                        nb_frames() const override                                                                                              {return (producer_)->nb_frames();}\r
 177         virtual monitor::source&                                                                        monitor_output()                                                                                                                {return (producer_)->monitor_output();}\r
 178 };\r
 179 \r
 180 safe_ptr<core::frame_producer> create_producer_print_proxy(safe_ptr<core::frame_producer> producer)\r
 181 {\r
 182         return make_safe<print_producer_proxy>(std::move(producer));\r
 183 }\r
 184 \r
 185 class last_frame_producer : public frame_producer\r
 186 {\r
 187         const std::wstring                      print_;\r
 188         const safe_ptr<basic_frame>     frame_;\r
 189         const uint32_t                          nb_frames_;\r
 190 public:\r
 191         last_frame_producer(const safe_ptr<frame_producer>& producer) \r
 192                 : print_(producer->print())\r
 193                 , frame_(producer->last_frame() != basic_frame::eof() ? producer->last_frame() : basic_frame::empty())\r
 194                 , nb_frames_(producer->nb_frames())\r
 195         {\r
 196         }\r
 197         \r
 198         virtual safe_ptr<basic_frame> receive(int){return frame_;}\r
 199         virtual safe_ptr<core::basic_frame> last_frame() const{return frame_;}\r
 200         virtual safe_ptr<core::basic_frame> create_thumbnail_frame() {return frame_;}\r
 201         virtual std::wstring print() const{return L"dummy[" + print_ + L"]";}\r
 202         virtual uint32_t nb_frames() const {return nb_frames_;} \r
 203         virtual boost::property_tree::wptree info() const override\r
 204         {\r
 205                 boost::property_tree::wptree info;\r
 206                 info.add(L"type", L"last-frame-producer");\r
 207                 return info;\r
 208         }\r
 209         virtual monitor::source& monitor_output()\r
 210         {\r
 211                 static monitor::subject monitor_subject("");\r
 212                 return monitor_subject;\r
 213         }\r
 214 };\r
 215 \r
 216 struct empty_frame_producer : public frame_producer\r
 217 {\r
 218         virtual safe_ptr<basic_frame> receive(int){return basic_frame::empty();}\r
 219         virtual safe_ptr<basic_frame> last_frame() const{return basic_frame::empty();}\r
 220         virtual void set_frame_factory(const safe_ptr<frame_factory>&){}\r
 221         virtual uint32_t nb_frames() const {return 0;}\r
 222         virtual std::wstring print() const { return L"empty";}\r
 223         \r
 224         virtual boost::property_tree::wptree info() const override\r
 225         {\r
 226                 boost::property_tree::wptree info;\r
 227                 info.add(L"type", L"empty-producer");\r
 228                 return info;\r
 229         }\r
 230 \r
 231         virtual monitor::source& monitor_output()\r
 232         {\r
 233                 static monitor::subject monitor_subject("");\r
 234                 return monitor_subject;\r
 235         }\r
 236 };\r
 237 \r
 238 const safe_ptr<frame_producer>& frame_producer::empty() // nothrow\r
 239 {\r
 240         static safe_ptr<frame_producer> producer = make_safe<empty_frame_producer>();\r
 241         return producer;\r
 242 }\r
 243 \r
 244 safe_ptr<basic_frame> frame_producer::create_thumbnail_frame()\r
 245 {\r
 246         return basic_frame::empty();\r
 247 }\r
 248 \r
 249 safe_ptr<basic_frame> receive_and_follow(safe_ptr<frame_producer>& producer, int hints)\r
 250 {       \r
 251         auto frame = producer->receive(hints);\r
 252         if(frame == basic_frame::eof())\r
 253         {\r
 254                 CASPAR_LOG(info) << producer->print() << " End Of File.";\r
 255                 auto following = producer->get_following_producer();\r
 256                 if(following != frame_producer::empty())\r
 257                 {\r
 258                         following->set_leading_producer(producer);\r
 259                         producer = std::move(following);\r
 260                 }\r
 261                 else\r
 262                         producer = make_safe<last_frame_producer>(producer);\r
 263 \r
 264                 return receive_and_follow(producer, hints);\r
 265         }\r
 266         return frame;\r
 267 }\r
 268 \r
 269 void register_producer_factory(const producer_factory_t& factory)\r
 270 {\r
 271         g_factories.push_back(factory);\r
 272 }\r
 273 \r
 274 void register_thumbnail_producer_factory(const producer_factory_t& factory)\r
 275 {\r
 276         g_thumbnail_factories.push_back(factory);\r
 277 }\r
 278 \r
 279 safe_ptr<core::frame_producer> do_create_producer(const safe_ptr<frame_factory>& my_frame_factory, const core::parameters& params, const std::vector<const producer_factory_t>& factories, bool throw_on_fail = false)\r
 280 {\r
 281         if(params.empty())\r
 282                 BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("params") << arg_value_info(""));\r
 283         \r
 284         auto producer = frame_producer::empty();\r
 285         std::any_of(factories.begin(), factories.end(), [&](const producer_factory_t& factory) -> bool\r
 286                 {\r
 287                         try\r
 288                         {\r
 289                                 producer = factory(my_frame_factory, params);\r
 290                         }\r
 291                         catch(...)\r
 292                         {\r
 293                                 if (throw_on_fail)\r
 294                                         throw;\r
 295                                 else\r
 296                                         CASPAR_LOG_CURRENT_EXCEPTION();\r
 297                         }\r
 298                         return producer != frame_producer::empty();\r
 299                 });\r
 300 \r
 301         if(producer == frame_producer::empty())\r
 302                 producer = create_color_producer(my_frame_factory, params);\r
 303         return producer;\r
 304 }\r
 305 \r
 306 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>& my_frame_factory, const core::parameters& params)\r
 307 {       \r
 308         auto producer = do_create_producer(my_frame_factory, params, g_factories);\r
 309         auto key_producer = frame_producer::empty();\r
 310         \r
 311         std::wstring resource_name = L"";\r
 312         auto tokens = parameters::protocol_split(params.at_original(0));\r
 313         if (tokens[0].empty())\r
 314         {\r
 315                 resource_name = params.at_original(0);\r
 316         }\r
 317 \r
 318         if(!resource_name.empty()) {\r
 319         try // to find a key file.\r
 320         {\r
 321                 auto params_copy = params;\r
 322                 if(params_copy.size() > 0)\r
 323                 {\r
 324                         auto resource_name = params_copy.at_original(0);\r
 325                         params_copy.set(0, resource_name + L"_A");\r
 326                         key_producer = do_create_producer(my_frame_factory, params_copy, g_factories);                  \r
 327                         if(key_producer == frame_producer::empty())\r
 328                         {\r
 329                                 params_copy.set(0, resource_name + L"_ALPHA");\r
 330                                 key_producer = do_create_producer(my_frame_factory, params_copy, g_factories);  \r
 331                         }\r
 332                 }\r
 333         }\r
 334         catch(...){}\r
 335         }\r
 336 \r
 337         if(producer != frame_producer::empty() && key_producer != frame_producer::empty())\r
 338                 return create_separated_producer(producer, key_producer);\r
 339         \r
 340         if(producer == frame_producer::empty())\r
 341         {\r
 342                 std::wstring str = params.get_original_string();\r
 343                 BOOST_THROW_EXCEPTION(file_not_found() << msg_info("No match found for supplied commands. Check syntax.") << arg_value_info(narrow(str)));\r
 344         }\r
 345 \r
 346         return producer;\r
 347 }\r
 348 \r
 349 safe_ptr<core::frame_producer> create_thumbnail_producer(const safe_ptr<frame_factory>& my_frame_factory, const std::wstring& media_file)\r
 350 {\r
 351         core::parameters params;\r
 352         params.push_back(media_file);\r
 353 \r
 354         auto producer = do_create_producer(my_frame_factory, params, g_thumbnail_factories, true);\r
 355         auto key_producer = frame_producer::empty();\r
 356         \r
 357         try // to find a key file.\r
 358         {\r
 359                 auto params_copy = params;\r
 360                 if (params_copy.size() > 0)\r
 361                 {\r
 362                         auto resource_name = params_copy.at_original(0);\r
 363                         params_copy.set(0, resource_name + L"_A");\r
 364                         key_producer = do_create_producer(my_frame_factory, params_copy, g_thumbnail_factories, true);\r
 365                         if (key_producer == frame_producer::empty())\r
 366                         {\r
 367                                 params_copy.set(0, resource_name + L"_ALPHA");\r
 368                                 key_producer = do_create_producer(my_frame_factory, params_copy, g_thumbnail_factories, true);\r
 369                         }\r
 370                 }\r
 371         }\r
 372         catch(...){}\r
 373 \r
 374         if (producer != frame_producer::empty() && key_producer != frame_producer::empty())\r
 375                 return create_separated_thumbnail_producer(producer, key_producer);\r
 376         \r
 377         return producer;\r
 378 }\r
 379 \r
 380 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>& factory, const std::wstring& param)\r
 381 {\r
 382         parameters params;\r
 383         params.push_back(param);\r
 384         return create_producer(factory, params);\r
 385 }\r
 386 \r
 387 }}