/usr/include/gmerlin/plugin.h is in libgmerlin-dev 1.2.0~dfsg+1-6.1build1.
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 | /*****************************************************************
* gmerlin - a general purpose multimedia framework and applications
*
* Copyright (c) 2001 - 2011 Members of the Gmerlin project
* gmerlin-general@lists.sourceforge.net
* http://gmerlin.sourceforge.net
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
* *****************************************************************/
#ifndef __BG_PLUGIN_H_
#define __BG_PLUGIN_H_
#include <gavl/gavl.h>
#include <gavl/compression.h>
#include <gmerlin/parameter.h>
#include <gmerlin/streaminfo.h>
#include <gmerlin/accelerator.h>
#include <gmerlin/edl.h>
/** \defgroup plugin Plugins
* \brief Plugin types and associated functions
*
* Gmerlin plugins are structs which contain function pointers and
* other data. The API looks a bit complicated, but many functions are
* optional, so plugins can, in prinpiple, be very simple.
* All plugins are based on a common struct (\ref bg_plugin_common_t),
* which contains an identifier for the plugin type. The bg_plugin_common_t
* pointer can be casted to the derived plugin types.
*
* The application calls the functions in the order, in which they are
* defined. Some functions are mandatory from the plugin view (i.e. they
* must be non-null), some functions are mandatory for the application
* (i.e. the application must check for them and call them if they are
* present.
*
* The configuration of the plugins works entirely through the
* parameter passing mechanisms (see \ref parameter). Configurable
* plugins only need to define get_parameters and set_parameter methods.
* Encoding plugins have an additional layer, which allows setting
* parameters individually for each stream.
*
* Events, which are caught by the plugins (e.g. song name changes or
* mouse clicks) are propagated through optional callbacks.
* These are passed from the application to the plugin with the
* set_callbacks function.
* Applications should not rely on any callback to be actually supported by
* a plugin. Plugins should not rely on the presence of any callback
*/
/** \ingroup plugin
* \brief Generic prototype for reading audio
* \param priv Private data
* \param frame Audio frame
* \param stream Stream index (0 is only one stream)
* \param samples Samples to read
* \returns The number of samples read
*
* This is a generic prototype for reading audio. It's shared between
* input pluigns, recorders and filters to enable arbitrary chaining.
*/
typedef int (*bg_read_audio_func_t)(void * priv, gavl_audio_frame_t* frame,
int stream,
int num_samples);
/** \ingroup plugin
* \brief Generic prototype for reading video
* \param priv Private data
* \param frame Video frame
* \param stream Stream index (0 is only one stream)
* \returns 1 if a frame could be read, 0 else
*
* This is a generic prototype for reading audio. It's shared between
* input pluigns, recorders and filters to enable arbitrary chaining.
*/
typedef int (*bg_read_video_func_t)(void * priv, gavl_video_frame_t* frame,
int stream);
/** \defgroup plugin_flags Plugin flags
* \ingroup plugin
* \brief Macros for the plugin flags
*
*
* All plugins must have at least one flag set.
* @{
*/
#define BG_PLUGIN_REMOVABLE (1<<0) //!< Plugin handles removable media (CD, DVD etc.)
#define BG_PLUGIN_FILE (1<<1) //!< Plugin reads/writes files
#define BG_PLUGIN_RECORDER (1<<2) //!< Plugin does hardware recording
#define BG_PLUGIN_URL (1<<3) //!< Plugin can load URLs
#define BG_PLUGIN_PLAYBACK (1<<4) //!< Plugin is an audio or video driver for playback
#define BG_PLUGIN_STDIN (1<<8) //!< Plugin can read from stdin ("-")
#define BG_PLUGIN_TUNER (1<<9) //!< Plugin has some kind of tuner. Channels will be loaded as tracks.
#define BG_PLUGIN_FILTER_1 (1<<10) //!< Plugin acts as a filter with one input
#define BG_PLUGIN_EMBED_WINDOW (1<<11) //!< Plugin can embed it's window into another application
#define BG_PLUGIN_VISUALIZE_FRAME (1<<12) //!< Visualization plugin outputs video frames
#define BG_PLUGIN_VISUALIZE_GL (1<<13) //!< Visualization plugin outputs via OpenGL
#define BG_PLUGIN_PP (1<<14) //!< Postprocessor
#define BG_PLUGIN_CALLBACKS (1<<15) //!< Plugin can be opened from callbacks
#define BG_PLUGIN_BROADCAST (1<<16) //!< Plugin can broadcasts (e.g. webstreams)
#define BG_PLUGIN_DEVPARAM (1<<17) //!< Plugin has pluggable devices as parameters, which must be updated regurarly
#define BG_PLUGIN_UNSUPPORTED (1<<24) //!< Plugin is not supported. Only for a foreign API plugins
#define BG_PLUGIN_ALL 0xFFFFFFFF //!< Mask of all possible plugin flags
/** @}
*/
#define BG_PLUGIN_API_VERSION 26
/* Include this into all plugin modules exactly once
to let the plugin loader obtain the API version */
#define BG_GET_PLUGIN_API_VERSION \
int get_plugin_api_version() __attribute__ ((visibility("default"))); \
int get_plugin_api_version() { return BG_PLUGIN_API_VERSION; }
#define BG_PLUGIN_PRIORITY_MIN 1
#define BG_PLUGIN_PRIORITY_MAX 10
/** \defgroup plugin_i Media input
* \ingroup plugin
* \brief Media input
*/
/** \ingroup plugin_i
* \brief Stream actions
*
* These describe how streams should be handled by the input
* plugin. Note that by default, each stream is switched off.
*/
typedef enum
{
BG_STREAM_ACTION_OFF = 0, //!< Stream is switched off and will be ignored
BG_STREAM_ACTION_DECODE, //!< Stream is switched on and will be decoded
BG_STREAM_ACTION_READRAW, //!< Stream will be read in compressed form
} bg_stream_action_t;
/***************************************************
* Plugin API
*
* Plugin dlls contain a symbol "the_plugin",
* which points to one of the structures below.
* The member functions are described below.
*
***************************************************/
/*
* Plugin types
*/
/** \ingroup plugin
* \brief Plugin types
*/
typedef enum
{
BG_PLUGIN_NONE = 0, //!< None or undefined
BG_PLUGIN_INPUT = (1<<0), //!< Media input
BG_PLUGIN_OUTPUT_AUDIO = (1<<1), //!< Audio output
BG_PLUGIN_OUTPUT_VIDEO = (1<<2), //!< Video output
BG_PLUGIN_RECORDER_AUDIO = (1<<3), //!< Audio recorder
BG_PLUGIN_RECORDER_VIDEO = (1<<4), //!< Video recorder
BG_PLUGIN_ENCODER_AUDIO = (1<<5), //!< Encoder for audio only
BG_PLUGIN_ENCODER_VIDEO = (1<<6), //!< Encoder for video only
BG_PLUGIN_ENCODER_SUBTITLE_TEXT = (1<<7), //!< Encoder for text subtitles only
BG_PLUGIN_ENCODER_SUBTITLE_OVERLAY = (1<<8), //!< Encoder for overlay subtitles only
BG_PLUGIN_ENCODER = (1<<9), //!< Encoder for multiple kinds of streams
BG_PLUGIN_ENCODER_PP = (1<<10),//!< Encoder postprocessor (e.g. CD burner)
BG_PLUGIN_IMAGE_READER = (1<<11),//!< Image reader
BG_PLUGIN_IMAGE_WRITER = (1<<12), //!< Image writer
BG_PLUGIN_FILTER_AUDIO = (1<<13), //!< Audio filter
BG_PLUGIN_FILTER_VIDEO = (1<<14), //!< Video filter
BG_PLUGIN_VISUALIZATION = (1<<15), //!< Visualization
BG_PLUGIN_AV_RECORDER = (1<<16), //!< Audio/Video recorder
} bg_plugin_type_t;
/** \ingroup plugin
* \brief Device description
*
* The find_devices() function of a plugin returns
* a NULL terminated array of devices. It's used mainly for input plugins,
* which access multiple drives. For output plugins, devices are normal parameters.
*/
typedef struct
{
char * device; //!< String, which can be passed to the open() method
char * name; //!< More humanized description, might be NULL
} bg_device_info_t;
/** \ingroup plugin
* \brief Append device info to an existing array and return the new array.
* \param arr An array (can be NULL)
* \param device Device string
* \param name Humanized description (can be NULL)
* \returns Newly allocated array. The source array is freed.
*
* This is used mainly by the device detection routines of the plugins
*/
bg_device_info_t * bg_device_info_append(bg_device_info_t * arr,
const char * device,
const char * name);
/** \ingroup plugin
* \brief Free an array of device descriptions
* \param arr a device array
*/
void bg_device_info_destroy(bg_device_info_t * arr);
/* Common part */
/** \ingroup plugin
* \brief Typedef for base structure common to all plugins
*/
typedef struct bg_plugin_common_s bg_plugin_common_t;
/** \ingroup plugin
* \brief Base structure common to all plugins
*/
struct bg_plugin_common_s
{
char * gettext_domain; //!< First argument for bindtextdomain().
char * gettext_directory; //!< Second argument for bindtextdomain().
char * name; //!< Unique short name
char * long_name; //!< Humanized name for GUI widgets
bg_plugin_type_t type; //!< Type
int flags; //!< Flags (see defines)
char * description; //!< Textual description
/*
* If there might be more than one plugin for the same
* job, there is a priority (0..10) which is used for the
* decision
*/
int priority; //!< Priority (between 1 and 10).
/** \brief Create the instance, return handle.
* \returns A private handle, which is the first argument to all subsequent functions.
*/
void * (*create)();
/** \brief Destroy plugin instance
* \param priv The handle returned by the create() method
*
* Destroy everything, making it ready for dlclose()
* This function might also be called on opened plugins,
* so the plugins should call their close()-function from
* within the destroy method.
*/
void (*destroy)(void* priv);
/** \brief Get available parameters
* \param priv The handle returned by the create() method
* \returns a NULL terminated parameter array.
*
* The returned array is owned (an should be freed) by the plugin.
*/
const bg_parameter_info_t * (*get_parameters)(void * priv);
/** \brief Set configuration parameter (optional)
*/
bg_set_parameter_func_t set_parameter;
/** \brief Get configuration parameter (optional)
*
* This must only return parameters, which are changed internally
* by the plugins.
*/
bg_get_parameter_func_t get_parameter;
/** \brief Check, if a device can be opened by the plugin (optional)
* \param device The device as passed to the open() method
* \param name Returns the name if available
* \returns 1 if the device is supported, 0 else
*
* The name should be set to NULL before this call, and must be freed
* if it's non-NULL after the call.
*/
int (*check_device)(const char * device, char ** name);
/** \brief Get an array of all supported devices found on the system
* \returns A NULL terminated device array
*
* The returned array must be freed with \ref bg_device_info_destroy by
* the caller.
*/
bg_device_info_t * (*find_devices)();
};
/*
* Plugin callbacks: Functions called by the
* plugin to reflect user input or other changes
* Applications might pass NULL callbacks,
* so plugins MUST check for valid callbacks structure
* before calling any of these functions
*/
/* Input plugin */
/** \ingroup plugin_i
* \brief typedef for input callbacks
*
*/
typedef struct bg_input_callbacks_s bg_input_callbacks_t;
/** \ingroup plugin_i
* \brief Callbacks for input plugins
*
* Passing the callback structure to the plugin is optional. Futhermore,
* any of the callback functions is optional (i.e. can be NULL). The plugin
* might use the callbacks for propagating events.
*/
struct bg_input_callbacks_s
{
/** \brief Duration changed
* \param data The data member of this bg_input_callbacks_s struct
* \param time The new duration
*/
void (*duration_changed)(void * data, gavl_time_t duration);
/** \brief Name changed
* \param data The data member of this bg_input_callbacks_s struct
* \param time The new name
*
* This is for web-radio stations, which send song-names.
*/
void (*name_changed)(void * data, const char * name);
/** \brief Metadata changed
* \param data The data member of this bg_input_callbacks_s struct
* \param m The new metadata
*
* This is for web-radio stations, which send metadata for each song.
*/
void (*metadata_changed)(void * data, const gavl_metadata_t * m);
/** \brief Buffer callback
* \param data The data member of this bg_input_callbacks_s struct
* \param percentage The buffer fullness (0.0..1.0)
*
* For network connections, plugins might buffer data. This takes some time,
* so they notify the API about the progress with this callback.
*/
void (*buffer_notify)(void * data, float percentage);
/** \brief Authentication callback
* \param data The data member of this bg_input_callbacks_s struct
* \param resource Name of the resource (e.g. server name)
* \param username Returns the username
* \param password Returns the password
* \returns 1 if username and password are available, 0 else.
*
* For sources, which require authentication (like FTP servers), this
* function is called by the plugin to get username and password.
* Username and password must be returned in newly allocated strings, which
* will be freed by the plugin.
*/
int (*user_pass)(void * data, const char * resource,
char ** username, char ** password);
/** \brief Aspect ratio change callback
* \param data The data member of this bg_input_callbacks_s struct
* \param stream Video stream index (starts with 0)
* \param pixel_width New pixel width
* \param pixel_height New pixel height
*
* Some streams (e.g. DVB) change the pixel aspect ratio on the fly.
* If the input plugin detects such a change, it should call this
* callback.
*/
void (*aspect_changed)(void * data, int stream,
int pixel_width, int pixel_height);
void * data; //!< Application specific data passed as the first argument to all callbacks.
};
/*************************************************
* MEDIA INPUT
*************************************************/
/** \ingroup plugin_i
* \brief Typedef for input plugin
*/
typedef struct bg_input_plugin_s bg_input_plugin_t;
/** \ingroup plugin_i
* \brief Input plugin
*
* This is for all kinds of media inputs (files, disks, urls, etc), except recording from
* hardware devices (see \ref plugin_r).
*
*
*/
struct bg_input_plugin_s
{
bg_plugin_common_t common; //!< Infos and functions common to all plugin types
/** \brief Get supported protocols
* \param priv The handle returned by the create() method
* \returns A space separated list of protocols
*/
const char * (*get_protocols)(void * priv);
/** \brief Get supported mimetypes
* \param priv The handle returned by the create() method
* \returns A space separated list of mimetypes
*/
const char * (*get_mimetypes)(void * priv);
/** \brief Get supported extensions
* \param priv The handle returned by the create() method
* \returns A space separated list of extensions
*/
const char * (*get_extensions)(void * priv);
/** \brief Set callbacks
* \param priv The handle returned by the create() method
* \param callbacks Callback structure initialized by the caller before
*
* Set callback functions, which will be called by the plugin.
* Defining as well as calling this function is optional. Any of the
* members of callbacks can be NULL.
*/
void (*set_callbacks)(void * priv, bg_input_callbacks_t * callbacks);
/** \brief Open file/url/device
* \param priv The handle returned by the create() method
* \param arg Filename, URL or device name
* \returns 1 on success, 0 on failure
*/
int (*open)(void * priv, const char * arg);
/** \brief Open plugin from filedescriptor (optional)
* \param priv The handle returned by the create() method
* \param fd Open filedescriptor
* \param total_bytes Totally available bytes or 0 if unknown
* \param mimetype Mimetype from http header (or NULL)
* \returns 1 on success, 0 on failure
*/
int (*open_fd)(void * priv, int fd, int64_t total_bytes,
const char * mimetype);
/** \brief Open plugin with callbacks (optional)
* \param priv The handle returned by the create() method
* \param read_callback Callback for reading data
* \param seek_callback Callback for seeking
* \param cb_priv Private argument for the callbacks
* \param filename The filename of the input or NULL if this info is not known.
* \param mimetype The mimetype of the input or NULL if this info is not known.
* \param total_bytes total number of bytes or 0 if this info is not known.
* \returns 1 on success, 0 on failure
*/
int (*open_callbacks)(void * priv,
int (*read_callback)(void * priv, uint8_t * data, int len),
int64_t (*seek_callback)(void * priv, uint64_t pos, int whence),
void * cb_priv, const char * filename, const char * mimetype,
int64_t total_bytes);
/** \brief Get the edl (optional)
* \param priv The handle returned by the create() method
* \returns The edl if any
*/
const bg_edl_t * (*get_edl)(void * priv);
/** \brief Get the disc name (optional)
* \param priv The handle returned by the create() method
* \returns The name of the disc if any
*
* This is only for plugins, which access removable discs (e.g. CDs).
*/
const char * (*get_disc_name)(void * priv);
/** \brief Eject disc (optional)
* \param priv The handle returned by the create() method
* \returns 1 if eject was successful
*
* This is only for plugins, which access removable discs (e.g. CDs).
* \todo This function doesn't work reliably now. Either fix or remove this
*/
int (*eject_disc)(const char * device);
/** \brief Get the number of tracks
* \param priv The handle returned by the create() method
* \returns The number of tracks
*
* This can be NULL for plugins, which support just one track.
*/
int (*get_num_tracks)(void * priv);
/** \brief Return information about a track
* \param priv The handle returned by the create() method
* \param track Track index starting with 0
* \returns The track info
*
* The following fields MUST be valid after this call:
* - num_audio_streams
* - num_video_streams
* - num_subtitle_streams
* - duration
* - Name (If NULL, the filename minus the suffix will be used)
*
* Other data, especially audio and video formats, will become valid after the
* start() call (see below).
*/
bg_track_info_t * (*get_track_info)(void * priv, int track);
/** \brief Set the track to be played
* \param priv The handle returned by the create() method
* \param track Track index starting with 0
*
* This has to be defined even if the plugin doesn't support
* multiple tracks. In addition to selecting the track,
* the plugin should also reset it's internal state such
* that streams can newly be selected.
*/
int (*set_track)(void * priv, int track);
/** \brief Get the compression info of an audio stream
* \param priv The handle returned by the create() method
* \param stream Stream index starting with 0
* \param info Returns the compression info
* \returns 1 if the compression info was returned, 0 if the stream cannot be output in compressed form
*
* The returned compression info should be freed with
* \ref gavl_compression_info_free
*/
int (*get_audio_compression_info)(void * priv, int stream,
gavl_compression_info_t * info);
/** \brief Get the compression info of a video stream
* \param priv The handle returned by the create() method
* \param stream Stream index starting with 0
* \param info Returns the compression info
* \returns 1 if the compression info was returned, 0 if the stream cannot be output in compressed form
*
* The returned compression info should be freed with
* \ref gavl_compression_info_free
*/
int (*get_video_compression_info)(void * priv, int stream,
gavl_compression_info_t * info);
/*
* These functions set the audio- video- and subpicture streams
* as well as programs (== DVD Angles). All these start with 0
*
* Arguments for actions are defined in the enum bg_stream_action_t
* above. Plugins must return FALSE on failure (e.g. no such stream)
*
* Functions must be defined only, if the corresponding stream
* type is supported by the plugin and can be switched.
* Single stream plugins can leave these NULL
* Gmerlin will never try to call these functions on nonexistent streams
*/
/** \brief Setup audio stream
* \param priv The handle returned by the create() method
* \param stream Stream index starting with 0
* \param action What to do with the stream
* \returns 1 on success, 0 on failure
*/
int (*set_audio_stream)(void * priv, int stream, bg_stream_action_t action);
/** \brief Setup video stream
* \param priv The handle returned by the create() method
* \param stream Stream index starting with 0
* \param action What to do with the stream
* \returns 1 on success, 0 on failure
*/
int (*set_video_stream)(void * priv, int stream, bg_stream_action_t action);
/** \brief Setup subtitle stream
* \param priv The handle returned by the create() method
* \param stream Stream index starting with 0
* \param action What to do with the stream
* \returns 1 on success, 0 on failure
*/
int (*set_subtitle_stream)(void * priv, int stream, bg_stream_action_t action);
/** \brief Start decoding
* \param priv The handle returned by the create() method
* \returns 1 on success, 0 on error
*
* After this call, all remaining members of the track info returned earlier
* (especially audio- and video formats) must be valid.
*
* From the plugins point of view, this is the last chance to return 0
* if something fails
*/
int (*start)(void * priv);
/** \brief Get frame table
* \param priv The handle returned by the create() method
* \param stream Stream index (starting with 0)
* \returns A newly allocated frame table or NULL
*
* The returned frame table must be freed with
* \ref gavl_frame_table_destroy.
*/
gavl_frame_table_t * (*get_frame_table)(void * priv, int stream);
/** \brief Read audio samples
* \param priv The handle returned by the create() method
* \param frame The frame, where the samples will be copied
* \param stream Stream index starting with 0
* \param num_samples Number of samples
* \returns The number of decoded samples, 0 means EOF.
*
* The num_samples argument can be larger than the samples_per_frame member of the
* video format. This means, that all audio decoding plugins must have an internal
* buffering mechanism.
*/
bg_read_audio_func_t read_audio;
/** \brief Check is a still image is available
* \param priv The handle returned by the create() method
* \param stream Stream index starting with 0
* \returns 1 if a still frame can be decoded, 0 else.
*
* If EOF occurs in still streams, this function will return
* 1, but the subsequent call to read_video returns 0
*/
int (*has_still)(void * priv, int stream);
/** \brief Read a video frame
* \param priv The handle returned by the create() method
* \param frame The frame, where the image will be copied
* \param stream Stream index starting with 0
* \returns 1 if a frame was decoded, 0 means EOF.
*/
bg_read_video_func_t read_video;
/** \brief Read compressed audio packet
* \param priv The handle returned by the create() method
* \param stream Stream index (starting with 0)
* \param p Returns the packet
* \returns 1 if a packet was read, 0 else
*
* You can pass the same packet multiple times to a read fuction.
* Use \ref gavl_packet_free when it's no longer used.
*/
int (*read_audio_packet)(void * priv, int stream, gavl_packet_t * p);
/** \brief Read compressed video packet
* \param priv The handle returned by the create() method
* \param stream Stream index (starting with 0)
* \param p Returns the packet
* \returns 1 if a packet was read, 0 else
*
* You can pass the same packet multiple times to a read fuction.
* Use \ref gavl_packet_free when it's no longer used.
*/
int (*read_video_packet)(void * priv, int stream, gavl_packet_t * p);
/** \brief Skip frames in a video stream
\param stream Stream index (starting with 0)
\param time The time to skip to (will be changed to the true time)
\param scale Scale by which the time is scaled
\param exact 1 if an exact skip should be done, 0 for faster approximate skip
Use this function if it turns out, that the machine is too weak to
decode all frames. Set exact to 0 to make the skipping even faster
but less accurate.
*/
void (*skip_video)(void * priv, int stream, int64_t * time, int scale, int exact);
/** \brief Query if a new subtitle is available
* \param priv The handle returned by the create() method
* \param stream Stream index starting with 0
* \returns 1 if a subtitle is available, 0 else.
*/
int (*has_subtitle)(void * priv, int stream);
/** \brief Read one pixmap subtitle
* \param priv The handle returned by the create() method
* \param ovl Where the overlay will be copied
* \param stream Stream index starting with 0
* \returns 1 if a subtitle was decoded, 0 else
*
* EOF in a graphical subtitle stream is reached if
* - has_subtitle() returned 1 and
* - read_subtitle_overlay() returned 0
*/
int (*read_subtitle_overlay)(void * priv,
gavl_overlay_t*ovl, int stream);
/** \brief Read one text subtitle
* \param priv The handle returned by the create() method
* \param text Where the text will be copied, the buffer will be realloc()ed.
* \param text_alloc Allocated bytes for text. Will be updated by the function.
* \param start_time Returns the start time of the subtitle
* \param duration Returns the duration of the subtitle
* \param stream Stream index starting with 0
* \returns 1 if a subtitle was decoded, 0 else
*
* EOF in a text subtitle stream is reached if
* - has_subtitle() returned 1 and
* - read_subtitle_text() returned 0
*
* This function automatically handles the text buffer (and text_alloc).
* Just set both to zero before the first call and free() the text buffer
* after the last call (if non-NULL).
*/
int (*read_subtitle_text)(void * priv,
char ** text, int * text_alloc,
int64_t * start_time,
int64_t * duration, int stream);
/** \brief Seek within a media track
* \param priv The handle returned by the create() method
* \param time Time to seek to
* \param scale Timescale
*
* Media streams are supposed to be seekable, if this
* function is non-NULL AND the duration field of the track info
* is > 0 AND the seekable flag in the track info is nonzero.
* The time argument might be changed to the correct value
*/
void (*seek)(void * priv, int64_t * time, int scale);
/** \brief Stop playback
* \param priv The handle returned by the create() method
*
* This is used for plugins in bypass mode to stop playback.
* The plugin can be started again after
*/
void (*stop)(void * priv);
/** \brief Close plugin
* \param priv The handle returned by the create() method
*
* Close the file/device/url.
*/
void (*close)(void * priv);
};
/** \defgroup plugin_oa Audio output
* \ingroup plugin
* \brief Audio output
*/
/** \ingroup plugin_oa
* \brief Typedef for audio output plugin
*/
typedef struct bg_oa_plugin_s bg_oa_plugin_t;
/** \ingroup plugin_oa
* \brief Audio output plugin
*
* This plugin type implements audio playback through a soundcard.
*/
struct bg_oa_plugin_s
{
bg_plugin_common_t common; //!< Infos and functions common to all plugin types
/** \brief Open plugin
* \param priv The handle returned by the create() method
* \param format The format of the media source
*
* The format will be changed to the nearest format, which is supported
* by the plugin. To convert the source format to the output format,
* use a \ref gavl_audio_converter_t
*/
int (*open)(void * priv, gavl_audio_format_t* format);
/** \brief Start playback
* \param priv The handle returned by the create() method
*
* Notify the plugin, that audio playback is about to begin.
*/
int (*start)(void * priv);
/** \brief Write audio samples
* \param priv The handle returned by the create() method
* \param frame The audio frame to write.
*/
void (*write_audio)(void * priv, gavl_audio_frame_t* frame);
/** \brief Get the number of buffered audio samples
* \param priv The handle returned by the create() method
* \returns The number of buffered samples (both soft- and hardware)
*
* This function is used for A/V synchronization with the soundcard. If this
* function is NULL, software synchronization will be used
*/
int (*get_delay)(void * priv);
/** \brief Stop playback
* \param priv The handle returned by the create() method
*
* Notify the plugin, that playback will stop. Playback can be starzed again with
* start().
*/
void (*stop)(void * priv);
/** \brief Close plugin
* \param priv The handle returned by the create() method
*
* Close the plugin. After this call, the plugin can be opened with another format
*/
void (*close)(void * priv);
};
/*******************************************
* AUDIO RECORDER
*******************************************/
/** \defgroup plugin_r Recorder
* \ingroup plugin
* \brief Recorder
*/
typedef struct bg_recorder_callbacks_s bg_recorder_callbacks_t;
/** \ingroup plugin_r
* \brief Callbacks for recorder plugins
*
* Passing the callback structure to the plugin is optional. Futhermore,
* any of the callback functions is optional (i.e. can be NULL). The plugin
* might use the callbacks for propagating events.
*/
struct bg_recorder_callbacks_s
{
/** \brief Name changed
* \param data The data member of this bg_input_callbacks_s struct
* \param name The new name
* \param metadata The new metadata
*
* This is for web-radio stations, which send song-names.
*/
void (*metadata_changed)(void * data, const char * name,
const gavl_metadata_t * m);
void * data; //!< Application specific data passed as the first argument to all callbacks.
};
/** \ingroup plugin_r
* \brief Typedef for recorder
*/
typedef struct bg_recorder_plugin_s bg_recorder_plugin_t;
/** \ingroup plugin_ra
* \brief Recorder
*
* Recording support from hardware devices
*/
struct bg_recorder_plugin_s
{
bg_plugin_common_t common; //!< Infos and functions common to all plugin types
/** \brief Set callbacks
* \param priv The handle returned by the create() method
* \param callbacks Callback structure initialized by the caller before
*
* Set callback functions, which will be called by the plugin.
* Defining as well as calling this function is optional. Any of the
* members of callbacks can be NULL.
*/
void (*set_callbacks)(void * priv, bg_recorder_callbacks_t * callbacks);
/** \brief Open plugin
* \param priv The handle returned by the create() method
* \param format The desired format
*
* The format will be changed to the nearest format, which is supported
* by the plugin. To convert the source format to the output format,
* use a \ref gavl_audio_converter_t
*/
int (*open)(void * priv, gavl_audio_format_t * audio_format,
gavl_video_format_t * video_format);
/** \brief Read audio samples
*/
bg_read_audio_func_t read_audio;
/** \brief Read video frame
*/
bg_read_video_func_t read_video;
/** \brief Close plugin
* \param priv The handle returned by the create() method
*/
void (*close)(void * priv);
};
/*******************************************
* VIDEO OUTPUT
*******************************************/
/* Callbacks */
/** \defgroup plugin_ov Video output
* \ingroup plugin
* \brief Video output
*/
/** \ingroup plugin_ov
* \brief Typedef for callbacks for the video output plugin
*
*/
typedef struct bg_ov_callbacks_s bg_ov_callbacks_t;
/** \ingroup plugin_ov
* \brief Callbacks for the video output plugin
*
*/
struct bg_ov_callbacks_s
{
/** \brief Accelerator map
*
* These contain accelerator keys, which get reported
* through the accel_callback
*/
const bg_accelerator_map_t * accel_map;
/** \brief Keyboard callback
* \param data The data member of this bg_ov_callbacks_s struct
* \param id The accelerator ID
*/
int (*accel_callback)(void * data, int id);
/** \brief Keyboard callback
* \param data The data member of this bg_ov_callbacks_s struct
* \param key Key code (see \ref keycodes)
* \param mask Modifier mask (see \ref keycodes)
* \returns 1 if the event should further be processed, 0 else
*
* Although key_callback and accel_callback can be used at the same
* time, accelerator_callback is preferred, because it allows registering
* keyboard shortcuts in advance. This makes things more reliable, if
* different modules (e.g. embedded visualization plugins) also want to
* receive keybords events·
*/
int (*key_callback)(void * data, int key, int mask);
/** \brief Keyboard release callback
* \param data The data member of this bg_ov_callbacks_s struct
* \param key Key code (see \ref keycodes)
* \param mask Modifier mask (see \ref keycodes)
* \returns 1 if the event should further be processed, 0 else
*/
int (*key_release_callback)(void * data, int key, int mask);
/** \brief Mouse button callback
* \param data The data member of this bg_ov_callbacks_s struct
* \param x Horizontal cursor position in image coordinates
* \param y Vertical cursor position in image coordinates
* \param button Number of the mouse button, which was pressed (starting with 1)
* \param mask State mask
* \returns 1 if the event should further be processed, 0 else
*/
int (*button_callback)(void * data, int x, int y, int button, int mask);
/** \brief Mouse button release callback
* \param data The data member of this bg_ov_callbacks_s struct
* \param x Horizontal cursor position in image coordinates
* \param y Vertical cursor position in image coordinates
* \param button Number of the mouse button, which was pressed (starting with 1)
* \param mask State mask
* \returns 1 if the event should further be processed, 0 else
*/
int (*button_release_callback)(void * data, int x, int y, int button, int mask);
/** \brief Motion callback
* \param data The data member of this bg_ov_callbacks_s struct
* \param x Horizontal cursor position in image coordinates
* \param y Vertical cursor position in image coordinates
* \param mask State mask
* \returns 1 if the event should further be processed, 0 else
*/
int (*motion_callback)(void * data, int x, int y, int mask);
/** \brief Show/hide callback
* \param data The data member of this bg_ov_callbacks_s struct
* \param show 1 if the window is shown now, 0 if it is hidden.
*/
void (*show_window)(void * data, int show);
/** \brief Brightness change callback
* \param data The data member of this bg_ov_callbacks_s struct
* \param val New value (0.0..1.0)
*
* This callback can be used to update OSD when the brightness changed.
*/
void (*brightness_callback)(void * data, float val);
/** \brief Saturation change callback
* \param data The data member of this bg_ov_callbacks_s struct
* \param val New value (0.0..1.0)
*
* This callback can be used to update OSD when the saturation changed.
*/
void (*saturation_callback)(void * data, float val);
/** \brief Contrast change callback
* \param data The data member of this bg_ov_callbacks_s struct
* \param val New value (0.0..1.0)
*
* This callback can be used to update OSD when the contrast changed.
*/
void (*contrast_callback)(void * data, float val);
/** \brief Hue change callback
* \param data The data member of this bg_ov_callbacks_s struct
* \param val New value (0.0..1.0)
*
* This callback can be used to update OSD when the hue changed.
*/
void (*hue_callback)(void * data, float val);
void * data;//!< Application specific data passed as the first argument to all callbacks.
};
/* Plugin structure */
/** \ingroup plugin_ov
* \brief Typedef for video output plugin
*/
typedef struct bg_ov_plugin_s bg_ov_plugin_t;
/** \ingroup plugin_ov
* \brief Video output plugin
*
* This handles video output and still-image display.
* In a window based system, it will typically open a new window,
* which is owned by the plugin.
*/
struct bg_ov_plugin_s
{
bg_plugin_common_t common; //!< Infos and functions common to all plugin types
/** \brief Set window
* \param priv The handle returned by the create() method
* \param window Window identifier
*
* Call this immediately after creation of the plugin to embed
* video output into a foreign application.
* For X11, the window identifier has the form
* \<display_name\>:\<normal_id\>:\<fullscreen_id\>.
*/
void (*set_window)(void * priv, const char * window_id);
/** \brief Get window
* \param priv The handle returned by the create() method
* \returns Window identifier
*/
const char * (*get_window)(void * priv);
/** \brief Set window class
* \param priv The handle returned by the create() method
* \param name The name of the window
* \param klass The class of the window
*
* This makes sense probably only in an X11 environment.
* If the klass argument is the same for all windows of an
* application, they, might be grouped together in the
* window list. On X11 this results in a call to
* XSetClassHint().
*/
void (*set_window_options)(void * priv, const char * name,
const char * klass,
const gavl_video_frame_t * icon,
const gavl_video_format_t * icon_format);
/** \brief Set window title
* \param priv The handle returned by the create() method
* \param title The title for the window
*/
void (*set_window_title)(void * priv, const char * title);
/** \brief Set callbacks
* \param priv The handle returned by the create() method
* \param callbacks Callback structure initialized by the caller before
*/
void (*set_callbacks)(void * priv, bg_ov_callbacks_t * callbacks);
/** \brief Open plugin
* \param priv The handle returned by the create() method
* \param format Video format
* \param window_title Window title
*
* The format will be changed to the nearest format, which is supported
* by the plugin. To convert the source format to the output format,
* use a \ref gavl_video_converter_t
*/
int (*open)(void * priv, gavl_video_format_t * format, int keep_aspect);
/** \brief Get a video frame for filling with data
* \param priv The handle returned by the create() method
*/
gavl_video_frame_t * (*get_frame)(void * priv);
/** \brief Add a stream for transparent overlays
* \param priv The handle returned by the create() method
* \param format Format of the overlays
* \returns The index of the overlay stream
*
* It's up to the plugin, if they are realized in hardware or
* with a gavl_overlay_blend_context_t, but they must be there.
* add_overlay_stream() must be called after open()
*
* An application can have more than one overlay stream. Typical
* is one for subtitles and one for OSD.
*/
int (*add_overlay_stream)(void * priv, gavl_video_format_t * format);
/** \brief Allocate an overlay
* \param priv The handle returned by the create() method
* \param id The id returned by the add_overlay_stream() method
* \returns a newly allocated overlay
*
* This optional method allocates an overlay in a plugin specific manner
* (e.g. in a shared memory segment). If this funtion is defined, all overlays
* which are passed to the plugin, must be allocated by this function.
* Before the plugin is closed, all created overlays must be freed with
* the destroy_overlay() method.
*/
gavl_overlay_t * (*create_overlay)(void * priv, int id);
/** \brief Set an overlay for a specific stream
* \param priv The handle returned by the create() method
* \param stream Stream index returned by add_overlay_stream()
* \param ovl New overlay or NULL
*/
void (*set_overlay)(void * priv, int stream, gavl_overlay_t * ovl);
/** \brief Display a frame of a video stream
* \param priv The handle returned by the create() method
* \param frame Frame to display
*
* This is for video playback
*/
void (*put_video)(void * priv, gavl_video_frame_t*frame);
/** \brief Display a still image
* \param priv The handle returned by the create() method
* \param frame Frame to display
*
* This function is like put_video() with the difference, that
* the frame will be remembered and redisplayed, when an expose event
* is received.
*/
void (*put_still)(void * priv, gavl_video_frame_t*frame);
/** \brief Get all events from the queue and handle them
* \param priv The handle returned by the create() method
*
* This function processes and handles all events, which were
* received from the windowing system. It calls mouse and key-callbacks,
* and redisplays the image when in still mode.
*/
void (*handle_events)(void * priv);
/** \brief Update aspect ratio
* \param priv The handle returned by the create() method
* \param pixel_width New pixel width
* \param pixel_height New pixel height
*/
void (*update_aspect)(void * priv, int pixel_width, int pixel_height);
/** \brief Free a frame created with the create_frame() method.
* \param priv The handle returned by the create() method
* \param frame The frame to be freed
*/
// void (*destroy_frame)(void * priv, gavl_video_frame_t * frame);
/** \brief Free an overlay created with the create_overlay() method.
* \param priv The handle returned by the create() method
* \param id The id returned by the add_overlay_stream() method
* \param ovl The overlay to be freed
*/
void (*destroy_overlay)(void * priv, int id, gavl_overlay_t * ovl);
/** \brief Close the plugin
* \param priv The handle returned by the create() method
*
* Close everything so the plugin can be opened with a differtent format
* after.
*/
void (*close)(void * priv);
/** \brief Show or hide the window
* \param priv The handle returned by the create() method
* \param show 1 for showing, 0 for hiding
*/
void (*show_window)(void * priv, int show);
};
/*******************************************
* ENCODER
*******************************************/
/** \defgroup plugin_e Encoder
* \ingroup plugin
* \brief Encoder
*/
/** \ingroup plugin_ov
* \brief Typedef for callbacks for the encoder plugin
*
*/
typedef struct bg_encoder_callbacks_s bg_encoder_callbacks_t;
/** \ingroup plugin_ov
* \brief Callbacks for the encoder plugin
*
*/
struct bg_encoder_callbacks_s
{
/** \brief Output file callback
* \param data The data member of this bg_ov_callbacks_s struct
* \param filename Name of the created file
* \returns 1 if the file may be created, 0 else
*
* This is called whenever an output file is created.
*/
int (*create_output_file)(void * data, const char * filename);
/** \brief Temp file callback
* \param data The data member of this bg_ov_callbacks_s struct
* \param filename Name of the created file
* \returns 1 if the file may be created, 0 else
*
* This is called whenever a temporary file is created.
*/
int (*create_temp_file)(void * data, const char * filename);
void * data;//!< Application specific data passed as the first argument to all callbacks.
};
/** \ingroup plugin_e
* \brief Typedef for encoder plugin
*/
typedef struct bg_encoder_plugin_s bg_encoder_plugin_t;
/** \ingroup plugin_e
* \brief Encoder plugin
*/
struct bg_encoder_plugin_s
{
bg_plugin_common_t common; //!< Infos and functions common to all plugin types
int max_audio_streams; //!< Maximum number of audio streams. -1 means infinite
int max_video_streams; //!< Maximum number of video streams. -1 means infinite
int max_subtitle_text_streams;//!< Maximum number of text subtitle streams. -1 means infinite
int max_subtitle_overlay_streams;//!< Maximum number of overlay subtitle streams. -1 means infinite
/** \brief Set callbacks
* \param priv The handle returned by the create() method
* \param cb Callback structure
*/
void (*set_callbacks)(void * priv, bg_encoder_callbacks_t * cb);
/** \brief Query for writing compressed audio packets
* \param priv The handle returned by the create() method
* \param format Format of the source
* \param info Compression info
* \returns 1 if stream compressed format can be written, 0 else
*
* Call this function after all global parameters are set.
*/
int (*writes_compressed_audio)(void * priv,
const gavl_audio_format_t * format,
const gavl_compression_info_t * info);
/** \brief Query for writing compressed video packets
* \param priv The handle returned by the create() method
* \param format Format of the source
* \param info Compression info
* \returns 1 if stream compressed format can be written, 0 else
*
* Call this function after all global parameters are set.
*/
int (*writes_compressed_video)(void * priv,
const gavl_video_format_t * format,
const gavl_compression_info_t * info);
/** \brief Open a file
* \param priv The handle returned by the create() method
* \param filename Name of the file to be opened (without extension!)
* \param metadata Metadata to be written to the file
* \param chapter_list Chapter list (optional, can be NULL)
*
* The extension is added automatically by the plugin.
* To keep track of the written files, use the \ref bg_encoder_callbacks_t.
*/
int (*open)(void * data, const char * filename,
const gavl_metadata_t * metadata,
const bg_chapter_list_t * chapter_list);
/* Return per stream parameters */
/** \brief Get audio related parameters
* \param priv The handle returned by the create() method
* \returns NULL terminated array of parameter descriptions
*
* The returned parameters are owned by the plugin and must not be freed.
*/
const bg_parameter_info_t * (*get_audio_parameters)(void * priv);
/** \brief Get video related parameters
* \param priv The handle returned by the create() method
* \returns NULL terminated array of parameter descriptions
*
* The returned parameters are owned by the plugin and must not be freed.
*/
const bg_parameter_info_t * (*get_video_parameters)(void * priv);
/** \brief Get text subtitle related parameters
* \param priv The handle returned by the create() method
* \returns NULL terminated array of parameter descriptions
*
* The returned parameters are owned by the plugin and must not be freed.
*/
const bg_parameter_info_t * (*get_subtitle_text_parameters)(void * priv);
/** \brief Get overlay subtitle related parameters
* \param priv The handle returned by the create() method
* \returns NULL terminated array of parameter descriptions
*
* The returned parameters are owned by the plugin and must not be freed.
*/
const bg_parameter_info_t * (*get_subtitle_overlay_parameters)(void * priv);
/* Add streams. The formats can be changed, be sure to get the
* final formats with get_[audio|video]_format after starting the plugin
* Return value is the index of the added stream.
*/
/** \brief Add an audio stream
* \param priv The handle returned by the create() method
* \param language as ISO 639-2 code (3 characters+'\\0') or NULL
* \param format Format of the source
* \returns Index of this stream (starting with 0)
*
* The format might be changed to the nearest format supported by
* the plugin. Use \ref get_audio_format to get the actual format
* needed by the plugin, after \ref start() was called.
*/
int (*add_audio_stream)(void * priv, const gavl_metadata_t * m,
const gavl_audio_format_t * format);
/** \brief Add an audio stream fpr compressed writing
* \param priv The handle returned by the create() method
* \param language as ISO 639-2 code (3 characters+'\\0') or NULL
* \param format Format of the source
* \param info Compression info of the source
* \returns Index of this stream (starting with 0)
*
* The format might be changed to the nearest format supported by
* the plugin. Use \ref get_audio_format to get the actual format
* needed by the plugin, after \ref start() was called.
*/
int (*add_audio_stream_compressed)(void * priv, const gavl_metadata_t * m,
const gavl_audio_format_t * format,
const gavl_compression_info_t * info);
/** \brief Add a video stream
* \param priv The handle returned by the create() method
* \param format Format of the source
* \returns Index of this stream (starting with 0)
*
* The format might be changed to the nearest format supported by
* the plugin. Use \ref get_video_format to get the actual format
* needed by the plugin, after \ref start() was called.
*/
int (*add_video_stream)(void * priv,
const gavl_metadata_t * m,
const gavl_video_format_t * format);
/** \brief Add a video stream for compressed writing
* \param priv The handle returned by the create() method
* \param format Format of the source
* \param info Compression info of the source
* \returns Index of this stream (starting with 0)
*
* The format might be changed to the nearest format supported by
* the plugin. Use \ref get_video_format to get the actual format
* needed by the plugin, after \ref start() was called.
*/
int (*add_video_stream_compressed)(void * priv,
const gavl_metadata_t * m,
const gavl_video_format_t * format,
const gavl_compression_info_t * info);
/** \brief Add a text subtitle stream
* \param priv The handle returned by the create() method
* \param language as ISO 639-2 code (3 characters+'\\0') or NULL
* \returns Index of this stream (starting with 0)
*/
int (*add_subtitle_text_stream)(void * priv,
const gavl_metadata_t * m,
int * timescale);
/** \brief Add a text subtitle stream
* \param priv The handle returned by the create() method
* \param language as ISO 639-2 code (3 characters+'\\0') or NULL
* \param format Format of the source
* \returns Index of this stream (starting with 0)
*
* The format might be changed to the nearest format supported by
* the plugin. Use \ref get_subtitle_overlay_format
* to get the actual format
* needed by the plugin, after \ref start was called.
*/
int (*add_subtitle_overlay_stream)(void * priv,
const gavl_metadata_t * m,
const gavl_video_format_t * format);
/* Set parameters for the streams */
/** \brief Set audio encoding parameter
* \param priv The handle returned by the create() method
* \param stream Stream index (starting with 0)
* \param name Name of the parameter
* \param v Value
*
* Use this function with parameters obtained by
* \ref get_audio_parameters.
*/
void (*set_audio_parameter)(void * priv, int stream, const char * name,
const bg_parameter_value_t * v);
/** \brief Set video encoding parameter
* \param priv The handle returned by the create() method
* \param stream Stream index (starting with 0)
* \param name Name of the parameter
* \param v Value
*
* Use this function with parameters obtained by
* \ref get_video_parameters.
*/
void (*set_video_parameter)(void * priv, int stream, const char * name,
const bg_parameter_value_t * v);
/** \brief Set text subtitle encoding parameter
* \param priv The handle returned by the create() method
* \param stream Stream index (starting with 0)
* \param name Name of the parameter
* \param v Value
*
* Use this function with parameters obtained by
* \ref get_subtitle_text_parameters.
*/
void (*set_subtitle_text_parameter)(void * priv, int stream,
const char * name,
const bg_parameter_value_t * v);
/** \brief Set text subtitle encoding parameter
* \param priv The handle returned by the create() method
* \param stream Stream index (starting with 0)
* \param name Name of the parameter
* \param v Value
*
* Use this function with parameters obtained by
* \ref get_subtitle_overlay_parameters.
*/
void (*set_subtitle_overlay_parameter)(void * priv, int stream,
const char * name,
const bg_parameter_value_t * v);
/** \brief Setup multipass video encoding.
* \param priv The handle returned by the create() method
* \param stream Stream index (starting with 0)
* \param pass Number of this pass (starting with 1)
* \param total_passes Number of total passes
* \param stats_file Name of a file, which can be used for multipass statistics
* \returns 0 if multipass transcoding is not supported and can be ommitted, 1 else
*/
int (*set_video_pass)(void * priv, int stream, int pass, int total_passes,
const char * stats_file);
/** \brief Set up all codecs and prepare for encoding
* \param priv The handle returned by the create() method
* \returns 0 on error, 1 on success
*
* Optional function for preparing the actual encoding. Applications must
* check for this function and call it when available.
*/
int (*start)(void * priv);
/*
* After setting the parameters, get the formats, you need to deliver the frames in
*/
/** \brief Get audio format
* \param priv The handle returned by the create() method
* \param stream Stream index (starting with 0)
* \param ret Returns format
*
* Call this after calling \ref start() if it's defined.
*/
void (*get_audio_format)(void * priv, int stream, gavl_audio_format_t*ret);
/** \brief Get video format
* \param priv The handle returned by the create() method
* \param stream Stream index (starting with 0)
* \param ret Returns format
*
* Call this after calling \ref start() if it's defined.
*/
void (*get_video_format)(void * priv, int stream, gavl_video_format_t*ret);
/** \brief Get video format of an overlay subtitle stream
* \param priv The handle returned by the create() method
* \param stream Stream index (starting with 0)
* \param ret Returns format
*
* Call this after calling \ref start() if it's defined.
*/
void (*get_subtitle_overlay_format)(void * priv, int stream,
gavl_video_format_t*ret);
/*
* Encode audio/video
*/
/** \brief Write audio samples
* \param priv The handle returned by the create() method
* \param frame Frame with samples
* \param stream Stream index (starting with 0)
* \returns 1 is the data was successfully written, 0 else
*
* The actual number of samples must be stored in the valid_samples member of
* the frame.
*/
int (*write_audio_frame)(void * data, gavl_audio_frame_t * frame, int stream);
/** \brief Write audio packet
* \param priv The handle returned by the create() method
* \param packet Packet with compressed data
* \param stream Stream index (starting with 0)
* \returns 1 is the data was successfully written, 0 else
*
* The actual number of samples must be stored in the duration member of
* the packet.
*/
int (*write_audio_packet)(void * data, gavl_packet_t * packet, int stream);
/** \brief Write video frame
* \param priv The handle returned by the create() method
* \param frame Frame
* \param stream Stream index (starting with 0)
* \returns 1 is the data was successfully written, 0 else
*/
int (*write_video_frame)(void * data, gavl_video_frame_t * frame, int stream);
/** \brief Write video packet
* \param priv The handle returned by the create() method
* \param packet Packet with compressed data
* \param stream Stream index (starting with 0)
* \returns 1 is the data was successfully written, 0 else
*/
int (*write_video_packet)(void * data, gavl_packet_t * packet, int stream);
/** \brief Write a text subtitle
* \param priv The handle returned by the create() method
* \param frame The text
* \param start Start of the subtitle
* \param duration Duration of the subtitle
* \param stream Stream index (starting with 0)
* \returns 1 is the data was successfully written, 0 else
*/
int (*write_subtitle_text)(void * data,const char * text,
int64_t start,
int64_t duration, int stream);
/** \brief Write an overlay subtitle
* \param priv The handle returned by the create() method
* \param ovl An overlay
* \param stream Stream index (starting with 0)
* \returns 1 is the data was successfully written, 0 else
*/
int (*write_subtitle_overlay)(void * data, gavl_overlay_t * ovl, int stream);
/** \brief Update metadata
* \param data The data member of this bg_input_callbacks_s struct
* \param name Name
* \param m Metadata
*
* Update metadata for broadcasting plugins.
* Either name or m can be NULL.
*/
void (*update_metadata)(void * data, const char * name,
const gavl_metadata_t * m);
/** \brief Close encoder
* \param priv The handle returned by the create() method
* \param do_delete Set this to 1 to delete all created files
* \returns 1 is the file was sucessfully closed, 0 else
*
* After calling this function, the plugin should be destroyed.
*/
int (*close)(void * data, int do_delete);
};
/*******************************************
* ENCODER Postprocessor
*******************************************/
/** \defgroup plugin_e_pp Encoding postprocessor
* \ingroup plugin
* \brief Encoding postprocessor
*
* The postprocessing plugins take one or more files
* for further processing them. There are postprocessors
* for creating and (optionally) burning audio CDs and VCDs.
*/
/** \ingroup plugin_e_pp
* \brief Callbacks for postprocessing
*
*/
typedef struct
{
/** \brief Callback describing the current action
* \param data The data member of this bg_ov_callbacks_s struct
* \param action A string describing the current action
*
* Action can be something like "Burning track 1/10".
*/
void (*action_callback)(void * data, char * action);
/** \brief Callback describing the progress of the current action
* \param data The data member of this bg_ov_callbacks_s struct
* \param perc Percentage (0.0 .. 1.0)
*
* This is exclusively for updating progress bars in
* GUI applications. Note, that some postprocessors
* reset the progress during postprocessing.
*/
void (*progress_callback)(void * data, float perc);
void * data; //!< Application specific data passed as the first argument to all callbacks.
} bg_e_pp_callbacks_t;
/** \ingroup plugin_e_pp
* \brief Typedef for encoding postprocessor
*
*/
typedef struct bg_encoder_pp_plugin_s bg_encoder_pp_plugin_t;
/** \ingroup plugin_e_pp
* \brief Encoding postprocessor
*
*/
struct bg_encoder_pp_plugin_s
{
bg_plugin_common_t common; //!< Infos and functions common to all plugin types
int max_audio_streams; //!< Maximum number of audio streams. -1 means infinite
int max_video_streams; //!< Maximum number of video streams. -1 means infinite
char * supported_extensions; //!< Supported file extensions (space separated)
/** \brief Set callbacks
* \param priv The handle returned by the create() method
* \param callbacks Callback structure initialized by the caller before
*
*/
void (*set_callbacks)(void * priv,bg_e_pp_callbacks_t * callbacks);
/** \brief Initialize
* \param priv The handle returned by the create() method
*
* This functions clears all tracks and makes the plugin ready to
* add new tracks.
*/
int (*init)(void * priv);
/** \brief Add a transcoded track
* \param priv The handle returned by the create() method
* \param filename Name of the media file
* \param metadata Metadata for the track
* \param pp_only Set this to 1 if this file was not encoded and is only postprocessed
*
* Send a track to the postprocessor. This plugin will store all necessary data until
* the \ref run() method is called. Some postprocessors might do some sanity tests
* on the file e.g. the audio CD burner will reject anything except WAV-files.
*
* Usually, it is assumed, that files were encoded for the only purpose of postprocessing
* them. This means, they will be deleted if the cleanup flag is passed to the \ref run()
* function. If you set the pp_only argument to 1, you tell, that this file should be
* kept after postprocessing.
*/
void (*add_track)(void * priv, const char * filename,
gavl_metadata_t * metadata, int pp_only);
/** \brief Start postprocessing
* \param priv The handle returned by the create() method
* \param directory The directory, where output files can be written
* \param cleanup Set this to 1 to erase all source files and temporary files after finishing
* Run can be a long operation, it should be called from a separate
* thread launched by the application and the callbacks should be
* used for progress reporting
*/
void (*run)(void * priv, const char * directory, int cleanup);
/** \brief Stop postprocessing
* \param priv The handle returned by the create() method
*
* Call this function to cancel a previously called \ref run() function.
* The plugin must implement the stop mechanism in a thread save manner,
* i.e. the stop method must savely be callable from another thread than the
* one, which called \ref run().
*/
void (*stop)(void * priv);
};
/** \defgroup plugin_ir Image support
* \ingroup plugin
* \brief Read and write image files
*
* These support reading and writing of images in a variety
* of formats
*
* @{
*/
/** \brief Typedef for image reader plugin
*/
typedef struct bg_image_reader_plugin_s bg_image_reader_plugin_t;
/** \brief Image reader plugin
*/
struct bg_image_reader_plugin_s
{
bg_plugin_common_t common; //!< Infos and functions common to all plugin types
const char * extensions; //!< Supported file extensions (space separated)
/** \brief Read the file header
* \param priv The handle returned by the create() method
* \param filename Filename
* \param format Returns the format of the image
* \returns 1 on success, 0 on error.
*/
int (*read_header)(void * priv, const char * filename,
gavl_video_format_t * format);
/** \brief Get metadata
* \param priv The handle returned by the create() method
* \returns Metadata for the image or NULL
*/
const gavl_metadata_t * (*get_metadata)(void * priv);
/** \brief Get compression info
* \param priv The handle returned by the create() method
* \param ci Returns the compression info
* \returns 1 if the compression info could be returned, 0 else
*/
int (*get_compression_info)(void * priv, gavl_compression_info_t * ci);
/** \brief Read the image
* \param priv The handle returned by the create() method
* \param frame The frame, where the image will be copied
* \returns 1 if the image was read, 0 else
*
* After reading the image the plugin is cleaned up, so \ref read_header()
* can be called again after that. If frame is NULL, no image is read,
* and the plugin is reset.
*/
int (*read_image)(void * priv, gavl_video_frame_t * frame);
};
/**
* \brief Typedef for callbacks for the image writer plugin
*/
typedef struct bg_iw_callbacks_s bg_iw_callbacks_t;
/**
* \brief Callbacks for the image writer plugin
*/
struct bg_iw_callbacks_s
{
/** \brief Output file callback
* \param data The data member of this bg_ov_callbacks_s struct
* \param filename Name of the created file
* \returns 1 if the file may be created, 0 else
*
* This is called whenever an output file is created.
*/
int (*create_output_file)(void * data, const char * filename);
void * data;//!< Application specific data passed as the first argument to all callbacks.
};
/** \brief Typedef for image writer plugin
*
*/
typedef struct bg_image_writer_plugin_s bg_image_writer_plugin_t;
/** \brief Image writer plugin
*
*/
struct bg_image_writer_plugin_s
{
bg_plugin_common_t common; //!< Infos and functions common to all plugin types
const char * extensions; //!< File extensions (space separated)
/** \brief Set callbacks
* \param priv The handle returned by the create() method
* \param cb Callback structure
*/
void (*set_callbacks)(void * priv, bg_iw_callbacks_t * cb);
/** \brief Write the file header
* \param priv The handle returned by the create() method
* \param format Video format
* \returns 1 on success, 0 on error.
*
* The format will be changed to the nearest format, which is supported
* by the plugin. To convert the source format to the output format,
* use a \ref gavl_video_converter_t
*/
int (*write_header)(void * priv, const char * filename,
gavl_video_format_t * format, const gavl_metadata_t * m);
/** \brief Write the image
* \param priv The handle returned by the create() method
* \param frame The frame containing the image
* \returns 1 on success, 0 on error.
*
* After writing the image the plugin is cleaned up, so \ref write_header()
* can be called again after that. If frame is NULL, no image is read,
* and the plugin is reset.
*/
int (*write_image)(void * priv, gavl_video_frame_t * frame);
} ;
/**
* @}
*/
/** \defgroup plugin_filter A/V Filters
* \ingroup plugin
* \brief A/V Filters
* These can apply additional effects to uncomporessed A/V data.
* The API follows an asynchronous pull approach: You pass a callback
* for reading input frames. Then you call the read method to read one
* output frame. The plugin will read input data via the callback.
*
* This mechanism allows filters, where the numbers of input frames/samples
* differs from the numbers of output frames/samples (e.g. when the filter
* does framerate conversion).
*
* In principle, the API also supports filters with multiple input ports,
* but currently, only plugins with one input are available.
*
* Not all filters support all formats. Applications should build filter chains
* with format converters between them. There are, however, some standard formats,
* which are supported by almost all filters, so the overall conversion overhead
* is usually zero in real-life situations.
*
* @{
*/
/* Filters */
/** \brief Typedef for audio filter plugin
*
*/
typedef struct bg_fa_plugin_s bg_fa_plugin_t;
/** \brief Audio filter plugin
*
*/
struct bg_fa_plugin_s
{
bg_plugin_common_t common; //!< Infos and functions common to all plugin types
/** \brief Set input callback
* \param priv The handle returned by the create() method
* \param func The function to call
* \param data The private handle to pass to func
* \param stream The stream argument to pass to func
* \param port The input port of the plugin
*/
void (*connect_input_port)(void * priv, bg_read_audio_func_t func,
void * data,
int stream, int port);
/** \brief Set input format
* \param priv The handle returned by the create() method
* \param format Format
* \param port The input port of the plugin
*
* The input format can be changed by the plugin. Make sure that you have a format
* converter before the filter.
*/
void (*set_input_format)(void * priv, gavl_audio_format_t * format, int port);
/** \brief Reset
* \param priv The handle returned by the create() method
*
* Optional, resets internal state, as if no frame has been processed before.
*/
void (*reset)(void * priv);
/** \brief Get output format
* \param priv The handle returned by the create() method
* \param format Returns the output format
*
* These must be called after init().
*/
void (*get_output_format)(void * priv, gavl_audio_format_t * format);
/** \brief Report, if the plugin must be reinitialized
* \param priv The handle returned by the create() method
* \returns 1 if the plugin must be reinitialized, 0 else
*
* Optional, must be called after set_parameter() to check, if the
* filter must be reinitialized. Note, that the input and output formats can
* be changed in this case as well.
*/
int (*need_restart)(void * priv);
/** \brief Read audio samples from the plugin
*/
bg_read_audio_func_t read_audio;
};
/** \brief Typedef for video filter plugin
*
*/
typedef struct bg_fv_plugin_s bg_fv_plugin_t;
/** \brief Video filter plugin
*
*/
struct bg_fv_plugin_s
{
bg_plugin_common_t common; //!< Infos and functions common to all plugin types
/** \brief Get gavl options
* \param priv The handle returned by the create() method
* \returns Video conversion options
*
* This optional function returns the gavl options. You can configure them
* like you do it in plain gavl.
*/
gavl_video_options_t * (*get_options)(void * priv);
/** \brief Set input callback
* \param priv The handle returned by the create() method
* \param func The function to call
* \param data The private handle to pass to func
* \param stream The stream argument to pass to func
* \param port The input port of the plugin
*/
void (*connect_input_port)(void * priv,
bg_read_video_func_t func,
void * data, int stream, int port);
/** \brief Set input format
* \param priv The handle returned by the create() method
* \param format Format
* \param port The input port of the plugin
*/
void (*set_input_format)(void * priv, gavl_video_format_t * format, int port);
/** \brief Reset
* \param priv The handle returned by the create() method
*
* Optional, resets internal state, as if no frame has been processed before.
*/
void (*reset)(void * priv);
/** \brief Get output format
* \param priv The handle returned by the create() method
* \param format Returns the output format
*
* These must be called after init().
*/
void (*get_output_format)(void * priv, gavl_video_format_t * format);
/** \brief Report, if the plugin must be reinitialized
* \param priv The handle returned by the create() method
* \returns 1 if the plugin must be reinitialized, 0 else
*
* Optional, must be called after set_parameter() to check, if the
* filter must be reinitialized. Note, that the input and output formats can
* be changed in this case as well.
*/
int (*need_restart)(void * priv);
/** \brief Read a video frame from the plugin
*/
bg_read_video_func_t read_video;
};
/**
* @}
*/
/** \defgroup plugin_visualization Audio Visualization plugins
* \ingroup plugin
* \brief Audio Visualization plugins
*
*
*
* @{
*/
/** \brief Typedef for audio visualization plugin
*
*/
typedef struct bg_visualization_plugin_s bg_visualization_plugin_t;
/** \brief Audio visualization plugin
*
* These plugins get audio samples and run visualizations of them.
* Output can be either into a \ref gavl_video_frame_t or directly
* via OpenGL. Which method is used is denoted by the
* \ref BG_PLUGIN_VISUALIZE_FRAME and \ref BG_PLUGIN_VISUALIZE_GL
* flags.
*
* For OpenGL, you need to pass a window ID to the
* plugin. The plugin is then responsible for creating Subwindows and
* setting up an OpenGL context. In General, it's stronly recommended to
* use the \ref bg_visualizer_t module to use visualizations.
*/
struct bg_visualization_plugin_s
{
bg_plugin_common_t common; //!< Infos and functions common to all plugin types
/** \brief return callback
* \param priv The handle returned by the create() method
* \param cb The callbacks to be called
*/
void (*set_callbacks)(void * priv, bg_ov_callbacks_t * cb);
/** \brief Open a frame based visualization plugin
* \param priv The handle returned by the create() method
* \param audio_format Audio format
* \param video_format Video format
*
* The audio format parameter will most likely changed to the
* nearest supported format. In the video format parameter, you
* usually pass the desired render size. Everything else
* (except the framerate) will be set up by the plugin.
*/
int (*open_ov)(void * priv, gavl_audio_format_t * audio_format,
gavl_video_format_t * video_format);
/** \brief Open a window based visualization plugin
* \param priv The handle returned by the create() method
* \param audio_format Audio format
* \param window_id A window ID
*
* The audio format parameter will most likely changed to the
* nearest supported format. For the window id, use strings formatted
* like the one returned by \ref bg_ov_plugin_t
*/
int (*open_win)(void * priv, gavl_audio_format_t * audio_format,
const char * window_id);
/** \brief Send audio data to the plugin
* \param priv The handle returned by the create() method
* \param frame Audio frame
*
* This updates the plugin with new audio samples. After that, we may
* or may not call the draw_frame function below to actually draw an
* image. Note, that visualization plugins are not required to do
* internal audio buffering, so it's wise to pass a frame with as many
* samples as the samples_per_frame member of the audio format returned
* by \ref open_ov or \ref open_win.
*/
void (*update)(void * priv, gavl_audio_frame_t * frame);
/** \brief Draw an image
* \param priv The handle returned by the create() method
* \param The video frame to draw to
*
* For OpenGL plugins, frame is NULL. For frame based plugins,
* the image will be drawn into the frame you pass. You must display
* the frame on your own then.
*/
void (*draw_frame)(void * priv, gavl_video_frame_t * frame);
/** \brief Show the image
* \param priv The handle returned by the create() method
*
* This function is needed only for OpenGL plugins. Under X11,
* it will typically call glXSwapBuffers and process events on the
* X11 window.
*/
void (*show_frame)(void * priv);
/** \brief Close a plugin
* \param priv The handle returned by the create() method
*/
void (*close)(void * priv);
};
/**
* @}
*/
#endif // __BG_PLUGIN_H_
|