/usr/include/va/va.h is in libva-dev 1.0.15-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 | /*
* Copyright (c) 2007-2009 Intel Corporation. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sub license, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice (including the
* next paragraph) shall be included in all copies or substantial portions
* of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
* IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE LIABLE FOR
* ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
/*
* Video Acceleration (VA) API Specification
*
* Rev. 0.30
* <jonathan.bian@intel.com>
*
* Revision History:
* rev 0.10 (12/10/2006 Jonathan Bian) - Initial draft
* rev 0.11 (12/15/2006 Jonathan Bian) - Fixed some errors
* rev 0.12 (02/05/2007 Jonathan Bian) - Added VC-1 data structures for slice level decode
* rev 0.13 (02/28/2007 Jonathan Bian) - Added GetDisplay()
* rev 0.14 (04/13/2007 Jonathan Bian) - Fixed MPEG-2 PictureParameter structure, cleaned up a few funcs.
* rev 0.15 (04/20/2007 Jonathan Bian) - Overhauled buffer management
* rev 0.16 (05/02/2007 Jonathan Bian) - Added error codes and fixed some issues with configuration
* rev 0.17 (05/07/2007 Jonathan Bian) - Added H.264/AVC data structures for slice level decode.
* rev 0.18 (05/14/2007 Jonathan Bian) - Added data structures for MPEG-4 slice level decode
* and MPEG-2 motion compensation.
* rev 0.19 (08/06/2007 Jonathan Bian) - Removed extra type for bitplane data.
* rev 0.20 (08/08/2007 Jonathan Bian) - Added missing fields to VC-1 PictureParameter structure.
* rev 0.21 (08/20/2007 Jonathan Bian) - Added image and subpicture support.
* rev 0.22 (08/27/2007 Jonathan Bian) - Added support for chroma-keying and global alpha.
* rev 0.23 (09/11/2007 Jonathan Bian) - Fixed some issues with images and subpictures.
* rev 0.24 (09/18/2007 Jonathan Bian) - Added display attributes.
* rev 0.25 (10/18/2007 Jonathan Bian) - Changed to use IDs only for some types.
* rev 0.26 (11/07/2007 Waldo Bastian) - Change vaCreateBuffer semantics
* rev 0.27 (11/19/2007 Matt Sottek) - Added DeriveImage
* rev 0.28 (12/06/2007 Jonathan Bian) - Added new versions of PutImage and AssociateSubpicture
* to enable scaling
* rev 0.29 (02/07/2008 Jonathan Bian) - VC1 parameter fixes,
* added VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED
* rev 0.30 (03/01/2009 Jonathan Bian) - Added encoding support for H.264 BP and MPEG-4 SP and fixes
* for ISO C conformance.
* rev 0.31 (09/02/2009 Gwenole Beauchesne) - VC-1/H264 fields change for VDPAU and XvBA backend
* Application needs to relink with the new library.
*
* rev 0.31.1 (03/29/2009) - Data structure for JPEG encode
* rev 0.31.2 (01/13/2011 Anthony Pabon)- Added a flag to indicate Subpicture coordinates are screen
* screen relative rather than source video relative.
* rev 0.32.0 (01/13/2011 Xiang Haihao) - Add profile into VAPictureParameterBufferVC1
* update VAAPI to 0.32.0
*
* Acknowledgements:
* Some concepts borrowed from XvMC and XvImage.
* Waldo Bastian (Intel), Matt Sottek (Intel), Austin Yuan (Intel), and Gwenole Beauchesne (SDS)
* contributed to various aspects of the API.
*/
#ifndef _VA_H_
#define _VA_H_
#include <va/va_version.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
Overview
The VA API is intended to provide an interface between a video decode/encode/display
application (client) and a hardware accelerator (server), to off-load
video decode/encode/display operations from the host to the hardware accelerator at various
entry-points.
The basic operation steps are:
- Negotiate a mutually acceptable configuration with the server to lock
down profile, entrypoints, and other attributes that will not change on
a frame-by-frame basis.
- Create a decode context which represents a "virtualized" hardware decode
device
- Get and fill decode buffers with picture level, slice level and macroblock
level data (depending on entrypoints)
- Pass the decode buffers to the server to decode the current frame
Initialization & Configuration Management
- Find out supported profiles
- Find out entrypoints for a given profile
- Find out configuration attributes for a given profile/entrypoint pair
- Create a configuration for use by the decoder
*/
typedef void* VADisplay; /* window system dependent */
typedef int VAStatus; /* Return status type from functions */
/* Values for the return status */
#define VA_STATUS_SUCCESS 0x00000000
#define VA_STATUS_ERROR_OPERATION_FAILED 0x00000001
#define VA_STATUS_ERROR_ALLOCATION_FAILED 0x00000002
#define VA_STATUS_ERROR_INVALID_DISPLAY 0x00000003
#define VA_STATUS_ERROR_INVALID_CONFIG 0x00000004
#define VA_STATUS_ERROR_INVALID_CONTEXT 0x00000005
#define VA_STATUS_ERROR_INVALID_SURFACE 0x00000006
#define VA_STATUS_ERROR_INVALID_BUFFER 0x00000007
#define VA_STATUS_ERROR_INVALID_IMAGE 0x00000008
#define VA_STATUS_ERROR_INVALID_SUBPICTURE 0x00000009
#define VA_STATUS_ERROR_ATTR_NOT_SUPPORTED 0x0000000a
#define VA_STATUS_ERROR_MAX_NUM_EXCEEDED 0x0000000b
#define VA_STATUS_ERROR_UNSUPPORTED_PROFILE 0x0000000c
#define VA_STATUS_ERROR_UNSUPPORTED_ENTRYPOINT 0x0000000d
#define VA_STATUS_ERROR_UNSUPPORTED_RT_FORMAT 0x0000000e
#define VA_STATUS_ERROR_UNSUPPORTED_BUFFERTYPE 0x0000000f
#define VA_STATUS_ERROR_SURFACE_BUSY 0x00000010
#define VA_STATUS_ERROR_FLAG_NOT_SUPPORTED 0x00000011
#define VA_STATUS_ERROR_INVALID_PARAMETER 0x00000012
#define VA_STATUS_ERROR_RESOLUTION_NOT_SUPPORTED 0x00000013
#define VA_STATUS_ERROR_UNIMPLEMENTED 0x00000014
#define VA_STATUS_ERROR_SURFACE_IN_DISPLAYING 0x00000015
#define VA_STATUS_ERROR_INVALID_IMAGE_FORMAT 0x00000016
#define VA_STATUS_ERROR_DECODING_ERROR 0x00000017
#define VA_STATUS_ERROR_ENCODING_ERROR 0x00000018
#define VA_STATUS_ERROR_UNKNOWN 0xFFFFFFFF
/* De-interlacing flags for vaPutSurface() */
#define VA_FRAME_PICTURE 0x00000000
#define VA_TOP_FIELD 0x00000001
#define VA_BOTTOM_FIELD 0x00000002
/*
* Enabled the positioning/cropping/blending feature:
* 1, specify the video playback position in the isurface
* 2, specify the cropping info for video playback
* 3, encoded video will blend with background color
*/
#define VA_ENABLE_BLEND 0x00000004 /* video area blend with the constant color */
/*
* Clears the drawable with background color.
* for hardware overlay based implementation this flag
* can be used to turn off the overlay
*/
#define VA_CLEAR_DRAWABLE 0x00000008
/* Color space conversion flags for vaPutSurface() */
#define VA_SRC_BT601 0x00000010
#define VA_SRC_BT709 0x00000020
#define VA_SRC_SMPTE_240 0x00000040
/* Scaling flags for vaPutSurface() */
#define VA_FILTER_SCALING_DEFAULT 0x00000000
#define VA_FILTER_SCALING_FAST 0x00000100
#define VA_FILTER_SCALING_HQ 0x00000200
#define VA_FILTER_SCALING_NL_ANAMORPHIC 0x00000300
#define VA_FILTER_SCALING_MASK 0x00000f00
/*
* Returns a short english description of error_status
*/
const char *vaErrorStr(VAStatus error_status);
/*
* Initialization:
* A display must be obtained by calling vaGetDisplay() before calling
* vaInitialize() and other functions. This connects the API to the
* native window system.
* For X Windows, native_dpy would be from XOpenDisplay()
*/
typedef void* NativeDisplay; /* window system dependent */
int vaDisplayIsValid(VADisplay dpy);
/*
* Initialize the library
*/
VAStatus vaInitialize (
VADisplay dpy,
int *major_version, /* out */
int *minor_version /* out */
);
/*
* After this call, all library internal resources will be cleaned up
*/
VAStatus vaTerminate (
VADisplay dpy
);
/*
* vaQueryVendorString returns a pointer to a zero-terminated string
* describing some aspects of the VA implemenation on a specific
* hardware accelerator. The format of the returned string is vendor
* specific and at the discretion of the implementer.
* e.g. for the Intel GMA500 implementation, an example would be:
* "Intel GMA500 - 2.0.0.32L.0005"
*/
const char *vaQueryVendorString (
VADisplay dpy
);
typedef int (*VAPrivFunc)();
/*
* Return a function pointer given a function name in the library.
* This allows private interfaces into the library
*/
VAPrivFunc vaGetLibFunc (
VADisplay dpy,
const char *func
);
/* Currently defined profiles */
typedef enum
{
VAProfileMPEG2Simple = 0,
VAProfileMPEG2Main = 1,
VAProfileMPEG4Simple = 2,
VAProfileMPEG4AdvancedSimple = 3,
VAProfileMPEG4Main = 4,
VAProfileH264Baseline = 5,
VAProfileH264Main = 6,
VAProfileH264High = 7,
VAProfileVC1Simple = 8,
VAProfileVC1Main = 9,
VAProfileVC1Advanced = 10,
VAProfileH263Baseline = 11,
VAProfileJPEGBaseline = 12,
VAProfileH264ConstrainedBaseline = 13
} VAProfile;
/*
* Currently defined entrypoints
*/
typedef enum
{
VAEntrypointVLD = 1,
VAEntrypointIZZ = 2,
VAEntrypointIDCT = 3,
VAEntrypointMoComp = 4,
VAEntrypointDeblocking = 5,
VAEntrypointEncSlice = 6, /* slice level encode */
VAEntrypointEncPicture = 7 /* pictuer encode, JPEG, etc */
} VAEntrypoint;
/* Currently defined configuration attribute types */
typedef enum
{
VAConfigAttribRTFormat = 0,
VAConfigAttribSpatialResidual = 1,
VAConfigAttribSpatialClipping = 2,
VAConfigAttribIntraResidual = 3,
VAConfigAttribEncryption = 4,
VAConfigAttribRateControl = 5
} VAConfigAttribType;
/*
* Configuration attributes
* If there is more than one value for an attribute, a default
* value will be assigned to the attribute if the client does not
* specify the attribute when creating a configuration
*/
typedef struct _VAConfigAttrib {
VAConfigAttribType type;
unsigned int value; /* OR'd flags (bits) for this attribute */
} VAConfigAttrib;
/* attribute value for VAConfigAttribRTFormat */
#define VA_RT_FORMAT_YUV420 0x00000001
#define VA_RT_FORMAT_YUV422 0x00000002
#define VA_RT_FORMAT_YUV444 0x00000004
#define VA_RT_FORMAT_PROTECTED 0x80000000
/* attribute value for VAConfigAttribRateControl */
#define VA_RC_NONE 0x00000001
#define VA_RC_CBR 0x00000002
#define VA_RC_VBR 0x00000004
#define VA_RC_VCM 0x00000008 /* video conference mode */
/*
* if an attribute is not applicable for a given
* profile/entrypoint pair, then set the value to the following
*/
#define VA_ATTRIB_NOT_SUPPORTED 0x80000000
/* Get maximum number of profiles supported by the implementation */
int vaMaxNumProfiles (
VADisplay dpy
);
/* Get maximum number of entrypoints supported by the implementation */
int vaMaxNumEntrypoints (
VADisplay dpy
);
/* Get maximum number of attributs supported by the implementation */
int vaMaxNumConfigAttributes (
VADisplay dpy
);
/*
* Query supported profiles
* The caller must provide a "profile_list" array that can hold at
* least vaMaxNumProfile() entries. The actual number of profiles
* returned in "profile_list" is returned in "num_profile".
*/
VAStatus vaQueryConfigProfiles (
VADisplay dpy,
VAProfile *profile_list, /* out */
int *num_profiles /* out */
);
/*
* Query supported entrypoints for a given profile
* The caller must provide an "entrypoint_list" array that can hold at
* least vaMaxNumEntrypoints() entries. The actual number of entrypoints
* returned in "entrypoint_list" is returned in "num_entrypoints".
*/
VAStatus vaQueryConfigEntrypoints (
VADisplay dpy,
VAProfile profile,
VAEntrypoint *entrypoint_list, /* out */
int *num_entrypoints /* out */
);
/*
* Get attributes for a given profile/entrypoint pair
* The caller must provide an "attrib_list" with all attributes to be
* retrieved. Upon return, the attributes in "attrib_list" have been
* updated with their value. Unknown attributes or attributes that are
* not supported for the given profile/entrypoint pair will have their
* value set to VA_ATTRIB_NOT_SUPPORTED
*/
VAStatus vaGetConfigAttributes (
VADisplay dpy,
VAProfile profile,
VAEntrypoint entrypoint,
VAConfigAttrib *attrib_list, /* in/out */
int num_attribs
);
/* Generic ID type, can be re-typed for specific implementation */
typedef unsigned int VAGenericID;
typedef VAGenericID VAConfigID;
/*
* Create a configuration for the decode pipeline
* it passes in the attribute list that specifies the attributes it cares
* about, with the rest taking default values.
*/
VAStatus vaCreateConfig (
VADisplay dpy,
VAProfile profile,
VAEntrypoint entrypoint,
VAConfigAttrib *attrib_list,
int num_attribs,
VAConfigID *config_id /* out */
);
/*
* Free resources associdated with a given config
*/
VAStatus vaDestroyConfig (
VADisplay dpy,
VAConfigID config_id
);
/*
* Query all attributes for a given configuration
* The profile of the configuration is returned in "profile"
* The entrypoint of the configuration is returned in "entrypoint"
* The caller must provide an "attrib_list" array that can hold at least
* vaMaxNumConfigAttributes() entries. The actual number of attributes
* returned in "attrib_list" is returned in "num_attribs"
*/
VAStatus vaQueryConfigAttributes (
VADisplay dpy,
VAConfigID config_id,
VAProfile *profile, /* out */
VAEntrypoint *entrypoint, /* out */
VAConfigAttrib *attrib_list,/* out */
int *num_attribs /* out */
);
/*
* Contexts and Surfaces
*
* Context represents a "virtual" video decode pipeline. Surfaces are render
* targets for a given context. The data in the surfaces are not accessible
* to the client and the internal data format of the surface is implementatin
* specific.
*
* Surfaces will be bound to a context when the context is created. Once
* a surface is bound to a given context, it can not be used to create
* another context. The association is removed when the context is destroyed
*
* Both contexts and surfaces are identified by unique IDs and its
* implementation specific internals are kept opaque to the clients
*/
typedef VAGenericID VAContextID;
typedef VAGenericID VASurfaceID;
#define VA_INVALID_ID 0xffffffff
#define VA_INVALID_SURFACE VA_INVALID_ID
/*
* vaCreateSurfaces - Create an array of surfaces used for decode and display
* dpy: display
* width: surface width
* height: surface height
* format: VA_RT_FORMAT_YUV420, VA_RT_FORMAT_YUV422 or VA_RT_FORMAT_YUV444
* num_surfaces: number of surfaces to be created
* surfaces: array of surfaces created upon return
*/
VAStatus vaCreateSurfaces (
VADisplay dpy,
int width,
int height,
int format,
int num_surfaces,
VASurfaceID *surfaces /* out */
);
/*
* vaDestroySurfaces - Destroy resources associated with surfaces.
* Surfaces can only be destroyed after the context associated has been
* destroyed.
* dpy: display
* surfaces: array of surfaces to destroy
* num_surfaces: number of surfaces in the array to be destroyed.
*/
VAStatus vaDestroySurfaces (
VADisplay dpy,
VASurfaceID *surfaces,
int num_surfaces
);
#define VA_PROGRESSIVE 0x1
/*
* vaCreateContext - Create a context
* dpy: display
* config_id: configuration for the context
* picture_width: coded picture width
* picture_height: coded picture height
* flag: any combination of the following:
* VA_PROGRESSIVE (only progressive frame pictures in the sequence when set)
* render_targets: render targets (surfaces) tied to the context
* num_render_targets: number of render targets in the above array
* context: created context id upon return
*/
VAStatus vaCreateContext (
VADisplay dpy,
VAConfigID config_id,
int picture_width,
int picture_height,
int flag,
VASurfaceID *render_targets,
int num_render_targets,
VAContextID *context /* out */
);
/*
* vaDestroyContext - Destroy a context
* dpy: display
* context: context to be destroyed
*/
VAStatus vaDestroyContext (
VADisplay dpy,
VAContextID context
);
/*
* Buffers
* Buffers are used to pass various types of data from the
* client to the server. The server maintains a data store
* for each buffer created, and the client idenfies a buffer
* through a unique buffer id assigned by the server.
*/
typedef VAGenericID VABufferID;
typedef enum
{
VAPictureParameterBufferType = 0,
VAIQMatrixBufferType = 1,
VABitPlaneBufferType = 2,
VASliceGroupMapBufferType = 3,
VASliceParameterBufferType = 4,
VASliceDataBufferType = 5,
VAMacroblockParameterBufferType = 6,
VAResidualDataBufferType = 7,
VADeblockingParameterBufferType = 8,
VAImageBufferType = 9,
VAProtectedSliceDataBufferType = 10,
VAQMatrixBufferType = 11,
/* Following are encode buffer types */
VAEncCodedBufferType = 21,
VAEncSequenceParameterBufferType = 22,
VAEncPictureParameterBufferType = 23,
VAEncSliceParameterBufferType = 24,
VAEncH264VUIBufferType = 25,
VAEncH264SEIBufferType = 26,
VAEncMiscParameterBufferType = 27,
VABufferTypeMax = 0xff
} VABufferType;
typedef enum
{
VAEncMiscParameterTypeFrameRate = 0,
VAEncMiscParameterTypeRateControl = 1,
VAEncMiscParameterTypeMaxSliceSize = 2,
VAEncMiscParameterTypeAIR = 3,
} VAEncMiscParameterType;
/*
* For application, e.g. set a new bitrate
* VABufferID buf_id;
* VAEncMiscParameterBuffer *misc_param;
* VAEncMiscParameterRateControl *misc_rate_ctrl;
*
* vaCreateBuffer(dpy, context, VAEncMiscParameterBufferType,
* sizeof(VAEncMiscParameterBuffer) + sizeof(VAEncMiscParameterRateControl),
* 1, NULL, &buf_id);
*
* vaMapBuffer(dpy,buf_id,(void **)&misc_param);
* misc_param->type = VAEncMiscParameterTypeRateControl;
* misc_rate_ctrl= (VAEncMiscParameterRateControl *)misc_param->data;
* misc_rate_ctrl->bits_per_second = 6400000;
* vaUnmapBuffer(dpy, buf_id);
* vaRenderPicture(dpy, context, &buf_id, 1);
*/
typedef struct _VAEncMiscParameterBuffer
{
VAEncMiscParameterType type;
unsigned int data[0];
} VAEncMiscParameterBuffer;
typedef struct _VAEncMiscParameterRateControl
{
unsigned int bits_per_second; /* this is the maximum bit-rate to be constrained by the rate control implementation */
unsigned int target_percentage; /* this is the bit-rate the rate control is targeting, as a percentage of the maximum bit-rate */
/* for example if target_percentage is 95 then the rate control will target a bit-rate that is */
/* 95% of the maximum bit-rate */
unsigned int window_size; /* windows size in milliseconds. For example if this is set to 500, then the rate control will guarantee the */
/* target bit-rate over a 500 ms window */
unsigned int initial_qp; /* initial QP at I frames */
unsigned int min_qp;
} VAEncMiscParameterRateControl;
typedef struct _VAEncMiscParameterFrameRate
{
unsigned int framerate;
} VAEncMiscParameterFrameRate;
/*
* Allow a maximum slice size to be specified (in bits).
* The encoder will attempt to make sure that individual slices do not exceed this size
* Or to signal applicate if the slice size exceed this size, see "status" of VACodedBufferSegment
*/
typedef struct _VAEncMiscParameterMaxSliceSize
{
unsigned int max_slice_size;
} VAEncMiscParameterMaxSliceSize;
typedef struct _VAEncMiscParameterAIR
{
unsigned int air_num_mbs;
unsigned int air_threshold;
unsigned int air_auto; /* if set to 1 then hardware auto-tune the AIR threshold */
} VAEncMiscParameterAIR;
/*
* There will be cases where the bitstream buffer will not have enough room to hold
* the data for the entire slice, and the following flags will be used in the slice
* parameter to signal to the server for the possible cases.
* If a slice parameter buffer and slice data buffer pair is sent to the server with
* the slice data partially in the slice data buffer (BEGIN and MIDDLE cases below),
* then a slice parameter and data buffer needs to be sent again to complete this slice.
*/
#define VA_SLICE_DATA_FLAG_ALL 0x00 /* whole slice is in the buffer */
#define VA_SLICE_DATA_FLAG_BEGIN 0x01 /* The beginning of the slice is in the buffer but the end if not */
#define VA_SLICE_DATA_FLAG_MIDDLE 0x02 /* Neither beginning nor end of the slice is in the buffer */
#define VA_SLICE_DATA_FLAG_END 0x04 /* end of the slice is in the buffer */
/* Codec-independent Slice Parameter Buffer base */
typedef struct _VASliceParameterBufferBase
{
unsigned int slice_data_size; /* number of bytes in the slice data buffer for this slice */
unsigned int slice_data_offset; /* the offset to the first byte of slice data */
unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX definitions */
} VASliceParameterBufferBase;
/****************************
* JEPG data structure
***************************/
typedef struct _VAQMatrixBufferJPEG
{
int load_lum_quantiser_matrix;
int load_chroma_quantiser_matrix;
unsigned char lum_quantiser_matrix[64];
unsigned char chroma_quantiser_matrix[64];
} VAQMatrixBufferJPEG;
typedef struct _VAEncPictureParameterBufferJPEG
{
VASurfaceID reconstructed_picture;
unsigned short picture_width;
unsigned short picture_height;
VABufferID coded_buf;
} VAEncPictureParameterBufferJPEG;
/****************************
* MPEG-2 data structures
****************************/
/* MPEG-2 Picture Parameter Buffer */
/*
* For each frame or field, and before any slice data, a single
* picture parameter buffer must be send.
*/
typedef struct _VAPictureParameterBufferMPEG2
{
unsigned short horizontal_size;
unsigned short vertical_size;
VASurfaceID forward_reference_picture;
VASurfaceID backward_reference_picture;
/* meanings of the following fields are the same as in the standard */
int picture_coding_type;
int f_code; /* pack all four fcode into this */
union {
struct {
unsigned int intra_dc_precision : 2;
unsigned int picture_structure : 2;
unsigned int top_field_first : 1;
unsigned int frame_pred_frame_dct : 1;
unsigned int concealment_motion_vectors : 1;
unsigned int q_scale_type : 1;
unsigned int intra_vlc_format : 1;
unsigned int alternate_scan : 1;
unsigned int repeat_first_field : 1;
unsigned int progressive_frame : 1;
unsigned int is_first_field : 1; /* indicate whether the current field
* is the first field for field picture
*/
} bits;
unsigned int value;
} picture_coding_extension;
} VAPictureParameterBufferMPEG2;
/* MPEG-2 Inverse Quantization Matrix Buffer */
typedef struct _VAIQMatrixBufferMPEG2
{
int load_intra_quantiser_matrix;
int load_non_intra_quantiser_matrix;
int load_chroma_intra_quantiser_matrix;
int load_chroma_non_intra_quantiser_matrix;
unsigned char intra_quantiser_matrix[64];
unsigned char non_intra_quantiser_matrix[64];
unsigned char chroma_intra_quantiser_matrix[64];
unsigned char chroma_non_intra_quantiser_matrix[64];
} VAIQMatrixBufferMPEG2;
/* MPEG-2 Slice Parameter Buffer */
typedef struct _VASliceParameterBufferMPEG2
{
unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
unsigned int slice_data_offset;/* the offset to the first byte of slice data */
unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
unsigned int slice_horizontal_position;
unsigned int slice_vertical_position;
int quantiser_scale_code;
int intra_slice_flag;
} VASliceParameterBufferMPEG2;
/* MPEG-2 Macroblock Parameter Buffer */
typedef struct _VAMacroblockParameterBufferMPEG2
{
unsigned short macroblock_address;
/*
* macroblock_address (in raster scan order)
* top-left: 0
* bottom-right: picture-height-in-mb*picture-width-in-mb - 1
*/
unsigned char macroblock_type; /* see definition below */
union {
struct {
unsigned int frame_motion_type : 2;
unsigned int field_motion_type : 2;
unsigned int dct_type : 1;
} bits;
unsigned int value;
} macroblock_modes;
unsigned char motion_vertical_field_select;
/*
* motion_vertical_field_select:
* see section 6.3.17.2 in the spec
* only the lower 4 bits are used
* bit 0: first vector forward
* bit 1: first vector backward
* bit 2: second vector forward
* bit 3: second vector backward
*/
short PMV[2][2][2]; /* see Table 7-7 in the spec */
unsigned short coded_block_pattern;
/*
* The bitplanes for coded_block_pattern are described
* in Figure 6.10-12 in the spec
*/
/* Number of skipped macroblocks after this macroblock */
unsigned short num_skipped_macroblocks;
} VAMacroblockParameterBufferMPEG2;
/*
* OR'd flags for macroblock_type (section 6.3.17.1 in the spec)
*/
#define VA_MB_TYPE_MOTION_FORWARD 0x02
#define VA_MB_TYPE_MOTION_BACKWARD 0x04
#define VA_MB_TYPE_MOTION_PATTERN 0x08
#define VA_MB_TYPE_MOTION_INTRA 0x10
/*
* MPEG-2 Residual Data Buffer
* For each macroblock, there wil be 64 shorts (16-bit) in the
* residual data buffer
*/
/****************************
* MPEG-4 Part 2 data structures
****************************/
/* MPEG-4 Picture Parameter Buffer */
/*
* For each frame or field, and before any slice data, a single
* picture parameter buffer must be send.
*/
typedef struct _VAPictureParameterBufferMPEG4
{
unsigned short vop_width;
unsigned short vop_height;
VASurfaceID forward_reference_picture;
VASurfaceID backward_reference_picture;
union {
struct {
unsigned int short_video_header : 1;
unsigned int chroma_format : 2;
unsigned int interlaced : 1;
unsigned int obmc_disable : 1;
unsigned int sprite_enable : 2;
unsigned int sprite_warping_accuracy : 2;
unsigned int quant_type : 1;
unsigned int quarter_sample : 1;
unsigned int data_partitioned : 1;
unsigned int reversible_vlc : 1;
unsigned int resync_marker_disable : 1;
} bits;
unsigned int value;
} vol_fields;
unsigned char no_of_sprite_warping_points;
short sprite_trajectory_du[3];
short sprite_trajectory_dv[3];
unsigned char quant_precision;
union {
struct {
unsigned int vop_coding_type : 2;
unsigned int backward_reference_vop_coding_type : 2;
unsigned int vop_rounding_type : 1;
unsigned int intra_dc_vlc_thr : 3;
unsigned int top_field_first : 1;
unsigned int alternate_vertical_scan_flag : 1;
} bits;
unsigned int value;
} vop_fields;
unsigned char vop_fcode_forward;
unsigned char vop_fcode_backward;
unsigned short vop_time_increment_resolution;
/* short header related */
unsigned char num_gobs_in_vop;
unsigned char num_macroblocks_in_gob;
/* for direct mode prediction */
short TRB;
short TRD;
} VAPictureParameterBufferMPEG4;
/* MPEG-4 Inverse Quantization Matrix Buffer */
typedef struct _VAIQMatrixBufferMPEG4
{
int load_intra_quant_mat;
int load_non_intra_quant_mat;
unsigned char intra_quant_mat[64];
unsigned char non_intra_quant_mat[64];
} VAIQMatrixBufferMPEG4;
/* MPEG-4 Slice Parameter Buffer */
typedef struct _VASliceParameterBufferMPEG4
{
unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
unsigned int slice_data_offset;/* the offset to the first byte of slice data */
unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
unsigned int macroblock_number;
int quant_scale;
} VASliceParameterBufferMPEG4;
/*
VC-1 data structures
*/
typedef enum /* see 7.1.1.32 */
{
VAMvMode1Mv = 0,
VAMvMode1MvHalfPel = 1,
VAMvMode1MvHalfPelBilinear = 2,
VAMvModeMixedMv = 3,
VAMvModeIntensityCompensation = 4
} VAMvModeVC1;
/* VC-1 Picture Parameter Buffer */
/*
* For each picture, and before any slice data, a picture parameter
* buffer must be send. Multiple picture parameter buffers may be
* sent for a single picture. In that case picture parameters will
* apply to all slice data that follow it until a new picture
* parameter buffer is sent.
*
* Notes:
* pic_quantizer_type should be set to the applicable quantizer
* type as defined by QUANTIZER (J.1.19) and either
* PQUANTIZER (7.1.1.8) or PQINDEX (7.1.1.6)
*/
typedef struct _VAPictureParameterBufferVC1
{
VASurfaceID forward_reference_picture;
VASurfaceID backward_reference_picture;
/* if out-of-loop post-processing is done on the render
target, then we need to keep the in-loop decoded
picture as a reference picture */
VASurfaceID inloop_decoded_picture;
/* sequence layer for AP or meta data for SP and MP */
union {
struct {
unsigned int pulldown : 1; /* SEQUENCE_LAYER::PULLDOWN */
unsigned int interlace : 1; /* SEQUENCE_LAYER::INTERLACE */
unsigned int tfcntrflag : 1; /* SEQUENCE_LAYER::TFCNTRFLAG */
unsigned int finterpflag : 1; /* SEQUENCE_LAYER::FINTERPFLAG */
unsigned int psf : 1; /* SEQUENCE_LAYER::PSF */
unsigned int multires : 1; /* METADATA::MULTIRES */
unsigned int overlap : 1; /* METADATA::OVERLAP */
unsigned int syncmarker : 1; /* METADATA::SYNCMARKER */
unsigned int rangered : 1; /* METADATA::RANGERED */
unsigned int max_b_frames : 3; /* METADATA::MAXBFRAMES */
unsigned int profile : 2; /* SEQUENCE_LAYER::PROFILE or The MSB of METADATA::PROFILE */
} bits;
unsigned int value;
} sequence_fields;
unsigned short coded_width; /* ENTRY_POINT_LAYER::CODED_WIDTH */
unsigned short coded_height; /* ENTRY_POINT_LAYER::CODED_HEIGHT */
union {
struct {
unsigned int broken_link : 1; /* ENTRY_POINT_LAYER::BROKEN_LINK */
unsigned int closed_entry : 1; /* ENTRY_POINT_LAYER::CLOSED_ENTRY */
unsigned int panscan_flag : 1; /* ENTRY_POINT_LAYER::PANSCAN_FLAG */
unsigned int loopfilter : 1; /* ENTRY_POINT_LAYER::LOOPFILTER */
} bits;
unsigned int value;
} entrypoint_fields;
unsigned char conditional_overlap_flag; /* ENTRY_POINT_LAYER::CONDOVER */
unsigned char fast_uvmc_flag; /* ENTRY_POINT_LAYER::FASTUVMC */
union {
struct {
unsigned int luma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPY_FLAG */
unsigned int luma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPY */
unsigned int chroma_flag : 1; /* ENTRY_POINT_LAYER::RANGE_MAPUV_FLAG */
unsigned int chroma : 3; /* ENTRY_POINT_LAYER::RANGE_MAPUV */
} bits;
unsigned int value;
} range_mapping_fields;
unsigned char b_picture_fraction; /* PICTURE_LAYER::BFRACTION */
unsigned char cbp_table; /* PICTURE_LAYER::CBPTAB/ICBPTAB */
unsigned char mb_mode_table; /* PICTURE_LAYER::MBMODETAB */
unsigned char range_reduction_frame;/* PICTURE_LAYER::RANGEREDFRM */
unsigned char rounding_control; /* PICTURE_LAYER::RNDCTRL */
unsigned char post_processing; /* PICTURE_LAYER::POSTPROC */
unsigned char picture_resolution_index; /* PICTURE_LAYER::RESPIC */
unsigned char luma_scale; /* PICTURE_LAYER::LUMSCALE */
unsigned char luma_shift; /* PICTURE_LAYER::LUMSHIFT */
union {
struct {
unsigned int picture_type : 3; /* PICTURE_LAYER::PTYPE */
unsigned int frame_coding_mode : 3; /* PICTURE_LAYER::FCM */
unsigned int top_field_first : 1; /* PICTURE_LAYER::TFF */
unsigned int is_first_field : 1; /* set to 1 if it is the first field */
unsigned int intensity_compensation : 1; /* PICTURE_LAYER::INTCOMP */
} bits;
unsigned int value;
} picture_fields;
union {
struct {
unsigned int mv_type_mb : 1; /* PICTURE::MVTYPEMB */
unsigned int direct_mb : 1; /* PICTURE::DIRECTMB */
unsigned int skip_mb : 1; /* PICTURE::SKIPMB */
unsigned int field_tx : 1; /* PICTURE::FIELDTX */
unsigned int forward_mb : 1; /* PICTURE::FORWARDMB */
unsigned int ac_pred : 1; /* PICTURE::ACPRED */
unsigned int overflags : 1; /* PICTURE::OVERFLAGS */
} flags;
unsigned int value;
} raw_coding;
union {
struct {
unsigned int bp_mv_type_mb : 1; /* PICTURE::MVTYPEMB */
unsigned int bp_direct_mb : 1; /* PICTURE::DIRECTMB */
unsigned int bp_skip_mb : 1; /* PICTURE::SKIPMB */
unsigned int bp_field_tx : 1; /* PICTURE::FIELDTX */
unsigned int bp_forward_mb : 1; /* PICTURE::FORWARDMB */
unsigned int bp_ac_pred : 1; /* PICTURE::ACPRED */
unsigned int bp_overflags : 1; /* PICTURE::OVERFLAGS */
} flags;
unsigned int value;
} bitplane_present; /* signal what bitplane is being passed via the bitplane buffer */
union {
struct {
unsigned int reference_distance_flag : 1;/* PICTURE_LAYER::REFDIST_FLAG */
unsigned int reference_distance : 5;/* PICTURE_LAYER::REFDIST */
unsigned int num_reference_pictures: 1;/* PICTURE_LAYER::NUMREF */
unsigned int reference_field_pic_indicator : 1;/* PICTURE_LAYER::REFFIELD */
} bits;
unsigned int value;
} reference_fields;
union {
struct {
unsigned int mv_mode : 3; /* PICTURE_LAYER::MVMODE */
unsigned int mv_mode2 : 3; /* PICTURE_LAYER::MVMODE2 */
unsigned int mv_table : 3; /* PICTURE_LAYER::MVTAB/IMVTAB */
unsigned int two_mv_block_pattern_table: 2; /* PICTURE_LAYER::2MVBPTAB */
unsigned int four_mv_switch : 1; /* PICTURE_LAYER::4MVSWITCH */
unsigned int four_mv_block_pattern_table : 2; /* PICTURE_LAYER::4MVBPTAB */
unsigned int extended_mv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_MV */
unsigned int extended_mv_range : 2; /* PICTURE_LAYER::MVRANGE */
unsigned int extended_dmv_flag : 1; /* ENTRY_POINT_LAYER::EXTENDED_DMV */
unsigned int extended_dmv_range : 2; /* PICTURE_LAYER::DMVRANGE */
} bits;
unsigned int value;
} mv_fields;
union {
struct {
unsigned int dquant : 2; /* ENTRY_POINT_LAYER::DQUANT */
unsigned int quantizer : 2; /* ENTRY_POINT_LAYER::QUANTIZER */
unsigned int half_qp : 1; /* PICTURE_LAYER::HALFQP */
unsigned int pic_quantizer_scale : 5;/* PICTURE_LAYER::PQUANT */
unsigned int pic_quantizer_type : 1;/* PICTURE_LAYER::PQUANTIZER */
unsigned int dq_frame : 1; /* VOPDQUANT::DQUANTFRM */
unsigned int dq_profile : 2; /* VOPDQUANT::DQPROFILE */
unsigned int dq_sb_edge : 2; /* VOPDQUANT::DQSBEDGE */
unsigned int dq_db_edge : 2; /* VOPDQUANT::DQDBEDGE */
unsigned int dq_binary_level : 1; /* VOPDQUANT::DQBILEVEL */
unsigned int alt_pic_quantizer : 5;/* VOPDQUANT::ALTPQUANT */
} bits;
unsigned int value;
} pic_quantizer_fields;
union {
struct {
unsigned int variable_sized_transform_flag : 1;/* ENTRY_POINT_LAYER::VSTRANSFORM */
unsigned int mb_level_transform_type_flag : 1;/* PICTURE_LAYER::TTMBF */
unsigned int frame_level_transform_type : 2;/* PICTURE_LAYER::TTFRM */
unsigned int transform_ac_codingset_idx1 : 2;/* PICTURE_LAYER::TRANSACFRM */
unsigned int transform_ac_codingset_idx2 : 2;/* PICTURE_LAYER::TRANSACFRM2 */
unsigned int intra_transform_dc_table : 1;/* PICTURE_LAYER::TRANSDCTAB */
} bits;
unsigned int value;
} transform_fields;
} VAPictureParameterBufferVC1;
/* VC-1 Bitplane Buffer
There will be at most three bitplanes coded in any picture header. To send
the bitplane data more efficiently, each byte is divided in two nibbles, with
each nibble carrying three bitplanes for one macroblock. The following table
shows the bitplane data arrangement within each nibble based on the picture
type.
Picture Type Bit3 Bit2 Bit1 Bit0
I or BI OVERFLAGS ACPRED FIELDTX
P MYTYPEMB SKIPMB DIRECTMB
B FORWARDMB SKIPMB DIRECTMB
Within each byte, the lower nibble is for the first MB and the upper nibble is
for the second MB. E.g. the lower nibble of the first byte in the bitplane
buffer is for Macroblock #1 and the upper nibble of the first byte is for
Macroblock #2 in the first row.
*/
/* VC-1 Slice Parameter Buffer */
typedef struct _VASliceParameterBufferVC1
{
unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
unsigned int slice_data_offset;/* the offset to the first byte of slice data */
unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
unsigned int macroblock_offset;/* the offset to the first bit of MB from the first byte of slice data */
unsigned int slice_vertical_position;
} VASliceParameterBufferVC1;
/* VC-1 Slice Data Buffer */
/*
This is simplely a buffer containing raw bit-stream bytes
*/
/****************************
* H.264/AVC data structures
****************************/
typedef struct _VAPictureH264
{
VASurfaceID picture_id;
unsigned int frame_idx;
unsigned int flags;
signed int TopFieldOrderCnt;
signed int BottomFieldOrderCnt;
} VAPictureH264;
/* flags in VAPictureH264 could be OR of the following */
#define VA_PICTURE_H264_INVALID 0x00000001
#define VA_PICTURE_H264_TOP_FIELD 0x00000002
#define VA_PICTURE_H264_BOTTOM_FIELD 0x00000004
#define VA_PICTURE_H264_SHORT_TERM_REFERENCE 0x00000008
#define VA_PICTURE_H264_LONG_TERM_REFERENCE 0x00000010
/* H.264 Picture Parameter Buffer */
/*
* For each picture, and before any slice data, a single
* picture parameter buffer must be send.
*/
typedef struct _VAPictureParameterBufferH264
{
VAPictureH264 CurrPic;
VAPictureH264 ReferenceFrames[16]; /* in DPB */
unsigned short picture_width_in_mbs_minus1;
unsigned short picture_height_in_mbs_minus1;
unsigned char bit_depth_luma_minus8;
unsigned char bit_depth_chroma_minus8;
unsigned char num_ref_frames;
union {
struct {
unsigned int chroma_format_idc : 2;
unsigned int residual_colour_transform_flag : 1;
unsigned int gaps_in_frame_num_value_allowed_flag : 1;
unsigned int frame_mbs_only_flag : 1;
unsigned int mb_adaptive_frame_field_flag : 1;
unsigned int direct_8x8_inference_flag : 1;
unsigned int MinLumaBiPredSize8x8 : 1; /* see A.3.3.2 */
unsigned int log2_max_frame_num_minus4 : 4;
unsigned int pic_order_cnt_type : 2;
unsigned int log2_max_pic_order_cnt_lsb_minus4 : 4;
unsigned int delta_pic_order_always_zero_flag : 1;
} bits;
unsigned int value;
} seq_fields;
unsigned char num_slice_groups_minus1;
unsigned char slice_group_map_type;
unsigned short slice_group_change_rate_minus1;
signed char pic_init_qp_minus26;
signed char pic_init_qs_minus26;
signed char chroma_qp_index_offset;
signed char second_chroma_qp_index_offset;
union {
struct {
unsigned int entropy_coding_mode_flag : 1;
unsigned int weighted_pred_flag : 1;
unsigned int weighted_bipred_idc : 2;
unsigned int transform_8x8_mode_flag : 1;
unsigned int field_pic_flag : 1;
unsigned int constrained_intra_pred_flag : 1;
unsigned int pic_order_present_flag : 1;
unsigned int deblocking_filter_control_present_flag : 1;
unsigned int redundant_pic_cnt_present_flag : 1;
unsigned int reference_pic_flag : 1; /* nal_ref_idc != 0 */
} bits;
unsigned int value;
} pic_fields;
unsigned short frame_num;
} VAPictureParameterBufferH264;
/* H.264 Inverse Quantization Matrix Buffer */
typedef struct _VAIQMatrixBufferH264
{
unsigned char ScalingList4x4[6][16];
unsigned char ScalingList8x8[2][64];
} VAIQMatrixBufferH264;
/*
* H.264 Slice Group Map Buffer
* When VAPictureParameterBufferH264::num_slice_group_minus1 is not equal to 0,
* A slice group map buffer should be sent for each picture if required. The buffer
* is sent only when there is a change in the mapping values.
* The slice group map buffer map "map units" to slice groups as specified in
* section 8.2.2 of the H.264 spec. The buffer will contain one byte for each macroblock
* in raster scan order
*/
/* H.264 Slice Parameter Buffer */
typedef struct _VASliceParameterBufferH264
{
unsigned int slice_data_size;/* number of bytes in the slice data buffer for this slice */
unsigned int slice_data_offset;/* the offset to the NAL start code for this slice */
unsigned int slice_data_flag; /* see VA_SLICE_DATA_FLAG_XXX defintions */
unsigned short slice_data_bit_offset; /* bit offset from NAL start code to the beginning of slice data */
unsigned short first_mb_in_slice;
unsigned char slice_type;
unsigned char direct_spatial_mv_pred_flag;
unsigned char num_ref_idx_l0_active_minus1;
unsigned char num_ref_idx_l1_active_minus1;
unsigned char cabac_init_idc;
char slice_qp_delta;
unsigned char disable_deblocking_filter_idc;
char slice_alpha_c0_offset_div2;
char slice_beta_offset_div2;
VAPictureH264 RefPicList0[32]; /* See 8.2.4.2 */
VAPictureH264 RefPicList1[32]; /* See 8.2.4.2 */
unsigned char luma_log2_weight_denom;
unsigned char chroma_log2_weight_denom;
unsigned char luma_weight_l0_flag;
short luma_weight_l0[32];
short luma_offset_l0[32];
unsigned char chroma_weight_l0_flag;
short chroma_weight_l0[32][2];
short chroma_offset_l0[32][2];
unsigned char luma_weight_l1_flag;
short luma_weight_l1[32];
short luma_offset_l1[32];
unsigned char chroma_weight_l1_flag;
short chroma_weight_l1[32][2];
short chroma_offset_l1[32][2];
} VASliceParameterBufferH264;
/****************************
* Common encode data structures
****************************/
typedef enum
{
VAEncPictureTypeIntra = 0,
VAEncPictureTypePredictive = 1,
VAEncPictureTypeBidirectional = 2,
} VAEncPictureType;
/* Encode Slice Parameter Buffer */
typedef struct _VAEncSliceParameterBuffer
{
unsigned int start_row_number; /* starting MB row number for this slice */
unsigned int slice_height; /* slice height measured in MB */
union {
struct {
unsigned int is_intra : 1;
unsigned int disable_deblocking_filter_idc : 2;
unsigned int uses_long_term_ref :1;
unsigned int is_long_term_ref :1;
} bits;
unsigned int value;
} slice_flags;
} VAEncSliceParameterBuffer;
/****************************
* H.264 specific encode data structures
****************************/
typedef struct _VAEncSequenceParameterBufferH264
{
unsigned char seq_parameter_set_id;
unsigned char level_idc;
unsigned int intra_period;
unsigned int intra_idr_period;
unsigned int max_num_ref_frames;
unsigned int picture_width_in_mbs;
unsigned int picture_height_in_mbs;
unsigned int bits_per_second;
unsigned int frame_rate;
unsigned int initial_qp;
unsigned int min_qp;
unsigned int basic_unit_size;
unsigned char vui_flag;
} VAEncSequenceParameterBufferH264;
#define H264_LAST_PICTURE_EOSEQ 0x01 /* the last picture in the sequence */
#define H264_LAST_PICTURE_EOSTREAM 0x02 /* the last picture in the stream */
typedef struct _VAEncPictureParameterBufferH264
{
VASurfaceID reference_picture;
VASurfaceID reconstructed_picture;
VABufferID coded_buf;
unsigned short picture_width;
unsigned short picture_height;
unsigned char last_picture;
} VAEncPictureParameterBufferH264;
/****************************
* H.263 specific encode data structures
****************************/
typedef struct _VAEncSequenceParameterBufferH263
{
unsigned int intra_period;
unsigned int bits_per_second;
unsigned int frame_rate;
unsigned int initial_qp;
unsigned int min_qp;
} VAEncSequenceParameterBufferH263;
typedef struct _VAEncPictureParameterBufferH263
{
VASurfaceID reference_picture;
VASurfaceID reconstructed_picture;
VABufferID coded_buf;
unsigned short picture_width;
unsigned short picture_height;
VAEncPictureType picture_type;
} VAEncPictureParameterBufferH263;
/****************************
* MPEG-4 specific encode data structures
****************************/
typedef struct _VAEncSequenceParameterBufferMPEG4
{
unsigned char profile_and_level_indication;
unsigned int intra_period;
unsigned int video_object_layer_width;
unsigned int video_object_layer_height;
unsigned int vop_time_increment_resolution;
unsigned int fixed_vop_rate;
unsigned int fixed_vop_time_increment;
unsigned int bits_per_second;
unsigned int frame_rate;
unsigned int initial_qp;
unsigned int min_qp;
} VAEncSequenceParameterBufferMPEG4;
typedef struct _VAEncPictureParameterBufferMPEG4
{
VASurfaceID reference_picture;
VASurfaceID reconstructed_picture;
VABufferID coded_buf;
unsigned short picture_width;
unsigned short picture_height;
unsigned int modulo_time_base; /* number of 1s */
unsigned int vop_time_increment;
VAEncPictureType picture_type;
} VAEncPictureParameterBufferMPEG4;
/* Buffer functions */
/*
* Creates a buffer for "num_elements" elements of "size" bytes and
* initalize with "data".
* if "data" is null, then the contents of the buffer data store
* are undefined.
* Basically there are two ways to get buffer data to the server side. One is
* to call vaCreateBuffer() with a non-null "data", which results the data being
* copied to the data store on the server side. A different method that
* eliminates this copy is to pass null as "data" when calling vaCreateBuffer(),
* and then use vaMapBuffer() to map the data store from the server side to the
* client address space for access.
* Note: image buffers are created by the library, not the client. Please see
* vaCreateImage on how image buffers are managed.
*/
VAStatus vaCreateBuffer (
VADisplay dpy,
VAContextID context,
VABufferType type, /* in */
unsigned int size, /* in */
unsigned int num_elements, /* in */
void *data, /* in */
VABufferID *buf_id /* out */
);
/*
* Convey to the server how many valid elements are in the buffer.
* e.g. if multiple slice parameters are being held in a single buffer,
* this will communicate to the server the number of slice parameters
* that are valid in the buffer.
*/
VAStatus vaBufferSetNumElements (
VADisplay dpy,
VABufferID buf_id, /* in */
unsigned int num_elements /* in */
);
/*
* device independent data structure for codedbuffer
*/
/*
* FICTURE_AVE_QP(bit7-0): The average Qp value used during this frame
* LARGE_SLICE(bit8):At least one slice in the current frame was large
* enough for the encoder to attempt to limit its size.
* SLICE_OVERFLOW(bit9): At least one slice in the current frame has
* exceeded the maximum slice size specified.
* BITRATE_OVERFLOW(bit10): The peak bitrate was exceeded for this frame.
* BITRATE_HIGH(bit11): The frame size got within the safety margin of the maximum size (VCM only)
* AIR_MB_OVER_THRESHOLD: the number of MBs adapted to Intra MB
*/
#define VA_CODED_BUF_STATUS_PICTURE_AVE_QP_MASK 0xff
#define VA_CODED_BUF_STATUS_LARGE_SLICE_MASK 0x100
#define VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK 0x200
#define VA_CODED_BUF_STATUS_BITRATE_OVERFLOW 0x400
#define VA_CODED_BUF_STATUS_BITRATE_HIGH 0x800
#define VA_CODED_BUF_STATUS_AIR_MB_OVER_THRESHOLD 0xff0000
/*
* device independent data structure for codedbuffer
*/
typedef struct _VACodedBufferSegment {
unsigned int size;/* size of the data buffer in the coded buffer segment, in bytes */
unsigned int bit_offset; /* bit offset into the data buffer where valid bitstream data begins */
unsigned int status; /* status set by the driver on the coded buffer*/
unsigned int reserved; /* for future use */
void *buf; /* pointer to the beginning of the data buffer in the coded buffer segment */
void *next; /* pointer to the next VACodedBufferSegment */
} VACodedBufferSegment;
/*
* Map data store of the buffer into the client's address space
* vaCreateBuffer() needs to be called with "data" set to NULL before
* calling vaMapBuffer()
*
* if buffer type is VAEncCodedBufferType, pbuf points to link-list of
* VACodedBufferSegment, and the list is terminated if "next" is NULL
*/
VAStatus vaMapBuffer (
VADisplay dpy,
VABufferID buf_id, /* in */
void **pbuf /* out */
);
/*
* After client making changes to a mapped data store, it needs to
* "Unmap" it to let the server know that the data is ready to be
* consumed by the server
*/
VAStatus vaUnmapBuffer (
VADisplay dpy,
VABufferID buf_id /* in */
);
/*
* After this call, the buffer is deleted and this buffer_id is no longer valid
* Only call this if the buffer is not going to be passed to vaRenderBuffer
*/
VAStatus vaDestroyBuffer (
VADisplay dpy,
VABufferID buffer_id
);
/*
Render (Decode) Pictures
A picture represents either a frame or a field.
The Begin/Render/End sequence sends the decode buffers to the server
*/
/*
* Get ready to decode a picture to a target surface
*/
VAStatus vaBeginPicture (
VADisplay dpy,
VAContextID context,
VASurfaceID render_target
);
/*
* Send decode buffers to the server.
* Buffers are automatically destroyed afterwards
*/
VAStatus vaRenderPicture (
VADisplay dpy,
VAContextID context,
VABufferID *buffers,
int num_buffers
);
/*
* Make the end of rendering for a picture.
* The server should start processing all pending operations for this
* surface. This call is non-blocking. The client can start another
* Begin/Render/End sequence on a different render target.
*/
VAStatus vaEndPicture (
VADisplay dpy,
VAContextID context
);
/*
Synchronization
*/
/*
* This function blocks until all pending operations on the render target
* have been completed. Upon return it is safe to use the render target for a
* different picture.
*/
VAStatus vaSyncSurface (
VADisplay dpy,
VASurfaceID render_target
);
typedef enum
{
VASurfaceRendering = 1, /* Rendering in progress */
VASurfaceDisplaying = 2, /* Displaying in progress (not safe to render into it) */
/* this status is useful if surface is used as the source */
/* of an overlay */
VASurfaceReady = 4, /* not being rendered or displayed */
VASurfaceSkipped = 8 /* Indicate a skipped frame during encode */
} VASurfaceStatus;
/*
* Find out any pending ops on the render target
*/
VAStatus vaQuerySurfaceStatus (
VADisplay dpy,
VASurfaceID render_target,
VASurfaceStatus *status /* out */
);
typedef enum
{
VADecodeSliceMissing = 0,
VADecodeMBError = 1,
} VADecodeErrorType;
/*
* Client calls vaQuerySurfaceError with VA_STATUS_ERROR_DECODING_ERROR, server side returns
* an array of structure VASurfaceDecodeMBErrors, and the array is terminated by setting status=-1
*/
typedef struct _VASurfaceDecodeMBErrors
{
int status; /* 1 if hardware has returned detailed info below, -1 means this record is invalid */
unsigned int start_mb; /* start mb address with errors */
unsigned int end_mb; /* end mb address with errors */
VADecodeErrorType decode_error_type;
} VASurfaceDecodeMBErrors;
/*
* After the application gets VA_STATUS_ERROR_DECODING_ERROR after calling vaSyncSurface(),
* it can call vaQuerySurfaceError to find out further details on the particular error.
* VA_STATUS_ERROR_DECODING_ERROR should be passed in as "error_status",
* upon the return, error_info will point to an array of _VASurfaceDecodeMBErrors structure,
* which is allocated and filled by libVA with detailed information on the missing or error macroblocks.
* The array is terminated if "status==-1" is detected.
*/
VAStatus vaQuerySurfaceError(
VADisplay dpy,
VASurfaceID surface,
VAStatus error_status,
void **error_info
);
/*
* Images and Subpictures
* VAImage is used to either get the surface data to client memory, or
* to copy image data in client memory to a surface.
* Both images, subpictures and surfaces follow the same 2D coordinate system where origin
* is at the upper left corner with positive X to the right and positive Y down
*/
#define VA_FOURCC(ch0, ch1, ch2, ch3) \
((unsigned long)(unsigned char) (ch0) | ((unsigned long)(unsigned char) (ch1) << 8) | \
((unsigned long)(unsigned char) (ch2) << 16) | ((unsigned long)(unsigned char) (ch3) << 24 ))
/* a few common FourCCs */
#define VA_FOURCC_NV12 0x3231564E
#define VA_FOURCC_AI44 0x34344149
#define VA_FOURCC_RGBA 0x41424752
#define VA_FOURCC_BGRA 0x41524742
#define VA_FOURCC_UYVY 0x59565955
#define VA_FOURCC_YUY2 0x32595559
#define VA_FOURCC_AYUV 0x56555941
#define VA_FOURCC_NV11 0x3131564e
#define VA_FOURCC_YV12 0x32315659
#define VA_FOURCC_P208 0x38303250
#define VA_FOURCC_IYUV 0x56555949
/* byte order */
#define VA_LSB_FIRST 1
#define VA_MSB_FIRST 2
typedef struct _VAImageFormat
{
unsigned int fourcc;
unsigned int byte_order; /* VA_LSB_FIRST, VA_MSB_FIRST */
unsigned int bits_per_pixel;
/* for RGB formats */
unsigned int depth; /* significant bits per pixel */
unsigned int red_mask;
unsigned int green_mask;
unsigned int blue_mask;
unsigned int alpha_mask;
} VAImageFormat;
typedef VAGenericID VAImageID;
typedef struct _VAImage
{
VAImageID image_id; /* uniquely identify this image */
VAImageFormat format;
VABufferID buf; /* image data buffer */
/*
* Image data will be stored in a buffer of type VAImageBufferType to facilitate
* data store on the server side for optimal performance. The buffer will be
* created by the CreateImage function, and proper storage allocated based on the image
* size and format. This buffer is managed by the library implementation, and
* accessed by the client through the buffer Map/Unmap functions.
*/
unsigned short width;
unsigned short height;
unsigned int data_size;
unsigned int num_planes; /* can not be greater than 3 */
/*
* An array indicating the scanline pitch in bytes for each plane.
* Each plane may have a different pitch. Maximum 3 planes for planar formats
*/
unsigned int pitches[3];
/*
* An array indicating the byte offset from the beginning of the image data
* to the start of each plane.
*/
unsigned int offsets[3];
/* The following fields are only needed for paletted formats */
int num_palette_entries; /* set to zero for non-palette images */
/*
* Each component is one byte and entry_bytes indicates the number of components in
* each entry (eg. 3 for YUV palette entries). set to zero for non-palette images
*/
int entry_bytes;
/*
* An array of ascii characters describing the order of the components within the bytes.
* Only entry_bytes characters of the string are used.
*/
char component_order[4];
} VAImage;
/* Get maximum number of image formats supported by the implementation */
int vaMaxNumImageFormats (
VADisplay dpy
);
/*
* Query supported image formats
* The caller must provide a "format_list" array that can hold at
* least vaMaxNumImageFormats() entries. The actual number of formats
* returned in "format_list" is returned in "num_formats".
*/
VAStatus vaQueryImageFormats (
VADisplay dpy,
VAImageFormat *format_list, /* out */
int *num_formats /* out */
);
/*
* Create a VAImage structure
* The width and height fields returned in the VAImage structure may get
* enlarged for some YUV formats. Upon return from this function,
* image->buf has been created and proper storage allocated by the library.
* The client can access the image through the Map/Unmap calls.
*/
VAStatus vaCreateImage (
VADisplay dpy,
VAImageFormat *format,
int width,
int height,
VAImage *image /* out */
);
/*
* Should call DestroyImage before destroying the surface it is bound to
*/
VAStatus vaDestroyImage (
VADisplay dpy,
VAImageID image
);
VAStatus vaSetImagePalette (
VADisplay dpy,
VAImageID image,
/*
* pointer to an array holding the palette data. The size of the array is
* num_palette_entries * entry_bytes in size. The order of the components
* in the palette is described by the component_order in VAImage struct
*/
unsigned char *palette
);
/*
* Retrive surface data into a VAImage
* Image must be in a format supported by the implementation
*/
VAStatus vaGetImage (
VADisplay dpy,
VASurfaceID surface,
int x, /* coordinates of the upper left source pixel */
int y,
unsigned int width, /* width and height of the region */
unsigned int height,
VAImageID image
);
/*
* Copy data from a VAImage to a surface
* Image must be in a format supported by the implementation
* Returns a VA_STATUS_ERROR_SURFACE_BUSY if the surface
* shouldn't be rendered into when this is called
*/
VAStatus vaPutImage (
VADisplay dpy,
VASurfaceID surface,
VAImageID image,
int src_x,
int src_y,
unsigned int src_width,
unsigned int src_height,
int dest_x,
int dest_y,
unsigned int dest_width,
unsigned int dest_height
);
/*
* Derive an VAImage from an existing surface.
* This interface will derive a VAImage and corresponding image buffer from
* an existing VA Surface. The image buffer can then be mapped/unmapped for
* direct CPU access. This operation is only possible on implementations with
* direct rendering capabilities and internal surface formats that can be
* represented with a VAImage. When the operation is not possible this interface
* will return VA_STATUS_ERROR_OPERATION_FAILED. Clients should then fall back
* to using vaCreateImage + vaPutImage to accomplish the same task in an
* indirect manner.
*
* Implementations should only return success when the resulting image buffer
* would be useable with vaMap/Unmap.
*
* When directly accessing a surface special care must be taken to insure
* proper synchronization with the graphics hardware. Clients should call
* vaQuerySurfaceStatus to insure that a surface is not the target of concurrent
* rendering or currently being displayed by an overlay.
*
* Additionally nothing about the contents of a surface should be assumed
* following a vaPutSurface. Implementations are free to modify the surface for
* scaling or subpicture blending within a call to vaPutImage.
*
* Calls to vaPutImage or vaGetImage using the same surface from which the image
* has been derived will return VA_STATUS_ERROR_SURFACE_BUSY. vaPutImage or
* vaGetImage with other surfaces is supported.
*
* An image created with vaDeriveImage should be freed with vaDestroyImage. The
* image and image buffer structures will be destroyed; however, the underlying
* surface will remain unchanged until freed with vaDestroySurfaces.
*/
VAStatus vaDeriveImage (
VADisplay dpy,
VASurfaceID surface,
VAImage *image /* out */
);
/*
* Subpictures
* Subpicture is a special type of image that can be blended
* with a surface during vaPutSurface(). Subpicture can be used to render
* DVD sub-titles or closed captioning text etc.
*/
typedef VAGenericID VASubpictureID;
/* Get maximum number of subpicture formats supported by the implementation */
int vaMaxNumSubpictureFormats (
VADisplay dpy
);
/* flags for subpictures */
#define VA_SUBPICTURE_CHROMA_KEYING 0x0001
#define VA_SUBPICTURE_GLOBAL_ALPHA 0x0002
#define VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD 0x0004
/*
* Query supported subpicture formats
* The caller must provide a "format_list" array that can hold at
* least vaMaxNumSubpictureFormats() entries. The flags arrary holds the flag
* for each format to indicate additional capabilities for that format. The actual
* number of formats returned in "format_list" is returned in "num_formats".
* flags: returned value to indicate addtional capabilities
* VA_SUBPICTURE_CHROMA_KEYING - supports chroma-keying
* VA_SUBPICTURE_GLOBAL_ALPHA - supports global alpha
* VA_SUBPICTURE_DESTINATION_IS_SCREEN_COORD - supports unscaled screen relative subpictures for On Screen Display
*/
VAStatus vaQuerySubpictureFormats (
VADisplay dpy,
VAImageFormat *format_list, /* out */
unsigned int *flags, /* out */
unsigned int *num_formats /* out */
);
/*
* Subpictures are created with an image associated.
*/
VAStatus vaCreateSubpicture (
VADisplay dpy,
VAImageID image,
VASubpictureID *subpicture /* out */
);
/*
* Destroy the subpicture before destroying the image it is assocated to
*/
VAStatus vaDestroySubpicture (
VADisplay dpy,
VASubpictureID subpicture
);
/*
* Bind an image to the subpicture. This image will now be associated with
* the subpicture instead of the one at creation.
*/
VAStatus vaSetSubpictureImage (
VADisplay dpy,
VASubpictureID subpicture,
VAImageID image
);
/*
* If chromakey is enabled, then the area where the source value falls within
* the chromakey [min, max] range is transparent
* The chromakey component format is the following:
* For RGB: [0:7] Red [8:15] Blue [16:23] Green
* For YUV: [0:7] V [8:15] U [16:23] Y
* The chromakey mask can be used to mask out certain components for chromakey
* comparision
*/
VAStatus vaSetSubpictureChromakey (
VADisplay dpy,
VASubpictureID subpicture,
unsigned int chromakey_min,
unsigned int chromakey_max,
unsigned int chromakey_mask
);
/*
* Global alpha value is between 0 and 1. A value of 1 means fully opaque and
* a value of 0 means fully transparent. If per-pixel alpha is also specified then
* the overall alpha is per-pixel alpha multiplied by the global alpha
*/
VAStatus vaSetSubpictureGlobalAlpha (
VADisplay dpy,
VASubpictureID subpicture,
float global_alpha
);
/*
* vaAssociateSubpicture associates the subpicture with target_surfaces.
* It defines the region mapping between the subpicture and the target
* surfaces through source and destination rectangles (with the same width and height).
* Both will be displayed at the next call to vaPutSurface. Additional
* associations before the call to vaPutSurface simply overrides the association.
*/
VAStatus vaAssociateSubpicture (
VADisplay dpy,
VASubpictureID subpicture,
VASurfaceID *target_surfaces,
int num_surfaces,
short src_x, /* upper left offset in subpicture */
short src_y,
unsigned short src_width,
unsigned short src_height,
short dest_x, /* upper left offset in surface */
short dest_y,
unsigned short dest_width,
unsigned short dest_height,
/*
* whether to enable chroma-keying, global-alpha, or screen relative mode
* see VA_SUBPICTURE_XXX values
*/
unsigned int flags
);
/*
* vaDeassociateSubpicture removes the association of the subpicture with target_surfaces.
*/
VAStatus vaDeassociateSubpicture (
VADisplay dpy,
VASubpictureID subpicture,
VASurfaceID *target_surfaces,
int num_surfaces
);
typedef struct _VARectangle
{
short x;
short y;
unsigned short width;
unsigned short height;
} VARectangle;
/*
* Display attributes
* Display attributes are used to control things such as contrast, hue, saturation,
* brightness etc. in the rendering process. The application can query what
* attributes are supported by the driver, and then set the appropriate attributes
* before calling vaPutSurface()
*/
/* PowerVR IEP Lite attributes */
typedef enum
{
VADISPLAYATTRIB_BLE_OFF = 0x00,
VADISPLAYATTRIB_BLE_LOW,
VADISPLAYATTRIB_BLE_MEDIUM,
VADISPLAYATTRIB_BLE_HIGH,
VADISPLAYATTRIB_BLE_NONE,
} VADisplayAttribBLEMode;
/* attribute value for VADisplayAttribRotation */
#define VA_ROTATION_NONE 0x00000000
#define VA_ROTATION_90 0x00000001
#define VA_ROTATION_180 0x00000002
#define VA_ROTATION_270 0x00000003
/* attribute value for VADisplayAttribOutOfLoopDeblock */
#define VA_OOL_DEBLOCKING_FALSE 0x00000000
#define VA_OOL_DEBLOCKING_TRUE 0x00000001
/* Render mode */
#define VA_RENDER_MODE_UNDEFINED 0
#define VA_RENDER_MODE_LOCAL_OVERLAY 1
#define VA_RENDER_MODE_LOCAL_GPU 2
#define VA_RENDER_MODE_EXTERNAL_OVERLAY 4
#define VA_RENDER_MODE_EXTERNAL_GPU 8
/* Render device */
#define VA_RENDER_DEVICE_UNDEFINED 0
#define VA_RENDER_DEVICE_LOCAL 1
#define VA_RENDER_DEVICE_EXTERNAL 2
/* Currently defined display attribute types */
typedef enum
{
VADisplayAttribBrightness = 0,
VADisplayAttribContrast = 1,
VADisplayAttribHue = 2,
VADisplayAttribSaturation = 3,
/* client can specifiy a background color for the target window
* the new feature of video conference,
* the uncovered area of the surface is filled by this color
* also it will blend with the decoded video color
*/
VADisplayAttribBackgroundColor = 4,
/*
* this is a gettable only attribute. For some implementations that use the
* hardware overlay, after PutSurface is called, the surface can not be
* re-used until after the subsequent PutSurface call. If this is the case
* then the value for this attribute will be set to 1 so that the client
* will not attempt to re-use the surface right after returning from a call
* to PutSurface.
*
* Don't use it, use flag VASurfaceDisplaying of vaQuerySurfaceStatus since
* driver may use overlay or GPU alternatively
*/
VADisplayAttribDirectSurface = 5,
VADisplayAttribRotation = 6,
VADisplayAttribOutofLoopDeblock = 7,
/* PowerVR IEP Lite specific attributes */
VADisplayAttribBLEBlackMode = 8,
VADisplayAttribBLEWhiteMode = 9,
VADisplayAttribBlueStretch = 10,
VADisplayAttribSkinColorCorrection = 11,
/*
* For type VADisplayAttribCSCMatrix, "value" field is a pointer to the color
* conversion matrix. Each element in the matrix is float-point
*/
VADisplayAttribCSCMatrix = 12,
/* specify the constant color used to blend with video surface
* Cd = Cv*Cc*Ac + Cb *(1 - Ac) C means the constant RGB
* d: the final color to overwrite into the frame buffer
* v: decoded video after color conversion,
* c: video color specified by VADisplayAttribBlendColor
* b: background color of the drawable
*/
VADisplayAttribBlendColor = 13,
/*
* Indicate driver to skip painting color key or not.
* only applicable if the render is overlay
*/
VADisplayAttribOverlayAutoPaintColorKey = 14,
/*
* customized overlay color key, the format is RGB888
* [23:16] = Red, [15:08] = Green, [07:00] = Blue.
*/
VADisplayAttribOverlayColorKey = 15,
/*
* The hint for the implementation of vaPutSurface
* normally, the driver could use an overlay or GPU to render the surface on the screen
* this flag provides APP the flexibity to switch the render dynamically
*/
VADisplayAttribRenderMode = 16,
/*
* specify if vaPutSurface needs to render into specified monitors
* one example is that one external monitor (e.g. HDMI) is enabled,
* but the window manager is not aware of it, and there is no associated drawable
*/
VADisplayAttribRenderDevice = 17,
/*
* specify vaPutSurface render area if there is no drawable on the monitor
*/
VADisplayAttribRenderRect = 18,
} VADisplayAttribType;
/* flags for VADisplayAttribute */
#define VA_DISPLAY_ATTRIB_NOT_SUPPORTED 0x0000
#define VA_DISPLAY_ATTRIB_GETTABLE 0x0001
#define VA_DISPLAY_ATTRIB_SETTABLE 0x0002
typedef struct _VADisplayAttribute
{
VADisplayAttribType type;
int min_value;
int max_value;
int value; /* used by the set/get attribute functions */
/* flags can be VA_DISPLAY_ATTRIB_GETTABLE or VA_DISPLAY_ATTRIB_SETTABLE or OR'd together */
unsigned int flags;
} VADisplayAttribute;
/* Get maximum number of display attributs supported by the implementation */
int vaMaxNumDisplayAttributes (
VADisplay dpy
);
/*
* Query display attributes
* The caller must provide a "attr_list" array that can hold at
* least vaMaxNumDisplayAttributes() entries. The actual number of attributes
* returned in "attr_list" is returned in "num_attributes".
*/
VAStatus vaQueryDisplayAttributes (
VADisplay dpy,
VADisplayAttribute *attr_list, /* out */
int *num_attributes /* out */
);
/*
* Get display attributes
* This function returns the current attribute values in "attr_list".
* Only attributes returned with VA_DISPLAY_ATTRIB_GETTABLE set in the "flags" field
* from vaQueryDisplayAttributes() can have their values retrieved.
*/
VAStatus vaGetDisplayAttributes (
VADisplay dpy,
VADisplayAttribute *attr_list, /* in/out */
int num_attributes
);
/*
* Set display attributes
* Only attributes returned with VA_DISPLAY_ATTRIB_SETTABLE set in the "flags" field
* from vaQueryDisplayAttributes() can be set. If the attribute is not settable or
* the value is out of range, the function returns VA_STATUS_ERROR_ATTR_NOT_SUPPORTED
*/
VAStatus vaSetDisplayAttributes (
VADisplay dpy,
VADisplayAttribute *attr_list,
int num_attributes
);
#ifdef __cplusplus
}
#endif
#endif /* _VA_H_ */
|