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 #include <boost/property_tree/ptree_fwd.hpp>\r
  26 \r
  27 #include <functional>\r
  28 #include <string>\r
  29 #include <vector>\r
  30 \r
  31 namespace caspar { namespace core {\r
  32         \r
  33 class read_frame;\r
  34 struct video_format_desc;\r
  35 \r
  36 struct frame_consumer : boost::noncopyable\r
  37 {\r
  38         virtual ~frame_consumer() {}\r
  39         \r
  40         virtual bool send(const safe_ptr<read_frame>& frame) = 0;\r
  41         virtual void initialize(const video_format_desc& format_desc, int channel_index) = 0;\r
  42         virtual std::wstring print() const = 0;\r
  43         virtual boost::property_tree::wptree info() const = 0;\r
  44         virtual bool has_synchronization_clock() const {return true;}\r
  45         virtual size_t buffer_depth() const = 0;\r
  46         virtual int index() const = 0;\r
  47 \r
  48         static const safe_ptr<frame_consumer>& empty();\r
  49 };\r
  50 \r
  51 safe_ptr<frame_consumer> create_consumer_cadence_guard(const safe_ptr<frame_consumer>& consumer);\r
  52 \r
  53 typedef std::function<safe_ptr<core::frame_consumer>(const std::vector<std::wstring>&)> consumer_factory_t;\r
  54 \r
  55 void register_consumer_factory(const consumer_factory_t& factory);\r
  56 safe_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params);\r
  57 \r
  58 }}