]> git.sesse.net Git - casparcg/blob - core/mixer/image/image_mixer.cpp
2.0.0.2: Added some comments. - read_frame: Added error handling for image_data future.
[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                 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::queue<std::queue<render_item>>             render_queue_;\r
61         \r
62         image_kernel kernel_;\r
63                         \r
64         safe_ptr<device_buffer> draw_buffer_;\r
65         safe_ptr<device_buffer> write_buffer_;\r
66 \r
67         safe_ptr<device_buffer> local_key_buffer_;\r
68         safe_ptr<device_buffer> layer_key_buffer_;\r
69 \r
70         bool local_key_;\r
71         bool layer_key_;\r
72 \r
73 public:\r
74         implementation(const core::video_format_desc& format_desc) \r
75                 : format_desc_(format_desc)\r
76                 , draw_buffer_(ogl_device::create_device_buffer(format_desc.width, format_desc.height, 4))\r
77                 , write_buffer_ (ogl_device::create_device_buffer(format_desc.width, format_desc.height, 4))\r
78                 , local_key_buffer_(ogl_device::create_device_buffer(format_desc.width, format_desc.height, 1))\r
79                 , layer_key_buffer_(ogl_device::create_device_buffer(format_desc.width, format_desc.height, 1))\r
80                 , local_key_(false)\r
81                 , layer_key_(false)\r
82         {\r
83                 transform_stack_.push(core::image_transform());\r
84         }\r
85         \r
86         void begin(const core::basic_frame& frame)\r
87         {\r
88                 transform_stack_.push(transform_stack_.top()*frame.get_image_transform());\r
89         }\r
90                 \r
91         void visit(core::write_frame& frame)\r
92         {                       \r
93                 render_item item = {frame.get_pixel_format_desc(), frame.get_textures(), transform_stack_.top()*frame.get_image_transform()};   \r
94                 render_queue_.back().push(item);\r
95         }\r
96 \r
97         void end()\r
98         {\r
99                 transform_stack_.pop();\r
100         }\r
101 \r
102         void begin_layer()\r
103         {\r
104                 render_queue_.push(std::queue<render_item>());\r
105         }\r
106 \r
107         void end_layer()\r
108         {\r
109         }\r
110 \r
111         boost::unique_future<safe_ptr<const host_buffer>> render()\r
112         {\r
113                 auto result = ogl_device::create_host_buffer(format_desc_.size, host_buffer::read_only);\r
114 \r
115                 auto render_queue = std::move(render_queue_);\r
116 \r
117                 ogl_device::begin_invoke([=]() mutable\r
118                 {\r
119                         local_key_ = false;\r
120                         layer_key_ = false;\r
121 \r
122                         // Clear buffers.\r
123                         local_key_buffer_->clear();\r
124                         layer_key_buffer_->clear();\r
125                         draw_buffer_->clear();\r
126 \r
127                         // Draw items in device.\r
128 \r
129                         while(!render_queue.empty())\r
130                         {\r
131                                 auto layer = render_queue.front();\r
132                                 render_queue.pop();\r
133                                 \r
134                                 draw_buffer_->attach(); \r
135 \r
136                                 while(!layer.empty())\r
137                                 {\r
138                                         draw(layer.front());\r
139                                         layer.pop();\r
140                                         ogl_device::yield(); // Allow quick buffer allocation to execute.\r
141                                 }\r
142 \r
143                                 layer_key_ = local_key_; // If there was only key in last layer then use it as key for the entire next layer.\r
144                                 local_key_ = false;\r
145 \r
146                                 std::swap(local_key_buffer_, layer_key_buffer_);\r
147                         }\r
148 \r
149                         // Start transfer from device to host.\r
150 \r
151                         draw_buffer_->write(*result);\r
152 \r
153                         std::swap(draw_buffer_, write_buffer_);\r
154                 });\r
155 \r
156                 // While transferring do additional work which was queued during rendering.\r
157                 \r
158                 return ogl_device::begin_invoke([=]() -> safe_ptr<const host_buffer>\r
159                 {\r
160                         result->map(); // Might block.\r
161                         return result;\r
162                 });\r
163         }\r
164         \r
165         void draw(const render_item& item)\r
166         {               \r
167                 // Bind textures\r
168 \r
169                 for(size_t n = 0; n < item.textures.size(); ++n)\r
170                         item.textures[n]->bind(n);              \r
171 \r
172                 // Setup key and kernel\r
173 \r
174                 bool local_key = false;\r
175                 bool layer_key = false;\r
176                 \r
177                 if(item.transform.get_is_key()) // This is a key frame, render it to the local_key buffer for later use.\r
178                 {\r
179                         if(!local_key_) // Initialize local-key if it is not active.\r
180                         {\r
181                                 local_key_buffer_->clear();\r
182                                 local_key_buffer_->attach();\r
183                                 local_key_ = true;\r
184                         }\r
185                 }               \r
186                 else // This is a normal frame. Use key buffers if they are active.\r
187                 {               \r
188                         local_key = local_key_;\r
189                         layer_key = layer_key_;\r
190 \r
191                         if(local_key_) // Use local key if we have it.\r
192                         {\r
193                                 local_key_buffer_->bind(LOCAL_KEY_INDEX);\r
194                                 draw_buffer_->attach(); \r
195                                 local_key_ = false; // Use it only one time.\r
196                         }               \r
197 \r
198                         if(layer_key_) // Use layer key if we have it.\r
199                                 layer_key_buffer_->bind(LAYER_KEY_INDEX);\r
200                 }       \r
201 \r
202                 // Draw\r
203 \r
204                 kernel_.draw(format_desc_.width, format_desc_.height, item.desc, item.transform, local_key, layer_key); \r
205         }\r
206                         \r
207         safe_ptr<write_frame> create_frame(void* tag, const core::pixel_format_desc& desc)\r
208         {\r
209                 std::vector<safe_ptr<host_buffer>> buffers;\r
210                 std::vector<safe_ptr<device_buffer>> textures;\r
211                 ogl_device::invoke([&]\r
212                 {\r
213                         std::transform(desc.planes.begin(), desc.planes.end(), std::back_inserter(buffers), [&](const core::pixel_format_desc::plane& plane)\r
214                         {\r
215                                 return ogl_device::create_host_buffer(plane.size, host_buffer::write_only);\r
216                         });\r
217                         std::transform(desc.planes.begin(), desc.planes.end(), std::back_inserter(textures), [&](const core::pixel_format_desc::plane& plane)\r
218                         {\r
219                                 return ogl_device::create_device_buffer(plane.width, plane.height, plane.channels);\r
220                         });\r
221                 });\r
222 \r
223                 return make_safe<write_frame>(reinterpret_cast<int>(tag), desc, buffers, textures);\r
224         }\r
225 };\r
226 \r
227 image_mixer::image_mixer(const core::video_format_desc& format_desc) : impl_(new implementation(format_desc)){}\r
228 void image_mixer::begin(const core::basic_frame& frame){impl_->begin(frame);}\r
229 void image_mixer::visit(core::write_frame& frame){impl_->visit(frame);}\r
230 void image_mixer::end(){impl_->end();}\r
231 boost::unique_future<safe_ptr<const host_buffer>> image_mixer::render(){return impl_->render();}\r
232 safe_ptr<write_frame> image_mixer::create_frame(void* tag, const core::pixel_format_desc& desc){return impl_->create_frame(tag, desc);}\r
233 void image_mixer::begin_layer(){impl_->begin_layer();}\r
234 void image_mixer::end_layer(){impl_->end_layer();}\r
235 \r
236 }}