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

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