src/transform/multiplanar_external_texture.h

// Copyright 2021 The Tint Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SRC_TRANSFORM_MULTIPLANAR_EXTERNAL_TEXTURE_H_
#define SRC_TRANSFORM_MULTIPLANAR_EXTERNAL_TEXTURE_H_

#include <unordered_map>
#include <utility>

#include "src/ast/struct_member.h"
#include "src/sem/binding_point.h"
#include "src/sem/builtin_type.h"
#include "src/transform/transform.h"

namespace tint {
namespace transform {

/// BindingPoint is an alias to sem::BindingPoint
using BindingPoint = sem::BindingPoint;

/// This struct identifies the binding groups and locations for new bindings to
/// use when transforming a texture_external instance.
struct BindingPoints {
  /// The desired binding location of the texture_2d representing plane #1 when
  /// a texture_external binding is expanded.
  BindingPoint plane_1;
  /// The desired binding location of the ExternalTextureParams uniform when a
  /// texture_external binding is expanded.
  BindingPoint params;
};

/// Within the MultiplanarExternalTexture transform, each instance of a
/// texture_external binding is unpacked into two texture_2d<f32> bindings
/// representing two possible planes of a texture and a uniform buffer binding
/// representing a struct of parameters. Calls to textureLoad or
/// textureSampleLevel that contain a texture_external parameter will be
/// transformed into a newly generated version of the function, which can
/// perform the desired operation on a single RGBA plane or on seperate Y and UV
/// planes.
class MultiplanarExternalTexture
    : public Castable<MultiplanarExternalTexture, Transform> {
 public:
  /// BindingsMap is a map where the key is the binding location of a
  /// texture_external and the value is a struct containing the desired
  /// locations for new bindings expanded from the texture_external instance.
  using BindingsMap = std::unordered_map<BindingPoint, BindingPoints>;

  /// NewBindingPoints is consumed by the MultiplanarExternalTexture transform.
  /// Data holds information about location of each texture_external binding and
  /// which binding slots it should expand into.
  struct NewBindingPoints : public Castable<Data, transform::Data> {
    /// Constructor
    /// @param bm a map to the new binding slots to use.
    explicit NewBindingPoints(BindingsMap bm);

    /// Destructor
    ~NewBindingPoints() override;

    /// A map of new binding points to use.
    const BindingsMap bindings_map;
  };

  /// Constructor
  MultiplanarExternalTexture();
  /// Destructor
  ~MultiplanarExternalTexture() override;

  /// @param program the program to inspect
  /// @param data optional extra transform-specific input data
  /// @returns true if this transform should be run for the given program
  bool ShouldRun(const Program* program,
                 const DataMap& data = {}) const override;

 protected:
  struct State;

  /// Runs the transform using the CloneContext built for transforming a
  /// program. Run() is responsible for calling Clone() on the CloneContext.
  /// @param ctx the CloneContext primed with the input program and
  /// ProgramBuilder
  /// @param inputs optional extra transform-specific input data
  /// @param outputs optional extra transform-specific output data
  void Run(CloneContext& ctx,
           const DataMap& inputs,
           DataMap& outputs) const override;
};

}  // namespace transform
}  // namespace tint

#endif  // SRC_TRANSFORM_MULTIPLANAR_EXTERNAL_TEXTURE_H_