]> git.sesse.net Git - casparcg/blob - core/mixer/image/image_mixer.cpp
2.0.0.2: -image_mixer: Added some comments.
[casparcg] / core / mixer / image / image_mixer.cpp
1 /*\r
2 * copyright (c) 2010 Sveriges Television AB <info@casparcg.com>\r
3 *\r
4 *  This file is part of CasparCG.\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 */\r
20 #include "../../stdafx.h"\r
21 \r
22 #include "image_mixer.h"\r
23 #include "image_kernel.h"\r
24 \r
25 #include "../gpu/ogl_device.h"\r
26 #include "../gpu/host_buffer.h"\r
27 #include "../gpu/device_buffer.h"\r
28 #include "../write_frame.h"\r
29 \r
30 #include <common/concurrency/executor.h>\r
31 #include <common/exception/exceptions.h>\r
32 #include <common/gl/gl_check.h>\r
33 \r
34 #include <core/producer/frame/image_transform.h>\r
35 #include <core/producer/frame/pixel_format.h>\r
36 #include <core/video_format.h>\r
37 \r
38 #include <boost/foreach.hpp>\r
39 \r
40 #include <array>\r
41 #include <unordered_map>\r
42 \r
43 namespace caspar { namespace core {\r
44                 \r
45 struct image_mixer::implementation : boost::noncopyable\r
46 {       \r
47         static const size_t LOCAL_KEY_INDEX = 3;\r
48         static const size_t LAYER_KEY_INDEX = 4;\r
49 \r
50         struct render_item\r
51         {\r
52                 core::pixel_format_desc desc;\r
53                 std::vector<safe_ptr<device_buffer>> textures;\r
54                 core::image_transform transform;\r
55         };\r
56 \r
57         const core::video_format_desc format_desc_;\r
58         \r
59         std::stack<core::image_transform>               transform_stack_;\r
60         std::vector<std::vector<render_item>>   transferring_queue_;\r
61         std::vector<std::vector<render_item>>   render_queue_;\r
62         \r
63         image_kernel kernel_;\r
64                 \r
65         safe_ptr<host_buffer>   read_buffer_;\r
66         \r
67         safe_ptr<device_buffer> draw_buffer_;\r
68         safe_ptr<device_buffer> write_buffer_;\r
69 \r
70         safe_ptr<device_buffer> local_key_buffer_;\r
71         safe_ptr<device_buffer> layer_key_buffer_;\r
72 \r
73         bool local_key_;\r
74         bool layer_key_;\r
75 \r
76 public:\r
77         implementation(const core::video_format_desc& format_desc) \r
78                 : format_desc_(format_desc)\r
79                 , read_buffer_(ogl_device::create_host_buffer(format_desc_.size, host_buffer::read_only))\r
80                 , draw_buffer_(ogl_device::create_device_buffer(format_desc.width, format_desc.height, 4))\r
81                 , write_buffer_ (ogl_device::create_device_buffer(format_desc.width, format_desc.height, 4))\r
82                 , local_key_buffer_(ogl_device::create_device_buffer(format_desc.width, format_desc.height, 1))\r
83                 , layer_key_buffer_(ogl_device::create_device_buffer(format_desc.width, format_desc.height, 1))\r
84                 , local_key_(false)\r
85                 , layer_key_(false)\r
86         {\r
87                 transform_stack_.push(core::image_transform());\r
88         }\r
89         \r
90         void begin(const core::basic_frame& frame)\r
91         {\r
92                 transform_stack_.push(transform_stack_.top()*frame.get_image_transform());\r
93         }\r
94                 \r
95         void visit(core::write_frame& frame)\r
96         {                                               \r
97                 auto desc               = frame.get_pixel_format_desc();\r
98                 auto buffers    = frame.get_plane_buffers();\r
99                 auto transform  = transform_stack_.top()*frame.get_image_transform();\r
100 \r
101                 ogl_device::begin_invoke([=]\r
102                 {\r
103                         render_item item;\r
104 \r
105                         item.desc = desc;\r
106                         item.transform = transform;\r
107                         \r
108                         // Start transfer from host to device.\r
109 \r
110                         for(size_t n = 0; n < buffers.size(); ++n)\r
111                         {\r
112                                 auto texture = ogl_device::create_device_buffer(desc.planes[n].width, desc.planes[n].height, desc.planes[n].channels);\r
113                                 texture->read(*buffers[n]);\r
114                                 item.textures.push_back(texture);\r
115                         }       \r
116 \r
117                         transferring_queue_.back().push_back(item);\r
118                 });\r
119         }\r
120 \r
121         void end()\r
122         {\r
123                 transform_stack_.pop();\r
124         }\r
125 \r
126         void begin_layer()\r
127         {\r
128                 ogl_device::begin_invoke([=]\r
129                 {\r
130                         transferring_queue_.push_back(std::vector<render_item>());\r
131                 });\r
132         }\r
133 \r
134         void end_layer()\r
135         {\r
136         }\r
137 \r
138         boost::unique_future<safe_ptr<const host_buffer>> render()\r
139         {\r
140                 auto result = ogl_device::begin_invoke([=]() -> safe_ptr<const host_buffer>\r
141                 {\r
142                         read_buffer_->map(); // Might block.\r
143                         return read_buffer_;\r
144                 });\r
145                         \r
146                 ogl_device::begin_invoke([=]\r
147                 {\r
148                         local_key_ = false;\r
149                         layer_key_ = false;\r
150 \r
151                         // Clear buffers.\r
152                         local_key_buffer_->clear();\r
153                         layer_key_buffer_->clear();\r
154                         draw_buffer_->clear();\r
155 \r
156                         // Draw items in device.\r
157 \r
158                         BOOST_FOREACH(auto layer, render_queue_)\r
159                         {\r
160                                 draw_buffer_->attach(); \r
161 \r
162                                 BOOST_FOREACH(auto item, layer)                 \r
163                                         draw(item);     \r
164                                                                 \r
165                                 layer_key_ = local_key_; // If there was only key in last layer then use it as key for the entire next layer.\r
166                                 local_key_ = false;\r
167 \r
168                                 std::swap(local_key_buffer_, layer_key_buffer_);\r
169                         }\r
170 \r
171                         // Move waiting items to queue.\r
172 \r
173                         render_queue_ = std::move(transferring_queue_);\r
174 \r
175                         // Start transfer from device to host.\r
176 \r
177                         read_buffer_ = ogl_device::create_host_buffer(format_desc_.size, host_buffer::read_only);\r
178                         draw_buffer_->write(*read_buffer_);\r
179 \r
180                         std::swap(draw_buffer_, write_buffer_);\r
181                 });\r
182 \r
183                 return std::move(result);\r
184         }\r
185         \r
186         void draw(const render_item& item)\r
187         {               \r
188                 // Bind textures\r
189 \r
190                 for(size_t n = 0; n < item.textures.size(); ++n)\r
191                         item.textures[n]->bind(n);              \r
192 \r
193                 // Setup key and kernel\r
194 \r
195                 bool local_key = false;\r
196                 bool layer_key = false;\r
197                 \r
198                 if(item.transform.get_is_key()) // This is a key frame, render it to the local_key buffer for later use.\r
199                 {\r
200                         if(!local_key_) // Initialize local-key if it is not active.\r
201                         {\r
202                                 local_key_buffer_->clear();\r
203                                 local_key_buffer_->attach();\r
204                                 local_key_ = true;\r
205                         }\r
206                 }               \r
207                 else // This is a normal frame. Use key buffers if they are active.\r
208                 {               \r
209                         local_key = local_key_;\r
210                         layer_key = layer_key_;\r
211 \r
212                         if(local_key_) // Use local key if we have it.\r
213                         {\r
214                                 local_key_buffer_->bind(LOCAL_KEY_INDEX);\r
215                                 draw_buffer_->attach(); \r
216                                 local_key_ = false; // Use it only one time.\r
217                         }               \r
218 \r
219                         if(layer_key_) // Use layer key if we have it.\r
220                                 layer_key_buffer_->bind(LAYER_KEY_INDEX);\r
221                 }       \r
222 \r
223                 // Draw\r
224 \r
225                 kernel_.draw(format_desc_.width, format_desc_.height, item.desc, item.transform, local_key, layer_key); \r
226         }\r
227                         \r
228         std::vector<safe_ptr<host_buffer>> create_buffers(const core::pixel_format_desc& format)\r
229         {\r
230                 std::vector<safe_ptr<host_buffer>> buffers;\r
231                 std::transform(format.planes.begin(), format.planes.end(), std::back_inserter(buffers), [&](const core::pixel_format_desc::plane& plane)\r
232                 {\r
233                         return ogl_device::create_host_buffer(plane.size, host_buffer::write_only);\r
234                 });\r
235                 return buffers;\r
236         }\r
237 };\r
238 \r
239 image_mixer::image_mixer(const core::video_format_desc& format_desc) : impl_(new implementation(format_desc)){}\r
240 void image_mixer::begin(const core::basic_frame& frame){impl_->begin(frame);}\r
241 void image_mixer::visit(core::write_frame& frame){impl_->visit(frame);}\r
242 void image_mixer::end(){impl_->end();}\r
243 boost::unique_future<safe_ptr<const host_buffer>> image_mixer::render(){return impl_->render();}\r
244 std::vector<safe_ptr<host_buffer>> image_mixer::create_buffers(const core::pixel_format_desc& format){return impl_->create_buffers(format);}\r
245 void image_mixer::begin_layer(){impl_->begin_layer();}\r
246 void image_mixer::end_layer(){impl_->end_layer();}\r
247 \r
248 }}