/usr/share/gir-1.0/GstVideo-1.0.gir is in libgstreamer-plugins-base1.0-dev 1.2.3-1.
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 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 | <?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="Gst" version="1.0"/>
<include name="GstBase" version="1.0"/>
<package name="gstreamer-video-1.0"/>
<c:include name="gst/video/video.h"/>
<namespace name="GstVideo"
version="1.0"
shared-library="libgstvideo-1.0.so.0"
c:identifier-prefixes="Gst"
c:symbol-prefixes="gst">
<constant name="BUFFER_POOL_OPTION_VIDEO_ALIGNMENT"
value="GstBufferPoolOptionVideoAlignment"
c:type="GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT">
<doc xml:space="preserve">A bufferpool option to enable extra padding. When a bufferpool supports this
option, gst_buffer_pool_config_set_video_alignment() can be called.
When this option is enabled on the bufferpool,
#GST_BUFFER_POOL_OPTION_VIDEO_META should also be enabled.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="BUFFER_POOL_OPTION_VIDEO_META"
value="GstBufferPoolOptionVideoMeta"
c:type="GST_BUFFER_POOL_OPTION_VIDEO_META">
<doc xml:space="preserve">An option that can be activated on bufferpool to request video metadata
on buffers from the pool.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="CAPS_FEATURE_META_GST_VIDEO_GL_TEXTURE_UPLOAD_META"
value="meta:GstVideoGLTextureUploadMeta"
c:type="GST_CAPS_FEATURE_META_GST_VIDEO_GL_TEXTURE_UPLOAD_META">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="CAPS_FEATURE_META_GST_VIDEO_META"
value="meta:GstVideoMeta"
c:type="GST_CAPS_FEATURE_META_GST_VIDEO_META">
<type name="utf8" c:type="gchar*"/>
</constant>
<interface name="ColorBalance"
c:symbol-prefix="color_balance"
c:type="GstColorBalance"
glib:type-name="GstColorBalance"
glib:get-type="gst_color_balance_get_type"
glib:type-struct="ColorBalanceInterface">
<doc xml:space="preserve"><refsect2><para>
This interface is implemented by elements which can perform some color
balance operation on video frames they process. For example, modifying
the brightness, contrast, hue or saturation.
</para><para>
Example elements are 'xvimagesink' and 'colorbalance'
</para>
</refsect2></doc>
<virtual-method name="get_balance_type" invoker="get_balance_type">
<doc xml:space="preserve">Get the #GstColorBalanceType of this implementation.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A the #GstColorBalanceType.</doc>
<type name="ColorBalanceType" c:type="GstColorBalanceType"/>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">The #GstColorBalance implementation</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="get_value" invoker="get_value">
<doc xml:space="preserve">Retrieve the current value of the indicated channel, between min_value
and max_value.
See Also: The #GstColorBalanceChannel.min_value and
#GstColorBalanceChannel.max_value members of the
#GstColorBalanceChannel object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current value of the channel.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalanceChannel instance</doc>
<type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="list_channels"
invoker="list_channels"
introspectable="0">
<doc xml:space="preserve">Retrieve a list of the available channels.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A GList containing pointers to #GstColorBalanceChannel objects.
The list is owned by the #GstColorBalance instance and must not
be freed.</doc>
<type name="GLib.List" c:type="const GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="set_value" invoker="set_value">
<doc xml:space="preserve">Sets the current value of the channel to the passed value, which must
be between min_value and max_value.
See Also: The #GstColorBalanceChannel.min_value and
#GstColorBalanceChannel.max_value members of the
#GstColorBalanceChannel object.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalanceChannel instance</doc>
<type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The new value for the channel.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="value_changed" invoker="value_changed">
<doc xml:space="preserve">A helper function called by implementations of the GstColorBalance
interface. It fires the #GstColorBalance::value-changed signal on the
instance, and the #GstColorBalanceChannel::value-changed signal on the
channel object.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalanceChannel whose value has changed</doc>
<type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The new value of the channel</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<method name="get_balance_type"
c:identifier="gst_color_balance_get_balance_type">
<doc xml:space="preserve">Get the #GstColorBalanceType of this implementation.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A the #GstColorBalanceType.</doc>
<type name="ColorBalanceType" c:type="GstColorBalanceType"/>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">The #GstColorBalance implementation</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_value" c:identifier="gst_color_balance_get_value">
<doc xml:space="preserve">Retrieve the current value of the indicated channel, between min_value
and max_value.
See Also: The #GstColorBalanceChannel.min_value and
#GstColorBalanceChannel.max_value members of the
#GstColorBalanceChannel object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current value of the channel.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalanceChannel instance</doc>
<type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
</parameter>
</parameters>
</method>
<method name="list_channels"
c:identifier="gst_color_balance_list_channels"
introspectable="0">
<doc xml:space="preserve">Retrieve a list of the available channels.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A GList containing pointers to #GstColorBalanceChannel objects.
The list is owned by the #GstColorBalance instance and must not
be freed.</doc>
<type name="GLib.List" c:type="const GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_value" c:identifier="gst_color_balance_set_value">
<doc xml:space="preserve">Sets the current value of the channel to the passed value, which must
be between min_value and max_value.
See Also: The #GstColorBalanceChannel.min_value and
#GstColorBalanceChannel.max_value members of the
#GstColorBalanceChannel object.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalanceChannel instance</doc>
<type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The new value for the channel.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="value_changed"
c:identifier="gst_color_balance_value_changed">
<doc xml:space="preserve">A helper function called by implementations of the GstColorBalance
interface. It fires the #GstColorBalance::value-changed signal on the
instance, and the #GstColorBalanceChannel::value-changed signal on the
channel object.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</instance-parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalanceChannel whose value has changed</doc>
<type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The new value of the channel</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<glib:signal name="value-changed" when="last">
<doc xml:space="preserve">Fired when the value of the indicated channel has changed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">The #GstColorBalanceChannel</doc>
<type name="ColorBalanceChannel"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The new value</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</glib:signal>
</interface>
<class name="ColorBalanceChannel"
c:symbol-prefix="color_balance_channel"
c:type="GstColorBalanceChannel"
parent="GObject.Object"
glib:type-name="GstColorBalanceChannel"
glib:get-type="gst_color_balance_channel_get_type"
glib:type-struct="ColorBalanceChannelClass">
<doc xml:space="preserve"><refsect2><para>The #GstColorBalanceChannel object represents a parameter
for modifying the color balance implemented by an element providing the
#GstColorBalance interface. For example, Hue or Saturation.
</para></refsect2></doc>
<virtual-method name="value_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="channel" transfer-ownership="none">
<type name="ColorBalanceChannel" c:type="GstColorBalanceChannel*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="label">
<doc xml:space="preserve">A string containing a descriptive name for this channel</doc>
<type name="utf8" c:type="gchar*"/>
</field>
<field name="min_value">
<doc xml:space="preserve">The minimum valid value for this channel.</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="max_value">
<doc xml:space="preserve">The maximum valid value for this channel.</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
<glib:signal name="value-changed" when="last">
<doc xml:space="preserve">Fired when the value of the indicated channel has changed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The new value</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="ColorBalanceChannelClass"
c:type="GstColorBalanceChannelClass"
glib:is-gtype-struct-for="ColorBalanceChannel">
<doc xml:space="preserve">Color-balance channel class.</doc>
<field name="parent">
<doc xml:space="preserve">the parent class</doc>
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="value_changed">
<callback name="value_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="channel" transfer-ownership="none">
<type name="ColorBalanceChannel"
c:type="GstColorBalanceChannel*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<record name="ColorBalanceInterface"
c:type="GstColorBalanceInterface"
glib:is-gtype-struct-for="ColorBalance">
<doc xml:space="preserve">Color-balance interface.</doc>
<field name="iface">
<doc xml:space="preserve">the parent interface</doc>
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="list_channels" introspectable="0">
<callback name="list_channels" introspectable="0">
<return-value transfer-ownership="none">
<doc xml:space="preserve">A GList containing pointers to #GstColorBalanceChannel objects.
The list is owned by the #GstColorBalance instance and must not
be freed.</doc>
<type name="GLib.List" c:type="const GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</return-value>
<parameters>
<parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_value">
<callback name="set_value">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalanceChannel instance</doc>
<type name="ColorBalanceChannel"
c:type="GstColorBalanceChannel*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The new value for the channel.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_value">
<callback name="get_value">
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current value of the channel.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalanceChannel instance</doc>
<type name="ColorBalanceChannel"
c:type="GstColorBalanceChannel*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_balance_type">
<callback name="get_balance_type">
<return-value transfer-ownership="none">
<doc xml:space="preserve">A the #GstColorBalanceType.</doc>
<type name="ColorBalanceType" c:type="GstColorBalanceType"/>
</return-value>
<parameters>
<parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">The #GstColorBalance implementation</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="value_changed">
<callback name="value_changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="balance" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalance instance</doc>
<type name="ColorBalance" c:type="GstColorBalance*"/>
</parameter>
<parameter name="channel" transfer-ownership="none">
<doc xml:space="preserve">A #GstColorBalanceChannel whose value has changed</doc>
<type name="ColorBalanceChannel"
c:type="GstColorBalanceChannel*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The new value of the channel</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<enumeration name="ColorBalanceType"
glib:type-name="GstColorBalanceType"
glib:get-type="gst_color_balance_type_get_type"
c:type="GstColorBalanceType">
<doc xml:space="preserve">An enumeration indicating whether an element implements color balancing
operations in software or in dedicated hardware. In general, dedicated
hardware implementations (such as those provided by xvimagesink) are
preferred.</doc>
<member name="hardware"
value="0"
c:identifier="GST_COLOR_BALANCE_HARDWARE"
glib:nick="hardware">
<doc xml:space="preserve">Color balance is implemented with dedicated
hardware.</doc>
</member>
<member name="software"
value="1"
c:identifier="GST_COLOR_BALANCE_SOFTWARE"
glib:nick="software">
<doc xml:space="preserve">Color balance is implemented via software
processing.</doc>
</member>
</enumeration>
<constant name="META_TAG_VIDEO_COLORSPACE_STR"
value="colorspace"
c:type="GST_META_TAG_VIDEO_COLORSPACE_STR"
version="1.2">
<doc xml:space="preserve">This metadata stays relevant as long as video colorspace is unchanged.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="META_TAG_VIDEO_ORIENTATION_STR"
value="orientation"
c:type="GST_META_TAG_VIDEO_ORIENTATION_STR"
version="1.2">
<doc xml:space="preserve">This metadata stays relevant as long as video orientation is unchanged.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="META_TAG_VIDEO_SIZE_STR"
value="size"
c:type="GST_META_TAG_VIDEO_SIZE_STR"
version="1.2">
<doc xml:space="preserve">This metadata stays relevant as long as video size is unchanged.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="META_TAG_VIDEO_STR"
value="video"
c:type="GST_META_TAG_VIDEO_STR"
version="1.2">
<doc xml:space="preserve">This metadata is relevant for video streams.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<interface name="Navigation"
c:symbol-prefix="navigation"
c:type="GstNavigation"
glib:type-name="GstNavigation"
glib:get-type="gst_navigation_get_type"
glib:type-struct="NavigationInterface">
<doc xml:space="preserve">The Navigation interface is used for creating and injecting navigation related
events such as mouse button presses, cursor motion and key presses. The associated
library also provides methods for parsing received events, and for sending and
receiving navigation related bus events. One main usecase is DVD menu navigation.
The main parts of the API are:
<itemizedlist>
<listitem>
<para>
The GstNavigation interface, implemented by elements which provide an application
with the ability to create and inject navigation events into the pipeline.
</para>
</listitem>
<listitem>
<para>
GstNavigation event handling API. GstNavigation events are created in response to
calls on a GstNavigation interface implementation, and sent in the pipeline. Upstream
elements can use the navigation event API functions to parse the contents of received
messages.
</para>
</listitem>
<listitem>
<para>
GstNavigation message handling API. GstNavigation messages may be sent on the message
bus to inform applications of navigation related changes in the pipeline, such as the
mouse moving over a clickable region, or the set of available angles changing.
</para><para>
The GstNavigation message functions provide functions for creating and parsing
custom bus messages for signaling GstNavigation changes.
</para>
</listitem>
</itemizedlist></doc>
<function name="event_get_type"
c:identifier="gst_navigation_event_get_type">
<doc xml:space="preserve">Inspect a #GstEvent and return the #GstNavigationEventType of the event, or
#GST_NAVIGATION_EVENT_INVALID if the event is not a #GstNavigation event.</doc>
<return-value transfer-ownership="none">
<type name="NavigationEventType" c:type="GstNavigationEventType"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</function>
<function name="event_parse_command"
c:identifier="gst_navigation_event_parse_command">
<doc xml:space="preserve">Inspect a #GstNavigation command event and retrieve the enum value of the
associated command.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the navigation command could be extracted, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="command" transfer-ownership="none">
<doc xml:space="preserve">Pointer to GstNavigationCommand to receive the type of the
navigation event.</doc>
<type name="NavigationCommand" c:type="GstNavigationCommand*"/>
</parameter>
</parameters>
</function>
<function name="event_parse_key_event"
c:identifier="gst_navigation_event_parse_key_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a location to receive the string identifying the key
press. The returned string is owned by the event, and valid only until the
event is unreffed.</doc>
<type name="utf8" c:type="const gchar**"/>
</parameter>
</parameters>
</function>
<function name="event_parse_mouse_button_event"
c:identifier="gst_navigation_event_parse_mouse_button_event">
<doc xml:space="preserve">Retrieve the details of either a #GstNavigation mouse button press event or
a mouse button release event. Determine which type the event is using
gst_navigation_event_get_type() to retrieve the #GstNavigationEventType.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the button number and both coordinates could be extracted,
otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="button" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gint that will receive the button number associated
with the event.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the x coordinate of the mouse button
event.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the y coordinate of the mouse button
event.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
</parameters>
</function>
<function name="event_parse_mouse_move_event"
c:identifier="gst_navigation_event_parse_mouse_move_event">
<doc xml:space="preserve">Inspect a #GstNavigation mouse movement event and extract the coordinates
of the event.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if both coordinates could be extracted, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the x coordinate of the mouse movement.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the y coordinate of the mouse movement.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
</parameters>
</function>
<function name="message_get_type"
c:identifier="gst_navigation_message_get_type">
<doc xml:space="preserve">Check a bus message to see if it is a #GstNavigation event, and return
the #GstNavigationMessageType identifying the type of the message if so.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The type of the #GstMessage, or
#GST_NAVIGATION_MESSAGE_INVALID if the message is not a #GstNavigation
notification.</doc>
<type name="NavigationMessageType"
c:type="GstNavigationMessageType"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A #GstMessage to inspect.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
</parameters>
</function>
<function name="message_new_angles_changed"
c:identifier="gst_navigation_message_new_angles_changed">
<doc xml:space="preserve">Creates a new #GstNavigation message with type
#GST_NAVIGATION_MESSAGE_ANGLES_CHANGED for notifying an application
that the current angle, or current number of angles available in a
multiangle video has changed.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The new #GstMessage.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">A #GstObject to set as source of the new message.</doc>
<type name="Gst.Object" c:type="GstObject*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">The currently selected angle.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">The number of viewing angles now available.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="message_new_commands_changed"
c:identifier="gst_navigation_message_new_commands_changed">
<doc xml:space="preserve">Creates a new #GstNavigation message with type
#GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The new #GstMessage.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">A #GstObject to set as source of the new message.</doc>
<type name="Gst.Object" c:type="GstObject*"/>
</parameter>
</parameters>
</function>
<function name="message_new_mouse_over"
c:identifier="gst_navigation_message_new_mouse_over">
<doc xml:space="preserve">Creates a new #GstNavigation message with type
#GST_NAVIGATION_MESSAGE_MOUSE_OVER.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The new #GstMessage.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">A #GstObject to set as source of the new message.</doc>
<type name="Gst.Object" c:type="GstObject*"/>
</parameter>
<parameter name="active" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the mouse has entered a clickable area of the display.
%FALSE if it over a non-clickable area.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="message_parse_angles_changed"
c:identifier="gst_navigation_message_parse_angles_changed">
<doc xml:space="preserve">Parse a #GstNavigation message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED
and extract the @cur_angle and @n_angles parameters.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the message could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A #GstMessage to inspect.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a #guint to receive the new current angle number,
or NULL</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a #guint to receive the new angle count, or NULL.</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="message_parse_mouse_over"
c:identifier="gst_navigation_message_parse_mouse_over">
<doc xml:space="preserve">Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_MOUSE_OVER
and extract the active/inactive flag. If the mouse over event is marked
active, it indicates that the mouse is over a clickable area.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the message could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A #GstMessage to inspect.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="active" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a gboolean to receive the active/inactive state,
or NULL.</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</function>
<function name="query_get_type"
c:identifier="gst_navigation_query_get_type">
<doc xml:space="preserve">Inspect a #GstQuery and return the #GstNavigationQueryType associated with
it if it is a #GstNavigation query.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The #GstNavigationQueryType of the query, or
#GST_NAVIGATION_QUERY_INVALID</doc>
<type name="NavigationQueryType" c:type="GstNavigationQueryType"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">The query to inspect</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</function>
<function name="query_new_angles"
c:identifier="gst_navigation_query_new_angles">
<doc xml:space="preserve">Create a new #GstNavigation angles query. When executed, it will
query the pipeline for the set of currently available angles, which may be
greater than one in a multiangle video.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The new query.</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</return-value>
</function>
<function name="query_new_commands"
c:identifier="gst_navigation_query_new_commands">
<doc xml:space="preserve">Create a new #GstNavigation commands query. When executed, it will
query the pipeline for the set of currently available commands.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The new query.</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</return-value>
</function>
<function name="query_parse_angles"
c:identifier="gst_navigation_query_parse_angles">
<doc xml:space="preserve">Parse the current angle number in the #GstNavigation angles @query into the
#guint pointed to by the @cur_angle variable, and the number of available
angles into the #guint pointed to by the @n_angles variable.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a #guint into which to store the currently selected
angle value from the query, or NULL</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a #guint into which to store the number of angles
value from the query, or NULL</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="query_parse_commands_length"
c:identifier="gst_navigation_query_parse_commands_length">
<doc xml:space="preserve">Parse the number of commands in the #GstNavigation commands @query.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="n_cmds"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">the number of commands in this query.</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="query_parse_commands_nth"
c:identifier="gst_navigation_query_parse_commands_nth">
<doc xml:space="preserve">Parse the #GstNavigation command query and retrieve the @nth command from
it into @cmd. If the list contains less elements than @nth, @cmd will be
set to #GST_NAVIGATION_COMMAND_INVALID.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="nth" transfer-ownership="none">
<doc xml:space="preserve">the nth command to retrieve.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="cmd"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">a pointer to store the nth command into.</doc>
<type name="NavigationCommand" c:type="GstNavigationCommand*"/>
</parameter>
</parameters>
</function>
<function name="query_set_angles"
c:identifier="gst_navigation_query_set_angles">
<doc xml:space="preserve">Set the #GstNavigation angles query result field in @query.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">the current viewing angle to set.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">the number of viewing angles to set.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="query_set_commands"
c:identifier="gst_navigation_query_set_commands"
introspectable="0">
<doc xml:space="preserve">Set the #GstNavigation command query result fields in @query. The number
of commands passed must be equal to @n_commands.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="n_cmds" transfer-ownership="none">
<doc xml:space="preserve">the number of commands to set.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">A list of @GstNavigationCommand values, @n_cmds entries long.</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="query_set_commandsv"
c:identifier="gst_navigation_query_set_commandsv">
<doc xml:space="preserve">Set the #GstNavigation command query result fields in @query. The number
of commands passed must be equal to @n_commands.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="n_cmds" transfer-ownership="none">
<doc xml:space="preserve">the number of commands to set.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="cmds" transfer-ownership="none">
<doc xml:space="preserve">An array containing @n_cmds @GstNavigationCommand values.</doc>
<type name="NavigationCommand" c:type="GstNavigationCommand*"/>
</parameter>
</parameters>
</function>
<virtual-method name="send_event" invoker="send_event">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="navigation" transfer-ownership="none">
<type name="Navigation" c:type="GstNavigation*"/>
</instance-parameter>
<parameter name="structure" transfer-ownership="none">
<type name="Gst.Structure" c:type="GstStructure*"/>
</parameter>
</parameters>
</virtual-method>
<method name="send_command" c:identifier="gst_navigation_send_command">
<doc xml:space="preserve">Sends the indicated command to the navigation interface.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="navigation" transfer-ownership="none">
<doc xml:space="preserve">The navigation interface instance</doc>
<type name="Navigation" c:type="GstNavigation*"/>
</instance-parameter>
<parameter name="command" transfer-ownership="none">
<doc xml:space="preserve">The command to issue</doc>
<type name="NavigationCommand" c:type="GstNavigationCommand"/>
</parameter>
</parameters>
</method>
<method name="send_event" c:identifier="gst_navigation_send_event">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="navigation" transfer-ownership="none">
<type name="Navigation" c:type="GstNavigation*"/>
</instance-parameter>
<parameter name="structure" transfer-ownership="none">
<type name="Gst.Structure" c:type="GstStructure*"/>
</parameter>
</parameters>
</method>
<method name="send_key_event"
c:identifier="gst_navigation_send_key_event">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="navigation" transfer-ownership="none">
<doc xml:space="preserve">The navigation interface instance</doc>
<type name="Navigation" c:type="GstNavigation*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">The type of the key event. Recognised values are "key-press" and
"key-release"</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">Character representation of the key. This is typically as produced
by XKeysymToString.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="send_mouse_event"
c:identifier="gst_navigation_send_mouse_event">
<doc xml:space="preserve">Sends a mouse event to the navigation interface. Mouse event coordinates
are sent relative to the display space of the related output area. This is
usually the size in pixels of the window associated with the element
implementing the #GstNavigation interface.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="navigation" transfer-ownership="none">
<doc xml:space="preserve">The navigation interface instance</doc>
<type name="Navigation" c:type="GstNavigation*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">The type of mouse event, as a text string. Recognised values are
"mouse-button-press", "mouse-button-release" and "mouse-move".</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="button" transfer-ownership="none">
<doc xml:space="preserve">The button number of the button being pressed or released. Pass 0
for mouse-move events.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">The x coordinate of the mouse event.</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">The y coordinate of the mouse event.</doc>
<type name="gdouble" c:type="double"/>
</parameter>
</parameters>
</method>
</interface>
<enumeration name="NavigationCommand"
glib:type-name="GstNavigationCommand"
glib:get-type="gst_navigation_command_get_type"
c:type="GstNavigationCommand">
<doc xml:space="preserve">A set of commands that may be issued to an element providing the
#GstNavigation interface. The available commands can be queried via
the gst_navigation_query_new_commands() query.
For convenience in handling DVD navigation, the MENU commands are aliased as:
GST_NAVIGATION_COMMAND_DVD_MENU = @GST_NAVIGATION_COMMAND_MENU1
GST_NAVIGATION_COMMAND_DVD_TITLE_MENU = @GST_NAVIGATION_COMMAND_MENU2
GST_NAVIGATION_COMMAND_DVD_ROOT_MENU = @GST_NAVIGATION_COMMAND_MENU3
GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU = @GST_NAVIGATION_COMMAND_MENU4
GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU = @GST_NAVIGATION_COMMAND_MENU5
GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU = @GST_NAVIGATION_COMMAND_MENU6
GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU = @GST_NAVIGATION_COMMAND_MENU7</doc>
<member name="invalid"
value="0"
c:identifier="GST_NAVIGATION_COMMAND_INVALID"
glib:nick="invalid">
<doc xml:space="preserve">An invalid command entry</doc>
</member>
<member name="menu1"
value="1"
c:identifier="GST_NAVIGATION_COMMAND_MENU1"
glib:nick="menu1">
<doc xml:space="preserve">Execute navigation menu command 1. For DVD,
this enters the DVD root menu, or exits back to the title from the menu.</doc>
</member>
<member name="menu2"
value="2"
c:identifier="GST_NAVIGATION_COMMAND_MENU2"
glib:nick="menu2">
<doc xml:space="preserve">Execute navigation menu command 2. For DVD,
this jumps to the DVD title menu.</doc>
</member>
<member name="menu3"
value="3"
c:identifier="GST_NAVIGATION_COMMAND_MENU3"
glib:nick="menu3">
<doc xml:space="preserve">Execute navigation menu command 3. For DVD,
this jumps into the DVD root menu.</doc>
</member>
<member name="menu4"
value="4"
c:identifier="GST_NAVIGATION_COMMAND_MENU4"
glib:nick="menu4">
<doc xml:space="preserve">Execute navigation menu command 4. For DVD,
this jumps to the Subpicture menu.</doc>
</member>
<member name="menu5"
value="5"
c:identifier="GST_NAVIGATION_COMMAND_MENU5"
glib:nick="menu5">
<doc xml:space="preserve">Execute navigation menu command 5. For DVD,
the jumps to the audio menu.</doc>
</member>
<member name="menu6"
value="6"
c:identifier="GST_NAVIGATION_COMMAND_MENU6"
glib:nick="menu6">
<doc xml:space="preserve">Execute navigation menu command 6. For DVD,
this jumps to the angles menu.</doc>
</member>
<member name="menu7"
value="7"
c:identifier="GST_NAVIGATION_COMMAND_MENU7"
glib:nick="menu7">
<doc xml:space="preserve">Execute navigation menu command 7. For DVD,
this jumps to the chapter menu.</doc>
</member>
<member name="left"
value="20"
c:identifier="GST_NAVIGATION_COMMAND_LEFT"
glib:nick="left">
<doc xml:space="preserve">Select the next button to the left in a menu,
if such a button exists.</doc>
</member>
<member name="right"
value="21"
c:identifier="GST_NAVIGATION_COMMAND_RIGHT"
glib:nick="right">
<doc xml:space="preserve">Select the next button to the right in a menu,
if such a button exists.</doc>
</member>
<member name="up"
value="22"
c:identifier="GST_NAVIGATION_COMMAND_UP"
glib:nick="up">
<doc xml:space="preserve">Select the button above the current one in a
menu, if such a button exists.</doc>
</member>
<member name="down"
value="23"
c:identifier="GST_NAVIGATION_COMMAND_DOWN"
glib:nick="down">
<doc xml:space="preserve">Select the button below the current one in a
menu, if such a button exists.</doc>
</member>
<member name="activate"
value="24"
c:identifier="GST_NAVIGATION_COMMAND_ACTIVATE"
glib:nick="activate">
<doc xml:space="preserve">Activate (click) the currently selected
button in a menu, if such a button exists.</doc>
</member>
<member name="prev_angle"
value="30"
c:identifier="GST_NAVIGATION_COMMAND_PREV_ANGLE"
glib:nick="prev-angle">
<doc xml:space="preserve">Switch to the previous angle in a
multiangle feature.</doc>
</member>
<member name="next_angle"
value="31"
c:identifier="GST_NAVIGATION_COMMAND_NEXT_ANGLE"
glib:nick="next-angle">
<doc xml:space="preserve">Switch to the next angle in a multiangle
feature.</doc>
</member>
</enumeration>
<enumeration name="NavigationEventType"
glib:type-name="GstNavigationEventType"
glib:get-type="gst_navigation_event_type_get_type"
c:type="GstNavigationEventType">
<doc xml:space="preserve">Enum values for the various events that an element implementing the
GstNavigation interface might send up the pipeline.</doc>
<member name="invalid"
value="0"
c:identifier="GST_NAVIGATION_EVENT_INVALID"
glib:nick="invalid">
<doc xml:space="preserve">Returned from
gst_navigation_event_get_type() when the passed event is not a navigation event.</doc>
</member>
<member name="key_press"
value="1"
c:identifier="GST_NAVIGATION_EVENT_KEY_PRESS"
glib:nick="key-press">
<doc xml:space="preserve">A key press event. Use
gst_navigation_event_parse_key_event() to extract the details from the event.</doc>
</member>
<member name="key_release"
value="2"
c:identifier="GST_NAVIGATION_EVENT_KEY_RELEASE"
glib:nick="key-release">
<doc xml:space="preserve">A key release event. Use
gst_navigation_event_parse_key_event() to extract the details from the event.</doc>
</member>
<member name="mouse_button_press"
value="3"
c:identifier="GST_NAVIGATION_EVENT_MOUSE_BUTTON_PRESS"
glib:nick="mouse-button-press">
<doc xml:space="preserve">A mouse button press event. Use
gst_navigation_event_parse_mouse_button_event() to extract the details from the
event.</doc>
</member>
<member name="mouse_button_release"
value="4"
c:identifier="GST_NAVIGATION_EVENT_MOUSE_BUTTON_RELEASE"
glib:nick="mouse-button-release">
<doc xml:space="preserve">A mouse button release event. Use
gst_navigation_event_parse_mouse_button_event() to extract the details from the
event.</doc>
</member>
<member name="mouse_move"
value="5"
c:identifier="GST_NAVIGATION_EVENT_MOUSE_MOVE"
glib:nick="mouse-move">
<doc xml:space="preserve">A mouse movement event. Use
gst_navigation_event_parse_mouse_move_event() to extract the details from the
event.</doc>
</member>
<member name="command"
value="6"
c:identifier="GST_NAVIGATION_EVENT_COMMAND"
glib:nick="command">
<doc xml:space="preserve">A navigation command event. Use
gst_navigation_event_parse_command() to extract the details from the event.</doc>
</member>
</enumeration>
<record name="NavigationInterface"
c:type="GstNavigationInterface"
glib:is-gtype-struct-for="Navigation">
<doc xml:space="preserve">Navigation interface.</doc>
<field name="iface">
<doc xml:space="preserve">the parent interface</doc>
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="send_event">
<callback name="send_event">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="navigation" transfer-ownership="none">
<type name="Navigation" c:type="GstNavigation*"/>
</parameter>
<parameter name="structure" transfer-ownership="none">
<type name="Gst.Structure" c:type="GstStructure*"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<enumeration name="NavigationMessageType"
glib:type-name="GstNavigationMessageType"
glib:get-type="gst_navigation_message_type_get_type"
c:type="GstNavigationMessageType">
<doc xml:space="preserve">A set of notifications that may be received on the bus when navigation
related status changes.</doc>
<member name="invalid"
value="0"
c:identifier="GST_NAVIGATION_MESSAGE_INVALID"
glib:nick="invalid">
<doc xml:space="preserve">Returned from
gst_navigation_message_get_type() when the passed message is not a
navigation message.</doc>
</member>
<member name="mouse_over"
value="1"
c:identifier="GST_NAVIGATION_MESSAGE_MOUSE_OVER"
glib:nick="mouse-over">
<doc xml:space="preserve">Sent when the mouse moves over or leaves a
clickable region of the output, such as a DVD menu button.</doc>
</member>
<member name="commands_changed"
value="2"
c:identifier="GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED"
glib:nick="commands-changed">
<doc xml:space="preserve">Sent when the set of available commands
changes and should re-queried by interested applications.</doc>
</member>
<member name="angles_changed"
value="3"
c:identifier="GST_NAVIGATION_MESSAGE_ANGLES_CHANGED"
glib:nick="angles-changed">
<doc xml:space="preserve">Sent when display angles in a multi-angle
feature (such as a multiangle DVD) change - either angles have appeared or
disappeared.</doc>
</member>
</enumeration>
<enumeration name="NavigationQueryType"
glib:type-name="GstNavigationQueryType"
glib:get-type="gst_navigation_query_type_get_type"
c:type="GstNavigationQueryType">
<doc xml:space="preserve">Tyoes of navigation interface queries.</doc>
<member name="invalid"
value="0"
c:identifier="GST_NAVIGATION_QUERY_INVALID"
glib:nick="invalid">
<doc xml:space="preserve">invalid query</doc>
</member>
<member name="commands"
value="1"
c:identifier="GST_NAVIGATION_QUERY_COMMANDS"
glib:nick="commands">
<doc xml:space="preserve">command query</doc>
</member>
<member name="angles"
value="2"
c:identifier="GST_NAVIGATION_QUERY_ANGLES"
glib:nick="angles">
<doc xml:space="preserve">viewing angle query</doc>
</member>
</enumeration>
<constant name="VIDEO_COLORIMETRY_BT601"
value="bt601"
c:type="GST_VIDEO_COLORIMETRY_BT601">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_COLORIMETRY_BT709"
value="bt709"
c:type="GST_VIDEO_COLORIMETRY_BT709">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_COLORIMETRY_SMPTE240M"
value="smpte240m"
c:type="GST_VIDEO_COLORIMETRY_SMPTE240M">
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_COMP_A" value="3" c:type="GST_VIDEO_COMP_A">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_COMP_B" value="2" c:type="GST_VIDEO_COMP_B">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_COMP_G" value="1" c:type="GST_VIDEO_COMP_G">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_COMP_INDEX" value="0" c:type="GST_VIDEO_COMP_INDEX">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_COMP_PALETTE"
value="1"
c:type="GST_VIDEO_COMP_PALETTE">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_COMP_R" value="0" c:type="GST_VIDEO_COMP_R">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_COMP_U" value="1" c:type="GST_VIDEO_COMP_U">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_COMP_V" value="2" c:type="GST_VIDEO_COMP_V">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_COMP_Y" value="0" c:type="GST_VIDEO_COMP_Y">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_DECODER_MAX_ERRORS"
value="10"
c:type="GST_VIDEO_DECODER_MAX_ERRORS">
<doc xml:space="preserve">Default maximum number of errors tolerated before signaling error.</doc>
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_DECODER_SINK_NAME"
value="sink"
c:type="GST_VIDEO_DECODER_SINK_NAME">
<doc xml:space="preserve">The name of the templates for the sink pad.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_DECODER_SRC_NAME"
value="src"
c:type="GST_VIDEO_DECODER_SRC_NAME">
<doc xml:space="preserve">The name of the templates for the source pad.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_ENCODER_SINK_NAME"
value="sink"
c:type="GST_VIDEO_ENCODER_SINK_NAME">
<doc xml:space="preserve">The name of the templates for the sink pad.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_ENCODER_SRC_NAME"
value="src"
c:type="GST_VIDEO_ENCODER_SRC_NAME">
<doc xml:space="preserve">The name of the templates for the source pad.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="VIDEO_FORMATS_ALL"
value="{ I420, YV12, YUY2, UYVY, AYUV, RGBx, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, Y444, v210, v216, NV12, NV21, NV16, NV24, GRAY8, GRAY16_BE, GRAY16_LE, v308, RGB16, BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10LE, I420_10BE, I422_10LE, I422_10BE, Y444_10LE, Y444_10BE, GBR, GBR_10LE, GBR_10BE }"
c:type="GST_VIDEO_FORMATS_ALL">
<type name="utf8" c:type="gchar*"/>
</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_MAX_COMPONENTS"
value="4"
c:type="GST_VIDEO_MAX_COMPONENTS">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_MAX_PLANES" value="4" c:type="GST_VIDEO_MAX_PLANES">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS"
value="{ BGRx, RGBx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, I420, YV12, AYUV, YUY2, UYVY, v308, Y41B, Y42B, Y444, NV12, NV21, A420, YUV9, YVU9, IYU1, GRAY8 }"
c:type="GST_VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS"
version="1.2">
<doc xml:space="preserve">Video formats supported by gst_video_overlay_composition_blend(), for
use in overlay elements' pad template caps.</doc>
<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>
<record name="VideoAlignment" c:type="GstVideoAlignment">
<doc xml:space="preserve">Extra alignment paramters for the memory of video buffers. This
structure is usually used to configure the bufferpool if it supports the
#GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT.</doc>
<field name="padding_top" writable="1">
<doc xml:space="preserve">extra pixels on the top</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="padding_bottom" writable="1">
<doc xml:space="preserve">extra pixels on the bottom</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="padding_left" writable="1">
<doc xml:space="preserve">extra pixels on the left side</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="padding_right" writable="1">
<doc xml:space="preserve">extra pixels on the right side</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="stride_align" writable="1">
<doc xml:space="preserve">array with extra alignment requirements for the strides</doc>
<array zero-terminated="0" c:type="guint" fixed-size="4">
<type name="guint" c:type="guint"/>
</array>
</field>
<method name="reset" c:identifier="gst_video_alignment_reset">
<doc xml:space="preserve">Set @align to its default values with no padding and no alignment.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="align" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoAlignment</doc>
<type name="VideoAlignment" c:type="GstVideoAlignment*"/>
</instance-parameter>
</parameters>
</method>
</record>
<bitfield name="VideoBufferFlags" c:type="GstVideoBufferFlags">
<doc xml:space="preserve">Additional video buffer flags.</doc>
<member name="interlaced"
value="1048576"
c:identifier="GST_VIDEO_BUFFER_FLAG_INTERLACED">
<doc xml:space="preserve">If the #GstBuffer is interlaced. In mixed
interlace-mode, this flags specifies if the frame is
interlaced or progressive.</doc>
</member>
<member name="tff"
value="2097152"
c:identifier="GST_VIDEO_BUFFER_FLAG_TFF">
<doc xml:space="preserve">If the #GstBuffer is interlaced, then the first field
in the video frame is the top field. If unset, the
bottom field is first.</doc>
</member>
<member name="rff"
value="4194304"
c:identifier="GST_VIDEO_BUFFER_FLAG_RFF">
<doc xml:space="preserve">If the #GstBuffer is interlaced, then the first field
(as defined by the %GST_VIDEO_BUFFER_TFF flag setting)
is repeated.</doc>
</member>
<member name="onefield"
value="8388608"
c:identifier="GST_VIDEO_BUFFER_FLAG_ONEFIELD">
<doc xml:space="preserve">If the #GstBuffer is interlaced, then only the
first field (as defined by the %GST_VIDEO_BUFFER_TFF
flag setting) is to be displayed.</doc>
</member>
<member name="last"
value="268435456"
c:identifier="GST_VIDEO_BUFFER_FLAG_LAST">
</member>
</bitfield>
<class name="VideoBufferPool"
c:symbol-prefix="video_buffer_pool"
c:type="GstVideoBufferPool"
parent="Gst.BufferPool"
glib:type-name="GstVideoBufferPool"
glib:get-type="gst_video_buffer_pool_get_type"
glib:type-struct="VideoBufferPoolClass">
<constructor name="new" c:identifier="gst_video_buffer_pool_new">
<doc xml:space="preserve">Create a new bufferpool that can allocate video frames. This bufferpool
supports all the video bufferpool options.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a new #GstBufferPool to allocate video frames</doc>
<type name="Gst.BufferPool" c:type="GstBufferPool*"/>
</return-value>
</constructor>
<field name="bufferpool">
<type name="Gst.BufferPool" c:type="GstBufferPool"/>
</field>
<field name="priv">
<type name="VideoBufferPoolPrivate"
c:type="GstVideoBufferPoolPrivate*"/>
</field>
</class>
<record name="VideoBufferPoolClass"
c:type="GstVideoBufferPoolClass"
glib:is-gtype-struct-for="VideoBufferPool">
<field name="parent_class">
<type name="Gst.BufferPoolClass" c:type="GstBufferPoolClass"/>
</field>
</record>
<record name="VideoBufferPoolPrivate"
c:type="GstVideoBufferPoolPrivate"
disguised="1">
</record>
<bitfield name="VideoChromaFlags"
glib:type-name="GstVideoChromaFlags"
glib:get-type="gst_video_chroma_flags_get_type"
c:type="GstVideoChromaFlags">
<doc xml:space="preserve">Extra flags that influence the result from gst_video_chroma_resample_new().</doc>
<member name="none"
value="0"
c:identifier="GST_VIDEO_CHROMA_FLAG_NONE"
glib:nick="none">
<doc xml:space="preserve">no flags</doc>
</member>
<member name="interlaced"
value="1"
c:identifier="GST_VIDEO_CHROMA_FLAG_INTERLACED"
glib:nick="interlaced">
<doc xml:space="preserve">the input is interlaced</doc>
</member>
</bitfield>
<enumeration name="VideoChromaMethod"
glib:type-name="GstVideoChromaMethod"
glib:get-type="gst_video_chroma_method_get_type"
c:type="GstVideoChromaMethod">
<doc xml:space="preserve">Different subsampling and upsampling methods</doc>
<member name="nearest"
value="0"
c:identifier="GST_VIDEO_CHROMA_METHOD_NEAREST"
glib:nick="nearest">
<doc xml:space="preserve">Duplicates the chroma samples when
upsampling and drops when subsampling</doc>
</member>
<member name="linear"
value="1"
c:identifier="GST_VIDEO_CHROMA_METHOD_LINEAR"
glib:nick="linear">
<doc xml:space="preserve">Uses linear interpolation to reconstruct
missing chroma and averaging to subsample</doc>
</member>
</enumeration>
<record name="VideoChromaResample"
c:type="GstVideoChromaResample"
disguised="1">
<method name="" c:identifier="gst_video_chroma_resample">
<doc xml:space="preserve">Perform resampling of @width chroma pixels in @lines.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="resample" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoChromaResample</doc>
<type name="VideoChromaResample" c:type="GstVideoChromaResample*"/>
</instance-parameter>
<parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve">pixel lines</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">the number of pixels on one line</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="free" c:identifier="gst_video_chroma_resample_free">
<doc xml:space="preserve">Free @resample</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="resample" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoChromaResample</doc>
<type name="VideoChromaResample" c:type="GstVideoChromaResample*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_info"
c:identifier="gst_video_chroma_resample_get_info">
<doc xml:space="preserve">The resampler must be fed @n_lines at a time. The first line should be
at @offset.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="resample" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoChromaResample</doc>
<type name="VideoChromaResample" c:type="GstVideoChromaResample*"/>
</instance-parameter>
<parameter name="n_lines" transfer-ownership="none">
<doc xml:space="preserve">the number of input lines</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="offset" transfer-ownership="none">
<doc xml:space="preserve">the first line</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<function name="new"
c:identifier="gst_video_chroma_resample_new"
introspectable="0">
<doc xml:space="preserve">Create a new resampler object for the given parameters. When @h_factor or
@v_factoris > 0, upsampling will be used, otherwise subsampling is
performed.</doc>
<return-value>
<doc xml:space="preserve">a new #GstVideoChromaResample that should be freed with
gst_video_chroma_resample_free() after usage.</doc>
<type name="VideoChromaResample" c:type="GstVideoChromaResample*"/>
</return-value>
<parameters>
<parameter name="method" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoChromaMethod</doc>
<type name="VideoChromaMethod" c:type="GstVideoChromaMethod"/>
</parameter>
<parameter name="site" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoChromaSite</doc>
<type name="VideoChromaSite" c:type="GstVideoChromaSite"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoChromaFlags</doc>
<type name="VideoChromaFlags" c:type="GstVideoChromaFlags"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">the #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="h_factor" transfer-ownership="none">
<doc xml:space="preserve">horizontal resampling factor</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="v_factor" transfer-ownership="none">
<doc xml:space="preserve">vertical resampling factor</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</function>
</record>
<bitfield name="VideoChromaSite"
glib:type-name="GstVideoChromaSite"
glib:get-type="gst_video_chroma_site_get_type"
c:type="GstVideoChromaSite">
<doc xml:space="preserve">Various Chroma sitings.</doc>
<member name="unknown"
value="0"
c:identifier="GST_VIDEO_CHROMA_SITE_UNKNOWN"
glib:nick="unknown">
<doc xml:space="preserve">unknown cositing</doc>
</member>
<member name="none"
value="1"
c:identifier="GST_VIDEO_CHROMA_SITE_NONE"
glib:nick="none">
<doc xml:space="preserve">no cositing</doc>
</member>
<member name="h_cosited"
value="2"
c:identifier="GST_VIDEO_CHROMA_SITE_H_COSITED"
glib:nick="h-cosited">
<doc xml:space="preserve">chroma is horizontally cosited</doc>
</member>
<member name="v_cosited"
value="4"
c:identifier="GST_VIDEO_CHROMA_SITE_V_COSITED"
glib:nick="v-cosited">
<doc xml:space="preserve">chroma is vertically cosited</doc>
</member>
<member name="alt_line"
value="8"
c:identifier="GST_VIDEO_CHROMA_SITE_ALT_LINE"
glib:nick="alt-line">
<doc xml:space="preserve">choma samples are sited on alternate lines</doc>
</member>
<member name="cosited"
value="6"
c:identifier="GST_VIDEO_CHROMA_SITE_COSITED"
glib:nick="cosited">
<doc xml:space="preserve">chroma samples cosited with luma samples</doc>
</member>
<member name="jpeg"
value="1"
c:identifier="GST_VIDEO_CHROMA_SITE_JPEG"
glib:nick="jpeg">
<doc xml:space="preserve">jpeg style cositing, also for mpeg1 and mjpeg</doc>
</member>
<member name="mpeg2"
value="2"
c:identifier="GST_VIDEO_CHROMA_SITE_MPEG2"
glib:nick="mpeg2">
<doc xml:space="preserve">mpeg2 style cositing</doc>
</member>
<member name="dv"
value="14"
c:identifier="GST_VIDEO_CHROMA_SITE_DV"
glib:nick="dv">
<doc xml:space="preserve">DV style cositing</doc>
</member>
</bitfield>
<record name="VideoCodecFrame"
c:type="GstVideoCodecFrame"
glib:type-name="GstVideoCodecFrame"
glib:get-type="gst_video_codec_frame_get_type"
c:symbol-prefix="video_codec_frame">
<doc xml:space="preserve">A #GstVideoCodecFrame represents a video frame both in raw and
encoded form.</doc>
<field name="ref_count" readable="0" private="1">
<type name="gint" c:type="gint"/>
</field>
<field name="flags" readable="0" private="1">
<type name="guint32" c:type="guint32"/>
</field>
<field name="system_frame_number" writable="1">
<doc xml:space="preserve">Unique identifier for the frame. Use this if you need
to get hold of the frame later (like when data is being decoded).
Typical usage in decoders is to set this on the opaque value provided
to the library and get back the frame using gst_video_decoder_get_frame()</doc>
<type name="guint32" c:type="guint32"/>
</field>
<field name="decode_frame_number" writable="1">
<type name="guint32" c:type="guint32"/>
</field>
<field name="presentation_frame_number" writable="1">
<type name="guint32" c:type="guint32"/>
</field>
<field name="dts" writable="1">
<doc xml:space="preserve">Decoding timestamp</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</field>
<field name="pts" writable="1">
<doc xml:space="preserve">Presentation timestamp</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</field>
<field name="duration" writable="1">
<doc xml:space="preserve">Duration of the frame</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</field>
<field name="distance_from_sync" writable="1">
<doc xml:space="preserve">Distance in frames from the last synchronization point.</doc>
<type name="gint" c:type="int"/>
</field>
<field name="input_buffer" writable="1">
<doc xml:space="preserve">the input #GstBuffer that created this frame. The buffer is owned
by the frame and references to the frame instead of the buffer should</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</field>
<field name="output_buffer" writable="1">
<doc xml:space="preserve">the output #GstBuffer. Implementations should set this either
directly, or by using the @gst_video_decoder_alloc_output_frame() or
@gst_video_decoder_alloc_output_buffer() methods. The buffer is owned
by the frame and references to the frame instead of the buffer should
be kept.</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</field>
<field name="deadline" writable="1">
<doc xml:space="preserve">Running time when the frame will be used.</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</field>
<field name="events" readable="0" private="1">
<doc xml:space="preserve">Events that will be pushed downstream before this frame is pushed.</doc>
<type name="GLib.List" c:type="GList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</field>
<field name="user_data" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="user_data_destroy_notify" readable="0" private="1">
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</field>
<union name="abidata" c:type="abidata">
<record name="ABI" c:type="ABI">
<field name="ts" writable="1">
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</field>
<field name="ts2" writable="1">
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</field>
</record>
<field name="padding" writable="1">
<array zero-terminated="0" c:type="void" fixed-size="20">
<type name="gpointer" c:type="void*"/>
</array>
</field>
</union>
<method name="get_user_data"
c:identifier="gst_video_codec_frame_get_user_data">
<doc xml:space="preserve">Gets private data set on the frame by the subclass via
gst_video_codec_frame_set_user_data() previously.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The previously set user_data</doc>
<type name="gpointer" c:type="gpointer"/>
</return-value>
<parameters>
<instance-parameter name="frame" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoCodecFrame</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</instance-parameter>
</parameters>
</method>
<method name="ref" c:identifier="gst_video_codec_frame_ref">
<doc xml:space="preserve">Increases the refcount of the given frame by one.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">@buf</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</return-value>
<parameters>
<instance-parameter name="frame" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoCodecFrame</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_user_data"
c:identifier="gst_video_codec_frame_set_user_data">
<doc xml:space="preserve">Sets @user_data on the frame and the #GDestroyNotify that will be called when
the frame is freed. Allows to attach private data by the subclass to frames.
If a @user_data was previously set, then the previous set @notify will be called
before the @user_data is replaced.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="frame" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoCodecFrame</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</instance-parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">private data</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="notify"
transfer-ownership="none"
scope="async"
closure="0">
<doc xml:space="preserve">a #GDestroyNotify</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="unref" c:identifier="gst_video_codec_frame_unref">
<doc xml:space="preserve">Decreases the refcount of the frame. If the refcount reaches 0, the frame
will be freed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="frame" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoCodecFrame</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</instance-parameter>
</parameters>
</method>
</record>
<bitfield name="VideoCodecFrameFlags" c:type="GstVideoCodecFrameFlags">
<doc xml:space="preserve">Flags for #GstVideoCodecFrame</doc>
<member name="decode_only"
value="1"
c:identifier="GST_VIDEO_CODEC_FRAME_FLAG_DECODE_ONLY">
<doc xml:space="preserve">is the frame only meant to be decoded</doc>
</member>
<member name="sync_point"
value="2"
c:identifier="GST_VIDEO_CODEC_FRAME_FLAG_SYNC_POINT">
<doc xml:space="preserve">is the frame a synchronization point (keyframe)</doc>
</member>
<member name="force_keyframe"
value="4"
c:identifier="GST_VIDEO_CODEC_FRAME_FLAG_FORCE_KEYFRAME">
<doc xml:space="preserve">should the output frame be made a keyframe</doc>
</member>
<member name="force_keyframe_headers"
value="8"
c:identifier="GST_VIDEO_CODEC_FRAME_FLAG_FORCE_KEYFRAME_HEADERS">
<doc xml:space="preserve">should the encoder output stream headers</doc>
</member>
</bitfield>
<record name="VideoCodecState"
c:type="GstVideoCodecState"
glib:type-name="GstVideoCodecState"
glib:get-type="gst_video_codec_state_get_type"
c:symbol-prefix="video_codec_state">
<doc xml:space="preserve">Structure representing the state of an incoming or outgoing video
stream for encoders and decoders.
Decoders and encoders will receive such a state through their
respective @set_format vmethods.
Decoders and encoders can set the downstream state, by using the
@gst_video_decoder_set_output_state() or
@gst_video_encoder_set_output_state() methods.</doc>
<field name="ref_count" readable="0" private="1">
<type name="gint" c:type="gint"/>
</field>
<field name="info" writable="1">
<doc xml:space="preserve">The #GstVideoInfo describing the stream</doc>
<type name="VideoInfo" c:type="GstVideoInfo"/>
</field>
<field name="caps" writable="1">
<doc xml:space="preserve">The #GstCaps</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</field>
<field name="codec_data" writable="1">
<doc xml:space="preserve">a #GstBuffer corresponding to the
'codec_data' field of a stream.</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</field>
<field name="padding" readable="0" private="1">
<array zero-terminated="0" c:type="void" fixed-size="20">
<type name="gpointer" c:type="void*"/>
</array>
</field>
<method name="ref" c:identifier="gst_video_codec_state_ref">
<doc xml:space="preserve">Increases the refcount of the given state by one.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">@buf</doc>
<type name="VideoCodecState" c:type="GstVideoCodecState*"/>
</return-value>
<parameters>
<instance-parameter name="state" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoCodecState</doc>
<type name="VideoCodecState" c:type="GstVideoCodecState*"/>
</instance-parameter>
</parameters>
</method>
<method name="unref" c:identifier="gst_video_codec_state_unref">
<doc xml:space="preserve">Decreases the refcount of the state. If the refcount reaches 0, the state
will be freed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="state" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoCodecState</doc>
<type name="VideoCodecState" c:type="GstVideoCodecState*"/>
</instance-parameter>
</parameters>
</method>
</record>
<enumeration name="VideoColorMatrix"
glib:type-name="GstVideoColorMatrix"
glib:get-type="gst_video_color_matrix_get_type"
c:type="GstVideoColorMatrix">
<doc xml:space="preserve">The color matrix is used to convert between Y'PbPr and
non-linear RGB (R'G'B')</doc>
<member name="unknown"
value="0"
c:identifier="GST_VIDEO_COLOR_MATRIX_UNKNOWN"
glib:nick="unknown">
<doc xml:space="preserve">unknown matrix</doc>
</member>
<member name="rgb"
value="1"
c:identifier="GST_VIDEO_COLOR_MATRIX_RGB"
glib:nick="rgb">
<doc xml:space="preserve">identity matrix</doc>
</member>
<member name="fcc"
value="2"
c:identifier="GST_VIDEO_COLOR_MATRIX_FCC"
glib:nick="fcc">
<doc xml:space="preserve">FCC color matrix</doc>
</member>
<member name="bt709"
value="3"
c:identifier="GST_VIDEO_COLOR_MATRIX_BT709"
glib:nick="bt709">
<doc xml:space="preserve">ITU-R BT.709 color matrix</doc>
</member>
<member name="bt601"
value="4"
c:identifier="GST_VIDEO_COLOR_MATRIX_BT601"
glib:nick="bt601">
<doc xml:space="preserve">ITU-R BT.601 color matrix</doc>
</member>
<member name="smpte240m"
value="5"
c:identifier="GST_VIDEO_COLOR_MATRIX_SMPTE240M"
glib:nick="smpte240m">
<doc xml:space="preserve">SMPTE 240M color matrix</doc>
</member>
</enumeration>
<enumeration name="VideoColorPrimaries"
glib:type-name="GstVideoColorPrimaries"
glib:get-type="gst_video_color_primaries_get_type"
c:type="GstVideoColorPrimaries">
<doc xml:space="preserve">The color primaries define the how to transform linear RGB values to and from
the CIE XYZ colorspace.</doc>
<member name="unknown"
value="0"
c:identifier="GST_VIDEO_COLOR_PRIMARIES_UNKNOWN"
glib:nick="unknown">
<doc xml:space="preserve">unknown color primaries</doc>
</member>
<member name="bt709"
value="1"
c:identifier="GST_VIDEO_COLOR_PRIMARIES_BT709"
glib:nick="bt709">
<doc xml:space="preserve">BT709 primaries</doc>
</member>
<member name="bt470m"
value="2"
c:identifier="GST_VIDEO_COLOR_PRIMARIES_BT470M"
glib:nick="bt470m">
<doc xml:space="preserve">BT470M primaries</doc>
</member>
<member name="bt470bg"
value="3"
c:identifier="GST_VIDEO_COLOR_PRIMARIES_BT470BG"
glib:nick="bt470bg">
<doc xml:space="preserve">BT470BG primaries</doc>
</member>
<member name="smpte170m"
value="4"
c:identifier="GST_VIDEO_COLOR_PRIMARIES_SMPTE170M"
glib:nick="smpte170m">
<doc xml:space="preserve">SMPTE170M primaries</doc>
</member>
<member name="smpte240m"
value="5"
c:identifier="GST_VIDEO_COLOR_PRIMARIES_SMPTE240M"
glib:nick="smpte240m">
<doc xml:space="preserve">SMPTE240M primaries</doc>
</member>
<member name="film"
value="6"
c:identifier="GST_VIDEO_COLOR_PRIMARIES_FILM"
glib:nick="film">
<doc xml:space="preserve">Generic film</doc>
</member>
</enumeration>
<enumeration name="VideoColorRange"
glib:type-name="GstVideoColorRange"
glib:get-type="gst_video_color_range_get_type"
c:type="GstVideoColorRange">
<doc xml:space="preserve">Possible color range values. These constants are defined for 8 bit color
values and can be scaled for other bit depths.</doc>
<member name="unknown"
value="0"
c:identifier="GST_VIDEO_COLOR_RANGE_UNKNOWN"
glib:nick="unknown">
<doc xml:space="preserve">unknown range</doc>
</member>
<member name="0_255"
value="1"
c:identifier="GST_VIDEO_COLOR_RANGE_0_255"
glib:nick="0-255">
<doc xml:space="preserve">[0..255] for 8 bit components</doc>
</member>
<member name="16_235"
value="2"
c:identifier="GST_VIDEO_COLOR_RANGE_16_235"
glib:nick="16-235">
<doc xml:space="preserve">[16..235] for 8 bit components. Chroma has
[16..240] range.</doc>
</member>
<function name="offsets" c:identifier="gst_video_color_range_offsets">
<doc xml:space="preserve">Compute the offset and scale values for each component of @info. For each
component, (c[i] - offset[i]) / scale[i] will scale the component c[i] to the
range [0.0 .. 1.0].
The reverse operation (c[i] * scale[i]) + offset[i] can be used to convert
the component values in range [0.0 .. 1.0] back to their representation in
@info and @range.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="range" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoColorRange</doc>
<type name="VideoColorRange" c:type="GstVideoColorRange"/>
</parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFormatInfo</doc>
<type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
</parameter>
<parameter name="offset" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="scale"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">output scale</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</function>
</enumeration>
<record name="VideoColorimetry" c:type="GstVideoColorimetry">
<doc xml:space="preserve">Structure describing the color info.</doc>
<field name="range" writable="1">
<doc xml:space="preserve">the color range. This is the valid range for the samples.
It is used to convert the samples to Y'PbPr values.</doc>
<type name="VideoColorRange" c:type="GstVideoColorRange"/>
</field>
<field name="matrix" writable="1">
<doc xml:space="preserve">the color matrix. Used to convert between Y'PbPr and
non-linear RGB (R'G'B')</doc>
<type name="VideoColorMatrix" c:type="GstVideoColorMatrix"/>
</field>
<field name="transfer" writable="1">
<doc xml:space="preserve">the transfer function. used to convert between R'G'B' and RGB</doc>
<type name="VideoTransferFunction" c:type="GstVideoTransferFunction"/>
</field>
<field name="primaries" writable="1">
<doc xml:space="preserve">color primaries. used to convert between R'G'B' and CIE XYZ</doc>
<type name="VideoColorPrimaries" c:type="GstVideoColorPrimaries"/>
</field>
<method name="from_string"
c:identifier="gst_video_colorimetry_from_string">
<doc xml:space="preserve">Parse the colorimetry string and update @cinfo with the parsed
values.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if @color points to valid colorimetry info.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cinfo" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoColorimetry</doc>
<type name="VideoColorimetry" c:type="GstVideoColorimetry*"/>
</instance-parameter>
<parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a colorimetry string</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="matches" c:identifier="gst_video_colorimetry_matches">
<doc xml:space="preserve">Check if the colorimetry information in @info matches that of the
string @color.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if @color conveys the same colorimetry info as the color
information in @info.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cinfo" transfer-ownership="none">
<type name="VideoColorimetry" c:type="GstVideoColorimetry*"/>
</instance-parameter>
<parameter name="color" transfer-ownership="none">
<doc xml:space="preserve">a colorimetry string</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="to_string" c:identifier="gst_video_colorimetry_to_string">
<doc xml:space="preserve">Make a string representation of @cinfo.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a string representation of @cinfo.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cinfo" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoColorimetry</doc>
<type name="VideoColorimetry" c:type="GstVideoColorimetry*"/>
</instance-parameter>
</parameters>
</method>
</record>
<callback name="VideoConvertSampleCallback"
c:type="GstVideoConvertSampleCallback">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="sample" transfer-ownership="none">
<type name="Gst.Sample" c:type="GstSample*"/>
</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>
<record name="VideoCropMeta" c:type="GstVideoCropMeta">
<doc xml:space="preserve">Extra buffer metadata describing image cropping.</doc>
<field name="meta" writable="1">
<doc xml:space="preserve">parent #GstMeta</doc>
<type name="Gst.Meta" c:type="GstMeta"/>
</field>
<field name="x" writable="1">
<doc xml:space="preserve">the horizontal offset</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="y" writable="1">
<doc xml:space="preserve">the vertical offset</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="width" writable="1">
<doc xml:space="preserve">the cropped width</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="height" writable="1">
<doc xml:space="preserve">the cropped height</doc>
<type name="guint" c:type="guint"/>
</field>
<function name="get_info" c:identifier="gst_video_crop_meta_get_info">
<return-value transfer-ownership="none">
<type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
</return-value>
</function>
</record>
<class name="VideoDecoder"
c:symbol-prefix="video_decoder"
c:type="GstVideoDecoder"
parent="Gst.Element"
abstract="1"
glib:type-name="GstVideoDecoder"
glib:get-type="gst_video_decoder_get_type"
glib:type-struct="VideoDecoderClass">
<doc xml:space="preserve">This base class is for video decoders turning encoded data into raw video
frames.
The GstVideoDecoder base class and derived subclasses should cooperate as follows:
<orderedlist>
<listitem>
<itemizedlist><title>Configuration</title>
<listitem><para>
Initially, GstVideoDecoder calls @start when the decoder element
is activated, which allows the subclass to perform any global setup.
</para></listitem>
<listitem><para>
GstVideoDecoder calls @set_format to inform the subclass of caps
describing input video data that it is about to receive, including
possibly configuration data.
While unlikely, it might be called more than once, if changing input
parameters require reconfiguration.
</para></listitem>
<listitem><para>
Incoming data buffers are processed as needed, described in Data Processing below.
</para></listitem>
<listitem><para>
GstVideoDecoder calls @stop at end of all processing.
</para></listitem>
</itemizedlist>
</listitem>
<listitem>
<itemizedlist>
<title>Data processing</title>
<listitem><para>
The base class gathers input data, and optionally allows subclass
to parse this into subsequently manageable chunks, typically
corresponding to and referred to as 'frames'.
</para></listitem>
<listitem><para>
Each input frame is provided in turn to the subclass' @handle_frame callback.
The ownership of the frame is given to the @handle_frame callback.
</para></listitem>
<listitem><para>
If codec processing results in decoded data, the subclass should call
@gst_video_decoder_finish_frame to have decoded data pushed.
downstream. Otherwise, the subclass must call @gst_video_decoder_drop_frame, to
allow the base class to do timestamp and offset tracking, and possibly to
requeue the frame for a later attempt in the case of reverse playback.
</para></listitem>
</itemizedlist>
</listitem>
<listitem>
<itemizedlist><title>Shutdown phase</title>
<listitem><para>
The GstVideoDecoder class calls @stop to inform the subclass that data
parsing will be stopped.
</para></listitem>
</itemizedlist>
</listitem>
<listitem>
<itemizedlist><title>Additional Notes</title>
<listitem>
<itemizedlist><title>Seeking/Flushing</title>
<listitem><para>
When the pipeline is seeked or otherwise flushed, the subclass is informed via a call
to its @reset callback, with the hard parameter set to true. This indicates the
subclass should drop any internal data queues and timestamps and prepare for a fresh
set of buffers to arrive for parsing and decoding.
</para></listitem>
</itemizedlist>
</listitem>
<listitem>
<itemizedlist><title>End Of Stream</title>
<listitem><para>
At end-of-stream, the subclass @parse function may be called some final times with the
at_eos parameter set to true, indicating that the element should not expect any more data
to be arriving, and it should parse and remaining frames and call
gst_video_decoder_have_frame() if possible.
</para></listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
The subclass is responsible for providing pad template caps for
source and sink pads. The pads need to be named "sink" and "src". It also
needs to provide information about the ouptput caps, when they are known.
This may be when the base class calls the subclass' @set_format function,
though it might be during decoding, before calling
@gst_video_decoder_finish_frame. This is done via
@gst_video_decoder_set_output_state
The subclass is also responsible for providing (presentation) timestamps
(likely based on corresponding input ones). If that is not applicable
or possible, the base class provides limited framerate based interpolation.
Similarly, the base class provides some limited (legacy) seeking support
if specifically requested by the subclass, as full-fledged support
should rather be left to upstream demuxer, parser or alike. This simple
approach caters for seeking and duration reporting using estimated input
bitrates. To enable it, a subclass should call
@gst_video_decoder_set_estimate_rate to enable handling of incoming byte-streams.
The base class provides some support for reverse playback, in particular
in case incoming data is not packetized or upstream does not provide
fragments on keyframe boundaries. However, the subclass should then be prepared
for the parsing and frame processing stage to occur separately (in normal
forward processing, the latter immediately follows the former),
The subclass also needs to ensure the parsing stage properly marks keyframes,
unless it knows the upstream elements will do so properly for incoming data.
The bare minimum that a functional subclass needs to implement is:
<itemizedlist>
<listitem><para>Provide pad templates</para></listitem>
<listitem><para>
Inform the base class of output caps via @gst_video_decoder_set_output_state
</para></listitem>
<listitem><para>
Parse input data, if it is not considered packetized from upstream
Data will be provided to @parse which should invoke @gst_video_decoder_add_to_frame and
@gst_video_decoder_have_frame to separate the data belonging to each video frame.
</para></listitem>
<listitem><para>
Accept data in @handle_frame and provide decoded results to
@gst_video_decoder_finish_frame, or call @gst_video_decoder_drop_frame.
</para></listitem>
</itemizedlist></doc>
<virtual-method name="close">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="decide_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="finish">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="flush">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="handle_frame">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="frame" transfer-ownership="none">
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="negotiate" invoker="negotiate">
<doc xml:space="preserve">Negotiate with downstream elements to currently configured #GstVideoCodecState.
Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
negotiate fails.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if the negotiation succeeded, else #FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="open">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="parse">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="frame" transfer-ownership="none">
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
<parameter name="adapter" transfer-ownership="none">
<type name="GstBase.Adapter" c:type="GstAdapter*"/>
</parameter>
<parameter name="at_eos" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="propose_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="reset">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="hard" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_format">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="state" transfer-ownership="none">
<type name="VideoCodecState" c:type="GstVideoCodecState*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="sink_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="src_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="start">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="stop">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="add_to_frame"
c:identifier="gst_video_decoder_add_to_frame">
<doc xml:space="preserve">Removes next @n_bytes of input data and adds it to currently parsed frame.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="n_bytes" transfer-ownership="none">
<doc xml:space="preserve">the number of bytes to add</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="allocate_output_buffer"
c:identifier="gst_video_decoder_allocate_output_buffer">
<doc xml:space="preserve">Helper function that allocates a buffer to hold a video frame for @decoder's
current #GstVideoCodecState.
You should use gst_video_decoder_allocate_output_frame() instead of this
function, if possible at all.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">allocated buffer, or NULL if no buffer could be
allocated (e.g. when downstream is flushing or shutting down)</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="allocate_output_frame"
c:identifier="gst_video_decoder_allocate_output_frame">
<doc xml:space="preserve">Helper function that allocates a buffer to hold a video frame for @decoder's
current #GstVideoCodecState. Subclass should already have configured video
state and set src pad caps.
The buffer allocated here is owned by the frame and you should only
keep references to the frame, not the buffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%GST_FLOW_OK if an output buffer could be allocated</doc>
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="frame" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoCodecFrame</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
</parameters>
</method>
<method name="drop_frame" c:identifier="gst_video_decoder_drop_frame">
<doc xml:space="preserve">Similar to gst_video_decoder_finish_frame(), but drops @frame in any
case and posts a QoS message with the frame's details on the bus.
In any case, the frame is considered finished and released.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstFlowReturn, usually GST_FLOW_OK.</doc>
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="frame" transfer-ownership="full">
<doc xml:space="preserve">the #GstVideoCodecFrame to drop</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
</parameters>
</method>
<method name="finish_frame"
c:identifier="gst_video_decoder_finish_frame">
<doc xml:space="preserve">@frame should have a valid decoded data buffer, whose metadata fields
are then appropriately set according to frame data and pushed downstream.
If no output data is provided, @frame is considered skipped.
In any case, the frame is considered finished and released.
After calling this function the output buffer of the frame is to be
considered read-only. This function will also change the metadata
of the buffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstFlowReturn resulting from sending data downstream</doc>
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="frame" transfer-ownership="full">
<doc xml:space="preserve">a decoded #GstVideoCodecFrame</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
</parameters>
</method>
<method name="get_allocator"
c:identifier="gst_video_decoder_get_allocator">
<doc xml:space="preserve">Lets #GstVideoDecoder sub-classes to know the memory @allocator
used by the base class and its @params.
Unref the @allocator after use it.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="allocator"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:space="preserve">the #GstAllocator
used</doc>
<type name="Gst.Allocator" c:type="GstAllocator**"/>
</parameter>
<parameter name="params"
direction="out"
caller-allocates="1"
transfer-ownership="full"
allow-none="1">
<doc xml:space="preserve">the
#GstAllocatorParams of @allocator</doc>
<type name="Gst.AllocationParams" c:type="GstAllocationParams*"/>
</parameter>
</parameters>
</method>
<method name="get_buffer_pool"
c:identifier="gst_video_decoder_get_buffer_pool">
<return-value transfer-ownership="full">
<doc xml:space="preserve">the instance of the #GstBufferPool used
by the decoder; free it after use it</doc>
<type name="Gst.BufferPool" c:type="GstBufferPool*"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_estimate_rate"
c:identifier="gst_video_decoder_get_estimate_rate">
<return-value transfer-ownership="none">
<doc xml:space="preserve">currently configured byte to time conversion setting</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_frame" c:identifier="gst_video_decoder_get_frame">
<doc xml:space="preserve">Get a pending unfinished #GstVideoCodecFrame</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">pending unfinished #GstVideoCodecFrame identified by @frame_number.</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="frame_number" transfer-ownership="none">
<doc xml:space="preserve">system_frame_number of a frame</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="get_frames" c:identifier="gst_video_decoder_get_frames">
<doc xml:space="preserve">Get all pending unfinished #GstVideoCodecFrame</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">pending unfinished #GstVideoCodecFrame.</doc>
<type name="GLib.List" c:type="GList*">
<type name="VideoCodecFrame"/>
</type>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_latency" c:identifier="gst_video_decoder_get_latency">
<doc xml:space="preserve">Query the configured decoder latency. Results will be returned via
@min_latency and @max_latency.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="min_latency"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:space="preserve">address of variable in which to store the
configured minimum latency, or %NULL</doc>
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
<parameter name="max_latency"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:space="preserve">address of variable in which to store the
configured mximum latency, or %NULL</doc>
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
</parameters>
</method>
<method name="get_max_decode_time"
c:identifier="gst_video_decoder_get_max_decode_time">
<doc xml:space="preserve">Determines maximum possible decoding time for @frame that will
allow it to decode and arrive in time (as determined by QoS events).
In particular, a negative result means decoding in time is no longer possible
and should therefore occur as soon/skippy as possible.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">max decoding time.</doc>
<type name="Gst.ClockTimeDiff" c:type="GstClockTimeDiff"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="frame" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoCodecFrame</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
</parameters>
</method>
<method name="get_max_errors"
c:identifier="gst_video_decoder_get_max_errors">
<return-value transfer-ownership="none">
<doc xml:space="preserve">currently configured decoder tolerated error count.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_oldest_frame"
c:identifier="gst_video_decoder_get_oldest_frame">
<doc xml:space="preserve">Get the oldest pending unfinished #GstVideoCodecFrame</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">oldest pending unfinished #GstVideoCodecFrame.</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_output_state"
c:identifier="gst_video_decoder_get_output_state">
<doc xml:space="preserve">Get the #GstVideoCodecState currently describing the output stream.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">#GstVideoCodecState describing format of video data.</doc>
<type name="VideoCodecState" c:type="GstVideoCodecState*"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_packetized"
c:identifier="gst_video_decoder_get_packetized">
<doc xml:space="preserve">Queries whether input data is considered packetized or not by the
base class.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if input data is considered packetized.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_qos_proportion"
c:identifier="gst_video_decoder_get_qos_proportion"
version="1.0.3">
<return-value transfer-ownership="none">
<doc xml:space="preserve">The current QoS proportion.</doc>
<type name="gdouble" c:type="gdouble"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder
current QoS proportion, or %NULL</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="have_frame" c:identifier="gst_video_decoder_have_frame">
<doc xml:space="preserve">Gathers all data collected for currently parsed frame, gathers corresponding
metadata and passes it along for further processing, i.e. @handle_frame.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstFlowReturn</doc>
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="merge_tags" c:identifier="gst_video_decoder_merge_tags">
<doc xml:space="preserve">Adds tags to so-called pending tags, which will be processed
before pushing out data downstream.
Note that this is provided for convenience, and the subclass is
not required to use this and can still do tag handling on its own.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="tags" transfer-ownership="none">
<doc xml:space="preserve">a #GstTagList to merge</doc>
<type name="Gst.TagList" c:type="const GstTagList*"/>
</parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve">the #GstTagMergeMode to use</doc>
<type name="Gst.TagMergeMode" c:type="GstTagMergeMode"/>
</parameter>
</parameters>
</method>
<method name="negotiate" c:identifier="gst_video_decoder_negotiate">
<doc xml:space="preserve">Negotiate with downstream elements to currently configured #GstVideoCodecState.
Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
negotiate fails.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if the negotiation succeeded, else #FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="release_frame"
c:identifier="gst_video_decoder_release_frame"
version="1.2.2">
<doc xml:space="preserve">Similar to gst_video_decoder_drop_frame(), but simply releases @frame
without any processing other than removing it from list of pending frames,
after which it is considered finished and released.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="frame" transfer-ownership="full">
<doc xml:space="preserve">the #GstVideoCodecFrame to release</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
</parameters>
</method>
<method name="set_estimate_rate"
c:identifier="gst_video_decoder_set_estimate_rate">
<doc xml:space="preserve">Allows baseclass to perform byte to time estimated conversion.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="enabled" transfer-ownership="none">
<doc xml:space="preserve">whether to enable byte to time conversion</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_latency" c:identifier="gst_video_decoder_set_latency">
<doc xml:space="preserve">Lets #GstVideoDecoder sub-classes tell the baseclass what the decoder
latency is. Will also post a LATENCY message on the bus so the pipeline
can reconfigure its global latency.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="min_latency" transfer-ownership="none">
<doc xml:space="preserve">minimum latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
<parameter name="max_latency" transfer-ownership="none">
<doc xml:space="preserve">maximum latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="set_max_errors"
c:identifier="gst_video_decoder_set_max_errors">
<doc xml:space="preserve">Sets numbers of tolerated decoder errors, where a tolerated one is then only
warned about, but more than tolerated will lead to fatal error. Default
is set to GST_VIDEO_DECODER_MAX_ERRORS.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="dec" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="num" transfer-ownership="none">
<doc xml:space="preserve">max tolerated errors</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_output_state"
c:identifier="gst_video_decoder_set_output_state">
<doc xml:space="preserve">Creates a new #GstVideoCodecState with the specified @fmt, @width and @height
as the output state for the decoder.
Any previously set output state on @decoder will be replaced by the newly
created one.
If the subclass wishes to copy over existing fields (like pixel aspec ratio,
or framerate) from an existing #GstVideoCodecState, it can be provided as a
@reference.
If the subclass wishes to override some fields from the output state (like
pixel-aspect-ratio or framerate) it can do so on the returned #GstVideoCodecState.
The new output state will only take effect (set on pads and buffers) starting
from the next call to #gst_video_decoder_finish_frame().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the newly configured output state.</doc>
<type name="VideoCodecState" c:type="GstVideoCodecState*"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="fmt" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">The width in pixels</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">The height in pixels</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="reference" transfer-ownership="none" allow-none="1">
<doc xml:space="preserve">An optional reference #GstVideoCodecState</doc>
<type name="VideoCodecState" c:type="GstVideoCodecState*"/>
</parameter>
</parameters>
</method>
<method name="set_packetized"
c:identifier="gst_video_decoder_set_packetized">
<doc xml:space="preserve">Allows baseclass to consider input data as packetized or not. If the
input is packetized, then the @parse method will not be called.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</instance-parameter>
<parameter name="packetized" transfer-ownership="none">
<doc xml:space="preserve">whether the input data should be considered as packetized.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<field name="element" readable="0" private="1">
<type name="Gst.Element" c:type="GstElement"/>
</field>
<field name="sinkpad" readable="0" private="1">
<type name="Gst.Pad" c:type="GstPad*"/>
</field>
<field name="srcpad" readable="0" private="1">
<type name="Gst.Pad" c:type="GstPad*"/>
</field>
<field name="stream_lock" readable="0" private="1">
<type name="GLib.RecMutex" c:type="GRecMutex"/>
</field>
<field name="input_segment" readable="0" private="1">
<type name="Gst.Segment" c:type="GstSegment"/>
</field>
<field name="output_segment" readable="0" private="1">
<type name="Gst.Segment" c:type="GstSegment"/>
</field>
<field name="priv" readable="0" private="1">
<type name="VideoDecoderPrivate" c:type="GstVideoDecoderPrivate*"/>
</field>
<field name="padding" readable="0" private="1">
<array zero-terminated="0" c:type="void" fixed-size="20">
<type name="gpointer" c:type="void*"/>
</array>
</field>
</class>
<record name="VideoDecoderClass"
c:type="GstVideoDecoderClass"
glib:is-gtype-struct-for="VideoDecoder">
<doc xml:space="preserve">Subclasses can override any of the available virtual methods or not, as
needed. At minimum @handle_frame needs to be overridden, and @set_format
and likely as well. If non-packetized input is supported or expected,
@parse needs to be overridden as well.</doc>
<field name="element_class" readable="0" private="1">
<type name="Gst.ElementClass" c:type="GstElementClass"/>
</field>
<field name="open">
<callback name="open">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="close">
<callback name="close">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="start">
<callback name="start">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="stop">
<callback name="stop">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="parse">
<callback name="parse">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
<parameter name="frame" transfer-ownership="none">
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
<parameter name="adapter" transfer-ownership="none">
<type name="GstBase.Adapter" c:type="GstAdapter*"/>
</parameter>
<parameter name="at_eos" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_format">
<callback name="set_format">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<type name="VideoCodecState" c:type="GstVideoCodecState*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="reset">
<callback name="reset">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
<parameter name="hard" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="finish">
<callback name="finish">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="handle_frame">
<callback name="handle_frame">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
<parameter name="frame" transfer-ownership="none">
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="sink_event">
<callback name="sink_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="src_event">
<callback name="src_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="negotiate">
<callback name="negotiate">
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if the negotiation succeeded, else #FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoDecoder</doc>
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="decide_allocation">
<callback name="decide_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="propose_allocation">
<callback name="propose_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="flush">
<callback name="flush">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="decoder" transfer-ownership="none">
<type name="VideoDecoder" c:type="GstVideoDecoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="padding" readable="0" private="1">
<array zero-terminated="0" c:type="void" fixed-size="19">
<type name="gpointer" c:type="void*"/>
</array>
</field>
</record>
<record name="VideoDecoderPrivate"
c:type="GstVideoDecoderPrivate"
disguised="1">
</record>
<class name="VideoEncoder"
c:symbol-prefix="video_encoder"
c:type="GstVideoEncoder"
parent="Gst.Element"
abstract="1"
glib:type-name="GstVideoEncoder"
glib:get-type="gst_video_encoder_get_type"
glib:type-struct="VideoEncoderClass">
<doc xml:space="preserve">This base class is for video encoders turning raw video into
encoded video data.
GstVideoEncoder and subclass should cooperate as follows.
<orderedlist>
<listitem>
<itemizedlist><title>Configuration</title>
<listitem><para>
Initially, GstVideoEncoder calls @start when the encoder element
is activated, which allows subclass to perform any global setup.
</para></listitem>
<listitem><para>
GstVideoEncoder calls @set_format to inform subclass of the format
of input video data that it is about to receive. Subclass should
setup for encoding and configure base class as appropriate
(e.g. latency). While unlikely, it might be called more than once,
if changing input parameters require reconfiguration. Baseclass
will ensure that processing of current configuration is finished.
</para></listitem>
<listitem><para>
GstVideoEncoder calls @stop at end of all processing.
</para></listitem>
</itemizedlist>
</listitem>
<listitem>
<itemizedlist>
<title>Data processing</title>
<listitem><para>
Base class collects input data and metadata into a frame and hands
this to subclass' @handle_frame.
</para></listitem>
<listitem><para>
If codec processing results in encoded data, subclass should call
@gst_video_encoder_finish_frame to have encoded data pushed
downstream.
</para></listitem>
<listitem><para>
If implemented, baseclass calls subclass @pre_push just prior to
pushing to allow subclasses to modify some metadata on the buffer.
If it returns GST_FLOW_OK, the buffer is pushed downstream.
</para></listitem>
<listitem><para>
GstVideoEncoderClass will handle both srcpad and sinkpad events.
Sink events will be passed to subclass if @event callback has been
provided.
</para></listitem>
</itemizedlist>
</listitem>
<listitem>
<itemizedlist><title>Shutdown phase</title>
<listitem><para>
GstVideoEncoder class calls @stop to inform the subclass that data
parsing will be stopped.
</para></listitem>
</itemizedlist>
</listitem>
</orderedlist>
Subclass is responsible for providing pad template caps for
source and sink pads. The pads need to be named "sink" and "src". It should
also be able to provide fixed src pad caps in @getcaps by the time it calls
@gst_video_encoder_finish_frame.
Things that subclass need to take care of:
<itemizedlist>
<listitem><para>Provide pad templates</para></listitem>
<listitem><para>
Provide source pad caps before pushing the first buffer
</para></listitem>
<listitem><para>
Accept data in @handle_frame and provide encoded results to
@gst_video_encoder_finish_frame.
</para></listitem>
</itemizedlist></doc>
<implements name="Gst.Preset"/>
<virtual-method name="close">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="decide_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="finish">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="flush">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="getcaps">
<return-value transfer-ownership="full">
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="filter" transfer-ownership="none">
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="handle_frame">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="frame" transfer-ownership="none">
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="negotiate" invoker="negotiate">
<doc xml:space="preserve">Negotiate with downstream elements to currently configured #GstVideoCodecState.
Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
negotiate fails.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if the negotiation succeeded, else #FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="open">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="pre_push">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="frame" transfer-ownership="none">
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="propose_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="reset">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="hard" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_format">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="state" transfer-ownership="none">
<type name="VideoCodecState" c:type="GstVideoCodecState*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="sink_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="src_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="start">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="stop">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="allocate_output_buffer"
c:identifier="gst_video_encoder_allocate_output_buffer">
<doc xml:space="preserve">Helper function that allocates a buffer to hold an encoded video frame
for @encoder's current #GstVideoCodecState.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">allocated buffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="size" transfer-ownership="none">
<doc xml:space="preserve">size of the buffer</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</method>
<method name="allocate_output_frame"
c:identifier="gst_video_encoder_allocate_output_frame">
<doc xml:space="preserve">Helper function that allocates a buffer to hold an encoded video frame for @encoder's
current #GstVideoCodecState. Subclass should already have configured video
state and set src pad caps.
The buffer allocated here is owned by the frame and you should only
keep references to the frame, not the buffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%GST_FLOW_OK if an output buffer could be allocated</doc>
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="frame" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoCodecFrame</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
<parameter name="size" transfer-ownership="none">
<doc xml:space="preserve">size of the buffer</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</method>
<method name="finish_frame"
c:identifier="gst_video_encoder_finish_frame">
<doc xml:space="preserve">@frame must have a valid encoded data buffer, whose metadata fields
are then appropriately set according to frame data or no buffer at
all if the frame should be dropped.
It is subsequently pushed downstream or provided to @pre_push.
In any case, the frame is considered finished and released.
After calling this function the output buffer of the frame is to be
considered read-only. This function will also change the metadata
of the buffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstFlowReturn resulting from sending data downstream</doc>
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="frame" transfer-ownership="full">
<doc xml:space="preserve">an encoded #GstVideoCodecFrame</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
</parameters>
</method>
<method name="get_allocator"
c:identifier="gst_video_encoder_get_allocator">
<doc xml:space="preserve">Lets #GstVideoEncoder sub-classes to know the memory @allocator
used by the base class and its @params.
Unref the @allocator after use it.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="allocator"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:space="preserve">the #GstAllocator
used</doc>
<type name="Gst.Allocator" c:type="GstAllocator**"/>
</parameter>
<parameter name="params"
direction="out"
caller-allocates="1"
transfer-ownership="full"
allow-none="1">
<doc xml:space="preserve">the
#GstAllocatorParams of @allocator</doc>
<type name="Gst.AllocationParams" c:type="GstAllocationParams*"/>
</parameter>
</parameters>
</method>
<method name="get_discont" c:identifier="gst_video_encoder_get_discont">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_frame" c:identifier="gst_video_encoder_get_frame">
<doc xml:space="preserve">Get a pending unfinished #GstVideoCodecFrame</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">pending unfinished #GstVideoCodecFrame identified by @frame_number.</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEnccoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="frame_number" transfer-ownership="none">
<doc xml:space="preserve">system_frame_number of a frame</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="get_frames" c:identifier="gst_video_encoder_get_frames">
<doc xml:space="preserve">Get all pending unfinished #GstVideoCodecFrame</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">pending unfinished #GstVideoCodecFrame.</doc>
<type name="GLib.List" c:type="GList*">
<type name="VideoCodecFrame"/>
</type>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_latency" c:identifier="gst_video_encoder_get_latency">
<doc xml:space="preserve">Query the configured encoding latency. Results will be returned via
@min_latency and @max_latency.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="min_latency"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:space="preserve">address of variable in which to store the
configured minimum latency, or %NULL</doc>
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
<parameter name="max_latency"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:space="preserve">address of variable in which to store the
configured maximum latency, or %NULL</doc>
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
</parameters>
</method>
<method name="get_oldest_frame"
c:identifier="gst_video_encoder_get_oldest_frame">
<doc xml:space="preserve">Get the oldest unfinished pending #GstVideoCodecFrame</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">oldest unfinished pending #GstVideoCodecFrame</doc>
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_output_state"
c:identifier="gst_video_encoder_get_output_state">
<doc xml:space="preserve">Get the current #GstVideoCodecState</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">#GstVideoCodecState describing format of video data.</doc>
<type name="VideoCodecState" c:type="GstVideoCodecState*"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="merge_tags" c:identifier="gst_video_encoder_merge_tags">
<doc xml:space="preserve">Adds tags to so-called pending tags, which will be processed
before pushing out data downstream.
Note that this is provided for convenience, and the subclass is
not required to use this and can still do tag handling on its own.
MT safe.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="tags" transfer-ownership="none">
<doc xml:space="preserve">a #GstTagList to merge</doc>
<type name="Gst.TagList" c:type="const GstTagList*"/>
</parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve">the #GstTagMergeMode to use</doc>
<type name="Gst.TagMergeMode" c:type="GstTagMergeMode"/>
</parameter>
</parameters>
</method>
<method name="negotiate" c:identifier="gst_video_encoder_negotiate">
<doc xml:space="preserve">Negotiate with downstream elements to currently configured #GstVideoCodecState.
Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
negotiate fails.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if the negotiation succeeded, else #FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="proxy_getcaps"
c:identifier="gst_video_encoder_proxy_getcaps">
<doc xml:space="preserve">Returns caps that express @caps (or sink template caps if @caps == NULL)
restricted to resolution/format/... combinations supported by downstream
elements (e.g. muxers).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GstCaps owned by caller</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="caps" transfer-ownership="none">
<doc xml:space="preserve">initial caps</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="filter" transfer-ownership="none">
<doc xml:space="preserve">filter caps</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</method>
<method name="set_discont" c:identifier="gst_video_encoder_set_discont">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_headers" c:identifier="gst_video_encoder_set_headers">
<doc xml:space="preserve">Set the codec headers to be sent downstream whenever requested.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="headers" transfer-ownership="full">
<doc xml:space="preserve">a list of #GstBuffer containing the codec header</doc>
<type name="GLib.List" c:type="GList*">
<type name="Gst.Buffer"/>
</type>
</parameter>
</parameters>
</method>
<method name="set_latency" c:identifier="gst_video_encoder_set_latency">
<doc xml:space="preserve">Informs baseclass of encoding latency.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="min_latency" transfer-ownership="none">
<doc xml:space="preserve">minimum latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
<parameter name="max_latency" transfer-ownership="none">
<doc xml:space="preserve">maximum latency</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
</parameters>
</method>
<method name="set_output_state"
c:identifier="gst_video_encoder_set_output_state">
<doc xml:space="preserve">Creates a new #GstVideoCodecState with the specified caps as the output state
for the encoder.
Any previously set output state on @encoder will be replaced by the newly
created one.
The specified @caps should not contain any resolution, pixel-aspect-ratio,
framerate, codec-data, .... Those should be specified instead in the returned
#GstVideoCodecState.
If the subclass wishes to copy over existing fields (like pixel aspect ratio,
or framerate) from an existing #GstVideoCodecState, it can be provided as a
@reference.
If the subclass wishes to override some fields from the output state (like
pixel-aspect-ratio or framerate) it can do so on the returned #GstVideoCodecState.
The new output state will only take effect (set on pads and buffers) starting
from the next call to #gst_video_encoder_finish_frame().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the newly configured output state.</doc>
<type name="VideoCodecState" c:type="GstVideoCodecState*"/>
</return-value>
<parameters>
<instance-parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</instance-parameter>
<parameter name="caps" transfer-ownership="full">
<doc xml:space="preserve">the #GstCaps to use for the output</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="reference" transfer-ownership="none" allow-none="1">
<doc xml:space="preserve">An optional reference @GstVideoCodecState</doc>
<type name="VideoCodecState" c:type="GstVideoCodecState*"/>
</parameter>
</parameters>
</method>
<field name="element" readable="0" private="1">
<type name="Gst.Element" c:type="GstElement"/>
</field>
<field name="sinkpad" readable="0" private="1">
<type name="Gst.Pad" c:type="GstPad*"/>
</field>
<field name="srcpad" readable="0" private="1">
<type name="Gst.Pad" c:type="GstPad*"/>
</field>
<field name="stream_lock" readable="0" private="1">
<type name="GLib.RecMutex" c:type="GRecMutex"/>
</field>
<field name="input_segment" readable="0" private="1">
<type name="Gst.Segment" c:type="GstSegment"/>
</field>
<field name="output_segment" readable="0" private="1">
<type name="Gst.Segment" c:type="GstSegment"/>
</field>
<field name="priv" readable="0" private="1">
<type name="VideoEncoderPrivate" c:type="GstVideoEncoderPrivate*"/>
</field>
<field name="padding" readable="0" private="1">
<array zero-terminated="0" c:type="void" fixed-size="20">
<type name="gpointer" c:type="void*"/>
</array>
</field>
</class>
<record name="VideoEncoderClass"
c:type="GstVideoEncoderClass"
glib:is-gtype-struct-for="VideoEncoder">
<doc xml:space="preserve">Subclasses can override any of the available virtual methods or not, as
needed. At minimum @handle_frame needs to be overridden, and @set_format
and @get_caps are likely needed as well.</doc>
<field name="element_class" readable="0" private="1">
<type name="Gst.ElementClass" c:type="GstElementClass"/>
</field>
<field name="open">
<callback name="open">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="close">
<callback name="close">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="start">
<callback name="start">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="stop">
<callback name="stop">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_format">
<callback name="set_format">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<type name="VideoCodecState" c:type="GstVideoCodecState*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="handle_frame">
<callback name="handle_frame">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
<parameter name="frame" transfer-ownership="none">
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="reset">
<callback name="reset">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
<parameter name="hard" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="finish">
<callback name="finish">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="pre_push">
<callback name="pre_push">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
<parameter name="frame" transfer-ownership="none">
<type name="VideoCodecFrame" c:type="GstVideoCodecFrame*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="getcaps">
<callback name="getcaps">
<return-value transfer-ownership="full">
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<parameter name="enc" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
<parameter name="filter" transfer-ownership="none">
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="sink_event">
<callback name="sink_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="src_event">
<callback name="src_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
<parameter name="event" transfer-ownership="none">
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="negotiate">
<callback name="negotiate">
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if the negotiation succeeded, else #FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoEncoder</doc>
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="decide_allocation">
<callback name="decide_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="propose_allocation">
<callback name="propose_allocation">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
<parameter name="query" transfer-ownership="none">
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="flush">
<callback name="flush">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="encoder" transfer-ownership="none">
<type name="VideoEncoder" c:type="GstVideoEncoder*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="19">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<record name="VideoEncoderPrivate"
c:type="GstVideoEncoderPrivate"
disguised="1">
</record>
<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:space="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>
<virtual-method name="set_info">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="filter" transfer-ownership="none">
<type name="VideoFilter" c:type="GstVideoFilter*"/>
</instance-parameter>
<parameter name="incaps" transfer-ownership="none">
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="in_info" transfer-ownership="none">
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</parameter>
<parameter name="outcaps" transfer-ownership="none">
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="out_info" transfer-ownership="none">
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="transform_frame">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="filter" transfer-ownership="none">
<type name="VideoFilter" c:type="GstVideoFilter*"/>
</instance-parameter>
<parameter name="inframe" transfer-ownership="none">
<type name="VideoFrame" c:type="GstVideoFrame*"/>
</parameter>
<parameter name="outframe" transfer-ownership="none">
<type name="VideoFrame" c:type="GstVideoFrame*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="transform_frame_ip">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<instance-parameter name="trans" transfer-ownership="none">
<type name="VideoFilter" c:type="GstVideoFilter*"/>
</instance-parameter>
<parameter name="frame" transfer-ownership="none">
<type name="VideoFrame" c:type="GstVideoFrame*"/>
</parameter>
</parameters>
</virtual-method>
<field name="element">
<type name="GstBase.BaseTransform" c:type="GstBaseTransform"/>
</field>
<field name="negotiated">
<type name="gboolean" c:type="gboolean"/>
</field>
<field name="in_info">
<type name="VideoInfo" c:type="GstVideoInfo"/>
</field>
<field name="out_info">
<type name="VideoInfo" c:type="GstVideoInfo"/>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</class>
<record name="VideoFilterClass"
c:type="GstVideoFilterClass"
glib:is-gtype-struct-for="VideoFilter">
<doc xml:space="preserve">The video filter class structure.</doc>
<field name="parent_class">
<doc xml:space="preserve">the parent class structure</doc>
<type name="GstBase.BaseTransformClass"
c:type="GstBaseTransformClass"/>
</field>
<field name="set_info">
<callback name="set_info">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="filter" transfer-ownership="none">
<type name="VideoFilter" c:type="GstVideoFilter*"/>
</parameter>
<parameter name="incaps" transfer-ownership="none">
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="in_info" transfer-ownership="none">
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</parameter>
<parameter name="outcaps" transfer-ownership="none">
<type name="Gst.Caps" c:type="GstCaps*"/>
</parameter>
<parameter name="out_info" transfer-ownership="none">
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="transform_frame">
<callback name="transform_frame">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="filter" transfer-ownership="none">
<type name="VideoFilter" c:type="GstVideoFilter*"/>
</parameter>
<parameter name="inframe" transfer-ownership="none">
<type name="VideoFrame" c:type="GstVideoFrame*"/>
</parameter>
<parameter name="outframe" transfer-ownership="none">
<type name="VideoFrame" c:type="GstVideoFrame*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="transform_frame_ip">
<callback name="transform_frame_ip">
<return-value transfer-ownership="none">
<type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
</return-value>
<parameters>
<parameter name="trans" transfer-ownership="none">
<type name="VideoFilter" c:type="GstVideoFilter*"/>
</parameter>
<parameter name="frame" transfer-ownership="none">
<type name="VideoFrame" c:type="GstVideoFrame*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<bitfield name="VideoFlags"
glib:type-name="GstVideoFlags"
glib:get-type="gst_video_flags_get_type"
c:type="GstVideoFlags">
<doc xml:space="preserve">Extra video flags</doc>
<member name="none"
value="0"
c:identifier="GST_VIDEO_FLAG_NONE"
glib:nick="none">
<doc xml:space="preserve">no flags</doc>
</member>
<member name="variable_fps"
value="1"
c:identifier="GST_VIDEO_FLAG_VARIABLE_FPS"
glib:nick="variable-fps">
<doc xml:space="preserve">a variable fps is selected, fps_n and fps_d
denote the maximum fps of the video</doc>
</member>
<member name="premultiplied_alpha"
value="2"
c:identifier="GST_VIDEO_FLAG_PREMULTIPLIED_ALPHA"
glib:nick="premultiplied-alpha">
<doc xml:space="preserve">Each color has been scaled by the alpha
value.</doc>
</member>
</bitfield>
<enumeration name="VideoFormat"
glib:type-name="GstVideoFormat"
glib:get-type="gst_video_format_get_type"
c:type="GstVideoFormat">
<doc xml:space="preserve">Enum value describing the most common video formats.</doc>
<member name="unknown"
value="0"
c:identifier="GST_VIDEO_FORMAT_UNKNOWN"
glib:nick="unknown">
<doc xml:space="preserve">Unknown or unset video format id</doc>
</member>
<member name="encoded"
value="1"
c:identifier="GST_VIDEO_FORMAT_ENCODED"
glib:nick="encoded">
<doc xml:space="preserve">Encoded video format</doc>
</member>
<member name="i420"
value="2"
c:identifier="GST_VIDEO_FORMAT_I420"
glib:nick="i420">
<doc xml:space="preserve">planar 4:2:0 YUV</doc>
</member>
<member name="yv12"
value="3"
c:identifier="GST_VIDEO_FORMAT_YV12"
glib:nick="yv12">
<doc xml:space="preserve">planar 4:2:0 YVU (like I420 but UV planes swapped)</doc>
</member>
<member name="yuy2"
value="4"
c:identifier="GST_VIDEO_FORMAT_YUY2"
glib:nick="yuy2">
<doc xml:space="preserve">packed 4:2:2 YUV (Y0-U0-Y1-V0 Y2-U2-Y3-V2 Y4 ...)</doc>
</member>
<member name="uyvy"
value="5"
c:identifier="GST_VIDEO_FORMAT_UYVY"
glib:nick="uyvy">
<doc xml:space="preserve">packed 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)</doc>
</member>
<member name="ayuv"
value="6"
c:identifier="GST_VIDEO_FORMAT_AYUV"
glib:nick="ayuv">
<doc xml:space="preserve">packed 4:4:4 YUV with alpha channel (A0-Y0-U0-V0 ...)</doc>
</member>
<member name="rgbx"
value="7"
c:identifier="GST_VIDEO_FORMAT_RGBx"
glib:nick="rgbx">
<doc xml:space="preserve">sparse rgb packed into 32 bit, space last</doc>
</member>
<member name="bgrx"
value="8"
c:identifier="GST_VIDEO_FORMAT_BGRx"
glib:nick="bgrx">
<doc xml:space="preserve">sparse reverse rgb packed into 32 bit, space last</doc>
</member>
<member name="xrgb"
value="9"
c:identifier="GST_VIDEO_FORMAT_xRGB"
glib:nick="xrgb">
<doc xml:space="preserve">sparse rgb packed into 32 bit, space first</doc>
</member>
<member name="xbgr"
value="10"
c:identifier="GST_VIDEO_FORMAT_xBGR"
glib:nick="xbgr">
<doc xml:space="preserve">sparse reverse rgb packed into 32 bit, space first</doc>
</member>
<member name="rgba"
value="11"
c:identifier="GST_VIDEO_FORMAT_RGBA"
glib:nick="rgba">
<doc xml:space="preserve">rgb with alpha channel last</doc>
</member>
<member name="bgra"
value="12"
c:identifier="GST_VIDEO_FORMAT_BGRA"
glib:nick="bgra">
<doc xml:space="preserve">reverse rgb with alpha channel last</doc>
</member>
<member name="argb"
value="13"
c:identifier="GST_VIDEO_FORMAT_ARGB"
glib:nick="argb">
<doc xml:space="preserve">rgb with alpha channel first</doc>
</member>
<member name="abgr"
value="14"
c:identifier="GST_VIDEO_FORMAT_ABGR"
glib:nick="abgr">
<doc xml:space="preserve">reverse rgb with alpha channel first</doc>
</member>
<member name="rgb"
value="15"
c:identifier="GST_VIDEO_FORMAT_RGB"
glib:nick="rgb">
<doc xml:space="preserve">rgb</doc>
</member>
<member name="bgr"
value="16"
c:identifier="GST_VIDEO_FORMAT_BGR"
glib:nick="bgr">
<doc xml:space="preserve">reverse rgb</doc>
</member>
<member name="y41b"
value="17"
c:identifier="GST_VIDEO_FORMAT_Y41B"
glib:nick="y41b">
<doc xml:space="preserve">planar 4:1:1 YUV</doc>
</member>
<member name="y42b"
value="18"
c:identifier="GST_VIDEO_FORMAT_Y42B"
glib:nick="y42b">
<doc xml:space="preserve">planar 4:2:2 YUV</doc>
</member>
<member name="yvyu"
value="19"
c:identifier="GST_VIDEO_FORMAT_YVYU"
glib:nick="yvyu">
<doc xml:space="preserve">packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...)</doc>
</member>
<member name="y444"
value="20"
c:identifier="GST_VIDEO_FORMAT_Y444"
glib:nick="y444">
<doc xml:space="preserve">planar 4:4:4 YUV</doc>
</member>
<member name="v210"
value="21"
c:identifier="GST_VIDEO_FORMAT_v210"
glib:nick="v210">
<doc xml:space="preserve">packed 4:2:2 10-bit YUV, complex format</doc>
</member>
<member name="v216"
value="22"
c:identifier="GST_VIDEO_FORMAT_v216"
glib:nick="v216">
<doc xml:space="preserve">packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order</doc>
</member>
<member name="nv12"
value="23"
c:identifier="GST_VIDEO_FORMAT_NV12"
glib:nick="nv12">
<doc xml:space="preserve">planar 4:2:0 YUV with interleaved UV plane</doc>
</member>
<member name="nv21"
value="24"
c:identifier="GST_VIDEO_FORMAT_NV21"
glib:nick="nv21">
<doc xml:space="preserve">planar 4:2:0 YUV with interleaved VU plane</doc>
</member>
<member name="gray8"
value="25"
c:identifier="GST_VIDEO_FORMAT_GRAY8"
glib:nick="gray8">
<doc xml:space="preserve">8-bit grayscale</doc>
</member>
<member name="gray16_be"
value="26"
c:identifier="GST_VIDEO_FORMAT_GRAY16_BE"
glib:nick="gray16-be">
<doc xml:space="preserve">16-bit grayscale, most significant byte first</doc>
</member>
<member name="gray16_le"
value="27"
c:identifier="GST_VIDEO_FORMAT_GRAY16_LE"
glib:nick="gray16-le">
<doc xml:space="preserve">16-bit grayscale, least significant byte first</doc>
</member>
<member name="v308"
value="28"
c:identifier="GST_VIDEO_FORMAT_v308"
glib:nick="v308">
<doc xml:space="preserve">packed 4:4:4 YUV</doc>
</member>
<member name="rgb16"
value="29"
c:identifier="GST_VIDEO_FORMAT_RGB16"
glib:nick="rgb16">
<doc xml:space="preserve">rgb 5-6-5 bits per component</doc>
</member>
<member name="bgr16"
value="30"
c:identifier="GST_VIDEO_FORMAT_BGR16"
glib:nick="bgr16">
<doc xml:space="preserve">reverse rgb 5-6-5 bits per component</doc>
</member>
<member name="rgb15"
value="31"
c:identifier="GST_VIDEO_FORMAT_RGB15"
glib:nick="rgb15">
<doc xml:space="preserve">rgb 5-5-5 bits per component</doc>
</member>
<member name="bgr15"
value="32"
c:identifier="GST_VIDEO_FORMAT_BGR15"
glib:nick="bgr15">
<doc xml:space="preserve">reverse rgb 5-5-5 bits per component</doc>
</member>
<member name="uyvp"
value="33"
c:identifier="GST_VIDEO_FORMAT_UYVP"
glib:nick="uyvp">
<doc xml:space="preserve">packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)</doc>
</member>
<member name="a420"
value="34"
c:identifier="GST_VIDEO_FORMAT_A420"
glib:nick="a420">
<doc xml:space="preserve">planar 4:4:2:0 AYUV</doc>
</member>
<member name="rgb8p"
value="35"
c:identifier="GST_VIDEO_FORMAT_RGB8P"
glib:nick="rgb8p">
<doc xml:space="preserve">8-bit paletted RGB</doc>
</member>
<member name="yuv9"
value="36"
c:identifier="GST_VIDEO_FORMAT_YUV9"
glib:nick="yuv9">
<doc xml:space="preserve">planar 4:1:0 YUV</doc>
</member>
<member name="yvu9"
value="37"
c:identifier="GST_VIDEO_FORMAT_YVU9"
glib:nick="yvu9">
<doc xml:space="preserve">planar 4:1:0 YUV (like YUV9 but UV planes swapped)</doc>
</member>
<member name="iyu1"
value="38"
c:identifier="GST_VIDEO_FORMAT_IYU1"
glib:nick="iyu1">
<doc xml:space="preserve">packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...)</doc>
</member>
<member name="argb64"
value="39"
c:identifier="GST_VIDEO_FORMAT_ARGB64"
glib:nick="argb64">
<doc xml:space="preserve">rgb with alpha channel first, 16 bits per channel</doc>
</member>
<member name="ayuv64"
value="40"
c:identifier="GST_VIDEO_FORMAT_AYUV64"
glib:nick="ayuv64">
<doc xml:space="preserve">packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...)</doc>
</member>
<member name="r210"
value="41"
c:identifier="GST_VIDEO_FORMAT_r210"
glib:nick="r210">
<doc xml:space="preserve">packed 4:4:4 RGB, 10 bits per channel</doc>
</member>
<member name="i420_10be"
value="42"
c:identifier="GST_VIDEO_FORMAT_I420_10BE"
glib:nick="i420-10be">
<doc xml:space="preserve">planar 4:2:0 YUV, 10 bits per channel</doc>
</member>
<member name="i420_10le"
value="43"
c:identifier="GST_VIDEO_FORMAT_I420_10LE"
glib:nick="i420-10le">
<doc xml:space="preserve">planar 4:2:0 YUV, 10 bits per channel</doc>
</member>
<member name="i422_10be"
value="44"
c:identifier="GST_VIDEO_FORMAT_I422_10BE"
glib:nick="i422-10be">
<doc xml:space="preserve">planar 4:2:2 YUV, 10 bits per channel</doc>
</member>
<member name="i422_10le"
value="45"
c:identifier="GST_VIDEO_FORMAT_I422_10LE"
glib:nick="i422-10le">
<doc xml:space="preserve">planar 4:2:2 YUV, 10 bits per channel</doc>
</member>
<member name="y444_10be"
value="46"
c:identifier="GST_VIDEO_FORMAT_Y444_10BE"
glib:nick="y444-10be">
<doc xml:space="preserve">planar 4:4:4 YUV, 10 bits per channel</doc>
</member>
<member name="y444_10le"
value="47"
c:identifier="GST_VIDEO_FORMAT_Y444_10LE"
glib:nick="y444-10le">
<doc xml:space="preserve">planar 4:4:4 YUV, 10 bits per channel</doc>
</member>
<member name="gbr"
value="48"
c:identifier="GST_VIDEO_FORMAT_GBR"
glib:nick="gbr">
<doc xml:space="preserve">planar 4:4:4 RGB, 8 bits per channel</doc>
</member>
<member name="gbr_10be"
value="49"
c:identifier="GST_VIDEO_FORMAT_GBR_10BE"
glib:nick="gbr-10be">
<doc xml:space="preserve">planar 4:4:4 RGB, 10 bits per channel</doc>
</member>
<member name="gbr_10le"
value="50"
c:identifier="GST_VIDEO_FORMAT_GBR_10LE"
glib:nick="gbr-10le">
<doc xml:space="preserve">planar 4:4:4 RGB, 10 bits per channel</doc>
</member>
<member name="nv16"
value="51"
c:identifier="GST_VIDEO_FORMAT_NV16"
glib:nick="nv16">
<doc xml:space="preserve">planar 4:2:2 YUV with interleaved UV plane</doc>
</member>
<member name="nv24"
value="52"
c:identifier="GST_VIDEO_FORMAT_NV24"
glib:nick="nv24">
<doc xml:space="preserve">planar 4:4:4 YUV with interleaved UV plane</doc>
</member>
<function name="from_fourcc" c:identifier="gst_video_format_from_fourcc">
<doc xml:space="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:space="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:space="preserve">a FOURCC value representing raw YUV video</doc>
<type name="guint32" c:type="guint32"/>
</parameter>
</parameters>
</function>
<function name="from_masks" c:identifier="gst_video_format_from_masks">
<doc xml:space="preserve">Find the #GstVideoFormat for the given parameters.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFormat or GST_VIDEO_FORMAT_UNKNOWN when the parameters to
not specify a known format.</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</return-value>
<parameters>
<parameter name="depth" transfer-ownership="none">
<doc xml:space="preserve">the amount of bits used for a pixel</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="bpp" transfer-ownership="none">
<doc xml:space="preserve">the amount of bits used to store a pixel. This value is bigger than
@depth</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="endianness" transfer-ownership="none">
<doc xml:space="preserve">the endianness of the masks, #G_LITTLE_ENDIAN or #G_BIG_ENDIAN</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="red_mask" transfer-ownership="none">
<doc xml:space="preserve">the red mask</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="green_mask" transfer-ownership="none">
<doc xml:space="preserve">the green mask</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="blue_mask" transfer-ownership="none">
<doc xml:space="preserve">the blue mask</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="alpha_mask" transfer-ownership="none">
<doc xml:space="preserve">the alpha mask, or 0 if no alpha mask</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="from_string" c:identifier="gst_video_format_from_string">
<doc xml:space="preserve">Convert the @format string to its #GstVideoFormat.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #GstVideoFormat for @format or GST_VIDEO_FORMAT_UNKNOWN when the
string is not a known format.</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a format string</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="get_info" c:identifier="gst_video_format_get_info">
<doc xml:space="preserve">Get the #GstVideoFormatInfo for @format</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The #GstVideoFormatInfo for @format.</doc>
<type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="get_palette"
c:identifier="gst_video_format_get_palette"
version="1.2"
introspectable="0">
<doc xml:space="preserve">Get the default palette of @format. This the palette used in the pack
function for paletted formats.</doc>
<return-value>
<doc xml:space="preserve">the default palette of @format or %NULL when @format does not have a
palette.</doc>
<type name="gpointer" c:type="gconstpointer"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="size"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">size of the palette in bytes</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
</parameters>
</function>
<function name="to_fourcc" c:identifier="gst_video_format_to_fourcc">
<doc xml:space="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:space="preserve">the FOURCC corresponding to @format</doc>
<type name="guint32" c:type="guint32"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFormat video format</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="to_string" c:identifier="gst_video_format_to_string">
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
</enumeration>
<bitfield name="VideoFormatFlags"
glib:type-name="GstVideoFormatFlags"
glib:get-type="gst_video_format_flags_get_type"
c:type="GstVideoFormatFlags">
<doc xml:space="preserve">The different video flags that a format info can have.</doc>
<member name="yuv"
value="1"
c:identifier="GST_VIDEO_FORMAT_FLAG_YUV"
glib:nick="yuv">
<doc xml:space="preserve">The video format is YUV, components are numbered
0=Y, 1=U, 2=V.</doc>
</member>
<member name="rgb"
value="2"
c:identifier="GST_VIDEO_FORMAT_FLAG_RGB"
glib:nick="rgb">
<doc xml:space="preserve">The video format is RGB, components are numbered
0=R, 1=G, 2=B.</doc>
</member>
<member name="gray"
value="4"
c:identifier="GST_VIDEO_FORMAT_FLAG_GRAY"
glib:nick="gray">
<doc xml:space="preserve">The video is gray, there is one gray component
with index 0.</doc>
</member>
<member name="alpha"
value="8"
c:identifier="GST_VIDEO_FORMAT_FLAG_ALPHA"
glib:nick="alpha">
<doc xml:space="preserve">The video format has an alpha components with
the number 3.</doc>
</member>
<member name="le"
value="16"
c:identifier="GST_VIDEO_FORMAT_FLAG_LE"
glib:nick="le">
<doc xml:space="preserve">The video format has data stored in little
endianness.</doc>
</member>
<member name="palette"
value="32"
c:identifier="GST_VIDEO_FORMAT_FLAG_PALETTE"
glib:nick="palette">
<doc xml:space="preserve">The video format has a palette. The palette
is stored in the second plane and indexes are stored in the first plane.</doc>
</member>
<member name="complex"
value="64"
c:identifier="GST_VIDEO_FORMAT_FLAG_COMPLEX"
glib:nick="complex">
<doc xml:space="preserve">The video format has a complex layout that
can't be described with the usual information in the #GstVideoFormatInfo.</doc>
</member>
<member name="unpack"
value="128"
c:identifier="GST_VIDEO_FORMAT_FLAG_UNPACK"
glib:nick="unpack">
<doc xml:space="preserve">This format can be used in a
#GstVideoFormatUnpack and #GstVideoFormatPack function.</doc>
</member>
</bitfield>
<record name="VideoFormatInfo" c:type="GstVideoFormatInfo">
<doc xml:space="preserve">Information for a video format.</doc>
<field name="format" writable="1">
<doc xml:space="preserve">#GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</field>
<field name="name" writable="1">
<doc xml:space="preserve">string representation of the format</doc>
<type name="utf8" c:type="const gchar*"/>
</field>
<field name="description" writable="1">
<doc xml:space="preserve">use readable description of the format</doc>
<type name="utf8" c:type="const gchar*"/>
</field>
<field name="flags" writable="1">
<doc xml:space="preserve">#GstVideoFormatFlags</doc>
<type name="VideoFormatFlags" c:type="GstVideoFormatFlags"/>
</field>
<field name="bits" writable="1">
<doc xml:space="preserve">The number of bits used to pack data items. This can be less than 8
when multiple pixels are stored in a byte. for values > 8 multiple bytes
should be read according to the endianness flag before applying the shift
and mask.</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="n_components" writable="1">
<doc xml:space="preserve">the number of components in the video format.</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="shift" writable="1">
<doc xml:space="preserve">the number of bits to shift away to get the component data</doc>
<array zero-terminated="0" c:type="guint" fixed-size="4">
<type name="guint" c:type="guint"/>
</array>
</field>
<field name="depth" writable="1">
<doc xml:space="preserve">the depth in bits for each component</doc>
<array zero-terminated="0" c:type="guint" fixed-size="4">
<type name="guint" c:type="guint"/>
</array>
</field>
<field name="pixel_stride" writable="1">
<doc xml:space="preserve">the pixel stride of each component. This is the amount of
bytes to the pixel immediately to the right. When bits < 8, the stride is
expressed in bits. For 24-bit RGB, this would be 3 bytes, for example,
while it would be 4 bytes for RGBx or ARGB.</doc>
<array zero-terminated="0" c:type="gint" fixed-size="4">
<type name="gint" c:type="gint"/>
</array>
</field>
<field name="n_planes" writable="1">
<doc xml:space="preserve">the number of planes for this format. The number of planes can be
less than the amount of components when multiple components are packed into
one plane.</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="plane" writable="1">
<doc xml:space="preserve">the plane number where a component can be found</doc>
<array zero-terminated="0" c:type="guint" fixed-size="4">
<type name="guint" c:type="guint"/>
</array>
</field>
<field name="poffset" writable="1">
<doc xml:space="preserve">the offset in the plane where the first pixel of the components
can be found.</doc>
<array zero-terminated="0" c:type="guint" fixed-size="4">
<type name="guint" c:type="guint"/>
</array>
</field>
<field name="w_sub" writable="1">
<doc xml:space="preserve">subsampling factor of the width for the component. Use
GST_VIDEO_SUB_SCALE to scale a width.</doc>
<array zero-terminated="0" c:type="guint" fixed-size="4">
<type name="guint" c:type="guint"/>
</array>
</field>
<field name="h_sub" writable="1">
<doc xml:space="preserve">subsampling factor of the height for the component. Use
GST_VIDEO_SUB_SCALE to scale a height.</doc>
<array zero-terminated="0" c:type="guint" fixed-size="4">
<type name="guint" c:type="guint"/>
</array>
</field>
<field name="unpack_format" writable="1">
<doc xml:space="preserve">the format of the unpacked pixels. This format must have the
#GST_VIDEO_FORMAT_FLAG_UNPACK flag set.</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</field>
<field name="unpack_func" writable="1">
<doc xml:space="preserve">an unpack function for this format</doc>
<type name="VideoFormatUnpack" c:type="GstVideoFormatUnpack"/>
</field>
<field name="pack_lines" writable="1">
<doc xml:space="preserve">the amount of lines that will be packed</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="pack_func" writable="1">
<doc xml:space="preserve">an pack function for this format</doc>
<type name="VideoFormatPack" c:type="GstVideoFormatPack"/>
</field>
<field name="_gst_reserved" writable="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<callback name="VideoFormatPack" c:type="GstVideoFormatPack">
<doc xml:space="preserve">Packs @width pixels from @src to the given planes and strides in the
format @info. The pixels from source have each component interleaved
and will be packed into the planes in @data.
This function operates on pack_lines lines, meaning that @src should
contain at least pack_lines lines with a stride of @sstride and @y
should be a multiple of pack_lines.
Subsampled formats will use the horizontally cosited component in the
destination. Subsampling should be performed before packing.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFormatInfo</doc>
<type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">flags to control the packing</doc>
<type name="VideoPackFlags" c:type="GstVideoPackFlags"/>
</parameter>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a source array</doc>
<type name="gpointer" c:type="const gpointer"/>
</parameter>
<parameter name="sstride" transfer-ownership="none">
<doc xml:space="preserve">the source array stride</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">pointers to the destination data planes</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="stride" transfer-ownership="none">
<doc xml:space="preserve">strides of the destination planes</doc>
<type name="gint" c:type="const gint"/>
</parameter>
<parameter name="chroma_site" transfer-ownership="none">
<doc xml:space="preserve">the chroma siting of the target when subsampled (not used)</doc>
<type name="VideoChromaSite" c:type="GstVideoChromaSite"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">the y position in the image to pack to</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">the amount of pixels to pack.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
<callback name="VideoFormatUnpack" c:type="GstVideoFormatUnpack">
<doc xml:space="preserve">Unpacks @width pixels from the given planes and strides containing data of
format @info. The pixels will be unpacked into @dest which each component
interleaved. @dest should at least be big enough to hold @width *
n_components * size(unpack_format) bytes.
For subsampled formats, the components will be duplicated in the destination
array. Reconstruction of the missing components can be performed in a
separate step after unpacking.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFormatInfo</doc>
<type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">flags to control the unpacking</doc>
<type name="VideoPackFlags" c:type="GstVideoPackFlags"/>
</parameter>
<parameter name="dest" transfer-ownership="none">
<doc xml:space="preserve">a destination array</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">pointers to the data planes</doc>
<type name="gpointer" c:type="const gpointer"/>
</parameter>
<parameter name="stride" transfer-ownership="none">
<doc xml:space="preserve">strides of the planes</doc>
<type name="gint" c:type="const gint"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">the x position in the image to start from</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">the y position in the image to start from</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">the amount of pixels to unpack.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
<record name="VideoFrame" c:type="GstVideoFrame">
<doc xml:space="preserve">A video frame obtained from gst_video_frame_map()</doc>
<field name="info" writable="1">
<doc xml:space="preserve">the #GstVideoInfo</doc>
<type name="VideoInfo" c:type="GstVideoInfo"/>
</field>
<field name="flags" writable="1">
<type name="VideoFrameFlags" c:type="GstVideoFrameFlags"/>
</field>
<field name="buffer" writable="1">
<doc xml:space="preserve">the mapped buffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</field>
<field name="meta" writable="1">
<doc xml:space="preserve">pointer to metadata if any</doc>
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="id" writable="1">
<doc xml:space="preserve">id of the mapped frame. the id can for example be used to
indentify the frame in case of multiview video.</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="data" writable="1">
<doc xml:space="preserve">pointers to the plane data</doc>
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
<field name="map" writable="1">
<doc xml:space="preserve">mappings of the planes</doc>
<array zero-terminated="0" c:type="GstMapInfo" fixed-size="4">
<type name="Gst.MapInfo" c:type="GstMapInfo"/>
</array>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
<method name="copy" c:identifier="gst_video_frame_copy">
<doc xml:space="preserve">Copy the contents from @src to @dest.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the contents could be copied.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dest" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFrame</doc>
<type name="VideoFrame" c:type="GstVideoFrame*"/>
</instance-parameter>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFrame</doc>
<type name="VideoFrame" c:type="const GstVideoFrame*"/>
</parameter>
</parameters>
</method>
<method name="copy_plane" c:identifier="gst_video_frame_copy_plane">
<doc xml:space="preserve">Copy the plane with index @plane from @src to @dest.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the contents could be copied.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="dest" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFrame</doc>
<type name="VideoFrame" c:type="GstVideoFrame*"/>
</instance-parameter>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFrame</doc>
<type name="VideoFrame" c:type="const GstVideoFrame*"/>
</parameter>
<parameter name="plane" transfer-ownership="none">
<doc xml:space="preserve">a plane</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="map" c:identifier="gst_video_frame_map">
<doc xml:space="preserve">Use @info and @buffer to fill in the values of @frame.
All video planes of @buffer will be mapped and the pointers will be set in
@frame->data.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="frame" transfer-ownership="none">
<doc xml:space="preserve">pointer to #GstVideoFrame</doc>
<type name="VideoFrame" c:type="GstVideoFrame*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoInfo</doc>
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">the buffer to map</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">#GstMapFlags</doc>
<type name="Gst.MapFlags" c:type="GstMapFlags"/>
</parameter>
</parameters>
</method>
<method name="map_id" c:identifier="gst_video_frame_map_id">
<doc xml:space="preserve">Use @info and @buffer to fill in the values of @frame with the video frame
information of frame @id.
When @id is -1, the default frame is mapped. When @id != -1, this function
will return %FALSE when there is no GstVideoMeta with that id.
All video planes of @buffer will be mapped and the pointers will be set in
@frame->data.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="frame" transfer-ownership="none">
<doc xml:space="preserve">pointer to #GstVideoFrame</doc>
<type name="VideoFrame" c:type="GstVideoFrame*"/>
</instance-parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoInfo</doc>
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">the buffer to map</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve">the frame id to map</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">#GstMapFlags</doc>
<type name="Gst.MapFlags" c:type="GstMapFlags"/>
</parameter>
</parameters>
</method>
<method name="unmap" c:identifier="gst_video_frame_unmap">
<doc xml:space="preserve">Unmap the memory previously mapped with gst_video_frame_map.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="frame" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFrame</doc>
<type name="VideoFrame" c:type="GstVideoFrame*"/>
</instance-parameter>
</parameters>
</method>
</record>
<bitfield name="VideoFrameFlags" c:type="GstVideoFrameFlags">
<doc xml:space="preserve">Extra video frame flags</doc>
<member name="none" value="0" c:identifier="GST_VIDEO_FRAME_FLAG_NONE">
<doc xml:space="preserve">no flags</doc>
</member>
<member name="interlaced"
value="1"
c:identifier="GST_VIDEO_FRAME_FLAG_INTERLACED">
<doc xml:space="preserve">The video frame is interlaced. In mixed
interlace-mode, this flags specifies if the frame is interlace or
progressive.</doc>
</member>
<member name="tff" value="2" c:identifier="GST_VIDEO_FRAME_FLAG_TFF">
<doc xml:space="preserve">The video frame has the top field first</doc>
</member>
<member name="rff" value="4" c:identifier="GST_VIDEO_FRAME_FLAG_RFF">
<doc xml:space="preserve">The video frame has the repeat flag</doc>
</member>
<member name="onefield"
value="8"
c:identifier="GST_VIDEO_FRAME_FLAG_ONEFIELD">
<doc xml:space="preserve">The video frame has one field</doc>
</member>
</bitfield>
<enumeration name="VideoGLTextureOrientation"
c:type="GstVideoGLTextureOrientation">
<doc xml:space="preserve">The orientation of the GL texture.</doc>
<member name="normal_y_normal"
value="0"
c:identifier="GST_VIDEO_GL_TEXTURE_ORIENTATION_X_NORMAL_Y_NORMAL">
<doc xml:space="preserve">Top line first in memory, left row first</doc>
</member>
<member name="normal_y_flip"
value="1"
c:identifier="GST_VIDEO_GL_TEXTURE_ORIENTATION_X_NORMAL_Y_FLIP">
<doc xml:space="preserve">Bottom line first in memory, left row first</doc>
</member>
<member name="flip_y_normal"
value="2"
c:identifier="GST_VIDEO_GL_TEXTURE_ORIENTATION_X_FLIP_Y_NORMAL">
<doc xml:space="preserve">Top line first in memory, right row first</doc>
</member>
<member name="flip_y_flip"
value="3"
c:identifier="GST_VIDEO_GL_TEXTURE_ORIENTATION_X_FLIP_Y_FLIP">
<doc xml:space="preserve">Bottom line first in memory, right row first</doc>
</member>
</enumeration>
<enumeration name="VideoGLTextureType" c:type="GstVideoGLTextureType">
<doc xml:space="preserve">The GL texture type.</doc>
<member name="luminance"
value="0"
c:identifier="GST_VIDEO_GL_TEXTURE_TYPE_LUMINANCE">
<doc xml:space="preserve">Luminance texture, GL_LUMINANCE</doc>
</member>
<member name="luminance_alpha"
value="1"
c:identifier="GST_VIDEO_GL_TEXTURE_TYPE_LUMINANCE_ALPHA">
<doc xml:space="preserve">Luminance-alpha texture, GL_LUMINANCE_ALPHA</doc>
</member>
<member name="rgb16"
value="2"
c:identifier="GST_VIDEO_GL_TEXTURE_TYPE_RGB16">
<doc xml:space="preserve">RGB 565 texture, GL_RGB</doc>
</member>
<member name="rgb"
value="3"
c:identifier="GST_VIDEO_GL_TEXTURE_TYPE_RGB">
<doc xml:space="preserve">RGB texture, GL_RGB</doc>
</member>
<member name="rgba"
value="4"
c:identifier="GST_VIDEO_GL_TEXTURE_TYPE_RGBA">
<doc xml:space="preserve">RGBA texture, GL_RGBA</doc>
</member>
<member name="r" value="5" c:identifier="GST_VIDEO_GL_TEXTURE_TYPE_R">
<doc xml:space="preserve">R texture, GL_RED_EXT</doc>
</member>
<member name="rg" value="6" c:identifier="GST_VIDEO_GL_TEXTURE_TYPE_RG">
<doc xml:space="preserve">RG texture, GL_RG_EXT</doc>
</member>
</enumeration>
<callback name="VideoGLTextureUpload" c:type="GstVideoGLTextureUpload">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="meta" transfer-ownership="none">
<type name="VideoGLTextureUploadMeta"
c:type="GstVideoGLTextureUploadMeta*"/>
</parameter>
<parameter name="texture_id" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</callback>
<record name="VideoGLTextureUploadMeta"
c:type="GstVideoGLTextureUploadMeta">
<doc xml:space="preserve">Extra buffer metadata for uploading a buffer to an OpenGL texture
ID. The caller of gst_video_gl_texture_upload_meta_upload() must
have OpenGL set up and call this from a thread where it is valid
to upload something to an OpenGL texture.</doc>
<field name="meta" writable="1">
<doc xml:space="preserve">parent #GstMeta</doc>
<type name="Gst.Meta" c:type="GstMeta"/>
</field>
<field name="texture_orientation" writable="1">
<doc xml:space="preserve">Orientation of the textures</doc>
<type name="VideoGLTextureOrientation"
c:type="GstVideoGLTextureOrientation"/>
</field>
<field name="n_textures" writable="1">
<doc xml:space="preserve">Number of textures that are generated</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="texture_type" writable="1">
<doc xml:space="preserve">Type of each texture</doc>
<array zero-terminated="0"
c:type="GstVideoGLTextureType"
fixed-size="4">
<type name="VideoGLTextureType" c:type="GstVideoGLTextureType"/>
</array>
</field>
<field name="buffer" readable="0" private="1">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</field>
<field name="upload" readable="0" private="1">
<type name="VideoGLTextureUpload" c:type="GstVideoGLTextureUpload"/>
</field>
<field name="user_data" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="user_data_copy" introspectable="0" readable="0" private="1">
<type name="GObject.BoxedCopyFunc" c:type="GBoxedCopyFunc"/>
</field>
<field name="user_data_free" readable="0" private="1">
<type name="GObject.BoxedFreeFunc" c:type="GBoxedFreeFunc"/>
</field>
<method name="upload"
c:identifier="gst_video_gl_texture_upload_meta_upload">
<doc xml:space="preserve">Uploads the buffer which owns the meta to a specific texture ID.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if uploading succeeded, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="meta" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoGLTextureUploadMeta</doc>
<type name="VideoGLTextureUploadMeta"
c:type="GstVideoGLTextureUploadMeta*"/>
</instance-parameter>
<parameter name="texture_id" transfer-ownership="none">
<doc xml:space="preserve">the texture IDs to upload to</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<function name="get_info"
c:identifier="gst_video_gl_texture_upload_meta_get_info">
<return-value transfer-ownership="none">
<type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
</return-value>
</function>
</record>
<record name="VideoInfo" c:type="GstVideoInfo">
<doc xml:space="preserve">Information describing image properties. This information can be filled
in from GstCaps with gst_video_info_from_caps(). The information is also used
to store the specific video info when mapping a video frame with
gst_video_frame_map().
Use the provided macros to access the info in this structure.</doc>
<field name="finfo" writable="1">
<doc xml:space="preserve">the format info of the video</doc>
<type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
</field>
<field name="interlace_mode" writable="1">
<doc xml:space="preserve">the interlace mode</doc>
<type name="VideoInterlaceMode" c:type="GstVideoInterlaceMode"/>
</field>
<field name="flags" writable="1">
<doc xml:space="preserve">additional video flags</doc>
<type name="VideoFlags" c:type="GstVideoFlags"/>
</field>
<field name="width" writable="1">
<doc xml:space="preserve">the width of the video</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="height" writable="1">
<doc xml:space="preserve">the height of the video</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="size" writable="1">
<doc xml:space="preserve">the default size of one frame</doc>
<type name="gsize" c:type="gsize"/>
</field>
<field name="views" writable="1">
<doc xml:space="preserve">the number of views for multiview video</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="chroma_site" writable="1">
<doc xml:space="preserve">a #GstVideoChromaSite.</doc>
<type name="VideoChromaSite" c:type="GstVideoChromaSite"/>
</field>
<field name="colorimetry" writable="1">
<doc xml:space="preserve">the colorimetry info</doc>
<type name="VideoColorimetry" c:type="GstVideoColorimetry"/>
</field>
<field name="par_n" writable="1">
<doc xml:space="preserve">the pixel-aspect-ratio numerator</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="par_d" writable="1">
<doc xml:space="preserve">the pixel-aspect-ratio demnominator</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="fps_n" writable="1">
<doc xml:space="preserve">the framerate numerator</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="fps_d" writable="1">
<doc xml:space="preserve">the framerate demnominator</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="offset" writable="1">
<doc xml:space="preserve">offsets of the planes</doc>
<array zero-terminated="0" c:type="gsize" fixed-size="4">
<type name="gsize" c:type="gsize"/>
</array>
</field>
<field name="stride" writable="1">
<doc xml:space="preserve">strides of the planes</doc>
<array zero-terminated="0" c:type="gint" fixed-size="4">
<type name="gint" c:type="gint"/>
</array>
</field>
<field name="_gst_reserved" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
<method name="align" c:identifier="gst_video_info_align">
<doc xml:space="preserve">Adjust the offset and stride fields in @info so that the padding and
stride alignment in @align is respected.
Extra padding will be added to the right side when stride alignment padding
is required and @align will be updated with the new padding values.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoInfo</doc>
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</instance-parameter>
<parameter name="align" transfer-ownership="none">
<doc xml:space="preserve">alignment parameters</doc>
<type name="VideoAlignment" c:type="GstVideoAlignment*"/>
</parameter>
</parameters>
</method>
<method name="convert" c:identifier="gst_video_info_convert">
<doc xml:space="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 used to handle pad queries of the type GST_QUERY_CONVERT.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the conversion was successful.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoInfo</doc>
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</instance-parameter>
<parameter name="src_format" transfer-ownership="none">
<doc xml:space="preserve">#GstFormat of the @src_value</doc>
<type name="Gst.Format" c:type="GstFormat"/>
</parameter>
<parameter name="src_value" transfer-ownership="none">
<doc xml:space="preserve">value to convert</doc>
<type name="gint64" c:type="gint64"/>
</parameter>
<parameter name="dest_format" transfer-ownership="none">
<doc xml:space="preserve">#GstFormat of the @dest_value</doc>
<type name="Gst.Format" c:type="GstFormat"/>
</parameter>
<parameter name="dest_value" transfer-ownership="none">
<doc xml:space="preserve">pointer to destination value</doc>
<type name="gint64" c:type="gint64*"/>
</parameter>
</parameters>
</method>
<method name="from_caps" c:identifier="gst_video_info_from_caps">
<doc xml:space="preserve">Parse @caps and update @info.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if @caps could be parsed</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoInfo</doc>
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</instance-parameter>
<parameter name="caps" transfer-ownership="none">
<doc xml:space="preserve">a #GstCaps</doc>
<type name="Gst.Caps" c:type="const GstCaps*"/>
</parameter>
</parameters>
</method>
<method name="init" c:identifier="gst_video_info_init">
<doc xml:space="preserve">Initialize @info with default values.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoInfo</doc>
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_equal" c:identifier="gst_video_info_is_equal">
<doc xml:space="preserve">Compares two #GstVideoInfo and returns whether they are equal or not</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @info and @other are equal, else %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoInfo</doc>
<type name="VideoInfo" c:type="const GstVideoInfo*"/>
</instance-parameter>
<parameter name="other" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoInfo</doc>
<type name="VideoInfo" c:type="const GstVideoInfo*"/>
</parameter>
</parameters>
</method>
<method name="set_format" c:identifier="gst_video_info_set_format">
<doc xml:space="preserve">Set the default info for a video frame of @format and @width and @height.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoInfo</doc>
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</instance-parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">the format</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">a width</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">a height</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="to_caps" c:identifier="gst_video_info_to_caps">
<doc xml:space="preserve">Convert the values of @info into a #GstCaps.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GstCaps containing the info of @info.</doc>
<type name="Gst.Caps" c:type="GstCaps*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoInfo</doc>
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</instance-parameter>
</parameters>
</method>
</record>
<enumeration name="VideoInterlaceMode"
glib:type-name="GstVideoInterlaceMode"
glib:get-type="gst_video_interlace_mode_get_type"
c:type="GstVideoInterlaceMode">
<doc xml:space="preserve">The possible values of the #GstVideoInterlaceMode describing the interlace
mode of the stream.</doc>
<member name="progressive"
value="0"
c:identifier="GST_VIDEO_INTERLACE_MODE_PROGRESSIVE"
glib:nick="progressive">
<doc xml:space="preserve">all frames are progressive</doc>
</member>
<member name="interleaved"
value="1"
c:identifier="GST_VIDEO_INTERLACE_MODE_INTERLEAVED"
glib:nick="interleaved">
<doc xml:space="preserve">2 fields are interleaved in one video
frame. Extra buffer flags describe the field order.</doc>
</member>
<member name="mixed"
value="2"
c:identifier="GST_VIDEO_INTERLACE_MODE_MIXED"
glib:nick="mixed">
<doc xml:space="preserve">frames contains both interlaced and
progressive video, the buffer flags describe the frame and fields.</doc>
</member>
<member name="fields"
value="3"
c:identifier="GST_VIDEO_INTERLACE_MODE_FIELDS"
glib:nick="fields">
<doc xml:space="preserve">2 fields are stored in one buffer, use the
frame ID to get access to the required field. For multiview (the
'views' property > 1) the fields of view N can be found at frame ID
(N * 2) and (N * 2) + 1.
Each field has only half the amount of lines as noted in the
height property. This mode requires multiple GstVideoMeta metadata
to describe the fields.</doc>
</member>
</enumeration>
<record name="VideoMeta" c:type="GstVideoMeta">
<doc xml:space="preserve">Extra buffer metadata describing image properties</doc>
<field name="meta" writable="1">
<doc xml:space="preserve">parent #GstMeta</doc>
<type name="Gst.Meta" c:type="GstMeta"/>
</field>
<field name="buffer" writable="1">
<doc xml:space="preserve">the buffer this metadata belongs to</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</field>
<field name="flags" writable="1">
<doc xml:space="preserve">additional video flags</doc>
<type name="VideoFrameFlags" c:type="GstVideoFrameFlags"/>
</field>
<field name="format" writable="1">
<doc xml:space="preserve">the video format</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</field>
<field name="id" writable="1">
<doc xml:space="preserve">identifier of the frame</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="width" writable="1">
<doc xml:space="preserve">the video width</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="height" writable="1">
<doc xml:space="preserve">the video height</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="n_planes" writable="1">
<doc xml:space="preserve">the number of planes in the image</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="offset" writable="1">
<doc xml:space="preserve">array of offsets for the planes. This field might not always be
valid, it is used by the default implementation of @map.</doc>
<array zero-terminated="0" c:type="gsize" fixed-size="4">
<type name="gsize" c:type="gsize"/>
</array>
</field>
<field name="stride" writable="1">
<doc xml:space="preserve">array of strides for the planes. This field might not always be
valid, it is used by the default implementation of @map.</doc>
<array zero-terminated="0" c:type="gint" fixed-size="4">
<type name="gint" c:type="gint"/>
</array>
</field>
<field name="map">
<callback name="map">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="meta" transfer-ownership="none">
<type name="VideoMeta" c:type="GstVideoMeta*"/>
</parameter>
<parameter name="plane" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="info" transfer-ownership="none">
<type name="Gst.MapInfo" c:type="GstMapInfo*"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer*"/>
</parameter>
<parameter name="stride" transfer-ownership="none">
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<type name="Gst.MapFlags" c:type="GstMapFlags"/>
</parameter>
</parameters>
</callback>
</field>
<field name="unmap">
<callback name="unmap">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="meta" transfer-ownership="none">
<type name="VideoMeta" c:type="GstVideoMeta*"/>
</parameter>
<parameter name="plane" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="info" transfer-ownership="none">
<type name="Gst.MapInfo" c:type="GstMapInfo*"/>
</parameter>
</parameters>
</callback>
</field>
<method name="map" c:identifier="gst_video_meta_map">
<doc xml:space="preserve">Map the video plane with index @plane in @meta and return a pointer to the
first byte of the plane and the stride of the plane.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the map operation was successful.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="meta" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoMeta</doc>
<type name="VideoMeta" c:type="GstVideoMeta*"/>
</instance-parameter>
<parameter name="plane" transfer-ownership="none">
<doc xml:space="preserve">a plane</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstMapInfo</doc>
<type name="Gst.MapInfo" c:type="GstMapInfo*"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">the data of @plane</doc>
<type name="gpointer" c:type="gpointer*"/>
</parameter>
<parameter name="stride" transfer-ownership="none">
<doc xml:space="preserve">the stride of @plane</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">@GstMapFlags</doc>
<type name="Gst.MapFlags" c:type="GstMapFlags"/>
</parameter>
</parameters>
</method>
<method name="unmap" c:identifier="gst_video_meta_unmap">
<doc xml:space="preserve">Unmap a previously mapped plane with gst_video_meta_map().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the memory was successfully unmapped.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="meta" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoMeta</doc>
<type name="VideoMeta" c:type="GstVideoMeta*"/>
</instance-parameter>
<parameter name="plane" transfer-ownership="none">
<doc xml:space="preserve">a plane</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstMapInfo</doc>
<type name="Gst.MapInfo" c:type="GstMapInfo*"/>
</parameter>
</parameters>
</method>
<function name="get_info" c:identifier="gst_video_meta_get_info">
<return-value transfer-ownership="none">
<type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
</return-value>
</function>
</record>
<record name="VideoMetaTransform" c:type="GstVideoMetaTransform">
<doc xml:space="preserve">Extra data passed to a video transform #GstMetaTransformFunction such as:
"gst-video-scale".</doc>
<field name="in_info" writable="1">
<doc xml:space="preserve">the input #GstVideoInfo</doc>
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</field>
<field name="out_info" writable="1">
<doc xml:space="preserve">the output #GstVideoInfo</doc>
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</field>
<function name="scale_get_quark"
c:identifier="gst_video_meta_transform_scale_get_quark">
<doc xml:space="preserve">Get the #GQuark for the "gst-video-scale" metadata transform operation.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GQuark</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</record>
<interface name="VideoOrientation"
c:symbol-prefix="video_orientation"
c:type="GstVideoOrientation"
glib:type-name="GstVideoOrientation"
glib:get-type="gst_video_orientation_get_type"
glib:type-struct="VideoOrientationInterface">
<doc xml:space="preserve">The interface allows unified access to control flipping and autocenter
operation of video-sources or operators.</doc>
<virtual-method name="get_hcenter" invoker="get_hcenter">
<doc xml:space="preserve">Get the horizontal centering offset from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_hflip" invoker="get_hflip">
<doc xml:space="preserve">Get the horizontal flipping state (%TRUE for flipped) from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_vcenter" invoker="get_vcenter">
<doc xml:space="preserve">Get the vertical centering offset from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_vflip" invoker="get_vflip">
<doc xml:space="preserve">Get the vertical flipping state (%TRUE for flipped) from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_hcenter" invoker="set_hcenter">
<doc xml:space="preserve">Set the horizontal centering offset for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">centering offset</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_hflip" invoker="set_hflip">
<doc xml:space="preserve">Set the horizontal flipping state (%TRUE for flipped) for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">use flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_vcenter" invoker="set_vcenter">
<doc xml:space="preserve">Set the vertical centering offset for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">centering offset</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_vflip" invoker="set_vflip">
<doc xml:space="preserve">Set the vertical flipping state (%TRUE for flipped) for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">use flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</virtual-method>
<method name="get_hcenter"
c:identifier="gst_video_orientation_get_hcenter">
<doc xml:space="preserve">Get the horizontal centering offset from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<method name="get_hflip" c:identifier="gst_video_orientation_get_hflip">
<doc xml:space="preserve">Get the horizontal flipping state (%TRUE for flipped) from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</method>
<method name="get_vcenter"
c:identifier="gst_video_orientation_get_vcenter">
<doc xml:space="preserve">Get the vertical centering offset from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<method name="get_vflip" c:identifier="gst_video_orientation_get_vflip">
<doc xml:space="preserve">Get the vertical flipping state (%TRUE for flipped) from the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</method>
<method name="set_hcenter"
c:identifier="gst_video_orientation_set_hcenter">
<doc xml:space="preserve">Set the horizontal centering offset for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">centering offset</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_hflip" c:identifier="gst_video_orientation_set_hflip">
<doc xml:space="preserve">Set the horizontal flipping state (%TRUE for flipped) for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">use flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_vcenter"
c:identifier="gst_video_orientation_set_vcenter">
<doc xml:space="preserve">Set the vertical centering offset for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">centering offset</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_vflip" c:identifier="gst_video_orientation_set_vflip">
<doc xml:space="preserve">Set the vertical flipping state (%TRUE for flipped) for the given object.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="video_orientation"
transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</instance-parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">use flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
</interface>
<record name="VideoOrientationInterface"
c:type="GstVideoOrientationInterface"
glib:is-gtype-struct-for="VideoOrientation">
<doc xml:space="preserve">#GstVideoOrientationInterface interface.</doc>
<field name="iface">
<doc xml:space="preserve">parent interface type.</doc>
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="get_hflip">
<callback name="get_hflip">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_vflip">
<callback name="get_vflip">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_hcenter">
<callback name="get_hcenter">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_vcenter">
<callback name="get_vcenter">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">return location for the result</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_hflip">
<callback name="set_hflip">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">use flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_vflip">
<callback name="set_vflip">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="flip" transfer-ownership="none">
<doc xml:space="preserve">use flipping</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_hcenter">
<callback name="set_hcenter">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">centering offset</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_vcenter">
<callback name="set_vcenter">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE in case the element supports centering</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="video_orientation" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoOrientation interface of a #GstElement</doc>
<type name="VideoOrientation" c:type="GstVideoOrientation*"/>
</parameter>
<parameter name="center" transfer-ownership="none">
<doc xml:space="preserve">centering offset</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<interface name="VideoOverlay"
c:symbol-prefix="video_overlay"
c:type="GstVideoOverlay"
glib:type-name="GstVideoOverlay"
glib:get-type="gst_video_overlay_get_type"
glib:type-struct="VideoOverlayInterface">
<doc xml:space="preserve"><refsect2>
<para>
The #GstVideoOverlay interface is used for 2 main purposes :
<itemizedlist>
<listitem>
<para>
To get a grab on the Window where the video sink element is going to render.
This is achieved by either being informed about the Window identifier that
the video sink element generated, or by forcing the video sink element to use
a specific Window identifier for rendering.
</para>
</listitem>
<listitem>
<para>
To force a redrawing of the latest video frame the video sink element
displayed on the Window. Indeed if the #GstPipeline is in #GST_STATE_PAUSED
state, moving the Window around will damage its content. Application
developers will want to handle the Expose events themselves and force the
video sink element to refresh the Window's content.
</para>
</listitem>
</itemizedlist>
</para>
<para>
Using the Window created by the video sink is probably the simplest scenario,
in some cases, though, it might not be flexible enough for application
developers if they need to catch events such as mouse moves and button
clicks.
</para>
<para>
Setting a specific Window identifier on the video sink element is the most
flexible solution but it has some issues. Indeed the application needs to set
its Window identifier at the right time to avoid internal Window creation
from the video sink element. To solve this issue a #GstMessage is posted on
the bus to inform the application that it should set the Window identifier
immediately. Here is an example on how to do that correctly:
|[
static GstBusSyncReply
create_window (GstBus * bus, GstMessage * message, GstPipeline * pipeline)
{
// ignore anything but 'prepare-window-handle' element messages
if (!gst_is_video_overlay_prepare_window_handle_message (message))
return GST_BUS_PASS;
win = XCreateSimpleWindow (disp, root, 0, 0, 320, 240, 0, 0, 0);
XSetWindowBackgroundPixmap (disp, win, None);
XMapRaised (disp, win);
XSync (disp, FALSE);
gst_video_overlay_set_window_handle (GST_VIDEO_OVERLAY (GST_MESSAGE_SRC (message)),
win);
gst_message_unref (message);
return GST_BUS_DROP;
}
...
int
main (int argc, char **argv)
{
...
bus = gst_pipeline_get_bus (GST_PIPELINE (pipeline));
gst_bus_set_sync_handler (bus, (GstBusSyncHandler) create_window, pipeline,
NULL);
...
}
]|
</para>
</refsect2>
<refsect2>
<title>Two basic usage scenarios</title>
<para>
There are two basic usage scenarios: in the simplest case, the application
knows exactly what particular element is used for video output, which is
usually the case when the application creates the videosink to use
(e.g. #xvimagesink, #ximagesink, etc.) itself; in this case, the application
can just create the videosink element, create and realize the window to
render the video on and then call gst_video_overlay_set_window_handle() directly
with the XID or native window handle, before starting up the pipeline.
</para>
<para>
In the other and more common case, the application does not know in advance
what GStreamer video sink element will be used for video output. This is
usually the case when an element such as #autovideosink or #gconfvideosink
is used. In this case, the video sink element itself is created
asynchronously from a GStreamer streaming thread some time after the
pipeline has been started up. When that happens, however, the video sink
will need to know right then whether to render onto an already existing
application window or whether to create its own window. This is when it
posts a prepare-window-handle message, and that is also why this message needs
to be handled in a sync bus handler which will be called from the streaming
thread directly (because the video sink will need an answer right then).
</para>
<para>
As response to the prepare-window-handle element message in the bus sync
handler, the application may use gst_video_overlay_set_window_handle() to tell
the video sink to render onto an existing window surface. At this point the
application should already have obtained the window handle / XID, so it
just needs to set it. It is generally not advisable to call any GUI toolkit
functions or window system functions from the streaming thread in which the
prepare-window-handle message is handled, because most GUI toolkits and
windowing systems are not thread-safe at all and a lot of care would be
required to co-ordinate the toolkit and window system calls of the
different threads (Gtk+ users please note: prior to Gtk+ 2.18
GDK_WINDOW_XID() was just a simple structure access, so generally fine to do
within the bus sync handler; this macro was changed to a function call in
Gtk+ 2.18 and later, which is likely to cause problems when called from a
sync handler; see below for a better approach without GDK_WINDOW_XID()
used in the callback).
</para>
</refsect2>
<refsect2>
<title>GstVideoOverlay and Gtk+</title>
<para>
|[
#include &lt;gst/video/videooverlay.h&gt;
#include &lt;gtk/gtk.h&gt;
#ifdef GDK_WINDOWING_X11
#include &lt;gdk/gdkx.h&gt; // for GDK_WINDOW_XID
#endif
#ifdef GDK_WINDOWING_WIN32
#include &lt;gdk/gdkwin32.h&gt; // for GDK_WINDOW_HWND
#endif
...
static guintptr video_window_handle = 0;
...
static GstBusSyncReply
bus_sync_handler (GstBus * bus, GstMessage * message, gpointer user_data)
{
// ignore anything but 'prepare-window-handle' element messages
if (!gst_is_video_overlay_prepare_window_handle_message (message))
return GST_BUS_PASS;
if (video_window_handle != 0) {
GstVideoOverlay *overlay;
// GST_MESSAGE_SRC (message) will be the video sink element
overlay = GST_VIDEO_OVERLAY (GST_MESSAGE_SRC (message));
gst_video_overlay_set_window_handle (overlay, video_window_handle);
} else {
g_warning ("Should have obtained video_window_handle by now!");
}
gst_message_unref (message);
return GST_BUS_DROP;
}
...
static void
video_widget_realize_cb (GtkWidget * widget, gpointer data)
{
#if GTK_CHECK_VERSION(2,18,0)
// Tell Gtk+/Gdk to create a native window for this widget instead of
// drawing onto the parent widget.
// This is here just for pedagogical purposes, GDK_WINDOW_XID will call
// it as well in newer Gtk versions
if (!gdk_window_ensure_native (widget->window))
g_error ("Couldn't create native window needed for GstVideoOverlay!");
#endif
#ifdef GDK_WINDOWING_X11
{
gulong xid = GDK_WINDOW_XID (gtk_widget_get_window (video_window));
video_window_handle = xid;
}
#endif
#ifdef GDK_WINDOWING_WIN32
{
HWND wnd = GDK_WINDOW_HWND (gtk_widget_get_window (video_window));
video_window_handle = (guintptr) wnd;
}
#endif
}
...
int
main (int argc, char **argv)
{
GtkWidget *video_window;
GtkWidget *app_window;
...
app_window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
...
video_window = gtk_drawing_area_new ();
g_signal_connect (video_window, "realize",
G_CALLBACK (video_widget_realize_cb), NULL);
gtk_widget_set_double_buffered (video_window, FALSE);
...
// usually the video_window will not be directly embedded into the
// application window like this, but there will be many other widgets
// and the video window will be embedded in one of them instead
gtk_container_add (GTK_CONTAINER (ap_window), video_window);
...
// show the GUI
gtk_widget_show_all (app_window);
// realize window now so that the video window gets created and we can
// obtain its XID/HWND before the pipeline is started up and the videosink
// asks for the XID/HWND of the window to render onto
gtk_widget_realize (video_window);
// we should have the XID/HWND now
g_assert (video_window_handle != 0);
...
// set up sync handler for setting the xid once the pipeline is started
bus = gst_pipeline_get_bus (GST_PIPELINE (pipeline));
gst_bus_set_sync_handler (bus, (GstBusSyncHandler) bus_sync_handler, NULL,
NULL);
gst_object_unref (bus);
...
gst_element_set_state (pipeline, GST_STATE_PLAYING);
...
}
]|
</para>
</refsect2>
<refsect2>
<title>GstVideoOverlay and Qt</title>
<para>
|[
#include &lt;glib.h&gt;
#include &lt;gst/gst.h&gt;
#include &lt;gst/video/videooverlay.h&gt;
#include &lt;QApplication&gt;
#include &lt;QTimer&gt;
#include &lt;QWidget&gt;
int main(int argc, char *argv[])
{
if (!g_thread_supported ())
g_thread_init (NULL);
gst_init (&argc, &argv);
QApplication app(argc, argv);
app.connect(&app, SIGNAL(lastWindowClosed()), &app, SLOT(quit ()));
// prepare the pipeline
GstElement *pipeline = gst_pipeline_new ("xvoverlay");
GstElement *src = gst_element_factory_make ("videotestsrc", NULL);
GstElement *sink = gst_element_factory_make ("xvimagesink", NULL);
gst_bin_add_many (GST_BIN (pipeline), src, sink, NULL);
gst_element_link (src, sink);
// prepare the ui
QWidget window;
window.resize(320, 240);
window.show();
WId xwinid = window.winId();
gst_video_overlay_set_window_handle (GST_VIDEO_OVERLAY (sink), xwinid);
// run the pipeline
GstStateChangeReturn sret = gst_element_set_state (pipeline,
GST_STATE_PLAYING);
if (sret == GST_STATE_CHANGE_FAILURE) {
gst_element_set_state (pipeline, GST_STATE_NULL);
gst_object_unref (pipeline);
// Exit application
QTimer::singleShot(0, QApplication::activeWindow(), SLOT(quit()));
}
int ret = app.exec();
window.hide();
gst_element_set_state (pipeline, GST_STATE_NULL);
gst_object_unref (pipeline);
return ret;
}
]|
</para>
</refsect2></doc>
<virtual-method name="expose" invoker="expose">
<doc xml:space="preserve">Tell an overlay that it has been exposed. This will redraw the current frame
in the drawable even if the pipeline is PAUSED.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlay to expose.</doc>
<type name="VideoOverlay" c:type="GstVideoOverlay*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="handle_events" invoker="handle_events">
<doc xml:space="preserve">Tell an overlay that it should handle events from the window system. These
events are forwarded upstream as navigation events. In some window system,
events are not propagated in the window hierarchy if a client is listening
for them. This method allows you to disable events handling completely
from the #GstVideoOverlay.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlay to expose.</doc>
<type name="VideoOverlay" c:type="GstVideoOverlay*"/>
</instance-parameter>
<parameter name="handle_events" transfer-ownership="none">
<doc xml:space="preserve">a #gboolean indicating if events should be handled or not.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_render_rectangle">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<type name="VideoOverlay" c:type="GstVideoOverlay*"/>
</instance-parameter>
<parameter name="x" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="set_window_handle" invoker="set_window_handle">
<doc xml:space="preserve">This will call the video overlay's set_window_handle method. You
should use this method to tell to an overlay to display video output to a
specific window (e.g. an XWindow on X11). Passing 0 as the @handle will
tell the overlay to stop using that window and create an internal one.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlay to set the window on.</doc>
<type name="VideoOverlay" c:type="GstVideoOverlay*"/>
</instance-parameter>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a handle referencing the window.</doc>
<type name="guintptr" c:type="guintptr"/>
</parameter>
</parameters>
</virtual-method>
<method name="expose" c:identifier="gst_video_overlay_expose">
<doc xml:space="preserve">Tell an overlay that it has been exposed. This will redraw the current frame
in the drawable even if the pipeline is PAUSED.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlay to expose.</doc>
<type name="VideoOverlay" c:type="GstVideoOverlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="got_window_handle"
c:identifier="gst_video_overlay_got_window_handle">
<doc xml:space="preserve">This will post a "have-window-handle" element message on the bus.
This function should only be used by video overlay plugin developers.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlay which got a window</doc>
<type name="VideoOverlay" c:type="GstVideoOverlay*"/>
</instance-parameter>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a platform-specific handle referencing the window</doc>
<type name="guintptr" c:type="guintptr"/>
</parameter>
</parameters>
</method>
<method name="handle_events"
c:identifier="gst_video_overlay_handle_events">
<doc xml:space="preserve">Tell an overlay that it should handle events from the window system. These
events are forwarded upstream as navigation events. In some window system,
events are not propagated in the window hierarchy if a client is listening
for them. This method allows you to disable events handling completely
from the #GstVideoOverlay.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlay to expose.</doc>
<type name="VideoOverlay" c:type="GstVideoOverlay*"/>
</instance-parameter>
<parameter name="handle_events" transfer-ownership="none">
<doc xml:space="preserve">a #gboolean indicating if events should be handled or not.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="prepare_window_handle"
c:identifier="gst_video_overlay_prepare_window_handle">
<doc xml:space="preserve">This will post a "prepare-window-handle" element message on the bus
to give applications an opportunity to call
gst_video_overlay_set_window_handle() before a plugin creates its own
window.
This function should only be used by video overlay plugin developers.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlay which does not yet have an Window handle set</doc>
<type name="VideoOverlay" c:type="GstVideoOverlay*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_render_rectangle"
c:identifier="gst_video_overlay_set_render_rectangle">
<doc xml:space="preserve">Configure a subregion as a video target within the window set by
gst_video_overlay_set_window_handle(). If this is not used or not supported
the video will fill the area of the window set as the overlay to 100%.
By specifying the rectangle, the video can be overlayed to a specific region
of that window only. After setting the new rectangle one should call
gst_video_overlay_expose() to force a redraw. To unset the region pass -1 for
the @width and @height parameters.
This method is needed for non fullscreen video overlay in UI toolkits that
do not support subwindows.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%FALSE if not supported by the sink.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlay</doc>
<type name="VideoOverlay" c:type="GstVideoOverlay*"/>
</instance-parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">the horizontal offset of the render area inside the window</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">the vertical offset of the render area inside the window</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">the width of the render area inside the window</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">the height of the render area inside the window</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_window_handle"
c:identifier="gst_video_overlay_set_window_handle">
<doc xml:space="preserve">This will call the video overlay's set_window_handle method. You
should use this method to tell to an overlay to display video output to a
specific window (e.g. an XWindow on X11). Passing 0 as the @handle will
tell the overlay to stop using that window and create an internal one.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlay to set the window on.</doc>
<type name="VideoOverlay" c:type="GstVideoOverlay*"/>
</instance-parameter>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a handle referencing the window.</doc>
<type name="guintptr" c:type="guintptr"/>
</parameter>
</parameters>
</method>
</interface>
<record name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition"
glib:type-name="GstVideoOverlayComposition"
glib:get-type="gst_video_overlay_composition_get_type"
c:symbol-prefix="video_overlay_composition">
<doc xml:space="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">
<doc xml:space="preserve">Creates a new video overlay composition object to hold one or more
overlay rectangles.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GstVideoOverlayComposition. Unref with
gst_video_overlay_composition_unref() when no longer needed.</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</return-value>
<parameters>
<parameter name="rectangle" transfer-ownership="none">
<doc xml:space="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">
<doc xml:space="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>
<instance-parameter name="comp" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayComposition</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</instance-parameter>
<parameter name="rectangle" transfer-ownership="none">
<doc xml:space="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">
<doc xml:space="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 and
mapped appropriately.</doc>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="comp" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayComposition</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</instance-parameter>
<parameter name="video_buf" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFrame containing raw video data in a supported format</doc>
<type name="VideoFrame" c:type="GstVideoFrame*"/>
</parameter>
</parameters>
</method>
<method name="copy" c:identifier="gst_video_overlay_composition_copy">
<doc xml:space="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.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GstVideoOverlayComposition equivalent
to @comp.</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</return-value>
<parameters>
<instance-parameter name="comp" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayComposition to copy</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_rectangle"
c:identifier="gst_video_overlay_composition_get_rectangle">
<doc xml:space="preserve">Returns the @n-th #GstVideoOverlayRectangle contained in @comp.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the @n-th rectangle, or NULL if @n is out of
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>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</return-value>
<parameters>
<instance-parameter name="comp" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayComposition</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</instance-parameter>
<parameter name="n" transfer-ownership="none">
<doc xml:space="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">
<doc xml:space="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:space="preserve">the sequence number of @comp</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="comp" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayComposition</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</instance-parameter>
</parameters>
</method>
<method name="make_writable"
c:identifier="gst_video_overlay_composition_make_writable">
<doc xml:space="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.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a writable #GstVideoOverlayComposition
equivalent to @comp.</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</return-value>
<parameters>
<instance-parameter name="comp" transfer-ownership="full">
<doc xml:space="preserve">a #GstVideoOverlayComposition to copy</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</instance-parameter>
</parameters>
</method>
<method name="n_rectangles"
c:identifier="gst_video_overlay_composition_n_rectangles">
<doc xml:space="preserve">Returns the number of #GstVideoOverlayRectangle<!-- -->s contained in @comp.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the number of rectangles</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="comp" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayComposition</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</instance-parameter>
</parameters>
</method>
</record>
<record name="VideoOverlayCompositionMeta"
c:type="GstVideoOverlayCompositionMeta">
<doc xml:space="preserve">Extra buffer metadata describing image overlay data.</doc>
<field name="meta" writable="1">
<doc xml:space="preserve">parent #GstMeta</doc>
<type name="Gst.Meta" c:type="GstMeta"/>
</field>
<field name="overlay" writable="1">
<doc xml:space="preserve">the attached #GstVideoOverlayComposition</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</field>
<function name="get_info"
c:identifier="gst_video_overlay_composition_meta_get_info">
<return-value transfer-ownership="none">
<type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
</return-value>
</function>
</record>
<enumeration name="VideoOverlayFormatFlags"
c:type="GstVideoOverlayFormatFlags">
<doc xml:space="preserve">Overlay format flags.</doc>
<member name="none"
value="0"
c:identifier="GST_VIDEO_OVERLAY_FORMAT_FLAG_NONE">
<doc xml:space="preserve">no flags</doc>
</member>
<member name="premultiplied_alpha"
value="1"
c:identifier="GST_VIDEO_OVERLAY_FORMAT_FLAG_PREMULTIPLIED_ALPHA">
<doc xml:space="preserve">RGB are premultiplied by A/255.</doc>
</member>
<member name="global_alpha"
value="2"
c:identifier="GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA">
<doc xml:space="preserve">a global-alpha value != 1 is set.</doc>
</member>
</enumeration>
<record name="VideoOverlayInterface"
c:type="GstVideoOverlayInterface"
glib:is-gtype-struct-for="VideoOverlay">
<doc xml:space="preserve">#GstVideoOverlay interface</doc>
<field name="iface">
<doc xml:space="preserve">parent interface type.</doc>
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="expose">
<callback name="expose">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlay to expose.</doc>
<type name="VideoOverlay" c:type="GstVideoOverlay*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="handle_events">
<callback name="handle_events">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlay to expose.</doc>
<type name="VideoOverlay" c:type="GstVideoOverlay*"/>
</parameter>
<parameter name="handle_events" transfer-ownership="none">
<doc xml:space="preserve">a #gboolean indicating if events should be handled or not.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_render_rectangle">
<callback name="set_render_rectangle">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="overlay" transfer-ownership="none">
<type name="VideoOverlay" c:type="GstVideoOverlay*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_window_handle">
<callback name="set_window_handle">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="overlay" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlay to set the window on.</doc>
<type name="VideoOverlay" c:type="GstVideoOverlay*"/>
</parameter>
<parameter name="handle" transfer-ownership="none">
<doc xml:space="preserve">a handle referencing the window.</doc>
<type name="guintptr" c:type="guintptr"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<record name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle"
glib:type-name="GstVideoOverlayRectangle"
glib:get-type="gst_video_overlay_rectangle_get_type"
c:symbol-prefix="video_overlay_rectangle">
<doc xml:space="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_raw"
c:identifier="gst_video_overlay_rectangle_new_raw">
<doc xml:space="preserve">Creates a new video overlay rectangle with ARGB or AYUV pixel data.
The layout in case of ARGB 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. Unless specified in the flags, 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.
The pixel data buffer must have #GstVideoMeta set.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GstVideoOverlayRectangle. Unref with
gst_video_overlay_rectangle_unref() when no longer needed.</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</return-value>
<parameters>
<parameter name="pixels" transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer pointing to the pixel memory</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="render_x" transfer-ownership="none">
<doc xml:space="preserve">the X co-ordinate on the video where the top-left corner of this
overlay rectangle should be rendered to</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="render_y" transfer-ownership="none">
<doc xml:space="preserve">the Y co-ordinate on the video where the top-left corner of this
overlay rectangle should be rendered to</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="render_width" transfer-ownership="none">
<doc xml:space="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:space="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:space="preserve">flags</doc>
<type name="VideoOverlayFormatFlags"
c:type="GstVideoOverlayFormatFlags"/>
</parameter>
</parameters>
</constructor>
<method name="copy" c:identifier="gst_video_overlay_rectangle_copy">
<doc xml:space="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.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GstVideoOverlayRectangle equivalent
to @rectangle.</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</return-value>
<parameters>
<instance-parameter name="rectangle" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayRectangle to copy</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_flags"
c:identifier="gst_video_overlay_rectangle_get_flags">
<doc xml:space="preserve">Retrieves the flags associated with a #GstVideoOverlayRectangle.
This is useful if the caller can handle both premultiplied alpha and
non premultiplied alpha, for example. By knowing whether the rectangle
uses premultiplied or not, it can request the pixel data in the format
it is stored in, to avoid unnecessary conversion.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #GstVideoOverlayFormatFlags associated with the rectangle.</doc>
<type name="VideoOverlayFormatFlags"
c:type="GstVideoOverlayFormatFlags"/>
</return-value>
<parameters>
<instance-parameter name="rectangle" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayRectangle</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_global_alpha"
c:identifier="gst_video_overlay_rectangle_get_global_alpha">
<doc xml:space="preserve">Retrieves the global-alpha value associated with a #GstVideoOverlayRectangle.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the global-alpha value associated with the rectangle.</doc>
<type name="gfloat" c:type="gfloat"/>
</return-value>
<parameters>
<instance-parameter name="rectangle" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayRectangle</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_pixels_argb"
c:identifier="gst_video_overlay_rectangle_get_pixels_argb">
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer holding the ARGB pixel data with
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>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="rectangle" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayRectangle</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">flags
If a global_alpha value != 1 is set for the rectangle, the caller
should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
if he wants to apply global-alpha himself. If the flag is not set
global_alpha is applied internally before returning the pixel-data.</doc>
<type name="VideoOverlayFormatFlags"
c:type="GstVideoOverlayFormatFlags"/>
</parameter>
</parameters>
</method>
<method name="get_pixels_ayuv"
c:identifier="gst_video_overlay_rectangle_get_pixels_ayuv">
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer holding the AYUV pixel data with
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>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="rectangle" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayRectangle</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">flags
If a global_alpha value != 1 is set for the rectangle, the caller
should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
if he wants to apply global-alpha himself. If the flag is not set
global_alpha is applied internally before returning the pixel-data.</doc>
<type name="VideoOverlayFormatFlags"
c:type="GstVideoOverlayFormatFlags"/>
</parameter>
</parameters>
</method>
<method name="get_pixels_raw"
c:identifier="gst_video_overlay_rectangle_get_pixels_raw">
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer holding the pixel data with
format as originally provided and specified in video meta with
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>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="rectangle" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayRectangle</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">flags
If a global_alpha value != 1 is set for the rectangle, the caller
should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
if he wants to apply global-alpha himself. If the flag is not set
global_alpha is applied internally before returning the pixel-data.</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">
<doc xml:space="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().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer holding the ARGB pixel data with
#GstVideoMeta set. This function does not return a reference, the caller
should obtain a reference of her own with gst_buffer_ref() if needed.</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="rectangle" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayRectangle</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">flags.
If a global_alpha value != 1 is set for the rectangle, the caller
should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
if he wants to apply global-alpha himself. If the flag is not set
global_alpha is applied internally before returning the pixel-data.</doc>
<type name="VideoOverlayFormatFlags"
c:type="GstVideoOverlayFormatFlags"/>
</parameter>
</parameters>
</method>
<method name="get_pixels_unscaled_ayuv"
c:identifier="gst_video_overlay_rectangle_get_pixels_unscaled_ayuv">
<doc xml:space="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().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer holding the AYUV pixel data with
#GstVideoMeta set. This function does not return a reference, the caller
should obtain a reference of her own with gst_buffer_ref() if needed.</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="rectangle" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayRectangle</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">flags.
If a global_alpha value != 1 is set for the rectangle, the caller
should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
if he wants to apply global-alpha himself. If the flag is not set
global_alpha is applied internally before returning the pixel-data.</doc>
<type name="VideoOverlayFormatFlags"
c:type="GstVideoOverlayFormatFlags"/>
</parameter>
</parameters>
</method>
<method name="get_pixels_unscaled_raw"
c:identifier="gst_video_overlay_rectangle_get_pixels_unscaled_raw">
<doc xml:space="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().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer holding the pixel data with
#GstVideoMeta set. This function does not return a reference, the caller
should obtain a reference of her own with gst_buffer_ref() if needed.</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="rectangle" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayRectangle</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">flags.
If a global_alpha value != 1 is set for the rectangle, the caller
should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag
if he wants to apply global-alpha himself. If the flag is not set
global_alpha is applied internally before returning the pixel-data.</doc>
<type name="VideoOverlayFormatFlags"
c:type="GstVideoOverlayFormatFlags"/>
</parameter>
</parameters>
</method>
<method name="get_render_rectangle"
c:identifier="gst_video_overlay_rectangle_get_render_rectangle">
<doc xml:space="preserve">Retrieves the render position and render dimension of the overlay
rectangle on the video.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if valid render dimensions were retrieved.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="rectangle" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayRectangle</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</instance-parameter>
<parameter name="render_x"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:space="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:space="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:space="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:space="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">
<doc xml:space="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).
Using the sequence number of a rectangle as an indicator for changed
pixel-data of a rectangle is dangereous. Some API calls, like e.g.
gst_video_overlay_rectangle_set_global_alpha(), automatically update
the per rectangle sequence number, which is misleading for renderers/
consumers, that handle global-alpha themselves. For them the
pixel-data returned by gst_video_overlay_rectangle_get_pixels_*()
wont be different for different global-alpha values. In this case a
renderer could also use the GstBuffer pointers as a hint for changed
pixel-data.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the sequence number of @rectangle</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="rectangle" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayRectangle</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_global_alpha"
c:identifier="gst_video_overlay_rectangle_set_global_alpha">
<doc xml:space="preserve">Sets the global alpha value associated with a #GstVideoOverlayRectangle. Per-
pixel alpha values are multiplied with this value. Valid
values: 0 <= global_alpha <= 1; 1 to deactivate.
# @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>
<instance-parameter name="rectangle" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayRectangle</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</instance-parameter>
<parameter name="global_alpha" transfer-ownership="none">
<type name="gfloat" c:type="gfloat"/>
</parameter>
</parameters>
</method>
<method name="set_render_rectangle"
c:identifier="gst_video_overlay_rectangle_set_render_rectangle">
<doc xml:space="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>
<instance-parameter name="rectangle" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoOverlayRectangle</doc>
<type name="VideoOverlayRectangle"
c:type="GstVideoOverlayRectangle*"/>
</instance-parameter>
<parameter name="render_x" transfer-ownership="none">
<doc xml:space="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:space="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:space="preserve">render width of rectangle</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="render_height" transfer-ownership="none">
<doc xml:space="preserve">render height of rectangle</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
</record>
<bitfield name="VideoPackFlags"
glib:type-name="GstVideoPackFlags"
glib:get-type="gst_video_pack_flags_get_type"
c:type="GstVideoPackFlags">
<doc xml:space="preserve">The different flags that can be used when packing and unpacking.</doc>
<member name="none"
value="0"
c:identifier="GST_VIDEO_PACK_FLAG_NONE"
glib:nick="none">
<doc xml:space="preserve">No flag</doc>
</member>
<member name="truncate_range"
value="1"
c:identifier="GST_VIDEO_PACK_FLAG_TRUNCATE_RANGE"
glib:nick="truncate-range">
<doc xml:space="preserve">When the source has a smaller depth
than the target format, set the least significant bits of the target
to 0. This is likely sightly faster but less accurate. When this flag
is not specified, the most significant bits of the source are duplicated
in the least significant bits of the destination.</doc>
</member>
<member name="interlaced"
value="2"
c:identifier="GST_VIDEO_PACK_FLAG_INTERLACED"
glib:nick="interlaced">
<doc xml:space="preserve">The source is interlaced. The unpacked
format will be interlaced as well with each line containing
information from alternating fields. (Since 1.2)</doc>
</member>
</bitfield>
<record name="VideoRectangle" c:type="GstVideoRectangle">
<doc xml:space="preserve">Helper structure representing a rectangular area.</doc>
<field name="x" writable="1">
<doc xml:space="preserve">X coordinate of rectangle's top-left point</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="y" writable="1">
<doc xml:space="preserve">Y coordinate of rectangle's top-left point</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="w" writable="1">
<doc xml:space="preserve">width of the rectangle</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="h" writable="1">
<doc xml:space="preserve">height of the rectangle</doc>
<type name="gint" c:type="gint"/>
</field>
</record>
<record name="VideoRegionOfInterestMeta"
c:type="GstVideoRegionOfInterestMeta">
<doc xml:space="preserve">Extra buffer metadata describing an image region of interest</doc>
<field name="meta" writable="1">
<doc xml:space="preserve">parent #GstMeta</doc>
<type name="Gst.Meta" c:type="GstMeta"/>
</field>
<field name="roi_type" writable="1">
<doc xml:space="preserve">GQuark describing the semantic of the Roi (f.i. a face, a pedestrian)</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</field>
<field name="id" writable="1">
<doc xml:space="preserve">identifier of this particular ROI</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="parent_id" writable="1">
<doc xml:space="preserve">identifier of its parent ROI, used f.i. for ROI hierarchisation.</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="x" writable="1">
<doc xml:space="preserve">x component of upper-left corner</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="y" writable="1">
<doc xml:space="preserve">y component of upper-left corner</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="w" writable="1">
<type name="guint" c:type="guint"/>
</field>
<field name="h" writable="1">
<type name="guint" c:type="guint"/>
</field>
<function name="get_info"
c:identifier="gst_video_region_of_interest_meta_get_info">
<return-value transfer-ownership="none">
<type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
</return-value>
</function>
</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:space="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:space="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:space="preserve">the #GstVideoRectangle describing the source area</doc>
<type name="VideoRectangle" c:type="GstVideoRectangle"/>
</parameter>
<parameter name="dst" transfer-ownership="none">
<doc xml:space="preserve">the #GstVideoRectangle describing the destination area</doc>
<type name="VideoRectangle" c:type="GstVideoRectangle"/>
</parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="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:space="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>
<instance-parameter name="video_sink" transfer-ownership="none">
<type name="VideoSink" c:type="GstVideoSink*"/>
</instance-parameter>
<parameter name="buf" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
</parameters>
</virtual-method>
<property name="show-preroll-frame"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="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" c:type="gboolean"/>
</property>
<field name="element">
<type name="GstBase.BaseSink" c:type="GstBaseSink"/>
</field>
<field name="width">
<doc xml:space="preserve">video width (derived class needs to set this)</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="height">
<doc xml:space="preserve">video height (derived class needs to set this)</doc>
<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="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</class>
<record name="VideoSinkClass"
c:type="GstVideoSinkClass"
glib:is-gtype-struct-for="VideoSink">
<doc xml:space="preserve">The video sink class structure. Derived classes should override the
@show_frame virtual function.</doc>
<field name="parent_class">
<doc xml:space="preserve">the parent class structure</doc>
<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="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<record name="VideoSinkPrivate" c:type="GstVideoSinkPrivate" disguised="1">
</record>
<enumeration name="VideoTransferFunction"
glib:type-name="GstVideoTransferFunction"
glib:get-type="gst_video_transfer_function_get_type"
c:type="GstVideoTransferFunction">
<doc xml:space="preserve">The video transfer function defines the formula for converting between
non-linear RGB (R'G'B') and linear RGB</doc>
<member name="unknown"
value="0"
c:identifier="GST_VIDEO_TRANSFER_UNKNOWN"
glib:nick="unknown">
<doc xml:space="preserve">unknown transfer function</doc>
</member>
<member name="gamma10"
value="1"
c:identifier="GST_VIDEO_TRANSFER_GAMMA10"
glib:nick="gamma10">
<doc xml:space="preserve">linear RGB, gamma 1.0 curve</doc>
</member>
<member name="gamma18"
value="2"
c:identifier="GST_VIDEO_TRANSFER_GAMMA18"
glib:nick="gamma18">
<doc xml:space="preserve">Gamma 1.8 curve</doc>
</member>
<member name="gamma20"
value="3"
c:identifier="GST_VIDEO_TRANSFER_GAMMA20"
glib:nick="gamma20">
<doc xml:space="preserve">Gamma 2.0 curve</doc>
</member>
<member name="gamma22"
value="4"
c:identifier="GST_VIDEO_TRANSFER_GAMMA22"
glib:nick="gamma22">
<doc xml:space="preserve">Gamma 2.2 curve</doc>
</member>
<member name="bt709"
value="5"
c:identifier="GST_VIDEO_TRANSFER_BT709"
glib:nick="bt709">
<doc xml:space="preserve">Gamma 2.2 curve with a linear segment in the lower
range</doc>
</member>
<member name="smpte240m"
value="6"
c:identifier="GST_VIDEO_TRANSFER_SMPTE240M"
glib:nick="smpte240m">
<doc xml:space="preserve">Gamma 2.2 curve with a linear segment in the
lower range</doc>
</member>
<member name="srgb"
value="7"
c:identifier="GST_VIDEO_TRANSFER_SRGB"
glib:nick="srgb">
<doc xml:space="preserve">Gamma 2.4 curve with a linear segment in the lower
range</doc>
</member>
<member name="gamma28"
value="8"
c:identifier="GST_VIDEO_TRANSFER_GAMMA28"
glib:nick="gamma28">
<doc xml:space="preserve">Gamma 2.8 curve</doc>
</member>
<member name="log100"
value="9"
c:identifier="GST_VIDEO_TRANSFER_LOG100"
glib:nick="log100">
<doc xml:space="preserve">Logarithmic transfer characteristic
100:1 range</doc>
</member>
<member name="log316"
value="10"
c:identifier="GST_VIDEO_TRANSFER_LOG316"
glib:nick="log316">
<doc xml:space="preserve">Logarithmic transfer characteristic
316.22777:1 range</doc>
</member>
</enumeration>
<function name="buffer_add_video_gl_texture_upload_meta"
c:identifier="gst_buffer_add_video_gl_texture_upload_meta"
introspectable="0">
<doc xml:space="preserve">Attaches GstVideoGLTextureUploadMeta metadata to @buffer with the given
parameters.</doc>
<return-value>
<doc xml:space="preserve">the #GstVideoGLTextureUploadMeta on @buffer.</doc>
<type name="VideoGLTextureUploadMeta"
c:type="GstVideoGLTextureUploadMeta*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="texture_orientation" transfer-ownership="none">
<type name="VideoGLTextureOrientation"
c:type="GstVideoGLTextureOrientation"/>
</parameter>
<parameter name="n_textures" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="texture_type" transfer-ownership="none">
<type name="VideoGLTextureType" c:type="GstVideoGLTextureType"/>
</parameter>
<parameter name="upload" transfer-ownership="none" closure="5">
<doc xml:space="preserve">the function to upload the buffer to a specific texture ID</doc>
<type name="VideoGLTextureUpload" c:type="GstVideoGLTextureUpload"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">user data for the implementor of @upload</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="user_data_copy" transfer-ownership="none">
<doc xml:space="preserve">function to copy @user_data</doc>
<type name="GObject.BoxedCopyFunc" c:type="GBoxedCopyFunc"/>
</parameter>
<parameter name="user_data_free" transfer-ownership="none">
<doc xml:space="preserve">function to free @user_data</doc>
<type name="GObject.BoxedFreeFunc" c:type="GBoxedFreeFunc"/>
</parameter>
</parameters>
</function>
<function name="buffer_add_video_meta"
c:identifier="gst_buffer_add_video_meta"
introspectable="0">
<doc xml:space="preserve">Attaches GstVideoMeta metadata to @buffer with the given parameters and the
default offsets and strides for @format and @width x @height.
This function calculates the default offsets and strides and then calls
gst_buffer_add_video_meta_full() with them.</doc>
<return-value>
<doc xml:space="preserve">the #GstVideoMeta on @buffer.</doc>
<type name="VideoMeta" c:type="GstVideoMeta*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoFrameFlags</doc>
<type name="VideoFrameFlags" c:type="GstVideoFrameFlags"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">the width</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">the height</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="buffer_add_video_meta_full"
c:identifier="gst_buffer_add_video_meta_full"
introspectable="0">
<doc xml:space="preserve">Attaches GstVideoMeta metadata to @buffer with the given parameters.</doc>
<return-value>
<doc xml:space="preserve">the #GstVideoMeta on @buffer.</doc>
<type name="VideoMeta" c:type="GstVideoMeta*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">#GstVideoFrameFlags</doc>
<type name="VideoFrameFlags" c:type="GstVideoFrameFlags"/>
</parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">the width</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">the height</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="n_planes" transfer-ownership="none">
<doc xml:space="preserve">number of planes</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="offset" transfer-ownership="none">
<doc xml:space="preserve">offset of each plane</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="stride" transfer-ownership="none">
<doc xml:space="preserve">stride of each plane</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</function>
<function name="buffer_add_video_overlay_composition_meta"
c:identifier="gst_buffer_add_video_overlay_composition_meta"
introspectable="0">
<doc xml:space="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>
<type name="VideoOverlayCompositionMeta"
c:type="GstVideoOverlayCompositionMeta*"/>
</return-value>
<parameters>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="comp" transfer-ownership="none" allow-none="1">
<doc xml:space="preserve">a #GstVideoOverlayComposition</doc>
<type name="VideoOverlayComposition"
c:type="GstVideoOverlayComposition*"/>
</parameter>
</parameters>
</function>
<function name="buffer_add_video_region_of_interest_meta"
c:identifier="gst_buffer_add_video_region_of_interest_meta"
introspectable="0">
<doc xml:space="preserve">Attaches #GstVideoRegionOfInterestMeta metadata to @buffer with the given
parameters.</doc>
<return-value>
<doc xml:space="preserve">the #GstVideoRegionOfInterestMeta on @buffer.</doc>
<type name="VideoRegionOfInterestMeta"
c:type="GstVideoRegionOfInterestMeta*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="roi_type" transfer-ownership="none">
<doc xml:space="preserve">Type of the region of interest (e.g. "face")</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">X position</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Y position</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="w" transfer-ownership="none">
<doc xml:space="preserve">width</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">height</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="buffer_add_video_region_of_interest_meta_id"
c:identifier="gst_buffer_add_video_region_of_interest_meta_id"
introspectable="0">
<doc xml:space="preserve">Attaches #GstVideoRegionOfInterestMeta metadata to @buffer with the given
parameters.</doc>
<return-value>
<doc xml:space="preserve">the #GstVideoRegionOfInterestMeta on @buffer.</doc>
<type name="VideoRegionOfInterestMeta"
c:type="GstVideoRegionOfInterestMeta*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="roi_type" transfer-ownership="none">
<doc xml:space="preserve">Type of the region of interest (e.g. "face")</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">X position</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Y position</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="w" transfer-ownership="none">
<doc xml:space="preserve">width</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="h" transfer-ownership="none">
<doc xml:space="preserve">height</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="buffer_get_video_meta_id"
c:identifier="gst_buffer_get_video_meta_id"
introspectable="0">
<doc xml:space="preserve">Find the #GstVideoMeta on @buffer with the given @id.
Buffers can contain multiple #GstVideoMeta metadata items when dealing with
multiview buffers.</doc>
<return-value>
<doc xml:space="preserve">the #GstVideoMeta with @id or %NULL when there is no such metadata
on @buffer.</doc>
<type name="VideoMeta" c:type="GstVideoMeta*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve">a metadata id</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</function>
<function name="buffer_get_video_region_of_interest_meta_id"
c:identifier="gst_buffer_get_video_region_of_interest_meta_id"
introspectable="0">
<doc xml:space="preserve">Find the #GstVideoRegionOfInterestMeta on @buffer with the given @id.
Buffers can contain multiple #GstVideoRegionOfInterestMeta metadata items if
multiple regions of interests are marked on a frame.</doc>
<return-value>
<doc xml:space="preserve">the #GstVideoeRegionOfInterestMeta with @id or %NULL when there is
no such metadata on @buffer.</doc>
<type name="VideoRegionOfInterestMeta"
c:type="GstVideoRegionOfInterestMeta*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #GstBuffer</doc>
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve">a metadata id</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</function>
<function name="buffer_pool_config_get_video_alignment"
c:identifier="gst_buffer_pool_config_get_video_alignment">
<doc xml:space="preserve">Get the video alignment from the bufferpool configuration @config in
in @align</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">#TRUE if @config could be parsed correctly.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="config" transfer-ownership="none">
<doc xml:space="preserve">a #GstStructure</doc>
<type name="Gst.Structure" c:type="GstStructure*"/>
</parameter>
<parameter name="align" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoAlignment</doc>
<type name="VideoAlignment" c:type="GstVideoAlignment*"/>
</parameter>
</parameters>
</function>
<function name="buffer_pool_config_set_video_alignment"
c:identifier="gst_buffer_pool_config_set_video_alignment">
<doc xml:space="preserve">Set the video alignment in @align to the bufferpool configuration
@config</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="config" transfer-ownership="none">
<doc xml:space="preserve">a #GstStructure</doc>
<type name="Gst.Structure" c:type="GstStructure*"/>
</parameter>
<parameter name="align" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoAlignment</doc>
<type name="VideoAlignment" c:type="GstVideoAlignment*"/>
</parameter>
</parameters>
</function>
<function name="is_video_overlay_prepare_window_handle_message"
c:identifier="gst_is_video_overlay_prepare_window_handle_message">
<doc xml:space="preserve">Convenience function to check if the given message is a
"prepare-window-handle" message from a #GstVideoOverlay.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether @msg is a "prepare-window-handle" message</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #GstMessage</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
</parameters>
</function>
<function name="navigation_event_get_type"
c:identifier="gst_navigation_event_get_type"
moved-to="Navigation.event_get_type">
<doc xml:space="preserve">Inspect a #GstEvent and return the #GstNavigationEventType of the event, or
#GST_NAVIGATION_EVENT_INVALID if the event is not a #GstNavigation event.</doc>
<return-value transfer-ownership="none">
<type name="NavigationEventType" c:type="GstNavigationEventType"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
</parameters>
</function>
<function name="navigation_event_parse_command"
c:identifier="gst_navigation_event_parse_command"
moved-to="Navigation.event_parse_command">
<doc xml:space="preserve">Inspect a #GstNavigation command event and retrieve the enum value of the
associated command.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the navigation command could be extracted, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="command" transfer-ownership="none">
<doc xml:space="preserve">Pointer to GstNavigationCommand to receive the type of the
navigation event.</doc>
<type name="NavigationCommand" c:type="GstNavigationCommand*"/>
</parameter>
</parameters>
</function>
<function name="navigation_event_parse_key_event"
c:identifier="gst_navigation_event_parse_key_event"
moved-to="Navigation.event_parse_key_event">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a location to receive the string identifying the key
press. The returned string is owned by the event, and valid only until the
event is unreffed.</doc>
<type name="utf8" c:type="const gchar**"/>
</parameter>
</parameters>
</function>
<function name="navigation_event_parse_mouse_button_event"
c:identifier="gst_navigation_event_parse_mouse_button_event"
moved-to="Navigation.event_parse_mouse_button_event">
<doc xml:space="preserve">Retrieve the details of either a #GstNavigation mouse button press event or
a mouse button release event. Determine which type the event is using
gst_navigation_event_get_type() to retrieve the #GstNavigationEventType.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if the button number and both coordinates could be extracted,
otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="button" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gint that will receive the button number associated
with the event.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the x coordinate of the mouse button
event.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the y coordinate of the mouse button
event.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
</parameters>
</function>
<function name="navigation_event_parse_mouse_move_event"
c:identifier="gst_navigation_event_parse_mouse_move_event"
moved-to="Navigation.event_parse_mouse_move_event">
<doc xml:space="preserve">Inspect a #GstNavigation mouse movement event and extract the coordinates
of the event.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">TRUE if both coordinates could be extracted, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">A #GstEvent to inspect.</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the x coordinate of the mouse movement.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a gdouble to receive the y coordinate of the mouse movement.</doc>
<type name="gdouble" c:type="gdouble*"/>
</parameter>
</parameters>
</function>
<function name="navigation_message_get_type"
c:identifier="gst_navigation_message_get_type"
moved-to="Navigation.message_get_type">
<doc xml:space="preserve">Check a bus message to see if it is a #GstNavigation event, and return
the #GstNavigationMessageType identifying the type of the message if so.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The type of the #GstMessage, or
#GST_NAVIGATION_MESSAGE_INVALID if the message is not a #GstNavigation
notification.</doc>
<type name="NavigationMessageType" c:type="GstNavigationMessageType"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A #GstMessage to inspect.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
</parameters>
</function>
<function name="navigation_message_new_angles_changed"
c:identifier="gst_navigation_message_new_angles_changed"
moved-to="Navigation.message_new_angles_changed">
<doc xml:space="preserve">Creates a new #GstNavigation message with type
#GST_NAVIGATION_MESSAGE_ANGLES_CHANGED for notifying an application
that the current angle, or current number of angles available in a
multiangle video has changed.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The new #GstMessage.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">A #GstObject to set as source of the new message.</doc>
<type name="Gst.Object" c:type="GstObject*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">The currently selected angle.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">The number of viewing angles now available.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="navigation_message_new_commands_changed"
c:identifier="gst_navigation_message_new_commands_changed"
moved-to="Navigation.message_new_commands_changed">
<doc xml:space="preserve">Creates a new #GstNavigation message with type
#GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The new #GstMessage.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">A #GstObject to set as source of the new message.</doc>
<type name="Gst.Object" c:type="GstObject*"/>
</parameter>
</parameters>
</function>
<function name="navigation_message_new_mouse_over"
c:identifier="gst_navigation_message_new_mouse_over"
moved-to="Navigation.message_new_mouse_over">
<doc xml:space="preserve">Creates a new #GstNavigation message with type
#GST_NAVIGATION_MESSAGE_MOUSE_OVER.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The new #GstMessage.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<doc xml:space="preserve">A #GstObject to set as source of the new message.</doc>
<type name="Gst.Object" c:type="GstObject*"/>
</parameter>
<parameter name="active" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the mouse has entered a clickable area of the display.
%FALSE if it over a non-clickable area.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="navigation_message_parse_angles_changed"
c:identifier="gst_navigation_message_parse_angles_changed"
moved-to="Navigation.message_parse_angles_changed">
<doc xml:space="preserve">Parse a #GstNavigation message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED
and extract the @cur_angle and @n_angles parameters.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the message could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A #GstMessage to inspect.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a #guint to receive the new current angle number,
or NULL</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a #guint to receive the new angle count, or NULL.</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="navigation_message_parse_mouse_over"
c:identifier="gst_navigation_message_parse_mouse_over"
moved-to="Navigation.message_parse_mouse_over">
<doc xml:space="preserve">Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_MOUSE_OVER
and extract the active/inactive flag. If the mouse over event is marked
active, it indicates that the mouse is over a clickable area.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the message could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A #GstMessage to inspect.</doc>
<type name="Gst.Message" c:type="GstMessage*"/>
</parameter>
<parameter name="active" transfer-ownership="none">
<doc xml:space="preserve">A pointer to a gboolean to receive the active/inactive state,
or NULL.</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</function>
<function name="navigation_query_get_type"
c:identifier="gst_navigation_query_get_type"
moved-to="Navigation.query_get_type">
<doc xml:space="preserve">Inspect a #GstQuery and return the #GstNavigationQueryType associated with
it if it is a #GstNavigation query.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The #GstNavigationQueryType of the query, or
#GST_NAVIGATION_QUERY_INVALID</doc>
<type name="NavigationQueryType" c:type="GstNavigationQueryType"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">The query to inspect</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
</parameters>
</function>
<function name="navigation_query_new_angles"
c:identifier="gst_navigation_query_new_angles"
moved-to="Navigation.query_new_angles">
<doc xml:space="preserve">Create a new #GstNavigation angles query. When executed, it will
query the pipeline for the set of currently available angles, which may be
greater than one in a multiangle video.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The new query.</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</return-value>
</function>
<function name="navigation_query_new_commands"
c:identifier="gst_navigation_query_new_commands"
moved-to="Navigation.query_new_commands">
<doc xml:space="preserve">Create a new #GstNavigation commands query. When executed, it will
query the pipeline for the set of currently available commands.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The new query.</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</return-value>
</function>
<function name="navigation_query_parse_angles"
c:identifier="gst_navigation_query_parse_angles"
moved-to="Navigation.query_parse_angles">
<doc xml:space="preserve">Parse the current angle number in the #GstNavigation angles @query into the
#guint pointed to by the @cur_angle variable, and the number of available
angles into the #guint pointed to by the @n_angles variable.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a #guint into which to store the currently selected
angle value from the query, or NULL</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">Pointer to a #guint into which to store the number of angles
value from the query, or NULL</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="navigation_query_parse_commands_length"
c:identifier="gst_navigation_query_parse_commands_length"
moved-to="Navigation.query_parse_commands_length">
<doc xml:space="preserve">Parse the number of commands in the #GstNavigation commands @query.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="n_cmds"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">the number of commands in this query.</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="navigation_query_parse_commands_nth"
c:identifier="gst_navigation_query_parse_commands_nth"
moved-to="Navigation.query_parse_commands_nth">
<doc xml:space="preserve">Parse the #GstNavigation command query and retrieve the @nth command from
it into @cmd. If the list contains less elements than @nth, @cmd will be
set to #GST_NAVIGATION_COMMAND_INVALID.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the query could be successfully parsed. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="nth" transfer-ownership="none">
<doc xml:space="preserve">the nth command to retrieve.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="cmd"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">a pointer to store the nth command into.</doc>
<type name="NavigationCommand" c:type="GstNavigationCommand*"/>
</parameter>
</parameters>
</function>
<function name="navigation_query_set_angles"
c:identifier="gst_navigation_query_set_angles"
moved-to="Navigation.query_set_angles">
<doc xml:space="preserve">Set the #GstNavigation angles query result field in @query.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="cur_angle" transfer-ownership="none">
<doc xml:space="preserve">the current viewing angle to set.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="n_angles" transfer-ownership="none">
<doc xml:space="preserve">the number of viewing angles to set.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="navigation_query_set_commandsv"
c:identifier="gst_navigation_query_set_commandsv"
moved-to="Navigation.query_set_commandsv">
<doc xml:space="preserve">Set the #GstNavigation command query result fields in @query. The number
of commands passed must be equal to @n_commands.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">a #GstQuery</doc>
<type name="Gst.Query" c:type="GstQuery*"/>
</parameter>
<parameter name="n_cmds" transfer-ownership="none">
<doc xml:space="preserve">the number of commands to set.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="cmds" transfer-ownership="none">
<doc xml:space="preserve">An array containing @n_cmds @GstNavigationCommand values.</doc>
<type name="NavigationCommand" c:type="GstNavigationCommand*"/>
</parameter>
</parameters>
</function>
<function name="video_blend" c:identifier="gst_video_blend">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="dest" transfer-ownership="none">
<type name="VideoFrame" c:type="GstVideoFrame*"/>
</parameter>
<parameter name="src" transfer-ownership="none">
<type name="VideoFrame" c:type="GstVideoFrame*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="global_alpha" transfer-ownership="none">
<type name="gfloat" c:type="gfloat"/>
</parameter>
</parameters>
</function>
<function name="video_blend_scale_linear_RGBA"
c:identifier="gst_video_blend_scale_linear_RGBA">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="src" transfer-ownership="none">
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</parameter>
<parameter name="src_buffer" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer*"/>
</parameter>
<parameter name="dest_height" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="dest_width" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="dest" transfer-ownership="none">
<type name="VideoInfo" c:type="GstVideoInfo*"/>
</parameter>
<parameter name="dest_buffer" transfer-ownership="none">
<type name="Gst.Buffer" c:type="GstBuffer**"/>
</parameter>
</parameters>
</function>
<function name="video_calculate_display_ratio"
c:identifier="gst_video_calculate_display_ratio">
<doc xml:space="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.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A boolean indicating success and a calculated Display Ratio in the
dar_n and dar_d parameters.
The return value is FALSE in the case of integer overflow or other error.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="dar_n" transfer-ownership="none">
<doc xml:space="preserve">Numerator of the calculated display_ratio</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="dar_d" transfer-ownership="none">
<doc xml:space="preserve">Denominator of the calculated display_ratio</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="video_width" transfer-ownership="none">
<doc xml:space="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:space="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:space="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:space="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:space="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:space="preserve">Denominator of the pixel aspect ratio of the display device</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="video_chroma_from_string"
c:identifier="gst_video_chroma_from_string">
<doc xml:space="preserve">Convert @s to a #GstVideoChromaSite</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoChromaSite or %GST_VIDEO_CHROMA_SITE_UNKNOWN when @s does
not contain a valid chroma description.</doc>
<type name="VideoChromaSite" c:type="GstVideoChromaSite"/>
</return-value>
<parameters>
<parameter name="s" transfer-ownership="none">
<doc xml:space="preserve">a chromasite string</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="video_chroma_to_string"
c:identifier="gst_video_chroma_to_string">
<doc xml:space="preserve">Converts @site to its string representation.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a string describing @site.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="site" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoChromaSite</doc>
<type name="VideoChromaSite" c:type="GstVideoChromaSite"/>
</parameter>
</parameters>
</function>
<function name="video_color_range_offsets"
c:identifier="gst_video_color_range_offsets"
moved-to="VideoColorRange.offsets">
<doc xml:space="preserve">Compute the offset and scale values for each component of @info. For each
component, (c[i] - offset[i]) / scale[i] will scale the component c[i] to the
range [0.0 .. 1.0].
The reverse operation (c[i] * scale[i]) + offset[i] can be used to convert
the component values in range [0.0 .. 1.0] back to their representation in
@info and @range.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="range" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoColorRange</doc>
<type name="VideoColorRange" c:type="GstVideoColorRange"/>
</parameter>
<parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFormatInfo</doc>
<type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
</parameter>
<parameter name="offset" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="scale"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">output scale</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</function>
<function name="video_convert_sample"
c:identifier="gst_video_convert_sample"
throws="1">
<doc xml:space="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.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The converted #GstSample, or %NULL if an error happened (in which case @err
will point to the #GError).</doc>
<type name="Gst.Sample" c:type="GstSample*"/>
</return-value>
<parameters>
<parameter name="sample" transfer-ownership="none">
<doc xml:space="preserve">a #GstSample</doc>
<type name="Gst.Sample" c:type="GstSample*"/>
</parameter>
<parameter name="to_caps" transfer-ownership="none">
<doc xml:space="preserve">the #GstCaps to convert to</doc>
<type name="Gst.Caps" c:type="const GstCaps*"/>
</parameter>
<parameter name="timeout" transfer-ownership="none">
<doc xml:space="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_sample_async"
c:identifier="gst_video_convert_sample_async">
<doc xml:space="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="sample" transfer-ownership="none">
<doc xml:space="preserve">a #GstSample</doc>
<type name="Gst.Sample" c:type="GstSample*"/>
</parameter>
<parameter name="to_caps" transfer-ownership="none">
<doc xml:space="preserve">the #GstCaps to convert to</doc>
<type name="Gst.Caps" c:type="const GstCaps*"/>
</parameter>
<parameter name="timeout" transfer-ownership="none">
<doc xml:space="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:space="preserve">%GstVideoConvertSampleCallback that will be called after conversion.</doc>
<type name="VideoConvertSampleCallback"
c:type="GstVideoConvertSampleCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="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:space="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_crop_meta_api_get_type"
c:identifier="gst_video_crop_meta_api_get_type">
<return-value transfer-ownership="none">
<type name="GType" c:type="GType"/>
</return-value>
</function>
<function name="video_crop_meta_get_info"
c:identifier="gst_video_crop_meta_get_info"
moved-to="VideoCropMeta.get_info">
<return-value transfer-ownership="none">
<type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
</return-value>
</function>
<function name="video_event_is_force_key_unit"
c:identifier="gst_video_event_is_force_key_unit">
<doc xml:space="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:space="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:space="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">
<doc xml:space="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 transfer-ownership="full">
<doc xml:space="preserve">The new GstEvent</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</return-value>
<parameters>
<parameter name="timestamp" transfer-ownership="none">
<doc xml:space="preserve">the timestamp of the buffer that starts a new key unit</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
<parameter name="stream_time" transfer-ownership="none">
<doc xml:space="preserve">the stream_time of the buffer that starts a new key unit</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
<parameter name="running_time" transfer-ownership="none">
<doc xml:space="preserve">the running_time of the buffer that starts a new key unit</doc>
<type name="Gst.ClockTime" c:type="GstClockTime"/>
</parameter>
<parameter name="all_headers" transfer-ownership="none">
<doc xml:space="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:space="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">
<doc xml:space="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 transfer-ownership="full">
<doc xml:space="preserve">The new GstEvent</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</return-value>
<parameters>
<parameter name="in_still" transfer-ownership="none">
<doc xml:space="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">
<doc xml:space="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 transfer-ownership="full">
<doc xml:space="preserve">The new GstEvent</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</return-value>
<parameters>
<parameter name="running_time" transfer-ownership="none">
<doc xml:space="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:space="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:space="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">
<doc xml:space="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:space="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:space="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:space="preserve">A pointer to the timestamp in the event</doc>
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
<parameter name="stream_time"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">A pointer to the stream-time in the event</doc>
<type name="Gst.ClockTime" c:type="GstClockTime*"/>
</parameter>
<parameter name="running_time"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="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:space="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:space="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">
<doc xml:space="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:space="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:space="preserve">A #GstEvent to parse</doc>
<type name="Gst.Event" c:type="GstEvent*"/>
</parameter>
<parameter name="in_still" transfer-ownership="none">
<doc xml:space="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">
<doc xml:space="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:space="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:space="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:space="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:space="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:space="preserve">A pointer to the count field in the event</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<function name="video_format_from_fourcc"
c:identifier="gst_video_format_from_fourcc"
moved-to="VideoFormat.from_fourcc">
<doc xml:space="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:space="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:space="preserve">a FOURCC value representing raw YUV video</doc>
<type name="guint32" c:type="guint32"/>
</parameter>
</parameters>
</function>
<function name="video_format_from_masks"
c:identifier="gst_video_format_from_masks"
moved-to="VideoFormat.from_masks">
<doc xml:space="preserve">Find the #GstVideoFormat for the given parameters.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFormat or GST_VIDEO_FORMAT_UNKNOWN when the parameters to
not specify a known format.</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</return-value>
<parameters>
<parameter name="depth" transfer-ownership="none">
<doc xml:space="preserve">the amount of bits used for a pixel</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="bpp" transfer-ownership="none">
<doc xml:space="preserve">the amount of bits used to store a pixel. This value is bigger than
@depth</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="endianness" transfer-ownership="none">
<doc xml:space="preserve">the endianness of the masks, #G_LITTLE_ENDIAN or #G_BIG_ENDIAN</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="red_mask" transfer-ownership="none">
<doc xml:space="preserve">the red mask</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="green_mask" transfer-ownership="none">
<doc xml:space="preserve">the green mask</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="blue_mask" transfer-ownership="none">
<doc xml:space="preserve">the blue mask</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="alpha_mask" transfer-ownership="none">
<doc xml:space="preserve">the alpha mask, or 0 if no alpha mask</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="video_format_from_string"
c:identifier="gst_video_format_from_string"
moved-to="VideoFormat.from_string">
<doc xml:space="preserve">Convert the @format string to its #GstVideoFormat.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #GstVideoFormat for @format or GST_VIDEO_FORMAT_UNKNOWN when the
string is not a known format.</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a format string</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="video_format_get_info"
c:identifier="gst_video_format_get_info"
moved-to="VideoFormat.get_info">
<doc xml:space="preserve">Get the #GstVideoFormatInfo for @format</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The #GstVideoFormatInfo for @format.</doc>
<type name="VideoFormatInfo" c:type="const GstVideoFormatInfo*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFormat</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="video_format_to_fourcc"
c:identifier="gst_video_format_to_fourcc"
moved-to="VideoFormat.to_fourcc">
<doc xml:space="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:space="preserve">the FOURCC corresponding to @format</doc>
<type name="guint32" c:type="guint32"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">a #GstVideoFormat video format</doc>
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="video_format_to_string"
c:identifier="gst_video_format_to_string"
moved-to="VideoFormat.to_string">
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="format" transfer-ownership="none">
<type name="VideoFormat" c:type="GstVideoFormat"/>
</parameter>
</parameters>
</function>
<function name="video_gl_texture_upload_meta_api_get_type"
c:identifier="gst_video_gl_texture_upload_meta_api_get_type">
<return-value transfer-ownership="none">
<type name="GType" c:type="GType"/>
</return-value>
</function>
<function name="video_gl_texture_upload_meta_get_info"
c:identifier="gst_video_gl_texture_upload_meta_get_info"
moved-to="VideoGLTextureUploadMeta.get_info">
<return-value transfer-ownership="none">
<type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
</return-value>
</function>
<function name="video_meta_api_get_type"
c:identifier="gst_video_meta_api_get_type">
<return-value transfer-ownership="none">
<type name="GType" c:type="GType"/>
</return-value>
</function>
<function name="video_meta_get_info"
c:identifier="gst_video_meta_get_info"
moved-to="VideoMeta.get_info">
<return-value transfer-ownership="none">
<type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
</return-value>
</function>
<function name="video_meta_transform_scale_get_quark"
c:identifier="gst_video_meta_transform_scale_get_quark"
moved-to="VideoMetaTransform.scale_get_quark">
<doc xml:space="preserve">Get the #GQuark for the "gst-video-scale" metadata transform operation.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #GQuark</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="video_overlay_composition_meta_api_get_type"
c:identifier="gst_video_overlay_composition_meta_api_get_type">
<return-value transfer-ownership="none">
<type name="GType" c:type="GType"/>
</return-value>
</function>
<function name="video_overlay_composition_meta_get_info"
c:identifier="gst_video_overlay_composition_meta_get_info"
moved-to="VideoOverlayCompositionMeta.get_info">
<return-value transfer-ownership="none">
<type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
</return-value>
</function>
<function name="video_region_of_interest_meta_api_get_type"
c:identifier="gst_video_region_of_interest_meta_api_get_type">
<return-value transfer-ownership="none">
<type name="GType" c:type="GType"/>
</return-value>
</function>
<function name="video_region_of_interest_meta_get_info"
c:identifier="gst_video_region_of_interest_meta_get_info"
moved-to="VideoRegionOfInterestMeta.get_info">
<return-value transfer-ownership="none">
<type name="Gst.MetaInfo" c:type="const GstMetaInfo*"/>
</return-value>
</function>
</namespace>
</repository>
|