]> git.sesse.net Git - casparcg/blob - accelerator/ogl/image/image_mixer.cpp
Created template alias for std::vector<T, tbb::cache_aligned_allocator<T>> to caspar...
[casparcg] / accelerator / ogl / image / image_mixer.cpp
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 #include "../../stdafx.h"
22
23 #include "image_mixer.h"
24
25 #include "image_kernel.h"
26
27 #include "../util/device.h"
28 #include "../util/buffer.h"
29 #include "../util/texture.h"
30
31 #include <common/gl/gl_check.h>
32 #include <common/future.h>
33 #include <common/array.h>
34
35 #include <core/frame/frame.h>
36 #include <core/frame/frame_transform.h>
37 #include <core/frame/pixel_format.h>
38 #include <core/video_format.h>
39 #include <core/frame/geometry.h>
40
41 #include <asmlib.h>
42
43 #include <gl/glew.h>
44
45 #include <boost/range/algorithm_ext/erase.hpp>
46 #include <boost/thread/future.hpp>
47
48 #include <algorithm>
49 #include <vector>
50
51 namespace caspar { namespace accelerator { namespace ogl {
52                 
53 typedef std::shared_future<std::shared_ptr<texture>> future_texture;
54
55 struct item
56 {
57         core::pixel_format_desc         pix_desc        = core::pixel_format::invalid;
58         std::vector<future_texture>     textures;
59         core::image_transform           transform;
60         core::frame_geometry            geometry;
61 };
62
63 struct layer
64 {
65         std::vector<item>       items;
66         core::blend_mode        blend_mode;
67
68         layer()
69                 : blend_mode(core::blend_mode::normal)
70         {
71         }
72
73         layer(std::vector<item> items, core::blend_mode blend_mode)
74                 : items(std::move(items))
75                 , blend_mode(blend_mode)
76         {
77         }
78 };
79
80 class image_renderer
81 {
82         spl::shared_ptr<device> ogl_;
83         image_kernel                    kernel_;
84 public:
85         image_renderer(const spl::shared_ptr<device>& ogl, bool blend_modes_wanted)
86                 : ogl_(ogl)
87                 , kernel_(ogl_, blend_modes_wanted)
88         {
89         }
90         
91         std::future<array<const std::uint8_t>> operator()(std::vector<layer> layers, const core::video_format_desc& format_desc)
92         {       
93                 if(layers.empty())
94                 { // Bypass GPU with empty frame.
95                         auto buffer = spl::make_shared<const cache_aligned_vector<uint8_t>>(format_desc.size, 0);
96                         return make_ready_future(array<const std::uint8_t>(buffer->data(), format_desc.size, true, buffer));
97                 }               
98
99                 if(format_desc.field_mode != core::field_mode::progressive)
100                 { // Remove jitter from still.
101                         for (auto& layer : layers)
102                         {       
103                                 // Remove first field stills.
104                                 boost::range::remove_erase_if(layer.items, [&](const item& item)
105                                 {
106                                         return item.transform.is_still && item.transform.field_mode == format_desc.field_mode; // only us last field for stills.
107                                 });
108                 
109                                 // Stills are progressive
110                                 for (auto& item : layer.items)
111                                 {
112                                         if(item.transform.is_still)
113                                                 item.transform.field_mode = core::field_mode::progressive;
114                                 }
115                         }
116                 }
117
118                 return flatten(ogl_->begin_invoke([=]() mutable -> std::shared_future<array<const std::uint8_t>>
119                 {
120                         auto target_texture = ogl_->create_texture(format_desc.width, format_desc.height, 4);
121
122                         if (format_desc.field_mode != core::field_mode::progressive)
123                         {
124                                 draw(target_texture, layers, format_desc, core::field_mode::upper);
125                                 draw(target_texture, std::move(layers), format_desc, core::field_mode::lower);
126                         }
127                         else
128                                 draw(target_texture, std::move(layers), format_desc, core::field_mode::progressive);
129
130                         return ogl_->copy_async(target_texture);
131                 }));
132         }
133
134 private:        
135         
136         void draw(spl::shared_ptr<texture>&                     target_texture, 
137                           std::vector<layer>                            layers, 
138                           const core::video_format_desc&        format_desc,
139                           core::field_mode                                      field_mode)
140         {
141                 std::shared_ptr<texture> layer_key_texture;
142
143                 for (auto& layer : layers)
144                         draw(target_texture, std::move(layer), layer_key_texture, format_desc, field_mode);
145         }
146
147         void draw(spl::shared_ptr<texture>&                     target_texture,
148                           layer                                                         layer, 
149                           std::shared_ptr<texture>&                     layer_key_texture,
150                           const core::video_format_desc&        format_desc,
151                           core::field_mode                                      field_mode)
152         {                       
153                 // REMOVED: This is done in frame_muxer. 
154                 // Fix frames
155                 //BOOST_FOREACH(auto& item, layer.items)                
156                 //{
157                         //if(std::abs(item.transform.fill_scale[1]-1.0) > 1.0/target_texture->height() ||
158                         //   std::abs(item.transform.fill_translation[1]) > 1.0/target_texture->height())               
159                         //      CASPAR_LOG(warning) << L"[image_mixer] Frame should be deinterlaced. Send FILTER DEINTERLACE_BOB when creating producer.";      
160
161                         //if(item.pix_desc.planes.at(0).height == 480) // NTSC DV
162                         //{
163                         //      item.transform.fill_translation[1] += 2.0/static_cast<double>(format_desc.height);
164                         //      item.transform.fill_scale[1] *= 1.0 - 6.0*1.0/static_cast<double>(format_desc.height);
165                         //}
166         
167                         //// Fix field-order if needed
168                         //if(item.field_mode == core::field_mode::lower && format_desc.field_mode == core::field_mode::upper)
169                         //      item.transform.fill_translation[1] += 1.0/static_cast<double>(format_desc.height);
170                         //else if(item.field_mode == core::field_mode::upper && format_desc.field_mode == core::field_mode::lower)
171                         //      item.transform.fill_translation[1] -= 1.0/static_cast<double>(format_desc.height);
172                 //}
173
174                 // Mask out fields
175                 for (auto& item : layer.items)                          
176                         item.transform.field_mode &= field_mode;
177                 
178                 // Remove empty items.
179                 boost::range::remove_erase_if(layer.items, [&](const item& item)
180                 {
181                         return item.transform.field_mode == core::field_mode::empty;
182                 });
183                 
184                 if(layer.items.empty())
185                         return;
186
187                 std::shared_ptr<texture> local_key_texture;
188                 std::shared_ptr<texture> local_mix_texture;
189                                 
190                 if(layer.blend_mode != core::blend_mode::normal)
191                 {
192                         auto layer_texture = ogl_->create_texture(target_texture->width(), target_texture->height(), 4);
193
194                         for (auto& item : layer.items)
195                                 draw(layer_texture, std::move(item), layer_key_texture, local_key_texture, local_mix_texture);  
196                 
197                         draw(layer_texture, std::move(local_mix_texture), core::blend_mode::normal);                                                    
198                         draw(target_texture, std::move(layer_texture), layer.blend_mode);
199                 }
200                 else // fast path
201                 {
202                         for (auto& item : layer.items)          
203                                 draw(target_texture, std::move(item), layer_key_texture, local_key_texture, local_mix_texture);         
204                                         
205                         draw(target_texture, std::move(local_mix_texture), core::blend_mode::normal);
206                 }                                       
207
208                 layer_key_texture = std::move(local_key_texture);
209         }
210
211         void draw(spl::shared_ptr<texture>&     target_texture, 
212                           item                                          item, 
213                       std::shared_ptr<texture>& layer_key_texture, 
214                           std::shared_ptr<texture>&     local_key_texture, 
215                           std::shared_ptr<texture>&     local_mix_texture)
216         {                       
217                 draw_params draw_params;
218                 draw_params.pix_desc    = std::move(item.pix_desc);
219                 draw_params.transform   = std::move(item.transform);
220                 draw_params.geometry    = item.geometry;
221
222                 for (auto& future_texture : item.textures)
223                         draw_params.textures.push_back(spl::make_shared_ptr(future_texture.get()));
224
225                 if(item.transform.is_key)
226                 {
227                         local_key_texture = local_key_texture ? local_key_texture : ogl_->create_texture(target_texture->width(), target_texture->height(), 1);
228
229                         draw_params.background                  = local_key_texture;
230                         draw_params.local_key                   = nullptr;
231                         draw_params.layer_key                   = nullptr;
232
233                         kernel_.draw(std::move(draw_params));
234                 }
235                 else if(item.transform.is_mix)
236                 {
237                         local_mix_texture = local_mix_texture ? local_mix_texture : ogl_->create_texture(target_texture->width(), target_texture->height(), 4);
238
239                         draw_params.background                  = local_mix_texture;
240                         draw_params.local_key                   = std::move(local_key_texture);
241                         draw_params.layer_key                   = layer_key_texture;
242
243                         draw_params.keyer                               = keyer::additive;
244
245                         kernel_.draw(std::move(draw_params));
246                 }
247                 else
248                 {
249                         draw(target_texture, std::move(local_mix_texture), core::blend_mode::normal);
250                         
251                         draw_params.background                  = target_texture;
252                         draw_params.local_key                   = std::move(local_key_texture);
253                         draw_params.layer_key                   = layer_key_texture;
254
255                         kernel_.draw(std::move(draw_params));
256                 }       
257         }
258
259         void draw(spl::shared_ptr<texture>&      target_texture, 
260                           std::shared_ptr<texture>&& source_buffer, 
261                           core::blend_mode                       blend_mode = core::blend_mode::normal)
262         {
263                 if(!source_buffer)
264                         return;
265
266                 draw_params draw_params;
267                 draw_params.pix_desc.format             = core::pixel_format::bgra;
268                 draw_params.pix_desc.planes             = { core::pixel_format_desc::plane(source_buffer->width(), source_buffer->height(), 4) };
269                 draw_params.textures                    = { spl::make_shared_ptr(source_buffer) };
270                 draw_params.transform                   = core::image_transform();
271                 draw_params.blend_mode                  = blend_mode;
272                 draw_params.background                  = target_texture;
273                 draw_params.geometry                    = core::frame_geometry::get_default();
274
275                 kernel_.draw(std::move(draw_params));
276         }
277 };
278                 
279 struct image_mixer::impl : public core::frame_factory
280 {       
281         spl::shared_ptr<device>                         ogl_;
282         image_renderer                                          renderer_;
283         std::vector<core::image_transform>      transform_stack_;
284         std::vector<layer>                                      layers_; // layer/stream/items
285 public:
286         impl(const spl::shared_ptr<device>& ogl, bool blend_modes_wanted) 
287                 : ogl_(ogl)
288                 , renderer_(ogl, blend_modes_wanted)
289                 , transform_stack_(1)   
290         {
291                 CASPAR_LOG(info) << L"Initialized OpenGL Accelerated GPU Image Mixer";
292         }
293
294         void begin_layer(core::blend_mode blend_mode)
295         {
296                 layers_.push_back(layer(std::vector<item>(), blend_mode));
297         }
298                 
299         void push(const core::frame_transform& transform)
300         {
301                 transform_stack_.push_back(transform_stack_.back()*transform.image_transform);
302         }
303                 
304         void visit(const core::const_frame& frame)
305         {                       
306                 if(frame.pixel_format_desc().format == core::pixel_format::invalid)
307                         return;
308
309                 if(frame.pixel_format_desc().planes.empty())
310                         return;
311
312                 if(transform_stack_.back().field_mode == core::field_mode::empty)
313                         return;
314
315                 item item;
316                 item.pix_desc   = frame.pixel_format_desc();
317                 item.transform  = transform_stack_.back();
318                 item.geometry   = frame.geometry();
319                 
320                 // NOTE: Once we have copied the arrays they are no longer valid for reading!!! Check for alternative solution e.g. transfer with AMD_pinned_memory.
321                 for(int n = 0; n < static_cast<int>(item.pix_desc.planes.size()); ++n)
322                         item.textures.push_back(ogl_->copy_async(frame.image_data(n), item.pix_desc.planes[n].width, item.pix_desc.planes[n].height, item.pix_desc.planes[n].stride));
323                 
324                 layers_.back().items.push_back(item);
325         }
326
327         void pop()
328         {
329                 transform_stack_.pop_back();
330         }
331
332         void end_layer()
333         {               
334         }
335         
336         std::future<array<const std::uint8_t>> render(const core::video_format_desc& format_desc)
337         {
338                 return renderer_(std::move(layers_), format_desc);
339         }
340         
341         core::mutable_frame create_frame(const void* tag, const core::pixel_format_desc& desc) override
342         {
343                 std::vector<array<std::uint8_t>> buffers;
344                 for (auto& plane : desc.planes)         
345                         buffers.push_back(ogl_->create_array(plane.size));              
346
347                 return core::mutable_frame(std::move(buffers), core::audio_buffer(), tag, desc);
348         }
349 };
350
351 image_mixer::image_mixer(const spl::shared_ptr<device>& ogl, bool blend_modes_wanted) : impl_(new impl(ogl, blend_modes_wanted)){}
352 image_mixer::~image_mixer(){}
353 void image_mixer::push(const core::frame_transform& transform){impl_->push(transform);}
354 void image_mixer::visit(const core::const_frame& frame){impl_->visit(frame);}
355 void image_mixer::pop(){impl_->pop();}
356 std::future<array<const std::uint8_t>> image_mixer::operator()(const core::video_format_desc& format_desc){return impl_->render(format_desc);}
357 void image_mixer::begin_layer(core::blend_mode blend_mode){impl_->begin_layer(blend_mode);}
358 void image_mixer::end_layer(){impl_->end_layer();}
359 core::mutable_frame image_mixer::create_frame(const void* tag, const core::pixel_format_desc& desc) {return impl_->create_frame(tag, desc);}
360
361 }}}