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 #include "../fwd.h"
  26
  27 #include <common/memory.h>
  28 #include <common/future_fwd.h>
  29
  30 #include <boost/property_tree/ptree_fwd.hpp>
  31
  32 #include <functional>
  33 #include <string>
  34 #include <vector>
  35
  36 namespace caspar { namespace core {
  37
  38 // Interface
  39 class frame_consumer
  40 {
  41         frame_consumer(const frame_consumer&);
  42         frame_consumer& operator=(const frame_consumer&);
  43 public:
  44
  45         // Static Members
  46
  47         static const spl::shared_ptr<frame_consumer>& empty();
  48
  49         // Constructors
  50
  51         frame_consumer(){}
  52         virtual ~frame_consumer() {}
  53
  54         // Methods
  55
  56         virtual std::future<bool>                               send(const_frame frame) = 0;
  57         virtual void                                                    initialize(const video_format_desc& format_desc, int channel_index) = 0;
  58
  59         // monitor::observable
  60
  61         virtual monitor::subject& monitor_output() = 0;
  62
  63         // Properties
  64
  65         virtual std::wstring                                    print() const = 0;
  66         virtual std::wstring                                    name() const = 0;
  67         virtual boost::property_tree::wptree    info() const = 0;
  68         virtual bool                                                    has_synchronization_clock() const {return true;}
  69         virtual int                                                             buffer_depth() const = 0; // -1 to not participate in frame presentation synchronization
  70         virtual int                                                             index() const = 0;
  71 };
  72
  73 typedef std::function<spl::shared_ptr<frame_consumer>(
  74                 const std::vector<std::wstring>&,
  75                 interaction_sink* sink)> consumer_factory_t;
  76 typedef std::function<spl::shared_ptr<frame_consumer>(
  77                 const boost::property_tree::wptree& element,
  78                 interaction_sink* sink)> preconfigured_consumer_factory_t;
  79
  80 void register_consumer_factory(const consumer_factory_t& factory);
  81 void register_preconfigured_consumer_factory(
  82                 const std::wstring& element_name,
  83                 const preconfigured_consumer_factory_t& factory);
  84 spl::shared_ptr<frame_consumer> create_consumer(
  85                 const std::vector<std::wstring>& params,
  86                 interaction_sink* sink);
  87 spl::shared_ptr<frame_consumer> create_consumer(
  88                 const std::wstring& element_name,
  89                 const boost::property_tree::wptree& element,
  90                 interaction_sink* sink);
  91
  92 }}