/* * Copyright (c) 2016, Alliance for Open Media. All rights reserved. * * This source code is subject to the terms of the BSD 2 Clause License and * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License * was not distributed with this source code in the LICENSE file, you can * obtain it at www.aomedia.org/license/software. If the Alliance for Open * Media Patent License 1.0 was not distributed with this source code in the * PATENTS file, you can obtain it at www.aomedia.org/license/patent. */ /*!\file * \brief Describes the aom image descriptor and associated operations * */ #ifndef AOM_AOM_AOM_IMAGE_H_ #define AOM_AOM_AOM_IMAGE_H_ #ifdef __cplusplus extern "C" { #endif #include "aom/aom_integer.h" /*!\brief Current ABI version number * * \internal * If this file is altered in any way that changes the ABI, this value * must be bumped. Examples include, but are not limited to, changing * types, removing or reassigning enums, adding/removing/rearranging * fields to structures */ #define AOM_IMAGE_ABI_VERSION … #define AOM_IMG_FMT_PLANAR … #define AOM_IMG_FMT_UV_FLIP … /** 0x400 used to signal alpha channel, skipping for backwards compatibility. */ #define AOM_IMG_FMT_HIGHBITDEPTH … /*!\brief List of supported image formats */ aom_img_fmt_t; /**< alias for enum aom_img_fmt */ /*!\brief List of supported color primaries */ aom_color_primaries_t; /**< alias for enum aom_color_primaries */ /*!\brief List of supported transfer functions */ aom_transfer_characteristics_t; /**< alias for enum aom_transfer_characteristics */ /*!\brief List of supported matrix coefficients */ aom_matrix_coefficients_t; /**< alias for enum aom_matrix_coefficients */ /*!\brief List of supported color range */ aom_color_range_t; /**< alias for enum aom_color_range */ /*!\brief List of chroma sample positions */ aom_chroma_sample_position_t; /**< alias for enum aom_chroma_sample_position */ /*!\brief List of insert flags for Metadata * * These flags control how the library treats metadata during encode. * * While encoding, when metadata is added to an aom_image via * aom_img_add_metadata(), the flag passed along with the metadata will * determine where the metadata OBU will be placed in the encoded OBU stream. * Metadata will be emitted into the output stream within the next temporal unit * if it satisfies the specified insertion flag. * * During decoding, when the library encounters a metadata OBU, it is always * flagged as AOM_MIF_ANY_FRAME and emitted with the next output aom_image. */ aom_metadata_insert_flags_t; /*!\brief Array of aom_metadata structs for an image. */ aom_metadata_array_t; /*!\brief Metadata payload. */ aom_metadata_t; /**\brief Image Descriptor */ aom_image_t; /**< alias for struct aom_image */ /*!\brief Open a descriptor, allocating storage for the underlying image * * Returns a descriptor for storing an image of the given format. The * storage for the image is allocated on the heap. * * \param[in] img Pointer to storage for descriptor. If this parameter * is NULL, the storage for the descriptor will be * allocated on the heap. * \param[in] fmt Format for the image * \param[in] d_w Width of the image. Must not exceed 0x08000000 * (2^27). * \param[in] d_h Height of the image. Must not exceed 0x08000000 * (2^27). * \param[in] align Alignment, in bytes, of the image buffer and * each row in the image (stride). Must not exceed * 65536. * * \return Returns a pointer to the initialized image descriptor. If the img * parameter is non-null, the value of the img parameter will be * returned. */ aom_image_t *aom_img_alloc(aom_image_t *img, aom_img_fmt_t fmt, unsigned int d_w, unsigned int d_h, unsigned int align); /*!\brief Open a descriptor, using existing storage for the underlying image * * Returns a descriptor for storing an image of the given format. The * storage for the image has been allocated elsewhere, and a descriptor is * desired to "wrap" that storage. * * \param[in] img Pointer to storage for descriptor. If this parameter * is NULL, the storage for the descriptor will be * allocated on the heap. * \param[in] fmt Format for the image * \param[in] d_w Width of the image. Must not exceed 0x08000000 * (2^27). * \param[in] d_h Height of the image. Must not exceed 0x08000000 * (2^27). * \param[in] align Alignment, in bytes, of each row in the image * (stride). Must not exceed 65536. * \param[in] img_data Storage to use for the image * * \return Returns a pointer to the initialized image descriptor. If the img * parameter is non-null, the value of the img parameter will be * returned. */ aom_image_t *aom_img_wrap(aom_image_t *img, aom_img_fmt_t fmt, unsigned int d_w, unsigned int d_h, unsigned int align, unsigned char *img_data); /*!\brief Open a descriptor, allocating storage for the underlying image with a * border * * Returns a descriptor for storing an image of the given format and its * borders. The storage for the image is allocated on the heap. * * \param[in] img Pointer to storage for descriptor. If this parameter * is NULL, the storage for the descriptor will be * allocated on the heap. * \param[in] fmt Format for the image * \param[in] d_w Width of the image. Must not exceed 0x08000000 * (2^27). * \param[in] d_h Height of the image. Must not exceed 0x08000000 * (2^27). * \param[in] align Alignment, in bytes, of the image buffer and * each row in the image (stride). Must not exceed * 65536. * \param[in] size_align Alignment, in pixels, of the image width and height. * Must not exceed 65536. * \param[in] border A border that is padded on four sides of the image. * Must not exceed 65536. * * \return Returns a pointer to the initialized image descriptor. If the img * parameter is non-null, the value of the img parameter will be * returned. */ aom_image_t *aom_img_alloc_with_border(aom_image_t *img, aom_img_fmt_t fmt, unsigned int d_w, unsigned int d_h, unsigned int align, unsigned int size_align, unsigned int border); /*!\brief Set the rectangle identifying the displayed portion of the image * * Updates the displayed rectangle (aka viewport) on the image surface to * match the specified coordinates and size. Specifically, sets img->d_w, * img->d_h, and elements of the img->planes[] array. * * \param[in] img Image descriptor * \param[in] x leftmost column * \param[in] y topmost row * \param[in] w width * \param[in] h height * \param[in] border A border that is padded on four sides of the image. * * \return 0 if the requested rectangle is valid, nonzero (-1) otherwise. */ int aom_img_set_rect(aom_image_t *img, unsigned int x, unsigned int y, unsigned int w, unsigned int h, unsigned int border); /*!\brief Flip the image vertically (top for bottom) * * Adjusts the image descriptor's pointers and strides to make the image * be referenced upside-down. * * \param[in] img Image descriptor */ void aom_img_flip(aom_image_t *img); /*!\brief Close an image descriptor * * Frees all allocated storage associated with an image descriptor. * * \param[in] img Image descriptor */ void aom_img_free(aom_image_t *img); /*!\brief Get the width of a plane * * Get the width of a plane of an image * * \param[in] img Image descriptor * \param[in] plane Plane index */ int aom_img_plane_width(const aom_image_t *img, int plane); /*!\brief Get the height of a plane * * Get the height of a plane of an image * * \param[in] img Image descriptor * \param[in] plane Plane index */ int aom_img_plane_height(const aom_image_t *img, int plane); /*!\brief Add metadata to image. * * Adds metadata to aom_image_t. * Function makes a copy of the provided data parameter. * Metadata insertion point is controlled by insert_flag. * * \param[in] img Image descriptor * \param[in] type Metadata type * \param[in] data Metadata contents * \param[in] sz Metadata contents size * \param[in] insert_flag Metadata insert flag * * \return Returns 0 on success. If img or data is NULL, sz is 0, or memory * allocation fails, it returns -1. */ int aom_img_add_metadata(aom_image_t *img, uint32_t type, const uint8_t *data, size_t sz, aom_metadata_insert_flags_t insert_flag); /*!\brief Return a metadata payload stored within the image metadata array. * * Gets the metadata (aom_metadata_t) at the indicated index in the image * metadata array. * * \param[in] img Pointer to image descriptor to get metadata from * \param[in] index Metadata index to get from metadata array * * \return Returns a const pointer to the selected metadata, if img and/or index * is invalid, it returns NULL. */ const aom_metadata_t *aom_img_get_metadata(const aom_image_t *img, size_t index); /*!\brief Return the number of metadata blocks within the image. * * Gets the number of metadata blocks contained within the provided image * metadata array. * * \param[in] img Pointer to image descriptor to get metadata number * from. * * \return Returns the size of the metadata array. If img or metadata is NULL, * it returns 0. */ size_t aom_img_num_metadata(const aom_image_t *img); /*!\brief Remove metadata from image. * * Removes all metadata in image metadata list and sets metadata list pointer * to NULL. * * \param[in] img Image descriptor */ void aom_img_remove_metadata(aom_image_t *img); /*!\brief Allocate memory for aom_metadata struct. * * Allocates storage for the metadata payload, sets its type and copies the * payload data into the aom_metadata struct. A metadata payload buffer of size * sz is allocated and sz bytes are copied from data into the payload buffer. * * \param[in] type Metadata type * \param[in] data Metadata data pointer * \param[in] sz Metadata size * \param[in] insert_flag Metadata insert flag * * \return Returns the newly allocated aom_metadata struct. If data is NULL, * sz is 0, or memory allocation fails, it returns NULL. */ aom_metadata_t *aom_img_metadata_alloc(uint32_t type, const uint8_t *data, size_t sz, aom_metadata_insert_flags_t insert_flag); /*!\brief Free metadata struct. * * Free metadata struct and its buffer. * * \param[in] metadata Metadata struct pointer */ void aom_img_metadata_free(aom_metadata_t *metadata); #ifdef __cplusplus } // extern "C" #endif #endif // AOM_AOM_AOM_IMAGE_H_
Codebase Browser
chromium