2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
4 * This file is part of CasparCG (www.casparcg.com).
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.
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.
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/>.
19 * Author: Robert Nagy, ronag89@gmail.com
24 #include "../monitor/monitor.h"
27 #include <common/memory.h>
28 #include <common/future_fwd.h>
30 #include <boost/property_tree/ptree_fwd.hpp>
36 namespace caspar { namespace core {
41 frame_consumer(const frame_consumer&);
42 frame_consumer& operator=(const frame_consumer&);
47 static const spl::shared_ptr<frame_consumer>& empty();
52 virtual ~frame_consumer() {}
56 virtual std::future<bool> send(const_frame frame) = 0;
57 virtual void initialize(const video_format_desc& format_desc, int channel_index) = 0;
59 // monitor::observable
61 virtual monitor::subject& monitor_output() = 0;
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;
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;
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);