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 class destroy_producer_proxy : public frame_producer\r
  44 {       \r
  45         std::unique_ptr<std::shared_ptr<frame_producer>> producer_;\r
  46 public:\r
  47         destroy_producer_proxy(safe_ptr<frame_producer>&& producer) \r
  48                 : producer_(new std::shared_ptr<frame_producer>(std::move(producer)))\r
  49         {\r
  50         }\r
  51 \r
  52         ~destroy_producer_proxy()\r
  53         {               \r
  54                 static auto destroyers = std::make_shared<tbb::concurrent_bounded_queue<std::shared_ptr<executor>>>();\r
  55                 static tbb::atomic<int> destroyer_count;\r
  56 \r
  57                 try\r
  58                 {\r
  59                         std::shared_ptr<executor> destroyer;\r
  60                         if(!destroyers->try_pop(destroyer))\r
  61                         {\r
  62                                 destroyer.reset(new executor(L"destroyer"));\r
  63                                 destroyer->set_priority_class(below_normal_priority_class);\r
  64                                 if(++destroyer_count > 16)\r
  65                                         CASPAR_LOG(warning) << L"Potential destroyer dead-lock detected.";\r
  66                                 CASPAR_LOG(trace) << "Created destroyer: " << destroyer_count;\r
  67                         }\r
  68                                 \r
  69                         auto producer = producer_.release();\r
  70                         auto pool         = destroyers;\r
  71                         destroyer->begin_invoke([=]\r
  72                         {\r
  73                                 std::unique_ptr<std::shared_ptr<frame_producer>> producer2(producer);\r
  74 \r
  75                                 auto str = (*producer2)->print();\r
  76                                 try\r
  77                                 {\r
  78                                         if(!producer->unique())\r
  79                                                 CASPAR_LOG(trace) << str << L" Not destroyed on asynchronous destruction thread: " << producer->use_count();\r
  80                                         else\r
  81                                                 CASPAR_LOG(trace) << str << L" Destroying on asynchronous destruction thread.";\r
  82                                 }\r
  83                                 catch(...){}\r
  84                                                                 \r
  85                                 producer2.reset();\r
  86                                 pool->push(destroyer);\r
  87                         }); \r
  88                 }\r
  89                 catch(...)\r
  90                 {\r
  91                         CASPAR_LOG_CURRENT_EXCEPTION();\r
  92                         try\r
  93                         {\r
  94                                 producer_.reset();\r
  95                         }\r
  96                         catch(...){}\r
  97                 }\r
  98         }\r
  99 \r
 100         virtual safe_ptr<basic_frame>                                                           receive(int hints) override                                                                                             {return (*producer_)->receive(hints);}\r
 101         virtual safe_ptr<basic_frame>                                                           last_frame() const override                                                                                             {return (*producer_)->last_frame();}\r
 102         virtual safe_ptr<basic_frame>                                                           create_thumbnail_frame() override                                                                               {return (*producer_)->create_thumbnail_frame();}\r
 103         virtual std::wstring                                                                            print() const override                                                                                                  {return (*producer_)->print();}\r
 104         virtual boost::property_tree::wptree                                            info() const override                                                                                                   {return (*producer_)->info();}\r
 105         virtual boost::unique_future<std::wstring>                                      call(const std::wstring& str) override                                                                  {return (*producer_)->call(str);}\r
 106         virtual safe_ptr<frame_producer>                                                        get_following_producer() const override                                                                 {return (*producer_)->get_following_producer();}\r
 107         virtual void                                                                                            set_leading_producer(const safe_ptr<frame_producer>& producer) override {(*producer_)->set_leading_producer(producer);}\r
 108         virtual uint32_t                                                                                        nb_frames() const override                                                                                              {return (*producer_)->nb_frames();}\r
 109         virtual monitor::source&                                                                        monitor_output()                                                                                                                {return (*producer_)->monitor_output();}\r
 110 };\r
 111 \r
 112 safe_ptr<core::frame_producer> create_producer_destroy_proxy(safe_ptr<core::frame_producer> producer)\r
 113 {\r
 114         return make_safe<destroy_producer_proxy>(std::move(producer));\r
 115 }\r
 116 \r
 117 class print_producer_proxy : public frame_producer\r
 118 {       \r
 119         std::shared_ptr<frame_producer> producer_;\r
 120 public:\r
 121         print_producer_proxy(safe_ptr<frame_producer>&& producer) \r
 122                 : producer_(std::move(producer))\r
 123         {\r
 124                 CASPAR_LOG(info) << producer_->print() << L" Initialized.";\r
 125         }\r
 126 \r
 127         ~print_producer_proxy()\r
 128         {               \r
 129                 auto str = producer_->print();\r
 130                 CASPAR_LOG(trace) << str << L" Uninitializing.";\r
 131                 producer_.reset();\r
 132                 CASPAR_LOG(info) << str << L" Uninitialized.";\r
 133         }\r
 134 \r
 135         virtual safe_ptr<basic_frame>                                                           receive(int hints) override                                                                                             {return (producer_)->receive(hints);}\r
 136         virtual safe_ptr<basic_frame>                                                           last_frame() const override                                                                                             {return (producer_)->last_frame();}\r
 137         virtual safe_ptr<basic_frame>                                                           create_thumbnail_frame() override                                                                               {return (producer_)->create_thumbnail_frame();}\r
 138         virtual std::wstring                                                                            print() const override                                                                                                  {return (producer_)->print();}\r
 139         virtual boost::property_tree::wptree                                            info() const override                                                                                                   {return (producer_)->info();}\r
 140         virtual boost::unique_future<std::wstring>                                      call(const std::wstring& str) override                                                                  {return (producer_)->call(str);}\r
 141         virtual safe_ptr<frame_producer>                                                        get_following_producer() const override                                                                 {return (producer_)->get_following_producer();}\r
 142         virtual void                                                                                            set_leading_producer(const safe_ptr<frame_producer>& producer) override {(producer_)->set_leading_producer(producer);}\r
 143         virtual uint32_t                                                                                        nb_frames() const override                                                                                              {return (producer_)->nb_frames();}\r
 144         virtual monitor::source&                                                                        monitor_output()                                                                                                                {return (producer_)->monitor_output();}\r
 145 };\r
 146 \r
 147 safe_ptr<core::frame_producer> create_producer_print_proxy(safe_ptr<core::frame_producer> producer)\r
 148 {\r
 149         return make_safe<print_producer_proxy>(std::move(producer));\r
 150 }\r
 151 \r
 152 class last_frame_producer : public frame_producer\r
 153 {\r
 154         const std::wstring                      print_;\r
 155         const safe_ptr<basic_frame>     frame_;\r
 156         const uint32_t                          nb_frames_;\r
 157 public:\r
 158         last_frame_producer(const safe_ptr<frame_producer>& producer) \r
 159                 : print_(producer->print())\r
 160                 , frame_(producer->last_frame() != basic_frame::eof() ? producer->last_frame() : basic_frame::empty())\r
 161                 , nb_frames_(producer->nb_frames())\r
 162         {\r
 163         }\r
 164         \r
 165         virtual safe_ptr<basic_frame> receive(int){return frame_;}\r
 166         virtual safe_ptr<core::basic_frame> last_frame() const{return frame_;}\r
 167         virtual safe_ptr<core::basic_frame> create_thumbnail_frame() {return frame_;}\r
 168         virtual std::wstring print() const{return L"dummy[" + print_ + L"]";}\r
 169         virtual uint32_t nb_frames() const {return nb_frames_;} \r
 170         virtual boost::property_tree::wptree info() const override\r
 171         {\r
 172                 boost::property_tree::wptree info;\r
 173                 info.add(L"type", L"last-frame-producer");\r
 174                 return info;\r
 175         }\r
 176         virtual monitor::source& monitor_output()\r
 177         {\r
 178                 static monitor::subject monitor_subject("");\r
 179                 return monitor_subject;\r
 180         }\r
 181 };\r
 182 \r
 183 struct empty_frame_producer : public frame_producer\r
 184 {\r
 185         virtual safe_ptr<basic_frame> receive(int){return basic_frame::empty();}\r
 186         virtual safe_ptr<basic_frame> last_frame() const{return basic_frame::empty();}\r
 187         virtual void set_frame_factory(const safe_ptr<frame_factory>&){}\r
 188         virtual uint32_t nb_frames() const {return 0;}\r
 189         virtual std::wstring print() const { return L"empty";}\r
 190         \r
 191         virtual boost::property_tree::wptree info() const override\r
 192         {\r
 193                 boost::property_tree::wptree info;\r
 194                 info.add(L"type", L"empty-producer");\r
 195                 return info;\r
 196         }\r
 197 \r
 198         virtual monitor::source& monitor_output()\r
 199         {\r
 200                 static monitor::subject monitor_subject("");\r
 201                 return monitor_subject;\r
 202         }\r
 203 };\r
 204 \r
 205 const safe_ptr<frame_producer>& frame_producer::empty() // nothrow\r
 206 {\r
 207         static safe_ptr<frame_producer> producer = make_safe<empty_frame_producer>();\r
 208         return producer;\r
 209 }\r
 210 \r
 211 safe_ptr<basic_frame> frame_producer::create_thumbnail_frame()\r
 212 {\r
 213         return basic_frame::empty();\r
 214 }\r
 215 \r
 216 safe_ptr<basic_frame> receive_and_follow(safe_ptr<frame_producer>& producer, int hints)\r
 217 {       \r
 218         auto frame = producer->receive(hints);\r
 219         if(frame == basic_frame::eof())\r
 220         {\r
 221                 CASPAR_LOG(info) << producer->print() << " End Of File.";\r
 222                 auto following = producer->get_following_producer();\r
 223                 if(following != frame_producer::empty())\r
 224                 {\r
 225                         following->set_leading_producer(producer);\r
 226                         producer = std::move(following);\r
 227                 }\r
 228                 else\r
 229                         producer = make_safe<last_frame_producer>(producer);\r
 230 \r
 231                 return receive_and_follow(producer, hints);\r
 232         }\r
 233         return frame;\r
 234 }\r
 235 \r
 236 void register_producer_factory(const producer_factory_t& factory)\r
 237 {\r
 238         g_factories.push_back(factory);\r
 239 }\r
 240 \r
 241 void register_thumbnail_producer_factory(const producer_factory_t& factory)\r
 242 {\r
 243         g_thumbnail_factories.push_back(factory);\r
 244 }\r
 245 \r
 246 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
 247 {\r
 248         if(params.empty())\r
 249                 BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("params") << arg_value_info(""));\r
 250         \r
 251         auto producer = frame_producer::empty();\r
 252         std::any_of(factories.begin(), factories.end(), [&](const producer_factory_t& factory) -> bool\r
 253                 {\r
 254                         try\r
 255                         {\r
 256                                 producer = factory(my_frame_factory, params);\r
 257                         }\r
 258                         catch(...)\r
 259                         {\r
 260                                 if (throw_on_fail)\r
 261                                         throw;\r
 262                                 else\r
 263                                         CASPAR_LOG_CURRENT_EXCEPTION();\r
 264                         }\r
 265                         return producer != frame_producer::empty();\r
 266                 });\r
 267 \r
 268         if(producer == frame_producer::empty())\r
 269                 producer = create_color_producer(my_frame_factory, params);\r
 270         return producer;\r
 271 }\r
 272 \r
 273 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>& my_frame_factory, const core::parameters& params)\r
 274 {       \r
 275         auto producer = do_create_producer(my_frame_factory, params, g_factories);\r
 276         auto key_producer = frame_producer::empty();\r
 277         \r
 278         std::wstring resource_name = L"";\r
 279         auto tokens = parameters::protocol_split(params.at_original(0));\r
 280         if (tokens[0].empty())\r
 281         {\r
 282                 resource_name = params.at_original(0);\r
 283         }\r
 284 \r
 285         if(!resource_name.empty()) {\r
 286         try // to find a key file.\r
 287         {\r
 288                 auto params_copy = params;\r
 289                 if(params_copy.size() > 0)\r
 290                 {\r
 291                         auto resource_name = params_copy.at_original(0);\r
 292                         params_copy.set(0, resource_name + L"_A");\r
 293                         key_producer = do_create_producer(my_frame_factory, params_copy, g_factories);                  \r
 294                         if(key_producer == frame_producer::empty())\r
 295                         {\r
 296                                 params_copy.set(0, resource_name + L"_ALPHA");\r
 297                                 key_producer = do_create_producer(my_frame_factory, params_copy, g_factories);  \r
 298                         }\r
 299                 }\r
 300         }\r
 301         catch(...){}\r
 302         }\r
 303 \r
 304         if(producer != frame_producer::empty() && key_producer != frame_producer::empty())\r
 305                 return create_separated_producer(producer, key_producer);\r
 306         \r
 307         if(producer == frame_producer::empty())\r
 308         {\r
 309                 std::wstring str = params.get_original_string();\r
 310                 BOOST_THROW_EXCEPTION(file_not_found() << msg_info("No match found for supplied commands. Check syntax.") << arg_value_info(narrow(str)));\r
 311         }\r
 312 \r
 313         return producer;\r
 314 }\r
 315 \r
 316 safe_ptr<core::frame_producer> create_thumbnail_producer(const safe_ptr<frame_factory>& my_frame_factory, const std::wstring& media_file)\r
 317 {\r
 318         core::parameters params;\r
 319         params.push_back(media_file);\r
 320 \r
 321         auto producer = do_create_producer(my_frame_factory, params, g_thumbnail_factories, true);\r
 322         auto key_producer = frame_producer::empty();\r
 323         \r
 324         try // to find a key file.\r
 325         {\r
 326                 auto params_copy = params;\r
 327                 if (params_copy.size() > 0)\r
 328                 {\r
 329                         auto resource_name = params_copy.at_original(0);\r
 330                         params_copy.set(0, resource_name + L"_A");\r
 331                         key_producer = do_create_producer(my_frame_factory, params_copy, g_thumbnail_factories, true);\r
 332                         if (key_producer == frame_producer::empty())\r
 333                         {\r
 334                                 params_copy.set(0, resource_name + L"_ALPHA");\r
 335                                 key_producer = do_create_producer(my_frame_factory, params_copy, g_thumbnail_factories, true);\r
 336                         }\r
 337                 }\r
 338         }\r
 339         catch(...){}\r
 340 \r
 341         if (producer != frame_producer::empty() && key_producer != frame_producer::empty())\r
 342                 return create_separated_thumbnail_producer(producer, key_producer);\r
 343         \r
 344         return producer;\r
 345 }\r
 346 \r
 347 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>& factory, const std::wstring& param)\r
 348 {\r
 349         parameters params;\r
 350         params.push_back(param);\r
 351         return create_producer(factory, params);\r
 352 }\r
 353 \r
 354 }}