TIOVX User Guide
tivx_ext_raw_image.h File Reference

The TI Raw Image extension. More...

#include <VX/vx.h>

Go to the source code of this file.

Data Structures

struct  tivx_raw_image_format_t
 The raw image format structure that is given to the tivxCreateRawImage function. More...
 
struct  tivx_raw_image_create_params_t
 The raw image create params structure that is given to the tivxCreateRawImage function. More...
 

Macros

#define TIVX_TYPE_RAW_IMAGE   0x817
 The object type enumeration for raw images. More...
 
#define TIVX_ENUM_RAW_IMAGE_BUFFER_ACCESS   (vx_enum)0x0
 The enum type enumeration for raw images. More...
 
#define TIVX_ENUM_RAW_IMAGE_PIXEL_CONTAINER   (vx_enum)0x1
 A tivx_raw_image_pixel_container_e.
 
#define TIVX_RAW_IMAGE_MAX_EXPOSURES   3
 Maximum number of RAW image exposures that can be contained in a raw image object.
 

Typedefs

typedef struct _tivx_raw_image * tivx_raw_image
 The Raw Image Object. Raw Image is a strongly-typed container for RAW sensor images.
 

Enumerations

enum  tivx_raw_image_attribute_e {
  TIVX_RAW_IMAGE_WIDTH = VX_ATTRIBUTE_BASE(VX_ID_TI, TIVX_TYPE_RAW_IMAGE) + 0x0,
  TIVX_RAW_IMAGE_HEIGHT = VX_ATTRIBUTE_BASE(VX_ID_TI, TIVX_TYPE_RAW_IMAGE) + 0x1,
  TIVX_RAW_IMAGE_NUM_EXPOSURES = VX_ATTRIBUTE_BASE(VX_ID_TI, TIVX_TYPE_RAW_IMAGE) + 0x2,
  TIVX_RAW_IMAGE_LINE_INTERLEAVED = VX_ATTRIBUTE_BASE(VX_ID_TI, TIVX_TYPE_RAW_IMAGE) + 0x3,
  TIVX_RAW_IMAGE_FORMAT = VX_ATTRIBUTE_BASE(VX_ID_TI, TIVX_TYPE_RAW_IMAGE) + 0x4,
  TIVX_RAW_IMAGE_META_HEIGHT_BEFORE = VX_ATTRIBUTE_BASE(VX_ID_TI, TIVX_TYPE_RAW_IMAGE) + 0x5,
  TIVX_RAW_IMAGE_META_HEIGHT_AFTER = VX_ATTRIBUTE_BASE(VX_ID_TI, TIVX_TYPE_RAW_IMAGE) + 0x6,
  TIVX_RAW_IMAGE_IMAGEPATCH_ADDRESSING = VX_ATTRIBUTE_BASE(VX_ID_TI, TIVX_TYPE_RAW_IMAGE) + 0x7
}
 The raw image attributes. More...
 
enum  tivx_raw_image_buffer_access_e {
  TIVX_RAW_IMAGE_ALLOC_BUFFER = VX_ENUM_BASE(VX_ID_TI, TIVX_ENUM_RAW_IMAGE_BUFFER_ACCESS) + 0x0,
  TIVX_RAW_IMAGE_PIXEL_BUFFER = VX_ENUM_BASE(VX_ID_TI, TIVX_ENUM_RAW_IMAGE_BUFFER_ACCESS) + 0x1,
  TIVX_RAW_IMAGE_META_BEFORE_BUFFER = VX_ENUM_BASE(VX_ID_TI, TIVX_ENUM_RAW_IMAGE_BUFFER_ACCESS) + 0x2,
  TIVX_RAW_IMAGE_META_AFTER_BUFFER = VX_ENUM_BASE(VX_ID_TI, TIVX_ENUM_RAW_IMAGE_BUFFER_ACCESS) + 0x3
}
 The raw image buffer access enum. More...
 
enum  tivx_raw_image_pixel_container_e {
  TIVX_RAW_IMAGE_16_BIT = VX_ENUM_BASE(VX_ID_TI, TIVX_ENUM_RAW_IMAGE_PIXEL_CONTAINER) + 0x0,
  TIVX_RAW_IMAGE_8_BIT = VX_ENUM_BASE(VX_ID_TI, TIVX_ENUM_RAW_IMAGE_PIXEL_CONTAINER) + 0x1,
  TIVX_RAW_IMAGE_P12_BIT = VX_ENUM_BASE(VX_ID_TI, TIVX_ENUM_RAW_IMAGE_PIXEL_CONTAINER) + 0x2
}
 The raw image pixel container enum. More...
 

Functions

VX_API_ENTRY tivx_raw_image VX_API_CALL tivxCreateRawImage (vx_context context, tivx_raw_image_create_params_t *params)
 Creates an opaque reference to a raw sensor image (including multi-exposure and metadata). More...
 
VX_API_ENTRY vx_status VX_API_CALL tivxReleaseRawImage (tivx_raw_image *raw_image)
 Releases a reference of a raw image. The object may not be garbage collected until its total reference count is zero. After returning from this function the reference is zeroed. More...
 
VX_API_ENTRY vx_status VX_API_CALL tivxQueryRawImage (tivx_raw_image raw_image, vx_enum attribute, volatile void *ptr, vx_size size)
 Queries the raw image for some specific information. More...
 
VX_API_ENTRY vx_status VX_API_CALL tivxCopyRawImagePatch (tivx_raw_image raw_image, const vx_rectangle_t *rect, vx_uint32 exposure_index, const vx_imagepatch_addressing_t *user_addr, void *user_ptr, vx_enum usage, vx_enum mem_type, vx_enum buffer_select)
 Allows the application to copy a rectangular patch from/into a raw image object exposure. More...
 
VX_API_ENTRY vx_status VX_API_CALL tivxMapRawImagePatch (tivx_raw_image raw_image, const vx_rectangle_t *rect, vx_uint32 exposure_index, vx_map_id *map_id, vx_imagepatch_addressing_t *addr, void **user_ptr, vx_enum usage, vx_enum mem_type, vx_enum buffer_select)
 Allows the application to get direct access to a rectangular patch of a raw image object exposure. More...
 
VX_API_ENTRY vx_status VX_API_CALL tivxUnmapRawImagePatch (tivx_raw_image raw_image, vx_map_id map_id)
 Unmap and commit potential changes to a raw image object patch that were previously mapped. More...
 

Detailed Description

The TI Raw Image extension.

Definition in file tivx_ext_raw_image.h.