MPLAB® Harmony Graphics Suite  GFX v3.13.0
Legato API Documentation
legato_imagedecoder_jpeg_common.h
1 // DOM-IGNORE-BEGIN
2 /*******************************************************************************
3 * Copyright (C) 2020 Microchip Technology Inc. and its subsidiaries.
4 *
5 * Subject to your compliance with these terms, you may use Microchip software
6 * and any derivatives exclusively with Microchip products. It is your
7 * responsibility to comply with third party license terms applicable to your
8 * use of third party software (including open source software) that may
9 * accompany Microchip software.
10 *
11 * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
12 * EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
13 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
14 * PARTICULAR PURPOSE.
15 *
16 * IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
17 * INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
18 * WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
19 * BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
20 * FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
21 * ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
22 * THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
23 *******************************************************************************/
24 // DOM-IGNORE-END
25 
26 /*******************************************************************************
27  Module for Microchip Graphics Library - Legato User Interface Library
28 
29  Company:
30  Microchip Technology Inc.
31 
32  File Name:
33  legato_imagedecoder_raw.h
34 
35  Summary:
36  Image decoder
37 
38  Description:
39  Internal library use only
40 *******************************************************************************/
41 
49 #ifndef LE_IMAGEDECODER_JPEG_COMMON_H
50 #define LE_IMAGEDECODER_JPEG_COMMON_H
51 
52 #include "gfx/legato/common/legato_common.h"
53 
54 #if LE_ENABLE_JPEG_DECODER == 1
55 
56 #include "gfx/legato/image/legato_image.h"
57 #include "gfx/legato/core/legato_stream.h"
58 
59 #define JPEG_SendError(x) pJpegDecoder->bError = x; return(x); /* Point to proper error handler routine */
60 
61 #define JPEG_SAMPLE_1x1 0
62 #define JPEG_SAMPLE_1x2 1
63 #define JPEG_SAMPLE_2x1 2
64 #define JPEG_SAMPLE_2x2 3
65 
66 #define MAX_CHANNELS 3 /* This supports only Grayscale and YCbCr images - DONT CHANGE THIS */
67 #define MAX_BLOCKS 6 /* To decode one logical block, we have to decode 1 to 6 blocks depending on channels and subsampling - DONT REDUCE THIS */
68 #define MAX_HUFF_TABLES 2 /* Each causes 2 tables -> One for AC and another for DC - DONT REDUCE THIS */
69 #define MAX_DATA_BUF_LEN 512 /* Increase if you have more data memory */
70 
71 #define EXIF_2_2_ORIENTATION_OFFSET 0x2E
72 
73 /* Error list */
74 enum Errors
75 {
76  IMAGE_FILE_NOT_AVAILABLE
77 };
78 
79 /* JPEG Markers list */
80 enum Markers
81 {
82  SOF0 = 0xC0,
83  DHT = 0xC4,
84  SOI = 0xD8,
85  EOI = 0xD9,
86  SOS = 0xDA,
87  DQT = 0xDB,
88  DRI = 0xDD,
89  APP0 = 0xE0,
90  APP1 = 0xE1, // EXIF
91  COM = 0xFE,
92  /* The below markers doesn't have parameters */
93  TEM = 0x01,
94  RST0 = 0xD0,
95  RST1 = 0xD1,
96  RST2 = 0xD2,
97  RST3 = 0xD3,
98  RST4 = 0xD4,
99  RST5 = 0xD5,
100  RST6 = 0xD6,
101  RST7 = 0xD7
102 };
103 
104 typedef struct _JPEGDECODER JPEGDECODER;
105 
106 typedef uint32_t (*JPEG_Read_FnPtr)(void*, uint32_t, uint32_t, JPEGDECODER*);
107 
108 typedef void (*JPEG_Blit_FnPtr)(JPEGDECODER* state,
109  lePixelBuffer* buffer,
110  int32_t src_x,
111  int32_t src_y,
112  int32_t src_width,
113  int32_t src_height,
114  int32_t dest_x,
115  int32_t dest_y,
116  uint32_t a);
117 
118 /*************************/
119 /**** DATA STRUCTURES ****/
120 /*************************/
121 typedef struct _JPEGDECODER
122 {
123  const leImage *pImageFile; /* Image file pointer */
124  lePixelBuffer pixelBlockBuffer; /* Pointer to the pixel buffer for the current block to blit */
125  JPEG_Read_FnPtr readPtr; /* function to read memory */
126  JPEG_Blit_FnPtr blitPtr; /* function to blit the decompressed data */
127 
128  leRect clipRect;
129  uint32_t globalAlpha;
130  lePixelBuffer* imageWriteBuffer;
131 
132 #if LE_STREAMING_ENABLED == 1
133  leStream stream;
134 #endif
135 
136  uint32_t fileIndex; /* pointer to current location in image */
137 
138 /*********** From APP0 ***********/
139  uint8_t blJFIF; /* JFIF marker found flag */
140  uint8_t bMajorRev; /* Should be 1 */
141  uint8_t bMinorRev; /* Should be 0-2 but is not a show stopper */
142  /*------- The x/y densities and thumbnail data are ignored --------*/
143 
144  /*********** From APP1 EXIF ***********/
145  uint8_t bOrientation;
146 
147  /*********** From SOF0 ***********/
148  uint8_t bDataBits; /* Data precision, can be 8(, 12 or 16) */
149  uint16_t wWidth; /* Width in pixels */
150  uint16_t wHeight; /* Height in pixels */
151  uint8_t bChannels; /* Number of channels e.g. YCbCr = 3 */
152  uint8_t abChannelType[MAX_CHANNELS];
153  uint8_t abChannelHSampFactor[MAX_CHANNELS];
154  uint8_t abChannelVSampFactor[MAX_CHANNELS];
155  uint8_t abChannelQuantTableMap[MAX_CHANNELS];
156 
157  /*********** From DQT ***********/
158  uint8_t blQuantUses16bits; /* If flag is set, it is an error as 16 bit is not supported */
159  uint16_t awQuantTable[MAX_CHANNELS][64]; /* Supports only 8 & 16 bit resolutions */
160 
161  /*********** From DRI ***********/
162  uint16_t wRestartInterval; /* The restart interval in blocks */
163 
164  /*********** From DHT ***********/
165  uint8_t bHuffTables;
166  uint8_t abHuffAcSymLen[MAX_HUFF_TABLES][16]; /* Supports only 8 bit resolution */
167  uint8_t abHuffAcSymbol[MAX_HUFF_TABLES][256]; /* Maximum possible symbols are 256 */
168  uint8_t abHuffDcSymLen[MAX_HUFF_TABLES][16]; /* Supports only 8 bit resolution */
169  uint8_t abHuffDcSymbol[MAX_HUFF_TABLES][16]; /* Maximum possible symbols are 16 for DC :-) */
170  /*********** For Huffman-Decoding ***********/
171  uint16_t awHuffAcSymStart[MAX_HUFF_TABLES][16]; /* Starting symbol for each length */
172  uint16_t awHuffDcSymStart[MAX_HUFF_TABLES][16]; /* Starting symbol for each length */
173 
174  /*********** From SOS ***********/
175  uint8_t abChannelHuffAcTableMap[MAX_CHANNELS];
176  uint8_t abChannelHuffDcTableMap[MAX_CHANNELS];
177 
178  uint8_t bError;
179 
180  /*********** Work memory ***********/
181  uint16_t wWorkBits;
182  uint8_t bBitsAvailable;
183  uint8_t bBlocksInOnePass;
184  short asOneBlock[MAX_BLOCKS][64]; /* Temporary storage for a 8x8 block */
185  uint16_t wBlockNumber;
186  uint8_t abChannelMap[MAX_BLOCKS];
187  uint8_t bSubSampleType;
188  short asPrevDcValue[MAX_CHANNELS];
189  uint8_t *pbCurrentHuffSymLenTable;
190  uint8_t *pbCurrentHuffSymbolTable;
191  uint16_t *pwCurrentHuffSymStartTable;
192  uint16_t *pwCurrentQuantTable;
193  uint8_t abDataBuffer[MAX_DATA_BUF_LEN];
194  uint16_t wBufferLen;
195  uint16_t wBufferIndex;
196  uint8_t bFirstBit;
197 
198  int32_t wStartX;
199  int32_t wStartY;
200 
201  int32_t wDrawWidth;
202  int32_t wDrawHeight;
203 
204  int32_t wDrawX;
205  int32_t wDrawY;
206 
207  int32_t wPrevX;
208  int32_t wPrevY;
209  uint8_t handle; //handle to the driver instance
210 } JPEGDECODER;
211 
212 /*******************************************************************************
213 Function: void JPEG_vResetDecoder(JPEGDECODER *pJpegDecoder)
214 
215 Precondition: None
216 
217 Overview: This function resets the variables so that new jpeg image can be
218  decoded
219 
220 Input: JPEGDECODER
221 
222 Output: None
223 *******************************************************************************/
224 void JPEG_vResetDecoder(JPEGDECODER *decoder);
225 
226 /*******************************************************************************
227 Function: uint8_t JPEG_bReadHeader(JPEGDECODER *pJpegDecoder)
228 
229 Precondition: None
230 
231 Overview: This function reads the JPEG file header and
232  fills the data structure
233 
234 Input: JPEGDECODER
235 
236 Output: Error code - '0' means no error
237 *******************************************************************************/
238 uint8_t JPEG_bReadHeader(JPEGDECODER *pJpegDecoder);
239 
240 /*******************************************************************************
241 Function: uint8_t JPEG_bGenerateHuffmanTables(JPEGDECODER *pJpegDecoder)
242 
243 Precondition: None
244 
245 Overview: This function generated the table required for Huffman decoding
246  from the data read from the header
247 
248 Input: JPEGDECODER
249 
250 Output: Error code - '0' means no error
251 *******************************************************************************/
252 uint8_t JPEG_bGenerateHuffmanTables(JPEGDECODER *pJpegDecoder);
253 
254 /*******************************************************************************
255 Function: void JPEG_vInitDisplay(JPEGDECODER *pJpegDecoder)
256 
257 Precondition: None
258 
259 Overview: Initializes the (x, y) co-ordinates to (0, 0)
260 
261 Input: JPEGDECODER
262 
263 Output: None
264 *******************************************************************************/
265 void JPEG_vInitDisplay(JPEGDECODER *pJpegDecoder);
266 
267 /*******************************************************************************
268 Function: uint8_t JPEG_bDecodeOneBlock(JPEGDECODER *pJpegDecoder)
269 
270 Precondition: File pointer must point to a new block of data
271 
272 Overview: Decodes the 8x8 pixel values of all the channels
273  (A multiple of 8x8 block if subsampling is used)
274 
275 Input: JPEGDECODER
276 
277 Output: Error code - '0' means no error
278 *******************************************************************************/
279 uint8_t JPEG_bDecodeOneBlock(JPEGDECODER *pJpegDecoder);
280 
281 /*******************************************************************************
282 Function: uint8_t JPEG_bPaintOneBlock(JPEGDECODER *pJpegDecoder)
283 
284 Precondition: One block - 8x8 pixel data of all channels must be decoded
285 
286 Overview: Displays one 8x8 on the screen
287  (A multiple of 8x8 block if subsampling is used)
288 
289 Input: JPEGDECODER
290 
291 Output: Error code - '0' means no error
292 *******************************************************************************/
293 uint8_t JPEG_bPaintOneBlock(JPEGDECODER *pJpegDecoder);
294 
295 
296 
297 /**************************/
298 /**** CONSTANT TABLES ****/
299 /**************************/
300 static const uint8_t abZigzag[64] =
301 {
302  0, 1, 8, 16, 9, 2, 3, 10,
303  17, 24, 32, 25, 18, 11, 4, 5,
304  12, 19, 26, 33, 40, 48, 41, 34,
305  27, 20, 13, 6, 7, 14, 21, 28,
306  35, 42, 49, 56, 57, 50, 43, 36,
307  29, 22, 15, 23, 30, 37, 44, 51,
308  58, 59, 52, 45, 38, 31, 39, 46,
309  53, 60, 61, 54, 47, 55, 62, 63
310 };
311 
312 #endif /* LE_ENABLE_JPEG_DECODER */
313 
314 #endif // LE_IMAGEDECODER_JPEG_COMMON_H
legato_common.h
Common macros and definitions used by Legato.
legato_image.h
Image functions and defintions.
leImage
Definition: legato_image.h:181
leRect
This struct represents a rectangle.
Definition: legato_common.h:394
lePixelBuffer
Definition: legato_pixelbuffer.h:90
legato_stream.h
Defines a common header for all stream operations.