lvimgprocstatus.h

相机传输图像程序源代码 拜耳模式（RAW格式文件）与RGB图像数据互相转换函数库

#ifndef LvImgProcStatusH
#define LvImgProcStatusH

/** @defgroup StatusDefinitions Status definitions. */
//@{
  /** Invalid pointer. One of the pointers used by the function is NULL or invalid.
   */
  #define LVIP_STATUS_INVALID_POINTER                              100001
  /** Pointer to the source data image info or its data is invalid.
   */
  #define LVIP_STATUS_INVALID_SRC_POINTER                          100002
  /** Pointer to the destination data image info or its data is invalid.
   */
  #define LVIP_STATUS_INVALID_DST_POINTER                          100003
  /** The source or destination image info has invalid or unexpected pixel format or the dwPixelIncrement value
   * in the of @ref lvip_ImgInfo structure.
   * Another reason when this error code could be retrieved is when using the lvip_BmpInfoToImgInfo() function
   * with BITMAPINFOHEADER containing in its \a biBitCount member a different value than is supported.
   * Supported values in BITMAPINFOHEADER are:
   * @code
   *   8            LVIP_PIXEL_FORMAT_MONO8
   *   16           LVIP_PIXEL_FORMAT_RGB555_PACKED or LVIP_PIXEL_FORMAT_RGB565_PACKED
   *                (depends on biCompression member of the BITMAPINFOHEADER)
   *   24           LVIP_PIXEL_FORMAT_RGB8_PACKED
   *   32           LVIP_PIXEL_FORMAT_RGBA8_PACKED
   * @endcode
   */
  #define LVIP_STATUS_INVALID_PIXEL_FORMAT                         100004
  /** The lvip_ImgInfo parameter is not initialized.
   * The supplied @ref lvip_ImgInfo parameter has invalid contents. Either initialize it
   * with the lvip_InitImgInfo() function or setup in your code all the members to appropriate values.\n
   */
  #define LVIP_STATUS_IMAGEINFO_NOT_INITIALIZED                    100005
  /** Memory allocation failed.
   * This error code happens when the operating system does not allow to allocate any new memory to this library.\n
   * When this error happens, there is a critical insufficience of memory; it might indicate
   * a huge memory leak, typically caused by not deallocating used images when processing in a loop.
   * Another cause could be big image dimensions resulting in an attempt to allocate a huge memory amount.\n
   * Typically this error code could be retrieved from lvip_AllocateImageData() or lvip_SaveToTiff() functions.
   */  
  #define LVIP_STATUS_MEMORY_ALLOC_FAILED                          100006
  /** BMP header is unsupported.
   * Some members of BITMAPINFOHEADER (part of BITMAPINFO) have unexpected or unsupported values.
   * Check if the BITMAPINFO has correct data and that is correctly filled up.
   * Members \a biSize and \a biCompression have to be correctly filled up. The biCompression member has to be filled up with 
   * BI_RGB or BI_BITFIELDS values.
   */
  #define LVIP_STATUS_UNSUPPORTED_BMP_HEADER                       100007
  /** Source pixel format is incompatible to BITMAP pixel format possibilities.
   * BITMAP could be created only using one of these pixel formats:
   * @code
   *    LVIP_PIXEL_FORMAT_MONO8
   *    LVIP_PIXEL_FORMAT_RGB555_PACKED
   *    LVIP_PIXEL_FORMAT_RGB565_PACKED
   *    LVIP_PIXEL_FORMAT_RGB8_PACKED
   *    LVIP_PIXEL_FORMAT_RGBA8_PACKED
   * @endcode
   * If you have the image in other pixel format, you should convert the image by the
   * lvip_ConvertToPixelFormat() function.
   */
  #define LVIP_STATUS_BMP_INCOMPATIBLE_PIXEL_FORMAT                100008
  /** Color format has incompatible line increment to BMP possibilities.
   * The BMP has to have line increment aligned to 4 bytes.
   */
  #define LVIP_STATUS_BMP_INCOMPATIBLE_LINE_INCREMENT              100009
  #define LVIP_STATUS_IMAGEINFO_NOT_EQUAL                          100011  // currently unused
  /** The requested function or format is not supported.
   * If you are not sure which functionality is not supported, see Leutron Vision 
   * Log Messages Receiver application for details.
   */
  #define LVIP_STATUS_UNSUPPORTED                                  100012
  /** Unsupported pixel format of the source.
   * See documentation of the function which returns this error code for supported source pixel formats.
   */
  #define LVIP_STATUS_UNSUPPORTED_SRC_PIXEL_FORMAT                 100013
  /** Unsupported pixel format of the destination.
   * See documentation of function which returns this error code for supported destination pixel formats.
   */
  #define LVIP_STATUS_UNSUPPORTED_DST_PIXEL_FORMAT                 100014
  /** The @ref lvip_ImgInfo parameter has flag @ref LVIP_IMG_ATTR_COLOR_PLANES set and the called function doesn't support it.
   */
  #define LVIP_STATUS_UNSUPPORTED_COLOR_PLANES                     100015
  #define LVIP_STATUS_UNSUPPORTED_REVERSION                        100016
  /** Image line increment is too big.
   * This some functions support only limited line increment. 
   * This currently applies only to lvip_Deinterlace() function, which has a limit of 
   * 2048 * 32bit RGB image - it means that line increment could be more than 8192 bytes.
   */
  #define LVIP_STATUS_LINEINCREMENT_TOO_BIG                        100017 
  /** Destination image info is incompatible to expected output format.
   * You are trying to call a function and the supplied destination image info has
   * other than expected contents.\n
   * Possible reason is that you don'did not specify the @ref LVIP_IMG_REALLOCATE_DST flag, so
   * if the function has different output format than specified in the destination
   * image info, the image info could not be rellocated and this error happens.\n
   * Note that some functions may require different destination parameters than expected,
   * the size of the destination image in the lvip_CopyArea() function depends on
   * whether the desired rectangle lies fully in the image or not.
   */
  #define LVIP_STATUS_DST_IMG_INFO_INCOMPATIBLE                    100018
  #define LVIP_STATUS_INCOMPATIBLE_SRC_AND_DST                     100019  // currently unused
  /** Destination image info size is different from the source image info size.
   * It means that the function expects that the source and destination image info size is the same. Because it is not,
   * and the destination image info cannot be changed using the @ref LVIP_IMG_REALLOCATE_DST flag, this error happens.
   */
  #define LVIP_STATUS_INCOMPATIBLE_SRC_AND_DST_SIZE                100020
  /** Rotated destination image info size is different to the expected size.
   * It means that the function expects that the source width of image info has to be the same to the height of the destination
   * image info (and vice versa) - and it is not - and additionaly destination image info cannot be changed using
   * the @ref LVIP_IMG_REALLOCATE_DST flag.
   */
  #define LVIP_STATUS_INCOMPATIBLE_SRC_AND_DST_SIZE_ROTATED        100021
  /** The source and destination image info have different pixel format.
   * You are trying to call some function which expects that both of source and destination image info has the same pixel format.
   * But the destination image info has different pixel format set and it is not
   * permitted to change this (by the @ref LVIP_IMG_REALLOCATE_DST flag).
   */
  #define LVIP_STATUS_INCOMPATIBLE_SRC_AND_DST_PIXEL_FORMAT        100023
  /** Source and destination image info have incompatible flags.
   * Some functions need to have both of source and destination image info flags compatible.
   * This applies for example for the bitmap orientation (top-down vesrus bottom-up).
   */
  #define LVIP_STATUS_INCOMPATIBLE_SRC_AND_DST_FLAGS               100024
  /** The specified rectangle is outside of source image data.
   * It means that you are trying to copy an area which not exist in the source image.
   * To create a destination image, the rectangle must at least partially overlap the source image.
   */
  #define LVIP_STATUS_DST_RECT_OUTSIDE_SRC                         100025
  /** The source image info structure has no data.
   * The source image info has no image data - it means that the source image info does not point to any valid image data.\n
   * Use lvip_AllocateImageData() function to allocate the buffer for the image or point
   * the pData member(s) to a valid image.
   */
  #define LVIP_STATUS_SRC_IMAGEINFO_NO_DATA                        100026
  /** The destination image info structure has no data.
   * The destination image info has no image data - it means that the destination image info does not point to any valid image data
   * and it is not permitted to allocate the buffer automatically (the @ref LVIP_IMG_REALLOCATE_DST flag was not specified).
   */
  #define LVIP_STATUS_DST_IMAGEINFO_NO_DATA                        100027
  /** The image isn't in the displayable format.
   * If there is a need to display an image, there is a need to have this image in a displayable format
   * (in Windows one of the BMP pixel formats and the line increment alighed to 4 bytes).
   * The image does not have such format and the automatic conversion to a displayable format
   * was not enabled (using the third parameter of the lvip_DisplayImage() function and
   * optionally the @ref LVIP_IMG_REALLOCATE_DST flag).
   */
  #define LVIP_STATUS_NOT_DISPLAYABLE_FORMAT                       100028
  #define LVIP_STATUS_INVALID_LUT_HANDLE                           100029 // currently unused
  /** Invalid LUT type passed as a parameter of the function.
   * The LUT is in incompatible format which couldn't be used in this function.\n
   * General this happens when trying to use some bayer-decoding function and a non-bayer LUT is used
   * or the LUT has been created for the different pixel format.
   */
  #define LVIP_STATUS_INVALID_LUT_TYPE                             100030
  #define LVIP_STATUS_CANNOT_USE_BAYER_LUT                         100031 // currently unused
  /** The reference image is in incompatible pixel format.
   * When using the reference image info (in the lvip_ApplyShadingCorrection() function), it must be
   * in the same pixel format as the source image.
   */
  #define LVIP_STATUS_INCOMPATIBLE_REF_PIXEL_FORMAT                100032
  /** The reference image has incompatible flags.
   * When using the reference image info (in the lvip_ApplyShadingCorrection() function), it must have
   * compatible flags as the source image.
   * For example: @ref LVIP_IMG_ATTR_BOTTOM_UP and @ref LVIP_IMG_ATTR_COLOR_PLANES flags must be same.
   */
  #define LVIP_STATUS_INCOMPATIBLE_REF_FLAGS                       100033
  /** A system error occured when trying to open or read the file.
   * Possible reasons could be a wrong path and/or file name, the file currently locked or without rights to be opened/read
   * or the file does not exist yet.
   */
  #define LVIP_STATUS_CANNOT_OPEN_READ_FILE                        100034
  /** A system error occured when trying to create or write to the file.
   * Possible reasons could be an invalid path and/or file name, without rights to be created/written.
   */
  #define LVIP_STATUS_CANNOT_CREATE_WRITE_FILE                     100035
  /** The contents of the TIFF file is in the invalid or in the unsupported form.
   * You are probably trying to read a TIFF file, which was not created by this library (see the lvip_SaveToTiff() function)
   */
  #define LVIP_STATUS_TIFF_CONTENTS_INVALID                        100036
  /** The contents of the BMP file is in the invalid or in the unsupported form.
   * You are trying to read a BMP file which has different (or invalid) format than which is
   * supported by this library.
   */
  #define LVIP_STATUS_BMP_CONTENTS_INVALID                         100037
  #define LVIP_STATUS_IMAGEINFO_IN_USE                             100038 // currently unused
  
//@}
#endif