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"
26 #include "../help/help_repository.h"
28 #include <common/memory.h>
29 #include <common/future_fwd.h>
31 #include <boost/property_tree/ptree_fwd.hpp>
37 namespace caspar { namespace core {
42 frame_consumer(const frame_consumer&);
43 frame_consumer& operator=(const frame_consumer&);
48 static const spl::shared_ptr<frame_consumer>& empty();
53 virtual ~frame_consumer() {}
57 virtual std::future<bool> send(const_frame frame) = 0;
58 virtual void initialize(const video_format_desc& format_desc, const audio_channel_layout& channel_layout, int channel_index) = 0;
60 // monitor::observable
62 virtual monitor::subject& monitor_output() = 0;
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 virtual int64_t presentation_frame_age_millis() const = 0;
73 virtual const frame_consumer* unwrapped() const { return this; }
76 typedef std::function<spl::shared_ptr<frame_consumer>(
77 const std::vector<std::wstring>&,
78 interaction_sink* sink,
79 std::vector<spl::shared_ptr<video_channel>> channels)> consumer_factory_t;
80 typedef std::function<spl::shared_ptr<frame_consumer>(
81 const boost::property_tree::wptree& element,
82 interaction_sink* sink,
83 std::vector<spl::shared_ptr<video_channel>> channels)> preconfigured_consumer_factory_t;
85 class frame_consumer_registry : boost::noncopyable
88 frame_consumer_registry(spl::shared_ptr<help_repository> help_repo);
89 void register_consumer_factory(const std::wstring& name, const consumer_factory_t& factory, const help_item_describer& describer);
90 void register_preconfigured_consumer_factory(
91 const std::wstring& element_name,
92 const preconfigured_consumer_factory_t& factory);
93 spl::shared_ptr<frame_consumer> create_consumer(
94 const std::vector<std::wstring>& params,
95 interaction_sink* sink,
96 std::vector<spl::shared_ptr<video_channel>> channels) const;
97 spl::shared_ptr<frame_consumer> create_consumer(
98 const std::wstring& element_name,
99 const boost::property_tree::wptree& element,
100 interaction_sink* sink,
101 std::vector<spl::shared_ptr<video_channel>> channels) const;
104 spl::shared_ptr<impl> impl_;
107 void destroy_consumers_synchronously();