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 "playlist/playlist_producer.h"\r
  30 #include "separated/separated_producer.h"\r
  31 \r
  32 #include <common/memory/safe_ptr.h>\r
  33 #include <common/concurrency/executor.h>\r
  34 #include <common/exception/exceptions.h>\r
  35 #include <common/utility/move_on_copy.h>\r
  36 \r
  37 namespace caspar { namespace core {\r
  38         \r
  39 std::vector<const producer_factory_t> g_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 std::wstring                                                                            print() const override                                                                                                  {return (*producer_)->print();}\r
 101         virtual boost::property_tree::wptree                                            info() const override                                                                                                   {return (*producer_)->info();}\r
 102         virtual boost::unique_future<std::wstring>                                      call(const std::wstring& str) override                                                                  {return (*producer_)->call(str);}\r
 103         virtual safe_ptr<frame_producer>                                                        get_following_producer() const override                                                                 {return (*producer_)->get_following_producer();}\r
 104         virtual void                                                                                            set_leading_producer(const safe_ptr<frame_producer>& producer) override {(*producer_)->set_leading_producer(producer);}\r
 105         virtual uint32_t                                                                                        nb_frames() const override                                                                                              {return (*producer_)->nb_frames();}\r
 106 };\r
 107 \r
 108 safe_ptr<core::frame_producer> create_producer_destroy_proxy(safe_ptr<core::frame_producer> producer)\r
 109 {\r
 110         return make_safe<destroy_producer_proxy>(std::move(producer));\r
 111 }\r
 112 \r
 113 class print_producer_proxy : public frame_producer\r
 114 {       \r
 115         std::shared_ptr<frame_producer> producer_;\r
 116 public:\r
 117         print_producer_proxy(safe_ptr<frame_producer>&& producer) \r
 118                 : producer_(std::move(producer))\r
 119         {\r
 120                 CASPAR_LOG(info) << producer_->print() << L" Initialized.";\r
 121         }\r
 122 \r
 123         ~print_producer_proxy()\r
 124         {               \r
 125                 auto str = producer_->print();\r
 126                 CASPAR_LOG(trace) << str << L" Uninitializing.";\r
 127                 producer_.reset();\r
 128                 CASPAR_LOG(info) << str << L" Uninitialized.";\r
 129         }\r
 130 \r
 131         virtual safe_ptr<basic_frame>                                                           receive(int hints) override                                                                                             {return (producer_)->receive(hints);}\r
 132         virtual safe_ptr<basic_frame>                                                           last_frame() const override                                                                                             {return (producer_)->last_frame();}\r
 133         virtual std::wstring                                                                            print() const override                                                                                                  {return (producer_)->print();}\r
 134         virtual boost::property_tree::wptree                                            info() const override                                                                                                   {return (producer_)->info();}\r
 135         virtual boost::unique_future<std::wstring>                                      call(const std::wstring& str) override                                                                  {return (producer_)->call(str);}\r
 136         virtual safe_ptr<frame_producer>                                                        get_following_producer() const override                                                                 {return (producer_)->get_following_producer();}\r
 137         virtual void                                                                                            set_leading_producer(const safe_ptr<frame_producer>& producer) override {(producer_)->set_leading_producer(producer);}\r
 138         virtual uint32_t                                                                                        nb_frames() const override                                                                                              {return (producer_)->nb_frames();}\r
 139 };\r
 140 \r
 141 safe_ptr<core::frame_producer> create_producer_print_proxy(safe_ptr<core::frame_producer> producer)\r
 142 {\r
 143         return make_safe<print_producer_proxy>(std::move(producer));\r
 144 }\r
 145 \r
 146 class last_frame_producer : public frame_producer\r
 147 {\r
 148         const std::wstring                      print_;\r
 149         const safe_ptr<basic_frame>     frame_;\r
 150         const uint32_t                          nb_frames_;\r
 151 public:\r
 152         last_frame_producer(const safe_ptr<frame_producer>& producer) \r
 153                 : print_(producer->print())\r
 154                 , frame_(producer->last_frame() != basic_frame::eof() ? producer->last_frame() : basic_frame::empty())\r
 155                 , nb_frames_(producer->nb_frames())\r
 156         {\r
 157         }\r
 158         \r
 159         virtual safe_ptr<basic_frame> receive(int){return frame_;}\r
 160         virtual safe_ptr<core::basic_frame> last_frame() const{return frame_;}\r
 161         virtual std::wstring print() const{return L"dummy[" + print_ + L"]";}\r
 162         virtual uint32_t nb_frames() const {return nb_frames_;} \r
 163         virtual boost::property_tree::wptree info() const override\r
 164         {\r
 165                 boost::property_tree::wptree info;\r
 166                 info.add(L"type", L"last-frame-producer");\r
 167                 return info;\r
 168         }\r
 169 };\r
 170 \r
 171 struct empty_frame_producer : public frame_producer\r
 172 {\r
 173         virtual safe_ptr<basic_frame> receive(int){return basic_frame::empty();}\r
 174         virtual safe_ptr<basic_frame> last_frame() const{return basic_frame::empty();}\r
 175         virtual void set_frame_factory(const safe_ptr<frame_factory>&){}\r
 176         virtual uint32_t nb_frames() const {return 0;}\r
 177         virtual std::wstring print() const { return L"empty";}\r
 178         \r
 179         virtual boost::property_tree::wptree info() const override\r
 180         {\r
 181                 boost::property_tree::wptree info;\r
 182                 info.add(L"type", L"empty-producer");\r
 183                 return info;\r
 184         }\r
 185 };\r
 186 \r
 187 const safe_ptr<frame_producer>& frame_producer::empty() // nothrow\r
 188 {\r
 189         static safe_ptr<frame_producer> producer = make_safe<empty_frame_producer>();\r
 190         return producer;\r
 191 }       \r
 192 \r
 193 safe_ptr<basic_frame> receive_and_follow(safe_ptr<frame_producer>& producer, int hints)\r
 194 {       \r
 195         auto frame = producer->receive(hints);\r
 196         if(frame == basic_frame::eof())\r
 197         {\r
 198                 CASPAR_LOG(info) << producer->print() << " End Of File.";\r
 199                 auto following = producer->get_following_producer();\r
 200                 if(following != frame_producer::empty())\r
 201                 {\r
 202                         following->set_leading_producer(producer);\r
 203                         producer = std::move(following);\r
 204                 }\r
 205                 else\r
 206                         producer = make_safe<last_frame_producer>(producer);\r
 207 \r
 208                 return receive_and_follow(producer, hints);\r
 209         }\r
 210         return frame;\r
 211 }\r
 212 \r
 213 void register_producer_factory(const producer_factory_t& factory)\r
 214 {\r
 215         g_factories.push_back(factory);\r
 216 }\r
 217 \r
 218 safe_ptr<core::frame_producer> do_create_producer(const safe_ptr<frame_factory>& my_frame_factory, const std::vector<std::wstring>& params)\r
 219 {\r
 220         if(params.empty())\r
 221                 BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("params") << arg_value_info(""));\r
 222         \r
 223         auto producer = frame_producer::empty();\r
 224         std::any_of(g_factories.begin(), g_factories.end(), [&](const producer_factory_t& factory) -> bool\r
 225                 {\r
 226                         try\r
 227                         {\r
 228                                 producer = factory(my_frame_factory, params);\r
 229                         }\r
 230                         catch(...)\r
 231                         {\r
 232                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
 233                         }\r
 234                         return producer != frame_producer::empty();\r
 235                 });\r
 236 \r
 237         if(producer == frame_producer::empty())\r
 238                 producer = create_color_producer(my_frame_factory, params);\r
 239         \r
 240         if(producer == frame_producer::empty())\r
 241                 producer = create_playlist_producer(my_frame_factory, params);\r
 242         \r
 243         return producer;\r
 244 }\r
 245 \r
 246 \r
 247 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>& my_frame_factory, const std::vector<std::wstring>& params)\r
 248 {       \r
 249         auto producer = do_create_producer(my_frame_factory, params);\r
 250         auto key_producer = frame_producer::empty();\r
 251         \r
 252         try // to find a key file.\r
 253         {\r
 254                 auto params_copy = params;\r
 255                 if(params_copy.size() > 0)\r
 256                 {\r
 257                         params_copy[0] += L"_A";\r
 258                         key_producer = do_create_producer(my_frame_factory, params_copy);                       \r
 259                         if(key_producer == frame_producer::empty())\r
 260                         {\r
 261                                 params_copy[0] += L"LPHA";\r
 262                                 key_producer = do_create_producer(my_frame_factory, params_copy);       \r
 263                         }\r
 264                 }\r
 265         }\r
 266         catch(...){}\r
 267 \r
 268         if(producer != frame_producer::empty() && key_producer != frame_producer::empty())\r
 269                 return create_separated_producer(producer, key_producer);\r
 270         \r
 271         if(producer == frame_producer::empty())\r
 272         {\r
 273                 std::wstring str;\r
 274                 BOOST_FOREACH(auto& param, params)\r
 275                         str += param + L" ";\r
 276                 BOOST_THROW_EXCEPTION(file_not_found() << msg_info("No match found for supplied commands. Check syntax.") << arg_value_info(u8(str)));\r
 277         }\r
 278 \r
 279         return producer;\r
 280 }\r
 281 \r
 282 \r
 283 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>& factory, const std::wstring& params)\r
 284 {\r
 285         std::wstringstream iss(params);\r
 286         std::vector<std::wstring> tokens;\r
 287         typedef std::istream_iterator<std::wstring, wchar_t, std::char_traits<wchar_t> > iterator;\r
 288         std::copy(iterator(iss),  iterator(), std::back_inserter(tokens));\r
 289         return create_producer(factory, tokens);\r
 290 }\r
 291 \r
 292 }}