zircon/system/ulib/image-format/include/lib/image-format-llcpp/image-format-llcpp.h

// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef LIB_IMAGE_FORMAT_LLCPP_IMAGE_FORMAT_LLCPP_H_
#define LIB_IMAGE_FORMAT_LLCPP_IMAGE_FORMAT_LLCPP_H_

#include <fidl/fuchsia.sysmem/cpp/wire.h>
#include <fuchsia/sysmem/c/fidl.h>
#include <lib/image-format/image_format.h>

#include <optional>

// TODO(fxbug.dev/53304): We can merge this file and image-format.h, since there's no need to have a
// separate lib for C vs. LLCPP overloads of these functions.
namespace image_format {

fuchsia_sysmem_ImageFormatConstraints GetCConstraints(
    const fuchsia_sysmem::wire::ImageFormatConstraints& cpp);

fuchsia_sysmem::wire::PixelFormat GetCppPixelFormat(const fuchsia_sysmem_PixelFormat& pixel_format);

fuchsia_sysmem_PixelFormat GetCPixelFormat(const fuchsia_sysmem::wire::PixelFormat& pixel_format);

constexpr fuchsia_sysmem::wire::ImageFormatConstraints GetDefaultImageFormatConstraints() {
  // Should match values in constraints.fidl.
  // TODO(fxbug.dev/35314): LLCPP should initialize to default values.
  return fuchsia_sysmem::wire::ImageFormatConstraints{
      .max_coded_width_times_coded_height = 0xffffffff,
      .layers = 1,
      .coded_width_divisor = 1,
      .coded_height_divisor = 1,
      .bytes_per_row_divisor = 1,
      .start_offset_divisor = 1,
      .display_width_divisor = 1,
      .display_height_divisor = 1,
  };
}

constexpr fuchsia_sysmem::wire::BufferMemoryConstraints GetDefaultBufferMemoryConstraints() {
  // Should match values in constraints.fidl.
  // TODO(fxbug.dev/35314): LLCPP should initialize to default values.
  return fuchsia_sysmem::wire::BufferMemoryConstraints{.min_size_bytes = 0,
                                                       .max_size_bytes = 0xffffffff,
                                                       .physically_contiguous_required = false,
                                                       .secure_required = false,
                                                       .ram_domain_supported = false,
                                                       .cpu_domain_supported = true,
                                                       .inaccessible_domain_supported = false,
                                                       .heap_permitted_count = 0};
}

bool GetMinimumRowBytes(const fuchsia_sysmem::wire::ImageFormatConstraints& constraints,
                        uint32_t width, uint32_t* bytes_per_row_out);

std::optional<fuchsia_sysmem::wire::ImageFormat2> ConstraintsToFormat(
    const fuchsia_sysmem::wire::ImageFormatConstraints& constraints, uint32_t coded_width,
    uint32_t coded_height);

bool GetPlaneByteOffset(const fuchsia_sysmem::wire::ImageFormat2& image_format, uint32_t plane,
                        uint64_t* offset_out);

bool GetPlaneRowBytes(const fuchsia_sysmem::wire::ImageFormat2& image_format, uint32_t plane,
                      uint32_t* row_bytes_out);

bool FormatCompatibleWithProtectedMemory(const fuchsia_sysmem::wire::PixelFormat& format);

}  // namespace image_format

#endif  // LIB_IMAGE_FORMAT_LLCPP_IMAGE_FORMAT_LLCPP_H_