]> git.sesse.net Git - casparcg/blob - core/video_channel.h
* Enforce help descriptions for producers in code.
[casparcg] / core / video_channel.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 <common/memory.h>
25 #include <common/reactive.h>
26 #include <common/forward.h>
27
28 #include "fwd.h"
29
30 #include "monitor/monitor.h"
31
32 #include <boost/property_tree/ptree_fwd.hpp>
33
34 namespace caspar { namespace core {
35         
36 class video_channel final
37 {
38         video_channel(const video_channel&);
39         video_channel& operator=(const video_channel&);
40 public:
41
42         // Static Members
43
44         // Constructors
45
46         explicit video_channel(int index, const video_format_desc& format_desc, std::unique_ptr<image_mixer> image_mixer);
47         ~video_channel();
48
49         // Methods
50                         
51         monitor::subject&                                               monitor_output();
52
53         // Properties
54
55         const core::stage&                                              stage() const;
56         core::stage&                                                    stage();
57         const core::mixer&                                              mixer() const;
58         core::mixer&                                                    mixer();
59         const core::output&                                             output() const;
60         core::output&                                                   output();
61
62         core::video_format_desc                                 video_format_desc() const;
63         void                                                                    video_format_desc(const core::video_format_desc& format_desc);
64
65         spl::shared_ptr<core::frame_factory>    frame_factory();
66
67         boost::property_tree::wptree                    info() const;
68         int                                                                             index() const;
69 private:
70         struct impl;
71         spl::unique_ptr<impl> impl_;
72 };
73
74 }}