]> git.sesse.net Git - casparcg/blob - core/consumer/frame_consumer.h
* Upgraded to Visual Studio 2013
[casparcg] / 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 // Interface
38 class frame_consumer
39 {
40         frame_consumer(const frame_consumer&);
41         frame_consumer& operator=(const frame_consumer&);
42 public:
43
44         // Static Members
45         
46         static const spl::shared_ptr<frame_consumer>& empty();
47
48         // Constructors
49
50         frame_consumer(){}
51         virtual ~frame_consumer() {}
52         
53         // Methods
54
55         virtual std::future<bool>                               send(class const_frame frame) = 0;
56         virtual void                                                    initialize(const struct video_format_desc& format_desc, int channel_index) = 0;
57         
58         // monitor::observable
59
60         virtual monitor::subject& monitor_output() = 0;
61
62         // Properties
63
64         virtual std::wstring                                    print() const = 0;
65         virtual std::wstring                                    name() const = 0;
66         virtual boost::property_tree::wptree    info() const = 0;
67         virtual bool                                                    has_synchronization_clock() const {return true;}
68         virtual int                                                             buffer_depth() const = 0;
69         virtual int                                                             index() const = 0;
70 };
71
72 typedef std::function<spl::shared_ptr<frame_consumer>(const std::vector<std::wstring>&)> consumer_factory_t;
73
74 void register_consumer_factory(const consumer_factory_t& factory);
75 spl::shared_ptr<frame_consumer> create_consumer(const std::vector<std::wstring>& params);
76
77 }}