git.sesse.net Git - casparcg/blob - core/consumer/frame_consumer.h

   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 #pragma once\r
  23 \r
  24 #include <common/spl/memory.h>\r
  25 \r
  26 #include <boost/property_tree/ptree_fwd.hpp>\r
  27 \r
  28 #include <functional>\r
  29 #include <string>\r
  30 #include <vector>\r
  31 \r
  32 namespace caspar { namespace core {\r
  33         \r
  34 // Interface\r
  35 class frame_consumer\r
  36 {\r
  37         frame_consumer(const frame_consumer&);\r
  38         frame_consumer& operator=(const frame_consumer&);\r
  39 public:\r
  40 \r
  41         // Static Members\r
  42         \r
  43         static const spl::shared_ptr<frame_consumer>& empty();\r
  44 \r
  45         // Constructors\r
  46 \r
  47         frame_consumer(){}\r
  48         virtual ~frame_consumer() {}\r
  49         \r
  50         // Methods\r
  51 \r
  52         virtual bool                                                    send(class const_frame frame) = 0;\r
  53         virtual void                                                    initialize(const struct video_format_desc& format_desc, int channel_index) = 0;\r
  54 \r
  55         // Properties\r
  56 \r
  57         virtual std::wstring                                    print() const = 0;\r
  58         virtual std::wstring                                    name() const = 0;\r
  59         virtual boost::property_tree::wptree    info() const = 0;\r
  60         virtual bool                                                    has_synchronization_clock() const {return true;}\r
  61         virtual int                                                             buffer_depth() const = 0;\r
  62         virtual int                                                             index() const = 0;\r
  63 };\r
  64 \r
  65 typedef std::function<spl::shared_ptr<frame_consumer>(const std::vector<std::wstring>&)> consumer_factory_t;\r
  66 \r
  67 void register_consumer_factory(const consumer_factory_t& factory);\r
  68 spl::shared_ptr<frame_consumer> create_consumer(const std::vector<std::wstring>& params);\r
  69 \r
  70 }}