git.sesse.net Git - casparcg/blob - core/consumer/frame_consumer.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 \r
  30 namespace caspar { namespace core {\r
  31         \r
  32 class read_frame;\r
  33 struct video_format_desc;\r
  34 \r
  35 struct frame_consumer : boost::noncopyable\r
  36 {\r
  37         virtual ~frame_consumer() {}\r
  38         \r
  39         virtual bool send(const safe_ptr<read_frame>& frame) = 0;\r
  40         virtual void initialize(const video_format_desc& format_desc, int channel_index, int sub_index) = 0;\r
  41         virtual std::wstring print() const = 0;\r
  42         virtual bool has_synchronization_clock() const {return true;}\r
  43         virtual size_t buffer_depth() const = 0;\r
  44 \r
  45         static const safe_ptr<frame_consumer>& empty()\r
  46         {\r
  47                 struct empty_frame_consumer : public frame_consumer\r
  48                 {\r
  49                         virtual bool send(const safe_ptr<read_frame>&) override {return false;}\r
  50                         virtual void initialize(const video_format_desc&, int, int) override{}\r
  51                         virtual std::wstring print() const override {return L"empty";}\r
  52                         virtual bool has_synchronization_clock() const override {return false;}\r
  53                         virtual size_t buffer_depth() const override {return 0;};\r
  54                 };\r
  55                 static safe_ptr<frame_consumer> consumer = make_safe<empty_frame_consumer>();\r
  56                 return consumer;\r
  57         }\r
  58 };\r
  59 \r
  60 safe_ptr<frame_consumer> create_consumer_cadence_guard(safe_ptr<frame_consumer>&& consumer);\r
  61 \r
  62 typedef std::function<safe_ptr<core::frame_consumer>(const std::vector<std::wstring>&)> consumer_factory_t;\r
  63 \r
  64 void register_consumer_factory(const consumer_factory_t& factory);\r
  65 safe_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params);\r
  66 \r
  67 }}