stm32f7xx_hal_jpeg.h

Go to the documentation of this file.

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __STM32F7xx_HAL_JPEG_H
#define __STM32F7xx_HAL_JPEG_H

#ifdef __cplusplus
 extern "C" {
#endif
#if defined (STM32F767xx) || defined (STM32F769xx) || defined (STM32F777xx) || defined (STM32F779xx)
/* Includes ------------------------------------------------------------------*/
#include "stm32f7xx_hal_def.h"

/* Exported types ------------------------------------------------------------*/
typedef struct
{
  uint8_t  ColorSpace;                
  uint8_t  ChromaSubsampling;         
  uint32_t ImageHeight;               
  uint32_t ImageWidth;                
  uint8_t  ImageQuality;               
}JPEG_ConfTypeDef;
typedef enum
{
  HAL_JPEG_STATE_RESET              = 0x00U,  
  HAL_JPEG_STATE_READY              = 0x01U,  
  HAL_JPEG_STATE_BUSY               = 0x02U,  
  HAL_JPEG_STATE_BUSY_ENCODING      = 0x03U,  
  HAL_JPEG_STATE_BUSY_DECODING      = 0x04U,  
  HAL_JPEG_STATE_TIMEOUT            = 0x05U,  
  HAL_JPEG_STATE_ERROR              = 0x06U   
}HAL_JPEG_STATETypeDef;

typedef struct
{
  JPEG_TypeDef             *Instance;        
  JPEG_ConfTypeDef         Conf;             
  uint8_t                  *pJpegInBuffPtr;  
  uint8_t                  *pJpegOutBuffPtr; 
  __IO uint32_t            JpegInCount;      
  __IO uint32_t            JpegOutCount;     
  uint32_t                 InDataLength;     
  uint32_t                 OutDataLength;    
  DMA_HandleTypeDef        *hdmain;          
  DMA_HandleTypeDef        *hdmaout;         
  uint8_t                  CustomQuanTable;  
  uint8_t                  *QuantTable0;     
  uint8_t                  *QuantTable1;     
  uint8_t                  *QuantTable2;     
  uint8_t                  *QuantTable3;     
  HAL_LockTypeDef          Lock;             
  __IO  HAL_JPEG_STATETypeDef State;         
  __IO  uint32_t           ErrorCode;        
  __IO uint32_t Context;                     
}JPEG_HandleTypeDef;

/* Exported constants --------------------------------------------------------*/

#define  HAL_JPEG_ERROR_NONE        ((uint32_t)0x00000000U)    
#define  HAL_JPEG_ERROR_HUFF_TABLE  ((uint32_t)0x00000001U)    
#define  HAL_JPEG_ERROR_QUANT_TABLE ((uint32_t)0x00000002U)    
#define  HAL_JPEG_ERROR_DMA         ((uint32_t)0x00000004U)    
#define  HAL_JPEG_ERROR_TIMEOUT     ((uint32_t)0x00000008U)    
#define JPEG_QUANT_TABLE_SIZE  ((uint32_t)64U)

#define JPEG_GRAYSCALE_COLORSPACE     ((uint32_t)0x00000000U)
#define JPEG_YCBCR_COLORSPACE         JPEG_CONFR1_COLORSPACE_0
#define JPEG_CMYK_COLORSPACE          JPEG_CONFR1_COLORSPACE


#define JPEG_444_SUBSAMPLING     ((uint32_t)0x00000000U)   
#define JPEG_420_SUBSAMPLING     ((uint32_t)0x00000001U)   
#define JPEG_422_SUBSAMPLING     ((uint32_t)0x00000002U)   
#define JPEG_IMAGE_QUALITY_MIN     ((uint32_t)1U)     
#define JPEG_IMAGE_QUALITY_MAX     ((uint32_t)100U)   
#define JPEG_IT_IFT     ((uint32_t)JPEG_CR_IFTIE)   
#define JPEG_IT_IFNF    ((uint32_t)JPEG_CR_IFNFIE)  
#define JPEG_IT_OFT     ((uint32_t)JPEG_CR_OFTIE)   
#define JPEG_IT_OFNE    ((uint32_t)JPEG_CR_OFTIE)   
#define JPEG_IT_EOC     ((uint32_t)JPEG_CR_EOCIE)   
#define JPEG_IT_HPD     ((uint32_t)JPEG_CR_HPDIE)   
#define JPEG_FLAG_IFTF     ((uint32_t)JPEG_SR_IFTF)   
#define JPEG_FLAG_IFNFF    ((uint32_t)JPEG_SR_IFNFF)  
#define JPEG_FLAG_OFTF     ((uint32_t)JPEG_SR_OFTF)   
#define JPEG_FLAG_OFNEF    ((uint32_t)JPEG_SR_OFNEF)  
#define JPEG_FLAG_EOCF     ((uint32_t)JPEG_SR_EOCF)   
#define JPEG_FLAG_HPDF     ((uint32_t)JPEG_SR_HPDF)   
#define JPEG_FLAG_COF      ((uint32_t)JPEG_SR_COF)    
#define JPEG_FLAG_ALL      ((uint32_t)0x000000FEU)     
#define JPEG_PAUSE_RESUME_INPUT          ((uint32_t)0x00000001U)     
#define JPEG_PAUSE_RESUME_OUTPUT         ((uint32_t)0x00000002U)     
#define JPEG_PAUSE_RESUME_INPUT_OUTPUT   ((uint32_t)0x00000003U)     
/* Exported macro ------------------------------------------------------------*/

#define __HAL_JPEG_RESET_HANDLE_STATE(__HANDLE__) ( (__HANDLE__)->State = HAL_JPEG_STATE_RESET)


#define __HAL_JPEG_ENABLE(__HANDLE__)  ((__HANDLE__)->Instance->CR |=  JPEG_CR_JCEN)

#define __HAL_JPEG_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &=  ~JPEG_CR_JCEN)


#define __HAL_JPEG_GET_FLAG(__HANDLE__,__FLAG__)  (((__HANDLE__)->Instance->SR & (__FLAG__)))

#define __HAL_JPEG_CLEAR_FLAG(__HANDLE__,__FLAG__)  (((__HANDLE__)->Instance->CFR |= ((__FLAG__) & (JPEG_FLAG_EOCF | JPEG_FLAG_HPDF))))


#define __HAL_JPEG_ENABLE_IT(__HANDLE__,__INTERRUPT__)  ((__HANDLE__)->Instance->CR |= (__INTERRUPT__) )

#define __HAL_JPEG_DISABLE_IT(__HANDLE__,__INTERRUPT__) MODIFY_REG((__HANDLE__)->Instance->CR, (__INTERRUPT__), 0)


#define __HAL_JPEG_GET_IT_SOURCE(__HANDLE__,__INTERRUPT__)     ((__HANDLE__)->Instance->CR & (__INTERRUPT__))

/* Exported functions --------------------------------------------------------*/
/* Initialization/de-initialization functions  ********************************/
HAL_StatusTypeDef HAL_JPEG_Init(JPEG_HandleTypeDef *hjpeg);
HAL_StatusTypeDef HAL_JPEG_DeInit(JPEG_HandleTypeDef *hjpeg);
void HAL_JPEG_MspInit(JPEG_HandleTypeDef *hjpeg);
void HAL_JPEG_MspDeInit(JPEG_HandleTypeDef *hjpeg);

/* Encoding/Decoding Configuration functions  ********************************/
HAL_StatusTypeDef HAL_JPEG_ConfigEncoding(JPEG_HandleTypeDef *hjpeg, JPEG_ConfTypeDef *pConf);
HAL_StatusTypeDef HAL_JPEG_GetInfo(JPEG_HandleTypeDef *hjpeg, JPEG_ConfTypeDef *pInfo);
HAL_StatusTypeDef HAL_JPEG_EnableHeaderParsing(JPEG_HandleTypeDef *hjpeg);
HAL_StatusTypeDef HAL_JPEG_DisableHeaderParsing(JPEG_HandleTypeDef *hjpeg);
HAL_StatusTypeDef HAL_JPEG_SetUserQuantTables(JPEG_HandleTypeDef *hjpeg, uint8_t *QTable0, uint8_t *QTable1, uint8_t *QTable2, uint8_t *QTable3);

/* JPEG processing functions  **************************************/
HAL_StatusTypeDef  HAL_JPEG_Encode(JPEG_HandleTypeDef *hjpeg, uint8_t *pDataInMCU, uint32_t InDataLength, uint8_t *pDataOut, uint32_t OutDataLength, uint32_t Timeout);
HAL_StatusTypeDef  HAL_JPEG_Decode(JPEG_HandleTypeDef *hjpeg ,uint8_t *pDataIn ,uint32_t InDataLength ,uint8_t *pDataOutMCU ,uint32_t OutDataLength, uint32_t Timeout);
HAL_StatusTypeDef  HAL_JPEG_Encode_IT(JPEG_HandleTypeDef *hjpeg, uint8_t *pDataInMCU, uint32_t InDataLength, uint8_t *pDataOut, uint32_t OutDataLength);
HAL_StatusTypeDef  HAL_JPEG_Decode_IT(JPEG_HandleTypeDef *hjpeg ,uint8_t *pDataIn ,uint32_t InDataLength ,uint8_t *pDataOutMCU ,uint32_t OutDataLength);
HAL_StatusTypeDef  HAL_JPEG_Encode_DMA(JPEG_HandleTypeDef *hjpeg, uint8_t *pDataInMCU, uint32_t InDataLength, uint8_t *pDataOut, uint32_t OutDataLength);
HAL_StatusTypeDef  HAL_JPEG_Decode_DMA(JPEG_HandleTypeDef *hjpeg ,uint8_t *pDataIn ,uint32_t InDataLength ,uint8_t *pDataOutMCU ,uint32_t OutDataLength);
HAL_StatusTypeDef  HAL_JPEG_Pause(JPEG_HandleTypeDef *hjpeg, uint32_t XferSelection);
HAL_StatusTypeDef  HAL_JPEG_Resume(JPEG_HandleTypeDef *hjpeg, uint32_t XferSelection);
void HAL_JPEG_ConfigInputBuffer(JPEG_HandleTypeDef *hjpeg, uint8_t *pNewInputBuffer, uint32_t InDataLength);
void HAL_JPEG_ConfigOutputBuffer(JPEG_HandleTypeDef *hjpeg, uint8_t *pNewOutputBuffer, uint32_t OutDataLength);
HAL_StatusTypeDef HAL_JPEG_Abort(JPEG_HandleTypeDef *hjpeg);

/* JPEG Decode/Encode callback functions  ********************************************************/
void HAL_JPEG_InfoReadyCallback(JPEG_HandleTypeDef *hjpeg,JPEG_ConfTypeDef *pInfo);
void HAL_JPEG_EncodeCpltCallback(JPEG_HandleTypeDef *hjpeg);
void HAL_JPEG_DecodeCpltCallback(JPEG_HandleTypeDef *hjpeg);
void HAL_JPEG_ErrorCallback(JPEG_HandleTypeDef *hjpeg);
void HAL_JPEG_GetDataCallback(JPEG_HandleTypeDef *hjpeg, uint32_t NbDecodedData);
void HAL_JPEG_DataReadyCallback (JPEG_HandleTypeDef *hjpeg, uint8_t *pDataOut, uint32_t OutDataLength);

/* JPEG IRQ handler management  ******************************************************/
void HAL_JPEG_IRQHandler(JPEG_HandleTypeDef *hjpeg);

/* Peripheral State and Error functions  ************************************************/
HAL_JPEG_STATETypeDef  HAL_JPEG_GetState(JPEG_HandleTypeDef *hjpeg);
uint32_t               HAL_JPEG_GetError(JPEG_HandleTypeDef *hjpeg);

/* Private types -------------------------------------------------------------*/
/* Private defines -----------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/* Private macros ------------------------------------------------------------*/
#define IS_JPEG_CHROMASUBSAMPLING(SUBSAMPLING) (((SUBSAMPLING) == JPEG_444_SUBSAMPLING) || \
                                                ((SUBSAMPLING) == JPEG_420_SUBSAMPLING) || \
                                                ((SUBSAMPLING) == JPEG_422_SUBSAMPLING))

#define IS_JPEG_IMAGE_QUALITY(NUMBER) (((NUMBER) >= JPEG_IMAGE_QUALITY_MIN) && ((NUMBER) <= JPEG_IMAGE_QUALITY_MAX))

#define IS_JPEG_COLORSPACE(COLORSPACE) (((COLORSPACE) == JPEG_GRAYSCALE_COLORSPACE) || \
                                        ((COLORSPACE) == JPEG_YCBCR_COLORSPACE)     || \
                                        ((COLORSPACE) == JPEG_CMYK_COLORSPACE))

#define IS_JPEG_PAUSE_RESUME_STATE(VALUE) (((VALUE) == JPEG_PAUSE_RESUME_INPUT) || \
                                           ((VALUE) == JPEG_PAUSE_RESUME_OUTPUT)|| \
                                           ((VALUE) == JPEG_PAUSE_RESUME_INPUT_OUTPUT))

/* Private functions prototypes ----------------------------------------------*/
/* Private functions ---------------------------------------------------------*/
#endif /* STM32F767xx ||  STM32F769xx ||  STM32F777xx ||  STM32F779xx */ 
#ifdef __cplusplus
}
#endif

#endif /* __STM32F7xx_HAL_JPEG_H */

/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/