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