/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

/*!
 * \file tvm/relax/attrs/image.h
 * \brief Attributes for image operators.
 */
#ifndef TVM_RELAX_ATTRS_IMAGE_H_
#define TVM_RELAX_ATTRS_IMAGE_H_

#include <tvm/relax/expr.h>

namespace tvm {
namespace relax {

/*! \brief Attributes used in image resize2d operator */
struct Resize2DAttrs : public AttrsNode {
  ffi::Array<FloatImm> roi;
  ffi::String layout;
  ffi::String method;
  ffi::String coordinate_transformation_mode;
  ffi::String rounding_method;
  double cubic_alpha;
  int cubic_exclude;
  double extrapolation_value;
  ffi::Optional<DLDataType> out_dtype;

  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<Resize2DAttrs>()
        .def_ro("roi", &Resize2DAttrs::roi,
                "Region of Interest for coordinate transformation mode 'tf_crop_and_resize'")
        .def_ro("layout", &Resize2DAttrs::layout,
                "Dimension ordering of input data. Can be 'NCHW', 'NHWC', etc."
                "'N', 'C', 'H', 'W' stands for batch, channel, height, and width"
                "dimensions respectively. Resize is applied on the 'H' and"
                "'W' dimensions.")
        .def_ro("method", &Resize2DAttrs::method,
                "Specify the mode to use for scaling."
                "nearest_neighbor -  Nearest Neighbor"
                "linear - Bilinear Interpolation"
                "cubic - Bicubic Interpolation")
        .def_ro("coordinate_transformation_mode", &Resize2DAttrs::coordinate_transformation_mode,
                "Describes how to transform the coordinate in the resized tensor"
                "to the coordinate in the original tensor."
                "Refer to the ONNX Resize operator specification for details"
                "Available options are half_pixel, align_corners and asymmetric")
        .def_ro("rounding_method", &Resize2DAttrs::rounding_method,
                "indicates how to find the \"nearest\" pixel in nearest_neighbor method"
                "Available options are round, floor, and ceil.")
        .def_ro("cubic_alpha", &Resize2DAttrs::cubic_alpha,
                "Spline Coefficient for Bicubic Interpolation")
        .def_ro("cubic_exclude", &Resize2DAttrs::cubic_exclude,
                "Flag to exclude exterior of the image during bicubic interpolation")
        .def_ro("extrapolation_value", &Resize2DAttrs::extrapolation_value,
                "Value to return when roi is outside of the image")
        .def_ro(
            "out_dtype", &Resize2DAttrs::out_dtype,
            "The dtype of the output tensor. It it is not specified, the output will have the same "
            "dtype as input if not specified.");
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("relax.attrs.Resize2DAttrs", Resize2DAttrs, AttrsNode);
};  // struct Resize2dAttrs

/*! \brief Attributes used in image resize3d operator */
struct Resize3DAttrs : public AttrsNode {
  ffi::Array<FloatImm> roi;
  ffi::String layout;
  ffi::String method;
  ffi::String coordinate_transformation_mode;
  ffi::String rounding_method;
  double cubic_alpha;
  int cubic_exclude;
  double extrapolation_value;
  ffi::Optional<DLDataType> out_dtype;

  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<Resize3DAttrs>()
        .def_ro("roi", &Resize3DAttrs::roi,
                "Region of Interest for coordinate transformation mode 'tf_crop_and_resize'")
        .def_ro("layout", &Resize3DAttrs::layout,
                "Dimension ordering of input data. Can be 'NCDHW', 'NDHWC', etc."
                "'N', 'C', 'D', 'H', 'W' stands for batch, channel, depth, height, and width"
                "dimensions respectively. Resize is applied on the 'D', 'H' and"
                "'W' dimensions.")
        .def_ro("method", &Resize3DAttrs::method,
                "Specify the mode to use for scaling."
                "nearest_neighbor -  Nearest Neighbor"
                "linear - Trilinear Interpolation"
                "cubic - Tricubic Interpolation")
        .def_ro("coordinate_transformation_mode", &Resize3DAttrs::coordinate_transformation_mode,
                "Describes how to transform the coordinate in the resized tensor"
                "to the coordinate in the original tensor."
                "Refer to the ONNX Resize operator specification for details"
                "Available options are half_pixel, align_corners and asymmetric")
        .def_ro("rounding_method", &Resize3DAttrs::rounding_method,
                "indicates how to find the \"nearest\" pixel in nearest_neighbor method"
                "Available options are round, floor, and ceil.")
        .def_ro("cubic_alpha", &Resize3DAttrs::cubic_alpha,
                "Spline Coefficient for Tricubic Interpolation")
        .def_ro("cubic_exclude", &Resize3DAttrs::cubic_exclude,
                "Flag to exclude exterior of the image during tricubic interpolation")
        .def_ro("extrapolation_value", &Resize3DAttrs::extrapolation_value,
                "Value to return when roi is outside of the image")
        .def_ro(
            "out_dtype", &Resize3DAttrs::out_dtype,
            "The dtype of the output tensor. It it is not specified, the output will have the same "
            "dtype as input if not specified.");
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("relax.attrs.Resize3DAttrs", Resize3DAttrs, AttrsNode);
};  // struct Resize3DAttrs

/*! \brief Attributes used in image grid_sample operator */
struct GridSampleAttrs : public AttrsNode {
  ffi::String method;
  ffi::String layout;
  ffi::String padding_mode;
  bool align_corners;

  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<GridSampleAttrs>()
        .def_ro("method", &GridSampleAttrs::method,
                "Interpolation method. Can be 'nearest', 'bilinear', or 'bicubic'.")
        .def_ro("layout", &GridSampleAttrs::layout,
                "Dimension ordering of input data. Can be 'NCHW', 'NHWC', etc.")
        .def_ro("padding_mode", &GridSampleAttrs::padding_mode,
                "Padding mode for outside grid values. Can be 'zeros', 'border', or 'reflection'.")
        .def_ro("align_corners", &GridSampleAttrs::align_corners,
                "If True, the corner pixels of the input and output tensors are aligned.");
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("relax.attrs.GridSampleAttrs", GridSampleAttrs, AttrsNode);
};  // struct GridSampleAttrs

/*! \brief Attributes used in image affine_grid operator */
struct AffineGridAttrs : public AttrsNode {
  bool align_corners;

  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<AffineGridAttrs>().def_ro(
        "align_corners", &AffineGridAttrs::align_corners,
        "If True, normalized grid coordinates map to corner pixels; otherwise to pixel centers.");
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("relax.attrs.AffineGridAttrs", AffineGridAttrs, AttrsNode);
};  // struct AffineGridAttrs

}  // namespace relax
}  // namespace tvm

#endif  // TVM_RELAX_ATTRS_IMAGE_H_
