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