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

   1 /*\r
   2 * copyright (c) 2010 Sveriges Television AB <info@casparcg.com>\r
   3 *\r
   4 *  This file is part of CasparCG.\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 */\r
  20 #pragma once\r
  21 \r
  22 #include <common/memory/safe_ptr.h>\r
  23 \r
  24 #include <boost/noncopyable.hpp>\r
  25 \r
  26 #include <functional>\r
  27 #include <string>\r
  28 #include <vector>\r
  29 #include <stdint.h>\r
  30 #include <numeric>\r
  31 \r
  32 namespace caspar { \r
  33         \r
  34 class executor;\r
  35         \r
  36 namespace core {\r
  37 \r
  38 class basic_frame;\r
  39 struct frame_factory;\r
  40 \r
  41 struct frame_producer : boost::noncopyable\r
  42 {\r
  43 public:\r
  44         enum hints\r
  45         {\r
  46                 NO_HINT = 0,\r
  47                 ALPHA_HINT = 1\r
  48         };\r
  49 \r
  50         virtual ~frame_producer(){}     \r
  51 \r
  52         virtual std::wstring print() const = 0; // nothrow\r
  53 \r
  54         virtual void param(const std::wstring&){}\r
  55 \r
  56         virtual safe_ptr<frame_producer> get_following_producer() const {return frame_producer::empty();}  // nothrow\r
  57         virtual void set_leading_producer(const safe_ptr<frame_producer>&) {}  // nothrow\r
  58                 \r
  59         virtual int64_t nb_frames() const {return std::numeric_limits<int>::max();}\r
  60         \r
  61         virtual safe_ptr<basic_frame> receive(int hints) = 0;\r
  62         virtual safe_ptr<core::basic_frame> last_frame() const = 0;\r
  63 \r
  64         static const safe_ptr<frame_producer>& empty(); // nothrow\r
  65 };\r
  66 \r
  67 safe_ptr<basic_frame> receive_and_follow(safe_ptr<frame_producer>& producer, int hints);\r
  68 \r
  69 typedef std::function<safe_ptr<core::frame_producer>(const safe_ptr<frame_factory>&, const std::vector<std::wstring>&)> producer_factory_t;\r
  70 void register_producer_factory(const producer_factory_t& factory); // Not thread-safe.\r
  71 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>&, const std::vector<std::wstring>& params);\r
  72 \r
  73 safe_ptr<core::frame_producer> create_destroy_producer_proxy(executor& destroy_context, const safe_ptr<frame_producer>& producer);\r
  74 \r
  75 }}\r