2 * Copyright (c) 2007-2011 Intel Corporation. All Rights Reserved.
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:
12 * The above copyright notice and this permission notice (including the
13 * next paragraph) shall be included in all copies or substantial portions
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.
27 * \brief The H.264 encoding API
29 * This file contains the \ref api_enc_h264 "H.264 encoding API".
40 * \defgroup api_enc_h264 H.264 encoding API
48 * Those flags flags are meant to signal when a picture marks the end
49 * of a sequence, a stream, or even both at once.
54 * \brief Marks the last picture in the sequence.
56 * i.e. the driver appends \c end_of_seq() NAL unit to the encoded frame.
58 #define H264_LAST_PICTURE_EOSEQ 0x01
60 * \brief Marks the last picture in the stream.
62 * i.e. the driver appends \c end_of_stream() NAL unit to the encoded frame.
64 #define H264_LAST_PICTURE_EOSTREAM 0x02
68 * \brief Packed header types specific to H.264 encoding.
70 * Types of packed headers generally used for H.264 encoding. Each
71 * associated packed header data buffer shall contain the start code
72 * prefix 0x000001 followed by the complete NAL unit, thus also
73 * including the \c nal_unit_type.
75 * Note: the start code prefix can contain an arbitrary number of leading
76 * zeros. The driver will skip them for emulation prevention bytes insertion,
81 * \brief Packed Sequence Parameter Set (SPS).
83 * The corresponding packed header data buffer shall contain the
84 * complete seq_parameter_set_rbsp() syntax element.
86 * Note: packed \c nal_unit_type shall be equal to 7.
88 VAEncPackedHeaderH264_SPS = VAEncPackedHeaderSequence,
90 * \brief Packed Picture Parameter Set (PPS).
92 * The corresponding packed header data buffer shall contain the
93 * complete pic_parameter_set_rbsp() syntax element.
95 * Note: packed \c nal_unit_type shall be equal to 8.
97 VAEncPackedHeaderH264_PPS = VAEncPackedHeaderPicture,
99 * \brief Packed slice header.
101 * The corresponding packed header data buffer shall contain the
102 * \c slice_header() syntax element only, along with any start
103 * code prefix and NAL unit type preceeding it. i.e. this means
104 * that the buffer does not contain any of the \c slice_data() or
105 * the \c rbsp_slice_trailing_bits().
107 * Note: packed \c nal_unit_type shall be equal to 1 (non-IDR
108 * picture), or 5 (IDR picture).
110 VAEncPackedHeaderH264_Slice = VAEncPackedHeaderSlice,
112 * \brief Packed Supplemental Enhancement Information (SEI).
114 * The corresponding packed header data buffer shall contain the
115 * complete sei_rbsp() syntax element, thus including several
116 * sei_message() elements if necessary.
118 * Note: packed \c nal_unit_type shall be equal to 6.
120 VAEncPackedHeaderH264_SEI = (VAEncPackedHeaderMiscMask | 1),
121 } VAEncPackedHeaderTypeH264;
124 * \brief Sequence parameter for H.264 encoding in main & high profiles.
126 * This structure holds information for \c seq_parameter_set_data() as
127 * defined by the H.264 specification.
129 * If packed sequence headers mode is used, i.e. if the encoding
130 * pipeline was configured with the #VA_ENC_PACKED_HEADER_SEQUENCE
131 * flag, then the driver expects two more buffers to be provided to
132 * the same \c vaRenderPicture() as this buffer:
133 * - a #VAEncPackedHeaderParameterBuffer with type set to
134 * VAEncPackedHeaderType::VAEncPackedHeaderSequence ;
135 * - a #VAEncPackedHeaderDataBuffer which holds the actual packed
138 * If \c seq_scaling_matrix_present_flag is set to \c 1, then a
139 * #VAIQMatrixBufferH264 buffer shall also be provided within the same
140 * \c vaRenderPicture() call as this sequence parameter buffer.
142 typedef struct _VAEncSequenceParameterBufferH264 {
143 /** \brief Same as the H.264 bitstream syntax element. */
144 unsigned char seq_parameter_set_id;
145 /** \brief Same as the H.264 bitstream syntax element. */
146 unsigned char level_idc;
147 /** \brief Period between I frames. */
148 unsigned int intra_period;
149 /** \brief Period between IDR frames. */
150 unsigned int intra_idr_period;
151 /** \brief Period between I/P frames. */
152 unsigned int ip_period;
154 * \brief Initial bitrate set for this sequence in CBR or VBR modes.
156 * This field represents the initial bitrate value for this
157 * sequence if CBR or VBR mode is used, i.e. if the encoder
158 * pipeline was created with a #VAConfigAttribRateControl
159 * attribute set to either \ref VA_RC_CBR or \ref VA_RC_VBR.
161 * The bitrate can be modified later on through
162 * #VAEncMiscParameterRateControl buffers.
164 unsigned int bits_per_second;
165 /** \brief Same as the H.264 bitstream syntax element. */
166 unsigned int max_num_ref_frames;
167 /** \brief Picture width in macroblocks. */
168 unsigned short picture_width_in_mbs;
169 /** \brief Picture height in macroblocks. */
170 unsigned short picture_height_in_mbs;
174 /** \brief Same as the H.264 bitstream syntax element. */
175 unsigned int chroma_format_idc : 2;
176 /** \brief Same as the H.264 bitstream syntax element. */
177 unsigned int frame_mbs_only_flag : 1;
178 /** \brief Same as the H.264 bitstream syntax element. */
179 unsigned int mb_adaptive_frame_field_flag : 1;
180 /** \brief Same as the H.264 bitstream syntax element. */
181 unsigned int seq_scaling_matrix_present_flag : 1;
182 /** \brief Same as the H.264 bitstream syntax element. */
183 unsigned int direct_8x8_inference_flag : 1;
184 /** \brief Same as the H.264 bitstream syntax element. */
185 unsigned int log2_max_frame_num_minus4 : 4;
186 /** \brief Same as the H.264 bitstream syntax element. */
187 unsigned int pic_order_cnt_type : 2;
188 /** \brief Same as the H.264 bitstream syntax element. */
189 unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
190 /** \brief Same as the H.264 bitstream syntax element. */
191 unsigned int delta_pic_order_always_zero_flag : 1;
196 /** \brief Same as the H.264 bitstream syntax element. */
197 unsigned char bit_depth_luma_minus8;
198 /** \brief Same as the H.264 bitstream syntax element. */
199 unsigned char bit_depth_chroma_minus8;
201 /** if pic_order_cnt_type == 1 */
203 /** \brief Same as the H.264 bitstream syntax element. */
204 unsigned char num_ref_frames_in_pic_order_cnt_cycle;
205 /** \brief Same as the H.264 bitstream syntax element. */
206 int offset_for_non_ref_pic;
207 /** \brief Same as the H.264 bitstream syntax element. */
208 int offset_for_top_to_bottom_field;
209 /** \brief Same as the H.264 bitstream syntax element. */
210 int offset_for_ref_frame[256];
213 /** @name Cropping (optional) */
215 /** \brief Same as the H.264 bitstream syntax element. */
216 unsigned char frame_cropping_flag;
217 /** \brief Same as the H.264 bitstream syntax element. */
218 unsigned int frame_crop_left_offset;
219 /** \brief Same as the H.264 bitstream syntax element. */
220 unsigned int frame_crop_right_offset;
221 /** \brief Same as the H.264 bitstream syntax element. */
222 unsigned int frame_crop_top_offset;
223 /** \brief Same as the H.264 bitstream syntax element. */
224 unsigned int frame_crop_bottom_offset;
227 /** @name VUI parameters (optional) */
229 /** \brief Same as the H.264 bitstream syntax element. */
230 unsigned char vui_parameters_present_flag;
233 /** \brief Same as the H.264 bitstream syntax element. */
234 unsigned int timing_info_present_flag : 1;
235 /** \brief Same as the H.264 bitstream syntax element. */
236 unsigned int bitstream_restriction_flag : 1;
237 /** \brief Range: 0 to 16, inclusive. */
238 unsigned int log2_max_mv_length_horizontal : 5;
239 /** \brief Range: 0 to 16, inclusive. */
240 unsigned int log2_max_mv_length_vertical : 5;
244 /** \brief Same as the H.264 bitstream syntax element. */
245 unsigned int num_units_in_tick;
246 /** \brief Same as the H.264 bitstream syntax element. */
247 unsigned int time_scale;
249 } VAEncSequenceParameterBufferH264;
252 * \brief Picture parameter for H.264 encoding in main & high profiles.
254 * This structure holds information for \c pic_parameter_set_rbsp() as
255 * defined by the H.264 specification.
257 * If packed picture headers mode is used, i.e. if the encoding
258 * pipeline was configured with the #VA_ENC_PACKED_HEADER_PICTURE
259 * flag, then the driver expects two more buffers to be provided to
260 * the same \c vaRenderPicture() as this buffer:
261 * - a #VAEncPackedHeaderParameterBuffer with type set to
262 * VAEncPackedHeaderType::VAEncPackedHeaderPicture ;
263 * - a #VAEncPackedHeaderDataBuffer which holds the actual packed
266 * If \c pic_scaling_matrix_present_flag is set to \c 1, then a
267 * #VAIQMatrixBufferH264 buffer shall also be provided within the same
268 * \c vaRenderPicture() call as this picture parameter buffer.
270 typedef struct _VAEncPictureParameterBufferH264 {
272 * \brief Information about the picture to be encoded.
274 * See #VAPictureH264 for further description of each field.
275 * Note that CurrPic.picture_id represents the reconstructed
276 * (decoded) picture. User provides a scratch VA surface ID here.
278 VAPictureH264 CurrPic;
280 * \brief Decoded Picture Buffer (DPB).
282 * This array represents the list of reconstructed (decoded)
283 * frames used as reference. It is important to keep track of
284 * reconstructed frames so that they can be used later on as
285 * reference for P or B-frames encoding.
287 VAPictureH264 ReferenceFrames[16];
289 * \brief Output encoded bitstream.
291 * \ref coded_buf has type #VAEncCodedBufferType. It should be
292 * large enough to hold the compressed NAL slice and possibly SPS
295 VABufferID coded_buf;
297 /** \brief The picture parameter set referred to in the slice header. */
298 unsigned char pic_parameter_set_id;
299 /** \brief The active sequence parameter set. Range: 0 to 31, inclusive. */
300 unsigned char seq_parameter_set_id;
303 * \brief OR'd flags describing whether the picture is the last one or not.
305 * This fields holds 0 if the picture to be encoded is not the last
306 * one in the stream or sequence. Otherwise, it is a combination of
307 * \ref H264_LAST_PICTURE_EOSEQ or \ref H264_LAST_PICTURE_EOSTREAM.
309 unsigned char last_picture;
311 /** \brief The picture identifier.
312 * Range: 0 to \f$2^{log2\_max\_frame\_num\_minus4 + 4} - 1\f$, inclusive.
314 unsigned short frame_num;
316 /** \brief \c pic_init_qp_minus26 + 26. */
317 unsigned char pic_init_qp;
318 /** \brief Maximum reference index for reference picture list 0.
319 * Range: 0 to 31, inclusive.
321 unsigned char num_ref_idx_l0_active_minus1;
322 /** \brief Maximum reference index for reference picture list 1.
323 * Range: 0 to 31, inclusive.
325 unsigned char num_ref_idx_l1_active_minus1;
327 /** \brief Range: -12 to 12, inclusive. */
328 signed char chroma_qp_index_offset;
329 /** \brief Range: -12 to 12, inclusive. */
330 signed char second_chroma_qp_index_offset;
334 /** \brief Is picture an IDR picture? */
335 unsigned int idr_pic_flag : 1;
336 /** \brief Is picture a reference picture? */
337 unsigned int reference_pic_flag : 2;
338 /** \brief Selects CAVLC (0) or CABAC (1) entropy coding mode. */
339 unsigned int entropy_coding_mode_flag : 1;
340 /** \brief Is weighted prediction applied to P slices? */
341 unsigned int weighted_pred_flag : 1;
342 /** \brief Range: 0 to 2, inclusive. */
343 unsigned int weighted_bipred_idc : 2;
344 /** \brief Same as the H.264 bitstream syntax element. */
345 unsigned int constrained_intra_pred_flag : 1;
346 /** \brief Same as the H.264 bitstream syntax element. */
347 unsigned int transform_8x8_mode_flag : 1;
348 /** \brief Same as the H.264 bitstream syntax element. */
349 unsigned int deblocking_filter_control_present_flag : 1;
350 /** \brief Same as the H.264 bitstream syntax element. */
351 unsigned int redundant_pic_cnt_present_flag : 1;
352 /** \brief Same as the H.264 bitstream syntax element. */
353 unsigned int pic_order_present_flag : 1;
354 /** \brief Same as the H.264 bitstream syntax element. */
355 unsigned int pic_scaling_matrix_present_flag : 1;
359 } VAEncPictureParameterBufferH264;
362 * \brief Slice parameter for H.264 encoding in main & high profiles.
364 * This structure holds information for \c
365 * slice_layer_without_partitioning_rbsp() as defined by the H.264
368 * If packed slice headers mode is used, i.e. if the encoding
369 * pipeline was configured with the #VA_ENC_PACKED_HEADER_SLICE
370 * flag, then the driver expects two more buffers to be provided to
371 * the same \c vaRenderPicture() as this buffer:
372 * - a #VAEncPackedHeaderParameterBuffer with type set to
373 * VAEncPackedHeaderType::VAEncPackedHeaderSlice ;
374 * - a #VAEncPackedHeaderDataBuffer which holds the actual packed
377 * If per-macroblock encoder configuration is needed, \c macroblock_info
378 * references a buffer of type #VAEncMacroblockParameterBufferH264. This
379 * buffer is not passed to vaRenderPicture(). i.e. it is not destroyed
380 * by subsequent calls to vaRenderPicture() and then can be re-used
381 * without re-allocating the whole buffer.
383 typedef struct _VAEncSliceParameterBufferH264 {
384 /** \brief Starting MB address for this slice. */
385 unsigned int macroblock_address;
386 /** \brief Number of macroblocks in this slice. */
387 unsigned int num_macroblocks;
389 * \brief Per-MB encoder configuration buffer, or \c VA_INVALID_ID.
391 * If per-MB encoder configuration is needed, then \ref macroblock_info
392 * references a buffer of type #VAEncMacroblockParameterBufferH264
393 * (\c VAEncMacroblockParameterBufferType). Otherwise, buffer id
394 * is set to \c VA_INVALID_ID and per-MB configuration is derived
395 * from this slice parameter.
397 * The \c macroblock_info buffer must hold \ref num_macroblocks
400 VABufferID macroblock_info;
401 /** \brief Slice type.
402 * Range: 0..2, 5..7, i.e. no switching slices.
404 unsigned char slice_type;
405 /** \brief Same as the H.264 bitstream syntax element. */
406 unsigned char pic_parameter_set_id;
407 /** \brief Same as the H.264 bitstream syntax element. */
408 unsigned short idr_pic_id;
410 /** @name If pic_order_cnt_type == 0 */
412 /** \brief The picture order count modulo MaxPicOrderCntLsb. */
413 unsigned short pic_order_cnt_lsb;
414 /** \brief Valid if \c pic_order_present_flag and this is a bottom field. */
415 int delta_pic_order_cnt_bottom;
417 /** @name If pic_order_cnt_type == 1 && !delta_pic_order_always_zero_flag */
419 /** \brief [0]: top, [1]: bottom. */
420 int delta_pic_order_cnt[2];
423 /** @name If slice_type == B */
425 unsigned char direct_spatial_mv_pred_flag;
428 /** @name If slice_type == P */
430 /** \brief Specifies if
431 * \ref _VAEncPictureParameterBufferH264::num_ref_idx_l0_active_minus1 or
432 * \ref _VAEncPictureParameterBufferH264::num_ref_idx_l1_active_minus1 are
433 * overriden by the values for this slice.
435 unsigned char num_ref_idx_active_override_flag;
436 /** \brief Maximum reference index for reference picture list 0.
437 * Range: 0 to 31, inclusive.
439 unsigned char num_ref_idx_l0_active_minus1;
440 /** \brief Maximum reference index for reference picture list 1.
441 * Range: 0 to 31, inclusive.
443 unsigned char num_ref_idx_l1_active_minus1;
444 /** \brief Reference picture list 0 (for P slices). */
445 VAPictureH264 RefPicList0[32];
446 /** \brief Reference picture list 1 (for B slices). */
447 VAPictureH264 RefPicList1[32];
450 /** @name pred_weight_table() */
452 /** \brief Same as the H.264 bitstream syntax element. */
453 unsigned char luma_log2_weight_denom;
454 /** \brief Same as the H.264 bitstream syntax element. */
455 unsigned char chroma_log2_weight_denom;
456 /** \brief Same as the H.264 bitstream syntax element. */
457 unsigned char luma_weight_l0_flag;
458 /** \brief Same as the H.264 bitstream syntax element. */
459 signed short luma_weight_l0[32];
460 /** \brief Same as the H.264 bitstream syntax element. */
461 signed short luma_offset_l0[32];
462 /** \brief Same as the H.264 bitstream syntax element. */
463 unsigned char chroma_weight_l0_flag;
464 /** \brief Same as the H.264 bitstream syntax element. */
465 signed short chroma_weight_l0[32][2];
466 /** \brief Same as the H.264 bitstream syntax element. */
467 signed short chroma_offset_l0[32][2];
468 /** \brief Same as the H.264 bitstream syntax element. */
469 unsigned char luma_weight_l1_flag;
470 /** \brief Same as the H.264 bitstream syntax element. */
471 signed short luma_weight_l1[32];
472 /** \brief Same as the H.264 bitstream syntax element. */
473 signed short luma_offset_l1[32];
474 /** \brief Same as the H.264 bitstream syntax element. */
475 unsigned char chroma_weight_l1_flag;
476 /** \brief Same as the H.264 bitstream syntax element. */
477 signed short chroma_weight_l1[32][2];
478 /** \brief Same as the H.264 bitstream syntax element. */
479 signed short chroma_offset_l1[32][2];
482 /** \brief Range: 0 to 2, inclusive. */
483 unsigned char cabac_init_idc;
484 /** \brief Same as the H.264 bitstream syntax element. */
485 signed char slice_qp_delta;
486 /** @name If deblocking_filter_control_present_flag */
488 /** \brief Range: 0 to 2, inclusive. */
489 unsigned char disable_deblocking_filter_idc;
490 /** \brief Same as the H.264 bitstream syntax element. */
491 signed char slice_alpha_c0_offset_div2;
492 /** \brief Same as the H.264 bitstream syntax element. */
493 signed char slice_beta_offset_div2;
495 } VAEncSliceParameterBufferH264;
498 * @name Macroblock neighbour availability bits
500 * \anchor api_enc_h264_mb_pred_avail_bits
501 * Definitions for macroblock neighbour availability bits used in
502 * intra prediction mode (non MBAFF only).
506 /** \brief References macroblock in the top-left corner. */
507 #define VA_MB_PRED_AVAIL_TOP_LEFT (1 << 2)
508 /** \brief References macroblock above the current macroblock. */
509 #define VA_MB_PRED_AVAIL_TOP (1 << 4)
510 /** \brief References macroblock in the top-right corner. */
511 #define VA_MB_PRED_AVAIL_TOP_RIGHT (1 << 3)
512 /** \brief References macroblock on the left of the current macroblock. */
513 #define VA_MB_PRED_AVAIL_LEFT (1 << 6)
517 * \brief Macroblock parameter for H.264 encoding in main & high profiles.
519 * This structure holds per-macroblock information. The buffer must be
520 * allocated with as many elements (macroblocks) as necessary to fit
521 * the slice to be encoded. Besides, the per-macroblock records must
522 * be written in a strict raster order and with no gap. i.e. every
523 * macroblock, regardless of its type, shall have an entry.
525 typedef struct _VAEncMacroblockParameterBufferH264 {
527 * \brief Quantization parameter.
529 * Requested quantization parameter. Range: 0 to 51, inclusive.
530 * If \ref qp is set to 0xff, then the actual value is derived
531 * from the slice-level value: \c pic_init_qp + \c slice_qp_delta.
536 /** @name Data for intra macroblock */
541 * \brief Flag specified to override MB neighbour
542 * availability bits from VME stage.
544 * This flag specifies that macroblock neighbour
545 * availability bits from the VME stage are overriden
546 * by the \ref pred_avail_flags hereunder.
548 unsigned int pred_avail_override_flag : 1;
550 * \brief Bitwise representation of which macroblocks
551 * are available for intra prediction.
553 * If the slice is intra-coded, this field represents
554 * the macroblocks available for intra prediction.
555 * See \ref api_enc_h264_mb_pred_avail_bits
556 * "macroblock neighbour availability" bit definitions.
558 unsigned int pred_avail_flags : 8;
564 /** @name Data for inter macroblock */
573 } VAEncMacroblockParameterBufferH264;
581 #endif /* VA_ENC_H264_H */