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 boost::unique_future<std::wstring> frame_producer::call(const std::wstring&) \r
  39 {\r
  40         BOOST_THROW_EXCEPTION(not_supported());\r
  41 }\r
  42         \r
  43 std::vector<const producer_factory_t> g_factories;\r
  44         \r
  45 class destroy_producer_proxy : public frame_producer\r
  46 {       \r
  47         std::unique_ptr<std::shared_ptr<frame_producer>> producer_;\r
  48 public:\r
  49         destroy_producer_proxy(safe_ptr<frame_producer>&& producer) \r
  50                 : producer_(new std::shared_ptr<frame_producer>(std::move(producer)))\r
  51         {\r
  52         }\r
  53 \r
  54         ~destroy_producer_proxy()\r
  55         {               \r
  56                 static auto destroyers = std::make_shared<tbb::concurrent_bounded_queue<std::shared_ptr<executor>>>();\r
  57                 static tbb::atomic<int> destroyer_count;\r
  58 \r
  59                 try\r
  60                 {\r
  61                         std::shared_ptr<executor> destroyer;\r
  62                         if(!destroyers->try_pop(destroyer))\r
  63                         {\r
  64                                 destroyer.reset(new executor(L"destroyer"));\r
  65                                 destroyer->set_priority_class(below_normal_priority_class);\r
  66                                 if(++destroyer_count > 16)\r
  67                                         CASPAR_LOG(warning) << L"Potential destroyer dead-lock detected.";\r
  68                                 CASPAR_LOG(trace) << "Created destroyer: " << destroyer_count;\r
  69                         }\r
  70                                 \r
  71                         auto producer = producer_.release();\r
  72                         auto pool         = destroyers;\r
  73                         destroyer->begin_invoke([=]\r
  74                         {\r
  75                                 std::unique_ptr<std::shared_ptr<frame_producer>> producer2(producer);\r
  76 \r
  77                                 auto str = (*producer2)->print();\r
  78                                 try\r
  79                                 {\r
  80                                         if(!producer->unique())\r
  81                                                 CASPAR_LOG(trace) << str << L" Not destroyed on asynchronous destruction thread: " << producer->use_count();\r
  82                                         else\r
  83                                                 CASPAR_LOG(trace) << str << L" Destroying on asynchronous destruction thread.";\r
  84                                 }\r
  85                                 catch(...){}\r
  86                                                                 \r
  87                                 producer2.reset();\r
  88                                 pool->push(destroyer);\r
  89                         }); \r
  90                 }\r
  91                 catch(...)\r
  92                 {\r
  93                         CASPAR_LOG_CURRENT_EXCEPTION();\r
  94                         try\r
  95                         {\r
  96                                 producer_.reset();\r
  97                         }\r
  98                         catch(...){}\r
  99                 }\r
 100         }\r
 101 \r
 102         virtual safe_ptr<basic_frame>                                                           receive(int hints) override                                                                                             {return (*producer_)->receive(hints);}\r
 103         virtual safe_ptr<basic_frame>                                                           last_frame() const override                                                                                             {return (*producer_)->last_frame();}\r
 104         virtual std::wstring                                                                            print() const override                                                                                                  {return (*producer_)->print();}\r
 105         virtual boost::property_tree::wptree                                            info() const override                                                                                                   {return (*producer_)->info();}\r
 106         virtual boost::unique_future<std::wstring>                                      call(const std::wstring& str) override                                                                  {return (*producer_)->call(str);}\r
 107         virtual safe_ptr<frame_producer>                                                        get_following_producer() const override                                                                 {return (*producer_)->get_following_producer();}\r
 108         virtual void                                                                                            set_leading_producer(const safe_ptr<frame_producer>& producer) override {(*producer_)->set_leading_producer(producer);}\r
 109         virtual uint32_t                                                                                        nb_frames() const override                                                                                              {return (*producer_)->nb_frames();}\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 std::wstring                                                                            print() const override                                                                                                  {return (producer_)->print();}\r
 138         virtual boost::property_tree::wptree                                            info() const override                                                                                                   {return (producer_)->info();}\r
 139         virtual boost::unique_future<std::wstring>                                      call(const std::wstring& str) override                                                                  {return (producer_)->call(str);}\r
 140         virtual safe_ptr<frame_producer>                                                        get_following_producer() const override                                                                 {return (producer_)->get_following_producer();}\r
 141         virtual void                                                                                            set_leading_producer(const safe_ptr<frame_producer>& producer) override {(producer_)->set_leading_producer(producer);}\r
 142         virtual uint32_t                                                                                        nb_frames() const override                                                                                              {return (producer_)->nb_frames();}\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 std::wstring print() const{return L"dummy[" + print_ + L"]";}\r
 166         virtual uint32_t nb_frames() const {return nb_frames_;} \r
 167         virtual boost::property_tree::wptree info() const override\r
 168         {\r
 169                 boost::property_tree::wptree info;\r
 170                 info.add(L"type", L"last-frame-producer");\r
 171                 return info;\r
 172         }\r
 173 };\r
 174 \r
 175 struct empty_frame_producer : public frame_producer\r
 176 {\r
 177         virtual safe_ptr<basic_frame> receive(int){return basic_frame::empty();}\r
 178         virtual safe_ptr<basic_frame> last_frame() const{return basic_frame::empty();}\r
 179         virtual void set_frame_factory(const safe_ptr<frame_factory>&){}\r
 180         virtual uint32_t nb_frames() const {return 0;}\r
 181         virtual std::wstring print() const { return L"empty";}\r
 182         \r
 183         virtual boost::property_tree::wptree info() const override\r
 184         {\r
 185                 boost::property_tree::wptree info;\r
 186                 info.add(L"type", L"empty-producer");\r
 187                 return info;\r
 188         }\r
 189 };\r
 190 \r
 191 const safe_ptr<frame_producer>& frame_producer::empty() // nothrow\r
 192 {\r
 193         static safe_ptr<frame_producer> producer = make_safe<empty_frame_producer>();\r
 194         return producer;\r
 195 }       \r
 196 \r
 197 safe_ptr<basic_frame> receive_and_follow(safe_ptr<frame_producer>& producer, int hints)\r
 198 {       \r
 199         auto frame = producer->receive(hints);\r
 200         if(frame == basic_frame::eof())\r
 201         {\r
 202                 CASPAR_LOG(info) << producer->print() << " End Of File.";\r
 203                 auto following = producer->get_following_producer();\r
 204                 if(following != frame_producer::empty())\r
 205                 {\r
 206                         following->set_leading_producer(producer);\r
 207                         producer = std::move(following);\r
 208                 }\r
 209                 else\r
 210                         producer = make_safe<last_frame_producer>(producer);\r
 211 \r
 212                 return receive_and_follow(producer, hints);\r
 213         }\r
 214         return frame;\r
 215 }\r
 216 \r
 217 void register_producer_factory(const producer_factory_t& factory)\r
 218 {\r
 219         g_factories.push_back(factory);\r
 220 }\r
 221 \r
 222 safe_ptr<core::frame_producer> do_create_producer(const safe_ptr<frame_factory>& my_frame_factory, const std::vector<std::wstring>& params)\r
 223 {\r
 224         if(params.empty())\r
 225                 BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("params") << arg_value_info(""));\r
 226         \r
 227         auto producer = frame_producer::empty();\r
 228         std::any_of(g_factories.begin(), g_factories.end(), [&](const producer_factory_t& factory) -> bool\r
 229                 {\r
 230                         try\r
 231                         {\r
 232                                 producer = factory(my_frame_factory, params);\r
 233                         }\r
 234                         catch(...)\r
 235                         {\r
 236                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
 237                         }\r
 238                         return producer != frame_producer::empty();\r
 239                 });\r
 240 \r
 241         if(producer == frame_producer::empty())\r
 242                 producer = create_color_producer(my_frame_factory, params);\r
 243                 \r
 244         return producer;\r
 245 }\r
 246 \r
 247 \r
 248 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>& my_frame_factory, const std::vector<std::wstring>& params)\r
 249 {       \r
 250         auto producer = do_create_producer(my_frame_factory, params);\r
 251         auto key_producer = frame_producer::empty();\r
 252         \r
 253         try // to find a key file.\r
 254         {\r
 255                 auto params_copy = params;\r
 256                 if(params_copy.size() > 0)\r
 257                 {\r
 258                         params_copy[0] += L"_A";\r
 259                         key_producer = do_create_producer(my_frame_factory, params_copy);                       \r
 260                         if(key_producer == frame_producer::empty())\r
 261                         {\r
 262                                 params_copy[0] += L"LPHA";\r
 263                                 key_producer = do_create_producer(my_frame_factory, params_copy);       \r
 264                         }\r
 265                 }\r
 266         }\r
 267         catch(...){}\r
 268 \r
 269         if(producer != frame_producer::empty() && key_producer != frame_producer::empty())\r
 270                 return create_separated_producer(producer, key_producer);\r
 271         \r
 272         if(producer == frame_producer::empty())\r
 273         {\r
 274                 std::wstring str;\r
 275                 BOOST_FOREACH(auto& param, params)\r
 276                         str += param + L" ";\r
 277                 BOOST_THROW_EXCEPTION(file_not_found() << msg_info("No match found for supplied commands. Check syntax.") << arg_value_info(u8(str)));\r
 278         }\r
 279 \r
 280         return producer;\r
 281 }\r
 282 \r
 283 \r
 284 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>& factory, const std::wstring& params)\r
 285 {\r
 286         std::wstringstream iss(params);\r
 287         std::vector<std::wstring> tokens;\r
 288         typedef std::istream_iterator<std::wstring, wchar_t, std::char_traits<wchar_t> > iterator;\r
 289         std::copy(iterator(iss),  iterator(), std::back_inserter(tokens));\r
 290         return create_producer(factory, tokens);\r
 291 }\r
 292 \r
 293 }}