2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
4 * This file is part of CasparCG (www.casparcg.com).
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.
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.
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/>.
19 * Author: Robert Nagy, ronag89@gmail.com
21 #include "../../stdafx.h"
23 #include "image_mixer.h"
25 #include "image_kernel.h"
27 #include "../util/device.h"
28 #include "../util/buffer.h"
29 #include "../util/texture.h"
31 #include <common/gl/gl_check.h>
32 #include <common/future.h>
33 #include <common/array.h>
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>
45 #include <boost/foreach.hpp>
46 #include <boost/range/algorithm_ext/erase.hpp>
47 #include <boost/thread/future.hpp>
52 using namespace boost::assign;
54 namespace caspar { namespace accelerator { namespace ogl {
56 typedef boost::shared_future<spl::shared_ptr<texture>> future_texture;
60 core::pixel_format_desc pix_desc;
61 std::vector<future_texture> textures;
62 core::image_transform transform;
63 core::frame_geometry geometry;
66 : pix_desc(core::pixel_format::invalid)
73 std::vector<item> items;
74 core::blend_mode blend_mode;
77 : blend_mode(core::blend_mode::normal)
81 layer(std::vector<item> items, core::blend_mode blend_mode)
82 : items(std::move(items))
83 , blend_mode(blend_mode)
90 spl::shared_ptr<device> ogl_;
93 image_renderer(const spl::shared_ptr<device>& ogl, bool blend_modes_wanted)
95 , kernel_(ogl_, blend_modes_wanted)
99 boost::unique_future<array<const std::uint8_t>> operator()(std::vector<layer> layers, const core::video_format_desc& format_desc)
102 { // Bypass GPU with empty frame.
103 auto buffer = spl::make_shared<const std::vector<uint8_t, tbb::cache_aligned_allocator<uint8_t>>>(format_desc.size, 0);
104 return async(launch::deferred, [=]
106 return array<const std::uint8_t>(buffer->data(), format_desc.size, true, buffer);
110 if(format_desc.field_mode != core::field_mode::progressive)
111 { // Remove jitter from still.
112 BOOST_FOREACH(auto& layer, layers)
114 // Remove first field stills.
115 boost::range::remove_erase_if(layer.items, [&](const item& item)
117 return item.transform.is_still && item.transform.field_mode == format_desc.field_mode; // only us last field for stills.
120 // Stills are progressive
121 BOOST_FOREACH(auto& item, layer.items)
123 if(item.transform.is_still)
124 item.transform.field_mode = core::field_mode::progressive;
129 return flatten(ogl_->begin_invoke([=]() mutable -> boost::shared_future<array<const std::uint8_t>>
131 auto target_texture = ogl_->create_texture(format_desc.width, format_desc.height, 4);
133 if(format_desc.field_mode != core::field_mode::progressive)
135 draw(target_texture, layers, format_desc, core::field_mode::upper);
136 draw(target_texture, std::move(layers), format_desc, core::field_mode::lower);
139 draw(target_texture, std::move(layers), format_desc, core::field_mode::progressive);
141 return ogl_->copy_async(target_texture);
147 void draw(spl::shared_ptr<texture>& target_texture,
148 std::vector<layer> layers,
149 const core::video_format_desc& format_desc,
150 core::field_mode field_mode)
152 std::shared_ptr<texture> layer_key_texture;
154 BOOST_FOREACH(auto& layer, layers)
155 draw(target_texture, std::move(layer), layer_key_texture, format_desc, field_mode);
158 void draw(spl::shared_ptr<texture>& target_texture,
160 std::shared_ptr<texture>& layer_key_texture,
161 const core::video_format_desc& format_desc,
162 core::field_mode field_mode)
164 // REMOVED: This is done in frame_muxer.
166 //BOOST_FOREACH(auto& item, layer.items)
168 //if(std::abs(item.transform.fill_scale[1]-1.0) > 1.0/target_texture->height() ||
169 // std::abs(item.transform.fill_translation[1]) > 1.0/target_texture->height())
170 // CASPAR_LOG(warning) << L"[image_mixer] Frame should be deinterlaced. Send FILTER DEINTERLACE_BOB when creating producer.";
172 //if(item.pix_desc.planes.at(0).height == 480) // NTSC DV
174 // item.transform.fill_translation[1] += 2.0/static_cast<double>(format_desc.height);
175 // item.transform.fill_scale[1] *= 1.0 - 6.0*1.0/static_cast<double>(format_desc.height);
178 //// Fix field-order if needed
179 //if(item.field_mode == core::field_mode::lower && format_desc.field_mode == core::field_mode::upper)
180 // item.transform.fill_translation[1] += 1.0/static_cast<double>(format_desc.height);
181 //else if(item.field_mode == core::field_mode::upper && format_desc.field_mode == core::field_mode::lower)
182 // item.transform.fill_translation[1] -= 1.0/static_cast<double>(format_desc.height);
186 BOOST_FOREACH(auto& item, layer.items)
187 item.transform.field_mode &= field_mode;
189 // Remove empty items.
190 boost::range::remove_erase_if(layer.items, [&](const item& item)
192 return item.transform.field_mode == core::field_mode::empty;
195 if(layer.items.empty())
198 std::shared_ptr<texture> local_key_texture;
199 std::shared_ptr<texture> local_mix_texture;
201 if(layer.blend_mode != core::blend_mode::normal)
203 auto layer_texture = ogl_->create_texture(target_texture->width(), target_texture->height(), 4);
205 BOOST_FOREACH(auto& item, layer.items)
206 draw(layer_texture, std::move(item), layer_key_texture, local_key_texture, local_mix_texture);
208 draw(layer_texture, std::move(local_mix_texture), core::blend_mode::normal);
209 draw(target_texture, std::move(layer_texture), layer.blend_mode);
213 BOOST_FOREACH(auto& item, layer.items)
214 draw(target_texture, std::move(item), layer_key_texture, local_key_texture, local_mix_texture);
216 draw(target_texture, std::move(local_mix_texture), core::blend_mode::normal);
219 layer_key_texture = std::move(local_key_texture);
222 void draw(spl::shared_ptr<texture>& target_texture,
224 std::shared_ptr<texture>& layer_key_texture,
225 std::shared_ptr<texture>& local_key_texture,
226 std::shared_ptr<texture>& local_mix_texture)
228 draw_params draw_params;
229 draw_params.pix_desc = std::move(item.pix_desc);
230 draw_params.transform = std::move(item.transform);
231 draw_params.geometry = item.geometry;
233 BOOST_FOREACH(auto& future_texture, item.textures)
234 draw_params.textures.push_back(future_texture.get());
236 if(item.transform.is_key)
238 local_key_texture = local_key_texture ? local_key_texture : ogl_->create_texture(target_texture->width(), target_texture->height(), 1);
240 draw_params.background = local_key_texture;
241 draw_params.local_key = nullptr;
242 draw_params.layer_key = nullptr;
244 kernel_.draw(std::move(draw_params));
246 else if(item.transform.is_mix)
248 local_mix_texture = local_mix_texture ? local_mix_texture : ogl_->create_texture(target_texture->width(), target_texture->height(), 4);
250 draw_params.background = local_mix_texture;
251 draw_params.local_key = std::move(local_key_texture);
252 draw_params.layer_key = layer_key_texture;
254 draw_params.keyer = keyer::additive;
256 kernel_.draw(std::move(draw_params));
260 draw(target_texture, std::move(local_mix_texture), core::blend_mode::normal);
262 draw_params.background = target_texture;
263 draw_params.local_key = std::move(local_key_texture);
264 draw_params.layer_key = layer_key_texture;
266 kernel_.draw(std::move(draw_params));
270 void draw(spl::shared_ptr<texture>& target_texture,
271 std::shared_ptr<texture>&& source_buffer,
272 core::blend_mode blend_mode = core::blend_mode::normal)
277 draw_params draw_params;
278 draw_params.pix_desc.format = core::pixel_format::bgra;
279 draw_params.pix_desc.planes = list_of(core::pixel_format_desc::plane(source_buffer->width(), source_buffer->height(), 4));
280 draw_params.textures = list_of(source_buffer);
281 draw_params.transform = core::image_transform();
282 draw_params.blend_mode = blend_mode;
283 draw_params.background = target_texture;
284 draw_params.geometry = core::frame_geometry::get_default();
286 kernel_.draw(std::move(draw_params));
290 struct image_mixer::impl : public core::frame_factory
292 spl::shared_ptr<device> ogl_;
293 image_renderer renderer_;
294 std::vector<core::image_transform> transform_stack_;
295 std::vector<layer> layers_; // layer/stream/items
297 impl(const spl::shared_ptr<device>& ogl, bool blend_modes_wanted)
299 , renderer_(ogl, blend_modes_wanted)
300 , transform_stack_(1)
302 CASPAR_LOG(info) << L"Initialized OpenGL Accelerated GPU Image Mixer";
305 void begin_layer(core::blend_mode blend_mode)
307 layers_.push_back(layer(std::vector<item>(), blend_mode));
310 void push(const core::frame_transform& transform)
312 transform_stack_.push_back(transform_stack_.back()*transform.image_transform);
315 void visit(const core::const_frame& frame)
317 if(frame.pixel_format_desc().format == core::pixel_format::invalid)
320 if(frame.pixel_format_desc().planes.empty())
323 if(transform_stack_.back().field_mode == core::field_mode::empty)
327 item.pix_desc = frame.pixel_format_desc();
328 item.transform = transform_stack_.back();
329 item.geometry = frame.geometry();
331 // 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.
332 for(int n = 0; n < static_cast<int>(item.pix_desc.planes.size()); ++n)
333 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));
335 layers_.back().items.push_back(item);
340 transform_stack_.pop_back();
347 boost::unique_future<array<const std::uint8_t>> render(const core::video_format_desc& format_desc)
349 return renderer_(std::move(layers_), format_desc);
352 core::mutable_frame create_frame(const void* tag, const core::pixel_format_desc& desc) override
354 std::vector<array<std::uint8_t>> buffers;
355 BOOST_FOREACH(auto& plane, desc.planes)
356 buffers.push_back(ogl_->create_array(plane.size));
358 return core::mutable_frame(std::move(buffers), core::audio_buffer(), tag, desc);
362 image_mixer::image_mixer(const spl::shared_ptr<device>& ogl, bool blend_modes_wanted) : impl_(new impl(ogl, blend_modes_wanted)){}
363 image_mixer::~image_mixer(){}
364 void image_mixer::push(const core::frame_transform& transform){impl_->push(transform);}
365 void image_mixer::visit(const core::const_frame& frame){impl_->visit(frame);}
366 void image_mixer::pop(){impl_->pop();}
367 boost::unique_future<array<const std::uint8_t>> image_mixer::operator()(const core::video_format_desc& format_desc){return impl_->render(format_desc);}
368 void image_mixer::begin_layer(core::blend_mode blend_mode){impl_->begin_layer(blend_mode);}
369 void image_mixer::end_layer(){impl_->end_layer();}
370 core::mutable_frame image_mixer::create_frame(const void* tag, const core::pixel_format_desc& desc) {return impl_->create_frame(tag, desc);}