xref: /aosp_15_r20/external/libva/va/va_dec_jpeg.h (revision 54e60f844a168e9a219354de272cd517ee8cd4b7)
1 /*
2  * Copyright (c) 2007-2012 Intel Corporation. All Rights Reserved.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the
6  * "Software"), to deal in the Software without restriction, including
7  * without limitation the rights to use, copy, modify, merge, publish,
8  * distribute, sub license, and/or sell copies of the Software, and to
9  * permit persons to whom the Software is furnished to do so, subject to
10  * the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the
13  * next paragraph) shall be included in all copies or substantial portions
14  * of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
19  * IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE LIABLE FOR
20  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
25 /**
26  * \file va_dec_jpeg.h
27  * \brief The JPEG decoding API
28  *
29  * This file contains the \ref api_dec_jpeg "JPEG decoding API".
30  */
31 
32 #ifndef VA_DEC_JPEG_H
33 #define VA_DEC_JPEG_H
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 #include <va/va.h>
40 
41 /**
42  * \defgroup api_dec_jpeg JPEG decoding API
43  *
44  * This JPEG decoding API supports Baseline profile only.
45  *
46  * @{
47  */
48 
49 /**
50  * \brief Picture parameter for JPEG decoding.
51  *
52  * This structure holds information from the frame header, along with
53  * definitions from additional segments.
54  */
55 typedef struct _VAPictureParameterBufferJPEGBaseline {
56     /** \brief Picture width in pixels. */
57     uint16_t      picture_width;
58     /** \brief Picture height in pixels. */
59     uint16_t      picture_height;
60 
61     struct {
62         /** \brief Component identifier (Ci). */
63         uint8_t   component_id;
64         /** \brief Horizontal sampling factor (Hi). */
65         uint8_t   h_sampling_factor;
66         /** \brief Vertical sampling factor (Vi). */
67         uint8_t   v_sampling_factor;
68         /* \brief Quantization table selector (Tqi). */
69         uint8_t   quantiser_table_selector;
70     }                   components[255];
71     /** \brief Number of components in frame (Nf). */
72     uint8_t       num_components;
73 
74     /** \brief Input color space 0: YUV, 1: RGB, 2: BGR, others: reserved */
75     uint8_t       color_space;
76     /** \brief Set to VA_ROTATION_* for a single rotation angle reported by VAConfigAttribDecJPEG. */
77     uint32_t      rotation;
78     /** \brief crop rectangle boundary in pixels */
79     VARectangle   crop_rectangle;
80     /** \brief Reserved bytes for future use, must be zero */
81     uint32_t                va_reserved[VA_PADDING_MEDIUM - 3];
82 } VAPictureParameterBufferJPEGBaseline;
83 
84 /**
85  * \brief Quantization table for JPEG decoding.
86  *
87  * This structure holds the complete quantization tables. This is an
88  * aggregation of all quantization table (DQT) segments maintained by
89  * the application. i.e. up to 4 quantization tables are stored in
90  * there for baseline profile.
91  *
92  * The #load_quantization_table array can be used as a hint to notify
93  * the VA driver implementation about which table(s) actually changed
94  * since the last submission of this buffer.
95  *
96  * The #quantiser_table values are specified in zig-zag scan order.
97  */
98 typedef struct _VAIQMatrixBufferJPEGBaseline {
99     /** \brief Specifies which #quantiser_table is valid. */
100     uint8_t       load_quantiser_table[4];
101     /** \brief Quanziation tables indexed by table identifier (Tqi). */
102     uint8_t       quantiser_table[4][64];
103 
104     /** \brief Reserved bytes for future use, must be zero */
105     uint32_t                va_reserved[VA_PADDING_LOW];
106 } VAIQMatrixBufferJPEGBaseline;
107 
108 /**
109  * \brief Slice parameter for JPEG decoding.
110  *
111  * This structure holds information from the scan header, along with
112  * definitions from additional segments. The associated slice data
113  * buffer holds all entropy coded segments (ECS) in the scan.
114  */
115 typedef struct _VASliceParameterBufferJPEGBaseline {
116     /** @name Codec-independent Slice Parameter Buffer base. */
117     /**@{*/
118     /** \brief Number of bytes in the slice data buffer for this slice. */
119     uint32_t        slice_data_size;
120     /** \brief The offset to the first byte of the first MCU. */
121     uint32_t        slice_data_offset;
122     /** \brief Slice data buffer flags. See \c VA_SLICE_DATA_FLAG_xxx. */
123     uint32_t        slice_data_flag;
124     /**@}*/
125 
126     /** \brief Scan horizontal position. */
127     uint32_t        slice_horizontal_position;
128     /** \brief Scan vertical position. */
129     uint32_t        slice_vertical_position;
130 
131     struct {
132         /** \brief Scan component selector (Csj). */
133         uint8_t   component_selector;
134         /** \brief DC entropy coding table selector (Tdj). */
135         uint8_t   dc_table_selector;
136         /** \brief AC entropy coding table selector (Taj). */
137         uint8_t   ac_table_selector;
138     }                   components[4];
139     /** \brief Number of components in scan (Ns). */
140     uint8_t       num_components;
141 
142     /** \brief Restart interval definition (Ri). */
143     uint16_t      restart_interval;
144     /** \brief Number of MCUs in a scan. */
145     uint32_t        num_mcus;
146 
147     /** \brief Reserved bytes for future use, must be zero */
148     uint32_t                va_reserved[VA_PADDING_LOW];
149 } VASliceParameterBufferJPEGBaseline;
150 
151 /**@}*/
152 
153 #ifdef __cplusplus
154 }
155 #endif
156 
157 #endif /* VA_DEC_JPEG_H */
158