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>
34 #include <common/linq.h>
36 #include <core/frame/frame.h>
37 #include <core/frame/frame_transform.h>
38 #include <core/frame/pixel_format.h>
39 #include <core/video_format.h>
40 #include <core/frame/geometry.h>
46 #include <boost/range/algorithm_ext/erase.hpp>
47 #include <boost/thread/future.hpp>
52 namespace caspar { namespace accelerator { namespace ogl {
54 typedef std::shared_future<std::shared_ptr<texture>> future_texture;
58 core::pixel_format_desc pix_desc = core::pixel_format::invalid;
59 std::vector<future_texture> textures;
60 core::image_transform transform;
61 core::frame_geometry geometry = core::frame_geometry::get_default();
66 std::vector<layer> sublayers;
67 std::vector<item> items;
68 core::blend_mode blend_mode;
70 layer(core::blend_mode blend_mode)
71 : blend_mode(blend_mode)
76 std::size_t get_max_video_format_size()
78 auto format_size = [](core::video_format format) { return core::video_format_desc(format).size; };
79 return cpplinq::from(enum_constants<core::video_format>())
80 .select(std::ref(format_size))
86 spl::shared_ptr<device> ogl_;
89 image_renderer(const spl::shared_ptr<device>& ogl, bool blend_modes_wanted, bool straight_alpha_wanted)
91 , kernel_(ogl_, blend_modes_wanted, straight_alpha_wanted)
95 std::future<array<const std::uint8_t>> operator()(std::vector<layer> layers, const core::video_format_desc& format_desc, bool straighten_alpha)
98 { // Bypass GPU with empty frame.
99 static const cache_aligned_vector<uint8_t> buffer(get_max_video_format_size(), 0);
100 return make_ready_future(array<const std::uint8_t>(buffer.data(), format_desc.size, true));
103 if(format_desc.field_mode != core::field_mode::progressive)
104 { // Remove jitter from still.
105 for (auto& layer : layers)
107 // Remove first field stills.
108 boost::range::remove_erase_if(layer.items, [&](const item& item)
110 return item.transform.is_still && item.transform.field_mode == format_desc.field_mode; // only us last field for stills.
113 // Stills are progressive
114 for (auto& item : layer.items)
116 if(item.transform.is_still)
117 item.transform.field_mode = core::field_mode::progressive;
122 return flatten(ogl_->begin_invoke([=]() mutable -> std::shared_future<array<const std::uint8_t>>
124 auto target_texture = ogl_->create_texture(format_desc.width, format_desc.height, 4, false);
126 if (format_desc.field_mode != core::field_mode::progressive)
128 draw(target_texture, layers, format_desc, core::field_mode::upper);
129 draw(target_texture, std::move(layers), format_desc, core::field_mode::lower);
132 draw(target_texture, std::move(layers), format_desc, core::field_mode::progressive);
134 kernel_.post_process(target_texture, straighten_alpha);
136 return ogl_->copy_async(target_texture);
142 void draw(spl::shared_ptr<texture>& target_texture,
143 std::vector<layer> layers,
144 const core::video_format_desc& format_desc,
145 core::field_mode field_mode)
147 std::shared_ptr<texture> layer_key_texture;
149 for (auto& layer : layers)
151 draw(target_texture, layer.sublayers, format_desc, field_mode);
152 draw(target_texture, std::move(layer), layer_key_texture, format_desc, field_mode);
156 void draw(spl::shared_ptr<texture>& target_texture,
158 std::shared_ptr<texture>& layer_key_texture,
159 const core::video_format_desc& format_desc,
160 core::field_mode field_mode)
162 // REMOVED: This is done in frame_muxer.
164 //BOOST_FOREACH(auto& item, layer.items)
166 //if(std::abs(item.transform.fill_scale[1]-1.0) > 1.0/target_texture->height() ||
167 // std::abs(item.transform.fill_translation[1]) > 1.0/target_texture->height())
168 // CASPAR_LOG(warning) << L"[image_mixer] Frame should be deinterlaced. Send FILTER DEINTERLACE_BOB when creating producer.";
170 //if(item.pix_desc.planes.at(0).height == 480) // NTSC DV
172 // item.transform.fill_translation[1] += 2.0/static_cast<double>(format_desc.height);
173 // item.transform.fill_scale[1] *= 1.0 - 6.0*1.0/static_cast<double>(format_desc.height);
176 //// Fix field-order if needed
177 //if(item.field_mode == core::field_mode::lower && format_desc.field_mode == core::field_mode::upper)
178 // item.transform.fill_translation[1] += 1.0/static_cast<double>(format_desc.height);
179 //else if(item.field_mode == core::field_mode::upper && format_desc.field_mode == core::field_mode::lower)
180 // item.transform.fill_translation[1] -= 1.0/static_cast<double>(format_desc.height);
184 for (auto& item : layer.items)
185 item.transform.field_mode &= field_mode;
187 // Remove empty items.
188 boost::range::remove_erase_if(layer.items, [&](const item& item)
190 return item.transform.field_mode == core::field_mode::empty;
193 if(layer.items.empty())
196 std::shared_ptr<texture> local_key_texture;
197 std::shared_ptr<texture> local_mix_texture;
199 if(layer.blend_mode != core::blend_mode::normal)
201 auto layer_texture = ogl_->create_texture(target_texture->width(), target_texture->height(), 4, false);
203 for (auto& item : layer.items)
204 draw(layer_texture, std::move(item), layer_key_texture, local_key_texture, local_mix_texture, format_desc);
206 draw(layer_texture, std::move(local_mix_texture), core::blend_mode::normal);
207 draw(target_texture, std::move(layer_texture), layer.blend_mode);
211 for (auto& item : layer.items)
212 draw(target_texture, std::move(item), layer_key_texture, local_key_texture, local_mix_texture, format_desc);
214 draw(target_texture, std::move(local_mix_texture), core::blend_mode::normal);
217 layer_key_texture = std::move(local_key_texture);
220 void draw(spl::shared_ptr<texture>& target_texture,
222 std::shared_ptr<texture>& layer_key_texture,
223 std::shared_ptr<texture>& local_key_texture,
224 std::shared_ptr<texture>& local_mix_texture,
225 const core::video_format_desc& format_desc)
227 draw_params draw_params;
228 draw_params.pix_desc = std::move(item.pix_desc);
229 draw_params.transform = std::move(item.transform);
230 draw_params.geometry = item.geometry;
231 draw_params.aspect_ratio = static_cast<double>(format_desc.square_width) / static_cast<double>(format_desc.square_height);
233 for (auto& future_texture : item.textures)
234 draw_params.textures.push_back(spl::make_shared_ptr(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, draw_params.transform.use_mipmap);
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, draw_params.transform.use_mipmap);
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 = { core::pixel_format_desc::plane(source_buffer->width(), source_buffer->height(), 4) };
280 draw_params.textures = { spl::make_shared_ptr(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
296 std::vector<layer*> layer_stack_;
298 impl(const spl::shared_ptr<device>& ogl, bool blend_modes_wanted, bool straight_alpha_wanted, int channel_id)
300 , renderer_(ogl, blend_modes_wanted, straight_alpha_wanted)
301 , transform_stack_(1)
303 CASPAR_LOG(info) << L"Initialized OpenGL Accelerated GPU Image Mixer for channel " << channel_id;
306 void push(const core::frame_transform& transform)
308 auto previous_layer_depth = transform_stack_.back().layer_depth;
309 transform_stack_.push_back(transform_stack_.back() * transform.image_transform);
310 auto new_layer_depth = transform_stack_.back().layer_depth;
312 if (previous_layer_depth < new_layer_depth)
314 layer new_layer(transform_stack_.back().blend_mode);
316 if (layer_stack_.empty())
318 layers_.push_back(std::move(new_layer));
319 layer_stack_.push_back(&layers_.back());
323 layer_stack_.back()->sublayers.push_back(std::move(new_layer));
324 layer_stack_.push_back(&layer_stack_.back()->sublayers.back());
330 void visit(const core::const_frame& frame)
332 if(frame.pixel_format_desc().format == core::pixel_format::invalid)
335 if(frame.pixel_format_desc().planes.empty())
338 if(transform_stack_.back().field_mode == core::field_mode::empty)
342 item.pix_desc = frame.pixel_format_desc();
343 item.transform = transform_stack_.back();
344 item.geometry = frame.geometry();
346 // 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.
347 for(int n = 0; n < static_cast<int>(item.pix_desc.planes.size()); ++n)
348 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, item.transform.use_mipmap));
350 layer_stack_.back()->items.push_back(item);
355 transform_stack_.pop_back();
356 layer_stack_.resize(transform_stack_.back().layer_depth);
359 std::future<array<const std::uint8_t>> render(const core::video_format_desc& format_desc, bool straighten_alpha)
361 return renderer_(std::move(layers_), format_desc, straighten_alpha);
364 core::mutable_frame create_frame(const void* tag, const core::pixel_format_desc& desc, const core::audio_channel_layout& channel_layout) override
366 std::vector<array<std::uint8_t>> buffers;
367 for (auto& plane : desc.planes)
368 buffers.push_back(ogl_->create_array(plane.size));
370 return core::mutable_frame(std::move(buffers), core::mutable_audio_buffer(), tag, desc, channel_layout);
374 image_mixer::image_mixer(const spl::shared_ptr<device>& ogl, bool blend_modes_wanted, bool straight_alpha_wanted, int channel_id) : impl_(new impl(ogl, blend_modes_wanted, straight_alpha_wanted, channel_id)){}
375 image_mixer::~image_mixer(){}
376 void image_mixer::push(const core::frame_transform& transform){impl_->push(transform);}
377 void image_mixer::visit(const core::const_frame& frame){impl_->visit(frame);}
378 void image_mixer::pop(){impl_->pop();}
379 std::future<array<const std::uint8_t>> image_mixer::operator()(const core::video_format_desc& format_desc, bool straighten_alpha){return impl_->render(format_desc, straighten_alpha);}
380 core::mutable_frame image_mixer::create_frame(const void* tag, const core::pixel_format_desc& desc, const core::audio_channel_layout& channel_layout) {return impl_->create_frame(tag, desc, channel_layout);}