Subversion Repositories Kolibri OS

Rev

Blame | Last modification | View Log | RSS feed

  1. /*
  2.  * Copyright (c) 2007-2009 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.  * Video Acceleration (VA) API Specification
  26.  *
  27.  * Rev. 0.30
  28.  * <jonathan.bian@intel.com>
  29.  *
  30.  * Revision History:
  31.  * rev 0.10 (12/10/2006 Jonathan Bian) - Initial draft
  32.  * rev 0.11 (12/15/2006 Jonathan Bian) - Fixed some errors
  33.  * rev 0.12 (02/05/2007 Jonathan Bian) - Added VC-1 data structures for slice level decode
  34.  * rev 0.13 (02/28/2007 Jonathan Bian) - Added GetDisplay()
  35.  * rev 0.14 (04/13/2007 Jonathan Bian) - Fixed MPEG-2 PictureParameter structure, cleaned up a few funcs.
  36.  * rev 0.15 (04/20/2007 Jonathan Bian) - Overhauled buffer management
  37.  * rev 0.16 (05/02/2007 Jonathan Bian) - Added error codes and fixed some issues with configuration
  38.  * rev 0.17 (05/07/2007 Jonathan Bian) - Added H.264/AVC data structures for slice level decode.
  39.  * rev 0.18 (05/14/2007 Jonathan Bian) - Added data structures for MPEG-4 slice level decode
  40.  *                                       and MPEG-2 motion compensation.
  41.  * rev 0.19 (08/06/2007 Jonathan Bian) - Removed extra type for bitplane data.
  42.  * rev 0.20 (08/08/2007 Jonathan Bian) - Added missing fields to VC-1 PictureParameter structure.
  43.  * rev 0.21 (08/20/2007 Jonathan Bian) - Added image and subpicture support.
  44.  * rev 0.22 (08/27/2007 Jonathan Bian) - Added support for chroma-keying and global alpha.
  45.  * rev 0.23 (09/11/2007 Jonathan Bian) - Fixed some issues with images and subpictures.
  46.  * rev 0.24 (09/18/2007 Jonathan Bian) - Added display attributes.
  47.  * rev 0.25 (10/18/2007 Jonathan Bian) - Changed to use IDs only for some types.
  48.  * rev 0.26 (11/07/2007 Waldo Bastian) - Change vaCreateBuffer semantics
  49.  * rev 0.27 (11/19/2007 Matt Sottek)   - Added DeriveImage
  50.  * rev 0.28 (12/06/2007 Jonathan Bian) - Added new versions of PutImage and AssociateSubpicture
  51.  *                                       to enable scaling
  52.  * rev 0.29 (02/07/2008 Jonathan Bian) - VC1 parameter fixes,
  53.  *                                       added VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED
  54.  * rev 0.30 (03/01/2009 Jonathan Bian) - Added encoding support for H.264 BP and MPEG-4 SP and fixes
  55.  *                                       for ISO C conformance.
  56.  * rev 0.31 (09/02/2009 Gwenole Beauchesne) - VC-1/H264 fields change for VDPAU and XvBA backend
  57.  *                                       Application needs to relink with the new library.
  58.  *
  59.  * rev 0.31.1 (03/29/2009)              - Data structure for JPEG encode
  60.  * rev 0.31.2 (01/13/2011 Anthony Pabon)- Added a flag to indicate Subpicture coordinates are screen
  61.  *                                        screen relative rather than source video relative.
  62.  * rev 0.32.0 (01/13/2011 Xiang Haihao) - Add profile into VAPictureParameterBufferVC1
  63.  *                                        update VAAPI to 0.32.0
  64.  *
  65.  * Acknowledgements:
  66.  *  Some concepts borrowed from XvMC and XvImage.
  67.  *  Waldo Bastian (Intel), Matt Sottek (Intel),  Austin Yuan (Intel), and Gwenole Beauchesne (SDS)
  68.  *  contributed to various aspects of the API.
  69.  */
  70.  
  71. /**
  72.  * \file va.h
  73.  * \brief The Core API
  74.  *
  75.  * This file contains the \ref api_core "Core API".
  76.  */
  77.  
  78. #ifndef _VA_H_
  79. #define _VA_H_
  80.  
  81. #include <stddef.h>
  82. #include <stdint.h>
  83. #include <va/va_version.h>
  84.  
  85. #ifdef __cplusplus
  86. extern "C" {
  87. #endif
  88.  
  89. /**
  90.  * \mainpage Video Acceleration (VA) API
  91.  *
  92.  * \section intro Introduction
  93.  *
  94.  * The main motivation for VA-API (Video Acceleration API) is to
  95.  * enable hardware accelerated video decode and encode at various
  96.  * entry-points (VLD, IDCT, Motion Compensation etc.) for the
  97.  * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4
  98.  * AVC/H.264, VC-1/VMW3, and JPEG).
  99.  *
  100.  * VA-API is split into several modules:
  101.  * - \ref api_core
  102.  * - \ref api_enc_h264
  103.  * - \ref api_vpp
  104.  */
  105.  
  106. /**
  107.  * \defgroup api_core Core API
  108.  *
  109.  * @{
  110.  */
  111.  
  112. /**
  113. Overview
  114.  
  115. The VA API is intended to provide an interface between a video decode/encode/display
  116. application (client) and a hardware accelerator (server), to off-load
  117. video decode/encode/display operations from the host to the hardware accelerator at various
  118. entry-points.
  119.  
  120. The basic operation steps are:
  121.  
  122. - Negotiate a mutually acceptable configuration with the server to lock
  123.   down profile, entrypoints, and other attributes that will not change on
  124.   a frame-by-frame basis.
  125. - Create a decode context which represents a "virtualized" hardware decode
  126.   device
  127. - Get and fill decode buffers with picture level, slice level and macroblock
  128.   level data (depending on entrypoints)
  129. - Pass the decode buffers to the server to decode the current frame
  130.  
  131. Initialization & Configuration Management
  132.  
  133. - Find out supported profiles
  134. - Find out entrypoints for a given profile
  135. - Find out configuration attributes for a given profile/entrypoint pair
  136. - Create a configuration for use by the decoder
  137.  
  138. */
  139.  
  140. typedef void* VADisplay;        /* window system dependent */
  141.  
  142. typedef int VAStatus;   /** Return status type from functions */
  143. /** Values for the return status */
  144. #define VA_STATUS_SUCCESS                       0x00000000
  145. #define VA_STATUS_ERROR_OPERATION_FAILED        0x00000001
  146. #define VA_STATUS_ERROR_ALLOCATION_FAILED       0x00000002
  147. #define VA_STATUS_ERROR_INVALID_DISPLAY         0x00000003
  148. #define VA_STATUS_ERROR_INVALID_CONFIG          0x00000004
  149. #define VA_STATUS_ERROR_INVALID_CONTEXT         0x00000005
  150. #define VA_STATUS_ERROR_INVALID_SURFACE         0x00000006
  151. #define VA_STATUS_ERROR_INVALID_BUFFER          0x00000007
  152. #define VA_STATUS_ERROR_INVALID_IMAGE           0x00000008
  153. #define VA_STATUS_ERROR_INVALID_SUBPICTURE      0x00000009
  154. #define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED      0x0000000a
  155. #define VA_STATUS_ERROR_MAX_NUM_EXCEEDED        0x0000000b
  156. #define VA_STATUS_ERROR_UNSUPPORTED_PROFILE     0x0000000c
  157. #define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT  0x0000000d
  158. #define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT   0x0000000e
  159. #define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE  0x0000000f
  160. #define VA_STATUS_ERROR_SURFACE_BUSY            0x00000010
  161. #define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED      0x00000011
  162. #define VA_STATUS_ERROR_INVALID_PARAMETER       0x00000012
  163. #define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
  164. #define VA_STATUS_ERROR_UNIMPLEMENTED           0x00000014
  165. #define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING   0x00000015
  166. #define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT    0x00000016
  167. #define VA_STATUS_ERROR_DECODING_ERROR          0x00000017
  168. #define VA_STATUS_ERROR_ENCODING_ERROR          0x00000018
  169. /**
  170.  * \brief An invalid/unsupported value was supplied.
  171.  *
  172.  * This is a catch-all error code for invalid or unsupported values.
  173.  * e.g. value exceeding the valid range, invalid type in the context
  174.  * of generic attribute values.
  175.  */
  176. #define VA_STATUS_ERROR_INVALID_VALUE           0x00000019
  177. /** \brief An unsupported filter was supplied. */
  178. #define VA_STATUS_ERROR_UNSUPPORTED_FILTER      0x00000020
  179. /** \brief An invalid filter chain was supplied. */
  180. #define VA_STATUS_ERROR_INVALID_FILTER_CHAIN    0x00000021
  181. /** \brief Indicate HW busy (e.g. run multiple encoding simultaneously). */
  182. #define VA_STATUS_ERROR_HW_BUSY                 0x00000022
  183. /** \brief An unsupported memory type was supplied. */
  184. #define VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE 0x00000024
  185. #define VA_STATUS_ERROR_UNKNOWN                 0xFFFFFFFF
  186.  
  187. /** De-interlacing flags for vaPutSurface() */
  188. #define VA_FRAME_PICTURE        0x00000000
  189. #define VA_TOP_FIELD            0x00000001
  190. #define VA_BOTTOM_FIELD         0x00000002
  191.  
  192. /**
  193.  * Enabled the positioning/cropping/blending feature:
  194.  * 1, specify the video playback position in the isurface
  195.  * 2, specify the cropping info for video playback
  196.  * 3, encoded video will blend with background color
  197.  */
  198. #define VA_ENABLE_BLEND         0x00000004 /* video area blend with the constant color */
  199.    
  200. /**
  201.  * Clears the drawable with background color.
  202.  * for hardware overlay based implementation this flag
  203.  * can be used to turn off the overlay
  204.  */
  205. #define VA_CLEAR_DRAWABLE       0x00000008
  206.  
  207. /** Color space conversion flags for vaPutSurface() */
  208. #define VA_SRC_BT601            0x00000010
  209. #define VA_SRC_BT709            0x00000020
  210. #define VA_SRC_SMPTE_240        0x00000040
  211.  
  212. /** Scaling flags for vaPutSurface() */
  213. #define VA_FILTER_SCALING_DEFAULT       0x00000000
  214. #define VA_FILTER_SCALING_FAST          0x00000100
  215. #define VA_FILTER_SCALING_HQ            0x00000200
  216. #define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
  217. #define VA_FILTER_SCALING_MASK          0x00000f00
  218.  
  219. /**
  220.  * Returns a short english description of error_status
  221.  */
  222. const char *vaErrorStr(VAStatus error_status);
  223.  
  224. /**
  225.  * Initialization:
  226.  * A display must be obtained by calling vaGetDisplay() before calling
  227.  * vaInitialize() and other functions. This connects the API to the
  228.  * native window system.
  229.  * For X Windows, native_dpy would be from XOpenDisplay()
  230.  */
  231. typedef void* VANativeDisplay;  /* window system dependent */
  232.  
  233. int vaDisplayIsValid(VADisplay dpy);
  234.    
  235. /**
  236.  * Initialize the library
  237.  */
  238. VAStatus vaInitialize (
  239.     VADisplay dpy,
  240.     int *major_version,  /* out */
  241.     int *minor_version   /* out */
  242. );
  243.  
  244. /**
  245.  * After this call, all library internal resources will be cleaned up
  246.  */
  247. VAStatus vaTerminate (
  248.     VADisplay dpy
  249. );
  250.  
  251. /**
  252.  * vaQueryVendorString returns a pointer to a zero-terminated string
  253.  * describing some aspects of the VA implemenation on a specific    
  254.  * hardware accelerator. The format of the returned string is vendor
  255.  * specific and at the discretion of the implementer.
  256.  * e.g. for the Intel GMA500 implementation, an example would be:
  257.  * "Intel GMA500 - 2.0.0.32L.0005"
  258.  */
  259. const char *vaQueryVendorString (
  260.     VADisplay dpy
  261. );
  262.  
  263. typedef int (*VAPrivFunc)();
  264.  
  265. /**
  266.  * Return a function pointer given a function name in the library.
  267.  * This allows private interfaces into the library
  268.  */
  269. VAPrivFunc vaGetLibFunc (
  270.     VADisplay dpy,
  271.     const char *func
  272. );
  273.  
  274. /** Currently defined profiles */
  275. typedef enum
  276. {
  277.     /** \brief Profile ID used for video processing. */
  278.     VAProfileNone                       = -1,
  279.     VAProfileMPEG2Simple                = 0,
  280.     VAProfileMPEG2Main                  = 1,
  281.     VAProfileMPEG4Simple                = 2,
  282.     VAProfileMPEG4AdvancedSimple        = 3,
  283.     VAProfileMPEG4Main                  = 4,
  284.     VAProfileH264Baseline               = 5,
  285.     VAProfileH264Main                   = 6,
  286.     VAProfileH264High                   = 7,
  287.     VAProfileVC1Simple                  = 8,
  288.     VAProfileVC1Main                    = 9,
  289.     VAProfileVC1Advanced                = 10,
  290.     VAProfileH263Baseline               = 11,
  291.     VAProfileJPEGBaseline               = 12,
  292.     VAProfileH264ConstrainedBaseline    = 13,
  293.     VAProfileVP8Version0_3              = 14,
  294.     VAProfileH264MultiviewHigh          = 15,
  295.     VAProfileH264StereoHigh             = 16
  296. } VAProfile;
  297.  
  298. /**
  299.  *  Currently defined entrypoints
  300.  */
  301. typedef enum
  302. {
  303.     VAEntrypointVLD             = 1,
  304.     VAEntrypointIZZ             = 2,
  305.     VAEntrypointIDCT            = 3,
  306.     VAEntrypointMoComp          = 4,
  307.     VAEntrypointDeblocking      = 5,
  308.     VAEntrypointEncSlice        = 6,    /* slice level encode */
  309.     VAEntrypointEncPicture      = 7,    /* pictuer encode, JPEG, etc */
  310.     VAEntrypointVideoProc       = 10,   /**< Video pre/post-processing. */
  311. } VAEntrypoint;
  312.  
  313. /** Currently defined configuration attribute types */
  314. typedef enum
  315. {
  316.     VAConfigAttribRTFormat              = 0,
  317.     VAConfigAttribSpatialResidual       = 1,
  318.     VAConfigAttribSpatialClipping       = 2,
  319.     VAConfigAttribIntraResidual         = 3,
  320.     VAConfigAttribEncryption            = 4,
  321.     VAConfigAttribRateControl           = 5,
  322.  
  323.     /** @name Attributes for encoding */
  324.     /**@{*/
  325.     /**
  326.      * \brief Packed headers mode. Read/write.
  327.      *
  328.      * This attribute determines what packed headers the driver supports,
  329.      * through vaGetConfigAttributes(); and what packed headers the user
  330.      * will be providing to the driver, through vaCreateConfig(), if the
  331.      * driver supports those.
  332.      *
  333.      * See \c VA_ENC_PACKED_HEADER_xxx for the list of packed headers.
  334.      */
  335.     VAConfigAttribEncPackedHeaders      = 10,
  336.     /**
  337.      * \brief Interlaced mode. Read/write.
  338.      *
  339.      * This attribute determines what kind of interlaced encoding mode
  340.      * the driver supports.
  341.      *
  342.      * See \c VA_ENC_INTERLACED_xxx for the list of interlaced modes.
  343.      */
  344.     VAConfigAttribEncInterlaced         = 11,
  345.     /**
  346.      * \brief Maximum number of reference frames. Read-only.
  347.      *
  348.      * This attribute determines the maximum number of reference
  349.      * frames supported for encoding.
  350.      *
  351.      * Note: for H.264 encoding, the value represents the maximum number
  352.      * of reference frames for both the reference picture list 0 (bottom
  353.      * 16 bits) and the reference picture list 1 (top 16 bits).
  354.      */
  355.     VAConfigAttribEncMaxRefFrames       = 13,
  356.     /**
  357.      * \brief Maximum number of slices per frame. Read-only.
  358.      *
  359.      * This attribute determines the maximum number of slices the
  360.      * driver can support to encode a single frame.
  361.      */
  362.     VAConfigAttribEncMaxSlices          = 14,
  363.     /**
  364.      * \brief Slice structure. Read-only.
  365.      *
  366.      * This attribute determines slice structures supported by the
  367.      * driver for encoding. This attribute is a hint to the user so
  368.      * that he can choose a suitable surface size and how to arrange
  369.      * the encoding process of multiple slices per frame.
  370.      *
  371.      * More specifically, for H.264 encoding, this attribute
  372.      * determines the range of accepted values to
  373.      * VAEncSliceParameterBufferH264::macroblock_address and
  374.      * VAEncSliceParameterBufferH264::num_macroblocks.
  375.      *
  376.      * See \c VA_ENC_SLICE_STRUCTURE_xxx for the supported slice
  377.      * structure types.
  378.      */
  379.     VAConfigAttribEncSliceStructure     = 15,
  380.     /**
  381.      * \brief Macroblock information. Read-only.
  382.      *
  383.      * This attribute determines whether the driver supports extra
  384.      * encoding information per-macroblock. e.g. QP.
  385.      *
  386.      * More specifically, for H.264 encoding, if the driver returns a non-zero
  387.      * value for this attribute, this means the application can create
  388.      * additional #VAEncMacroblockParameterBufferH264 buffers referenced
  389.      * through VAEncSliceParameterBufferH264::macroblock_info.
  390.      */
  391.     VAConfigAttribEncMacroblockInfo     = 16,
  392.     /**
  393.      * \brief Encoding quality range attribute. Read-only.
  394.      *
  395.      * This attribute conveys whether the driver supports different quality level settings
  396.      * for encoding. A value less than or equal to 1 means that the encoder only has a single
  397.      * quality setting, and a value greater than 1 represents the number of quality levels
  398.      * that can be configured. e.g. a value of 2 means there are two distinct quality levels.
  399.      */
  400.     VAConfigAttribEncQualityRange     = 21,
  401.     /**@}*/
  402.     VAConfigAttribTypeMax
  403. } VAConfigAttribType;
  404.  
  405. /**
  406.  * Configuration attributes
  407.  * If there is more than one value for an attribute, a default
  408.  * value will be assigned to the attribute if the client does not
  409.  * specify the attribute when creating a configuration
  410.  */
  411. typedef struct _VAConfigAttrib {
  412.     VAConfigAttribType type;
  413.     unsigned int value; /* OR'd flags (bits) for this attribute */
  414. } VAConfigAttrib;
  415.  
  416. /** attribute value for VAConfigAttribRTFormat */
  417. #define VA_RT_FORMAT_YUV420     0x00000001     
  418. #define VA_RT_FORMAT_YUV422     0x00000002
  419. #define VA_RT_FORMAT_YUV444     0x00000004
  420. #define VA_RT_FORMAT_YUV411     0x00000008
  421. #define VA_RT_FORMAT_YUV400     0x00000010
  422. #define VA_RT_FORMAT_RGB16      0x00010000
  423. #define VA_RT_FORMAT_RGB32      0x00020000
  424. /* RGBP covers RGBP and BGRP fourcc */
  425. #define VA_RT_FORMAT_RGBP       0x00100000
  426. #define VA_RT_FORMAT_PROTECTED  0x80000000
  427.  
  428. /** @name Attribute values for VAConfigAttribRateControl */
  429. /**@{*/
  430. /** \brief Driver does not support any form of rate control. */
  431. #define VA_RC_NONE                      0x00000001
  432. /** \brief Constant bitrate. */
  433. #define VA_RC_CBR                       0x00000002
  434. /** \brief Variable bitrate. */
  435. #define VA_RC_VBR                       0x00000004
  436. /** \brief Video conference mode. */
  437. #define VA_RC_VCM                       0x00000008
  438. /** \brief Constant QP. */
  439. #define VA_RC_CQP                       0x00000010
  440. /** \brief Variable bitrate with peak rate higher than average bitrate. */
  441. #define VA_RC_VBR_CONSTRAINED           0x00000020
  442. /**@}*/
  443.  
  444. /** @name Attribute values for VAConfigAttribEncPackedHeaders */
  445. /**@{*/
  446. /** \brief Driver does not support any packed headers mode. */
  447. #define VA_ENC_PACKED_HEADER_NONE       0x00000000
  448. /** \brief Driver supports packed sequence headers. e.g. SPS for H.264. */
  449. #define VA_ENC_PACKED_HEADER_SEQUENCE   0x00000001
  450. /** \brief Driver supports packed picture headers. e.g. PPS for H.264. */
  451. #define VA_ENC_PACKED_HEADER_PICTURE    0x00000002
  452. /** \brief Driver supports packed slice headers. e.g. \c slice_header() for H.264. */
  453. #define VA_ENC_PACKED_HEADER_SLICE      0x00000004
  454. /** \brief Driver supports misc packed headers. e.g. SEI for H.264. */
  455. #define VA_ENC_PACKED_HEADER_MISC       0x00000008
  456. /** \brief Driver supports raw packed header, see VAEncPackedHeaderRawData */
  457. #define VA_ENC_PACKED_HEADER_RAW_DATA   0x00000010
  458. /**@}*/
  459.  
  460. /** @name Attribute values for VAConfigAttribEncInterlaced */
  461. /**@{*/
  462. /** \brief Driver does not support interlaced coding. */
  463. #define VA_ENC_INTERLACED_NONE          0x00000000
  464. /** \brief Driver supports interlaced frame coding. */
  465. #define VA_ENC_INTERLACED_FRAME         0x00000001
  466. /** \brief Driver supports interlaced field coding. */
  467. #define VA_ENC_INTERLACED_FIELD         0x00000002
  468. /** \brief Driver supports macroblock adaptive frame field coding. */
  469. #define VA_ENC_INTERLACED_MBAFF         0x00000004
  470. /** \brief Driver supports picture adaptive frame field coding. */
  471. #define VA_ENC_INTERLACED_PAFF          0x00000008
  472. /**@}*/
  473.  
  474. /** @name Attribute values for VAConfigAttribEncSliceStructure */
  475. /**@{*/
  476. /** \brief Driver supports an arbitrary number of rows per slice. */
  477. #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_ROWS           0x00000000
  478. /** \brief Driver supports a power-of-two number of rows per slice. */
  479. #define VA_ENC_SLICE_STRUCTURE_POWER_OF_TWO_ROWS        0x00000001
  480. /** \brief Driver supports an arbitrary number of rows per slice. */
  481. #define VA_ENC_SLICE_STRUCTURE_ARBITRARY_MACROBLOCKS    0x00000002
  482. /**@}*/
  483.  
  484. /**
  485.  * if an attribute is not applicable for a given
  486.  * profile/entrypoint pair, then set the value to the following
  487.  */
  488. #define VA_ATTRIB_NOT_SUPPORTED 0x80000000
  489.  
  490. /** Get maximum number of profiles supported by the implementation */
  491. int vaMaxNumProfiles (
  492.     VADisplay dpy
  493. );
  494.  
  495. /** Get maximum number of entrypoints supported by the implementation */
  496. int vaMaxNumEntrypoints (
  497.     VADisplay dpy
  498. );
  499.  
  500. /** Get maximum number of attributs supported by the implementation */
  501. int vaMaxNumConfigAttributes (
  502.     VADisplay dpy
  503. );
  504.  
  505. /**
  506.  * Query supported profiles
  507.  * The caller must provide a "profile_list" array that can hold at
  508.  * least vaMaxNumProfile() entries. The actual number of profiles
  509.  * returned in "profile_list" is returned in "num_profile".
  510.  */
  511. VAStatus vaQueryConfigProfiles (
  512.     VADisplay dpy,
  513.     VAProfile *profile_list,    /* out */
  514.     int *num_profiles           /* out */
  515. );
  516.  
  517. /**
  518.  * Query supported entrypoints for a given profile
  519.  * The caller must provide an "entrypoint_list" array that can hold at
  520.  * least vaMaxNumEntrypoints() entries. The actual number of entrypoints
  521.  * returned in "entrypoint_list" is returned in "num_entrypoints".
  522.  */
  523. VAStatus vaQueryConfigEntrypoints (
  524.     VADisplay dpy,
  525.     VAProfile profile,
  526.     VAEntrypoint *entrypoint_list,      /* out */
  527.     int *num_entrypoints                /* out */
  528. );
  529.  
  530. /**
  531.  * Get attributes for a given profile/entrypoint pair
  532.  * The caller must provide an "attrib_list" with all attributes to be
  533.  * retrieved.  Upon return, the attributes in "attrib_list" have been
  534.  * updated with their value.  Unknown attributes or attributes that are
  535.  * not supported for the given profile/entrypoint pair will have their
  536.  * value set to VA_ATTRIB_NOT_SUPPORTED
  537.  */
  538. VAStatus vaGetConfigAttributes (
  539.     VADisplay dpy,
  540.     VAProfile profile,
  541.     VAEntrypoint entrypoint,
  542.     VAConfigAttrib *attrib_list, /* in/out */
  543.     int num_attribs
  544. );
  545.  
  546. /** Generic ID type, can be re-typed for specific implementation */
  547. typedef unsigned int VAGenericID;
  548.  
  549. typedef VAGenericID VAConfigID;
  550.  
  551. /**
  552.  * Create a configuration for the decode pipeline
  553.  * it passes in the attribute list that specifies the attributes it cares
  554.  * about, with the rest taking default values.  
  555.  */
  556. VAStatus vaCreateConfig (
  557.     VADisplay dpy,
  558.     VAProfile profile,
  559.     VAEntrypoint entrypoint,
  560.     VAConfigAttrib *attrib_list,
  561.     int num_attribs,
  562.     VAConfigID *config_id /* out */
  563. );
  564.  
  565. /**
  566.  * Free resources associdated with a given config
  567.  */
  568. VAStatus vaDestroyConfig (
  569.     VADisplay dpy,
  570.     VAConfigID config_id
  571. );
  572.  
  573. /**
  574.  * Query all attributes for a given configuration
  575.  * The profile of the configuration is returned in "profile"
  576.  * The entrypoint of the configuration is returned in "entrypoint"
  577.  * The caller must provide an "attrib_list" array that can hold at least
  578.  * vaMaxNumConfigAttributes() entries. The actual number of attributes
  579.  * returned in "attrib_list" is returned in "num_attribs"
  580.  */
  581. VAStatus vaQueryConfigAttributes (
  582.     VADisplay dpy,
  583.     VAConfigID config_id,
  584.     VAProfile *profile,         /* out */
  585.     VAEntrypoint *entrypoint,   /* out */
  586.     VAConfigAttrib *attrib_list,/* out */
  587.     int *num_attribs            /* out */
  588. );
  589.  
  590.  
  591. /**
  592.  * Contexts and Surfaces
  593.  *
  594.  * Context represents a "virtual" video decode pipeline. Surfaces are render
  595.  * targets for a given context. The data in the surfaces are not accessible  
  596.  * to the client and the internal data format of the surface is implementatin
  597.  * specific.
  598.  *
  599.  * Surfaces will be bound to a context when the context is created. Once
  600.  * a surface is bound to a given context, it can not be used to create  
  601.  * another context. The association is removed when the context is destroyed
  602.  *
  603.  * Both contexts and surfaces are identified by unique IDs and its
  604.  * implementation specific internals are kept opaque to the clients
  605.  */
  606.  
  607. typedef VAGenericID VAContextID;
  608.  
  609. typedef VAGenericID VASurfaceID;
  610.  
  611. #define VA_INVALID_ID           0xffffffff
  612. #define VA_INVALID_SURFACE      VA_INVALID_ID
  613.  
  614. /** \brief Generic value types. */
  615. typedef enum  {
  616.     VAGenericValueTypeInteger = 1,      /**< 32-bit signed integer. */
  617.     VAGenericValueTypeFloat,            /**< 32-bit floating-point value. */
  618.     VAGenericValueTypePointer,          /**< Generic pointer type */
  619.     VAGenericValueTypeFunc              /**< Pointer to function */
  620. } VAGenericValueType;
  621.  
  622. /** \brief Generic function type. */
  623. typedef void (*VAGenericFunc)(void);
  624.  
  625. /** \brief Generic value. */
  626. typedef struct _VAGenericValue {
  627.     /** \brief Value type. See #VAGenericValueType. */
  628.     VAGenericValueType  type;
  629.     /** \brief Value holder. */
  630.     union {
  631.         /** \brief 32-bit signed integer. */
  632.         int             i;
  633.         /** \brief 32-bit float. */
  634.         float           f;
  635.         /** \brief Generic pointer. */
  636.         void           *p;
  637.         /** \brief Pointer to function. */
  638.         VAGenericFunc   fn;
  639.     }                   value;
  640. } VAGenericValue;
  641.  
  642. /** @name Surface attribute flags */
  643. /**@{*/
  644. /** \brief Surface attribute is not supported. */
  645. #define VA_SURFACE_ATTRIB_NOT_SUPPORTED 0x00000000
  646. /** \brief Surface attribute can be got through vaQuerySurfaceAttributes(). */
  647. #define VA_SURFACE_ATTRIB_GETTABLE      0x00000001
  648. /** \brief Surface attribute can be set through vaCreateSurfaces(). */
  649. #define VA_SURFACE_ATTRIB_SETTABLE      0x00000002
  650. /**@}*/
  651.  
  652. /** \brief Surface attribute types. */
  653. typedef enum {
  654.     VASurfaceAttribNone = 0,
  655.     /**
  656.      * \brief Pixel format (fourcc).
  657.      *
  658.      * The value is meaningful as input to vaQuerySurfaceAttributes().
  659.      * If zero, the driver returns the optimal pixel format for the
  660.      * specified config. Otherwise, if non-zero, the value represents
  661.      * a pixel format (FOURCC) that is kept as is on output, if the
  662.      * driver supports it. Otherwise, the driver sets the value to
  663.      * zero and drops the \c VA_SURFACE_ATTRIB_SETTABLE flag.
  664.      */
  665.     VASurfaceAttribPixelFormat,
  666.     /** \brief Minimal width in pixels (int, read-only). */
  667.     VASurfaceAttribMinWidth,
  668.     /** \brief Maximal width in pixels (int, read-only). */
  669.     VASurfaceAttribMaxWidth,
  670.     /** \brief Minimal height in pixels (int, read-only). */
  671.     VASurfaceAttribMinHeight,
  672.     /** \brief Maximal height in pixels (int, read-only). */
  673.     VASurfaceAttribMaxHeight,
  674.     /** \brief Surface memory type expressed in bit fields (int, read/write). */
  675.     VASurfaceAttribMemoryType,
  676.     /** \brief External buffer descriptor (pointer, write). */
  677.     VASurfaceAttribExternalBufferDescriptor,
  678.     /** \brief Surface usage hint, gives the driver a hint of intended usage
  679.      *  to optimize allocation (e.g. tiling) (int, read/write). */
  680.     VASurfaceAttribUsageHint,
  681.     /** \brief Number of surface attributes. */
  682.     VASurfaceAttribCount
  683. } VASurfaceAttribType;
  684.  
  685. /** \brief Surface attribute. */
  686. typedef struct _VASurfaceAttrib {
  687.     /** \brief Type. */
  688.     VASurfaceAttribType type;
  689.     /** \brief Flags. See "Surface attribute flags". */
  690.     unsigned int        flags;
  691.     /** \brief Value. See "Surface attribute types" for the expected types. */
  692.     VAGenericValue      value;
  693. } VASurfaceAttrib;
  694.  
  695. /**
  696.  * @name VASurfaceAttribMemoryType values in bit fields.
  697.  * Bit 0:7 are reserved for generic types, Bit 31:28 are reserved for
  698.  * Linux DRM, Bit 23:20 are reserved for Android. DRM and Android specific
  699.  * types are defined in DRM and Android header files.
  700.  */
  701. /**@{*/
  702. /** \brief VA memory type (default) is supported. */
  703. #define VA_SURFACE_ATTRIB_MEM_TYPE_VA                   0x00000001
  704. /** \brief V4L2 buffer memory type is supported. */
  705. #define VA_SURFACE_ATTRIB_MEM_TYPE_V4L2                 0x00000002
  706. /** \brief User pointer memory type is supported. */
  707. #define VA_SURFACE_ATTRIB_MEM_TYPE_USER_PTR             0x00000004
  708. /**@}*/
  709.  
  710. /**
  711.  * \brief VASurfaceAttribExternalBuffers structure for
  712.  * the VASurfaceAttribExternalBufferDescriptor attribute.
  713.  */
  714. typedef struct _VASurfaceAttribExternalBuffers {
  715.     /** \brief pixel format in fourcc. */
  716.     unsigned int pixel_format;
  717.     /** \brief width in pixels. */
  718.     unsigned int width;
  719.     /** \brief height in pixels. */
  720.     unsigned int height;
  721.     /** \brief total size of the buffer in bytes. */
  722.     unsigned int data_size;
  723.     /** \brief number of planes for planar layout */
  724.     unsigned int num_planes;
  725.     /** \brief pitch for each plane in bytes */
  726.     unsigned int pitches[4];
  727.     /** \brief offset for each plane in bytes */
  728.     unsigned int offsets[4];
  729.     /** \brief buffer handles or user pointers */
  730.     unsigned long *buffers;
  731.     /** \brief number of elements in the "buffers" array */
  732.     unsigned int num_buffers;
  733.     /** \brief flags. See "Surface external buffer descriptor flags". */
  734.     unsigned int flags;
  735.     /** \brief reserved for passing private data */
  736.     void *private_data;
  737. } VASurfaceAttribExternalBuffers;
  738.  
  739. /** @name VASurfaceAttribExternalBuffers flags */
  740. /**@{*/
  741. /** \brief Enable memory tiling */
  742. #define VA_SURFACE_EXTBUF_DESC_ENABLE_TILING    0x00000001
  743. /** \brief Memory is cacheable */
  744. #define VA_SURFACE_EXTBUF_DESC_CACHED           0x00000002
  745. /** \brief Memory is non-cacheable */
  746. #define VA_SURFACE_EXTBUF_DESC_UNCACHED         0x00000004
  747. /** \brief Memory is write-combined */
  748. #define VA_SURFACE_EXTBUF_DESC_WC               0x00000008
  749. /** \brief Memory is protected */
  750. #define VA_SURFACE_EXTBUF_DESC_PROTECTED        0x80000000
  751.  
  752. /** @name VASurfaceAttribUsageHint attribute usage hint flags */
  753. /**@{*/
  754. /** \brief Surface usage not indicated. */
  755. #define VA_SURFACE_ATTRIB_USAGE_HINT_GENERIC    0x00000000
  756. /** \brief Surface used by video decoder. */
  757. #define VA_SURFACE_ATTRIB_USAGE_HINT_DECODER    0x00000001
  758. /** \brief Surface used by video encoder. */
  759. #define VA_SURFACE_ATTRIB_USAGE_HINT_ENCODER    0x00000002
  760. /** \brief Surface read by video post-processing. */
  761. #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_READ   0x00000004
  762. /** \brief Surface written by video post-processing. */
  763. #define VA_SURFACE_ATTRIB_USAGE_HINT_VPP_WRITE  0x00000008
  764. /** \brief Surface used for display. */
  765. #define VA_SURFACE_ATTRIB_USAGE_HINT_DISPLAY    0x00000010
  766.  
  767. /**@}*/
  768.  
  769. /**
  770.  * \brief Queries surface attributes for the supplied config.
  771.  *
  772.  * Unlike vaGetSurfaceAttributes(), this function queries for all
  773.  * supported attributes for the supplied VA @config. In particular, if
  774.  * the underlying hardware supports the creation of VA surfaces in
  775.  * various formats, then this function will enumerate all pixel
  776.  * formats that are supported.
  777.  *
  778.  * The \c attrib_list array is allocated by the user and \c
  779.  * num_attribs shall be initialized to the number of allocated
  780.  * elements in that array. Upon successful return, the actual number
  781.  * of attributes will be overwritten into \c num_attribs. Otherwise,
  782.  * \c VA_STATUS_ERROR_MAX_NUM_EXCEEDED is returned and \c num_attribs
  783.  * is adjusted to the number of elements that would be returned if
  784.  * enough space was available.
  785.  *
  786.  * Note: it is perfectly valid to pass NULL to the \c attrib_list
  787.  * argument when vaQuerySurfaceAttributes() is used to determine the
  788.  * actual number of elements that need to be allocated.
  789.  *
  790.  * @param[in] dpy               the VA display
  791.  * @param[in] config            the config identifying a codec or a video
  792.  *     processing pipeline
  793.  * @param[out] attrib_list      the output array of #VASurfaceAttrib elements
  794.  * @param[in,out] num_attribs   the number of elements allocated on
  795.  *      input, the number of elements actually filled in output
  796.  */
  797. VAStatus
  798. vaQuerySurfaceAttributes(
  799.     VADisplay           dpy,
  800.     VAConfigID          config,
  801.     VASurfaceAttrib    *attrib_list,
  802.     unsigned int       *num_attribs
  803. );
  804.  
  805. /**
  806.  * \brief Creates an array of surfaces
  807.  *
  808.  * Creates an array of surfaces. The optional list of attributes shall
  809.  * be constructed and validated through vaGetSurfaceAttributes() or
  810.  * constructed based based on what the underlying hardware could
  811.  * expose through vaQuerySurfaceAttributes().
  812.  *
  813.  * @param[in] dpy               the VA display
  814.  * @param[in] format            the desired surface format. See \c VA_RT_FORMAT_*
  815.  * @param[in] width             the surface width
  816.  * @param[in] height            the surface height
  817.  * @param[out] surfaces         the array of newly created surfaces
  818.  * @param[in] num_surfaces      the number of surfaces to create
  819.  * @param[in] attrib_list       the list of (optional) attributes, or \c NULL
  820.  * @param[in] num_attribs       the number of attributes supplied in
  821.  *     \c attrib_list, or zero
  822.  */
  823. VAStatus
  824. vaCreateSurfaces(
  825.     VADisplay           dpy,
  826.     unsigned int        format,
  827.     unsigned int        width,
  828.     unsigned int        height,
  829.     VASurfaceID        *surfaces,
  830.     unsigned int        num_surfaces,
  831.     VASurfaceAttrib    *attrib_list,
  832.     unsigned int        num_attribs
  833. );
  834.    
  835. /**
  836.  * vaDestroySurfaces - Destroy resources associated with surfaces.
  837.  *  Surfaces can only be destroyed after the context associated has been
  838.  *  destroyed.  
  839.  *  dpy: display
  840.  *  surfaces: array of surfaces to destroy
  841.  *  num_surfaces: number of surfaces in the array to be destroyed.
  842.  */
  843. VAStatus vaDestroySurfaces (
  844.     VADisplay dpy,
  845.     VASurfaceID *surfaces,
  846.     int num_surfaces
  847. );
  848.  
  849. #define VA_PROGRESSIVE 0x1
  850. /**
  851.  * vaCreateContext - Create a context
  852.  *  dpy: display
  853.  *  config_id: configuration for the context
  854.  *  picture_width: coded picture width
  855.  *  picture_height: coded picture height
  856.  *  flag: any combination of the following:
  857.  *    VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
  858.  *  render_targets: render targets (surfaces) tied to the context
  859.  *  num_render_targets: number of render targets in the above array
  860.  *  context: created context id upon return
  861.  */
  862. VAStatus vaCreateContext (
  863.     VADisplay dpy,
  864.     VAConfigID config_id,
  865.     int picture_width,
  866.     int picture_height,
  867.     int flag,
  868.     VASurfaceID *render_targets,
  869.     int num_render_targets,
  870.     VAContextID *context                /* out */
  871. );
  872.  
  873. /**
  874.  * vaDestroyContext - Destroy a context
  875.  *  dpy: display
  876.  *  context: context to be destroyed
  877.  */
  878. VAStatus vaDestroyContext (
  879.     VADisplay dpy,
  880.     VAContextID context
  881. );
  882.  
  883. /**
  884.  * Buffers
  885.  * Buffers are used to pass various types of data from the
  886.  * client to the server. The server maintains a data store
  887.  * for each buffer created, and the client idenfies a buffer
  888.  * through a unique buffer id assigned by the server.
  889.  */
  890.  
  891. typedef VAGenericID VABufferID;
  892.  
  893. typedef enum
  894. {
  895.     VAPictureParameterBufferType        = 0,
  896.     VAIQMatrixBufferType                = 1,
  897.     VABitPlaneBufferType                = 2,
  898.     VASliceGroupMapBufferType           = 3,
  899.     VASliceParameterBufferType          = 4,
  900.     VASliceDataBufferType               = 5,
  901.     VAMacroblockParameterBufferType     = 6,
  902.     VAResidualDataBufferType            = 7,
  903.     VADeblockingParameterBufferType     = 8,
  904.     VAImageBufferType                   = 9,
  905.     VAProtectedSliceDataBufferType      = 10,
  906.     VAQMatrixBufferType                 = 11,
  907.     VAHuffmanTableBufferType            = 12,
  908.     VAProbabilityBufferType             = 13,
  909.  
  910. /* Following are encode buffer types */
  911.     VAEncCodedBufferType                = 21,
  912.     VAEncSequenceParameterBufferType    = 22,
  913.     VAEncPictureParameterBufferType     = 23,
  914.     VAEncSliceParameterBufferType       = 24,
  915.     VAEncPackedHeaderParameterBufferType = 25,
  916.     VAEncPackedHeaderDataBufferType     = 26,
  917.     VAEncMiscParameterBufferType        = 27,
  918.     VAEncMacroblockParameterBufferType  = 28,
  919.     VAEncMacroblockMapBufferType        = 29,
  920. /* Following are video processing buffer types */
  921.     /**
  922.      * \brief Video processing pipeline parameter buffer.
  923.      *
  924.      * This buffer describes the video processing pipeline. See
  925.      * #VAProcPipelineParameterBuffer for details.
  926.      */
  927.     VAProcPipelineParameterBufferType   = 41,
  928.     /**
  929.      * \brief Video filter parameter buffer.
  930.      *
  931.      * This buffer describes the video filter parameters. All buffers
  932.      * inherit from #VAProcFilterParameterBufferBase, thus including
  933.      * a unique filter buffer type.
  934.      *
  935.      * The default buffer used by most filters is #VAProcFilterParameterBuffer.
  936.      * Filters requiring advanced parameters include, but are not limited to,
  937.      * deinterlacing (#VAProcFilterParameterBufferDeinterlacing),
  938.      * color balance (#VAProcFilterParameterBufferColorBalance), etc.
  939.      */
  940.     VAProcFilterParameterBufferType     = 42,
  941.     VABufferTypeMax
  942. } VABufferType;
  943.  
  944. typedef enum
  945. {
  946.     VAEncMiscParameterTypeFrameRate     = 0,
  947.     VAEncMiscParameterTypeRateControl   = 1,
  948.     VAEncMiscParameterTypeMaxSliceSize  = 2,
  949.     VAEncMiscParameterTypeAIR           = 3,
  950.     /** \brief Buffer type used to express a maximum frame size (in bits). */
  951.     VAEncMiscParameterTypeMaxFrameSize  = 4,
  952.     /** \brief Buffer type used for HRD parameters. */
  953.     VAEncMiscParameterTypeHRD           = 5,
  954.     VAEncMiscParameterTypeQualityLevel  = 6,
  955. } VAEncMiscParameterType;
  956.  
  957. /** \brief Packed header type. */
  958. typedef enum {
  959.     /** \brief Packed sequence header. */
  960.     VAEncPackedHeaderSequence   = 1,
  961.     /** \brief Packed picture header. */
  962.     VAEncPackedHeaderPicture    = 2,
  963.     /** \brief Packed slice header. */
  964.     VAEncPackedHeaderSlice      = 3,
  965.     /**
  966.      * \brief Packed raw header.
  967.      *
  968.      * Packed raw data header can be used by the client to insert a header  
  969.      * into the bitstream data buffer at the point it is passed, the driver
  970.      * will handle the raw packed header based on "has_emulation_bytes" field
  971.      * in the packed header parameter structure.
  972.      */
  973.     VAEncPackedHeaderRawData    = 4,
  974.     /** \brief Misc packed header. See codec-specific definitions. */
  975.     VAEncPackedHeaderMiscMask   = 0x80000000,
  976. } VAEncPackedHeaderType;
  977.  
  978. /** \brief Packed header parameter. */
  979. typedef struct _VAEncPackedHeaderParameterBuffer {
  980.     /** Type of the packed header buffer. See #VAEncPackedHeaderType. */
  981.     unsigned int                type;
  982.     /** \brief Size of the #VAEncPackedHeaderDataBuffer in bits. */
  983.     unsigned int                bit_length;
  984.     /** \brief Flag: buffer contains start code emulation prevention bytes? */
  985.     unsigned char               has_emulation_bytes;
  986. } VAEncPackedHeaderParameterBuffer;
  987.  
  988. /**
  989.  *  For application, e.g. set a new bitrate
  990.  *    VABufferID buf_id;
  991.  *    VAEncMiscParameterBuffer *misc_param;
  992.  *    VAEncMiscParameterRateControl *misc_rate_ctrl;
  993.  *
  994.  *    vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
  995.  *              sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
  996.  *              1, NULL, &buf_id);
  997.  *
  998.  *    vaMapBuffer(dpy,buf_id,(void **)&misc_param);
  999.  *    misc_param->type = VAEncMiscParameterTypeRateControl;
  1000.  *    misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
  1001.  *    misc_rate_ctrl->bits_per_second = 6400000;
  1002.  *    vaUnmapBuffer(dpy, buf_id);
  1003.  *    vaRenderPicture(dpy, context, &buf_id, 1);
  1004.  */
  1005. typedef struct _VAEncMiscParameterBuffer
  1006. {
  1007.     VAEncMiscParameterType type;
  1008.     unsigned int data[0];
  1009. } VAEncMiscParameterBuffer;
  1010.  
  1011.  
  1012. /** \brief Rate control parameters */
  1013. typedef struct _VAEncMiscParameterRateControl
  1014. {
  1015.     /* this is the maximum bit-rate to be constrained by the rate control implementation */
  1016.     unsigned int bits_per_second;
  1017.     /* this is the bit-rate the rate control is targeting, as a percentage of the maximum
  1018.      * bit-rate for example if target_percentage is 95 then the rate control will target
  1019.      * a bit-rate that is 95% of the maximum bit-rate
  1020.      */
  1021.     unsigned int target_percentage;
  1022.     /* windows size in milliseconds. For example if this is set to 500,
  1023.      * then the rate control will guarantee the target bit-rate over a 500 ms window
  1024.      */
  1025.     unsigned int window_size;
  1026.     /* initial QP at I frames */
  1027.     unsigned int initial_qp;
  1028.     unsigned int min_qp;
  1029.     unsigned int basic_unit_size;
  1030.     union
  1031.     {
  1032.         struct
  1033.         {
  1034.             unsigned int reset : 1;
  1035.             unsigned int disable_frame_skip : 1; /* Disable frame skip in rate control mode */
  1036.             unsigned int disable_bit_stuffing : 1; /* Disable bit stuffing in rate control mode */
  1037.         } bits;
  1038.         unsigned int value;
  1039.     } rc_flags;
  1040. } VAEncMiscParameterRateControl;
  1041.  
  1042. typedef struct _VAEncMiscParameterFrameRate
  1043. {
  1044.     unsigned int framerate;
  1045. } VAEncMiscParameterFrameRate;
  1046.  
  1047. /**
  1048.  * Allow a maximum slice size to be specified (in bits).
  1049.  * The encoder will attempt to make sure that individual slices do not exceed this size
  1050.  * Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
  1051.  */
  1052. typedef struct _VAEncMiscParameterMaxSliceSize
  1053. {
  1054.     unsigned int max_slice_size;
  1055. } VAEncMiscParameterMaxSliceSize;
  1056.  
  1057. typedef struct _VAEncMiscParameterAIR
  1058. {
  1059.     unsigned int air_num_mbs;
  1060.     unsigned int air_threshold;
  1061.     unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
  1062. } VAEncMiscParameterAIR;
  1063.  
  1064. typedef struct _VAEncMiscParameterHRD
  1065. {
  1066.     unsigned int initial_buffer_fullness;       /* in bits */
  1067.     unsigned int buffer_size;                   /* in bits */
  1068. } VAEncMiscParameterHRD;
  1069.  
  1070. /**
  1071.  * \brief Defines a maximum frame size (in bits).
  1072.  *
  1073.  * This misc parameter buffer defines the maximum size of a frame (in
  1074.  * bits). The encoder will try to make sure that each frame does not
  1075.  * exceed this size. Otherwise, if the frame size exceeds this size,
  1076.  * the \c status flag of #VACodedBufferSegment will contain
  1077.  * #VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW.
  1078.  */
  1079. typedef struct _VAEncMiscParameterBufferMaxFrameSize {
  1080.     /** \brief Type. Shall be set to #VAEncMiscParameterTypeMaxFrameSize. */
  1081.     VAEncMiscParameterType      type;
  1082.     /** \brief Maximum size of a frame (in bits). */
  1083.     unsigned int                max_frame_size;
  1084. } VAEncMiscParameterBufferMaxFrameSize;
  1085.  
  1086. /**
  1087.  * \brief Encoding quality level.
  1088.  *
  1089.  * The encoding quality could be set through this structure, if the implementation  
  1090.  * supports multiple quality levels. The quality level set through this structure is
  1091.  * persistent over the entire coded sequence, or until a new structure is being sent.
  1092.  * The quality level range can be queried through the VAConfigAttribEncQualityRange
  1093.  * attribute. A lower value means higher quality, and a value of 1 represents the highest
  1094.  * quality. The quality level setting is used as a trade-off between quality and speed/power
  1095.  * consumption, with higher quality corresponds to lower speed and higher power consumption.
  1096.  */
  1097. typedef struct _VAEncMiscParameterBufferQualityLevel {
  1098.     /** \brief Encoding quality level setting. When set to 0, default quality
  1099.      * level is used.
  1100.      */
  1101.     unsigned int                quality_level;
  1102. } VAEncMiscParameterBufferQualityLevel;
  1103.  
  1104. /*
  1105.  * There will be cases where the bitstream buffer will not have enough room to hold
  1106.  * the data for the entire slice, and the following flags will be used in the slice
  1107.  * parameter to signal to the server for the possible cases.
  1108.  * If a slice parameter buffer and slice data buffer pair is sent to the server with
  1109.  * the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
  1110.  * then a slice parameter and data buffer needs to be sent again to complete this slice.
  1111.  */
  1112. #define VA_SLICE_DATA_FLAG_ALL          0x00    /* whole slice is in the buffer */
  1113. #define VA_SLICE_DATA_FLAG_BEGIN        0x01    /* The beginning of the slice is in the buffer but the end if not */
  1114. #define VA_SLICE_DATA_FLAG_MIDDLE       0x02    /* Neither beginning nor end of the slice is in the buffer */
  1115. #define VA_SLICE_DATA_FLAG_END          0x04    /* end of the slice is in the buffer */
  1116.  
  1117. /* Codec-independent Slice Parameter Buffer base */
  1118. typedef struct _VASliceParameterBufferBase
  1119. {
  1120.     unsigned int slice_data_size;       /* number of bytes in the slice data buffer for this slice */
  1121.     unsigned int slice_data_offset;     /* the offset to the first byte of slice data */
  1122.     unsigned int slice_data_flag;       /* see VA_SLICE_DATA_FLAG_XXX definitions */
  1123. } VASliceParameterBufferBase;
  1124.  
  1125.  
  1126. /****************************
  1127.  * JEPG data structure
  1128.  ***************************/
  1129. typedef struct _VAQMatrixBufferJPEG
  1130. {
  1131.     int load_lum_quantiser_matrix;
  1132.     int load_chroma_quantiser_matrix;
  1133.     unsigned char lum_quantiser_matrix[64];
  1134.     unsigned char chroma_quantiser_matrix[64];
  1135. } VAQMatrixBufferJPEG;
  1136.  
  1137. typedef struct _VAEncPictureParameterBufferJPEG
  1138. {
  1139.     VASurfaceID reconstructed_picture;
  1140.     unsigned short picture_width;
  1141.     unsigned short picture_height;
  1142.     VABufferID coded_buf;
  1143. } VAEncPictureParameterBufferJPEG;
  1144.  
  1145. #include <va/va_dec_jpeg.h>
  1146.  
  1147. /****************************
  1148.  * MPEG-2 data structures
  1149.  ****************************/
  1150.  
  1151. /* MPEG-2 Picture Parameter Buffer */
  1152. /*
  1153.  * For each frame or field, and before any slice data, a single
  1154.  * picture parameter buffer must be send.
  1155.  */
  1156. typedef struct _VAPictureParameterBufferMPEG2
  1157. {
  1158.     unsigned short horizontal_size;
  1159.     unsigned short vertical_size;
  1160.     VASurfaceID forward_reference_picture;
  1161.     VASurfaceID backward_reference_picture;
  1162.     /* meanings of the following fields are the same as in the standard */
  1163.     int picture_coding_type;
  1164.     int f_code; /* pack all four fcode into this */
  1165.     union {
  1166.         struct {
  1167.             unsigned int intra_dc_precision             : 2;
  1168.             unsigned int picture_structure              : 2;
  1169.             unsigned int top_field_first                : 1;
  1170.             unsigned int frame_pred_frame_dct           : 1;
  1171.             unsigned int concealment_motion_vectors     : 1;
  1172.             unsigned int q_scale_type                   : 1;
  1173.             unsigned int intra_vlc_format               : 1;
  1174.             unsigned int alternate_scan                 : 1;
  1175.             unsigned int repeat_first_field             : 1;
  1176.             unsigned int progressive_frame              : 1;
  1177.             unsigned int is_first_field                 : 1; /* indicate whether the current field
  1178.                                                               * is the first field for field picture
  1179.                                                               */
  1180.         } bits;
  1181.         unsigned int value;
  1182.     } picture_coding_extension;
  1183. } VAPictureParameterBufferMPEG2;
  1184.  
  1185. /** MPEG-2 Inverse Quantization Matrix Buffer */
  1186. typedef struct _VAIQMatrixBufferMPEG2
  1187. {
  1188.     /** \brief Same as the MPEG-2 bitstream syntax element. */
  1189.     int load_intra_quantiser_matrix;
  1190.     /** \brief Same as the MPEG-2 bitstream syntax element. */
  1191.     int load_non_intra_quantiser_matrix;
  1192.     /** \brief Same as the MPEG-2 bitstream syntax element. */
  1193.     int load_chroma_intra_quantiser_matrix;
  1194.     /** \brief Same as the MPEG-2 bitstream syntax element. */
  1195.     int load_chroma_non_intra_quantiser_matrix;
  1196.     /** \brief Luminance intra matrix, in zig-zag scan order. */
  1197.     unsigned char intra_quantiser_matrix[64];
  1198.     /** \brief Luminance non-intra matrix, in zig-zag scan order. */
  1199.     unsigned char non_intra_quantiser_matrix[64];
  1200.     /** \brief Chroma intra matrix, in zig-zag scan order. */
  1201.     unsigned char chroma_intra_quantiser_matrix[64];
  1202.     /** \brief Chroma non-intra matrix, in zig-zag scan order. */
  1203.     unsigned char chroma_non_intra_quantiser_matrix[64];
  1204. } VAIQMatrixBufferMPEG2;
  1205.  
  1206. /** MPEG-2 Slice Parameter Buffer */
  1207. typedef struct _VASliceParameterBufferMPEG2
  1208. {
  1209.     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
  1210.     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
  1211.     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
  1212.     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
  1213.     unsigned int slice_horizontal_position;
  1214.     unsigned int slice_vertical_position;
  1215.     int quantiser_scale_code;
  1216.     int intra_slice_flag;
  1217. } VASliceParameterBufferMPEG2;
  1218.  
  1219. /** MPEG-2 Macroblock Parameter Buffer */
  1220. typedef struct _VAMacroblockParameterBufferMPEG2
  1221. {
  1222.     unsigned short macroblock_address;
  1223.     /*
  1224.      * macroblock_address (in raster scan order)
  1225.      * top-left: 0
  1226.      * bottom-right: picture-height-in-mb*picture-width-in-mb - 1
  1227.      */
  1228.     unsigned char macroblock_type;  /* see definition below */
  1229.     union {
  1230.         struct {
  1231.             unsigned int frame_motion_type              : 2;
  1232.             unsigned int field_motion_type              : 2;
  1233.             unsigned int dct_type                       : 1;
  1234.         } bits;
  1235.         unsigned int value;
  1236.     } macroblock_modes;
  1237.     unsigned char motion_vertical_field_select;
  1238.     /*
  1239.      * motion_vertical_field_select:
  1240.      * see section 6.3.17.2 in the spec
  1241.      * only the lower 4 bits are used
  1242.      * bit 0: first vector forward
  1243.      * bit 1: first vector backward
  1244.      * bit 2: second vector forward
  1245.      * bit 3: second vector backward
  1246.      */
  1247.     short PMV[2][2][2]; /* see Table 7-7 in the spec */
  1248.     unsigned short coded_block_pattern;
  1249.     /*
  1250.      * The bitplanes for coded_block_pattern are described
  1251.      * in Figure 6.10-12 in the spec
  1252.      */
  1253.      
  1254.     /* Number of skipped macroblocks after this macroblock */
  1255.     unsigned short num_skipped_macroblocks;
  1256. } VAMacroblockParameterBufferMPEG2;
  1257.  
  1258. /*
  1259.  * OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
  1260.  */
  1261. #define VA_MB_TYPE_MOTION_FORWARD       0x02
  1262. #define VA_MB_TYPE_MOTION_BACKWARD      0x04
  1263. #define VA_MB_TYPE_MOTION_PATTERN       0x08
  1264. #define VA_MB_TYPE_MOTION_INTRA         0x10
  1265.  
  1266. /**
  1267.  * MPEG-2 Residual Data Buffer
  1268.  * For each macroblock, there wil be 64 shorts (16-bit) in the
  1269.  * residual data buffer
  1270.  */
  1271.  
  1272. /****************************
  1273.  * MPEG-4 Part 2 data structures
  1274.  ****************************/
  1275.  
  1276. /* MPEG-4 Picture Parameter Buffer */
  1277. /*
  1278.  * For each frame or field, and before any slice data, a single
  1279.  * picture parameter buffer must be send.
  1280.  */
  1281. typedef struct _VAPictureParameterBufferMPEG4
  1282. {
  1283.     unsigned short vop_width;
  1284.     unsigned short vop_height;
  1285.     VASurfaceID forward_reference_picture;
  1286.     VASurfaceID backward_reference_picture;
  1287.     union {
  1288.         struct {
  1289.             unsigned int short_video_header             : 1;
  1290.             unsigned int chroma_format                  : 2;
  1291.             unsigned int interlaced                     : 1;
  1292.             unsigned int obmc_disable                   : 1;
  1293.             unsigned int sprite_enable                  : 2;
  1294.             unsigned int sprite_warping_accuracy        : 2;
  1295.             unsigned int quant_type                     : 1;
  1296.             unsigned int quarter_sample                 : 1;
  1297.             unsigned int data_partitioned               : 1;
  1298.             unsigned int reversible_vlc                 : 1;
  1299.             unsigned int resync_marker_disable          : 1;
  1300.         } bits;
  1301.         unsigned int value;
  1302.     } vol_fields;
  1303.     unsigned char no_of_sprite_warping_points;
  1304.     short sprite_trajectory_du[3];
  1305.     short sprite_trajectory_dv[3];
  1306.     unsigned char quant_precision;
  1307.     union {
  1308.         struct {
  1309.             unsigned int vop_coding_type                : 2;
  1310.             unsigned int backward_reference_vop_coding_type     : 2;
  1311.             unsigned int vop_rounding_type              : 1;
  1312.             unsigned int intra_dc_vlc_thr               : 3;
  1313.             unsigned int top_field_first                : 1;
  1314.             unsigned int alternate_vertical_scan_flag   : 1;
  1315.         } bits;
  1316.         unsigned int value;
  1317.     } vop_fields;
  1318.     unsigned char vop_fcode_forward;
  1319.     unsigned char vop_fcode_backward;
  1320.     unsigned short vop_time_increment_resolution;
  1321.     /* short header related */
  1322.     unsigned char num_gobs_in_vop;
  1323.     unsigned char num_macroblocks_in_gob;
  1324.     /* for direct mode prediction */
  1325.     short TRB;
  1326.     short TRD;
  1327. } VAPictureParameterBufferMPEG4;
  1328.  
  1329. /** MPEG-4 Inverse Quantization Matrix Buffer */
  1330. typedef struct _VAIQMatrixBufferMPEG4
  1331. {
  1332.     /** Same as the MPEG-4:2 bitstream syntax element. */
  1333.     int load_intra_quant_mat;
  1334.     /** Same as the MPEG-4:2 bitstream syntax element. */
  1335.     int load_non_intra_quant_mat;
  1336.     /** The matrix for intra blocks, in zig-zag scan order. */
  1337.     unsigned char intra_quant_mat[64];
  1338.     /** The matrix for non-intra blocks, in zig-zag scan order. */
  1339.     unsigned char non_intra_quant_mat[64];
  1340. } VAIQMatrixBufferMPEG4;
  1341.  
  1342. /** MPEG-4 Slice Parameter Buffer */
  1343. typedef struct _VASliceParameterBufferMPEG4
  1344. {
  1345.     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
  1346.     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
  1347.     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
  1348.     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
  1349.     unsigned int macroblock_number;
  1350.     int quant_scale;
  1351. } VASliceParameterBufferMPEG4;
  1352.  
  1353. /**
  1354.  VC-1 data structures
  1355. */
  1356.  
  1357. typedef enum   /* see 7.1.1.32 */
  1358. {
  1359.     VAMvMode1Mv                        = 0,
  1360.     VAMvMode1MvHalfPel                 = 1,
  1361.     VAMvMode1MvHalfPelBilinear         = 2,
  1362.     VAMvModeMixedMv                    = 3,
  1363.     VAMvModeIntensityCompensation      = 4
  1364. } VAMvModeVC1;
  1365.  
  1366. /** VC-1 Picture Parameter Buffer */
  1367. /*
  1368.  * For each picture, and before any slice data, a picture parameter
  1369.  * buffer must be send. Multiple picture parameter buffers may be
  1370.  * sent for a single picture. In that case picture parameters will
  1371.  * apply to all slice data that follow it until a new picture
  1372.  * parameter buffer is sent.
  1373.  *
  1374.  * Notes:
  1375.  *   pic_quantizer_type should be set to the applicable quantizer
  1376.  *   type as defined by QUANTIZER (J.1.19) and either
  1377.  *   PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
  1378.  */
  1379. typedef struct _VAPictureParameterBufferVC1
  1380. {
  1381.     VASurfaceID forward_reference_picture;
  1382.     VASurfaceID backward_reference_picture;
  1383.     /* if out-of-loop post-processing is done on the render
  1384.        target, then we need to keep the in-loop decoded
  1385.        picture as a reference picture */
  1386.     VASurfaceID inloop_decoded_picture;
  1387.  
  1388.     /* sequence layer for AP or meta data for SP and MP */
  1389.     union {
  1390.         struct {
  1391.             unsigned int pulldown       : 1; /* SEQUENCE_LAYER::PULLDOWN */
  1392.             unsigned int interlace      : 1; /* SEQUENCE_LAYER::INTERLACE */
  1393.             unsigned int tfcntrflag     : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
  1394.             unsigned int finterpflag    : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
  1395.             unsigned int psf            : 1; /* SEQUENCE_LAYER::PSF */
  1396.             unsigned int multires       : 1; /* METADATA::MULTIRES */
  1397.             unsigned int overlap        : 1; /* METADATA::OVERLAP */
  1398.             unsigned int syncmarker     : 1; /* METADATA::SYNCMARKER */
  1399.             unsigned int rangered       : 1; /* METADATA::RANGERED */
  1400.             unsigned int max_b_frames   : 3; /* METADATA::MAXBFRAMES */
  1401.             unsigned int profile        : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
  1402.         } bits;
  1403.         unsigned int value;
  1404.     } sequence_fields;
  1405.  
  1406.     unsigned short coded_width;         /* ENTRY_POINT_LAYER::CODED_WIDTH */
  1407.     unsigned short coded_height;        /* ENTRY_POINT_LAYER::CODED_HEIGHT */
  1408.     union {
  1409.         struct {
  1410.             unsigned int broken_link    : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
  1411.             unsigned int closed_entry   : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
  1412.             unsigned int panscan_flag   : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
  1413.             unsigned int loopfilter     : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
  1414.         } bits;
  1415.         unsigned int value;
  1416.     } entrypoint_fields;
  1417.     unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
  1418.     unsigned char fast_uvmc_flag;       /* ENTRY_POINT_LAYER::FASTUVMC */
  1419.     union {
  1420.         struct {
  1421.             unsigned int luma_flag      : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
  1422.             unsigned int luma           : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
  1423.             unsigned int chroma_flag    : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
  1424.             unsigned int chroma         : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
  1425.         } bits;
  1426.         unsigned int value;
  1427.     } range_mapping_fields;
  1428.  
  1429.     unsigned char b_picture_fraction;   /* PICTURE_LAYER::BFRACTION */
  1430.     unsigned char cbp_table;            /* PICTURE_LAYER::CBPTAB/ICBPTAB */
  1431.     unsigned char mb_mode_table;        /* PICTURE_LAYER::MBMODETAB */
  1432.     unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
  1433.     unsigned char rounding_control;     /* PICTURE_LAYER::RNDCTRL */
  1434.     unsigned char post_processing;      /* PICTURE_LAYER::POSTPROC */
  1435.     unsigned char picture_resolution_index;     /* PICTURE_LAYER::RESPIC */
  1436.     unsigned char luma_scale;           /* PICTURE_LAYER::LUMSCALE */
  1437.     unsigned char luma_shift;           /* PICTURE_LAYER::LUMSHIFT */
  1438.     union {
  1439.         struct {
  1440.             unsigned int picture_type           : 3; /* PICTURE_LAYER::PTYPE */
  1441.             unsigned int frame_coding_mode      : 3; /* PICTURE_LAYER::FCM */
  1442.             unsigned int top_field_first        : 1; /* PICTURE_LAYER::TFF */
  1443.             unsigned int is_first_field         : 1; /* set to 1 if it is the first field */
  1444.             unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
  1445.         } bits;
  1446.         unsigned int value;
  1447.     } picture_fields;
  1448.     union {
  1449.         struct {
  1450.             unsigned int mv_type_mb     : 1;    /* PICTURE::MVTYPEMB */
  1451.             unsigned int direct_mb      : 1;    /* PICTURE::DIRECTMB */
  1452.             unsigned int skip_mb        : 1;    /* PICTURE::SKIPMB */
  1453.             unsigned int field_tx       : 1;    /* PICTURE::FIELDTX */
  1454.             unsigned int forward_mb     : 1;    /* PICTURE::FORWARDMB */
  1455.             unsigned int ac_pred        : 1;    /* PICTURE::ACPRED */
  1456.             unsigned int overflags      : 1;    /* PICTURE::OVERFLAGS */
  1457.         } flags;
  1458.         unsigned int value;
  1459.     } raw_coding;
  1460.     union {
  1461.         struct {
  1462.             unsigned int bp_mv_type_mb   : 1;    /* PICTURE::MVTYPEMB */
  1463.             unsigned int bp_direct_mb    : 1;    /* PICTURE::DIRECTMB */
  1464.             unsigned int bp_skip_mb      : 1;    /* PICTURE::SKIPMB */  
  1465.             unsigned int bp_field_tx     : 1;    /* PICTURE::FIELDTX */
  1466.             unsigned int bp_forward_mb   : 1;    /* PICTURE::FORWARDMB */
  1467.             unsigned int bp_ac_pred      : 1;    /* PICTURE::ACPRED */  
  1468.             unsigned int bp_overflags    : 1;    /* PICTURE::OVERFLAGS */
  1469.         } flags;
  1470.         unsigned int value;
  1471.     } bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
  1472.     union {
  1473.         struct {
  1474.             unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
  1475.             unsigned int reference_distance     : 5;/* PICTURE_LAYER::REFDIST */
  1476.             unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
  1477.             unsigned int reference_field_pic_indicator  : 1;/* PICTURE_LAYER::REFFIELD */
  1478.         } bits;
  1479.         unsigned int value;
  1480.     } reference_fields;
  1481.     union {
  1482.         struct {
  1483.             unsigned int mv_mode                : 3; /* PICTURE_LAYER::MVMODE */
  1484.             unsigned int mv_mode2               : 3; /* PICTURE_LAYER::MVMODE2 */
  1485.             unsigned int mv_table               : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
  1486.             unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
  1487.             unsigned int four_mv_switch         : 1; /* PICTURE_LAYER::4MVSWITCH */
  1488.             unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
  1489.             unsigned int extended_mv_flag       : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
  1490.             unsigned int extended_mv_range      : 2; /* PICTURE_LAYER::MVRANGE */
  1491.             unsigned int extended_dmv_flag      : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
  1492.             unsigned int extended_dmv_range     : 2; /* PICTURE_LAYER::DMVRANGE */
  1493.         } bits;
  1494.         unsigned int value;
  1495.     } mv_fields;
  1496.     union {
  1497.         struct {
  1498.             unsigned int dquant : 2;    /* ENTRY_POINT_LAYER::DQUANT */
  1499.             unsigned int quantizer     : 2;     /* ENTRY_POINT_LAYER::QUANTIZER */
  1500.             unsigned int half_qp        : 1;    /* PICTURE_LAYER::HALFQP */
  1501.             unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
  1502.             unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
  1503.             unsigned int dq_frame       : 1;    /* VOPDQUANT::DQUANTFRM */
  1504.             unsigned int dq_profile     : 2;    /* VOPDQUANT::DQPROFILE */
  1505.             unsigned int dq_sb_edge     : 2;    /* VOPDQUANT::DQSBEDGE */
  1506.             unsigned int dq_db_edge     : 2;    /* VOPDQUANT::DQDBEDGE */
  1507.             unsigned int dq_binary_level : 1;   /* VOPDQUANT::DQBILEVEL */
  1508.             unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
  1509.         } bits;
  1510.         unsigned int value;
  1511.     } pic_quantizer_fields;
  1512.     union {
  1513.         struct {
  1514.             unsigned int variable_sized_transform_flag  : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
  1515.             unsigned int mb_level_transform_type_flag   : 1;/* PICTURE_LAYER::TTMBF */
  1516.             unsigned int frame_level_transform_type     : 2;/* PICTURE_LAYER::TTFRM */
  1517.             unsigned int transform_ac_codingset_idx1    : 2;/* PICTURE_LAYER::TRANSACFRM */
  1518.             unsigned int transform_ac_codingset_idx2    : 2;/* PICTURE_LAYER::TRANSACFRM2 */
  1519.             unsigned int intra_transform_dc_table       : 1;/* PICTURE_LAYER::TRANSDCTAB */
  1520.         } bits;
  1521.         unsigned int value;
  1522.     } transform_fields;
  1523. } VAPictureParameterBufferVC1;
  1524.  
  1525. /** VC-1 Bitplane Buffer
  1526. There will be at most three bitplanes coded in any picture header. To send
  1527. the bitplane data more efficiently, each byte is divided in two nibbles, with
  1528. each nibble carrying three bitplanes for one macroblock.  The following table
  1529. shows the bitplane data arrangement within each nibble based on the picture
  1530. type.
  1531.  
  1532. Picture Type    Bit3            Bit2            Bit1            Bit0
  1533. I or BI                         OVERFLAGS       ACPRED          FIELDTX
  1534. P                               MYTYPEMB        SKIPMB          DIRECTMB
  1535. B                               FORWARDMB       SKIPMB          DIRECTMB
  1536.  
  1537. Within each byte, the lower nibble is for the first MB and the upper nibble is
  1538. for the second MB.  E.g. the lower nibble of the first byte in the bitplane
  1539. buffer is for Macroblock #1 and the upper nibble of the first byte is for
  1540. Macroblock #2 in the first row.
  1541. */
  1542.  
  1543. /* VC-1 Slice Parameter Buffer */
  1544. typedef struct _VASliceParameterBufferVC1
  1545. {
  1546.     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
  1547.     unsigned int slice_data_offset;/* the offset to the first byte of slice data */
  1548.     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
  1549.     unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
  1550.     unsigned int slice_vertical_position;
  1551. } VASliceParameterBufferVC1;
  1552.  
  1553. /* VC-1 Slice Data Buffer */
  1554. /*
  1555. This is simplely a buffer containing raw bit-stream bytes
  1556. */
  1557.  
  1558. /****************************
  1559.  * H.264/AVC data structures
  1560.  ****************************/
  1561.  
  1562. typedef struct _VAPictureH264
  1563. {
  1564.     VASurfaceID picture_id;
  1565.     unsigned int frame_idx;
  1566.     unsigned int flags;
  1567.     signed int TopFieldOrderCnt;
  1568.     signed int BottomFieldOrderCnt;
  1569. } VAPictureH264;
  1570. /* flags in VAPictureH264 could be OR of the following */
  1571. #define VA_PICTURE_H264_INVALID                 0x00000001
  1572. #define VA_PICTURE_H264_TOP_FIELD               0x00000002
  1573. #define VA_PICTURE_H264_BOTTOM_FIELD            0x00000004
  1574. #define VA_PICTURE_H264_SHORT_TERM_REFERENCE    0x00000008
  1575. #define VA_PICTURE_H264_LONG_TERM_REFERENCE     0x00000010
  1576.  
  1577. /** H.264 Picture Parameter Buffer */
  1578. /*
  1579.  * For each picture, and before any slice data, a single
  1580.  * picture parameter buffer must be send.
  1581.  */
  1582. typedef struct _VAPictureParameterBufferH264
  1583. {
  1584.     VAPictureH264 CurrPic;
  1585.     VAPictureH264 ReferenceFrames[16];  /* in DPB */
  1586.     unsigned short picture_width_in_mbs_minus1;
  1587.     unsigned short picture_height_in_mbs_minus1;
  1588.     unsigned char bit_depth_luma_minus8;
  1589.     unsigned char bit_depth_chroma_minus8;
  1590.     unsigned char num_ref_frames;
  1591.     union {
  1592.         struct {
  1593.             unsigned int chroma_format_idc                      : 2;
  1594.             unsigned int residual_colour_transform_flag         : 1;
  1595.             unsigned int gaps_in_frame_num_value_allowed_flag   : 1;
  1596.             unsigned int frame_mbs_only_flag                    : 1;
  1597.             unsigned int mb_adaptive_frame_field_flag           : 1;
  1598.             unsigned int direct_8x8_inference_flag              : 1;
  1599.             unsigned int MinLumaBiPredSize8x8                   : 1; /* see A.3.3.2 */
  1600.             unsigned int log2_max_frame_num_minus4              : 4;
  1601.             unsigned int pic_order_cnt_type                     : 2;
  1602.             unsigned int log2_max_pic_order_cnt_lsb_minus4      : 4;
  1603.             unsigned int delta_pic_order_always_zero_flag       : 1;
  1604.         } bits;
  1605.         unsigned int value;
  1606.     } seq_fields;
  1607.     unsigned char num_slice_groups_minus1;
  1608.     unsigned char slice_group_map_type;
  1609.     unsigned short slice_group_change_rate_minus1;
  1610.     signed char pic_init_qp_minus26;
  1611.     signed char pic_init_qs_minus26;
  1612.     signed char chroma_qp_index_offset;
  1613.     signed char second_chroma_qp_index_offset;
  1614.     union {
  1615.         struct {
  1616.             unsigned int entropy_coding_mode_flag       : 1;
  1617.             unsigned int weighted_pred_flag             : 1;
  1618.             unsigned int weighted_bipred_idc            : 2;
  1619.             unsigned int transform_8x8_mode_flag        : 1;
  1620.             unsigned int field_pic_flag                 : 1;
  1621.             unsigned int constrained_intra_pred_flag    : 1;
  1622.             unsigned int pic_order_present_flag                 : 1;
  1623.             unsigned int deblocking_filter_control_present_flag : 1;
  1624.             unsigned int redundant_pic_cnt_present_flag         : 1;
  1625.             unsigned int reference_pic_flag                     : 1; /* nal_ref_idc != 0 */
  1626.         } bits;
  1627.         unsigned int value;
  1628.     } pic_fields;
  1629.     unsigned short frame_num;
  1630. } VAPictureParameterBufferH264;
  1631.  
  1632. /** H.264 Inverse Quantization Matrix Buffer */
  1633. typedef struct _VAIQMatrixBufferH264
  1634. {
  1635.     /** \brief 4x4 scaling list, in raster scan order. */
  1636.     unsigned char ScalingList4x4[6][16];
  1637.     /** \brief 8x8 scaling list, in raster scan order. */
  1638.     unsigned char ScalingList8x8[2][64];
  1639. } VAIQMatrixBufferH264;
  1640.  
  1641. /**
  1642.  * H.264 Slice Group Map Buffer
  1643.  * When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
  1644.  * A slice group map buffer should be sent for each picture if required. The buffer
  1645.  * is sent only when there is a change in the mapping values.
  1646.  * The slice group map buffer map "map units" to slice groups as specified in
  1647.  * section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
  1648.  * in raster scan order
  1649.  */
  1650.  
  1651. /** H.264 Slice Parameter Buffer */
  1652. typedef struct _VASliceParameterBufferH264
  1653. {
  1654.     unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
  1655.     /** \brief Byte offset to the NAL Header Unit for this slice. */
  1656.     unsigned int slice_data_offset;
  1657.     unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
  1658.     /**
  1659.      * \brief Bit offset from NAL Header Unit to the begining of slice_data().
  1660.      *
  1661.      * This bit offset is relative to and includes the NAL unit byte
  1662.      * and represents the number of bits parsed in the slice_header()
  1663.      * after the removal of any emulation prevention bytes in
  1664.      * there. However, the slice data buffer passed to the hardware is
  1665.      * the original bitstream, thus including any emulation prevention
  1666.      * bytes.
  1667.      */
  1668.     unsigned short slice_data_bit_offset;
  1669.     unsigned short first_mb_in_slice;
  1670.     unsigned char slice_type;
  1671.     unsigned char direct_spatial_mv_pred_flag;
  1672.     unsigned char num_ref_idx_l0_active_minus1;
  1673.     unsigned char num_ref_idx_l1_active_minus1;
  1674.     unsigned char cabac_init_idc;
  1675.     char slice_qp_delta;
  1676.     unsigned char disable_deblocking_filter_idc;
  1677.     char slice_alpha_c0_offset_div2;
  1678.     char slice_beta_offset_div2;
  1679.     VAPictureH264 RefPicList0[32];      /* See 8.2.4.2 */
  1680.     VAPictureH264 RefPicList1[32];      /* See 8.2.4.2 */
  1681.     unsigned char luma_log2_weight_denom;
  1682.     unsigned char chroma_log2_weight_denom;
  1683.     unsigned char luma_weight_l0_flag;
  1684.     short luma_weight_l0[32];
  1685.     short luma_offset_l0[32];
  1686.     unsigned char chroma_weight_l0_flag;
  1687.     short chroma_weight_l0[32][2];
  1688.     short chroma_offset_l0[32][2];
  1689.     unsigned char luma_weight_l1_flag;
  1690.     short luma_weight_l1[32];
  1691.     short luma_offset_l1[32];
  1692.     unsigned char chroma_weight_l1_flag;
  1693.     short chroma_weight_l1[32][2];
  1694.     short chroma_offset_l1[32][2];
  1695. } VASliceParameterBufferH264;
  1696.  
  1697. /****************************
  1698.  * Common encode data structures
  1699.  ****************************/
  1700. typedef enum
  1701. {
  1702.     VAEncPictureTypeIntra               = 0,
  1703.     VAEncPictureTypePredictive          = 1,
  1704.     VAEncPictureTypeBidirectional       = 2,
  1705. } VAEncPictureType;
  1706.  
  1707. /* Encode Slice Parameter Buffer */
  1708. typedef struct _VAEncSliceParameterBuffer
  1709. {
  1710.     unsigned int start_row_number;      /* starting MB row number for this slice */
  1711.     unsigned int slice_height;  /* slice height measured in MB */
  1712.     union {
  1713.         struct {
  1714.             unsigned int is_intra       : 1;
  1715.             unsigned int disable_deblocking_filter_idc : 2;
  1716.             unsigned int uses_long_term_ref             :1;
  1717.             unsigned int is_long_term_ref               :1;
  1718.         } bits;
  1719.         unsigned int value;
  1720.     } slice_flags;
  1721. } VAEncSliceParameterBuffer;
  1722.  
  1723.  
  1724. /****************************
  1725.  * H.263 specific encode data structures
  1726.  ****************************/
  1727.  
  1728. typedef struct _VAEncSequenceParameterBufferH263
  1729. {
  1730.     unsigned int intra_period;
  1731.     unsigned int bits_per_second;
  1732.     unsigned int frame_rate;
  1733.     unsigned int initial_qp;
  1734.     unsigned int min_qp;
  1735. } VAEncSequenceParameterBufferH263;
  1736.  
  1737. typedef struct _VAEncPictureParameterBufferH263
  1738. {
  1739.     VASurfaceID reference_picture;
  1740.     VASurfaceID reconstructed_picture;
  1741.     VABufferID coded_buf;
  1742.     unsigned short picture_width;
  1743.     unsigned short picture_height;
  1744.     VAEncPictureType picture_type;
  1745. } VAEncPictureParameterBufferH263;
  1746.  
  1747. /****************************
  1748.  * MPEG-4 specific encode data structures
  1749.  ****************************/
  1750.  
  1751. typedef struct _VAEncSequenceParameterBufferMPEG4
  1752. {
  1753.     unsigned char profile_and_level_indication;
  1754.     unsigned int intra_period;
  1755.     unsigned int video_object_layer_width;
  1756.     unsigned int video_object_layer_height;
  1757.     unsigned int vop_time_increment_resolution;
  1758.     unsigned int fixed_vop_rate;
  1759.     unsigned int fixed_vop_time_increment;
  1760.     unsigned int bits_per_second;
  1761.     unsigned int frame_rate;
  1762.     unsigned int initial_qp;
  1763.     unsigned int min_qp;
  1764. } VAEncSequenceParameterBufferMPEG4;
  1765.  
  1766. typedef struct _VAEncPictureParameterBufferMPEG4
  1767. {
  1768.     VASurfaceID reference_picture;
  1769.     VASurfaceID reconstructed_picture;
  1770.     VABufferID coded_buf;
  1771.     unsigned short picture_width;
  1772.     unsigned short picture_height;
  1773.     unsigned int modulo_time_base; /* number of 1s */
  1774.     unsigned int vop_time_increment;
  1775.     VAEncPictureType picture_type;
  1776. } VAEncPictureParameterBufferMPEG4;
  1777.  
  1778.  
  1779.  
  1780. /** Buffer functions */
  1781.  
  1782. /**
  1783.  * Creates a buffer for "num_elements" elements of "size" bytes and
  1784.  * initalize with "data".
  1785.  * if "data" is null, then the contents of the buffer data store
  1786.  * are undefined.
  1787.  * Basically there are two ways to get buffer data to the server side. One is
  1788.  * to call vaCreateBuffer() with a non-null "data", which results the data being
  1789.  * copied to the data store on the server side.  A different method that
  1790.  * eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
  1791.  * and then use vaMapBuffer() to map the data store from the server side to the
  1792.  * client address space for access.
  1793.  *  Note: image buffers are created by the library, not the client. Please see
  1794.  *        vaCreateImage on how image buffers are managed.
  1795.  */
  1796. VAStatus vaCreateBuffer (
  1797.     VADisplay dpy,
  1798.     VAContextID context,
  1799.     VABufferType type,  /* in */
  1800.     unsigned int size,  /* in */
  1801.     unsigned int num_elements, /* in */
  1802.     void *data,         /* in */
  1803.     VABufferID *buf_id  /* out */
  1804. );
  1805.  
  1806. /**
  1807.  * Convey to the server how many valid elements are in the buffer.
  1808.  * e.g. if multiple slice parameters are being held in a single buffer,
  1809.  * this will communicate to the server the number of slice parameters
  1810.  * that are valid in the buffer.
  1811.  */
  1812. VAStatus vaBufferSetNumElements (
  1813.     VADisplay dpy,
  1814.     VABufferID buf_id,  /* in */
  1815.     unsigned int num_elements /* in */
  1816. );
  1817.  
  1818.  
  1819. /**
  1820.  * device independent data structure for codedbuffer
  1821.  */
  1822.  
  1823. /*
  1824.  * FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
  1825.  * LARGE_SLICE(bit8):At least one slice in the current frame was large
  1826.  *              enough for the encoder to attempt to limit its size.
  1827.  * SLICE_OVERFLOW(bit9): At least one slice in the current frame has
  1828.  *              exceeded the maximum slice size specified.
  1829.  * BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
  1830.  * BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
  1831.  * AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
  1832.  */
  1833. #define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK         0xff
  1834. #define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK            0x100
  1835. #define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK         0x200
  1836. #define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW            0x400
  1837. #define VA_CODED_BUF_STATUS_BITRATE_HIGH                0x800
  1838. /**
  1839.  * \brief The frame has exceeded the maximum requested size.
  1840.  *
  1841.  * This flag indicates that the encoded frame size exceeds the value
  1842.  * specified through a misc parameter buffer of type
  1843.  * #VAEncMiscParameterTypeMaxFrameSize.
  1844.  */
  1845. #define VA_CODED_BUF_STATUS_FRAME_SIZE_OVERFLOW         0x1000
  1846. #define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD       0xff0000
  1847.  
  1848. /**
  1849.  * \brief The coded buffer segment contains a single NAL unit.
  1850.  *
  1851.  * This flag indicates that the coded buffer segment contains a
  1852.  * single NAL unit. This flag might be useful to the user for
  1853.  * processing the coded buffer.
  1854.  */
  1855. #define VA_CODED_BUF_STATUS_SINGLE_NALU                 0x10000000     
  1856.  
  1857. /**
  1858.  * \brief Coded buffer segment.
  1859.  *
  1860.  * #VACodedBufferSegment is an element of a linked list describing
  1861.  * some information on the coded buffer. The coded buffer segment
  1862.  * could contain either a single NAL unit, or more than one NAL unit.
  1863.  * It is recommended (but not required) to return a single NAL unit
  1864.  * in a coded buffer segment, and the implementation should set the
  1865.  * VA_CODED_BUF_STATUS_SINGLE_NALU status flag if that is the case.
  1866.  */
  1867. typedef  struct _VACodedBufferSegment  {
  1868.     /**
  1869.      * \brief Size of the data buffer in this segment (in bytes).
  1870.      */
  1871.     unsigned int        size;
  1872.     /** \brief Bit offset into the data buffer where the video data starts. */
  1873.     unsigned int        bit_offset;
  1874.     /** \brief Status set by the driver. See \c VA_CODED_BUF_STATUS_*. */
  1875.     unsigned int        status;
  1876.     /** \brief Reserved for future use. */
  1877.     unsigned int        reserved;
  1878.     /** \brief Pointer to the start of the data buffer. */
  1879.     void               *buf;
  1880.     /**
  1881.      * \brief Pointer to the next #VACodedBufferSegment element,
  1882.      * or \c NULL if there is none.
  1883.      */
  1884.     void               *next;
  1885. } VACodedBufferSegment;
  1886.      
  1887. /**
  1888.  * Map data store of the buffer into the client's address space
  1889.  * vaCreateBuffer() needs to be called with "data" set to NULL before
  1890.  * calling vaMapBuffer()
  1891.  *
  1892.  * if buffer type is VAEncCodedBufferType, pbuf points to link-list of
  1893.  * VACodedBufferSegment, and the list is terminated if "next" is NULL
  1894.  */
  1895. VAStatus vaMapBuffer (
  1896.     VADisplay dpy,
  1897.     VABufferID buf_id,  /* in */
  1898.     void **pbuf         /* out */
  1899. );
  1900.  
  1901. /**
  1902.  * After client making changes to a mapped data store, it needs to
  1903.  * "Unmap" it to let the server know that the data is ready to be
  1904.  * consumed by the server
  1905.  */
  1906. VAStatus vaUnmapBuffer (
  1907.     VADisplay dpy,
  1908.     VABufferID buf_id   /* in */
  1909. );
  1910.  
  1911. /**
  1912.  * After this call, the buffer is deleted and this buffer_id is no longer valid
  1913.  * Only call this if the buffer is not going to be passed to vaRenderBuffer
  1914.  */
  1915. VAStatus vaDestroyBuffer (
  1916.     VADisplay dpy,
  1917.     VABufferID buffer_id
  1918. );
  1919.  
  1920. /** \brief VA buffer information */
  1921. typedef struct {
  1922.     /** \brief Buffer handle */
  1923.     uintptr_t           handle;
  1924.     /** \brief Buffer type (See \ref VABufferType). */
  1925.     uint32_t            type;
  1926.     /**
  1927.      * \brief Buffer memory type (See \ref VASurfaceAttribMemoryType).
  1928.      *
  1929.      * On input to vaAcquireBufferHandle(), this field can serve as a hint
  1930.      * to specify the set of memory types the caller is interested in.
  1931.      * On successful return from vaAcquireBufferHandle(), the field is
  1932.      * updated with the best matching memory type.
  1933.      */
  1934.     uint32_t            mem_type;
  1935.     /** \brief Size of the underlying buffer. */
  1936.     size_t              mem_size;
  1937. } VABufferInfo;
  1938.  
  1939. /**
  1940.  * \brief Acquires buffer handle for external API usage
  1941.  *
  1942.  * Locks the VA buffer object \ref buf_id for external API usage like
  1943.  * EGL or OpenCL (OCL). This function is a synchronization point. This
  1944.  * means that any pending operation is guaranteed to be completed
  1945.  * prior to returning from the function.
  1946.  *
  1947.  * If the referenced VA buffer object is the backing store of a VA
  1948.  * surface, then this function acts as if vaSyncSurface() on the
  1949.  * parent surface was called first.
  1950.  *
  1951.  * The \ref VABufferInfo argument shall be zero'ed on input. On
  1952.  * successful output, the data structure is filled in with all the
  1953.  * necessary buffer level implementation details like handle, type,
  1954.  * memory type and memory size.
  1955.  *
  1956.  * Note: the external API implementation, or the application, can
  1957.  * express the memory types it is interested in by filling in the \ref
  1958.  * mem_type field accordingly. On successful output, the memory type
  1959.  * that fits best the request and that was used is updated in the \ref
  1960.  * VABufferInfo data structure. If none of the supplied memory types
  1961.  * is supported, then a \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE
  1962.  * error is returned.
  1963.  *
  1964.  * The \ref VABufferInfo data is valid until vaReleaseBufferHandle()
  1965.  * is called. Besides, no additional operation is allowed on any of
  1966.  * the buffer parent object until vaReleaseBufferHandle() is called.
  1967.  * e.g. decoding into a VA surface backed with the supplied VA buffer
  1968.  * object \ref buf_id would fail with a \ref VA_STATUS_ERROR_SURFACE_BUSY
  1969.  * error.
  1970.  *
  1971.  * Possible errors:
  1972.  * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
  1973.  *   does not support this interface
  1974.  * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
  1975.  * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
  1976.  * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
  1977.  *   does not support exporting buffers of the specified type
  1978.  * - \ref VA_STATUS_ERROR_UNSUPPORTED_MEMORY_TYPE: none of the requested
  1979.  *   memory types in \ref VABufferInfo.mem_type was supported
  1980.  *
  1981.  * @param[in] dpy               the VA display
  1982.  * @param[in] buf_id            the VA buffer
  1983.  * @param[in,out] buf_info      the associated VA buffer information
  1984.  * @return VA_STATUS_SUCCESS if successful
  1985.  */
  1986. VAStatus
  1987. vaAcquireBufferHandle(VADisplay dpy, VABufferID buf_id, VABufferInfo *buf_info);
  1988.  
  1989. /**
  1990.  * \brief Releases buffer after usage from external API
  1991.  *
  1992.  * Unlocks the VA buffer object \ref buf_id from external API usage like
  1993.  * EGL or OpenCL (OCL). This function is a synchronization point. This
  1994.  * means that any pending operation is guaranteed to be completed
  1995.  * prior to returning from the function.
  1996.  *
  1997.  * The \ref VABufferInfo argument shall point to the original data
  1998.  * structure that was obtained from vaAcquireBufferHandle(), unaltered.
  1999.  * This is necessary so that the VA driver implementation could
  2000.  * deallocate any resources that were needed.
  2001.  *
  2002.  * In any case, returning from this function invalidates any contents
  2003.  * in \ref VABufferInfo. i.e. the underlyng buffer handle is no longer
  2004.  * valid. Therefore, VA driver implementations are free to reset this
  2005.  * data structure to safe defaults.
  2006.  *
  2007.  * Possible errors:
  2008.  * - \ref VA_STATUS_ERROR_UNIMPLEMENTED: the VA driver implementation
  2009.  *   does not support this interface
  2010.  * - \ref VA_STATUS_ERROR_INVALID_DISPLAY: an invalid display was supplied
  2011.  * - \ref VA_STATUS_ERROR_INVALID_BUFFER: an invalid buffer was supplied
  2012.  * - \ref VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE: the implementation
  2013.  *   does not support exporting buffers of the specified type
  2014.  *
  2015.  * @param[in] dpy               the VA display
  2016.  * @param[in] buf_id            the VA buffer
  2017.  * @return VA_STATUS_SUCCESS if successful
  2018.  */
  2019. VAStatus
  2020. vaReleaseBufferHandle(VADisplay dpy, VABufferID buf_id);
  2021.  
  2022. /*
  2023. Render (Decode) Pictures
  2024.  
  2025. A picture represents either a frame or a field.
  2026.  
  2027. The Begin/Render/End sequence sends the decode buffers to the server
  2028. */
  2029.  
  2030. /**
  2031.  * Get ready to decode a picture to a target surface
  2032.  */
  2033. VAStatus vaBeginPicture (
  2034.     VADisplay dpy,
  2035.     VAContextID context,
  2036.     VASurfaceID render_target
  2037. );
  2038.  
  2039. /**
  2040.  * Send decode buffers to the server.
  2041.  * Buffers are automatically destroyed afterwards
  2042.  */
  2043. VAStatus vaRenderPicture (
  2044.     VADisplay dpy,
  2045.     VAContextID context,
  2046.     VABufferID *buffers,
  2047.     int num_buffers
  2048. );
  2049.  
  2050. /**
  2051.  * Make the end of rendering for a picture.
  2052.  * The server should start processing all pending operations for this
  2053.  * surface. This call is non-blocking. The client can start another
  2054.  * Begin/Render/End sequence on a different render target.
  2055.  */
  2056. VAStatus vaEndPicture (
  2057.     VADisplay dpy,
  2058.     VAContextID context
  2059. );
  2060.  
  2061. /*
  2062.  
  2063. Synchronization
  2064.  
  2065. */
  2066.  
  2067. /**
  2068.  * This function blocks until all pending operations on the render target
  2069.  * have been completed.  Upon return it is safe to use the render target for a
  2070.  * different picture.
  2071.  */
  2072. VAStatus vaSyncSurface (
  2073.     VADisplay dpy,
  2074.     VASurfaceID render_target
  2075. );
  2076.  
  2077. typedef enum
  2078. {
  2079.     VASurfaceRendering  = 1, /* Rendering in progress */
  2080.     VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
  2081.                              /* this status is useful if surface is used as the source */
  2082.                              /* of an overlay */
  2083.     VASurfaceReady      = 4, /* not being rendered or displayed */
  2084.     VASurfaceSkipped    = 8  /* Indicate a skipped frame during encode */
  2085. } VASurfaceStatus;
  2086.  
  2087. /**
  2088.  * Find out any pending ops on the render target
  2089.  */
  2090. VAStatus vaQuerySurfaceStatus (
  2091.     VADisplay dpy,
  2092.     VASurfaceID render_target,
  2093.     VASurfaceStatus *status     /* out */
  2094. );
  2095.  
  2096. typedef enum
  2097. {
  2098.     VADecodeSliceMissing            = 0,
  2099.     VADecodeMBError                 = 1,
  2100. } VADecodeErrorType;
  2101.  
  2102. /**
  2103.  * Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
  2104.  * an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
  2105. */
  2106. typedef struct _VASurfaceDecodeMBErrors
  2107. {
  2108.     int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
  2109.     unsigned int start_mb; /* start mb address with errors */
  2110.     unsigned int end_mb;  /* end mb address with errors */
  2111.     VADecodeErrorType decode_error_type;
  2112. } VASurfaceDecodeMBErrors;
  2113.  
  2114. /**
  2115.  * After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
  2116.  * it can call vaQuerySurfaceError to find out further details on the particular error.
  2117.  * VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
  2118.  * upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
  2119.  * which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
  2120.  * The array is terminated if "status==-1" is detected.
  2121.  */
  2122. VAStatus vaQuerySurfaceError(
  2123.     VADisplay dpy,
  2124.     VASurfaceID surface,
  2125.     VAStatus error_status,
  2126.     void **error_info
  2127. );
  2128.  
  2129. /**
  2130.  * Images and Subpictures
  2131.  * VAImage is used to either get the surface data to client memory, or
  2132.  * to copy image data in client memory to a surface.
  2133.  * Both images, subpictures and surfaces follow the same 2D coordinate system where origin
  2134.  * is at the upper left corner with positive X to the right and positive Y down
  2135.  */
  2136. #define VA_FOURCC(ch0, ch1, ch2, ch3) \
  2137.     ((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
  2138.     ((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
  2139.  
  2140. /*
  2141.  * Pre-defined fourcc codes
  2142.  */
  2143. #define VA_FOURCC_NV12          0x3231564E
  2144. #define VA_FOURCC_AI44          0x34344149
  2145. #define VA_FOURCC_RGBA          0x41424752
  2146. #define VA_FOURCC_RGBX          0x58424752
  2147. #define VA_FOURCC_BGRA          0x41524742
  2148. #define VA_FOURCC_BGRX          0x58524742
  2149. #define VA_FOURCC_ARGB          0x42475241
  2150. #define VA_FOURCC_XRGB          0x42475258
  2151. #define VA_FOURCC_ABGR          0x52474241
  2152. #define VA_FOURCC_XBGR          0x52474258
  2153. #define VA_FOURCC_UYVY          0x59565955
  2154. #define VA_FOURCC_YUY2          0x32595559
  2155. #define VA_FOURCC_AYUV          0x56555941
  2156. #define VA_FOURCC_NV11          0x3131564e
  2157. #define VA_FOURCC_YV12          0x32315659
  2158. #define VA_FOURCC_P208          0x38303250
  2159. #define VA_FOURCC_IYUV          0x56555949
  2160. #define VA_FOURCC_YV24          0x34325659
  2161. #define VA_FOURCC_YV32          0x32335659
  2162. #define VA_FOURCC_Y800          0x30303859
  2163. #define VA_FOURCC_IMC3          0x33434D49
  2164. #define VA_FOURCC_411P          0x50313134
  2165. #define VA_FOURCC_422H          0x48323234
  2166. #define VA_FOURCC_422V          0x56323234
  2167. #define VA_FOURCC_444P          0x50343434
  2168. #define VA_FOURCC_RGBP          0x50424752
  2169. #define VA_FOURCC_BGRP          0x50524742
  2170. #define VA_FOURCC_411R          0x52313134 /* rotated 411P */
  2171.  
  2172. /* byte order */
  2173. #define VA_LSB_FIRST            1
  2174. #define VA_MSB_FIRST            2
  2175.  
  2176. typedef struct _VAImageFormat
  2177. {
  2178.     unsigned int        fourcc;
  2179.     unsigned int        byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
  2180.     unsigned int        bits_per_pixel;
  2181.     /* for RGB formats */
  2182.     unsigned int        depth; /* significant bits per pixel */
  2183.     unsigned int        red_mask;
  2184.     unsigned int        green_mask;
  2185.     unsigned int        blue_mask;
  2186.     unsigned int        alpha_mask;
  2187. } VAImageFormat;
  2188.  
  2189. typedef VAGenericID VAImageID;
  2190.  
  2191. typedef struct _VAImage
  2192. {
  2193.     VAImageID           image_id; /* uniquely identify this image */
  2194.     VAImageFormat       format;
  2195.     VABufferID          buf;    /* image data buffer */
  2196.     /*
  2197.      * Image data will be stored in a buffer of type VAImageBufferType to facilitate
  2198.      * data store on the server side for optimal performance. The buffer will be
  2199.      * created by the CreateImage function, and proper storage allocated based on the image
  2200.      * size and format. This buffer is managed by the library implementation, and
  2201.      * accessed by the client through the buffer Map/Unmap functions.
  2202.      */
  2203.     unsigned short      width;
  2204.     unsigned short      height;
  2205.     unsigned int        data_size;
  2206.     unsigned int        num_planes;     /* can not be greater than 3 */
  2207.     /*
  2208.      * An array indicating the scanline pitch in bytes for each plane.
  2209.      * Each plane may have a different pitch. Maximum 3 planes for planar formats
  2210.      */
  2211.     unsigned int        pitches[3];
  2212.     /*
  2213.      * An array indicating the byte offset from the beginning of the image data
  2214.      * to the start of each plane.
  2215.      */
  2216.     unsigned int        offsets[3];
  2217.  
  2218.     /* The following fields are only needed for paletted formats */
  2219.     int num_palette_entries;   /* set to zero for non-palette images */
  2220.     /*
  2221.      * Each component is one byte and entry_bytes indicates the number of components in
  2222.      * each entry (eg. 3 for YUV palette entries). set to zero for non-palette images  
  2223.      */
  2224.     int entry_bytes;
  2225.     /*
  2226.      * An array of ascii characters describing the order of the components within the bytes.
  2227.      * Only entry_bytes characters of the string are used.
  2228.      */
  2229.     char component_order[4];
  2230. } VAImage;
  2231.  
  2232. /** Get maximum number of image formats supported by the implementation */
  2233. int vaMaxNumImageFormats (
  2234.     VADisplay dpy
  2235. );
  2236.  
  2237. /**
  2238.  * Query supported image formats
  2239.  * The caller must provide a "format_list" array that can hold at
  2240.  * least vaMaxNumImageFormats() entries. The actual number of formats
  2241.  * returned in "format_list" is returned in "num_formats".
  2242.  */
  2243. VAStatus vaQueryImageFormats (
  2244.     VADisplay dpy,
  2245.     VAImageFormat *format_list, /* out */
  2246.     int *num_formats            /* out */
  2247. );
  2248.  
  2249. /**
  2250.  * Create a VAImage structure
  2251.  * The width and height fields returned in the VAImage structure may get
  2252.  * enlarged for some YUV formats. Upon return from this function,
  2253.  * image->buf has been created and proper storage allocated by the library.
  2254.  * The client can access the image through the Map/Unmap calls.
  2255.  */
  2256. VAStatus vaCreateImage (
  2257.     VADisplay dpy,
  2258.     VAImageFormat *format,
  2259.     int width,
  2260.     int height,
  2261.     VAImage *image      /* out */
  2262. );
  2263.  
  2264. /**
  2265.  * Should call DestroyImage before destroying the surface it is bound to
  2266.  */
  2267. VAStatus vaDestroyImage (
  2268.     VADisplay dpy,
  2269.     VAImageID image
  2270. );
  2271.  
  2272. VAStatus vaSetImagePalette (
  2273.     VADisplay dpy,
  2274.     VAImageID image,
  2275.     /*
  2276.      * pointer to an array holding the palette data.  The size of the array is
  2277.      * num_palette_entries * entry_bytes in size.  The order of the components
  2278.      * in the palette is described by the component_order in VAImage struct    
  2279.      */
  2280.     unsigned char *palette
  2281. );
  2282.  
  2283. /**
  2284.  * Retrive surface data into a VAImage
  2285.  * Image must be in a format supported by the implementation
  2286.  */
  2287. VAStatus vaGetImage (
  2288.     VADisplay dpy,
  2289.     VASurfaceID surface,
  2290.     int x,      /* coordinates of the upper left source pixel */
  2291.     int y,
  2292.     unsigned int width, /* width and height of the region */
  2293.     unsigned int height,
  2294.     VAImageID image
  2295. );
  2296.  
  2297. /**
  2298.  * Copy data from a VAImage to a surface
  2299.  * Image must be in a format supported by the implementation
  2300.  * Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
  2301.  * shouldn't be rendered into when this is called
  2302.  */
  2303. VAStatus vaPutImage (
  2304.     VADisplay dpy,
  2305.     VASurfaceID surface,
  2306.     VAImageID image,
  2307.     int src_x,
  2308.     int src_y,
  2309.     unsigned int src_width,
  2310.     unsigned int src_height,
  2311.     int dest_x,
  2312.     int dest_y,
  2313.     unsigned int dest_width,
  2314.     unsigned int dest_height
  2315. );
  2316.  
  2317. /**
  2318.  * Derive an VAImage from an existing surface.
  2319.  * This interface will derive a VAImage and corresponding image buffer from
  2320.  * an existing VA Surface. The image buffer can then be mapped/unmapped for
  2321.  * direct CPU access. This operation is only possible on implementations with
  2322.  * direct rendering capabilities and internal surface formats that can be
  2323.  * represented with a VAImage. When the operation is not possible this interface
  2324.  * will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
  2325.  * to using vaCreateImage + vaPutImage to accomplish the same task in an
  2326.  * indirect manner.
  2327.  *
  2328.  * Implementations should only return success when the resulting image buffer
  2329.  * would be useable with vaMap/Unmap.
  2330.  *
  2331.  * When directly accessing a surface special care must be taken to insure
  2332.  * proper synchronization with the graphics hardware. Clients should call
  2333.  * vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
  2334.  * rendering or currently being displayed by an overlay.
  2335.  *
  2336.  * Additionally nothing about the contents of a surface should be assumed
  2337.  * following a vaPutSurface. Implementations are free to modify the surface for
  2338.  * scaling or subpicture blending within a call to vaPutImage.
  2339.  *
  2340.  * Calls to vaPutImage or vaGetImage using the same surface from which the image
  2341.  * has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
  2342.  * vaGetImage with other surfaces is supported.
  2343.  *
  2344.  * An image created with vaDeriveImage should be freed with vaDestroyImage. The
  2345.  * image and image buffer structures will be destroyed; however, the underlying
  2346.  * surface will remain unchanged until freed with vaDestroySurfaces.
  2347.  */
  2348. VAStatus vaDeriveImage (
  2349.     VADisplay dpy,
  2350.     VASurfaceID surface,
  2351.     VAImage *image      /* out */
  2352. );
  2353.  
  2354. /**
  2355.  * Subpictures
  2356.  * Subpicture is a special type of image that can be blended
  2357.  * with a surface during vaPutSurface(). Subpicture can be used to render
  2358.  * DVD sub-titles or closed captioning text etc.  
  2359.  */
  2360.  
  2361. typedef VAGenericID VASubpictureID;
  2362.  
  2363. /** Get maximum number of subpicture formats supported by the implementation */
  2364. int vaMaxNumSubpictureFormats (
  2365.     VADisplay dpy
  2366. );
  2367.  
  2368. /** flags for subpictures */
  2369. #define VA_SUBPICTURE_CHROMA_KEYING                     0x0001
  2370. #define VA_SUBPICTURE_GLOBAL_ALPHA                      0x0002
  2371. #define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD       0x0004
  2372. /**
  2373.  * Query supported subpicture formats
  2374.  * The caller must provide a "format_list" array that can hold at
  2375.  * least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
  2376.  * for each format to indicate additional capabilities for that format. The actual
  2377.  * number of formats returned in "format_list" is returned in "num_formats".
  2378.  *  flags: returned value to indicate addtional capabilities
  2379.  *         VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
  2380.  *         VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
  2381.  *         VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
  2382.  */
  2383.  
  2384. VAStatus vaQuerySubpictureFormats (
  2385.     VADisplay dpy,
  2386.     VAImageFormat *format_list, /* out */
  2387.     unsigned int *flags,        /* out */
  2388.     unsigned int *num_formats   /* out */
  2389. );
  2390.  
  2391. /**
  2392.  * Subpictures are created with an image associated.
  2393.  */
  2394. VAStatus vaCreateSubpicture (
  2395.     VADisplay dpy,
  2396.     VAImageID image,
  2397.     VASubpictureID *subpicture  /* out */
  2398. );
  2399.  
  2400. /**
  2401.  * Destroy the subpicture before destroying the image it is assocated to
  2402.  */
  2403. VAStatus vaDestroySubpicture (
  2404.     VADisplay dpy,
  2405.     VASubpictureID subpicture
  2406. );
  2407.  
  2408. /**
  2409.  * Bind an image to the subpicture. This image will now be associated with
  2410.  * the subpicture instead of the one at creation.
  2411.  */
  2412. VAStatus vaSetSubpictureImage (
  2413.     VADisplay dpy,
  2414.     VASubpictureID subpicture,
  2415.     VAImageID image
  2416. );
  2417.  
  2418. /**
  2419.  * If chromakey is enabled, then the area where the source value falls within
  2420.  * the chromakey [min, max] range is transparent
  2421.  * The chromakey component format is the following:
  2422.  *  For RGB: [0:7] Red [8:15] Blue [16:23] Green  
  2423.  *  For YUV: [0:7] V [8:15] U [16:23] Y
  2424.  * The chromakey mask can be used to mask out certain components for chromakey
  2425.  * comparision
  2426.  */
  2427. VAStatus vaSetSubpictureChromakey (
  2428.     VADisplay dpy,
  2429.     VASubpictureID subpicture,
  2430.     unsigned int chromakey_min,
  2431.     unsigned int chromakey_max,
  2432.     unsigned int chromakey_mask
  2433. );
  2434.  
  2435. /**
  2436.  * Global alpha value is between 0 and 1. A value of 1 means fully opaque and
  2437.  * a value of 0 means fully transparent. If per-pixel alpha is also specified then
  2438.  * the overall alpha is per-pixel alpha multiplied by the global alpha
  2439.  */
  2440. VAStatus vaSetSubpictureGlobalAlpha (
  2441.     VADisplay dpy,
  2442.     VASubpictureID subpicture,
  2443.     float global_alpha
  2444. );
  2445.  
  2446. /**
  2447.  * vaAssociateSubpicture associates the subpicture with target_surfaces.
  2448.  * It defines the region mapping between the subpicture and the target  
  2449.  * surfaces through source and destination rectangles (with the same width and height).
  2450.  * Both will be displayed at the next call to vaPutSurface.  Additional
  2451.  * associations before the call to vaPutSurface simply overrides the association.
  2452.  */
  2453. VAStatus vaAssociateSubpicture (
  2454.     VADisplay dpy,
  2455.     VASubpictureID subpicture,
  2456.     VASurfaceID *target_surfaces,
  2457.     int num_surfaces,
  2458.     short src_x, /* upper left offset in subpicture */
  2459.     short src_y,
  2460.     unsigned short src_width,
  2461.     unsigned short src_height,
  2462.     short dest_x, /* upper left offset in surface */
  2463.     short dest_y,
  2464.     unsigned short dest_width,
  2465.     unsigned short dest_height,
  2466.     /*
  2467.      * whether to enable chroma-keying, global-alpha, or screen relative mode
  2468.      * see VA_SUBPICTURE_XXX values
  2469.      */
  2470.     unsigned int flags
  2471. );
  2472.  
  2473. /**
  2474.  * vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
  2475.  */
  2476. VAStatus vaDeassociateSubpicture (
  2477.     VADisplay dpy,
  2478.     VASubpictureID subpicture,
  2479.     VASurfaceID *target_surfaces,
  2480.     int num_surfaces
  2481. );
  2482.  
  2483. typedef struct _VARectangle
  2484. {
  2485.     short x;
  2486.     short y;
  2487.     unsigned short width;
  2488.     unsigned short height;
  2489. } VARectangle;
  2490.  
  2491. /**
  2492.  * Display attributes
  2493.  * Display attributes are used to control things such as contrast, hue, saturation,
  2494.  * brightness etc. in the rendering process.  The application can query what
  2495.  * attributes are supported by the driver, and then set the appropriate attributes
  2496.  * before calling vaPutSurface()
  2497.  */
  2498. /* PowerVR IEP Lite attributes */
  2499. typedef enum
  2500. {
  2501.     VADISPLAYATTRIB_BLE_OFF              = 0x00,
  2502.     VADISPLAYATTRIB_BLE_LOW,
  2503.     VADISPLAYATTRIB_BLE_MEDIUM,
  2504.     VADISPLAYATTRIB_BLE_HIGH,
  2505.     VADISPLAYATTRIB_BLE_NONE,
  2506. } VADisplayAttribBLEMode;
  2507.  
  2508. /** attribute value for VADisplayAttribRotation   */
  2509. #define VA_ROTATION_NONE        0x00000000
  2510. #define VA_ROTATION_90          0x00000001
  2511. #define VA_ROTATION_180         0x00000002
  2512. #define VA_ROTATION_270         0x00000003
  2513.  
  2514. /** attribute value for VADisplayAttribOutOfLoopDeblock */
  2515. #define VA_OOL_DEBLOCKING_FALSE 0x00000000
  2516. #define VA_OOL_DEBLOCKING_TRUE  0x00000001
  2517.  
  2518. /** Render mode */
  2519. #define VA_RENDER_MODE_UNDEFINED           0
  2520. #define VA_RENDER_MODE_LOCAL_OVERLAY       1
  2521. #define VA_RENDER_MODE_LOCAL_GPU           2
  2522. #define VA_RENDER_MODE_EXTERNAL_OVERLAY    4
  2523. #define VA_RENDER_MODE_EXTERNAL_GPU        8
  2524.  
  2525. /** Render device */
  2526. #define VA_RENDER_DEVICE_UNDEFINED  0
  2527. #define VA_RENDER_DEVICE_LOCAL      1
  2528. #define VA_RENDER_DEVICE_EXTERNAL   2
  2529.  
  2530. /** Currently defined display attribute types */
  2531. typedef enum
  2532. {
  2533.     VADisplayAttribBrightness           = 0,
  2534.     VADisplayAttribContrast             = 1,
  2535.     VADisplayAttribHue                  = 2,
  2536.     VADisplayAttribSaturation           = 3,
  2537.     /* client can specifiy a background color for the target window
  2538.      * the new feature of video conference,
  2539.      * the uncovered area of the surface is filled by this color
  2540.      * also it will blend with the decoded video color
  2541.      */
  2542.     VADisplayAttribBackgroundColor      = 4,
  2543.     /*
  2544.      * this is a gettable only attribute. For some implementations that use the
  2545.      * hardware overlay, after PutSurface is called, the surface can not be    
  2546.      * re-used until after the subsequent PutSurface call. If this is the case
  2547.      * then the value for this attribute will be set to 1 so that the client  
  2548.      * will not attempt to re-use the surface right after returning from a call
  2549.      * to PutSurface.
  2550.      *
  2551.      * Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
  2552.      * driver may use overlay or GPU alternatively
  2553.      */
  2554.     VADisplayAttribDirectSurface       = 5,
  2555.     VADisplayAttribRotation            = 6,    
  2556.     VADisplayAttribOutofLoopDeblock    = 7,
  2557.  
  2558.     /* PowerVR IEP Lite specific attributes */
  2559.     VADisplayAttribBLEBlackMode        = 8,
  2560.     VADisplayAttribBLEWhiteMode        = 9,
  2561.     VADisplayAttribBlueStretch         = 10,
  2562.     VADisplayAttribSkinColorCorrection = 11,
  2563.     /*
  2564.      * For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
  2565.      * conversion matrix. Each element in the matrix is float-point
  2566.      */
  2567.     VADisplayAttribCSCMatrix           = 12,
  2568.     /* specify the constant color used to blend with video surface
  2569.      * Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
  2570.      *      d: the final color to overwrite into the frame buffer
  2571.      *      v: decoded video after color conversion,
  2572.      *      c: video color specified by VADisplayAttribBlendColor
  2573.      *      b: background color of the drawable
  2574.      */
  2575.     VADisplayAttribBlendColor          = 13,
  2576.     /*
  2577.      * Indicate driver to skip painting color key or not.
  2578.      * only applicable if the render is overlay
  2579.      */
  2580.     VADisplayAttribOverlayAutoPaintColorKey   = 14,
  2581.     /*
  2582.      * customized overlay color key, the format is RGB888
  2583.      * [23:16] = Red, [15:08] = Green, [07:00] = Blue.
  2584.      */
  2585.     VADisplayAttribOverlayColorKey      = 15,
  2586.     /*
  2587.      * The hint for the implementation of vaPutSurface
  2588.      * normally, the driver could use an overlay or GPU to render the surface on the screen
  2589.      * this flag provides APP the flexibity to switch the render dynamically
  2590.      */
  2591.     VADisplayAttribRenderMode           = 16,
  2592.     /*
  2593.      * specify if vaPutSurface needs to render into specified monitors
  2594.      * one example is that one external monitor (e.g. HDMI) is enabled,
  2595.      * but the window manager is not aware of it, and there is no associated drawable
  2596.      */
  2597.     VADisplayAttribRenderDevice        = 17,
  2598.     /*
  2599.      * specify vaPutSurface render area if there is no drawable on the monitor
  2600.      */
  2601.     VADisplayAttribRenderRect          = 18,
  2602. } VADisplayAttribType;
  2603.  
  2604. /* flags for VADisplayAttribute */
  2605. #define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
  2606. #define VA_DISPLAY_ATTRIB_GETTABLE      0x0001
  2607. #define VA_DISPLAY_ATTRIB_SETTABLE      0x0002
  2608.  
  2609. typedef struct _VADisplayAttribute
  2610. {
  2611.     VADisplayAttribType type;
  2612.     int min_value;
  2613.     int max_value;
  2614.     int value;  /* used by the set/get attribute functions */
  2615. /* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
  2616.     unsigned int flags;
  2617. } VADisplayAttribute;
  2618.  
  2619. /** Get maximum number of display attributs supported by the implementation */
  2620. int vaMaxNumDisplayAttributes (
  2621.     VADisplay dpy
  2622. );
  2623.  
  2624. /**
  2625.  * Query display attributes
  2626.  * The caller must provide a "attr_list" array that can hold at
  2627.  * least vaMaxNumDisplayAttributes() entries. The actual number of attributes
  2628.  * returned in "attr_list" is returned in "num_attributes".
  2629.  */
  2630. VAStatus vaQueryDisplayAttributes (
  2631.     VADisplay dpy,
  2632.     VADisplayAttribute *attr_list,      /* out */
  2633.     int *num_attributes                 /* out */
  2634. );
  2635.  
  2636. /**
  2637.  * Get display attributes
  2638.  * This function returns the current attribute values in "attr_list".
  2639.  * Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
  2640.  * from vaQueryDisplayAttributes() can have their values retrieved.  
  2641.  */
  2642. VAStatus vaGetDisplayAttributes (
  2643.     VADisplay dpy,
  2644.     VADisplayAttribute *attr_list,      /* in/out */
  2645.     int num_attributes
  2646. );
  2647.  
  2648. /**
  2649.  * Set display attributes
  2650.  * Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
  2651.  * from vaQueryDisplayAttributes() can be set.  If the attribute is not settable or
  2652.  * the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
  2653.  */
  2654. VAStatus vaSetDisplayAttributes (
  2655.     VADisplay dpy,
  2656.     VADisplayAttribute *attr_list,
  2657.     int num_attributes
  2658. );
  2659.  
  2660. /**@}*/
  2661.  
  2662. #ifdef __cplusplus
  2663. }
  2664. #endif
  2665.  
  2666. #endif /* _VA_H_ */
  2667.