]> git.sesse.net Git - casparcg/blob - core/mixer/image/image_mixer.cpp
2.0. image_mixer: Refactored blend-modes.
[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 "../../video_channel_context.h"\r
31 \r
32 #include <common/concurrency/executor.h>\r
33 #include <common/exception/exceptions.h>\r
34 #include <common/gl/gl_check.h>\r
35 \r
36 #include <core/producer/frame/image_transform.h>\r
37 #include <core/producer/frame/pixel_format.h>\r
38 #include <core/video_format.h>\r
39 \r
40 #include <gl/glew.h>\r
41 \r
42 #include <boost/foreach.hpp>\r
43 #include <boost/range.hpp>\r
44 #include <boost/range/algorithm/find.hpp>\r
45 \r
46 #include <algorithm>\r
47 #include <array>\r
48 #include <deque>\r
49 #include <unordered_map>\r
50 \r
51 namespace caspar { namespace core {\r
52                 \r
53 struct image_mixer::implementation : boost::noncopyable\r
54 {               \r
55         typedef std::deque<render_item>                 layer;\r
56 \r
57         video_channel_context&                                  channel_;\r
58 \r
59         std::vector<image_transform>                    transform_stack_;\r
60         std::vector<video_mode::type>                   mode_stack_;\r
61         std::stack<blend_mode::type>                    blend_stack_;\r
62 \r
63         std::deque<std::deque<render_item>>             layers_; // layer/stream/items\r
64         \r
65         image_kernel                                                    kernel_;                \r
66 \r
67         std::shared_ptr<device_buffer>                  active_buffer_;\r
68 public:\r
69         implementation(video_channel_context& video_channel) \r
70                 : channel_(video_channel)\r
71                 , transform_stack_(1)\r
72                 , mode_stack_(1, video_mode::progressive)\r
73         {\r
74         }\r
75 \r
76         ~implementation()\r
77         {\r
78                 channel_.ogl().gc();\r
79         }\r
80         \r
81         void begin(core::basic_frame& frame)\r
82         {\r
83                 transform_stack_.push_back(transform_stack_.back()*frame.get_image_transform());\r
84                 mode_stack_.push_back(frame.get_mode() == video_mode::progressive ? mode_stack_.back() : frame.get_mode());\r
85         }\r
86                 \r
87         void visit(core::write_frame& frame)\r
88         {       \r
89                 CASPAR_ASSERT(!layers_.empty());\r
90 \r
91                 // Check if frame has been discarded by interlacing\r
92                 if(boost::range::find(mode_stack_, video_mode::upper) != mode_stack_.end() && boost::range::find(mode_stack_, video_mode::lower) != mode_stack_.end())\r
93                         return;\r
94                 \r
95                 core::render_item item(frame.get_pixel_format_desc(), frame.get_textures(), transform_stack_.back(), mode_stack_.back(), frame.tag(), blend_stack_.top());      \r
96 \r
97                 auto& layer = layers_.back();\r
98 \r
99                 if(boost::range::find(layer, item) == layer.end())\r
100                         layer.push_back(item);\r
101         }\r
102 \r
103         void end()\r
104         {\r
105                 transform_stack_.pop_back();\r
106                 mode_stack_.pop_back();\r
107         }\r
108 \r
109         void begin_layer(blend_mode::type blend_mode)\r
110         {\r
111                 blend_stack_.push(blend_mode);\r
112                 layers_.push_back(layer());\r
113         }\r
114 \r
115         void end_layer()\r
116         {\r
117                 blend_stack_.pop();\r
118         }\r
119         \r
120         boost::unique_future<safe_ptr<host_buffer>> render()\r
121         {               \r
122                 auto layers = std::move(layers_);\r
123                 return channel_.ogl().begin_invoke([=]() mutable\r
124                 {\r
125                         return render(std::move(layers));\r
126                 });\r
127         }\r
128         \r
129         safe_ptr<host_buffer> render(std::deque<layer>&& layers)\r
130         {\r
131                 std::shared_ptr<device_buffer> layer_key_buffer;\r
132 \r
133                 auto draw_buffer = create_device_buffer(4);\r
134                                 \r
135                 BOOST_FOREACH(auto& layer, layers)\r
136                         draw(std::move(layer), draw_buffer, layer_key_buffer);\r
137                 \r
138                 auto host_buffer = channel_.ogl().create_host_buffer(channel_.get_format_desc().size, host_buffer::read_only);\r
139                 channel_.ogl().attach(*draw_buffer);\r
140                 host_buffer->begin_read(draw_buffer->width(), draw_buffer->height(), format(draw_buffer->stride()));\r
141                 \r
142                 active_buffer_ = draw_buffer;\r
143 \r
144                 channel_.ogl().flush(); // NOTE: This is important, otherwise fences will deadlock.\r
145                         \r
146                 return host_buffer;\r
147         }\r
148 \r
149         // TODO: We might have more overlaps for opacity transitions\r
150         // TODO: What about blending modes, are they ok? Maybe only overlap detection is required for opacity?\r
151         void draw(layer&& layer, const safe_ptr<device_buffer>& draw_buffer, std::shared_ptr<device_buffer>& layer_key_buffer)\r
152         {                               \r
153                 if(layer.empty())\r
154                         return;\r
155 \r
156                 std::pair<int, std::shared_ptr<device_buffer>> local_key_buffer;\r
157                                 \r
158                 if(has_overlapping_items(layer, layer.front().blend_mode))\r
159                 {\r
160                         auto local_draw_buffer = create_device_buffer(4);       \r
161 \r
162                         auto local_blend_mode = layer.front().blend_mode;\r
163 \r
164                         int fields = 0;\r
165                         BOOST_FOREACH(auto& item, layer)\r
166                         {\r
167                                 if(fields & item.mode)\r
168                                         item.blend_mode = blend_mode::normal; // Disable blending, it will be used when merging back into render stack.\r
169                                 else\r
170                                 {\r
171                                         item.blend_mode = blend_mode::replace; // Target field is empty, no blending, just copy\r
172                                         fields |= item.mode;\r
173                                 }\r
174 \r
175                                 draw_item(std::move(item), local_draw_buffer, local_key_buffer, layer_key_buffer);              \r
176                         }\r
177 \r
178                         kernel_.draw(channel_.ogl(), create_render_item(local_draw_buffer, local_blend_mode), draw_buffer, nullptr, nullptr);\r
179                 }\r
180                 else // fast path\r
181                 {\r
182                         BOOST_FOREACH(auto& item, layer)                \r
183                                 draw_item(std::move(item), draw_buffer, local_key_buffer, layer_key_buffer);            \r
184                 }                                       \r
185 \r
186                 CASPAR_ASSERT(local_key_buffer.first == 0 || local_key_buffer.first == core::video_mode::progressive);\r
187 \r
188                 std::swap(local_key_buffer.second, layer_key_buffer);\r
189         }\r
190 \r
191         void draw_item(render_item&&                                                                    item, \r
192                                    const safe_ptr<device_buffer>&                                       draw_buffer, \r
193                                    std::pair<int, std::shared_ptr<device_buffer>>&      local_key_buffer, \r
194                                    std::shared_ptr<device_buffer>&                                      layer_key_buffer)\r
195         {                                                                                       \r
196                 if(item.transform.get_is_key())\r
197                 {\r
198                         if(!local_key_buffer.second)\r
199                         {\r
200                                 local_key_buffer.first = 0;\r
201                                 local_key_buffer.second = create_device_buffer(1);\r
202                         }\r
203                         \r
204                         local_key_buffer.first |= item.mode;\r
205                         kernel_.draw(channel_.ogl(), std::move(item), make_safe(local_key_buffer.second), nullptr, nullptr);\r
206                 }\r
207                 else\r
208                 {\r
209                         kernel_.draw(channel_.ogl(), std::move(item), draw_buffer, local_key_buffer.second, layer_key_buffer);\r
210                         local_key_buffer.first ^= item.mode;\r
211                         \r
212                         if(local_key_buffer.first == 0)\r
213                         {\r
214                                 local_key_buffer.first = 0;\r
215                                 local_key_buffer.second.reset();\r
216                         }\r
217                 }\r
218         }\r
219 \r
220         //// TODO: Optimize\r
221         bool has_overlapping_items(const layer& layer, blend_mode::type blend_mode)\r
222         {\r
223                 if(layer.size() < 2)\r
224                         return false;   \r
225                 \r
226                 if(blend_mode == blend_mode::normal)\r
227                         return false;\r
228                                 \r
229                 return std::any_of(layer.begin(), layer.end(), [&](const render_item& item)\r
230                 {\r
231                         return item.tag != layer.front().tag;\r
232                 });\r
233 \r
234                 //std::copy_if(layer.begin(), layer.end(), std::back_inserter(fill), [&](const render_item& item)\r
235                 //{\r
236                 //      return !item.transform.get_is_key();\r
237                 //});\r
238                 //      \r
239                 //if(blend_mode == blend_mode::normal) // only overlap if opacity\r
240                 //{\r
241                 //      return std::any_of(fill.begin(), fill.end(), [&](const render_item& item)\r
242                 //      {\r
243                 //              return item.transform.get_opacity() < 1.0 - 0.001;\r
244                 //      });\r
245                 //}\r
246 \r
247                 //// simple solution, just check if we have differnt video streams / tags.\r
248                 //return std::any_of(fill.begin(), fill.end(), [&](const render_item& item)\r
249                 //{\r
250                 //      return item.tag != fill.front().tag;\r
251                 //});\r
252         }                       \r
253                 \r
254         render_item create_render_item(const safe_ptr<device_buffer>& buffer, blend_mode::type blend_mode)\r
255         {\r
256                 CASPAR_ASSERT(buffer->stride() == 4 && "Only used for bgra textures");\r
257 \r
258                 pixel_format_desc desc;\r
259                 desc.pix_fmt = pixel_format::bgra;\r
260                 desc.planes.push_back(pixel_format_desc::plane(channel_.get_format_desc().width, channel_.get_format_desc().height, 4));\r
261 \r
262                 std::vector<safe_ptr<device_buffer>> textures;\r
263                 textures.push_back(buffer);\r
264                                 \r
265                 return render_item(desc, std::move(textures), image_transform(), video_mode::progressive, nullptr, blend_mode);          \r
266         }\r
267 \r
268         safe_ptr<device_buffer> create_device_buffer(size_t stride)\r
269         {\r
270                 auto buffer = channel_.ogl().create_device_buffer(channel_.get_format_desc().width, channel_.get_format_desc().height, stride);\r
271                 channel_.ogl().clear(*buffer);\r
272                 return buffer;\r
273         }\r
274 \r
275         safe_ptr<write_frame> create_frame(const void* tag, const core::pixel_format_desc& desc)\r
276         {\r
277                 return make_safe<write_frame>(channel_.ogl(), tag, desc);\r
278         }\r
279 };\r
280 \r
281 image_mixer::image_mixer(video_channel_context& video_channel) : impl_(new implementation(video_channel)){}\r
282 void image_mixer::begin(core::basic_frame& frame){impl_->begin(frame);}\r
283 void image_mixer::visit(core::write_frame& frame){impl_->visit(frame);}\r
284 void image_mixer::end(){impl_->end();}\r
285 boost::unique_future<safe_ptr<host_buffer>> image_mixer::render(){return impl_->render();}\r
286 safe_ptr<write_frame> image_mixer::create_frame(const void* tag, const core::pixel_format_desc& desc){return impl_->create_frame(tag, desc);}\r
287 void image_mixer::begin_layer(blend_mode::type blend_mode){impl_->begin_layer(blend_mode);}\r
288 void image_mixer::end_layer(){impl_->end_layer();}\r
289 image_mixer& image_mixer::operator=(image_mixer&& other)\r
290 {\r
291         impl_ = std::move(other.impl_);\r
292         return *this;\r
293 }\r
294 \r
295 }}