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

   1 /*
   2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
   3 *
   4 * This file is part of CasparCG (www.casparcg.com).
   5 *
   6 * CasparCG is free software: you can redistribute it and/or modify
   7 * it under the terms of the GNU General Public License as published by
   8 * the Free Software Foundation, either version 3 of the License, or
   9 * (at your option) any later version.
  10 *
  11 * CasparCG is distributed in the hope that it will be useful,
  12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 * GNU General Public License for more details.
  15 *
  16 * You should have received a copy of the GNU General Public License
  17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
  18 *
  19 * Author: Robert Nagy, ronag89@gmail.com
  20 */
  21
  22 #pragma once
  23
  24 #include "../monitor/monitor.h"
  25
  26 #include <common/memory.h>
  27 #include <common/future_fwd.h>
  28
  29 #include <boost/property_tree/ptree_fwd.hpp>
  30
  31 #include <functional>
  32 #include <string>
  33 #include <vector>
  34
  35 namespace caspar { namespace core {
  36
  37 struct interaction_sink;
  38
  39 // Interface
  40 class frame_consumer
  41 {
  42         frame_consumer(const frame_consumer&);
  43         frame_consumer& operator=(const frame_consumer&);
  44 public:
  45
  46         // Static Members
  47
  48         static const spl::shared_ptr<frame_consumer>& empty();
  49
  50         // Constructors
  51
  52         frame_consumer(){}
  53         virtual ~frame_consumer() {}
  54
  55         // Methods
  56
  57         virtual std::future<bool>                               send(class const_frame frame) = 0;
  58         virtual void                                                    initialize(const struct video_format_desc& format_desc, int channel_index) = 0;
  59
  60         // monitor::observable
  61
  62         virtual monitor::subject& monitor_output() = 0;
  63
  64         // Properties
  65
  66         virtual std::wstring                                    print() const = 0;
  67         virtual std::wstring                                    name() const = 0;
  68         virtual boost::property_tree::wptree    info() const = 0;
  69         virtual bool                                                    has_synchronization_clock() const {return true;}
  70         virtual int                                                             buffer_depth() const = 0; // -1 to not participate in frame presentation synchronization
  71         virtual int                                                             index() const = 0;
  72 };
  73
  74 typedef std::function<spl::shared_ptr<frame_consumer>(
  75                 const std::vector<std::wstring>&,
  76                 interaction_sink* sink)> consumer_factory_t;
  77 typedef std::function<spl::shared_ptr<frame_consumer>(
  78                 const boost::property_tree::wptree& element,
  79                 interaction_sink* sink)> preconfigured_consumer_factory_t;
  80
  81 void register_consumer_factory(const consumer_factory_t& factory);
  82 void register_preconfigured_consumer_factory(
  83                 const std::wstring& element_name,
  84                 const preconfigured_consumer_factory_t& factory);
  85 spl::shared_ptr<frame_consumer> create_consumer(
  86                 const std::vector<std::wstring>& params,
  87                 interaction_sink* sink);
  88 spl::shared_ptr<frame_consumer> create_consumer(
  89                 const std::wstring& element_name,
  90                 const boost::property_tree::wptree& element,
  91                 interaction_sink* sink);
  92
  93 }}