/usr/share/gir-1.0/GstVideo-0.10.gir is in libgstreamer-plugins-base0.10-dev 0.10.36-1ubuntu0.2.
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 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 | <?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="GLib" version="2.0"/>
<include name="GModule" version="2.0"/>
<include name="GObject" version="2.0"/>
<include name="Gst" version="0.10"/>
<include name="GstBase" version="0.10"/>
<include name="libxml2" version="2.0"/>
<package name="gstreamer-video-0.10"/>
<c:include name="gst/video/gstvideofilter.h"/>
<c:include name="gst/video/gstvideosink.h"/>
<c:include name="gst/video/video-enumtypes.h"/>
<c:include name="gst/video/video-overlay-composition.h"/>
<c:include name="gst/video/video.h"/>
<namespace name="GstVideo"
version="0.10"
shared-library="libgstvideo-0.10.so.0"
c:identifier-prefixes="Gst"
c:symbol-prefixes="gst">
<constant name="VIDEO_BYTE1_MASK_24"
value="0x00FF0000"
c:type="GST_VIDEO_BYTE1_MASK_24">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_BYTE1_MASK_24_INT"
value="16711680"
c:type="GST_VIDEO_BYTE1_MASK_24_INT">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_BYTE1_MASK_32"
value="0xFF000000"
c:type="GST_VIDEO_BYTE1_MASK_32">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_BYTE1_MASK_32_INT"
value="4278190080"
c:type="GST_VIDEO_BYTE1_MASK_32_INT">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_BYTE2_MASK_24"
value="0x0000FF00"
c:type="GST_VIDEO_BYTE2_MASK_24">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_BYTE2_MASK_24_INT"
value="65280"
c:type="GST_VIDEO_BYTE2_MASK_24_INT">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_BYTE2_MASK_32"
value="0x00FF0000"
c:type="GST_VIDEO_BYTE2_MASK_32">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_BYTE2_MASK_32_INT"
value="16711680"
c:type="GST_VIDEO_BYTE2_MASK_32_INT">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_BYTE3_MASK_24"
value="0x000000FF"
c:type="GST_VIDEO_BYTE3_MASK_24">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_BYTE3_MASK_24_INT"
value="255"
c:type="GST_VIDEO_BYTE3_MASK_24_INT">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_BYTE3_MASK_32"
value="0x0000FF00"
c:type="GST_VIDEO_BYTE3_MASK_32">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_BYTE3_MASK_32_INT"
value="65280"
c:type="GST_VIDEO_BYTE3_MASK_32_INT">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_BYTE4_MASK_32"
value="0x000000FF"
c:type="GST_VIDEO_BYTE4_MASK_32">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_BYTE4_MASK_32_INT"
value="255"
c:type="GST_VIDEO_BYTE4_MASK_32_INT">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_CAPS_GRAY8"
value="video/x-raw-gray, bpp = (int) 8, depth = (int) 8, width = "
c:type="GST_VIDEO_CAPS_GRAY8">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_CAPS_RGB8_PALETTED"
value="video/x-raw-rgb, bpp = (int)8, depth = (int)8, width = "
c:type="GST_VIDEO_CAPS_RGB8_PALETTED">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_CAPS_r210"
value="video/x-raw-rgb, bpp = (int) 32, depth = (int) 30, endianness = (int) BIG_ENDIAN, red_mask = (int) 0x3ff00000, green_mask = (int) 0x000ffc00, blue_mask = (int) 0x000003ff, width = "
c:type="GST_VIDEO_CAPS_r210">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_COMP1_MASK_15"
value="0x7c00"
c:type="GST_VIDEO_COMP1_MASK_15">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_COMP1_MASK_15_INT"
value="31744"
c:type="GST_VIDEO_COMP1_MASK_15_INT">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_COMP1_MASK_16"
value="0xf800"
c:type="GST_VIDEO_COMP1_MASK_16">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_COMP1_MASK_16_INT"
value="63488"
c:type="GST_VIDEO_COMP1_MASK_16_INT">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_COMP2_MASK_15"
value="0x03e0"
c:type="GST_VIDEO_COMP2_MASK_15">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_COMP2_MASK_15_INT"
value="992"
c:type="GST_VIDEO_COMP2_MASK_15_INT">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_COMP2_MASK_16"
value="0x07e0"
c:type="GST_VIDEO_COMP2_MASK_16">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_COMP2_MASK_16_INT"
value="2016"
c:type="GST_VIDEO_COMP2_MASK_16_INT">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_COMP3_MASK_15"
value="0x001f"
c:type="GST_VIDEO_COMP3_MASK_15">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_COMP3_MASK_15_INT"
value="31"
c:type="GST_VIDEO_COMP3_MASK_15_INT">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_COMP3_MASK_16"
value="0x001f"
c:type="GST_VIDEO_COMP3_MASK_16">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_COMP3_MASK_16_INT"
value="31"
c:type="GST_VIDEO_COMP3_MASK_16_INT">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_FPS_RANGE"
value="(fraction) [ 0, max ]"
c:type="GST_VIDEO_FPS_RANGE">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_SIZE_RANGE"
value="(int) [ 1, max ]"
c:type="GST_VIDEO_SIZE_RANGE">
<type name="utf8" c:type="gchar*"/>
</constant>
<callback name="VideoConvertFrameCallback"
c:type="GstVideoConvertFrameCallback">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="error" transfer-ownership="none">
<type name="GLib.Error" c:type="GError*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="2">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<class name="VideoFilter"
c:symbol-prefix="video_filter"
c:type="GstVideoFilter"
parent="GstBase.BaseTransform"
abstract="1"
glib:type-name="GstVideoFilter"
glib:get-type="gst_video_filter_get_type"
glib:type-struct="VideoFilterClass">
<doc xml:whitespace="preserve"><refsect2>
<para>
Provides useful functions and a base class for video filters.
</para>
<para>
The videofilter will by default enable QoS on the parent GstBaseTransform
to implement frame dropping.
</para>
</refsect2></doc>
<field name="element">
<type name="GstBase.BaseTransform" c:type="GstBaseTransform"/>
</field>
<field name="inited">
<type name="gboolean" c:type="gboolean"/>
</field>
</class>
<record name="VideoFilterClass"
c:type="GstVideoFilterClass"
glib:is-gtype-struct-for="VideoFilter">
<doc xml:whitespace="preserve">The video filter class structure.</doc>
<field name="parent_class">
<type name="GstBase.BaseTransformClass"
c:type="GstBaseTransformClass"/>
</field>
</record>
<enumeration name="VideoFormat"
glib:type-name="GstVideoFormat"
glib:get-type="gst_video_format_get_type"
c:type="GstVideoFormat">
<doc xml:whitespace="preserve">Enum value describing the most common video formats.</doc>
<member name="unknown"
value="0"
c:identifier="GST_VIDEO_FORMAT_UNKNOWN"
glib:nick="unknown"/>
<member name="i420"
value="1"
c:identifier="GST_VIDEO_FORMAT_I420"
glib:nick="i420"/>
<member name="yv12"
value="2"
c:identifier="GST_VIDEO_FORMAT_YV12"
glib:nick="yv12"/>
<member name="yuy2"
value="3"
c:identifier="GST_VIDEO_FORMAT_YUY2"
glib:nick="yuy2"/>
<member name="uyvy"
value="4"
c:identifier="GST_VIDEO_FORMAT_UYVY"
glib:nick="uyvy"/>
<member name="ayuv"
value="5"
c:identifier="GST_VIDEO_FORMAT_AYUV"
glib:nick="ayuv"/>
<member name="rgbx"
value="6"
c:identifier="GST_VIDEO_FORMAT_RGBx"
glib:nick="rgbx"/>
<member name="bgrx"
value="7"
c:identifier="GST_VIDEO_FORMAT_BGRx"
glib:nick="bgrx"/>
<member name="xrgb"
value="8"
c:identifier="GST_VIDEO_FORMAT_xRGB"
glib:nick="xrgb"/>
<member name="xbgr"
value="9"
c:identifier="GST_VIDEO_FORMAT_xBGR"
glib:nick="xbgr"/>
<member name="rgba"
value="10"
c:identifier="GST_VIDEO_FORMAT_RGBA"
glib:nick="rgba"/>
<member name="bgra"
value="11"
c:identifier="GST_VIDEO_FORMAT_BGRA"
glib:nick="bgra"/>
<member name="argb"
value="12"
c:identifier="GST_VIDEO_FORMAT_ARGB"
glib:nick="argb"/>
<member name="abgr"
value="13"
c:identifier="GST_VIDEO_FORMAT_ABGR"
glib:nick="abgr"/>
<member name="rgb"
value="14"
c:identifier="GST_VIDEO_FORMAT_RGB"
glib:nick="rgb"/>
<member name="bgr"
value="15"
c:identifier="GST_VIDEO_FORMAT_BGR"
glib:nick="bgr"/>
<member name="y41b"
value="16"
c:identifier="GST_VIDEO_FORMAT_Y41B"
glib:nick="y41b"/>
<member name="y42b"
value="17"
c:identifier="GST_VIDEO_FORMAT_Y42B"
glib:nick="y42b"/>
<member name="yvyu"
value="18"
c:identifier="GST_VIDEO_FORMAT_YVYU"
glib:nick="yvyu"/>
<member name="y444"
value="19"
c:identifier="GST_VIDEO_FORMAT_Y444"
glib:nick="y444"/>
<member name="v210"
value="20"
c:identifier="GST_VIDEO_FORMAT_v210"
glib:nick="v210"/>
<member name="v216"
value="21"
c:identifier="GST_VIDEO_FORMAT_v216"
glib:nick="v216"/>
<member name="nv12"
value="22"
c:identifier="GST_VIDEO_FORMAT_NV12"
glib:nick="nv12"/>
<member name="nv21"
value="23"
c:identifier="GST_VIDEO_FORMAT_NV21"
glib:nick="nv21"/>
<member name="gray8"
value="24"
c:identifier="GST_VIDEO_FORMAT_GRAY8"
glib:nick="gray8"/>
<member name="gray16_be"
value="25"
c:identifier="GST_VIDEO_FORMAT_GRAY16_BE"
glib:nick="gray16-be"/>
<member name="gray16_le"
value="26"
c:identifier="GST_VIDEO_FORMAT_GRAY16_LE"
glib:nick="gray16-le"/>
<member name="v308"
value="27"
c:identifier="GST_VIDEO_FORMAT_v308"
glib:nick="v308"/>
<member name="y800"
value="28"
c:identifier="GST_VIDEO_FORMAT_Y800"
glib:nick="y800"/>
<member name="y16"
value="29"
c:identifier="GST_VIDEO_FORMAT_Y16"
glib:nick="y16"/>
<member name="rgb16"
value="30"
c:identifier="GST_VIDEO_FORMAT_RGB16"
glib:nick="rgb16"/>
<member name="bgr16"
value="31"
c:identifier="GST_VIDEO_FORMAT_BGR16"
glib:nick="bgr16"/>
<member name="rgb15"
value="32"
c:identifier="GST_VIDEO_FORMAT_RGB15"
glib:nick="rgb15"/>
<member name="bgr15"
value="33"
c:identifier="GST_VIDEO_FORMAT_BGR15"
glib:nick="bgr15"/>
<member name="uyvp"
value="34"
c:identifier="GST_VIDEO_FORMAT_UYVP"
glib:nick="uyvp"/>
<member name="a420"
value="35"
c:identifier="GST_VIDEO_FORMAT_A420"
glib:nick="a420"/>
<member name="rgb8_paletted"
value="36"
c:identifier="GST_VIDEO_FORMAT_RGB8_PALETTED"
glib:nick="rgb8-paletted"/>
<member name="yuv9"
value="37"
c:identifier="GST_VIDEO_FORMAT_YUV9"
glib:nick="yuv9"/>
<member name="yvu9"
value="38"
c:identifier="GST_VIDEO_FORMAT_YVU9"
glib:nick="yvu9"/>
<member name="iyu1"
value="39"
c:identifier="GST_VIDEO_FORMAT_IYU1"
glib:nick="iyu1"/>
<member name="argb64"
value="40"
c:identifier="GST_VIDEO_FORMAT_ARGB64"
glib:nick="argb64"/>
<member name="ayuv64"
value="41"
c:identifier="GST_VIDEO_FORMAT_AYUV64"
glib:nick="ayuv64"/>
<member name="r210"
value="42"
c:identifier="GST_VIDEO_FORMAT_r210"
glib:nick="r210"/>
<function name="convert"
c:identifier="gst_video_format_convert"
version="0.10.16">
<doc xml:whitespace="preserve">Converts among various #GstFormat types. This function handles
GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For
raw video, GST_FORMAT_DEFAULT corresponds to video frames. This
function can be to handle pad queries of the type GST_QUERY_CONVERT.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if the conversion was successful.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">the width of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">the height of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="fps_n" transfer-ownership="none">
<doc xml:whitespace="preserve">frame rate numerator</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="fps_d" transfer-ownership="none">
<doc xml:whitespace="preserve">frame rate denominator</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="src_format" transfer-ownership="none">
<doc xml:whitespace="preserve">#GstFormat of the @src_value</doc>
<type name="Gst.Format" c:type="GstFormat"/>
</parameter>
<parameter name="src_value" transfer-ownership="none">
<doc xml:whitespace="preserve">value to convert</doc>
<type name="gint64" c:type="gint64"/>
</parameter>
<parameter name="dest_format" transfer-ownership="none">
<doc xml:whitespace="preserve">#GstFormat of the @dest_value</doc>
<type name="Gst.Format" c:type="GstFormat"/>
</parameter>
<parameter name="dest_value" transfer-ownership="none">
<doc xml:whitespace="preserve">pointer to destination value</doc>
<type name="gint64" c:type="gint64*"/>
</parameter>
</parameters>
</function>
<function name="from_fourcc"
c:identifier="gst_video_format_from_fourcc"
version="0.10.16">
<doc xml:whitespace="preserve">Converts a FOURCC value into the corresponding #GstVideoFormat.
If the FOURCC cannot be represented by #GstVideoFormat,
#GST_VIDEO_FORMAT_UNKNOWN is returned.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstVideoFormat describing the FOURCC value</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</return-value>
<parameters>
<parameter name="fourcc" transfer-ownership="none">
<doc xml:whitespace="preserve">a FOURCC value representing raw YUV video</doc>
<type name="guint32" c:type="guint32"/>
</parameter>
</parameters>
</function>
<function name="get_component_depth"
c:identifier="gst_video_format_get_component_depth"
version="0.10.33">
<doc xml:whitespace="preserve">Returns the number of bits used to encode an individual pixel of
a given @component. Typically this is 8, although higher and lower
values are possible for some formats.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">depth of component</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="component" transfer-ownership="none">
<doc xml:whitespace="preserve">the video component (e.g. 0 for 'R' in RGB)</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="get_component_height"
c:identifier="gst_video_format_get_component_height"
version="0.10.16">
<doc xml:whitespace="preserve">Calculates the height of the component. See
@gst_video_format_get_row_stride for a description
of the component index.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">height of component @component</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="component" transfer-ownership="none">
<doc xml:whitespace="preserve">the component index</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">the height of video</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="get_component_offset"
c:identifier="gst_video_format_get_component_offset"
version="0.10.16">
<doc xml:whitespace="preserve">Calculates the offset (in bytes) of the first pixel of the component
with index @component. For packed formats, this will typically be a
small integer (0, 1, 2, 3). For planar formats, this will be a
(relatively) large offset to the beginning of the second or third
component planes. See @gst_video_format_get_row_stride for a description
of the component index.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">offset of component @component</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="component" transfer-ownership="none">
<doc xml:whitespace="preserve">the component index</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">the width of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">the height of video</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="get_component_width"
c:identifier="gst_video_format_get_component_width"
version="0.10.16">
<doc xml:whitespace="preserve">Calculates the width of the component. See
@gst_video_format_get_row_stride for a description
of the component index.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">width of component @component</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="component" transfer-ownership="none">
<doc xml:whitespace="preserve">the component index</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">the width of video</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="get_pixel_stride"
c:identifier="gst_video_format_get_pixel_stride"
version="0.10.16">
<doc xml:whitespace="preserve">Calculates the pixel stride (number of bytes from one pixel to the
pixel to its immediate left) for the video component with an index
of @component. See @gst_video_format_get_row_stride for a description
of the component index.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">pixel stride of component @component</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="component" transfer-ownership="none">
<doc xml:whitespace="preserve">the component index</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="get_row_stride"
c:identifier="gst_video_format_get_row_stride"
version="0.10.16">
<doc xml:whitespace="preserve">Calculates the row stride (number of bytes from one row of pixels to
the next) for the video component with an index of @component. For
YUV video, Y, U, and V have component indices of 0, 1, and 2,
respectively. For RGB video, R, G, and B have component indicies of
0, 1, and 2, respectively. Alpha channels, if present, have a component
index of 3. The @width parameter always represents the width of the
video, not the component.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">row stride of component @component</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="component" transfer-ownership="none">
<doc xml:whitespace="preserve">the component index</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">the width of video</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="get_size"
c:identifier="gst_video_format_get_size"
version="0.10.16">
<doc xml:whitespace="preserve">Calculates the total number of bytes in the raw video format. This
number should be used when allocating a buffer for raw video.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">size (in bytes) of raw video format</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">the width of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">the height of video</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="has_alpha"
c:identifier="gst_video_format_has_alpha"
version="0.10.16">
<doc xml:whitespace="preserve">Returns TRUE or FALSE depending on if the video format provides an
alpha channel.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if @format has an alpha channel</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="is_gray"
c:identifier="gst_video_format_is_gray"
version="0.10.29">
<doc xml:whitespace="preserve">Determine whether the video format is a grayscale format.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if @format represents grayscale video</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="is_rgb"
c:identifier="gst_video_format_is_rgb"
version="0.10.16">
<doc xml:whitespace="preserve">Determine whether the video format is an RGB format.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if @format represents RGB video</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="is_yuv"
c:identifier="gst_video_format_is_yuv"
version="0.10.16">
<doc xml:whitespace="preserve">Determine whether the video format is a YUV format.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if @format represents YUV video</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="new_caps"
c:identifier="gst_video_format_new_caps"
version="0.10.16">
<doc xml:whitespace="preserve">Creates a new #GstCaps object based on the parameters provided.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #GstCaps object, or NULL if there was an error</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstVideoFormat describing the raw video format</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">width of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">height of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="framerate_n" transfer-ownership="none">
<doc xml:whitespace="preserve">numerator of frame rate</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="framerate_d" transfer-ownership="none">
<doc xml:whitespace="preserve">denominator of frame rate</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="par_n" transfer-ownership="none">
<doc xml:whitespace="preserve">numerator of pixel aspect ratio</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="par_d" transfer-ownership="none">
<doc xml:whitespace="preserve">denominator of pixel aspect ratio</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="new_caps_interlaced"
c:identifier="gst_video_format_new_caps_interlaced"
version="0.10.23">
<doc xml:whitespace="preserve">Creates a new #GstCaps object based on the parameters provided.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #GstCaps object, or NULL if there was an error</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstVideoFormat describing the raw video format</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">width of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">height of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="framerate_n" transfer-ownership="none">
<doc xml:whitespace="preserve">numerator of frame rate</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="framerate_d" transfer-ownership="none">
<doc xml:whitespace="preserve">denominator of frame rate</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="par_n" transfer-ownership="none">
<doc xml:whitespace="preserve">numerator of pixel aspect ratio</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="par_d" transfer-ownership="none">
<doc xml:whitespace="preserve">denominator of pixel aspect ratio</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="interlaced" transfer-ownership="none">
<doc xml:whitespace="preserve">#TRUE if the format is interlaced</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="new_template_caps"
c:identifier="gst_video_format_new_template_caps"
version="0.10.33">
<doc xml:whitespace="preserve">Creates a new #GstCaps object based on the parameters provided.
Size, frame rate, and pixel aspect ratio are set to the full
range.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #GstCaps object, or NULL if there was an error</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstVideoFormat describing the raw video format</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="parse_caps"
c:identifier="gst_video_format_parse_caps"
version="0.10.16">
<doc xml:whitespace="preserve">Determines the #GstVideoFormat of @caps and places it in the location
pointed to by @format. Extracts the size of the video and places it
in the location pointed to by @width and @height. If @caps does not
represent a video format or does not contain height and width, the
function will fail and return FALSE. If @caps does not represent a raw
video format listed in #GstVideoFormat, but still contains video caps,
this function will return TRUE and set @format to #GST_VIDEO_FORMAT_UNKNOWN.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if @caps was parsed correctly.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="caps" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstCaps to parse</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstVideoFormat of the video represented by @caps (output)</doc>
<type name="VideoFormat" c:type="GstVideoFormat*"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">the width of the video represented by @caps, may be NULL (output)</doc>
<type name="gint" c:type="int*"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">the height of the video represented by @caps, may be NULL (output)</doc>
<type name="gint" c:type="int*"/>
</parameter>
</parameters>
</function>
<function name="parse_caps_interlaced"
c:identifier="gst_video_format_parse_caps_interlaced"
version="0.10.23">
<doc xml:whitespace="preserve">Extracts whether the caps represents interlaced content or not and places it
in @interlaced.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if @caps was parsed correctly.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="caps" transfer-ownership="none">
<doc xml:whitespace="preserve">the fixed #GstCaps to parse</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="interlaced" transfer-ownership="none">
<doc xml:whitespace="preserve">whether @caps represents interlaced video or not, may be NULL (output)</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</function>
<function name="to_fourcc"
c:identifier="gst_video_format_to_fourcc"
version="0.10.16">
<doc xml:whitespace="preserve">Converts a #GstVideoFormat value into the corresponding FOURCC. Only
a few YUV formats have corresponding FOURCC values. If @format has
no corresponding FOURCC value, 0 is returned.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the FOURCC corresponding to @format</doc>
<type name="guint32" c:type="guint32"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat video format</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
</enumeration>
<class name="VideoOverlayComposition"
c:symbol-prefix="video_overlay_composition"
c:type="GstVideoOverlayComposition"
version="0.10.36"
parent="Gst.MiniObject"
glib:type-name="GstVideoOverlayComposition"
glib:get-type="gst_video_overlay_composition_get_type"
glib:type-struct="VideoOverlayCompositionClass"
glib:fundamental="1">
<doc xml:whitespace="preserve"><refsect2>
<para>
Functions to create and handle overlay compositions on video buffers.
</para>
<para>
An overlay composition describes one or more overlay rectangles to be
blended on top of a video buffer.
</para>
<para>
This API serves two main purposes:
<itemizedlist>
<listitem>
it can be used to attach overlay information (subtitles or logos)
to non-raw video buffers such as GL/VAAPI/VDPAU surfaces. The actual
blending of the overlay can then be done by e.g. the video sink that
processes these non-raw buffers.
</listitem>
<listitem>
it can also be used to blend overlay rectangles on top of raw video
buffers, thus consolidating blending functionality for raw video in
one place.
</listitem>
Together, this allows existing overlay elements to easily handle raw
and non-raw video as input in without major changes (once the overlays
have been put into a #GstOverlayComposition object anyway) - for raw
video the overlay can just use the blending function to blend the data
on top of the video, and for surface buffers it can just attach them to
the buffer and let the sink render the overlays.
</itemizedlist>
</para>
</refsect2></doc>
<constructor name="new"
c:identifier="gst_video_overlay_composition_new"
version="0.10.36">
<doc xml:whitespace="preserve">Creates a new video overlay composition object to hold one or more
overlay rectangles.
gst_video_overlay_composition_unref() when no longer needed.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #GstVideoOverlayComposition. Unref with</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</return-value>
<parameters>
<parameter name="rectangle" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoOverlayRectangle to add to the composition</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</parameter>
</parameters>
</constructor>
<method name="add_rectangle"
c:identifier="gst_video_overlay_composition_add_rectangle"
version="0.10.36">
<doc xml:whitespace="preserve">Adds an overlay rectangle to an existing overlay composition object. This
must be done right after creating the overlay composition.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="rectangle" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoOverlayRectangle to add to the composition</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</parameter>
</parameters>
</method>
<method name="blend"
c:identifier="gst_video_overlay_composition_blend"
version="0.10.36">
<doc xml:whitespace="preserve">Blends the overlay rectangles in @comp on top of the raw video data
contained in @video_buf. The data in @video_buf must be writable. If
needed, use gst_buffer_make_writable() before calling this function to
ensure a buffer is writable. @video_buf must also have valid raw video
caps set on it.</doc>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_buf" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstBuffer containing raw video data in a supported format</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
</parameters>
</method>
<method name="copy"
c:identifier="gst_video_overlay_composition_copy"
version="0.10.36">
<doc xml:whitespace="preserve">Makes a copy of @comp and all contained rectangles, so that it is possible
to modify the composition and contained rectangles (e.g. add additional
rectangles or change the render co-ordinates or render dimension). The
actual overlay pixel data buffers contained in the rectangles are not
copied.
to @comp.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #GstVideoOverlayComposition equivalent</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</return-value>
</method>
<method name="get_rectangle"
c:identifier="gst_video_overlay_composition_get_rectangle"
version="0.10.36">
<doc xml:whitespace="preserve">Returns the @n-th #GstVideoOverlayRectangle contained in @comp.
bounds. Will not return a new reference, the caller will need to
obtain her own reference using gst_video_overlay_rectangle_ref()
if needed.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the @n-th rectangle, or NULL if @n is out of</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</return-value>
<parameters>
<parameter name="n" transfer-ownership="none">
<doc xml:whitespace="preserve">number of the rectangle to get</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_seqnum"
c:identifier="gst_video_overlay_composition_get_seqnum"
version="0.10.36">
<doc xml:whitespace="preserve">Returns the sequence number of this composition. Sequence numbers are
monotonically increasing and unique for overlay compositions and rectangles
(meaning there will never be a rectangle with the same sequence number as
a composition).</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the sequence number of @comp</doc>
<type name="guint" c:type="guint"/>
</return-value>
</method>
<method name="make_writable"
c:identifier="gst_video_overlay_composition_make_writable"
version="0.10.36">
<doc xml:whitespace="preserve">Takes ownership of @comp and returns a version of @comp that is writable
(i.e. can be modified). Will either return @comp right away, or create a
new writable copy of @comp and unref @comp itself. All the contained
rectangles will also be copied, but the actual overlay pixel data buffers
contained in the rectangles are not copied.
equivalent to @comp.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a writable #GstVideoOverlayComposition</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</return-value>
</method>
<method name="n_rectangles"
c:identifier="gst_video_overlay_composition_n_rectangles"
version="0.10.36">
<doc xml:whitespace="preserve">Returns the number of #GstVideoOverlayRectangle<!-- -->s contained in @comp.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the number of rectangles</doc>
<type name="guint" c:type="guint"/>
</return-value>
</method>
</class>
<record name="VideoOverlayCompositionClass"
c:type="GstVideoOverlayCompositionClass"
disguised="1"
glib:is-gtype-struct-for="VideoOverlayComposition">
</record>
<enumeration name="VideoOverlayFormatFlags"
version="0.10.36"
c:type="GstVideoOverlayFormatFlags">
<doc xml:whitespace="preserve">Overlay format flags.</doc>
<member name="video_overlay_format_flag_none"
value="0"
c:identifier="GST_VIDEO_OVERLAY_FORMAT_FLAG_NONE"/>
</enumeration>
<class name="VideoOverlayRectangle"
c:symbol-prefix="video_overlay_rectangle"
c:type="GstVideoOverlayRectangle"
version="0.10.36"
parent="Gst.MiniObject"
glib:type-name="GstVideoOverlayRectangle"
glib:get-type="gst_video_overlay_rectangle_get_type"
glib:type-struct="VideoOverlayRectangleClass"
glib:fundamental="1">
<doc xml:whitespace="preserve">An opaque video overlay rectangle object. A rectangle contains a single
overlay rectangle which can be added to a composition.</doc>
<constructor name="new_argb"
c:identifier="gst_video_overlay_rectangle_new_argb"
version="0.10.36">
<doc xml:whitespace="preserve">Creates a new video overlay rectangle with ARGB pixel data. The layout
of the components in memory is B-G-R-A on little-endian platforms
(corresponding to #GST_VIDEO_FORMAT_BGRA) and A-R-G-B on big-endian
platforms (corresponding to #GST_VIDEO_FORMAT_ARGB). In other words,
pixels are treated as 32-bit words and the lowest 8 bits then contain
the blue component value and the highest 8 bits contain the alpha
component value. The RGB values are non-premultiplied. This is the
format that is used by most hardware, and also many rendering libraries
such as Cairo, for example.
gst_video_overlay_rectangle_unref() when no longer needed.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #GstVideoOverlayRectangle. Unref with</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</return-value>
<parameters>
<parameter name="pixels" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstBuffer pointing to the pixel memory</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">the width of the rectangle in @pixels</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">the height of the rectangle in @pixels</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="stride" transfer-ownership="none">
<doc xml:whitespace="preserve">the stride of the rectangle in @pixels in bytes (&gt;= 4*width)</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="render_x" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="render_y" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="render_width" transfer-ownership="none">
<doc xml:whitespace="preserve">the render width of this rectangle on the video</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="render_height" transfer-ownership="none">
<doc xml:whitespace="preserve">the render height of this rectangle on the video</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:whitespace="preserve">flags (currently unused)</doc>
<type name="VideoOverlayFormatFlags"
c:type="GstVideoOverlayFormatFlags"/>
</parameter>
</parameters>
</constructor>
<method name="copy"
c:identifier="gst_video_overlay_rectangle_copy"
version="0.10.36">
<doc xml:whitespace="preserve">Makes a copy of @rectangle, so that it is possible to modify it
(e.g. to change the render co-ordinates or render dimension). The
actual overlay pixel data buffers contained in the rectangle are not
copied.
to @rectangle.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #GstVideoOverlayRectangle equivalent</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</return-value>
</method>
<method name="get_pixels_argb"
c:identifier="gst_video_overlay_rectangle_get_pixels_argb"
version="0.10.36">
<doc xml:whitespace="preserve">row stride @stride and width and height of the render dimensions as per
gst_video_overlay_rectangle_get_render_rectangle(). This function does
not return a reference, the caller should obtain a reference of her own
with gst_buffer_ref() if needed.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstBuffer holding the ARGB pixel data with</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<parameter name="stride"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:whitespace="preserve">address of guint variable where to store the row stride of the ARGB pixel data in the buffer</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:whitespace="preserve">flags (unused)</doc>
<type name="VideoOverlayFormatFlags"
c:type="GstVideoOverlayFormatFlags"/>
</parameter>
</parameters>
</method>
<method name="get_pixels_unscaled_argb"
c:identifier="gst_video_overlay_rectangle_get_pixels_unscaled_argb"
version="0.10.36">
<doc xml:whitespace="preserve">Retrieves the pixel data as it is. This is useful if the caller can
do the scaling itself when handling the overlaying. The rectangle will
need to be scaled to the render dimensions, which can be retrieved using
gst_video_overlay_rectangle_get_render_rectangle().
row stride @stride. This function does not return a reference, the caller
should obtain a reference of her own with gst_buffer_ref() if needed.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstBuffer holding the ARGB pixel data with</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<parameter name="width"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:whitespace="preserve">address where to store the height of the unscaled rectangle in pixels</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="stride"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:whitespace="preserve">address of guint variable where to store the row stride of the ARGB pixel data in the buffer</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:whitespace="preserve">flags for future use (unused)</doc>
<type name="VideoOverlayFormatFlags"
c:type="GstVideoOverlayFormatFlags"/>
</parameter>
</parameters>
</method>
<method name="get_render_rectangle"
c:identifier="gst_video_overlay_rectangle_get_render_rectangle"
version="0.10.36">
<doc xml:whitespace="preserve">Retrieves the render position and render dimension of the overlay
rectangle on the video.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if valid render dimensions were retrieved.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="render_x"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:whitespace="preserve">address where to store the X render offset</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="render_y"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:whitespace="preserve">address where to store the Y render offset</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="render_width"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:whitespace="preserve">address where to store the render width</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="render_height"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:whitespace="preserve">address where to store the render height</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</method>
<method name="get_seqnum"
c:identifier="gst_video_overlay_rectangle_get_seqnum"
version="0.10.36">
<doc xml:whitespace="preserve">Returns the sequence number of this rectangle. Sequence numbers are
monotonically increasing and unique for overlay compositions and rectangles
(meaning there will never be a rectangle with the same sequence number as
a composition).</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the sequence number of @rectangle</doc>
<type name="guint" c:type="guint"/>
</return-value>
</method>
<method name="set_render_rectangle"
c:identifier="gst_video_overlay_rectangle_set_render_rectangle"
version="0.10.36">
<doc xml:whitespace="preserve">Sets the render position and dimensions of the rectangle on the video.
This function is mainly for elements that modify the size of the video
in some way (e.g. through scaling or cropping) and need to adjust the
details of any overlays to match the operation that changed the size.
@rectangle must be writable, meaning its refcount must be 1. You can
make the rectangles inside a #GstVideoOverlayComposition writable using
gst_video_overlay_composition_make_writable() or
gst_video_overlay_composition_copy().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="render_x" transfer-ownership="none">
<doc xml:whitespace="preserve">render X position of rectangle on video</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="render_y" transfer-ownership="none">
<doc xml:whitespace="preserve">render Y position of rectangle on video</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="render_width" transfer-ownership="none">
<doc xml:whitespace="preserve">render width of rectangle</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="render_height" transfer-ownership="none">
<doc xml:whitespace="preserve">render height of rectangle</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
</class>
<record name="VideoOverlayRectangleClass"
c:type="GstVideoOverlayRectangleClass"
disguised="1"
glib:is-gtype-struct-for="VideoOverlayRectangle">
</record>
<record name="VideoRectangle" c:type="GstVideoRectangle">
<doc xml:whitespace="preserve">Helper structure representing a rectangular area.</doc>
<field name="x" writable="1">
<type name="gint" c:type="gint"/>
</field>
<field name="y" writable="1">
<type name="gint" c:type="gint"/>
</field>
<field name="w" writable="1">
<type name="gint" c:type="gint"/>
</field>
<field name="h" writable="1">
<type name="gint" c:type="gint"/>
</field>
</record>
<class name="VideoSink"
c:symbol-prefix="video_sink"
c:type="GstVideoSink"
parent="GstBase.BaseSink"
glib:type-name="GstVideoSink"
glib:get-type="gst_video_sink_get_type"
glib:type-struct="VideoSinkClass">
<doc xml:whitespace="preserve"><refsect2>
<para>
Provides useful functions and a base class for video sinks.
</para>
<para>
GstVideoSink will configure the default base sink to drop frames that
arrive later than 20ms as this is considered the default threshold for
observing out-of-sync frames.
</para>
</refsect2></doc>
<function name="center_rect" c:identifier="gst_video_sink_center_rect">
<doc xml:whitespace="preserve">Takes @src rectangle and position it at the center of @dst rectangle with or
without @scaling. It handles clipping if the @src rectangle is bigger than
the @dst one and @scaling is set to FALSE.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstVideoRectangle describing the source area</doc>
<type name="VideoRectangle" c:type="GstVideoRectangle"/>
</parameter>
<parameter name="dst" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstVideoRectangle describing the destination area</doc>
<type name="VideoRectangle" c:type="GstVideoRectangle"/>
</parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:whitespace="preserve">a pointer to a #GstVideoRectangle which will receive the result area</doc>
<type name="VideoRectangle" c:type="GstVideoRectangle*"/>
</parameter>
<parameter name="scaling" transfer-ownership="none">
<doc xml:whitespace="preserve">a #gboolean indicating if scaling should be applied or not</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<virtual-method name="show_frame">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
</parameters>
</virtual-method>
<property name="show-preroll-frame"
version="0.10.25"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:whitespace="preserve">Whether to show video frames during preroll. If set to #FALSE, video
frames will only be rendered in PLAYING state.</doc>
<type name="gboolean"/>
</property>
<field name="element">
<type name="GstBase.BaseSink" c:type="GstBaseSink"/>
</field>
<field name="width">
<type name="gint" c:type="gint"/>
</field>
<field name="height">
<type name="gint" c:type="gint"/>
</field>
<field name="priv" readable="0" private="1">
<type name="VideoSinkPrivate" c:type="GstVideoSinkPrivate*"/>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="3">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</class>
<record name="VideoSinkClass"
c:type="GstVideoSinkClass"
glib:is-gtype-struct-for="VideoSink">
<doc xml:whitespace="preserve">The video sink class structure. Derived classes should override the
@show_frame virtual function.</doc>
<field name="parent_class">
<type name="GstBase.BaseSinkClass" c:type="GstBaseSinkClass"/>
</field>
<field name="show_frame">
<callback name="show_frame">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="video_sink" transfer-ownership="none">
<type name="VideoSink" c:type="GstVideoSink*"/>
</parameter>
<parameter name="buf" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="3">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<record name="VideoSinkPrivate" c:type="GstVideoSinkPrivate" disguised="1">
</record>
<function name="video_buffer_get_overlay_composition"
c:identifier="gst_video_buffer_get_overlay_composition"
version="0.10.36">
<doc xml:whitespace="preserve">Get the overlay composition that has previously been attached to a buffer
with gst_video_buffer_get_overlay_composition(), usually by another element
upstream.
this buffer, or NULL. Does not return a reference to the composition,
caller must obtain her own ref via gst_video_overlay_composition_ref()
if needed.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstVideoOverlayComposition attached to</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstBuffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
</parameters>
</function>
<function name="video_buffer_set_overlay_composition"
c:identifier="gst_video_buffer_set_overlay_composition"
version="0.10.36">
<doc xml:whitespace="preserve">Sets an overlay composition on a buffer. The buffer will obtain its own
reference to the composition, meaning this function does not take ownership
of @comp.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstBuffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="comp" transfer-ownership="none" allow-none="1">
<doc xml:whitespace="preserve">a #GstVideoOverlayComposition, or NULL to clear a previously-set composition</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</parameter>
</parameters>
</function>
<function name="video_calculate_display_ratio"
c:identifier="gst_video_calculate_display_ratio"
version="0.10.7">
<doc xml:whitespace="preserve">Given the Pixel Aspect Ratio and size of an input video frame, and the
pixel aspect ratio of the intended display device, calculates the actual
display ratio the video will be rendered with.
dar_n and dar_d parameters.
The return value is FALSE in the case of integer overflow or other error.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">A boolean indicating success and a calculated Display Ratio in the</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="dar_n" transfer-ownership="none">
<doc xml:whitespace="preserve">Numerator of the calculated display_ratio</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="dar_d" transfer-ownership="none">
<doc xml:whitespace="preserve">Denominator of the calculated display_ratio</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="video_width" transfer-ownership="none">
<doc xml:whitespace="preserve">Width of the video frame in pixels</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="video_height" transfer-ownership="none">
<doc xml:whitespace="preserve">Height of the video frame in pixels</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="video_par_n" transfer-ownership="none">
<doc xml:whitespace="preserve">Numerator of the pixel aspect ratio of the input video.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="video_par_d" transfer-ownership="none">
<doc xml:whitespace="preserve">Denominator of the pixel aspect ratio of the input video.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="display_par_n" transfer-ownership="none">
<doc xml:whitespace="preserve">Numerator of the pixel aspect ratio of the display device</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="display_par_d" transfer-ownership="none">
<doc xml:whitespace="preserve">Denominator of the pixel aspect ratio of the display device</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="video_convert_frame"
c:identifier="gst_video_convert_frame"
version="0.10.31"
introspectable="0"
throws="1">
<doc xml:whitespace="preserve">Converts a raw video buffer into the specified output caps.
The output caps can be any raw video formats or any image formats (jpeg, png, ...).
The width, height and pixel-aspect-ratio can also be specified in the output caps.
will point to the #GError).</doc>
<return-value>
<doc xml:whitespace="preserve">The converted #GstBuffer, or %NULL if an error happened (in which case @err</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstBuffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="to_caps" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstCaps to convert to</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="timeout" transfer-ownership="none">
<doc xml:whitespace="preserve">the maximum amount of time allowed for the processing.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</function>
<function name="video_convert_frame_async"
c:identifier="gst_video_convert_frame_async"
version="0.10.31">
<doc xml:whitespace="preserve">Converts a raw video buffer into the specified output caps.
The output caps can be any raw video formats or any image formats (jpeg, png, ...).
The width, height and pixel-aspect-ratio can also be specified in the output caps.
@callback will be called after conversion, when an error occured or if conversion didn't
finish after @timeout. @callback will always be called from the thread default
%GMainContext, see g_main_context_get_thread_default(). If GLib before 2.22 is used,
this will always be the global default main context.
@destroy_notify will be called after the callback was called and @user_data is not needed
anymore.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstBuffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="to_caps" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstCaps to convert to</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="timeout" transfer-ownership="none">
<doc xml:whitespace="preserve">the maximum amount of time allowed for the processing.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
scope="notified"
closure="4"
destroy="5">
<doc xml:whitespace="preserve">%GstVideoConvertFrameCallback that will be called after conversion.</doc>
<type name="VideoConvertFrameCallback"
c:type="GstVideoConvertFrameCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:whitespace="preserve">extra data that will be passed to the @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="destroy_notify"
transfer-ownership="none"
scope="async">
<doc xml:whitespace="preserve">%GDestroyNotify to be called after @user_data is not needed anymore</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</function>
<function name="video_event_is_force_key_unit"
c:identifier="gst_video_event_is_force_key_unit"
version="0.10.36">
<doc xml:whitespace="preserve">Checks if an event is a force key unit event. Returns true for both upstream
and downstream force key unit events.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if the event is a valid force key unit event</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:whitespace="preserve">A #GstEvent to check</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</function>
<function name="video_event_new_downstream_force_key_unit"
c:identifier="gst_video_event_new_downstream_force_key_unit"
version="0.10.36"
introspectable="0">
<doc xml:whitespace="preserve">Creates a new downstream force key unit event. A downstream force key unit
event can be sent down the pipeline to request downstream elements to produce
a key unit. A downstream force key unit event must also be sent when handling
an upstream force key unit event to notify downstream that the latter has been
handled.
To parse an event created by gst_video_event_new_downstream_force_key_unit() use
gst_video_event_parse_downstream_force_key_unit().</doc>
<return-value>
<doc xml:whitespace="preserve">The new GstEvent</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</return-value>
<parameters>
<parameter name="timestamp" transfer-ownership="none">
<doc xml:whitespace="preserve">the timestamp of the buffer that starts a new key unit</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
<parameter name="streamtime" transfer-ownership="none">
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
<parameter name="runningtime" transfer-ownership="none">
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
<parameter name="all_headers" transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE to produce headers when starting a new key unit</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:whitespace="preserve">integer that can be used to number key units</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="video_event_new_still_frame"
c:identifier="gst_video_event_new_still_frame"
version="0.10.26"
introspectable="0">
<doc xml:whitespace="preserve">Creates a new Still Frame event. If @in_still is %TRUE, then the event
represents the start of a still frame sequence. If it is %FALSE, then
the event ends a still frame sequence.
To parse an event created by gst_video_event_new_still_frame() use
gst_video_event_parse_still_frame().</doc>
<return-value>
<doc xml:whitespace="preserve">The new GstEvent</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</return-value>
<parameters>
<parameter name="in_still" transfer-ownership="none">
<doc xml:whitespace="preserve">boolean value for the still-frame state of the event.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="video_event_new_upstream_force_key_unit"
c:identifier="gst_video_event_new_upstream_force_key_unit"
version="0.10.36"
introspectable="0">
<doc xml:whitespace="preserve">Creates a new upstream force key unit event. An upstream force key unit event
can be sent to request upstream elements to produce a key unit.
@running_time can be set to request a new key unit at a specific
running_time. If set to GST_CLOCK_TIME_NONE, upstream elements will produce a
new key unit as soon as possible.
To parse an event created by gst_video_event_new_downstream_force_key_unit() use
gst_video_event_parse_downstream_force_key_unit().</doc>
<return-value>
<doc xml:whitespace="preserve">The new GstEvent</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</return-value>
<parameters>
<parameter name="running_time" transfer-ownership="none">
<doc xml:whitespace="preserve">the running_time at which a new key unit should be produced</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
<parameter name="all_headers" transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE to produce headers when starting a new key unit</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:whitespace="preserve">integer that can be used to number key units</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="video_event_parse_downstream_force_key_unit"
c:identifier="gst_video_event_parse_downstream_force_key_unit"
version="0.10.36">
<doc xml:whitespace="preserve">Get timestamp, stream-time, running-time, all-headers and count in the force
key unit event. See gst_video_event_new_downstream_force_key_unit() for a
full description of the downstream force key unit event.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if the event is a valid downstream force key unit event.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:whitespace="preserve">A #GstEvent to parse</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="timestamp"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:whitespace="preserve">A pointer to the timestamp in the event</doc>
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
<parameter name="streamtime" transfer-ownership="none">
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
<parameter name="runningtime" transfer-ownership="none">
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
<parameter name="all_headers"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:whitespace="preserve">A pointer to the all_headers flag in the event</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
<parameter name="count"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:whitespace="preserve">A pointer to the count field of the event</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="video_event_parse_still_frame"
c:identifier="gst_video_event_parse_still_frame"
version="0.10.26">
<doc xml:whitespace="preserve">Parse a #GstEvent, identify if it is a Still Frame event, and
return the still-frame state from the event if it is.
If the event represents the start of a still frame, the in_still
variable will be set to TRUE, otherwise FALSE. It is OK to pass NULL for the
in_still variable order to just check whether the event is a valid still-frame
event.
Create a still frame event using gst_video_event_new_still_frame()</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if the event is a valid still-frame event. %FALSE if not</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:whitespace="preserve">A #GstEvent to parse</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="in_still" transfer-ownership="none">
<doc xml:whitespace="preserve">A boolean to receive the still-frame status from the event, or NULL</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</function>
<function name="video_event_parse_upstream_force_key_unit"
c:identifier="gst_video_event_parse_upstream_force_key_unit"
version="0.10.36">
<doc xml:whitespace="preserve">Get running-time, all-headers and count in the force key unit event. See
gst_video_event_new_upstream_force_key_unit() for a full description of the
upstream force key unit event.
Create an upstream force key unit event using gst_video_event_new_upstream_force_key_unit()</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if the event is a valid upstream force-key-unit event. %FALSE if not</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:whitespace="preserve">A #GstEvent to parse</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="running_time"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:whitespace="preserve">A pointer to the running_time in the event</doc>
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
<parameter name="all_headers"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:whitespace="preserve">A pointer to the all_headers flag in the event</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
<parameter name="count"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:whitespace="preserve">A pointer to the count field in the event</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="video_format_convert"
c:identifier="gst_video_format_convert"
moved-to="VideoFormat.convert"
version="0.10.16">
<doc xml:whitespace="preserve">Converts among various #GstFormat types. This function handles
GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For
raw video, GST_FORMAT_DEFAULT corresponds to video frames. This
function can be to handle pad queries of the type GST_QUERY_CONVERT.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if the conversion was successful.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">the width of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">the height of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="fps_n" transfer-ownership="none">
<doc xml:whitespace="preserve">frame rate numerator</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="fps_d" transfer-ownership="none">
<doc xml:whitespace="preserve">frame rate denominator</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="src_format" transfer-ownership="none">
<doc xml:whitespace="preserve">#GstFormat of the @src_value</doc>
<type name="Gst.Format" c:type="GstFormat"/>
</parameter>
<parameter name="src_value" transfer-ownership="none">
<doc xml:whitespace="preserve">value to convert</doc>
<type name="gint64" c:type="gint64"/>
</parameter>
<parameter name="dest_format" transfer-ownership="none">
<doc xml:whitespace="preserve">#GstFormat of the @dest_value</doc>
<type name="Gst.Format" c:type="GstFormat"/>
</parameter>
<parameter name="dest_value" transfer-ownership="none">
<doc xml:whitespace="preserve">pointer to destination value</doc>
<type name="gint64" c:type="gint64*"/>
</parameter>
</parameters>
</function>
<function name="video_format_from_fourcc"
c:identifier="gst_video_format_from_fourcc"
moved-to="VideoFormat.from_fourcc"
version="0.10.16">
<doc xml:whitespace="preserve">Converts a FOURCC value into the corresponding #GstVideoFormat.
If the FOURCC cannot be represented by #GstVideoFormat,
#GST_VIDEO_FORMAT_UNKNOWN is returned.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstVideoFormat describing the FOURCC value</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</return-value>
<parameters>
<parameter name="fourcc" transfer-ownership="none">
<doc xml:whitespace="preserve">a FOURCC value representing raw YUV video</doc>
<type name="guint32" c:type="guint32"/>
</parameter>
</parameters>
</function>
<function name="video_format_get_component_depth"
c:identifier="gst_video_format_get_component_depth"
moved-to="VideoFormat.get_component_depth"
version="0.10.33">
<doc xml:whitespace="preserve">Returns the number of bits used to encode an individual pixel of
a given @component. Typically this is 8, although higher and lower
values are possible for some formats.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">depth of component</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="component" transfer-ownership="none">
<doc xml:whitespace="preserve">the video component (e.g. 0 for 'R' in RGB)</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="video_format_get_component_height"
c:identifier="gst_video_format_get_component_height"
moved-to="VideoFormat.get_component_height"
version="0.10.16">
<doc xml:whitespace="preserve">Calculates the height of the component. See
@gst_video_format_get_row_stride for a description
of the component index.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">height of component @component</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="component" transfer-ownership="none">
<doc xml:whitespace="preserve">the component index</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">the height of video</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="video_format_get_component_offset"
c:identifier="gst_video_format_get_component_offset"
moved-to="VideoFormat.get_component_offset"
version="0.10.16">
<doc xml:whitespace="preserve">Calculates the offset (in bytes) of the first pixel of the component
with index @component. For packed formats, this will typically be a
small integer (0, 1, 2, 3). For planar formats, this will be a
(relatively) large offset to the beginning of the second or third
component planes. See @gst_video_format_get_row_stride for a description
of the component index.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">offset of component @component</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="component" transfer-ownership="none">
<doc xml:whitespace="preserve">the component index</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">the width of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">the height of video</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="video_format_get_component_width"
c:identifier="gst_video_format_get_component_width"
moved-to="VideoFormat.get_component_width"
version="0.10.16">
<doc xml:whitespace="preserve">Calculates the width of the component. See
@gst_video_format_get_row_stride for a description
of the component index.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">width of component @component</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="component" transfer-ownership="none">
<doc xml:whitespace="preserve">the component index</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">the width of video</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="video_format_get_pixel_stride"
c:identifier="gst_video_format_get_pixel_stride"
moved-to="VideoFormat.get_pixel_stride"
version="0.10.16">
<doc xml:whitespace="preserve">Calculates the pixel stride (number of bytes from one pixel to the
pixel to its immediate left) for the video component with an index
of @component. See @gst_video_format_get_row_stride for a description
of the component index.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">pixel stride of component @component</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="component" transfer-ownership="none">
<doc xml:whitespace="preserve">the component index</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="video_format_get_row_stride"
c:identifier="gst_video_format_get_row_stride"
moved-to="VideoFormat.get_row_stride"
version="0.10.16">
<doc xml:whitespace="preserve">Calculates the row stride (number of bytes from one row of pixels to
the next) for the video component with an index of @component. For
YUV video, Y, U, and V have component indices of 0, 1, and 2,
respectively. For RGB video, R, G, and B have component indicies of
0, 1, and 2, respectively. Alpha channels, if present, have a component
index of 3. The @width parameter always represents the width of the
video, not the component.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">row stride of component @component</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="component" transfer-ownership="none">
<doc xml:whitespace="preserve">the component index</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">the width of video</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="video_format_get_size"
c:identifier="gst_video_format_get_size"
moved-to="VideoFormat.get_size"
version="0.10.16">
<doc xml:whitespace="preserve">Calculates the total number of bytes in the raw video format. This
number should be used when allocating a buffer for raw video.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">size (in bytes) of raw video format</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">the width of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">the height of video</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="video_format_has_alpha"
c:identifier="gst_video_format_has_alpha"
moved-to="VideoFormat.has_alpha"
version="0.10.16">
<doc xml:whitespace="preserve">Returns TRUE or FALSE depending on if the video format provides an
alpha channel.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if @format has an alpha channel</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="video_format_is_gray"
c:identifier="gst_video_format_is_gray"
moved-to="VideoFormat.is_gray"
version="0.10.29">
<doc xml:whitespace="preserve">Determine whether the video format is a grayscale format.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if @format represents grayscale video</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="video_format_is_rgb"
c:identifier="gst_video_format_is_rgb"
moved-to="VideoFormat.is_rgb"
version="0.10.16">
<doc xml:whitespace="preserve">Determine whether the video format is an RGB format.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if @format represents RGB video</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="video_format_is_yuv"
c:identifier="gst_video_format_is_yuv"
moved-to="VideoFormat.is_yuv"
version="0.10.16">
<doc xml:whitespace="preserve">Determine whether the video format is a YUV format.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if @format represents YUV video</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="video_format_new_caps"
c:identifier="gst_video_format_new_caps"
moved-to="VideoFormat.new_caps"
version="0.10.16">
<doc xml:whitespace="preserve">Creates a new #GstCaps object based on the parameters provided.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #GstCaps object, or NULL if there was an error</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstVideoFormat describing the raw video format</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">width of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">height of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="framerate_n" transfer-ownership="none">
<doc xml:whitespace="preserve">numerator of frame rate</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="framerate_d" transfer-ownership="none">
<doc xml:whitespace="preserve">denominator of frame rate</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="par_n" transfer-ownership="none">
<doc xml:whitespace="preserve">numerator of pixel aspect ratio</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="par_d" transfer-ownership="none">
<doc xml:whitespace="preserve">denominator of pixel aspect ratio</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="video_format_new_caps_interlaced"
c:identifier="gst_video_format_new_caps_interlaced"
moved-to="VideoFormat.new_caps_interlaced"
version="0.10.23">
<doc xml:whitespace="preserve">Creates a new #GstCaps object based on the parameters provided.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #GstCaps object, or NULL if there was an error</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstVideoFormat describing the raw video format</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">width of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">height of video</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="framerate_n" transfer-ownership="none">
<doc xml:whitespace="preserve">numerator of frame rate</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="framerate_d" transfer-ownership="none">
<doc xml:whitespace="preserve">denominator of frame rate</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="par_n" transfer-ownership="none">
<doc xml:whitespace="preserve">numerator of pixel aspect ratio</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="par_d" transfer-ownership="none">
<doc xml:whitespace="preserve">denominator of pixel aspect ratio</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="interlaced" transfer-ownership="none">
<doc xml:whitespace="preserve">#TRUE if the format is interlaced</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="video_format_new_template_caps"
c:identifier="gst_video_format_new_template_caps"
moved-to="VideoFormat.new_template_caps"
version="0.10.33">
<doc xml:whitespace="preserve">Creates a new #GstCaps object based on the parameters provided.
Size, frame rate, and pixel aspect ratio are set to the full
range.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #GstCaps object, or NULL if there was an error</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstVideoFormat describing the raw video format</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="video_format_parse_caps"
c:identifier="gst_video_format_parse_caps"
moved-to="VideoFormat.parse_caps"
version="0.10.16">
<doc xml:whitespace="preserve">Determines the #GstVideoFormat of @caps and places it in the location
pointed to by @format. Extracts the size of the video and places it
in the location pointed to by @width and @height. If @caps does not
represent a video format or does not contain height and width, the
function will fail and return FALSE. If @caps does not represent a raw
video format listed in #GstVideoFormat, but still contains video caps,
this function will return TRUE and set @format to #GST_VIDEO_FORMAT_UNKNOWN.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if @caps was parsed correctly.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="caps" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstCaps to parse</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GstVideoFormat of the video represented by @caps (output)</doc>
<type name="VideoFormat" c:type="GstVideoFormat*"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">the width of the video represented by @caps, may be NULL (output)</doc>
<type name="gint" c:type="int*"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">the height of the video represented by @caps, may be NULL (output)</doc>
<type name="gint" c:type="int*"/>
</parameter>
</parameters>
</function>
<function name="video_format_parse_caps_interlaced"
c:identifier="gst_video_format_parse_caps_interlaced"
moved-to="VideoFormat.parse_caps_interlaced"
version="0.10.23">
<doc xml:whitespace="preserve">Extracts whether the caps represents interlaced content or not and places it
in @interlaced.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if @caps was parsed correctly.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="caps" transfer-ownership="none">
<doc xml:whitespace="preserve">the fixed #GstCaps to parse</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="interlaced" transfer-ownership="none">
<doc xml:whitespace="preserve">whether @caps represents interlaced video or not, may be NULL (output)</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</function>
<function name="video_format_to_fourcc"
c:identifier="gst_video_format_to_fourcc"
moved-to="VideoFormat.to_fourcc"
version="0.10.16">
<doc xml:whitespace="preserve">Converts a #GstVideoFormat value into the corresponding FOURCC. Only
a few YUV formats have corresponding FOURCC values. If @format has
no corresponding FOURCC value, 0 is returned.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the FOURCC corresponding to @format</doc>
<type name="guint32" c:type="guint32"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GstVideoFormat video format</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="video_frame_rate" c:identifier="gst_video_frame_rate">
<doc xml:whitespace="preserve">A convenience function to retrieve a GValue holding the framerate
from the caps on a pad.
The pad needs to have negotiated caps containing a framerate property.
do not contain a framerate.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">NULL if the pad has no configured caps or the configured caps</doc>
<type name="GObject.Value" c:type="GValue*"/>
</return-value>
<parameters>
<parameter name="pad" transfer-ownership="none">
<doc xml:whitespace="preserve">pointer to a #GstPad</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</parameter>
</parameters>
</function>
<function name="video_get_size" c:identifier="gst_video_get_size">
<doc xml:whitespace="preserve">Inspect the caps of the provided pad and retrieve the width and height of
the video frames it is configured for.
The pad needs to have negotiated caps containing width and height properties.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if the width and height could be retrieved.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="pad" transfer-ownership="none">
<doc xml:whitespace="preserve">pointer to a #GstPad</doc>
<type name="Gst.Pad" c:type="GstPad*"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:whitespace="preserve">pointer to integer to hold pixel width of the video frames (output)</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:whitespace="preserve">pointer to integer to hold pixel height of the video frames (output)</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</function>
<function name="video_get_size_from_caps"
c:identifier="gst_video_get_size_from_caps"
version="0.10.36">
<doc xml:whitespace="preserve">Calculates the total number of bytes in the raw video format for the given
caps. This number should be used when allocating a buffer for raw video.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if the size could be calculated from the caps</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="caps" transfer-ownership="none">
<doc xml:whitespace="preserve">a pointer to #GstCaps</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="size" transfer-ownership="none">
<doc xml:whitespace="preserve">a pointer to a gint that will be assigned the size (in bytes) of a video frame with the given caps</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</function>
<function name="video_parse_caps_chroma_site"
c:identifier="gst_video_parse_caps_chroma_site"
version="0.10.29">
<doc xml:whitespace="preserve">Extracts the chroma site used by the caps. Possible values are
"mpeg2" for MPEG-2 style chroma siting (co-sited horizontally,
halfway-sited vertically), "jpeg" for JPEG and Theora style
chroma siting (halfway-sited both horizontally and vertically).
Other chroma site values are possible, but uncommon.
When no chroma site is specified in the caps, it should be assumed
to be "mpeg2".
determined.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">a chroma site string, or NULL if no chroma site could be</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="caps" transfer-ownership="none">
<doc xml:whitespace="preserve">the fixed #GstCaps to parse</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</function>
<function name="video_parse_caps_color_matrix"
c:identifier="gst_video_parse_caps_color_matrix"
version="0.10.29">
<doc xml:whitespace="preserve">Extracts the color matrix used by the caps. Possible values are
"sdtv" for the standard definition color matrix (as specified in
Rec. ITU-R BT.470-6) or "hdtv" for the high definition color
matrix (as specified in Rec. ITU-R BT.709)
determined.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">a color matrix string, or NULL if no color matrix could be</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="caps" transfer-ownership="none">
<doc xml:whitespace="preserve">the fixed #GstCaps to parse</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</function>
<function name="video_parse_caps_framerate"
c:identifier="gst_video_parse_caps_framerate"
version="0.10.16">
<doc xml:whitespace="preserve">Extracts the frame rate from @caps and places the values in the locations
pointed to by @fps_n and @fps_d. Returns TRUE if the values could be
parsed correctly, FALSE if not.
This function can be used with #GstCaps that have any media type; it
is not limited to formats handled by #GstVideoFormat.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if @caps was parsed correctly.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="caps" transfer-ownership="none">
<doc xml:whitespace="preserve">pointer to a #GstCaps instance</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="fps_n" transfer-ownership="none">
<doc xml:whitespace="preserve">pointer to integer to hold numerator of frame rate (output)</doc>
<type name="gint" c:type="int*"/>
</parameter>
<parameter name="fps_d" transfer-ownership="none">
<doc xml:whitespace="preserve">pointer to integer to hold denominator of frame rate (output)</doc>
<type name="gint" c:type="int*"/>
</parameter>
</parameters>
</function>
<function name="video_parse_caps_palette"
c:identifier="gst_video_parse_caps_palette"
version="0.10.32"
introspectable="0">
<doc xml:whitespace="preserve">Returns the palette data from the caps as a #GstBuffer. For
#GST_VIDEO_FORMAT_RGB8_PALETTED this is containing 256 #guint32
values, each containing ARGB colors in native endianness.</doc>
<return-value>
<doc xml:whitespace="preserve">a #GstBuffer containing the palette data. Unref after usage.</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<parameter name="caps" transfer-ownership="none">
<doc xml:whitespace="preserve">#GstCaps to parse</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</function>
<function name="video_parse_caps_pixel_aspect_ratio"
c:identifier="gst_video_parse_caps_pixel_aspect_ratio"
version="0.10.16">
<doc xml:whitespace="preserve">Extracts the pixel aspect ratio from @caps and places the values in
the locations pointed to by @par_n and @par_d. Returns TRUE if the
values could be parsed correctly, FALSE if not.
This function can be used with #GstCaps that have any media type; it
is not limited to formats handled by #GstVideoFormat.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">TRUE if @caps was parsed correctly.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="caps" transfer-ownership="none">
<doc xml:whitespace="preserve">pointer to a #GstCaps instance</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="par_n" transfer-ownership="none">
<doc xml:whitespace="preserve">pointer to numerator of pixel aspect ratio (output)</doc>
<type name="gint" c:type="int*"/>
</parameter>
<parameter name="par_d" transfer-ownership="none">
<doc xml:whitespace="preserve">pointer to denominator of pixel aspect ratio (output)</doc>
<type name="gint" c:type="int*"/>
</parameter>
</parameters>
</function>
</namespace>
</repository>
|