va/va_enc_h264.h

   1 /*
   2  * Copyright (c) 2007-2011 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_enc_h264.h
  27  * \brief The H.264 encoding API
  28  *
  29  * This file contains the \ref api_enc_h264 "H.264 encoding API".
  30  */
  31
  32 #ifndef VA_ENC_H264_H
  33 #define VA_ENC_H264_H
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 #include <va/va_enc.h>
  40
  41 /**
  42  * \defgroup api_enc_h264 H.264 encoding API
  43  *
  44  * @{
  45  */
  46
  47 /**
  48  * @name Picture flags
  49  *
  50  * Those flags flags are meant to signal when a picture marks the end
  51  * of a sequence, a stream, or even both at once.
  52  *
  53  * @{
  54  */
  55 /**
  56  * \brief Marks the last picture in the sequence.
  57  *
  58  * i.e. the driver appends \c end_of_seq() NAL unit to the encoded frame.
  59  */
  60 #define H264_LAST_PICTURE_EOSEQ     0x01
  61 /**
  62  * \brief Marks the last picture in the stream.
  63  *
  64  * i.e. the driver appends \c end_of_stream() NAL unit to the encoded frame.
  65  */
  66 #define H264_LAST_PICTURE_EOSTREAM  0x02
  67 /**@}*/
  68
  69 /**
  70  * \brief Packed header types specific to H.264 encoding.
  71  *
  72  * Types of packed headers generally used for H.264 encoding. Each
  73  * associated packed header data buffer shall contain the start code
  74  * prefix 0x000001 followed by the complete NAL unit, thus also
  75  * including the \c nal_unit_type.
  76  *
  77  * Note: the start code prefix can contain an arbitrary number of leading
  78  * zeros. The driver will skip them for emulation prevention bytes insertion,
  79  * if necessary.
  80  */
  81 typedef enum {
  82     /**
  83      * \brief Packed Sequence Parameter Set (SPS).
  84      *
  85      * The corresponding packed header data buffer shall contain the
  86      * complete seq_parameter_set_rbsp() syntax element.
  87      *
  88      * Note: packed \c nal_unit_type shall be equal to 7.
  89      */
  90     VAEncPackedHeaderH264_SPS   = VAEncPackedHeaderSequence,
  91     /**
  92      * \brief Packed Picture Parameter Set (PPS).
  93      *
  94      * The corresponding packed header data buffer shall contain the
  95      * complete pic_parameter_set_rbsp() syntax element.
  96      *
  97      * Note: packed \c nal_unit_type shall be equal to 8.
  98      */
  99     VAEncPackedHeaderH264_PPS   = VAEncPackedHeaderPicture,
 100     /**
 101      * \brief Packed slice header.
 102      *
 103      * The corresponding packed header data buffer shall contain the
 104      * \c slice_header() syntax element only, along with any start
 105      * code prefix and NAL unit type preceeding it. i.e. this means
 106      * that the buffer does not contain any of the \c slice_data() or
 107      * the \c rbsp_slice_trailing_bits().
 108      *
 109      * Note: packed \c nal_unit_type shall be equal to 1 (non-IDR
 110      * picture), or 5 (IDR picture).
 111      */
 112     VAEncPackedHeaderH264_Slice = VAEncPackedHeaderSlice,
 113     /**
 114      * \brief Packed Supplemental Enhancement Information (SEI).
 115      *
 116      * The corresponding packed header data buffer shall contain the
 117      * complete sei_rbsp() syntax element, thus including several
 118      * sei_message() elements if necessary.
 119      *
 120      * Note: packed \c nal_unit_type shall be equal to 6.
 121      */
 122     VAEncPackedHeaderH264_SEI   = (VAEncPackedHeaderMiscMask | 1),
 123 } VAEncPackedHeaderTypeH264;
 124
 125 /**
 126  * \brief Sequence parameter for H.264 encoding in main & high profiles.
 127  *
 128  * This structure holds information for \c seq_parameter_set_data() as
 129  * defined by the H.264 specification.
 130  *
 131  * If packed sequence headers mode is used, i.e. if the encoding
 132  * pipeline was configured with the #VA_ENC_PACKED_HEADER_SEQUENCE
 133  * flag, then the driver expects two more buffers to be provided to
 134  * the same \c vaRenderPicture() as this buffer:
 135  * - a #VAEncPackedHeaderParameterBuffer with type set to
 136  *   VAEncPackedHeaderType::VAEncPackedHeaderSequence ;
 137  * - a #VAEncPackedHeaderDataBuffer which holds the actual packed
 138  *   header data.
 139  *
 140  * If \c seq_scaling_matrix_present_flag is set to \c 1, then a
 141  * #VAIQMatrixBufferH264 buffer shall also be provided within the same
 142  * \c vaRenderPicture() call as this sequence parameter buffer.
 143  */
 144 typedef struct _VAEncSequenceParameterBufferH264 {
 145     /** \brief Same as the H.264 bitstream syntax element. */
 146     unsigned char   seq_parameter_set_id;
 147     /** \brief Same as the H.264 bitstream syntax element. */
 148     unsigned char   level_idc;
 149     /** \brief Period between I frames. */
 150     unsigned int    intra_period;
 151     /** \brief Period between IDR frames. */
 152     unsigned int    intra_idr_period;
 153     /** \brief Period between I/P frames. */
 154     unsigned int    ip_period;
 155     /**
 156      * \brief Initial bitrate set for this sequence in CBR or VBR modes.
 157      *
 158      * This field represents the initial bitrate value for this
 159      * sequence if CBR or VBR mode is used, i.e. if the encoder
 160      * pipeline was created with a #VAConfigAttribRateControl
 161      * attribute set to either \ref VA_RC_CBR or \ref VA_RC_VBR.
 162      *
 163      * The bitrate can be modified later on through
 164      * #VAEncMiscParameterRateControl buffers.
 165      */
 166     unsigned int    bits_per_second;
 167     /** \brief Same as the H.264 bitstream syntax element. */
 168     unsigned int    max_num_ref_frames;
 169     /** \brief Picture width in macroblocks. */
 170     unsigned short  picture_width_in_mbs;
 171     /** \brief Picture height in macroblocks. */
 172     unsigned short  picture_height_in_mbs;
 173
 174     union {
 175         struct {
 176             /** \brief Same as the H.264 bitstream syntax element. */
 177             unsigned int chroma_format_idc                      : 2;
 178             /** \brief Same as the H.264 bitstream syntax element. */
 179             unsigned int frame_mbs_only_flag                    : 1;
 180             /** \brief Same as the H.264 bitstream syntax element. */
 181             unsigned int mb_adaptive_frame_field_flag           : 1;
 182             /** \brief Same as the H.264 bitstream syntax element. */
 183             unsigned int seq_scaling_matrix_present_flag        : 1;
 184             /** \brief Same as the H.264 bitstream syntax element. */
 185             unsigned int direct_8x8_inference_flag              : 1;
 186             /** \brief Same as the H.264 bitstream syntax element. */
 187             unsigned int log2_max_frame_num_minus4              : 4;
 188             /** \brief Same as the H.264 bitstream syntax element. */
 189             unsigned int pic_order_cnt_type                     : 2;
 190             /** \brief Same as the H.264 bitstream syntax element. */
 191             unsigned int log2_max_pic_order_cnt_lsb_minus4      : 4;
 192             /** \brief Same as the H.264 bitstream syntax element. */
 193             unsigned int delta_pic_order_always_zero_flag       : 1;
 194         } bits;
 195         unsigned int value;
 196     } seq_fields;
 197
 198     /** \brief Same as the H.264 bitstream syntax element. */
 199     unsigned char   bit_depth_luma_minus8;
 200     /** \brief Same as the H.264 bitstream syntax element. */
 201     unsigned char   bit_depth_chroma_minus8;
 202
 203     /** if pic_order_cnt_type == 1 */
 204     /**@{*/
 205     /** \brief Same as the H.264 bitstream syntax element. */
 206     unsigned char   num_ref_frames_in_pic_order_cnt_cycle;
 207     /** \brief Same as the H.264 bitstream syntax element. */
 208     int             offset_for_non_ref_pic;
 209     /** \brief Same as the H.264 bitstream syntax element. */
 210     int             offset_for_top_to_bottom_field;
 211     /** \brief Same as the H.264 bitstream syntax element. */
 212     int             offset_for_ref_frame[256];
 213     /**@}*/
 214
 215     /** @name Cropping (optional) */
 216     /**@{*/
 217     /** \brief Same as the H.264 bitstream syntax element. */
 218     unsigned char   frame_cropping_flag;
 219     /** \brief Same as the H.264 bitstream syntax element. */
 220     unsigned int    frame_crop_left_offset;
 221     /** \brief Same as the H.264 bitstream syntax element. */
 222     unsigned int    frame_crop_right_offset;
 223     /** \brief Same as the H.264 bitstream syntax element. */
 224     unsigned int    frame_crop_top_offset;
 225     /** \brief Same as the H.264 bitstream syntax element. */
 226     unsigned int    frame_crop_bottom_offset;
 227     /**@}*/
 228
 229     /** @name VUI parameters (optional) */
 230     /**@{*/
 231     /** \brief Same as the H.264 bitstream syntax element. */
 232     unsigned char   vui_parameters_present_flag;
 233     union {
 234         struct {
 235             /** \brief Same as the H.264 bitstream syntax element. */
 236             unsigned int aspect_ratio_info_present_flag         : 1;
 237             /** \brief Same as the H.264 bitstream syntax element. */
 238             unsigned int timing_info_present_flag               : 1;
 239             /** \brief Same as the H.264 bitstream syntax element. */
 240             unsigned int bitstream_restriction_flag             : 1;
 241             /** \brief Range: 0 to 16, inclusive. */
 242             unsigned int log2_max_mv_length_horizontal          : 5;
 243             /** \brief Range: 0 to 16, inclusive. */
 244             unsigned int log2_max_mv_length_vertical            : 5;
 245         } bits;
 246         unsigned int value;
 247     } vui_fields;
 248     /** \brief Same as the H.264 bitstream syntax element. */
 249     unsigned char   aspect_ratio_idc;
 250     /** \brief Same as the H.264 bitstream syntax element. */
 251     unsigned int    sar_width;
 252     /** \brief Same as the H.264 bitstream syntax element. */
 253     unsigned int    sar_height;
 254     /** \brief Same as the H.264 bitstream syntax element. */
 255     unsigned int    num_units_in_tick;
 256     /** \brief Same as the H.264 bitstream syntax element. */
 257     unsigned int    time_scale;
 258     /**@}*/
 259 } VAEncSequenceParameterBufferH264;
 260
 261 /**
 262  * \brief Picture parameter for H.264 encoding in main & high profiles.
 263  *
 264  * This structure holds information for \c pic_parameter_set_rbsp() as
 265  * defined by the H.264 specification.
 266  *
 267  * If packed picture headers mode is used, i.e. if the encoding
 268  * pipeline was configured with the #VA_ENC_PACKED_HEADER_PICTURE
 269  * flag, then the driver expects two more buffers to be provided to
 270  * the same \c vaRenderPicture() as this buffer:
 271  * - a #VAEncPackedHeaderParameterBuffer with type set to
 272  *   VAEncPackedHeaderType::VAEncPackedHeaderPicture ;
 273  * - a #VAEncPackedHeaderDataBuffer which holds the actual packed
 274  *   header data.
 275  *
 276  * If \c pic_scaling_matrix_present_flag is set to \c 1, then a
 277  * #VAIQMatrixBufferH264 buffer shall also be provided within the same
 278  * \c vaRenderPicture() call as this picture parameter buffer.
 279  */
 280 typedef struct _VAEncPictureParameterBufferH264 {
 281     /**
 282      * \brief Information about the picture to be encoded.
 283      *
 284      * See #VAPictureH264 for further description of each field.
 285      * Note that CurrPic.picture_id represents the reconstructed
 286      * (decoded) picture. User provides a scratch VA surface ID here.
 287      */
 288     VAPictureH264   CurrPic;
 289     /**
 290      * \brief Decoded Picture Buffer (DPB).
 291      *
 292      * This array represents the list of reconstructed (decoded)
 293      * frames used as reference. It is important to keep track of
 294      * reconstructed frames so that they can be used later on as
 295      * reference for P or B-frames encoding.
 296      */
 297     VAPictureH264   ReferenceFrames[16];
 298     /**
 299      * \brief Output encoded bitstream.
 300      *
 301      * \ref coded_buf has type #VAEncCodedBufferType. It should be
 302      * large enough to hold the compressed NAL slice and possibly SPS
 303      * and PPS NAL units.
 304      */
 305     VABufferID      coded_buf;
 306
 307     /** \brief The picture parameter set referred to in the slice header. */
 308     unsigned char   pic_parameter_set_id;
 309     /** \brief The active sequence parameter set. Range: 0 to 31, inclusive. */
 310     unsigned char   seq_parameter_set_id;
 311
 312     /**
 313      * \brief OR'd flags describing whether the picture is the last one or not.
 314      *
 315      * This fields holds 0 if the picture to be encoded is not the last
 316      * one in the stream or sequence. Otherwise, it is a combination of
 317      * \ref H264_LAST_PICTURE_EOSEQ or \ref H264_LAST_PICTURE_EOSTREAM.
 318      */
 319     unsigned char   last_picture;
 320
 321     /** \brief The picture identifier.
 322      *   Range: 0 to \f$2^{log2\_max\_frame\_num\_minus4 + 4} - 1\f$, inclusive.
 323      */
 324     unsigned short  frame_num;
 325
 326     /** \brief \c pic_init_qp_minus26 + 26. */
 327     unsigned char   pic_init_qp;
 328     /** \brief Maximum reference index for reference picture list 0.
 329      *   Range: 0 to 31, inclusive.
 330      */
 331     unsigned char   num_ref_idx_l0_active_minus1;
 332     /** \brief Maximum reference index for reference picture list 1.
 333      *  Range: 0 to 31, inclusive.
 334      */
 335     unsigned char   num_ref_idx_l1_active_minus1;
 336
 337     /** \brief Range: -12 to 12, inclusive. */
 338     signed char     chroma_qp_index_offset;
 339     /** \brief Range: -12 to 12, inclusive. */
 340     signed char     second_chroma_qp_index_offset;
 341
 342     union {
 343         struct {
 344             /** \brief Is picture an IDR picture? */
 345             unsigned int idr_pic_flag                           : 1;
 346             /** \brief Is picture a reference picture? */
 347             unsigned int reference_pic_flag                     : 2;
 348             /** \brief Selects CAVLC (0) or CABAC (1) entropy coding mode. */
 349             unsigned int entropy_coding_mode_flag               : 1;
 350             /** \brief Is weighted prediction applied to P slices? */
 351             unsigned int weighted_pred_flag                     : 1;
 352             /** \brief Range: 0 to 2, inclusive. */
 353             unsigned int weighted_bipred_idc                    : 2;
 354             /** \brief Same as the H.264 bitstream syntax element. */
 355             unsigned int constrained_intra_pred_flag            : 1;
 356             /** \brief Same as the H.264 bitstream syntax element. */
 357             unsigned int transform_8x8_mode_flag                : 1;
 358             /** \brief Same as the H.264 bitstream syntax element. */
 359             unsigned int deblocking_filter_control_present_flag : 1;
 360             /** \brief Same as the H.264 bitstream syntax element. */
 361             unsigned int redundant_pic_cnt_present_flag         : 1;
 362             /** \brief Same as the H.264 bitstream syntax element. */
 363             unsigned int pic_order_present_flag                 : 1;
 364             /** \brief Same as the H.264 bitstream syntax element. */
 365             unsigned int pic_scaling_matrix_present_flag        : 1;
 366         } bits;
 367         unsigned int value;
 368     } pic_fields;
 369 } VAEncPictureParameterBufferH264;
 370
 371 /**
 372  * \brief Slice parameter for H.264 encoding in main & high profiles.
 373  *
 374  * This structure holds information for \c
 375  * slice_layer_without_partitioning_rbsp() as defined by the H.264
 376  * specification.
 377  *
 378  * If packed slice headers mode is used, i.e. if the encoding
 379  * pipeline was configured with the #VA_ENC_PACKED_HEADER_SLICE
 380  * flag, then the driver expects two more buffers to be provided to
 381  * the same \c vaRenderPicture() as this buffer:
 382  * - a #VAEncPackedHeaderParameterBuffer with type set to
 383  *   VAEncPackedHeaderType::VAEncPackedHeaderSlice ;
 384  * - a #VAEncPackedHeaderDataBuffer which holds the actual packed
 385  *   header data.
 386  *
 387  * If per-macroblock encoder configuration is needed, \c macroblock_info
 388  * references a buffer of type #VAEncMacroblockParameterBufferH264. This
 389  * buffer is not passed to vaRenderPicture(). i.e. it is not destroyed
 390  * by subsequent calls to vaRenderPicture() and then can be re-used
 391  * without re-allocating the whole buffer.
 392  */
 393 typedef struct _VAEncSliceParameterBufferH264 {
 394     /** \brief Starting MB address for this slice. */
 395     unsigned int    macroblock_address;
 396     /** \brief Number of macroblocks in this slice. */
 397     unsigned int    num_macroblocks;
 398     /**
 399      * \brief Per-MB encoder configuration buffer, or \c VA_INVALID_ID.
 400      *
 401      * If per-MB encoder configuration is needed, then \ref macroblock_info
 402      * references a buffer of type #VAEncMacroblockParameterBufferH264
 403      * (\c VAEncMacroblockParameterBufferType). Otherwise, buffer id
 404      * is set to \c VA_INVALID_ID and per-MB configuration is derived
 405      * from this slice parameter.
 406      *
 407      * The \c macroblock_info buffer must hold \ref num_macroblocks
 408      * elements.
 409      */
 410     VABufferID      macroblock_info;
 411     /** \brief Slice type.
 412      *  Range: 0..2, 5..7, i.e. no switching slices.
 413      */
 414     unsigned char   slice_type;
 415     /** \brief Same as the H.264 bitstream syntax element. */
 416     unsigned char   pic_parameter_set_id;
 417     /** \brief Same as the H.264 bitstream syntax element. */
 418     unsigned short  idr_pic_id;
 419
 420     /** @name If pic_order_cnt_type == 0 */
 421     /**@{*/
 422     /** \brief The picture order count modulo MaxPicOrderCntLsb. */
 423     unsigned short  pic_order_cnt_lsb;
 424     /** \brief Valid if \c pic_order_present_flag and this is a bottom field. */
 425     int             delta_pic_order_cnt_bottom;
 426     /**@}*/
 427     /** @name If pic_order_cnt_type == 1 && !delta_pic_order_always_zero_flag */
 428     /**@{*/
 429     /** \brief [0]: top, [1]: bottom. */
 430     int             delta_pic_order_cnt[2];
 431     /**@}*/
 432
 433     /** @name If slice_type == B */
 434     /**@{*/
 435     unsigned char   direct_spatial_mv_pred_flag;
 436     /**@}*/
 437
 438     /** @name If slice_type == P */
 439     /**@{*/
 440     /** \brief Specifies if
 441      * \ref _VAEncPictureParameterBufferH264::num_ref_idx_l0_active_minus1 or
 442      * \ref _VAEncPictureParameterBufferH264::num_ref_idx_l1_active_minus1 are
 443      * overriden by the values for this slice.
 444      */
 445     unsigned char   num_ref_idx_active_override_flag;
 446     /** \brief Maximum reference index for reference picture list 0.
 447      *  Range: 0 to 31, inclusive.
 448      */
 449     unsigned char   num_ref_idx_l0_active_minus1;
 450     /** \brief Maximum reference index for reference picture list 1.
 451      *  Range: 0 to 31, inclusive.
 452      */
 453     unsigned char   num_ref_idx_l1_active_minus1;
 454     /** \brief Reference picture list 0 (for P slices). */
 455     VAPictureH264   RefPicList0[32];
 456     /** \brief Reference picture list 1 (for B slices). */
 457     VAPictureH264   RefPicList1[32];
 458     /**@}*/
 459
 460     /** @name pred_weight_table() */
 461     /**@{*/
 462     /** \brief Same as the H.264 bitstream syntax element. */
 463     unsigned char   luma_log2_weight_denom;
 464     /** \brief Same as the H.264 bitstream syntax element. */
 465     unsigned char   chroma_log2_weight_denom;
 466     /** \brief Same as the H.264 bitstream syntax element. */
 467     unsigned char   luma_weight_l0_flag;
 468     /** \brief Same as the H.264 bitstream syntax element. */
 469     signed short    luma_weight_l0[32];
 470     /** \brief Same as the H.264 bitstream syntax element. */
 471     signed short    luma_offset_l0[32];
 472     /** \brief Same as the H.264 bitstream syntax element. */
 473     unsigned char   chroma_weight_l0_flag;
 474     /** \brief Same as the H.264 bitstream syntax element. */
 475     signed short    chroma_weight_l0[32][2];
 476     /** \brief Same as the H.264 bitstream syntax element. */
 477     signed short    chroma_offset_l0[32][2];
 478     /** \brief Same as the H.264 bitstream syntax element. */
 479     unsigned char   luma_weight_l1_flag;
 480     /** \brief Same as the H.264 bitstream syntax element. */
 481     signed short    luma_weight_l1[32];
 482     /** \brief Same as the H.264 bitstream syntax element. */
 483     signed short    luma_offset_l1[32];
 484     /** \brief Same as the H.264 bitstream syntax element. */
 485     unsigned char   chroma_weight_l1_flag;
 486     /** \brief Same as the H.264 bitstream syntax element. */
 487     signed short    chroma_weight_l1[32][2];
 488     /** \brief Same as the H.264 bitstream syntax element. */
 489     signed short    chroma_offset_l1[32][2];
 490     /**@}*/
 491
 492     /** \brief Range: 0 to 2, inclusive. */
 493     unsigned char   cabac_init_idc;
 494     /** \brief Same as the H.264 bitstream syntax element. */
 495     signed char     slice_qp_delta;
 496     /** @name If deblocking_filter_control_present_flag */
 497     /**@{*/
 498     /** \brief Range: 0 to 2, inclusive. */
 499     unsigned char   disable_deblocking_filter_idc;
 500     /** \brief Same as the H.264 bitstream syntax element. */
 501     signed char     slice_alpha_c0_offset_div2;
 502     /** \brief Same as the H.264 bitstream syntax element. */
 503     signed char     slice_beta_offset_div2;
 504     /**@}*/
 505 } VAEncSliceParameterBufferH264;
 506
 507 /**
 508  * @name Macroblock neighbour availability bits
 509  *
 510  * \anchor api_enc_h264_mb_pred_avail_bits
 511  * Definitions for macroblock neighbour availability bits used in
 512  * intra prediction mode (non MBAFF only).
 513  *
 514  * @{
 515  */
 516 /** \brief References macroblock in the top-left corner. */
 517 #define VA_MB_PRED_AVAIL_TOP_LEFT         (1 << 2)
 518 /** \brief References macroblock above the current macroblock. */
 519 #define VA_MB_PRED_AVAIL_TOP              (1 << 4)
 520 /** \brief References macroblock in the top-right corner. */
 521 #define VA_MB_PRED_AVAIL_TOP_RIGHT        (1 << 3)
 522 /** \brief References macroblock on the left of the current macroblock. */
 523 #define VA_MB_PRED_AVAIL_LEFT             (1 << 6)
 524 /**@}*/
 525
 526 /**
 527  * \brief Macroblock parameter for H.264 encoding in main & high profiles.
 528  *
 529  * This structure holds per-macroblock information. The buffer must be
 530  * allocated with as many elements (macroblocks) as necessary to fit
 531  * the slice to be encoded. Besides, the per-macroblock records must
 532  * be written in a strict raster order and with no gap. i.e. every
 533  * macroblock, regardless of its type, shall have an entry.
 534  */
 535 typedef struct _VAEncMacroblockParameterBufferH264 {
 536     /**
 537      * \brief Quantization parameter.
 538      *
 539      * Requested quantization parameter. Range: 0 to 51, inclusive.
 540      * If \ref qp is set to 0xff, then the actual value is derived
 541      * from the slice-level value: \c pic_init_qp + \c slice_qp_delta.
 542      */
 543     unsigned char   qp;
 544
 545     union {
 546         /** @name Data for intra macroblock */
 547         /**@{*/
 548         struct {
 549             union {
 550                 /**
 551                  * \brief Flag specified to override MB neighbour
 552                  * availability bits from VME stage.
 553                  *
 554                  * This flag specifies that macroblock neighbour
 555                  * availability bits from the VME stage are overriden
 556                  * by the \ref pred_avail_flags hereunder.
 557                  */
 558                 unsigned int    pred_avail_override_flag        : 1;
 559                 /**
 560                  * \brief Bitwise representation of which macroblocks
 561                  * are available for intra prediction.
 562                  *
 563                  * If the slice is intra-coded, this field represents
 564                  * the macroblocks available for intra prediction.
 565                  * See \ref api_enc_h264_mb_pred_avail_bits
 566                  * "macroblock neighbour availability" bit definitions.
 567                  */
 568                 unsigned int    pred_avail_flags                : 8;
 569             } bits;
 570             unsigned int value;
 571         } intra_fields;
 572         /**@}*/
 573
 574         /** @name Data for inter macroblock */
 575         /**@{*/
 576         struct {
 577             union {
 578             } bits;
 579             unsigned int value;
 580         } inter_fields;
 581         /**@}*/
 582     } info;
 583 } VAEncMacroblockParameterBufferH264;
 584
 585 /** \brief Bitstream writer attribute types specific to H.264 encoding. */
 586 typedef enum {
 587     /**
 588      * \brief Flag: specifies whether to insert emulation prevention
 589      * bytes (integer).
 590      */
 591     VAEncBitstreamAttribEmulationPreventionH264 = (
 592         VAEncBitstreamAttribMiscMask | 1),
 593 } VAEncBitstreamAttribTypeH264;
 594
 595 /**
 596  * \brief Allocates a new H.264 bitstream writer.
 597  *
 598  * Allocates a new bitstream writer. By default, libva allocates and
 599  * maintains its own buffer. However, the user can pass down his own
 600  * buffer with the \c VAEncBitstreamAttribBuffer attribute, along with
 601  * the size of that buffer with the \c VAEncBitstreamAttribBufferSize
 602  * attribute.
 603  *
 604  * By default, emulation prevention bytes are not inserted. However,
 605  * the user can still request emulation prevention by setting the
 606  * \c VAEncBitstreamAttribEmulationPreventionH264 attribute to 1.
 607  *
 608  * @param[in] attribs       the optional attributes, or NULL
 609  * @param[in] num_attribs   the number of attributes available in \c attribs
 610  * @return a new #VAEncBitstream, or NULL if an error occurred
 611  */
 612 VAEncBitstream *
 613 va_enc_bitstream_h264_new(
 614     VAEncBitstreamAttrib *attribs,
 615     unsigned int          num_attribs
 616 );
 617
 618 /**
 619  * \brief Destroys an H.264 bitstream writer.
 620  *
 621  * @param[in] bs            the bitstream writer to destroy
 622  */
 623 void
 624 va_enc_bitstream_h264_destroy(VAEncBitstream *bs);
 625
 626 /**
 627  * \brief Writes an unsigned integer as \c ue(v).
 628  *
 629  * Writes a 32-bit unsigned int value by following \c ue(v) from the
 630  * H.264 specification.
 631  *
 632  * @param[in] bs            the bitstream writer
 633  * @param[in] value         the unsigned int value
 634  * @return the number of bits written, or a negative value to indicate an error
 635  */
 636 int
 637 va_enc_bitstream_h264_write_ue(VAEncBitstream *bs, unsigned int value);
 638
 639 /**
 640  * \brief Writes a signed integer as \c se(v).
 641  *
 642  * Writes a 32-bit signed int value by following \c se(v) from the
 643  * H.264 specification.
 644  *
 645  * @param[in] bs            the bitstream writer
 646  * @param[in] value         the signed int value
 647  * @return the number of bits written, or a negative value to indicate an error
 648  */
 649 int
 650 va_enc_bitstream_h264_write_se(VAEncBitstream *bs, int value);
 651
 652 /**
 653  * \brief Helper function to write trailing bits into the bitstream.
 654  *
 655  * @param[in] bs            the bitstream writer
 656  * @return the number of bits written, or a negative value to indicate an error
 657  */
 658 int
 659 va_enc_bitstream_h264_write_trailing_bits(VAEncBitstream *bs);
 660
 661 /**@}*/
 662
 663 #ifdef __cplusplus
 664 }
 665 #endif
 666
 667 #endif /* VA_ENC_H264_H */