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