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
// Copyright 2017 Lyndon Brown
//
// This file is part of the PulseAudio Rust language binding.
//
// Licensed under the MIT license or the Apache license (version 2.0), at your option. You may not
// copy, modify, or distribute this file except in compliance with said license. You can find copies
// of these licenses either in the LICENSE-MIT and LICENSE-APACHE files, or alternatively at
// <http://opensource.org/licenses/MIT> and <http://www.apache.org/licenses/LICENSE-2.0>
// respectively.
//
// Portions of documentation are copied from the LGPL 2.1+ licensed PulseAudio C headers on a
// fair-use basis, as discussed in the overall project readme (available in the git repository).
//! Routines for daemon introspection.
//!
//! # Overview
//!
//! Sometimes it is necessary to query and modify global settings in the server. For this,
//! PulseAudio has the introspection API. It can list sinks, sources, samples and other aspects of
//! the server. It can also modify the attributes of the server that will affect operations on a
//! global level, and not just the application’s context.
//!
//! # Usage
//!
//! The introspection routines are exposed as methods on an [`Introspector`] object held by the
//! [`Context`] object, and can be accessed via the [`Context::introspect()`] method.
//!
//! # Querying
//!
//! All querying is done through callbacks. This approach is necessary to maintain an asynchronous
//! design. The client will request the information and some time later, the server will respond
//! with the desired data.
//!
//! Some objects can have multiple instances on the server. When requesting all of these at once,
//! the callback will be called multiple times, each time with an [`ListResult`] variant. It will be
//! called once for each item in turn, using the `Item` variant, and then once more time with the
//! `End` variant to signal that the end of the list has been reached. If an error occurs, then
//! the `Error` variant will be given.
//!
//! Note that even if a single object is requested, and not the entire list, the terminating call
//! will still be made.
//!
//! Data members in the information structures are only valid during the duration of the callback.
//! If they are required after the callback is finished, a deep copy of the information structure
//! must be performed.
//!
//! # Server Information
//!
//! The server can be queried about its name, the environment it’s running on and the currently
//! active global defaults. Calling [`Introspector::get_server_info()`] provides access to a
//! [`ServerInfo`] structure containing all of these.
//!
//! # Memory Usage
//!
//! Statistics about memory usage can be fetched using [`Introspector::stat()`], giving a
//! [`StatInfo`] structure.
//!
//! # Sinks and Sources
//!
//! The server can have an arbitrary number of sinks and sources. Each sink and source have both an
//! index and a name associated with it. As such, there are three ways to get access to them:
//!
//! * By index: [`Introspector::get_sink_info_by_index()`],
//! [`Introspector::get_source_info_by_index()`]
//! * By name: [`Introspector::get_sink_info_by_name()`],
//! [`Introspector::get_source_info_by_name()`]
//! * All: [`Introspector::get_sink_info_list()`], [`Introspector::get_source_info_list()`]
//!
//! All three methods use the same callback and will provide a [`SinkInfo`] or [`SourceInfo`]
//! structure.
//!
//! # Sink Inputs and Source Outputs
//!
//! Sink inputs and source outputs are the representations of the client ends of streams inside the
//! server. I.e. they connect a client stream to one of the global sinks or sources.
//!
//! Sink inputs and source outputs only have an index to identify them. As such, there are only two
//! ways to get information about them:
//!
//! * By index: [`Introspector::get_sink_input_info()`], [`Introspector::get_source_output_info()`]
//! * All: [`Introspector::get_sink_input_info_list()`],
//! [`Introspector::get_source_output_info_list()`]
//!
//! The structure returned is the [`SinkInputInfo`] or [`SourceOutputInfo`] structure.
//!
//! # Samples
//!
//! The list of cached samples can be retrieved from the server. Three methods exist for querying
//! the sample cache list:
//!
//! * By index: [`Introspector::get_sample_info_by_index()`]
//! * By name: [`Introspector::get_sample_info_by_name()`]
//! * All: [`Introspector::get_sample_info_list()`]
//!
//! Note that this only retrieves information about the sample, not the sample data itself.
//!
//! # Driver Modules
//!
//! PulseAudio driver modules are identified by index and are retrieved using either
//! [`Introspector::get_module_info()`] or [`Introspector::get_module_info_list()`]. The information
//! structure is called [`ModuleInfo`].
//!
//! # Clients
//!
//! PulseAudio clients are also identified by index and are retrieved using either
//! [`Introspector::get_client_info()`] or [`Introspector::get_client_info_list()`]. The information
//! structure is called [`ClientInfo`].
//!
//! # Control
//!
//! Some parts of the server are only possible to read, but most can also be modified in different
//! ways. Note that these changes will affect all connected clients and not just the one issuing the
//! request.
//!
//! # Sinks and Sources
//!
//! The most common change one would want to apply to sinks and sources is to modify the volume of
//! the audio. Identically to how sinks and sources can be queried, there are two ways of
//! identifying them:
//!
//! * By index: [`Introspector::set_sink_volume_by_index()`],
//! [`Introspector::set_source_volume_by_index()`]
//! * By name: [`Introspector::set_sink_volume_by_name()`],
//! [`Introspector::set_source_volume_by_name()`]
//!
//! It is also possible to mute a sink or source:
//!
//! * By index: [`Introspector::set_sink_mute_by_index()`],
//! [`Introspector::set_source_mute_by_index()`]
//! * By name: [`Introspector::set_sink_mute_by_name()`],
//! [`Introspector::set_source_mute_by_name()`]
//!
//! # Sink Inputs and Source Outputs
//!
//! If an application desires to modify the volume of just a single stream (commonly one of its own
//! streams), this can be done by setting the volume of its associated sink input or source output,
//! using [`Introspector::set_sink_input_volume()`] or [`Introspector::set_source_output_volume()`].
//!
//! It is also possible to remove sink inputs and source outputs, terminating the streams associated
//! with them:
//!
//! * Sink input: [`Introspector::kill_sink_input()`]
//! * Source output: [`Introspector::kill_source_output()`]
//!
//! It is strongly recommended that all volume changes are done as a direct result of user input.
//! With automated requests, such as those resulting from misguided attempts of crossfading,
//! PulseAudio can store the stream volume at an inappropriate moment and restore it later. Besides,
//! such attempts lead to OSD popups in some desktop environments.
//!
//! As a special case of the general rule above, it is recommended that your application leaves the
//! task of saving and restoring the volume of its streams to PulseAudio and does not attempt to do
//! it by itself. PulseAudio really knows better about events such as stream moving or headphone
//! plugging that would make the volume stored by the application inapplicable to the new
//! configuration.
//!
//! Another important case where setting a sink input volume may be a bad idea is related to
//! interpreters that interpret potentially untrusted scripts. PulseAudio relies on your application
//! not making malicious requests (such as repeatedly setting the volume to 100%). Thus, script
//! interpreters that represent a security boundary must sandbox volume-changing requests coming
//! from their scripts. In the worst case, it may be necessary to apply the script-requested volume
//! to the script-produced sounds by altering the samples in the script interpreter and not touching
//! the sink or sink input volume as seen by PulseAudio.
//!
//! If an application changes any volume, it should also listen to changes of the same volume
//! originating from outside the application (e.g., from the system mixer application) and update
//! its user interface accordingly. Use [`Context::subscribe()`] to get such notifications.
//!
//! # Modules
//!
//! Server modules can be remotely loaded and unloaded using [`Introspector::load_module()`] and
//! [`Introspector::unload_module()`].
//!
//! # Messages
//!
//! Server objects like sinks, sink inputs or modules can register a message handler to communicate
//! with clients. A message can be sent to a named message handler using
//! [`Introspector::send_message_to_object()`].
//!
//! # Clients
//!
//! The only operation supported on clients is the possibility of kicking them off the server using
//! [`Introspector::kill_client()`].
use std::os::raw::c_void;
#[cfg(any(doc, feature = "pa_v15"))]
use std::os::raw::c_char;
use std::ffi::{CStr, CString};
use std::borrow::Cow;
use std::ptr::null_mut;
use num_traits::FromPrimitive;
use capi::pa_sink_port_info as SinkPortInfoInternal;
use capi::pa_sink_info as SinkInfoInternal;
use capi::pa_source_port_info as SourcePortInfoInternal;
use capi::pa_source_info as SourceInfoInternal;
use capi::pa_server_info as ServerInfoInternal;
use capi::pa_module_info as ModuleInfoInternal;
use capi::pa_client_info as ClientInfoInternal;
use capi::pa_card_profile_info2 as CardProfileInfoInternal;
use capi::pa_card_port_info as CardPortInfoInternal;
use capi::pa_card_info as CardInfoInternal;
use capi::pa_sink_input_info as SinkInputInfoInternal;
use capi::pa_source_output_info as SourceOutputInfoInternal;
use capi::pa_sample_info as SampleInfoInternal;
use super::{Context, ContextInternal};
use crate::{def, sample, channelmap, format, direction};
use crate::time::MicroSeconds;
use crate::callbacks::{
ListResult, box_closure_get_capi_ptr, callback_for_list_instance, get_su_capi_params,
get_su_callback
};
use crate::volume::{ChannelVolumes, Volume};
use crate::{operation::Operation, proplist::Proplist};
#[cfg(any(doc, feature = "pa_v14"))]
use crate::def::DevicePortType;
pub use capi::pa_stat_info as StatInfo;
/// A wrapper object providing introspection routines to a context.
pub struct Introspector {
context: *mut super::ContextInternal,
}
unsafe impl Send for Introspector {}
unsafe impl Sync for Introspector {}
impl Context {
/// Gets an introspection object linked to the current context, giving access to introspection
/// routines.
///
/// See [`context::introspect`](mod@crate::context::introspect).
#[inline]
pub fn introspect(&self) -> Introspector {
unsafe { capi::pa_context_ref(self.ptr) };
Introspector::from_raw(self.ptr)
}
}
impl Introspector {
/// Creates a new `Introspector` from an existing [`ContextInternal`] pointer.
#[inline(always)]
fn from_raw(context: *mut ContextInternal) -> Self {
Self { context: context }
}
}
impl Drop for Introspector {
fn drop(&mut self) {
unsafe { capi::pa_context_unref(self.context) };
self.context = null_mut::<super::ContextInternal>();
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////
// Sink info
////////////////////////////////////////////////////////////////////////////////////////////////////
/// Stores information about a specific port of a sink.
///
/// Please note that this structure can be extended as part of evolutionary API updates at any time
/// in any new release.
#[derive(Debug)]
pub struct SinkPortInfo<'a> {
/// Name of this port.
pub name: Option<Cow<'a, str>>,
/// Description of this port.
pub description: Option<Cow<'a, str>>,
/// The higher this value is, the more useful this port is as a default.
pub priority: u32,
/// A flag indicating availability status of this port.
pub available: def::PortAvailable,
/// An indentifier for the group of ports that share their availability status with each other.
///
/// This is meant especially for handling cases where one 3.5 mm connector is used for
/// headphones, headsets and microphones, and the hardware can only tell that something was
/// plugged in but not what exactly. In this situation the ports for all those devices share
/// their availability status, and PulseAudio can’t tell which one is actually plugged in, and
/// some application may ask the user what was plugged in. Such applications should get a list
/// of all card ports and compare their `availability_group` fields. Ports that have the same
/// group are those that need input from the user to determine which device was plugged in. The
/// application should then activate the user-chosen port.
///
/// May be `None`, in which case the port is not part of any availability group (which is the
/// same as having a group with only one member).
///
/// The group identifier must be treated as an opaque identifier. The string may look like an
/// ALSA control name, but applications must not assume any such relationship. The group naming
/// scheme can change without a warning.
///
/// Since one group can include both input and output ports, the grouping should be done using
/// `CardPortInfo` instead of `SinkPortInfo`, but this field is duplicated also in
/// `SinkPortInfo` (and `SourcePortInfo`) in case someone finds that convenient.
#[cfg(any(doc, feature = "pa_v14"))]
#[cfg_attr(docsrs, doc(cfg(feature = "pa_v14")))]
pub availability_group: Option<Cow<'a, str>>,
/// Port device type.
#[cfg(any(doc, feature = "pa_v14"))]
#[cfg_attr(docsrs, doc(cfg(feature = "pa_v14")))]
pub r#type: DevicePortType,
}
impl<'a> SinkPortInfo<'a> {
fn new_from_raw(p: *const SinkPortInfoInternal) -> Self {
assert!(!p.is_null());
let src = unsafe { &*p };
unsafe {
SinkPortInfo {
name: match src.name.is_null() {
false => Some(CStr::from_ptr(src.name).to_string_lossy()),
true => None,
},
description: match src.description.is_null() {
false => Some(CStr::from_ptr(src.description).to_string_lossy()),
true => None,
},
priority: src.priority,
available: def::PortAvailable::from_i32(src.available).unwrap(),
#[cfg(any(doc, feature = "pa_v14"))]
availability_group: match src.availability_group.is_null() {
false => Some(CStr::from_ptr(src.availability_group).to_string_lossy()),
true => None,
},
#[cfg(any(doc, feature = "pa_v14"))]
r#type: DevicePortType::from_u32(src.r#type).unwrap(),
}
}
}
}
/// Stores information about sinks.
///
/// Please note that this structure can be extended as part of evolutionary API updates at any time
/// in any new release.
#[derive(Debug)]
pub struct SinkInfo<'a> {
/// Name of the sink.
pub name: Option<Cow<'a, str>>,
/// Index of the sink.
pub index: u32,
/// Description of this sink.
pub description: Option<Cow<'a, str>>,
/// Sample spec of this sink.
pub sample_spec: sample::Spec,
/// Channel map.
pub channel_map: channelmap::Map,
/// Index of the owning module of this sink, or `None` if is invalid.
pub owner_module: Option<u32>,
/// Volume of the sink.
pub volume: ChannelVolumes,
/// Mute switch of the sink.
pub mute: bool,
/// Index of the monitor source connected to this sink.
pub monitor_source: u32,
/// The name of the monitor source.
pub monitor_source_name: Option<Cow<'a, str>>,
/// Length of queued audio in the output buffer.
pub latency: MicroSeconds,
/// Driver name.
pub driver: Option<Cow<'a, str>>,
/// Flags.
pub flags: def::SinkFlagSet,
/// Property list.
pub proplist: Proplist,
/// The latency this device has been configured to.
pub configured_latency: MicroSeconds,
/// Some kind of “base” volume that refers to unamplified/unattenuated volume in the context of
/// the output device.
pub base_volume: Volume,
/// State.
pub state: def::SinkState,
/// Number of volume steps for sinks which do not support arbitrary volumes.
pub n_volume_steps: u32,
/// Card index, or `None` if invalid.
pub card: Option<u32>,
/// Set of available ports.
pub ports: Vec<SinkPortInfo<'a>>,
/// Pointer to active port in the set, or `None`.
pub active_port: Option<Box<SinkPortInfo<'a>>>,
/// Set of formats supported by the sink.
pub formats: Vec<format::Info>,
}
impl<'a> SinkInfo<'a> {
fn new_from_raw(p: *const SinkInfoInternal) -> Self {
assert!(!p.is_null());
let src = unsafe { &*p };
let mut port_vec = Vec::with_capacity(src.n_ports as usize);
assert!(src.n_ports == 0 || !src.ports.is_null());
for i in 0..src.n_ports as isize {
let indexed_ptr = unsafe { (*src.ports.offset(i)) as *mut SinkPortInfoInternal };
if !indexed_ptr.is_null() {
port_vec.push(SinkPortInfo::new_from_raw(indexed_ptr));
}
}
let mut formats_vec = Vec::with_capacity(src.n_formats as usize);
assert!(src.n_formats == 0 || !src.formats.is_null());
for i in 0..src.n_formats as isize {
let indexed_ptr = unsafe { (*src.formats.offset(i)) as *mut format::InfoInternal };
if !indexed_ptr.is_null() {
formats_vec.push(format::Info::from_raw_weak(indexed_ptr));
}
}
unsafe {
SinkInfo {
name: match src.name.is_null() {
false => Some(CStr::from_ptr(src.name).to_string_lossy()),
true => None,
},
index: src.index,
description: match src.description.is_null() {
false => Some(CStr::from_ptr(src.description).to_string_lossy()),
true => None,
},
sample_spec: src.sample_spec.into(),
channel_map: src.channel_map.into(),
owner_module: match src.owner_module {
def::INVALID_INDEX => None,
i => Some(i),
},
volume: src.volume.into(),
mute: match src.mute {
0 => false,
_ => true,
},
monitor_source: src.monitor_source,
monitor_source_name: match src.monitor_source_name.is_null() {
false => Some(CStr::from_ptr(src.monitor_source_name).to_string_lossy()),
true => None,
},
latency: MicroSeconds(src.latency),
driver: match src.driver.is_null() {
false => Some(CStr::from_ptr(src.driver).to_string_lossy()),
true => None,
},
flags: def::SinkFlagSet::from_bits_truncate(src.flags),
proplist: Proplist::from_raw_weak(src.proplist),
configured_latency: MicroSeconds(src.configured_latency),
base_volume: Volume(src.base_volume),
state: src.state.into(),
n_volume_steps: src.n_volume_steps,
card: match src.card {
def::INVALID_INDEX => None,
i => Some(i),
},
ports: port_vec,
active_port: match src.active_port.is_null() {
true => None,
false => Some(Box::new(SinkPortInfo::new_from_raw(src.active_port))),
},
formats: formats_vec,
}
}
}
}
impl Introspector {
/// Gets information about a sink by its name.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_sink_info_by_name<F>(&self, name: &str, callback: F)
-> Operation<dyn FnMut(ListResult<&SinkInfo>)>
where F: FnMut(ListResult<&SinkInfo>) + 'static
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(name.clone()).unwrap();
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&SinkInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_sink_info_by_name(self.context, c_name.as_ptr(),
Some(get_sink_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&SinkInfo>)>)
}
/// Gets information about a sink by its index.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_sink_info_by_index<F>(&self, index: u32, callback: F)
-> Operation<dyn FnMut(ListResult<&SinkInfo>)>
where F: FnMut(ListResult<&SinkInfo>) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&SinkInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_sink_info_by_index(self.context, index,
Some(get_sink_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&SinkInfo>)>)
}
/// Gets the complete sink list.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_sink_info_list<F>(&self, callback: F) -> Operation<dyn FnMut(ListResult<&SinkInfo>)>
where F: FnMut(ListResult<&SinkInfo>) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&SinkInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_sink_info_list(self.context,
Some(get_sink_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&SinkInfo>)>)
}
/// Sets the volume of a sink device specified by its index.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_sink_volume_by_index(&mut self, index: u32, volume: &ChannelVolumes,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_sink_volume_by_index(self.context, index,
volume.as_ref(), cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Sets the volume of a sink device specified by its name.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_sink_volume_by_name(&mut self, name: &str, volume: &ChannelVolumes,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(name.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_sink_volume_by_name(self.context, c_name.as_ptr(),
volume.as_ref(), cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Sets the mute switch of a sink device specified by its index.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_sink_mute_by_index(&mut self, index: u32, mute: bool,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_sink_mute_by_index(self.context, index, mute as i32,
cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Sets the mute switch of a sink device specified by its name.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_sink_mute_by_name(&mut self, name: &str, mute: bool,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(name.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_sink_mute_by_name(self.context, c_name.as_ptr(),
mute as i32, cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Suspends/Resumes a sink.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn suspend_sink_by_name(&mut self, sink_name: &str, suspend: bool,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(sink_name.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_suspend_sink_by_name(self.context, c_name.as_ptr(),
suspend as i32, cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Suspends/Resumes a sink.
///
/// If `index` is [`def::INVALID_INDEX`] all sinks will be suspended.
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn suspend_sink_by_index(&mut self, index: u32, suspend: bool,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_suspend_sink_by_index(self.context, index,
suspend as i32, cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Changes the profile of a sink.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_sink_port_by_index(&mut self, index: u32, port: &str,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_port = CString::new(port.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_sink_port_by_index(self.context, index,
c_port.as_ptr(), cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Changes the profile of a sink.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_sink_port_by_name(&mut self, name: &str, port: &str,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(name.clone()).unwrap();
let c_port = CString::new(port.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_sink_port_by_name(self.context, c_name.as_ptr(),
c_port.as_ptr(), cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
}
/// Proxy for get sink info list callbacks.
/// Warning: This is for list cases only! On EOL it destroys the actual closure callback.
extern "C"
fn get_sink_info_list_cb_proxy(_: *mut ContextInternal, i: *const SinkInfoInternal, eol: i32,
userdata: *mut c_void)
{
let _ = std::panic::catch_unwind(|| {
callback_for_list_instance(i, eol, userdata, SinkInfo::new_from_raw);
});
}
////////////////////////////////////////////////////////////////////////////////////////////////////
// Source info
////////////////////////////////////////////////////////////////////////////////////////////////////
/// Stores information about a specific port of a source.
///
/// Please note that this structure can be extended as part of evolutionary API updates at any time
/// in any new release.
#[derive(Debug)]
pub struct SourcePortInfo<'a> {
/// Name of this port.
pub name: Option<Cow<'a, str>>,
/// Description of this port.
pub description: Option<Cow<'a, str>>,
/// The higher this value is, the more useful this port is as a default.
pub priority: u32,
/// A flag indicating availability status of this port.
pub available: def::PortAvailable,
/// An indentifier for the group of ports that share their availability status with each other.
///
/// This is meant especially for handling cases where one 3.5 mm connector is used for
/// headphones, headsets and microphones, and the hardware can only tell that something was
/// plugged in but not what exactly. In this situation the ports for all those devices share
/// their availability status, and PulseAudio can’t tell which one is actually plugged in, and
/// some application may ask the user what was plugged in. Such applications should get a list
/// of all card ports and compare their `availability_group` fields. Ports that have the same
/// group are those that need input from the user to determine which device was plugged in. The
/// application should then activate the user-chosen port.
///
/// May be `None`, in which case the port is not part of any availability group (which is the
/// same as having a group with only one member).
///
/// The group identifier must be treated as an opaque identifier. The string may look like an
/// ALSA control name, but applications must not assume any such relationship. The group naming
/// scheme can change without a warning.
///
/// Since one group can include both input and output ports, the grouping should be done using
/// `CardPortInfo` instead of `SourcePortInfo`, but this field is duplicated also in
/// `SourcePortInfo` (and `SinkPortInfo`) in case someone finds that convenient.
#[cfg(any(doc, feature = "pa_v14"))]
#[cfg_attr(docsrs, doc(cfg(feature = "pa_v14")))]
pub availability_group: Option<Cow<'a, str>>,
/// Port device type.
#[cfg(any(doc, feature = "pa_v14"))]
#[cfg_attr(docsrs, doc(cfg(feature = "pa_v14")))]
pub r#type: DevicePortType,
}
impl<'a> SourcePortInfo<'a> {
fn new_from_raw(p: *const SourcePortInfoInternal) -> Self {
assert!(!p.is_null());
let src = unsafe { &*p };
unsafe {
SourcePortInfo {
name: match src.name.is_null() {
false => Some(CStr::from_ptr(src.name).to_string_lossy()),
true => None,
},
description: match src.description.is_null() {
false => Some(CStr::from_ptr(src.description).to_string_lossy()),
true => None,
},
priority: src.priority,
available: def::PortAvailable::from_i32(src.available).unwrap(),
#[cfg(any(doc, feature = "pa_v14"))]
availability_group: match src.availability_group.is_null() {
false => Some(CStr::from_ptr(src.availability_group).to_string_lossy()),
true => None,
},
#[cfg(any(doc, feature = "pa_v14"))]
r#type: DevicePortType::from_u32(src.r#type).unwrap(),
}
}
}
}
/// Stores information about sources.
///
/// Please note that this structure can be extended as part of evolutionary API updates at any time
/// in any new release.
#[derive(Debug)]
pub struct SourceInfo<'a> {
/// Name of the source.
pub name: Option<Cow<'a, str>>,
/// Index of the source.
pub index: u32,
/// Description of this source.
pub description: Option<Cow<'a, str>>,
/// Sample spec of this source.
pub sample_spec: sample::Spec,
/// Channel map.
pub channel_map: channelmap::Map,
/// Owning module index, or `None`.
pub owner_module: Option<u32>,
/// Volume of the source.
pub volume: ChannelVolumes,
/// Mute switch of the sink.
pub mute: bool,
/// If this is a monitor source, the index of the owning sink, otherwise `None`.
pub monitor_of_sink: Option<u32>,
/// Name of the owning sink, or `None`.
pub monitor_of_sink_name: Option<Cow<'a, str>>,
/// Length of filled record buffer of this source.
pub latency: MicroSeconds,
/// Driver name.
pub driver: Option<Cow<'a, str>>,
/// Flags.
pub flags: def::SourceFlagSet,
/// Property list.
pub proplist: Proplist,
/// The latency this device has been configured to.
pub configured_latency: MicroSeconds,
/// Some kind of “base” volume that refers to unamplified/unattenuated volume in the context of
/// the input device.
pub base_volume: Volume,
/// State.
pub state: def::SourceState,
/// Number of volume steps for sources which do not support arbitrary volumes.
pub n_volume_steps: u32,
/// Card index, or `None`.
pub card: Option<u32>,
/// Set of available ports.
pub ports: Vec<SourcePortInfo<'a>>,
/// Pointer to active port in the set, or `None`.
pub active_port: Option<Box<SourcePortInfo<'a>>>,
/// Set of formats supported by the sink.
pub formats: Vec<format::Info>,
}
impl<'a> SourceInfo<'a> {
fn new_from_raw(p: *const SourceInfoInternal) -> Self {
assert!(!p.is_null());
let src = unsafe { &*p };
let mut port_vec = Vec::with_capacity(src.n_ports as usize);
assert!(src.n_ports == 0 || !src.ports.is_null());
for i in 0..src.n_ports as isize {
let indexed_ptr = unsafe { (*src.ports.offset(i)) as *mut SourcePortInfoInternal };
if !indexed_ptr.is_null() {
port_vec.push(SourcePortInfo::new_from_raw(indexed_ptr));
}
}
let mut formats_vec = Vec::with_capacity(src.n_formats as usize);
assert!(src.n_formats == 0 || !src.formats.is_null());
for i in 0..src.n_formats as isize {
let indexed_ptr = unsafe { (*src.formats.offset(i)) as *mut format::InfoInternal };
if !indexed_ptr.is_null() {
formats_vec.push(format::Info::from_raw_weak(indexed_ptr));
}
}
unsafe {
SourceInfo {
name: match src.name.is_null() {
false => Some(CStr::from_ptr(src.name).to_string_lossy()),
true => None,
},
index: src.index,
description: match src.description.is_null() {
false => Some(CStr::from_ptr(src.description).to_string_lossy()),
true => None,
},
sample_spec: src.sample_spec.into(),
channel_map: src.channel_map.into(),
owner_module: match src.owner_module {
def::INVALID_INDEX => None,
i => Some(i),
},
volume: src.volume.into(),
mute: match src.mute {
0 => false,
_ => true,
},
monitor_of_sink: match src.monitor_of_sink {
def::INVALID_INDEX => None,
i => Some(i),
},
monitor_of_sink_name: match src.monitor_of_sink_name.is_null() {
false => Some(CStr::from_ptr(src.monitor_of_sink_name).to_string_lossy()),
true => None,
},
latency: MicroSeconds(src.latency),
driver: match src.driver.is_null() {
false => Some(CStr::from_ptr(src.driver).to_string_lossy()),
true => None,
},
flags: def::SourceFlagSet::from_bits_truncate(src.flags),
proplist: Proplist::from_raw_weak(src.proplist),
configured_latency: MicroSeconds(src.configured_latency),
base_volume: Volume(src.base_volume),
state: src.state.into(),
n_volume_steps: src.n_volume_steps,
card: match src.card {
def::INVALID_INDEX => None,
i => Some(i),
},
ports: port_vec,
active_port: match src.active_port.is_null() {
true => None,
false => Some(Box::new(SourcePortInfo::new_from_raw(src.active_port))),
},
formats: formats_vec,
}
}
}
}
impl Introspector {
/// Gets information about a source by its name.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_source_info_by_name<F>(&self, name: &str, callback: F)
-> Operation<dyn FnMut(ListResult<&SourceInfo>)>
where F: FnMut(ListResult<&SourceInfo>) + 'static
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(name.clone()).unwrap();
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&SourceInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_source_info_by_name(self.context, c_name.as_ptr(),
Some(get_source_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&SourceInfo>)>)
}
/// Gets information about a source by its index.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_source_info_by_index<F>(&self, index: u32, callback: F)
-> Operation<dyn FnMut(ListResult<&SourceInfo>)>
where F: FnMut(ListResult<&SourceInfo>) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&SourceInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_source_info_by_index(self.context, index,
Some(get_source_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&SourceInfo>)>)
}
/// Gets the complete source list.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_source_info_list<F>(&self, callback: F)
-> Operation<dyn FnMut(ListResult<&SourceInfo>)>
where F: FnMut(ListResult<&SourceInfo>) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&SourceInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_source_info_list(self.context,
Some(get_source_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&SourceInfo>)>)
}
/// Sets the volume of a source device specified by its index.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_source_volume_by_index(&mut self, index: u32, volume: &ChannelVolumes,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_source_volume_by_index(self.context, index,
volume.as_ref(), cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Sets the volume of a source device specified by its name.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_source_volume_by_name(&mut self, name: &str, volume: &ChannelVolumes,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(name.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_source_volume_by_name(self.context,
c_name.as_ptr(), volume.as_ref(), cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Sets the mute switch of a source device specified by its index.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_source_mute_by_index(&mut self, index: u32, mute: bool,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_source_mute_by_index(self.context, index,
mute as i32, cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Sets the mute switch of a source device specified by its name.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_source_mute_by_name(&mut self, name: &str, mute: bool,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(name.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_source_mute_by_name(self.context, c_name.as_ptr(),
mute as i32, cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Suspends/Resumes a source.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn suspend_source_by_name(&mut self, name: &str, suspend: bool,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(name.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_suspend_source_by_name(self.context, c_name.as_ptr(),
suspend as i32, cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Suspends/Resumes a source.
///
/// If `index` is [`def::INVALID_INDEX`], all sources will be suspended.
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn suspend_source_by_index(&mut self, index: u32, suspend: bool,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_suspend_source_by_index(self.context, index,
suspend as i32, cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Changes the profile of a source.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_source_port_by_index(&mut self, index: u32, port: &str,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_port = CString::new(port.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_source_port_by_index(self.context, index,
c_port.as_ptr(), cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Changes the profile of a source.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_source_port_by_name(&mut self, name: &str, port: &str,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(name.clone()).unwrap();
let c_port = CString::new(port.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_source_port_by_name(self.context, c_name.as_ptr(),
c_port.as_ptr(), cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
}
/// Proxy for get source info list callbacks.
///
/// Warning: This is for list cases only! On EOL it destroys the actual closure callback.
extern "C"
fn get_source_info_list_cb_proxy(_: *mut ContextInternal, i: *const SourceInfoInternal, eol: i32,
userdata: *mut c_void)
{
let _ = std::panic::catch_unwind(|| {
callback_for_list_instance(i, eol, userdata, SourceInfo::new_from_raw);
});
}
////////////////////////////////////////////////////////////////////////////////////////////////////
// Server info
////////////////////////////////////////////////////////////////////////////////////////////////////
/// Server information.
///
/// Please note that this structure can be extended as part of evolutionary API updates at any time
/// in any new release.
#[derive(Debug)]
pub struct ServerInfo<'a> {
/// User name of the daemon process.
pub user_name: Option<Cow<'a, str>>,
/// Host name the daemon is running on.
pub host_name: Option<Cow<'a, str>>,
/// Version string of the daemon.
pub server_version: Option<Cow<'a, str>>,
/// Server package name (usually “pulseaudio”).
pub server_name: Option<Cow<'a, str>>,
/// Default sample specification.
pub sample_spec: sample::Spec,
/// Name of default sink.
pub default_sink_name: Option<Cow<'a, str>>,
/// Name of default source.
pub default_source_name: Option<Cow<'a, str>>,
/// A random cookie for identifying this instance of PulseAudio.
pub cookie: u32,
/// Default channel map.
pub channel_map: channelmap::Map,
}
impl<'a> ServerInfo<'a> {
fn new_from_raw(p: *const ServerInfoInternal) -> Self {
assert!(!p.is_null());
let src = unsafe { &*p };
unsafe {
ServerInfo {
user_name: match src.user_name.is_null() {
false => Some(CStr::from_ptr(src.user_name).to_string_lossy()),
true => None,
},
host_name: match src.host_name.is_null() {
false => Some(CStr::from_ptr(src.host_name).to_string_lossy()),
true => None,
},
server_version: match src.server_version.is_null() {
false => Some(CStr::from_ptr(src.server_version).to_string_lossy()),
true => None,
},
server_name: match src.server_name.is_null() {
false => Some(CStr::from_ptr(src.server_name).to_string_lossy()),
true => None,
},
sample_spec: src.sample_spec.into(),
default_sink_name: match src.default_sink_name.is_null() {
false => Some(CStr::from_ptr(src.default_sink_name).to_string_lossy()),
true => None,
},
default_source_name: match src.default_source_name.is_null() {
false => Some(CStr::from_ptr(src.default_source_name).to_string_lossy()),
true => None,
},
cookie: src.cookie,
channel_map: src.channel_map.into(),
}
}
}
}
impl Introspector {
/// Gets some information about the server.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_server_info<F>(&self, callback: F) -> Operation<dyn FnMut(&ServerInfo)>
where F: FnMut(&ServerInfo) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(&ServerInfo)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_server_info(self.context,
Some(get_server_info_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(&ServerInfo)>)
}
}
/// Proxy for get server info callbacks.
/// Warning: This is for single-use cases only! It destroys the actual closure callback.
extern "C"
fn get_server_info_cb_proxy(_: *mut ContextInternal, i: *const ServerInfoInternal,
userdata: *mut c_void)
{
let _ = std::panic::catch_unwind(|| {
assert!(!i.is_null());
let obj = ServerInfo::new_from_raw(i);
// Note, destroys closure callback after use - restoring outer box means it gets dropped
let mut callback = get_su_callback::<dyn FnMut(&ServerInfo)>(userdata);
(callback)(&obj);
});
}
////////////////////////////////////////////////////////////////////////////////////////////////////
// Module info
////////////////////////////////////////////////////////////////////////////////////////////////////
/// Stores information about modules.
///
/// Please note that this structure can be extended as part of evolutionary API updates at any time
/// in any new release.
#[derive(Debug)]
pub struct ModuleInfo<'a> {
/// Index of the module.
pub index: u32,
/// Name of the module.
pub name: Option<Cow<'a, str>>,
/// Argument string of the module.
pub argument: Option<Cow<'a, str>>,
/// Usage counter or `None` if invalid.
pub n_used: Option<u32>,
/// Property list.
pub proplist: Proplist,
}
impl<'a> ModuleInfo<'a> {
fn new_from_raw(p: *const ModuleInfoInternal) -> Self {
assert!(!p.is_null());
let src = unsafe { &*p };
unsafe {
ModuleInfo {
index: src.index,
name: match src.name.is_null() {
false => Some(CStr::from_ptr(src.name).to_string_lossy()),
true => None,
},
argument: match src.argument.is_null() {
false => Some(CStr::from_ptr(src.argument).to_string_lossy()),
true => None,
},
n_used: match src.n_used {
def::INVALID_INDEX => None,
i => Some(i),
},
proplist: Proplist::from_raw_weak(src.proplist),
}
}
}
}
impl Introspector {
/// Gets some information about a module by its index.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_module_info<F>(&self, index: u32, callback: F)
-> Operation<dyn FnMut(ListResult<&ModuleInfo>)>
where F: FnMut(ListResult<&ModuleInfo>) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&ModuleInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_module_info(self.context, index,
Some(mod_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&ModuleInfo>)>)
}
/// Gets the complete list of currently loaded modules.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_module_info_list<F>(&self, callback: F)
-> Operation<dyn FnMut(ListResult<&ModuleInfo>)>
where F: FnMut(ListResult<&ModuleInfo>) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&ModuleInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_module_info_list(self.context,
Some(mod_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&ModuleInfo>)>)
}
/// Loads a module.
///
/// Panics on error, i.e. invalid arguments or state. The callback is provided with the
/// index.
pub fn load_module<F>(&mut self, name: &str, argument: &str, callback: F)
-> Operation<dyn FnMut(u32)>
where F: FnMut(u32) + 'static
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(name.clone()).unwrap();
let c_arg = CString::new(argument.clone()).unwrap();
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(u32)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_load_module(self.context, c_name.as_ptr(),
c_arg.as_ptr(), Some(context_index_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(u32)>)
}
/// Unloads a module.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The callback must accept a `bool`, which indicates success.
pub fn unload_module<F>(&mut self, index: u32, callback: F) -> Operation<dyn FnMut(bool)>
where F: FnMut(bool) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(bool)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_unload_module(self.context, index,
Some(super::success_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
}
/// Proxy for get module info list callbacks.
///
/// Warning: This is for list cases only! On EOL it destroys the actual closure callback.
extern "C"
fn mod_info_list_cb_proxy(_: *mut ContextInternal, i: *const ModuleInfoInternal, eol: i32,
userdata: *mut c_void)
{
let _ = std::panic::catch_unwind(|| {
callback_for_list_instance(i, eol, userdata, ModuleInfo::new_from_raw);
});
}
/// Proxy for context index callbacks.
///
/// Warning: This is for single-use cases only! It destroys the actual closure callback.
extern "C"
fn context_index_cb_proxy(_: *mut ContextInternal, index: u32, userdata: *mut c_void) {
let _ = std::panic::catch_unwind(|| {
// Note, destroys closure callback after use - restoring outer box means it gets dropped
let mut callback = get_su_callback::<dyn FnMut(u32)>(userdata);
(callback)(index);
});
}
////////////////////////////////////////////////////////////////////////////////////////////////////
// Messages
////////////////////////////////////////////////////////////////////////////////////////////////////
impl Introspector {
/// Send a message to an object that registered a message handler.
///
/// The callback must accept two params, firstly a boolean indicating success if `true`, and
/// secondly, the response string. The response string may possibly not be given if
/// unsuccessful.
///
/// For more information see the [messaging_api.txt] documentation in the PulseAudio repository.
///
/// [messaging_api.txt]: https://gitlab.freedesktop.org/pulseaudio/pulseaudio/-/blob/master/doc/messaging_api.txt
#[cfg(any(doc, feature = "pa_v15"))]
#[cfg_attr(docsrs, doc(cfg(feature = "pa_v15")))]
pub fn send_message_to_object<F>(&mut self, recipient_name: &str, message: &str,
message_parameters: &str, callback: F) -> Operation<dyn FnMut(bool, Option<String>)>
where F: FnMut(bool, Option<String>) + 'static
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_recipient_name = CString::new(recipient_name.clone()).unwrap();
let c_message = CString::new(message.clone()).unwrap();
let c_message_parameters = CString::new(message_parameters.clone()).unwrap();
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(bool, Option<String>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_send_message_to_object(self.context,
c_recipient_name.as_ptr(), c_message.as_ptr(), c_message_parameters.as_ptr(),
Some(send_message_to_object_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool, Option<String>)>)
}
}
/// Proxy for send message to object callbacks.
///
/// Warning: This is for single-use cases only! It destroys the actual closure callback.
#[cfg(any(doc, feature = "pa_v15"))]
extern "C"
fn send_message_to_object_cb_proxy(_: *mut ContextInternal, success: i32, response: *const c_char,
userdata: *mut c_void)
{
let success_actual = match success {
0 => false,
_ => true,
};
let _ = std::panic::catch_unwind(|| {
let r = match response.is_null() {
true => None,
false => {
let tmp = unsafe { CStr::from_ptr(response) };
Some(tmp.to_string_lossy().into_owned())
},
};
// Note, destroys closure callback after use - restoring outer box means it gets dropped
let mut callback = get_su_callback::<dyn FnMut(bool, Option<String>)>(userdata);
(callback)(success_actual, r);
});
}
////////////////////////////////////////////////////////////////////////////////////////////////////
// Client info
////////////////////////////////////////////////////////////////////////////////////////////////////
/// Stores information about clients.
///
/// Please note that this structure can be extended as part of evolutionary API updates at any time
/// in any new release.
#[derive(Debug)]
pub struct ClientInfo<'a> {
/// Index of this client.
pub index: u32,
/// Name of this client.
pub name: Option<Cow<'a, str>>,
/// Index of the owning module, or `None`.
pub owner_module: Option<u32>,
/// Driver name.
pub driver: Option<Cow<'a, str>>,
/// Property list.
pub proplist: Proplist,
}
impl<'a> ClientInfo<'a> {
fn new_from_raw(p: *const ClientInfoInternal) -> Self {
assert!(!p.is_null());
let src = unsafe { &*p };
unsafe {
ClientInfo {
index: src.index,
name: match src.name.is_null() {
false => Some(CStr::from_ptr(src.name).to_string_lossy()),
true => None,
},
owner_module: match src.owner_module {
def::INVALID_INDEX => None,
i => Some(i),
},
driver: match src.driver.is_null() {
false => Some(CStr::from_ptr(src.driver).to_string_lossy()),
true => None,
},
proplist: Proplist::from_raw_weak(src.proplist),
}
}
}
}
impl Introspector {
/// Gets information about a client by its index.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_client_info<F>(&self, index: u32, callback: F)
-> Operation<dyn FnMut(ListResult<&ClientInfo>)>
where F: FnMut(ListResult<&ClientInfo>) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&ClientInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_client_info(self.context, index,
Some(get_client_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&ClientInfo>)>)
}
/// Gets the complete client list.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_client_info_list<F>(&self, callback: F)
-> Operation<dyn FnMut(ListResult<&ClientInfo>)>
where F: FnMut(ListResult<&ClientInfo>) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&ClientInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_client_info_list(self.context,
Some(get_client_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&ClientInfo>)>)
}
/// Kills a client.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The callback must accept a `bool`, which indicates success.
pub fn kill_client<F>(&mut self, index: u32, callback: F) -> Operation<dyn FnMut(bool)>
where F: FnMut(bool) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(bool)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_kill_client(self.context, index,
Some(super::success_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
}
/// Proxy for get sink info list callbacks.
///
/// Warning: This is for list cases only! On EOL it destroys the actual closure callback.
extern "C"
fn get_client_info_list_cb_proxy(_: *mut ContextInternal, i: *const ClientInfoInternal, eol: i32,
userdata: *mut c_void)
{
let _ = std::panic::catch_unwind(|| {
callback_for_list_instance(i, eol, userdata, ClientInfo::new_from_raw);
});
}
////////////////////////////////////////////////////////////////////////////////////////////////////
// Card info
////////////////////////////////////////////////////////////////////////////////////////////////////
/// Backwards compatable alias
#[deprecated(since = "2.28.0", note = "Use the name CardProfileInfo instead")]
pub type CardProfileInfo2<'a> = CardProfileInfo<'a>;
/// Stores information about a specific profile of a card.
///
/// Please note that this structure can be extended as part of evolutionary API updates at any time
/// in any new release.
#[derive(Debug)]
pub struct CardProfileInfo<'a> {
/// Name of this profile.
pub name: Option<Cow<'a, str>>,
/// Description of this profile.
pub description: Option<Cow<'a, str>>,
/// Number of sinks this profile would create.
pub n_sinks: u32,
/// Number of sources this profile would create.
pub n_sources: u32,
/// The higher this value is, the more useful this profile is as a default.
pub priority: u32,
/// Is this profile available? If this is `false`, meaning “unavailable”, then it makes no sense
/// to try to activate this profile. If this is `true`, it’s still not a guarantee that
/// activating the profile will result in anything useful, it just means that the server isn’t
/// aware of any reason why the profile would definitely be useless.
pub available: bool,
}
impl<'a> CardProfileInfo<'a> {
fn new_from_raw(p: *const CardProfileInfoInternal) -> Self {
assert!(!p.is_null());
let src = unsafe { &*p };
unsafe {
CardProfileInfo {
name: match src.name.is_null() {
false => Some(CStr::from_ptr(src.name).to_string_lossy()),
true => None,
},
description: match src.description.is_null() {
false => Some(CStr::from_ptr(src.description).to_string_lossy()),
true => None,
},
n_sinks: src.n_sinks,
n_sources: src.n_sources,
priority: src.priority,
available: match src.available {
0 => false,
_ => true,
},
}
}
}
}
/// Stores information about a specific port of a card.
///
/// Please note that this structure can be extended as part of evolutionary API updates at any time
/// in any new release.
#[derive(Debug)]
pub struct CardPortInfo<'a> {
/// Name of this port.
pub name: Option<Cow<'a, str>>,
/// Description of this port.
pub description: Option<Cow<'a, str>>,
/// The higher this value is, the more useful this port is as a default.
pub priority: u32,
/// Availability status of this port.
pub available: def::PortAvailable,
/// The direction of this port.
pub direction: direction::FlagSet,
/// Property list.
pub proplist: Proplist,
/// Latency offset of the port that gets added to the sink/source latency when the port is
/// active.
pub latency_offset: i64,
/// Set of available profiles.
pub profiles: Vec<CardProfileInfo<'a>>,
/// An indentifier for the group of ports that share their availability status with each other.
///
/// This is meant especially for handling cases where one 3.5 mm connector is used for
/// headphones, headsets and microphones, and the hardware can only tell that something was
/// plugged in but not what exactly. In this situation the ports for all those devices share
/// their availability status, and PulseAudio can’t tell which one is actually plugged in, and
/// some application may ask the user what was plugged in. Such applications should get a list
/// of all card ports and compare their `availability_group` fields. Ports that have the same
/// group are those that need input from the user to determine which device was plugged in. The
/// application should then activate the user-chosen port.
///
/// May be `None`, in which case the port is not part of any availability group (which is the
/// same as having a group with only one member).
///
/// The group identifier must be treated as an opaque identifier. The string may look like an
/// ALSA control name, but applications must not assume any such relationship. The group naming
/// scheme can change without a warning.
#[cfg(any(doc, feature = "pa_v14"))]
#[cfg_attr(docsrs, doc(cfg(feature = "pa_v14")))]
pub availability_group: Option<Cow<'a, str>>,
/// Port device type.
#[cfg(any(doc, feature = "pa_v14"))]
#[cfg_attr(docsrs, doc(cfg(feature = "pa_v14")))]
pub r#type: DevicePortType,
}
impl<'a> CardPortInfo<'a> {
fn new_from_raw(p: *const CardPortInfoInternal) -> Self {
assert!(!p.is_null());
let src = unsafe { &*p };
let mut profiles_vec = Vec::with_capacity(src.n_profiles as usize);
assert!(src.n_profiles == 0 || !src.profiles2.is_null());
for i in 0..src.n_profiles as isize {
let indexed_ptr =
unsafe { (*src.profiles2.offset(i)) as *mut CardProfileInfoInternal };
if !indexed_ptr.is_null() {
profiles_vec.push(CardProfileInfo::new_from_raw(indexed_ptr));
}
}
unsafe {
CardPortInfo {
name: match src.name.is_null() {
false => Some(CStr::from_ptr(src.name).to_string_lossy()),
true => None,
},
description: match src.description.is_null() {
false => Some(CStr::from_ptr(src.description).to_string_lossy()),
true => None,
},
priority: src.priority,
available: def::PortAvailable::from_i32(src.available).unwrap(),
direction: direction::FlagSet::from_bits_truncate(src.direction),
proplist: Proplist::from_raw_weak(src.proplist),
latency_offset: src.latency_offset,
profiles: profiles_vec,
#[cfg(any(doc, feature = "pa_v14"))]
availability_group: match src.availability_group.is_null() {
false => Some(CStr::from_ptr(src.availability_group).to_string_lossy()),
true => None,
},
#[cfg(any(doc, feature = "pa_v14"))]
r#type: DevicePortType::from_u32(src.r#type).unwrap(),
}
}
}
}
/// Stores information about cards.
///
/// Please note that this structure can be extended as part of evolutionary API updates at any time
/// in any new release.
#[derive(Debug)]
pub struct CardInfo<'a> {
/// Index of this card.
pub index: u32,
/// Name of this card.
pub name: Option<Cow<'a, str>>,
/// Index of the owning module, or `None`.
pub owner_module: Option<u32>,
/// Driver name.
pub driver: Option<Cow<'a, str>>,
/// Property list.
pub proplist: Proplist,
/// Set of ports.
pub ports: Vec<CardPortInfo<'a>>,
/// Set of available profiles.
pub profiles: Vec<CardProfileInfo<'a>>,
/// Pointer to active profile in the set, or `None`.
pub active_profile: Option<Box<CardProfileInfo<'a>>>,
}
impl<'a> CardInfo<'a> {
fn new_from_raw(p: *const CardInfoInternal) -> Self {
assert!(!p.is_null());
let src = unsafe { &*p };
let mut ports_vec = Vec::with_capacity(src.n_ports as usize);
assert!(src.n_ports == 0 || !src.ports.is_null());
for i in 0..src.n_ports as isize {
let indexed_ptr = unsafe { (*src.ports.offset(i)) as *mut CardPortInfoInternal };
if !indexed_ptr.is_null() {
ports_vec.push(CardPortInfo::new_from_raw(indexed_ptr));
}
}
let mut profiles_vec = Vec::with_capacity(src.n_profiles as usize);
assert!(src.n_profiles == 0 || !src.profiles2.is_null());
for i in 0..src.n_profiles as isize {
let indexed_ptr =
unsafe { (*src.profiles2.offset(i)) as *mut CardProfileInfoInternal };
if !indexed_ptr.is_null() {
profiles_vec.push(CardProfileInfo::new_from_raw(indexed_ptr));
}
}
unsafe {
CardInfo {
index: src.index,
name: match src.name.is_null() {
false => Some(CStr::from_ptr(src.name).to_string_lossy()),
true => None,
},
owner_module: match src.owner_module {
def::INVALID_INDEX => None,
i => Some(i),
},
driver: match src.driver.is_null() {
false => Some(CStr::from_ptr(src.driver).to_string_lossy()),
true => None,
},
proplist: Proplist::from_raw_weak(src.proplist),
ports: ports_vec,
profiles: profiles_vec,
active_profile: match src.active_profile2.is_null() {
true => None,
false => Some(Box::new(CardProfileInfo::new_from_raw(src.active_profile2))),
},
}
}
}
}
impl Introspector {
/// Gets information about a card by its index.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_card_info_by_index<F>(&self, index: u32, callback: F)
-> Operation<dyn FnMut(ListResult<&CardInfo>)>
where F: FnMut(ListResult<&CardInfo>) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&CardInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_card_info_by_index(self.context, index,
Some(get_card_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&CardInfo>)>)
}
/// Gets information about a card by its name.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_card_info_by_name<F>(&self, name: &str, callback: F)
-> Operation<dyn FnMut(ListResult<&CardInfo>)>
where F: FnMut(ListResult<&CardInfo>) + 'static
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(name.clone()).unwrap();
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&CardInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_card_info_by_name(self.context, c_name.as_ptr(),
Some(get_card_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&CardInfo>)>)
}
/// Gets the complete card list.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_card_info_list<F>(&self, callback: F) -> Operation<dyn FnMut(ListResult<&CardInfo>)>
where F: FnMut(ListResult<&CardInfo>) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&CardInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_card_info_list(self.context,
Some(get_card_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&CardInfo>)>)
}
/// Changes the profile of a card.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_card_profile_by_index(&mut self, index: u32, profile: &str,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_profile = CString::new(profile.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_card_profile_by_index(self.context, index,
c_profile.as_ptr(), cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Changes the profile of a card.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_card_profile_by_name(&mut self, name: &str, profile: &str,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(name.clone()).unwrap();
let c_profile = CString::new(profile.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_card_profile_by_name(self.context, c_name.as_ptr(),
c_profile.as_ptr(), cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Sets the latency offset of a port.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_port_latency_offset(&mut self, card_name: &str, port_name: &str, offset: i64,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(card_name.clone()).unwrap();
let c_port = CString::new(port_name.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_port_latency_offset(self.context, c_name.as_ptr(),
c_port.as_ptr(), offset, cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
}
/// Proxy for get card info list callbacks.
///
/// Warning: This is for list cases only! On EOL it destroys the actual closure callback.
extern "C"
fn get_card_info_list_cb_proxy(_: *mut ContextInternal, i: *const CardInfoInternal, eol: i32,
userdata: *mut c_void)
{
let _ = std::panic::catch_unwind(|| {
callback_for_list_instance(i, eol, userdata, CardInfo::new_from_raw);
});
}
////////////////////////////////////////////////////////////////////////////////////////////////////
// Sink input info
////////////////////////////////////////////////////////////////////////////////////////////////////
/// Stores information about sink inputs.
///
/// Please note that this structure can be extended as part of evolutionary API updates at any time
/// in any new release.
#[derive(Debug)]
pub struct SinkInputInfo<'a> {
/// Index of the sink input.
pub index: u32,
/// Name of the sink input.
pub name: Option<Cow<'a, str>>,
/// Index of the module this sink input belongs to, or `None` when it does not belong to any
/// module.
pub owner_module: Option<u32>,
/// Index of the client this sink input belongs to, or invalid when it does not belong to any
/// client.
pub client: Option<u32>,
/// Index of the connected sink.
pub sink: u32,
/// The sample specification of the sink input.
pub sample_spec: sample::Spec,
/// Channel map.
pub channel_map: channelmap::Map,
/// The volume of this sink input.
pub volume: ChannelVolumes,
/// Latency due to buffering in sink input, see [`TimingInfo`](crate::def::TimingInfo) for
/// details.
pub buffer_usec: MicroSeconds,
/// Latency of the sink device, see [`TimingInfo`](crate::def::TimingInfo) for details.
pub sink_usec: MicroSeconds,
/// The resampling method used by this sink input.
pub resample_method: Option<Cow<'a, str>>,
/// Driver name.
pub driver: Option<Cow<'a, str>>,
/// Stream muted.
pub mute: bool,
/// Property list.
pub proplist: Proplist,
/// Stream corked.
pub corked: bool,
/// Stream has volume. If not set, then the meaning of this struct’s volume member is
/// unspecified.
pub has_volume: bool,
/// The volume can be set. If not set, the volume can still change even though clients can’t
/// control the volume.
pub volume_writable: bool,
/// Stream format information.
pub format: format::Info,
}
impl<'a> SinkInputInfo<'a> {
fn new_from_raw(p: *const SinkInputInfoInternal) -> Self {
assert!(!p.is_null());
let src = unsafe { &*p };
unsafe {
SinkInputInfo {
index: src.index,
name: match src.name.is_null() {
false => Some(CStr::from_ptr(src.name).to_string_lossy()),
true => None,
},
owner_module: match src.owner_module {
def::INVALID_INDEX => None,
i => Some(i),
},
client: match src.client {
def::INVALID_INDEX => None,
i => Some(i),
},
sink: src.sink,
sample_spec: src.sample_spec.into(),
channel_map: src.channel_map.into(),
volume: src.volume.into(),
buffer_usec: MicroSeconds(src.buffer_usec),
sink_usec: MicroSeconds(src.sink_usec),
resample_method: match src.resample_method.is_null() {
false => Some(CStr::from_ptr(src.resample_method).to_string_lossy()),
true => None,
},
driver: match src.driver.is_null() {
false => Some(CStr::from_ptr(src.driver).to_string_lossy()),
true => None,
},
mute: match src.mute {
0 => false,
_ => true,
},
proplist: Proplist::from_raw_weak(src.proplist),
corked: match src.corked {
0 => false,
_ => true,
},
has_volume: match src.has_volume {
0 => false,
_ => true,
},
volume_writable: match src.volume_writable {
0 => false,
_ => true,
},
format: format::Info::from_raw_weak(src.format as *mut format::InfoInternal),
}
}
}
}
impl Introspector {
/// Gets some information about a sink input by its index.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_sink_input_info<F>(&self, index: u32, callback: F)
-> Operation<dyn FnMut(ListResult<&SinkInputInfo>)>
where F: FnMut(ListResult<&SinkInputInfo>) + 'static
{
let cb_data =
box_closure_get_capi_ptr::<dyn FnMut(ListResult<&SinkInputInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_sink_input_info(self.context, index,
Some(get_sink_input_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&SinkInputInfo>)>)
}
/// Gets the complete sink input list.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_sink_input_info_list<F>(&self, callback: F)
-> Operation<dyn FnMut(ListResult<&SinkInputInfo>)>
where F: FnMut(ListResult<&SinkInputInfo>) + 'static
{
let cb_data =
box_closure_get_capi_ptr::<dyn FnMut(ListResult<&SinkInputInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_sink_input_info_list(self.context,
Some(get_sink_input_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&SinkInputInfo>)>)
}
/// Moves the specified sink input to a different sink.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn move_sink_input_by_name(&mut self, index: u32, sink_name: &str,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(sink_name.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_move_sink_input_by_name(self.context, index,
c_name.as_ptr(), cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Moves the specified sink input to a different sink.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn move_sink_input_by_index(&mut self, index: u32, sink_index: u32,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_move_sink_input_by_index(self.context, index,
sink_index, cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Sets the volume of a sink input stream.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_sink_input_volume(&mut self, index: u32, volume: &ChannelVolumes,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_sink_input_volume(self.context, index,
volume.as_ref(), cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Sets the mute switch of a sink input stream.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_sink_input_mute(&mut self, index: u32, mute: bool,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_sink_input_mute(self.context, index, mute as i32,
cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Kills a sink input.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The callback must accept a `bool`, which indicates success.
pub fn kill_sink_input<F>(&mut self, index: u32, callback: F) -> Operation<dyn FnMut(bool)>
where F: FnMut(bool) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(bool)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_kill_sink_input(self.context, index,
Some(super::success_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
}
/// Proxy for get sink input info list callbacks.
///
/// Warning: This is for list cases only! On EOL it destroys the actual closure callback.
extern "C"
fn get_sink_input_info_list_cb_proxy(_: *mut ContextInternal, i: *const SinkInputInfoInternal,
eol: i32, userdata: *mut c_void)
{
let _ = std::panic::catch_unwind(|| {
callback_for_list_instance(i, eol, userdata, SinkInputInfo::new_from_raw);
});
}
////////////////////////////////////////////////////////////////////////////////////////////////////
// Source output info
////////////////////////////////////////////////////////////////////////////////////////////////////
/// Stores information about source outputs.
///
/// Please note that this structure can be extended as part of evolutionary API updates at any time
/// in any new release.
#[derive(Debug)]
pub struct SourceOutputInfo<'a> {
/// Index of the source output.
pub index: u32,
/// Name of the source output.
pub name: Option<Cow<'a, str>>,
/// Index of the module this source output belongs to, or `None` when it does not belong to any
/// module.
pub owner_module: Option<u32>,
/// Index of the client this source output belongs to, or `None` when it does not belong to any
/// client.
pub client: Option<u32>,
/// Index of the connected source.
pub source: u32,
/// The sample specification of the source output.
pub sample_spec: sample::Spec,
/// Channel map.
pub channel_map: channelmap::Map,
/// Latency due to buffering in the source output, see [`TimingInfo`](crate::def::TimingInfo)
/// for details.
pub buffer_usec: MicroSeconds,
/// Latency of the source device, see [`TimingInfo`](crate::def::TimingInfo) for details.
pub source_usec: MicroSeconds,
/// The resampling method used by this source output.
pub resample_method: Option<Cow<'a, str>>,
/// Driver name.
pub driver: Option<Cow<'a, str>>,
/// Property list.
pub proplist: Proplist,
/// Stream corked.
pub corked: bool,
/// The volume of this source output.
pub volume: ChannelVolumes,
/// Stream muted.
pub mute: bool,
/// Stream has volume. If not set, then the meaning of this struct’s volume member is
/// unspecified.
pub has_volume: bool,
/// The volume can be set. If not set, the volume can still change even though clients can’t
/// control the volume.
pub volume_writable: bool,
/// Stream format information.
pub format: format::Info,
}
impl<'a> SourceOutputInfo<'a> {
fn new_from_raw(p: *const SourceOutputInfoInternal) -> Self {
assert!(!p.is_null());
let src = unsafe { &*p };
unsafe {
SourceOutputInfo {
index: src.index,
name: match src.name.is_null() {
false => Some(CStr::from_ptr(src.name).to_string_lossy()),
true => None,
},
owner_module: match src.owner_module {
def::INVALID_INDEX => None,
i => Some(i),
},
client: match src.client {
def::INVALID_INDEX => None,
i => Some(i),
},
source: src.source,
sample_spec: src.sample_spec.into(),
channel_map: src.channel_map.into(),
buffer_usec: MicroSeconds(src.buffer_usec),
source_usec: MicroSeconds(src.source_usec),
resample_method: match src.resample_method.is_null() {
false => Some(CStr::from_ptr(src.resample_method).to_string_lossy()),
true => None,
},
driver: match src.driver.is_null() {
false => Some(CStr::from_ptr(src.driver).to_string_lossy()),
true => None,
},
proplist: Proplist::from_raw_weak(src.proplist),
corked: match src.corked {
0 => false,
_ => true,
},
volume: src.volume.into(),
mute: match src.mute {
0 => false,
_ => true,
},
has_volume: match src.has_volume {
0 => false,
_ => true,
},
volume_writable: match src.volume_writable {
0 => false,
_ => true,
},
format: format::Info::from_raw_weak(src.format as *mut format::InfoInternal),
}
}
}
}
impl Introspector {
/// Gets information about a source output by its index.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_source_output_info<F>(&self, index: u32, callback: F)
-> Operation<dyn FnMut(ListResult<&SourceOutputInfo>)>
where F: FnMut(ListResult<&SourceOutputInfo>) + 'static
{
let cb_data =
box_closure_get_capi_ptr::<dyn FnMut(ListResult<&SourceOutputInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_source_output_info(self.context, index,
Some(get_source_output_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&SourceOutputInfo>)>)
}
/// Gets the complete list of source outputs.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_source_output_info_list<F>(&self, callback: F)
-> Operation<dyn FnMut(ListResult<&SourceOutputInfo>)>
where F: FnMut(ListResult<&SourceOutputInfo>) + 'static
{
let cb_data =
box_closure_get_capi_ptr::<dyn FnMut(ListResult<&SourceOutputInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_source_output_info_list(self.context,
Some(get_source_output_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&SourceOutputInfo>)>)
}
/// Moves the specified source output to a different source.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn move_source_output_by_name(&mut self, index: u32, source_name: &str,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(source_name.clone()).unwrap();
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_move_source_output_by_name(self.context, index,
c_name.as_ptr(), cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Moves the specified source output to a different source.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn move_source_output_by_index(&mut self, index: u32, source_index: u32,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_move_source_output_by_index(self.context, index,
source_index, cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Sets the volume of a source output stream.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_source_output_volume(&mut self, index: u32, volume: &ChannelVolumes,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_source_output_volume(self.context, index,
volume.as_ref(), cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Sets the mute switch of a source output stream.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The optional callback must accept a `bool`, which indicates success.
pub fn set_source_output_mute(&mut self, index: u32, mute: bool,
callback: Option<Box<dyn FnMut(bool) + 'static>>) -> Operation<dyn FnMut(bool)>
{
let (cb_fn, cb_data): (Option<extern "C" fn(_, _, _)>, _) =
get_su_capi_params::<_, _>(callback, super::success_cb_proxy);
let ptr = unsafe { capi::pa_context_set_source_output_mute(self.context, index, mute as i32,
cb_fn, cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
/// Kills a source output.
///
/// Panics on error, i.e. invalid arguments or state.
///
/// The callback must accept a `bool`, which indicates success.
pub fn kill_source_output<F>(&mut self, index: u32, callback: F) -> Operation<dyn FnMut(bool)>
where F: FnMut(bool) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(bool)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_kill_source_output(self.context, index,
Some(super::success_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(bool)>)
}
}
/// Proxy for get source output info list callbacks.
///
/// Warning: This is for list cases only! On EOL it destroys the actual closure callback.
extern "C"
fn get_source_output_info_list_cb_proxy(_: *mut ContextInternal, i: *const SourceOutputInfoInternal,
eol: i32, userdata: *mut c_void)
{
let _ = std::panic::catch_unwind(|| {
callback_for_list_instance(i, eol, userdata, SourceOutputInfo::new_from_raw);
});
}
////////////////////////////////////////////////////////////////////////////////////////////////////
// Stat info
////////////////////////////////////////////////////////////////////////////////////////////////////
impl Introspector {
/// Gets daemon memory block statistics.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn stat<F>(&self, callback: F) -> Operation<dyn FnMut(&StatInfo)>
where F: FnMut(&StatInfo) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(&StatInfo)>(Box::new(callback));
let ptr =
unsafe { capi::pa_context_stat(self.context, Some(get_stat_info_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(&StatInfo)>)
}
}
/// Proxy for get stat info callbacks.
///
/// Warning: This is for single-use cases only! It destroys the actual closure callback.
extern "C"
fn get_stat_info_cb_proxy(_: *mut ContextInternal, i: *const StatInfo, userdata: *mut c_void) {
let _ = std::panic::catch_unwind(|| {
assert!(!i.is_null());
// Note, destroys closure callback after use - restoring outer box means it gets dropped
let mut callback = get_su_callback::<dyn FnMut(&StatInfo)>(userdata);
(callback)(unsafe { &*i });
});
}
////////////////////////////////////////////////////////////////////////////////////////////////////
// Sample info
////////////////////////////////////////////////////////////////////////////////////////////////////
/// Stores information about sample cache entries.
///
/// Please note that this structure can be extended as part of evolutionary API updates at any time
/// in any new release.
#[derive(Debug)]
pub struct SampleInfo<'a> {
/// Index of this entry.
pub index: u32,
/// Name of this entry.
pub name: Option<Cow<'a, str>>,
/// Default volume of this entry.
pub volume: ChannelVolumes,
/// Sample specification of the sample.
pub sample_spec: sample::Spec,
/// The channel map.
pub channel_map: channelmap::Map,
/// Duration of this entry.
pub duration: MicroSeconds,
/// Length of this sample in bytes.
pub bytes: u32,
/// Non-zero when this is a lazy cache entry.
pub lazy: bool,
/// In case this is a lazy cache entry, the filename for the sound file to be loaded on demand.
pub filename: Option<Cow<'a, str>>,
/// Property list for this sample.
pub proplist: Proplist,
}
impl<'a> SampleInfo<'a> {
fn new_from_raw(p: *const SampleInfoInternal) -> Self {
assert!(!p.is_null());
let src = unsafe { &*p };
unsafe {
SampleInfo {
index: src.index,
name: match src.name.is_null() {
false => Some(CStr::from_ptr(src.name).to_string_lossy()),
true => None,
},
volume: src.volume.into(),
sample_spec: src.sample_spec.into(),
channel_map: src.channel_map.into(),
duration: MicroSeconds(src.duration),
bytes: src.bytes,
lazy: match src.lazy {
0 => false,
_ => true,
},
filename: match src.filename.is_null() {
false => Some(CStr::from_ptr(src.filename).to_string_lossy()),
true => None,
},
proplist: Proplist::from_raw_weak(src.proplist),
}
}
}
}
impl Introspector {
/// Gets information about a sample by its name.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_sample_info_by_name<F>(&self, name: &str, callback: F)
-> Operation<dyn FnMut(ListResult<&SampleInfo>)>
where F: FnMut(ListResult<&SampleInfo>) + 'static
{
// Warning: New CStrings will be immediately freed if not bound to a variable, leading to
// as_ptr() giving dangling pointers!
let c_name = CString::new(name.clone()).unwrap();
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&SampleInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_sample_info_by_name(self.context, c_name.as_ptr(),
Some(get_sample_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&SampleInfo>)>)
}
/// Gets information about a sample by its index.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_sample_info_by_index<F>(&self, index: u32, callback: F)
-> Operation<dyn FnMut(ListResult<&SampleInfo>)>
where F: FnMut(ListResult<&SampleInfo>) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&SampleInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_sample_info_by_index(self.context, index,
Some(get_sample_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&SampleInfo>)>)
}
/// Gets the complete list of samples stored in the daemon.
///
/// Panics on error, i.e. invalid arguments or state.
pub fn get_sample_info_list<F>(&self, callback: F)
-> Operation<dyn FnMut(ListResult<&SampleInfo>)>
where F: FnMut(ListResult<&SampleInfo>) + 'static
{
let cb_data = box_closure_get_capi_ptr::<dyn FnMut(ListResult<&SampleInfo>)>(Box::new(callback));
let ptr = unsafe { capi::pa_context_get_sample_info_list(self.context,
Some(get_sample_info_list_cb_proxy), cb_data) };
Operation::from_raw(ptr, cb_data as *mut Box<dyn FnMut(ListResult<&SampleInfo>)>)
}
}
/// Proxy for get sample info list callbacks.
///
/// Warning: This is for list cases only! On EOL it destroys the actual closure callback.
extern "C"
fn get_sample_info_list_cb_proxy(_: *mut ContextInternal, i: *const SampleInfoInternal, eol: i32,
userdata: *mut c_void)
{
let _ = std::panic::catch_unwind(|| {
callback_for_list_instance(i, eol, userdata, SampleInfo::new_from_raw);
});
}