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 \r
  26 #include "../frame/draw_frame.h"\r
  27 #include "../frame/frame_transform.h"\r
  28 \r
  29 #include "color/color_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/except.h>\r
  35 #include <common/utility/move_on_copy.h>\r
  36 \r
  37 namespace caspar { namespace core {\r
  38 \r
  39 boost::unique_future<std::wstring> frame_producer::call(const std::wstring&) \r
  40 {\r
  41         BOOST_THROW_EXCEPTION(not_supported());\r
  42 }\r
  43         \r
  44 std::vector<const producer_factory_t> g_factories;\r
  45         \r
  46 class destroy_producer_proxy : public frame_producer\r
  47 {       \r
  48         std::unique_ptr<std::shared_ptr<frame_producer>> producer_;\r
  49 public:\r
  50         destroy_producer_proxy(safe_ptr<frame_producer>&& producer) \r
  51                 : producer_(new std::shared_ptr<frame_producer>(std::move(producer)))\r
  52         {\r
  53         }\r
  54 \r
  55         ~destroy_producer_proxy()\r
  56         {               \r
  57                 static auto destroyers = std::make_shared<tbb::concurrent_bounded_queue<std::shared_ptr<executor>>>();\r
  58                 static tbb::atomic<int> destroyer_count;\r
  59 \r
  60                 try\r
  61                 {\r
  62                         std::shared_ptr<executor> destroyer;\r
  63                         if(!destroyers->try_pop(destroyer))\r
  64                         {\r
  65                                 destroyer.reset(new executor(L"destroyer"));\r
  66                                 destroyer->set_priority_class(below_normal_priority_class);\r
  67                                 if(++destroyer_count > 16)\r
  68                                         CASPAR_LOG(warning) << L"Potential destroyer dead-lock detected.";\r
  69                                 CASPAR_LOG(trace) << "Created destroyer: " << destroyer_count;\r
  70                         }\r
  71                                 \r
  72                         auto producer = producer_.release();\r
  73                         auto pool         = destroyers;\r
  74                         destroyer->begin_invoke([=]\r
  75                         {\r
  76                                 std::unique_ptr<std::shared_ptr<frame_producer>> producer2(producer);\r
  77 \r
  78                                 auto str = (*producer2)->print();\r
  79                                 try\r
  80                                 {\r
  81                                         if(!producer->unique())\r
  82                                                 CASPAR_LOG(trace) << str << L" Not destroyed on asynchronous destruction thread: " << producer->use_count();\r
  83                                         else\r
  84                                                 CASPAR_LOG(trace) << str << L" Destroying on asynchronous destruction thread.";\r
  85                                 }\r
  86                                 catch(...){}\r
  87                                                                 \r
  88                                 producer2.reset();\r
  89                                 pool->push(destroyer);\r
  90                         }); \r
  91                 }\r
  92                 catch(...)\r
  93                 {\r
  94                         CASPAR_LOG_CURRENT_EXCEPTION();\r
  95                         try\r
  96                         {\r
  97                                 producer_.reset();\r
  98                         }\r
  99                         catch(...){}\r
 100                 }\r
 101         }\r
 102 \r
 103         virtual safe_ptr<draw_frame>                                                            receive(int hints) override                                                                                             {return (*producer_)->receive(hints);}\r
 104         virtual safe_ptr<draw_frame>                                                            last_frame() const override                                                                                             {return (*producer_)->last_frame();}\r
 105         virtual std::wstring                                                                            print() const override                                                                                                  {return (*producer_)->print();}\r
 106         virtual boost::property_tree::wptree                                            info() const override                                                                                                   {return (*producer_)->info();}\r
 107         virtual boost::unique_future<std::wstring>                                      call(const std::wstring& str) override                                                                  {return (*producer_)->call(str);}\r
 108         virtual safe_ptr<frame_producer>                                                        get_following_producer() const override                                                                 {return (*producer_)->get_following_producer();}\r
 109         virtual void                                                                                            set_leading_producer(const safe_ptr<frame_producer>& producer) override {(*producer_)->set_leading_producer(producer);}\r
 110         virtual uint32_t                                                                                        nb_frames() const override                                                                                              {return (*producer_)->nb_frames();}\r
 111 };\r
 112 \r
 113 safe_ptr<core::frame_producer> create_producer_destroy_proxy(safe_ptr<core::frame_producer> producer)\r
 114 {\r
 115         return make_safe<destroy_producer_proxy>(std::move(producer));\r
 116 }\r
 117 \r
 118 class print_producer_proxy : public frame_producer\r
 119 {       \r
 120         std::shared_ptr<frame_producer> producer_;\r
 121 public:\r
 122         print_producer_proxy(safe_ptr<frame_producer>&& producer) \r
 123                 : producer_(std::move(producer))\r
 124         {\r
 125                 CASPAR_LOG(info) << producer_->print() << L" Initialized.";\r
 126         }\r
 127 \r
 128         ~print_producer_proxy()\r
 129         {               \r
 130                 auto str = producer_->print();\r
 131                 CASPAR_LOG(trace) << str << L" Uninitializing.";\r
 132                 producer_.reset();\r
 133                 CASPAR_LOG(info) << str << L" Uninitialized.";\r
 134         }\r
 135 \r
 136         virtual safe_ptr<draw_frame>                                                            receive(int hints) override                                                                                             {return (producer_)->receive(hints);}\r
 137         virtual safe_ptr<draw_frame>                                                            last_frame() const override                                                                                             {return (producer_)->last_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 };\r
 145 \r
 146 safe_ptr<core::frame_producer> create_producer_print_proxy(safe_ptr<core::frame_producer> producer)\r
 147 {\r
 148         return make_safe<print_producer_proxy>(std::move(producer));\r
 149 }\r
 150 \r
 151 class last_frame_producer : public frame_producer\r
 152 {\r
 153         const std::wstring                      print_;\r
 154         const safe_ptr<draw_frame>      frame_;\r
 155         const uint32_t                          nb_frames_;\r
 156 public:\r
 157         last_frame_producer(const safe_ptr<frame_producer>& producer) \r
 158                 : print_(producer->print())\r
 159                 , frame_(producer->last_frame() != draw_frame::eof() ? producer->last_frame() : draw_frame::empty())\r
 160                 , nb_frames_(producer->nb_frames())\r
 161         {\r
 162         }\r
 163         \r
 164         virtual safe_ptr<draw_frame> receive(int){return frame_;}\r
 165         virtual safe_ptr<core::draw_frame> last_frame() const{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 };\r
 175 \r
 176 struct empty_frame_producer : public frame_producer\r
 177 {\r
 178         virtual safe_ptr<draw_frame> receive(int){return draw_frame::empty();}\r
 179         virtual safe_ptr<draw_frame> last_frame() const{return draw_frame::empty();}\r
 180         virtual void set_frame_factory(const safe_ptr<frame_factory>&){}\r
 181         virtual uint32_t nb_frames() const {return 0;}\r
 182         virtual std::wstring print() const { return L"empty";}\r
 183         \r
 184         virtual boost::property_tree::wptree info() const override\r
 185         {\r
 186                 boost::property_tree::wptree info;\r
 187                 info.add(L"type", L"empty-producer");\r
 188                 return info;\r
 189         }\r
 190 };\r
 191 \r
 192 const safe_ptr<frame_producer>& frame_producer::empty() // nothrow\r
 193 {\r
 194         static safe_ptr<frame_producer> producer = make_safe<empty_frame_producer>();\r
 195         return producer;\r
 196 }       \r
 197 \r
 198 safe_ptr<draw_frame> receive_and_follow(safe_ptr<frame_producer>& producer, int hints)\r
 199 {       \r
 200         auto frame = producer->receive(hints);\r
 201         if(frame == draw_frame::eof())\r
 202         {\r
 203                 CASPAR_LOG(info) << producer->print() << " End Of File.";\r
 204                 auto following = producer->get_following_producer();\r
 205                 if(following != frame_producer::empty())\r
 206                 {\r
 207                         following->set_leading_producer(producer);\r
 208                         producer = std::move(following);\r
 209                 }\r
 210                 else\r
 211                         producer = make_safe<last_frame_producer>(producer);\r
 212 \r
 213                 return receive_and_follow(producer, hints);\r
 214         }\r
 215         return frame;\r
 216 }\r
 217 \r
 218 void register_producer_factory(const producer_factory_t& factory)\r
 219 {\r
 220         g_factories.push_back(factory);\r
 221 }\r
 222 \r
 223 safe_ptr<core::frame_producer> do_create_producer(const safe_ptr<frame_factory>& my_frame_factory, const std::vector<std::wstring>& params)\r
 224 {\r
 225         if(params.empty())\r
 226                 BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("params") << arg_value_info(""));\r
 227         \r
 228         auto producer = frame_producer::empty();\r
 229         std::any_of(g_factories.begin(), g_factories.end(), [&](const producer_factory_t& factory) -> bool\r
 230                 {\r
 231                         try\r
 232                         {\r
 233                                 producer = factory(my_frame_factory, params);\r
 234                         }\r
 235                         catch(...)\r
 236                         {\r
 237                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
 238                         }\r
 239                         return producer != frame_producer::empty();\r
 240                 });\r
 241 \r
 242         if(producer == frame_producer::empty())\r
 243                 producer = create_color_producer(my_frame_factory, params);\r
 244                 \r
 245         return producer;\r
 246 }\r
 247 \r
 248 \r
 249 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>& my_frame_factory, const std::vector<std::wstring>& params)\r
 250 {       \r
 251         auto producer = do_create_producer(my_frame_factory, params);\r
 252         auto key_producer = frame_producer::empty();\r
 253         \r
 254         try // to find a key file.\r
 255         {\r
 256                 auto params_copy = params;\r
 257                 if(params_copy.size() > 0)\r
 258                 {\r
 259                         params_copy[0] += L"_A";\r
 260                         key_producer = do_create_producer(my_frame_factory, params_copy);                       \r
 261                         if(key_producer == frame_producer::empty())\r
 262                         {\r
 263                                 params_copy[0] += L"LPHA";\r
 264                                 key_producer = do_create_producer(my_frame_factory, params_copy);       \r
 265                         }\r
 266                 }\r
 267         }\r
 268         catch(...){}\r
 269 \r
 270         if(producer != frame_producer::empty() && key_producer != frame_producer::empty())\r
 271                 return create_separated_producer(producer, key_producer);\r
 272         \r
 273         if(producer == frame_producer::empty())\r
 274         {\r
 275                 std::wstring str;\r
 276                 BOOST_FOREACH(auto& param, params)\r
 277                         str += param + L" ";\r
 278                 BOOST_THROW_EXCEPTION(file_not_found() << msg_info("No match found for supplied commands. Check syntax.") << arg_value_info(u8(str)));\r
 279         }\r
 280 \r
 281         return producer;\r
 282 }\r
 283 \r
 284 \r
 285 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>& factory, const std::wstring& params)\r
 286 {\r
 287         std::wstringstream iss(params);\r
 288         std::vector<std::wstring> tokens;\r
 289         typedef std::istream_iterator<std::wstring, wchar_t, std::char_traits<wchar_t> > iterator;\r
 290         std::copy(iterator(iss),  iterator(), std::back_inserter(tokens));\r
 291         return create_producer(factory, tokens);\r
 292 }\r
 293 \r
 294 }}