]> git.sesse.net Git - casparcg/blob - core/producer/layer.h
2.1.0: Don't use 'struct' for interfaces, use 'class'.
[casparcg] / core / producer / layer.h
1 /*\r
2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>\r
3 *\r
4 * This file is part of CasparCG (www.casparcg.com).\r
5 *\r
6 * CasparCG is free software: you can redistribute it and/or modify\r
7 * it under the terms of the GNU General Public License as published by\r
8 * the Free Software Foundation, either version 3 of the License, or\r
9 * (at your option) any later version.\r
10 *\r
11 * CasparCG is distributed in the hope that it will be useful,\r
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
14 * GNU General Public License for more details.\r
15 *\r
16 * You should have received a copy of the GNU General Public License\r
17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.\r
18 *\r
19 * Author: Robert Nagy, ronag89@gmail.com\r
20 */\r
21 \r
22 #pragma once\r
23 \r
24 #include "frame_producer.h"\r
25 \r
26 #include "../monitor/monitor.h"\r
27 \r
28 #include <common/forward.h>\r
29 #include <common/spl/memory.h>\r
30 \r
31 #include <boost/property_tree/ptree_fwd.hpp>\r
32 \r
33 #include <string>\r
34 \r
35 FORWARD1(boost, template<typename T> class unique_future);\r
36 FORWARD1(boost, template<typename T> class optional);\r
37 \r
38 namespace caspar { namespace core {\r
39         \r
40 class layer sealed : public monitor::observable\r
41 {\r
42 public:\r
43         layer(int index = -1); // nothrow\r
44         layer(layer&& other); // nothrow\r
45         layer& operator=(layer&& other); // nothrow\r
46 \r
47         void swap(layer& other); // nothrow \r
48                 \r
49         void load(spl::shared_ptr<class frame_producer> producer, const boost::optional<int32_t>& auto_play_delta = nullptr); // nothrow\r
50         void play(); // nothrow\r
51         void pause(); // nothrow\r
52         void stop(); // nothrow\r
53                 \r
54         spl::shared_ptr<class frame_producer> foreground() const; // nothrow\r
55         spl::shared_ptr<class frame_producer> background() const; // nothrow\r
56 \r
57         spl::shared_ptr<class draw_frame> receive(frame_producer::flags flags, const struct video_format_desc& format_desc); // nothrow\r
58 \r
59         boost::property_tree::wptree info() const;\r
60 \r
61         // monitor::observable\r
62 \r
63         virtual void subscribe(const monitor::observable::observer_ptr& o) override;\r
64         virtual void unsubscribe(const monitor::observable::observer_ptr& o) override;\r
65 private:\r
66         struct impl;\r
67         spl::shared_ptr<impl> impl_;\r
68 };\r
69 \r
70 }}