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
  40 #include <asmlib.h>
  41
  42 #include <gl/glew.h>
  43
  44 #include <boost/foreach.hpp>
  45 #include <boost/range/algorithm_ext/erase.hpp>
  46 #include <boost/thread/future.hpp>
  47
  48 #include <algorithm>
  49 #include <vector>
  50
  51 using namespace boost::assign;
  52
  53 namespace caspar { namespace accelerator { namespace ogl {
  54
  55 typedef boost::shared_future<spl::shared_ptr<texture>> future_texture;
  56
  57 struct item
  58 {
  59         core::pixel_format_desc                                                         pix_desc;
  60         std::vector<future_texture>                                                     textures;
  61         core::image_transform                                                           transform;
  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)
  92                 : ogl_(ogl)
  93                 , kernel_(ogl_)
  94         {
  95         }
  96
  97         boost::unique_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 async(launch::deferred, [=]
 103                         {
 104                                 return array<const std::uint8_t>(buffer->data(), format_desc.size, true, buffer);
 105                         });
 106                 }
 107
 108                 if(format_desc.field_mode != core::field_mode::progressive)
 109                 { // Remove jitter from still.
 110                         BOOST_FOREACH(auto& layer, layers)
 111                         {
 112                                 // Remove first field stills.
 113                                 boost::range::remove_erase_if(layer.items, [&](const item& item)
 114                                 {
 115                                         return item.transform.is_still && item.transform.field_mode == format_desc.field_mode; // only us last field for stills.
 116                                 });
 117
 118                                 // Stills are progressive
 119                                 BOOST_FOREACH(auto& item, layer.items)
 120                                 {
 121                                         if(item.transform.is_still)
 122                                                 item.transform.field_mode = core::field_mode::progressive;
 123                                 }
 124                         }
 125                 }
 126
 127                 return flatten(ogl_->begin_invoke([=]() mutable -> boost::shared_future<array<const std::uint8_t>>
 128                 {
 129                         auto target_texture = ogl_->create_texture(format_desc.width, format_desc.height, 4);
 130
 131                         if(format_desc.field_mode != core::field_mode::progressive)
 132                         {
 133                                 draw(target_texture, layers,                    format_desc, core::field_mode::upper);
 134                                 draw(target_texture, std::move(layers), format_desc, core::field_mode::lower);
 135                         }
 136                         else
 137                                 draw(target_texture, std::move(layers), format_desc, core::field_mode::progressive);
 138
 139                         return ogl_->copy_async(target_texture);
 140                 }));
 141         }
 142
 143 private:
 144
 145         void draw(spl::shared_ptr<texture>&                     target_texture,
 146                           std::vector<layer>                            layers,
 147                           const core::video_format_desc&        format_desc,
 148                           core::field_mode                                      field_mode)
 149         {
 150                 std::shared_ptr<texture> layer_key_texture;
 151
 152                 BOOST_FOREACH(auto& layer, layers)
 153                         draw(target_texture, std::move(layer), layer_key_texture, format_desc, field_mode);
 154         }
 155
 156         void draw(spl::shared_ptr<texture>&                     target_texture,
 157                           layer                                                         layer,
 158                           std::shared_ptr<texture>&                     layer_key_texture,
 159                           const core::video_format_desc&        format_desc,
 160                           core::field_mode                                      field_mode)
 161         {
 162                 // REMOVED: This is done in frame_muxer.
 163                 // Fix frames
 164                 //BOOST_FOREACH(auto& item, layer.items)
 165                 //{
 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.";
 169
 170                         //if(item.pix_desc.planes.at(0).height == 480) // NTSC DV
 171                         //{
 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);
 174                         //}
 175
 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);
 181                 //}
 182
 183                 // Mask out fields
 184                 BOOST_FOREACH(auto& item, layer.items)
 185                         item.transform.field_mode &= field_mode;
 186
 187                 // Remove empty items.
 188                 boost::range::remove_erase_if(layer.items, [&](const item& item)
 189                 {
 190                         return item.transform.field_mode == core::field_mode::empty;
 191                 });
 192
 193                 if(layer.items.empty())
 194                         return;
 195
 196                 std::shared_ptr<texture> local_key_texture;
 197                 std::shared_ptr<texture> local_mix_texture;
 198
 199                 if(layer.blend_mode != core::blend_mode::normal)
 200                 {
 201                         auto layer_texture = ogl_->create_texture(target_texture->width(), target_texture->height(), 4);
 202
 203                         BOOST_FOREACH(auto& item, layer.items)
 204                                 draw(layer_texture, std::move(item), layer_key_texture, local_key_texture, local_mix_texture);
 205
 206                         draw(layer_texture, std::move(local_mix_texture), core::blend_mode::normal);
 207                         draw(target_texture, std::move(layer_texture), layer.blend_mode);
 208                 }
 209                 else // fast path
 210                 {
 211                         BOOST_FOREACH(auto& item, layer.items)
 212                                 draw(target_texture, std::move(item), layer_key_texture, local_key_texture, local_mix_texture);
 213
 214                         draw(target_texture, std::move(local_mix_texture), core::blend_mode::normal);
 215                 }
 216
 217                 layer_key_texture = std::move(local_key_texture);
 218         }
 219
 220         void draw(spl::shared_ptr<texture>&     target_texture,
 221                           item                                          item,
 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         {
 226                 draw_params draw_params;
 227                 draw_params.pix_desc    = std::move(item.pix_desc);
 228                 draw_params.transform   = std::move(item.transform);
 229
 230                 BOOST_FOREACH(auto& future_texture, item.textures)
 231                         draw_params.textures.push_back(future_texture.get());
 232
 233                 if(item.transform.is_key)
 234                 {
 235                         local_key_texture = local_key_texture ? local_key_texture : ogl_->create_texture(target_texture->width(), target_texture->height(), 1);
 236
 237                         draw_params.background                  = local_key_texture;
 238                         draw_params.local_key                   = nullptr;
 239                         draw_params.layer_key                   = nullptr;
 240
 241                         kernel_.draw(std::move(draw_params));
 242                 }
 243                 else if(item.transform.is_mix)
 244                 {
 245                         local_mix_texture = local_mix_texture ? local_mix_texture : ogl_->create_texture(target_texture->width(), target_texture->height(), 4);
 246
 247                         draw_params.background                  = local_mix_texture;
 248                         draw_params.local_key                   = std::move(local_key_texture);
 249                         draw_params.layer_key                   = layer_key_texture;
 250
 251                         draw_params.keyer                               = keyer::additive;
 252
 253                         kernel_.draw(std::move(draw_params));
 254                 }
 255                 else
 256                 {
 257                         draw(target_texture, std::move(local_mix_texture), core::blend_mode::normal);
 258
 259                         draw_params.background                  = target_texture;
 260                         draw_params.local_key                   = std::move(local_key_texture);
 261                         draw_params.layer_key                   = layer_key_texture;
 262
 263                         kernel_.draw(std::move(draw_params));
 264                 }
 265         }
 266
 267         void draw(spl::shared_ptr<texture>&      target_texture,
 268                           std::shared_ptr<texture>&& source_buffer,
 269                           core::blend_mode                       blend_mode = core::blend_mode::normal)
 270         {
 271                 if(!source_buffer)
 272                         return;
 273
 274                 draw_params draw_params;
 275                 draw_params.pix_desc.format             = core::pixel_format::bgra;
 276                 draw_params.pix_desc.planes             = list_of(core::pixel_format_desc::plane(source_buffer->width(), source_buffer->height(), 4));
 277                 draw_params.textures                    = list_of(source_buffer);
 278                 draw_params.transform                   = core::image_transform();
 279                 draw_params.blend_mode                  = blend_mode;
 280                 draw_params.background                  = target_texture;
 281
 282                 kernel_.draw(std::move(draw_params));
 283         }
 284 };
 285
 286 struct image_mixer::impl : public core::frame_factory
 287 {
 288         spl::shared_ptr<device>                         ogl_;
 289         image_renderer                                          renderer_;
 290         std::vector<core::image_transform>      transform_stack_;
 291         std::vector<layer>                                      layers_; // layer/stream/items
 292 public:
 293         impl(const spl::shared_ptr<device>& ogl)
 294                 : ogl_(ogl)
 295                 , renderer_(ogl)
 296                 , transform_stack_(1)
 297         {
 298                 CASPAR_LOG(info) << L"Initialized OpenGL Accelerated GPU Image Mixer";
 299         }
 300
 301         void begin_layer(core::blend_mode blend_mode)
 302         {
 303                 layers_.push_back(layer(std::vector<item>(), blend_mode));
 304         }
 305
 306         void push(const core::frame_transform& transform)
 307         {
 308                 transform_stack_.push_back(transform_stack_.back()*transform.image_transform);
 309         }
 310
 311         void visit(const core::const_frame& frame)
 312         {
 313                 if(frame.pixel_format_desc().format == core::pixel_format::invalid)
 314                         return;
 315
 316                 if(frame.pixel_format_desc().planes.empty())
 317                         return;
 318
 319                 if(transform_stack_.back().field_mode == core::field_mode::empty)
 320                         return;
 321
 322                 item item;
 323                 item.pix_desc   = frame.pixel_format_desc();
 324                 item.transform  = transform_stack_.back();
 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         boost::unique_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) : impl_(new impl(ogl)){}
 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 boost::unique_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 }}}