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
/*! Rust API for the [Lab Streaming Layer](https://github.com/sccn/labstreaminglayer) (LSL). The lab streaming layer is a peer-to-peer pub/sub system on the local network that allows for real-time exchange of multi-channel time series (plus their meta-data) between applications and machines, with built-in cross-device time synchronization. The most common use case is in lab spaces to make, e.g., instrument data from different pieces of hardware (e.g., sensors) accessible in real time to client programs (e.g., experimentation scripts, recording programs, stream viewers, or live processing software). One of the main features of LSL is the uniform API that allows clients to read formatted multi-channel data from many device types (such as EEG, eye tracking, audio, human interface devices, events, etc.) with the same few lines of code. The API covers two areas: - The "push API" (aka publish) allows to create stream outlets and to push data (regular or irregular measurement time series, event data, coded audio/video frames, etc.) into them. - The "pull API" (aka subscribe) allows to create stream inlets and read time-synched experiment data from them (for recording, viewing or experiment control). This crate provides safe bindings to the [liblsl](https://github.com/sccn/liblsl) library via the low-level/raw `lsl-sys` crate. **Examples:** this library comes with example scripts for all common use cases (found in the crate's github repository). # Errors Operations that allocate OS resources (e.g., memory, sockets, etc) such as the `new()` functions of the main objects (`StreamInfo`, `StreamOutlet`, `StreamInlet`, `ContinuousResolver`) may return `Error::ResourceCreation` variants. */ use lsl_sys::*; use std::convert::{From, TryFrom}; use std::ffi; use std::fmt; use std::rc; use std::vec; /// Constant to indicate that a stream has variable sampling rate. pub const IRREGULAR_RATE: f64 = 0.0; /** Constant to indicate that a sample has the next successive time stamp. This is an optional optimization to transmit less data per sample. The stamp is then deduced from the preceding one according to the stream's sampling rate (in the case of an irregular rate, the same time stamp as before will is assumed). */ pub const DEDUCED_TIMESTAMP: f64 = -1.0; /** A very large time duration (> 1 year) for timeout values. Note that significantly larger numbers can cause the timeout to be invalid on some operating systems (e.g., 32-bit UNIX). */ pub const FOREVER: f64 = 32000000.0; /// Error type for all errors that can be returned by this library. #[derive(PartialEq, Eq, Copy, Clone, Debug)] pub enum Error { /// A bad argument was passed into a library function (e.g., negative number, string containing /// embedded zero bytes (which C libraries tend to not accept). BadArgument, /// A user-provided timeout has expired. Timeout, /// The stream that this is reading from has disappeared from the network and is unrecoverable. /// This can only happen if the stream had an empty `source_id` or if you turned off recovery. StreamLost, /// Resource creation failed. This is usually due to OS resource exhaustion (e.g., out of /// memory, thread handles, sockets, or the like). ResourceCreation, /// An internal error happened in the library. This is generally unlikely but can be returned /// by a variety of library calls. Internal, /// An unknown error has happened. There are only very few calls where this can happen since no /// detailed error codes are available in those cases, and is very unlikely to occur. Unknown, } /// Result type alias for results with library-specific errors. type Result<T> = std::result::Result<T, Error>; /// Data format of a channel (each transmitted sample holds an array of channels). #[derive(PartialEq, Eq, Copy, Clone, Debug)] pub enum ChannelFormat { /// For up to 24-bit precision measurements in the appropriate physical unit /// (e.g., microvolts). Integers from -16777216 to 16777216 are represented accurately. Float32 = 1, /// For universal numeric data as long as permitted by network & disk budget. /// The largest representable integer is 53-bit. Double64 = 2, /// For variable-length strings or data blobs, such as video frames, complex event /// descriptions, etc. String = 3, /// For high-rate digitized formats that require 32-bit precision. Depends critically on /// meta-data to represent meaningful units. Useful for application event codes or other /// coded data. Int32 = 4, /// For very high rate signals (40Khz+) such as consumer-grade audio /// (for professional audio, float is recommended). Int16 = 5, /// For binary signals or other coded data. Not recommended for encoding string data. Int8 = 6, /// Note that support for this type is not yet exposed in all languages. /// Also, some builds of liblsl (e.g., on 32-bit systems) will not be able to send or receive /// data of this type. Int64 = 7, /// Can not be transmitted. This is treated as an error/unknown value when used in conjunction /// with any of the API methods. Undefined = 0, } /// Post-processing options for stream inlets. #[derive(PartialEq, Eq, Copy, Clone, Debug)] pub enum ProcessingOption { /// No automatic post-processing; return the ground-truth time stamps for manual post- /// processing (this is the default behavior of the inlet). None = 0, /// Perform automatic clock synchronization; equivalent to manually adding the value returned /// by the `time_correction()` method to the received time stamps. ClockSync = 1, /// Remove jitter from time stamps. This will apply a smoothing algorithm to the received time /// stamps; the smoothing needs to see a minimum number of samples (30-120 seconds worst-case) /// until the remaining jitter is consistently below 1ms. Dejitter = 2, /// Force the time-stamps to be monotonically ascending (only makes sense if timestamps are /// dejittered). Monotonize = 4, /// Post-processing is thread-safe (same inlet can be read from by multiple threads); /// uses somewhat more CPU. Threadsafe = 8, /// The combination of all possible post-processing options. ALL = 1 | 2 | 4 | 8, } /** Protocol version number. - The major version is protocol_version() / 100; - The minor version is protocol_version() % 100; Clients with different minor versions are protocol-compatible with each other while clients with different major versions will refuse to work together (as of this writing, all versions are compatible with each other). */ pub fn protocol_version() -> i32 { unsafe { lsl_protocol_version() } } /** Version number of the liblsl library. - The major version is library_version() / 100; - The minor version is library_version() % 100; */ pub fn library_version() -> i32 { unsafe { lsl_library_version() } } /** Get a string containing library/build information. The format is considered an implementation detail and may change. This is mostly intended for debugging potential ABI or version issues. */ pub fn library_info() -> String { unsafe { make_string(lsl_library_info()) } } /** Obtain a local system time stamp in seconds. This clock should be used for all time measurements that are intended to be used in relation to LSL time stamps, since LSL cannot time-synchronize other kinds of clocks for you. *However*, if you build an application in which you have your own synchronized clocks (e.g., atomic clocks), it can make sense to use those other clocks. The resolution of this clock is better than a millisecond. The most common use case is to use this reading to assign time stamps to samples as they are being acquired. Specifically, if the *age* of a sample is known at a particular time (e.g., from USB transmission delays), it can be used as an offset to `local_clock()` to obtain a better (back-dated) estimate of when a sample was actually captured. See `StreamOutlet::push_sample()` for a use case. */ pub fn local_clock() -> f64 { unsafe { lsl_local_clock() } } // ========================== // === Stream Declaration === // ========================== /** The `StreamInfo` object stores the declaration of a data stream. It represents the following information: * stream data format (number of channels, channel format) * core information (stream name, content type, sampling rate) * optional meta-data about the stream content (channel labels, measurement units, etc.) Whenever a program wants to provide a new stream on the lab network it will typically first create a `StreamInfo` to describe its properties and then construct a `StreamOutlet` with it to create the stream on the network. The stream can then be discovered based on any of its meta-data, and recipients who discover the stream on the network can then query the full stream information. The content of the `StreamInfo` encompasses all the static information that is known up-front about a data stream, and therefore, anything you would expect to find in a file header for a streaming data file should be written into the stream info (in fact, if you use a tool to record one or more streams into an `XDF` file, the stream info goes into the file header. **Examples:** this library comes with example scripts for all common use cases (found in the crate's github repository). You can find various uses of the `StreamInfo` object in most of these files. */ #[derive(Debug)] pub struct StreamInfo { // internal fields handle: rc::Rc<StreamInfoHandle>, } impl StreamInfo { /** Construct a new `StreamInfo` object. Core stream information is specified here. Any remaining meta-data can be added subsequently. Arguments: * `stream_name`: Name of the stream. Describes the device (or product series) that this stream makes available (for use by programs, experimenters or data analysts). Cannot be empty. * `stream_type`: Content type of the stream. Please see [here](https://github.com/sccn/xdf/wiki/Meta-Data) (or web search for: XDF meta-data) for pre-defined content-type names that LSL adheres to, but you can also make up your own. The content type is the preferred way to find streams (as opposed to searching by name). * `channel_count`: Number of channels per sample. This stays constant for the lifetime of the stream. * `nominal_srate`: The sampling rate (in Hz) as advertised by the data source, if regular (otherwise set to `lsl::IRREGULAR_RATE`). * `channel_format`: Format/type of each channel. If your channels have different formats, consider supplying multiple streams or use the largest type that can hold them all (such as `ChannelFormat::Double64`). * `source_id`: Unique identifier of the device or source of the data, if available (such as the serial number). This is critical for system robustness since it allows recipients to recover from failure even after the serving app, device or computer crashes (just by finding a stream with the same source id on the network again). Therefore, it is highly recommended to always try to provide whatever information can uniquely identify the data source itself. If you don't have a unique id, you may use an empty str here. */ pub fn new( stream_name: &str, stream_type: &str, channel_count: u32, nominal_srate: f64, channel_format: ChannelFormat, source_id: &str, ) -> Result<StreamInfo> { if stream_name.is_empty() || nominal_srate < 0.0 || channel_count >= 0x80000000 { return Err(Error::BadArgument); } let stream_name = ffi::CString::new(stream_name)?; let stream_type = ffi::CString::new(stream_type)?; let source_id = ffi::CString::new(source_id)?; unsafe { let handle = lsl_create_streaminfo( stream_name.as_ptr(), stream_type.as_ptr(), channel_count as i32, nominal_srate, channel_format.to_native(), source_id.as_ptr(), ); match handle.is_null() { false => Ok(StreamInfo { handle: rc::Rc::new(StreamInfoHandle { handle }) }), true => Err(Error::ResourceCreation), } } } // ======================== // === Core Information === // ======================== // (these fields are assigned at construction) /** Name of the stream. This is a human-readable name. For streams offered by device modules, it refers to the type of device or product series that is generating the data of the stream. If the source is an application, the name may be a more generic or specific identifier. Multiple streams with the same name can coexist, though potentially at the cost of ambiguity (for the recording app or experimenter). */ pub fn stream_name(&self) -> String { unsafe { make_string(lsl_get_name(self.handle.handle )) } } /** Content type of the stream. The content type is a short string such as "EEG", "Gaze" which describes the content carried by the channel (if known). If a stream contains mixed content this value need not be assigned but may instead be stored in the description of channel types. To be useful to applications and automated processing systems, using the recommended content types is preferred. Content types usually follow those pre-defined [here](https://github.com/sccn/xdf/wiki/Meta-Data) (or web search for: XDF meta-data). */ pub fn stream_type(&self) -> String { unsafe { make_string(lsl_get_type(self.handle.handle )) } } /** Number of channels of the stream. A stream has at least one channel; the channel count stays constant for all samples. */ pub fn channel_count(&self) -> i32 { unsafe { lsl_get_channel_count(self.handle.handle ) } } /** Sampling rate of the stream, according to the source (in Hz). If a stream is irregularly sampled, this should be set to `lsl::IRREGULAR_RATE`. Note that no data will be lost even if this sampling rate is incorrect or if a device has temporary hiccups, since all samples will be recorded anyway (except for those dropped by the device itself). However, when the recording is imported into an application, a good importer may correct such errors more accurately if the advertised sampling rate was close to the specs of the device. */ pub fn nominal_srate(&self) -> f64 { unsafe { lsl_get_nominal_srate(self.handle.handle) } } /** Channel format of the stream. All channels in a stream have the same format. However, a device might offer multiple time-synched streams each with its own format. */ pub fn channel_format(&self) -> ChannelFormat { unsafe { ChannelFormat::from_native(lsl_get_channel_format(self.handle.handle)) } } /** Unique identifier of the stream's source, if available. The unique source (or device) identifier is an optional piece of information that, if available, allows that endpoints (such as the recording program) can re-acquire a stream automatically once it is back online. */ pub fn source_id(&self) -> String { unsafe { make_string(lsl_get_source_id(self.handle.handle)) } } // ====================================== // === Additional Hosting Information === // ====================================== // (these fields are implicitly assigned once bound to an outlet/inlet) /** Protocol version used to deliver the stream. Formatted like `lsl::protocol_version()`. */ pub fn version(&self) -> i32 { unsafe { lsl_get_version(self.handle.handle) } } /** Creation time stamp of the stream. This is the time stamp when the stream was first created (as determined via `lsl::local_clock()` on the providing machine). */ pub fn created_at(&self) -> f64 { unsafe { lsl_get_created_at(self.handle.handle) } } /** Unique ID of the stream outlet instance (once assigned). This is a unique identifier of the stream outlet, and is guaranteed to be different across multiple instantiations of the same outlet (e.g., after a re-start). */ pub fn uid(&self) -> String { unsafe { make_string(lsl_get_uid(self.handle.handle)) } } /** Session ID for the given stream. The session id is an optional human-assigned identifier of the recording session. While it is rarely used, it can be used to prevent concurrent recording activitites on the same sub-network (e.g., in multiple experiment areas) from seeing each other's streams (assigned via a configuration file by the experimenter, see Network Connectivity in the LSL wiki). */ pub fn session_id(&self) -> String { unsafe { make_string(lsl_get_session_id(self.handle.handle)) } } /** Hostname of the providing machine. */ pub fn hostname(&self) -> String { unsafe { make_string(lsl_get_hostname(self.handle.handle)) } } // ======================== // === Data Description === // ======================== /** Access the extended description of the stream. It is highly recommended that at least the channel labels are described here. See code examples on the LSL wiki. Other information, such as amplifier settings, measurement units if deviating from defaults, setup information, subject information, etc., can be specified here, as well. Meta-data recommendations follow the XDF file format project [here](https://github.com/sccn/xdf/wiki/Meta-Data) (or web search for: XDF meta-data). **Important:** if you use a stream content type for which meta-data recommendations exist, please try to lay out your meta-data in agreement with these recommendations for compatibility with other applications. */ pub fn desc(&mut self) -> XMLElement { unsafe { XMLElement { cursor: lsl_get_desc(self.handle.handle), // keep a shared ref of the underlying native handle since the xml element or // elements obtained from it may outlive the StreamInfo object doc: self.handle.clone() } } } /** Test whether the stream information matches the given query string. The query is evaluated using the same rules that govern `lsl::resolve_bypred()`. */ pub fn matches_query(&self, query: &str) -> bool { if let Ok(query) = ffi::CString::new(query) { unsafe { lsl_stream_info_matches_query(self.handle.handle, query.as_ptr()) != 0 } } else { false } } // =============================== // === Miscellaneous Functions === // =============================== /** Retrieve the entire streaminfo in XML format. This yields an XML document (in string form) whose top-level element is `<info>`. The info element contains one element for each field of the streaminfo class, including: * the core elements `<name>`, `<type>`, `<channel_count`, `<nominal_srate>`, `<channel_format>`, `<source_id>` * the misc elements `<version>`, `<created_at>`, `<uid>`, `<session_id>`, `<v4address>`, `<v4data_port>`, `<v4service_port>`, `<v6address>`, `<v6data_port>`, `<v6service_port>` * the extended description element `<desc>` with user-defined sub-elements. */ pub fn to_xml(&self) -> Result<String> { unsafe { let tmpstr = lsl_get_xml(self.handle.handle); if tmpstr.is_null() { return Err(Error::Internal); } let result = ffi::CStr::from_ptr(tmpstr).to_string_lossy().into_owned(); lsl_destroy_string(tmpstr); Ok(result) } } /// Number of bytes occupied by a channel (0 for string-typed channels). pub fn channel_bytes(&self) -> i32 { unsafe { lsl_get_channel_bytes(self.handle.handle) } } /// Number of bytes occupied by a sample (0 for string-typed channels). pub fn sample_bytes(&self) -> i32 { unsafe { lsl_get_sample_bytes(self.handle.handle) } } /// Construct a blank `StreamInfo`. pub fn from_blank() -> Result<StreamInfo> { StreamInfo::new("untitled", "", 0, 0.0, ChannelFormat::Undefined, "") } /** Create a `StreamInfo` from an XML string. */ pub fn from_xml(xml: &str) -> Result<StreamInfo> { let xml = ffi::CString::new(xml)?; unsafe { let handle = lsl_streaminfo_from_xml(xml.as_ptr()); match handle.is_null() { false => Ok(StreamInfo { handle: rc::Rc::new(StreamInfoHandle { handle }) }), true => Err(Error::ResourceCreation), } } } // === internal methods === /* Create a `StreamInfo` from a native handle. The info object takes ownership of the handle. This is considered internal since you can only get such a handle by calling raw native C library functions. */ fn from_handle(handle: lsl_streaminfo) -> StreamInfo { assert!( !handle.is_null(), "Attempted to create a StreamInfo from a NULL handle." ); StreamInfo { handle: rc::Rc::new(StreamInfoHandle { handle } ) } } // Get the native implementation handle. fn native_handle(&self) -> lsl_streaminfo { self.handle.handle } } impl Clone for StreamInfo { fn clone(&self) -> StreamInfo { unsafe { let handle = lsl_copy_streaminfo(self.handle.handle); assert!( !handle.is_null(), "Failed to clone native lsl_streaminfo object." ); StreamInfo { handle: rc::Rc::new(StreamInfoHandle { handle }) } } } } impl fmt::Display for StreamInfo { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!( f, "(name={}, type={}, fmt={}, srate={})", self.stream_name(), self.stream_type(), self.channel_format(), self.nominal_srate() ) } } // ======================= // ==== Stream Outlet ==== // ======================= /** A stream outlet. Outlets are used to make streaming data (and the meta-data) available on the lab network. The actual sample-pushing functionality is provided via the `Pushable` and `ExPushable` traits below. **Examples:** the `send_*.rs` examples (found in the crate's github repository) illustrate the use of `StreamOutlet`. */ #[derive(Debug)] pub struct StreamOutlet { // internal fields used by the Rust wrapper handle: lsl_outlet, channel_count: usize, nominal_rate: f64, } impl StreamOutlet { /** Establish a new stream outlet. This makes the stream discoverable. Arguments: * `info`: The stream information to use for creating this stream. Stays constant over the lifetime of the outlet. * `chunk_size`: The desired chunk granularity (in samples) for transmission. If specified as 0, each push operation yields one chunk. Inlets can override this setting. * `max_buffered`: The maximum amount of data to buffer (in seconds if there is a nominal sampling rate, otherwise x100 in samples). A good default is 360, which corresponds to 6 minutes of data. Note that, for high-bandwidth data you should consider using a lower value here to avoid running out of RAM in case data have to be buffered unexpectedly. */ pub fn new(info: &StreamInfo, chunk_size: i32, max_buffered: i32) -> Result<StreamOutlet> { let channel_count = info.channel_count() as usize; let nominal_rate = info.nominal_srate(); if chunk_size < 0 || max_buffered < 0 || channel_count >= 0x80000000 || nominal_rate < 0.0 { return Err(Error::BadArgument); } unsafe { let handle = lsl_create_outlet(info.native_handle(), chunk_size as i32, max_buffered as i32); match handle.is_null() { false => Ok(StreamOutlet { handle, channel_count, nominal_rate, }), true => Err(Error::ResourceCreation), } } } // =============================== // === Miscellaneous Functions === // =============================== /** Check whether consumers are currently registered. You can use this to disable sending data if there's no consumer (e.g. to save battery on an embedded device) -- however, this is not necessary and most production clients do not use it. */ pub fn have_consumers(&self) -> bool { unsafe { lsl_have_consumers(self.handle) != 0 } } /** Wait until some consumer shows up (without wasting resources, e.g., on embedded devices). To have no timeout, you can use the value `lsl::FOREVER` here. Returns True if the wait was successful, false if the timeout expired. Note that it is not necessary to do this, and most production clients do not use this feature. */ pub fn wait_for_consumers(&self, timeout: f64) -> bool { unsafe { lsl_wait_for_consumers(self.handle, timeout) != 0 } } /** Retrieve the stream info provided by this outlet. This is what was used to create the stream (and also has the Additional Network Information fields assigned). In extremely rare cases this may fail with an `Err::ResourceCreation` variant (e.g., due to out of memory). */ pub fn info(&self) -> Result<StreamInfo> { unsafe { let info_handle = lsl_get_info(self.handle); match info_handle.is_null() { // the handle already refers to a copy the outlet's info object so this operation // is trivial false => Ok(StreamInfo::from_handle(info_handle)), true => Err(Error::ResourceCreation), } } } // --- internal methods --- // Internal utility function that checks whether a given length value matches the channel count fn assert_len(&self, len: usize) { // we use assert since that's almost surely a sign of a fatal application bug assert_eq!( len, self.channel_count, "StreamOutlet received data whose length {} does not \ match the outlet's channel count {}", len, self.channel_count ); } /* Internal helper to implement `push_sample()` for numeric value types. Arguments: * `func`: the native FFI function to call to push a sample * `data`: A vector of values to push (one for each channel). * `timestamp`: Optionally the capture time of the sample, in agreement with `local_clock()`; if passed as 0.0, the current time is used. * `pushthrough`: Whether to push the sample through to the receivers instead of buffering it with subsequent samples. Typically this would be `true`. Note that the `chunk_size`, if specified at outlet construction, takes precedence over the pushthrough flag. */ fn safe_push_numeric<T>( &self, func: NativePushFunction<T>, data: &vec::Vec<T>, timestamp: f64, pushthrough: bool, ) -> Result<()> { self.assert_len(data.len()); unsafe { errcode_to_result(func(self.handle, data.as_ptr(), timestamp, pushthrough as i32))?; } Ok(()) } /* Internal helper to implement `push_sample()` for value types that can be converted to `&[u8]` byte slices via `.as_ref()`. Arguments: * `data`: A vector of values to push (one for each channel). * `timestamp`: Optionally the capture time of the sample, in agreement with `local_clock()`; if passed as 0.0, the current time is used. * `pushthrough`: Whether to push the sample through to the receivers instead of buffering it with subsequent samples. Typically this would be `true`. Note that the `chunk_size`, if specified at outlet construction, takes precedence over the pushthrough flag. */ fn safe_push_blob<T: AsRef<[u8]>>( &self, data: &vec::Vec<T>, timestamp: f64, pushthrough: bool, ) -> Result<()> { self.assert_len(data.len()); let ptrs: Vec<_> = data.iter().map(|x| x.as_ref().as_ptr()).collect(); let lens: Vec<_> = data .iter() .map(|x| u32::try_from(x.as_ref().len()).unwrap()) .collect(); unsafe { errcode_to_result(lsl_push_sample_buftp( self.handle, ptrs.as_ptr() as *mut *const std::os::raw::c_char, lens.as_ptr(), timestamp, pushthrough as i32, ))?; } Ok(()) } } /** A trait that enables the methods `push_sample<T>()` and `push_chunk<T>()`. Implemented by StreamOutlet. See also the `ExPushable` trait for the extended-argument versions of these methods, `push_sample_ex<T>()` and `push_chunk_ex<T>()`. **Note:** If you push in data that as the wrong size (array length not matching the declared number of channels), these functions will trigger an assertion and panic. */ pub trait Pushable<T> { /** Push a vector of values of some type as a sample into the outlet. Each entry in the vector corresponds to one channel. The function handles type checking & conversion. The data are time-stamped with the current time (using `local_clock()`), and immediately transmitted (unless a `chunk_size` was provided at outlet construction, which overrides in what granularity data are transmitted). See also `push_chunk_ex()` (provided by `ExPushable` trait) for a variant that allows for overriding the timestamp and implicit push-through (flush) behavior. */ fn push_sample(&self, data: &T) -> Result<()>; /** Push a chunk of samples (batched into a `Vec`) into the outlet. Each element of the given vector must itself be in a format accepted by `push_sample()` (e.g., `Vec`). The data are time-stamped with the current time (using `local_clock()`), and immediately transmitted (unless a `chunk_size` was provided at outlet construction, which causes the data to be internally re-aggregated into chunks of that specified size for transmission). See also `push_chunk_ex()` (provided by `ExPushable` trait) for a variant that allows for overriding the timestamp and implicit push-through (flush) behavior. */ fn push_chunk(&self, data: &vec::Vec<T>) -> Result<()>; /** Push a chunk of samples (batched into a `Vec`) along with a separate time stamp for each sample (for irregular-rate streams) into the outlet. Arguments: * `samples`: A `Vec` of samples, each in a format accepted by `push_sample()` (e.g., `Vec`). * `timestamps`: A `Vec` of capture times for each sample, in agreement with `local_clock()`. The data are immediately transmitted (unless a `chunk_size` was provided at outlet construction, which causes the data to be internally re-aggregated into chunks of that specified size for ttransmission). See also `push_chunk_ex()` (provided by `ExPushable` trait) for a variant that allows for overriding this behavior. */ fn push_chunk_stamped(&self, samples: &vec::Vec<T>, stamps: &vec::Vec<f64>) -> Result<()>; } // Pushable is basically a convenience layer on top of ExPushable impl<T, U: ExPushable<T>> Pushable<T> for U { fn push_sample(&self, data: &T) -> Result<()> { self.push_sample_ex(data, 0.0, true) } fn push_chunk(&self, data: &vec::Vec<T>) -> Result<()> { self.push_chunk_ex(data, 0.0, true) } fn push_chunk_stamped(&self, samples: &vec::Vec<T>, stamps: &vec::Vec<f64>) -> Result<()> { self.push_chunk_stamped_ex(samples, stamps, true) } } /** A trait that enables the methods `push_sample_ex<T>()` and `push_chunk_ex<T>()`. Implemented by StreamOutlet. See also the `Pushable` trait for the simpler methods `push_sample<T>()` and `push_chunk<T>()`. **Note:** If you push in data that as the wrong size (array length not matching the declared number of channels), these functions will trigger an assertion and panic. */ pub trait ExPushable<T>: HasNominalRate { /** Push a vector of values of some type as a sample into the outlet. Each entry in the vector corresponds to one channel. The function handles type checking & conversion. Arguments: * `data`: A vector of values to push (one for each channel). * `timestamp`: Optionally the capture time of the sample, in agreement with `local_clock()`; if passed as 0.0, the current time is used. * `pushthrough`: Whether to push the sample through to the receivers instead of buffering it with subsequent samples. Typically this would be `true`. Note that the `chunk_size`, if specified at outlet construction, takes precedence over the pushthrough flag. See also `push_sample()` for a simpler variant with default values for `timestamp` and `pushthrough` (defined in `Pushable` trait). */ fn push_sample_ex(&self, data: &T, timestamp: f64, pushthrough: bool) -> Result<()>; /** Push a chunk of samples (batched into a `Vec`) into the outlet. Arguments: * `samples`: A `Vec` of samples, each in a format accepted by `push_sample()` (e.g., `Vec`). * `timestamp`: Optionally the capture time of the most recent sample, in agreement with `local_clock()`; if specified as 0.0, the current time is used. The time stamps of other samples are automatically derived according to the sampling rate of the stream. * `pushthrough`: Whether to push the chunk through to the receivers instead of buffering it with subsequent samples. Typically this would be `true`. Note that the `chunk_size`, if specified at outlet construction, takes precedence over the pushthrough flag. See also `push_chunk()` for a simpler variant with default values for `timestamp` and `pushthrough` (defined in `Pushable` trait). */ fn push_chunk_ex( &self, samples: &vec::Vec<T>, timestamp: f64, pushthrough: bool, ) -> Result<()> { if !samples.is_empty() { let mut timestamp = if timestamp == 0.0 { local_clock() } else { timestamp }; let srate = self.nominal_srate(); let max_k = samples.len() - 1; // push first sample with calulated timestamp if srate != IRREGULAR_RATE { timestamp -= (max_k as f64) / srate; } self.push_sample_ex(&samples[0], timestamp, pushthrough && (samples.len() == 1))?; // push successive samples with deduced stamp for k in 1..=max_k { self.push_sample_ex(&samples[k], DEDUCED_TIMESTAMP, pushthrough && (k == max_k))?; } } Ok(()) } /** Push a chunk of samples (batched into a `Vec`) into the outlet. Allows for specifying a separate time stamp for each sample (for irregular-rate streams). Arguments: * `samples`: A `Vec` of samples, each in a format accepted by `push_sample()` (e.g., `Vec`). * `timestamps`: A `Vec` of capture times for each sample, in agreement with `local_clock()`. * `pushthrough`: Whether to push the chunk through to the receivers instead of buffering it with subsequent samples. Typically this would be `true`. Note that the `chunk_size`, if specified at outlet construction, takes precedence over the pushthrough flag. */ fn push_chunk_stamped_ex( &self, samples: &vec::Vec<T>, timestamps: &vec::Vec<f64>, pushthrough: bool, ) -> Result<()> { assert_eq!(samples.len(), timestamps.len()); let max_k = samples.len() - 1; // send all except last sample for k in 0..max_k { self.push_sample_ex(&samples[k], timestamps[k], false)?; } // send last sample with given pushthrough flag if !samples.is_empty() { self.push_sample_ex(&samples[max_k], timestamps[max_k], pushthrough)?; } Ok(()) } } impl ExPushable<vec::Vec<f32>> for StreamOutlet { fn push_sample_ex(&self, data: &vec::Vec<f32>, timestamp: f64, pushthrough: bool) -> Result<()> { self.safe_push_numeric(lsl_push_sample_ftp, data, timestamp, pushthrough) } } impl ExPushable<vec::Vec<f64>> for StreamOutlet { fn push_sample_ex(&self, data: &vec::Vec<f64>, timestamp: f64, pushthrough: bool) -> Result<()> { self.safe_push_numeric(lsl_push_sample_dtp, data, timestamp, pushthrough) } } impl ExPushable<vec::Vec<i8>> for StreamOutlet { fn push_sample_ex(&self, data: &vec::Vec<i8>, timestamp: f64, pushthrough: bool) -> Result<()> { self.safe_push_numeric(lsl_push_sample_ctp, data, timestamp, pushthrough) } } impl ExPushable<vec::Vec<i16>> for StreamOutlet { fn push_sample_ex(&self, data: &vec::Vec<i16>, timestamp: f64, pushthrough: bool) -> Result<()> { self.safe_push_numeric(lsl_push_sample_stp, data, timestamp, pushthrough) } } impl ExPushable<vec::Vec<i32>> for StreamOutlet { fn push_sample_ex(&self, data: &vec::Vec<i32>, timestamp: f64, pushthrough: bool) -> Result<()> { self.safe_push_numeric(lsl_push_sample_itp, data, timestamp, pushthrough) } } #[cfg(not(windows))] // TODO: once we upgrade to liblsl 1.14, we can drop this platform restriction impl ExPushable<vec::Vec<i64>> for StreamOutlet { fn push_sample_ex(&self, data: &vec::Vec<i64>, timestamp: f64, pushthrough: bool) -> Result<()> { self.safe_push_numeric(lsl_push_sample_ltp, data, timestamp, pushthrough) } } impl ExPushable<vec::Vec<String>> for StreamOutlet { fn push_sample_ex(&self, data: &vec::Vec<String>, timestamp: f64, pushthrough: bool) -> Result<()> { self.safe_push_blob(data, timestamp, pushthrough) } } impl ExPushable<vec::Vec<&str>> for StreamOutlet { fn push_sample_ex(&self, data: &vec::Vec<&str>, timestamp: f64, pushthrough: bool) -> Result<()> { self.safe_push_blob(data, timestamp, pushthrough) } } impl ExPushable<vec::Vec<&[u8]>> for StreamOutlet { fn push_sample_ex(&self, data: &vec::Vec<&[u8]>, timestamp: f64, pushthrough: bool) -> Result<()> { self.safe_push_blob(data, timestamp, pushthrough) } } impl Drop for StreamOutlet { fn drop(&mut self) { unsafe { lsl_destroy_outlet(self.handle); } } } /// Exposes a sampling rate via the method nominal_srate(). #[doc(hidden)] pub trait HasNominalRate { fn nominal_srate(&self) -> f64; } impl HasNominalRate for StreamOutlet { fn nominal_srate(&self) -> f64 { self.nominal_rate } } // =========================== // ==== Resolve Functions ==== // =========================== /** Resolve all streams on the network. This function returns all currently available streams from any outlet on the network. The network is usually the subnet specified at the local router, but may also include a multicast group of machines (given that the network supports it), or list of hostnames. These details may optionally be customized by the experimenter in a configuration file (see Network Connectivity in the LSL wiki). This is the default mechanism used by the browsing programs and the recording program. Arguments: * `wait_time`: The waiting time for the operation, in seconds, to search for streams. A good value is around 1.0 or 2.0 seconds. *Warning*: If this is too short (<0.5s) only a subset (or none) of the outlets that are present on the network may be returned. Returns a `Vec` of `StreamInfo` objects (excluding their desc field), any of which can subsequently be used to open an inlet. The full info can be retrieved from the inlet if needed. **Examples: the `receive_*.rs` examples (found in the crate's github repository) illustrate the use of the resolve functions. */ pub fn resolve_streams(wait_time: f64) -> Result<vec::Vec<StreamInfo>> { // the fixed-size buffer is safe since the native function uses it as the max number of results let mut buffer = [0 as lsl_streaminfo; 1024]; unsafe { let num_resolved = errcode_to_result(lsl_resolve_all( buffer.as_mut_ptr(), buffer.len() as u32, wait_time, ))? as usize; let results: Vec<_> = buffer[0..num_resolved] .iter() .map(|x| StreamInfo::from_handle(*x)) .collect(); Ok(results) } } /** Resolve all streams with a specific value for a given property. If the goal is to resolve a specific stream, this method is preferred over resolving all streams and then selecting the desired one. Arguments: * `prop`: The `StreamInfo` property that should have a specific value (e.g., "name", "type", "source_id", or "desc/manufaturer"). * `value`: The string value that the property should have (e.g., "EEG" as the type property). * `minimum`: Return at least this number of streams. * `timeout`: A timeout for the operation, in seconds. If the timeout expires, less than the desired number of streams (possibly none) will be returned. To have no timeout you can use the value `lsl::FOREVER` here, otherwise use at least 1.0 to 2.0 seconds to allow for results to come in on a busy network. *Warning*: If this is too short (<0.5s) only a subset (or none) of the outlets that are present on the network may be returned. Returns a `Vec` of `StreamInfo` objects (excluding their desc field), any of which can subsequently be used to open an inlet. The full info can be retrieved from the inlet if needed. In case of a timeout, the result is *not* an `Error::Timeout` but instead an shorter or empty result vector. **Examples: the `receive_*.rs` examples (found in the crate's github repository) illustrate the use of the resolve functions. */ pub fn resolve_byprop( prop: &str, value: &str, minimum: i32, wait_time: f64, ) -> Result<vec::Vec<StreamInfo>> { // the fixed-size buffer is safe since the native function uses it as the max number of results let mut buffer = [0 as lsl_streaminfo; 1024]; let prop = ffi::CString::new(prop)?; let value = ffi::CString::new(value)?; unsafe { let num_resolved = errcode_to_result(lsl_resolve_byprop( buffer.as_mut_ptr(), buffer.len() as u32, prop.as_ptr(), value.as_ptr(), minimum, wait_time, ))? as usize; let results: Vec<_> = buffer[0..num_resolved] .iter() .map(|x| StreamInfo::from_handle(*x)) .collect(); Ok(results) } } /** Resolve all streams that match a given predicate. Advanced query that allows to impose more conditions on the retrieved streams; the given string is an [XPath 1.0](http://en.wikipedia.org/w/index.php?title=XPath_1.0) predicate evaluated against the `<info>` element of the `StreamInfo`'s equivalent XML body (omitting the surrounding []'s), for each stream that's on the network. Arguments: * `pred`: The predicate string, e.g. `name='BioSemi'` or `type='EEG' and starts-with(name,'BioSemi') and count(info/desc/channel)=32` * `minimum`: Return at least this many streams. * `timeout`: A timeout for the operation, in seconds. If the timeout expires, less than the desired number of streams (possibly none) will be returned. To have no timeout you can use the value `lsl::FOREVER` here, otherwise use at least 1.0 to 2.0 seconds to allow for results to come in on a busy network. *Warning*: If this is too short (<0.5s) only a subset (or none) of the outlets that are present on the network may be returned. Returns a `Vec` of `StreamInfo` objects (excluding their desc field), any of which can subsequently be used to open an inlet. The full info can be retrieved from the inlet if needed. In case of a timeout, the result is *not* an `Error:Timeout` but instead an shorter or empty result vector. **Examples: the `receive_*.rs` examples (found in the crate's github repository) illustrate the use of the resolve functions. */ pub fn resolve_bypred(pred: &str, minimum: i32, wait_time: f64) -> Result<vec::Vec<StreamInfo>> { // the fixed-size buffer is safe since the native function uses it as the max number of results let mut buffer = [0 as lsl_streaminfo; 1024]; let pred = ffi::CString::new(pred)?; unsafe { let num_resolved = errcode_to_result(lsl_resolve_bypred( buffer.as_mut_ptr(), buffer.len() as u32, pred.as_ptr(), minimum, wait_time, ))? as usize; let results: Vec<_> = buffer[0..num_resolved] .iter() .map(|x| StreamInfo::from_handle(*x)) .collect(); Ok(results) } } // ====================== // ==== Stream Inlet ==== // ====================== /** A stream inlet. Inlets are used to receive streaming data (and meta-data) from the lab network. The actual sample-pulling functionality is provided via the `Pullable` trait below. **Examples:** the `receive_*.rs` examples (found in the crate's github repository) illustrate the use of `StreamInlet`. ### Errors For operations where a timeout is provided, if the operation does not complete in time, an `Error::Timeout` will be returned -- except for the `pull_*()` functions, where this is not considered an error. Also, for most operations, an `Error::StreamLost` is returned if the stream source has been lost in the meantime (see also `recover` option in the inlet's `new()` constructor). */ #[derive(Debug)] pub struct StreamInlet { // internal fields used by the Rust wrapper handle: lsl_inlet, channel_count: usize, } impl StreamInlet { /** Construct a new stream inlet from a resolved stream info. Arguments: * `info`: A resolved stream info object (as coming from one of the resolver functions). Note: the `StreamInlet` may also be constructed with a manually-constructed `StreamInfo`, if the desired channel format and count is already known up-front, but this is strongly discouraged and should only ever be done if there is no time to resolve the stream up-front (e.g., due to limitations in the client program). * `max_buflen`: The maximum amount of data to buffer (in seconds if there is a nominal sampling rate, otherwise x100 in samples). Recording applications want to use a fairly large buffer size here (a good default would be 360, which corresponds to 6 minutes of data), while real-time applications would only buffer as much as they need to perform their next calculation (e.g., 1-10). * `max_chunklen`: The maximum size, in samples, at which chunks are transmitted (the default corresponds to the chunk sizes used by the sender). If specified as 0, the chunk sizes preferred by the sender are used. Recording applications can use a generous size here (leaving it to the network how to pack things), while real-time applications may want a finer (perhaps 1-sample) granularity. * `recover`: Try to silently recover lost streams that are recoverable (those that that have a `source_id` set). In all other cases (`recover` is `false` or the stream is not recoverable) inlet methods may throw a `LostError` if the stream's source is lost (e.g., due to an app or computer crash). */ pub fn new( info: &StreamInfo, max_buflen: i32, max_chunklen: i32, recover: bool, ) -> Result<StreamInlet> { let channel_count = info.channel_count() as usize; if max_buflen < 0 || max_chunklen < 0 || channel_count >= 0x80000000 { return Err(Error::BadArgument); } unsafe { let handle = lsl_create_inlet( info.native_handle(), max_buflen, max_chunklen, recover as i32, ); match handle.is_null() { false => Ok(StreamInlet { handle, channel_count, }), true => Err(Error::ResourceCreation), } } } /** Retrieve the complete information of the given stream, including the extended description. Can be invoked at any time of the stream's lifetime. Arguments: * `timeout`: Timeout of the operation. You can use the value `lsl::FOREVER` to have no timeout. */ pub fn info(&self, timeout: f64) -> Result<StreamInfo> { let mut ec = [0 as i32]; unsafe { let handle = lsl_get_fullinfo(self.handle, timeout, ec.as_mut_ptr()); errcode_to_result(ec[0])?; match handle.is_null() { false => Ok(StreamInfo::from_handle(handle)), true => Err(Error::Unknown), } } } /** Subscribe to the data stream. All samples pushed in at the other end from this moment onwards will be queued and eventually be delivered in response to `pull_sample()` or `pull_chunk()` calls. In most applications it is not necessary to call this function since the stream will be opened implicitly upon the first call to any of the `pull_*()` operations. However, it can be used in order to not lose samples that had been sent over the stream prior to the first `pull_*()` call. Arguments: * `timeout` Optional timeout of the operation. To have no timeout, you can use `lsl::FOREVER` here. A timeout can make sense if you want to catch connection errors (e.g., due to misconfigured firewalls or the like). */ pub fn open_stream(&self, timeout: f64) -> Result<()> { let mut ec = [0 as i32]; unsafe { lsl_open_stream(self.handle, timeout, ec.as_mut_ptr()); errcode_to_result(ec[0])?; } Ok(()) } /** Unsubscribe from the current data stream. All samples that are still buffered or in flight will be dropped and transmission and buffering of data for this inlet will be stopped. If an application stops being interested in data from a source (temporarily or not) but keeps the outlet alive, it should call `close_stream()` to not waste unnecessary system and network resources. This feature is rarely used in practice since it's often simpler to just discard the whole inlet and later recreate it. */ pub fn close_stream(&self) { unsafe { lsl_close_stream(self.handle); } } /** Retrieve an estimated time correction offset for the given stream. The first call to this function takes several milliseconds until a reliable first estimate is obtained. Subsequent calls are instantaneous (and rely on periodic background updates). On a well-behaved network, the precision of these estimates should be below 1 ms (empirically it is within +/-0.2 ms). To get a measure of whether the network is well-behaved, see also the extended version `time_correction_ex()`, which additionally returns the round-trip-time, which is an upper bound for the uncertainty. Arguments: * `timeout`: Timeout to acquire the first time-correction estimate. You can use the value `lsl::FOREVER` to have no timeout. Otherwise, 2.0-5.0 seconds would be a reasonable timeout. Note that even if the timeout fails, the library will continue to attempt retrieving a time-correction estimate in the background, which can be queried in a subsequent call. */ pub fn time_correction(&self, timeout: f64) -> Result<f64> { let mut ec = [0 as i32]; unsafe { let result = lsl_time_correction(self.handle, timeout, ec.as_mut_ptr()); errcode_to_result(ec[0])?; Ok(result) } } /** Retrieve extended time-correction information for the given stream. This function is used like `time_correction()`, but instead returns additional information in a tuple of 3 values, which are (`time_offset`, `remote_time`, `uncertainty`), where: * `time_offset` corresponds to the return value of `time_correction()` (see for explanation). * `remote_time` is the remote time when the measurement was made, and consequently `remote_time + time_offset` is the local time when that measurement was made (this will typically lie as much as a few seconds before the current time point -- not because of inaccuracy, but because measurements are made periodically in the background, and the function only returns the most recent one of them). * `uncertainty` is the round-trip-time (RTT) of the measurement in seconds, which is a hard upper bound on the uncertainty of the time offset. Empirically, 0.2 ms a typical RTT for wired networks, 2 ms is typical of wireless networks, but it can be much higher on poor networks. */ pub fn time_correction_ex(&self, timeout: f64) -> Result<(f64, f64, f64)> { let mut ec = [0 as i32]; let mut retvals = [0.0, 0.0]; unsafe { let result = lsl_time_correction_ex( self.handle, retvals[0..].as_mut_ptr(), retvals[1..].as_mut_ptr(), timeout, ec.as_mut_ptr(), ); errcode_to_result(ec[0])?; Ok((result, retvals[0], retvals[1])) } } /** Set post-processing flags to use. By default, the inlet performs NO post-processing and returns the ground-truth time stamps, which can then be manually synchronized using `time_correction()`, and then smoothed/dejittered if desired. This function allows automating these two and possibly more operations. *Warning*: when you enable this, you will no longer receive or be able to recover the original time stamps. Arguments: * `options`: an array of `ProcessingOption` values that shall be set. You can also pass in the value `[ProcessingOption::ALL]` to enable all options or an empty array to clear all previously set options. */ pub fn set_postprocessing(&self, options: &[ProcessingOption]) -> Result<()> { let mut flags: u32 = 0; for &opt in options { flags |= opt as u32; } unsafe { let ec = lsl_set_postprocessing(self.handle, flags as u32); errcode_to_result(ec)?; Ok(()) } } /** Query whether samples are currently available for immediate pickup. Note that it is not a good idea to use `samples_available()` to determine whether a `pull_*()` call would block: to be sure, set the pull timeout to 0.0 or an acceptably low value. If the underlying implementation supports it, the value will be the number of samples available (otherwise it will be 1 or 0). */ pub fn samples_available(&self) -> u32 { unsafe { lsl_samples_available(self.handle) as u32 } } /** Query whether the clock was potentially reset since the last call to `was_clock_reset()`. This is a rarely-used function that is only useful to applications that combine multiple `time_correction` values to estimate precise clock drift; it allows to tolerate cases where the machine from which the stream is coming was hot-swapped or restarted in between two measurements. */ pub fn was_clock_reset(&self) -> bool { unsafe { lsl_was_clock_reset(self.handle) != 0 } } /** Override the half-time (forget factor) of the time-stamp smoothing. The default is 90 seconds unless a different value is set in the config file. Using a longer window will yield lower jitter in the time stamps, but longer windows will have trouble tracking changes in the clock rate (usually due to temperature changes); the default is able to track changes up to 10 degrees C per minute sufficiently well. */ pub fn smoothing_halftime(&self, value: f32) { unsafe { lsl_smoothing_halftime(self.handle, value as f32); } } // --- internal methods --- /* Internal helper to implement `pull_sample_buf()` safely for numeric value types, given a native function to do the actual job. Arguments: * `func`: the native FFI function to call to pull a sample * `buf`: a buffer to read into; will be resized if necessary * `timeout`: the timeout to pass in Returns the time stamp of the sample or 0.0 if no new data was available within the given timeout. */ fn safe_pull_numeric_buf<T: Clone + From<i8>>( &self, func: NativePullFunction<T>, buf: &mut vec::Vec<T>, timeout: f64, ) -> Result<f64> { let mut ec = [0 as i32]; if buf.len() != self.channel_count { buf.resize(self.channel_count, T::from(0)); } unsafe { let ts = func( self.handle, buf.as_mut_ptr(), buf.len() as i32, timeout, ec.as_mut_ptr(), ); errcode_to_result(ec[0])?; Ok(ts) } } /* Internal helper to implement `pull_sample()` safely for numeric value types, given a native function to do the actual job. Arguments: * `func`: the native FFI function to call to pull a sample * `timeout`: the timeout to pass in */ fn safe_pull_numeric<T: Clone + From<i8>>( &self, func: NativePullFunction<T>, timeout: f64, ) -> Result<(vec::Vec<T>, f64)> { let mut result = vec![T::from(0); self.channel_count]; let ts = self.safe_pull_numeric_buf(func, &mut result, timeout)?; if ts == 0.0 { result.clear(); } Ok((result, ts)) } /* Internal helper to implement `pull_sample_buf()` for types that can be be created from a `&[u8]` slice of bytes. Arguments: * `mapper`: a function that converts a `&[u8]` to an owned copy of type `T`. * `buf`: a buffer to read into; will be resized if necessary * `timeout`: the timeout to pass to the native function Returns the time stamp of the sample or 0.0 if no new data was available within the given timeout. */ fn safe_pull_blob_buf<T: Clone>( &self, mapper: fn(&[u8]) -> T, buf: &mut vec::Vec<T>, timeout: f64, ) -> Result<f64> { let mut ec = [0 as i32]; let mut ptrs = vec![0 as *mut ::std::os::raw::c_char; self.channel_count]; let mut lens = vec![0 as u32; self.channel_count]; unsafe { let ts = lsl_pull_sample_buf( self.handle, ptrs.as_mut_ptr(), lens.as_mut_ptr(), ptrs.len() as i32, timeout, ec.as_mut_ptr(), ); errcode_to_result(ec[0])?; if buf.len() != self.channel_count { buf.resize(self.channel_count, mapper(&[0 as u8; 0])); } if ts != 0.0 { for k in 0..ptrs.len() { let slice = std::slice::from_raw_parts(ptrs[k] as *const u8, lens[k] as usize); buf[k] = mapper(slice); lsl_destroy_string(ptrs[k]); } } Ok(ts) } } /* Internal helper to implement `pull_sample()` for types that can be be created from a `&[u8]` slice of bytes. Arguments: * `mapper`: a function that converts a `&[u8]` to an owned copy of type `T`. * `timeout`: the timeout to pass to the native function */ fn safe_pull_blob<T: Clone>( &self, mapper: fn(&[u8]) -> T, timeout: f64, ) -> Result<(vec::Vec<T>, f64)> { let mut ec = [0 as i32]; let mut ptrs = vec![0 as *mut ::std::os::raw::c_char; self.channel_count]; let mut lens = vec![0 as u32; self.channel_count]; // we're not calling safe_pull_blob_buf here since that would make unnecessary allocations // if there was no new data unsafe { let ts = lsl_pull_sample_buf( self.handle, ptrs.as_mut_ptr(), lens.as_mut_ptr(), ptrs.len() as i32, timeout, ec.as_mut_ptr(), ); errcode_to_result(ec[0])?; let mut sample = vec::Vec::<T>::new(); if ts != 0.0 { for k in 0..ptrs.len() { let slice = std::slice::from_raw_parts(ptrs[k] as *const u8, lens[k] as usize); sample.push(mapper(slice)); lsl_destroy_string(ptrs[k]); } } Ok((sample, ts)) } } } impl Drop for StreamInlet { fn drop(&mut self) { unsafe { lsl_destroy_inlet(self.handle); } } } /** A trait that enables the methods `pull_sample<T>()` and `pull_chunk<T>()`. Implemented by StreamInlet. */ pub trait Pullable<T> { /** Pull the next successive sample from an inlet and read it into a vector of values. Handles type checking & conversion. When using this function keep in mind that, if you do not pick up values for a while or at a sufficiently fast rate, you will fall behind in the data stream (up to a maximum of the inlet's `max_buflen` setting). Arguments: * `timeout`: The timeout for this operation, if any. If you use 0.0, the function will be non-blocking. You can also use `lsl::FOREVER` to have no timeout. Returns a tuple of `(sample, timestamp)`, where `sample` is a `Vec<T>` of values in the sample (each value corresponds to one channel, assuming the stream is multi-channel), and `timestamp` is the capture time of the sample on the remote side (e.g., remote machine). If no new sample was available, the sample vector will be empty and the timestamp will be 0.0 i.e., it will *not* return an `Error::Timeout` since we consider this a normal behavior. If you want to remap the time stamp to the local machine's clock, you can enable the clock synchronization option on the inlet using the `set_postprocessing()` method. Alternatively that can also be done manually by adding the return values of inlet's `time_correction()` method. */ fn pull_sample(&self, timeout: f64) -> Result<(vec::Vec<T>, f64)>; /** Pull the next successive sample from an inlet into a provided buffer. Handles type checking & conversion. When using this function keep in mind that, if you do not pick up values for a while or at a sufficiently fast rate, you will fall behind in the data stream (up to a maximum of the inlet's `max_buflen` setting). Arguments: * `buf`: A mutable buffer into which this function will read the data; the buffer will be resized (if necessary) to match the number of channels of the stream. * `timeout`: The timeout for this operation, if any. If you use 0.0, the function will be non-blocking. You can also use `lsl::FOREVER` to have no timeout. Returns the capture time of the sample on the remote side (e.g., remote machine). If no new sample was available, the returned timestamp will be 0.0, and the buffer will not be written to (although it may be resized as needed) -- i.e., it will *not* return an `Error::Timeout` since we consider this a normal behavior. If you want to remap the time stamp to the local machine's clock, you can enable the clock synchronization option on the inlet using the `set_postprocessing()` method. Alternatively that can also be done manually by adding the return values of inlet's `time_correction()` method. */ fn pull_sample_buf(&self, buf: &mut vec::Vec<T>, timeout: f64) -> Result<f64>; /** Pull a chunk of new samples and their time stamps from the inlet. This will return *all* new samples that you have not yet picked up since your last call (i.e., it can be anywhere between empty or a few-minute stretch). Note You can configure the maximum amount of buffered data via the `max_buflen` setting on the inlet -- if you allow data to accomulate beyond this amount, the oldest data samples will be discarded (for real-time processing applications it can make sense to set a low limit to avoid wasting resources, while for recording applications, a high limit is recommended). */ fn pull_chunk(&self) -> Result<(vec::Vec<vec::Vec<T>>, vec::Vec<f64>)> { let mut samples: vec::Vec<vec::Vec<T>> = vec![]; let mut stamps: vec::Vec<f64> = vec![]; loop { let (sample, stamp) = self.pull_sample(0.0)?; if stamp != 0.0 { samples.push(sample); stamps.push(stamp); } else { break; // no more data } } Ok((samples, stamps)) } } impl Pullable<f32> for StreamInlet { fn pull_sample(&self, timeout: f64) -> Result<(vec::Vec<f32>, f64)> { self.safe_pull_numeric(lsl_pull_sample_f, timeout) } fn pull_sample_buf(&self, buf: &mut vec::Vec<f32>, timeout: f64) -> Result<f64> { self.safe_pull_numeric_buf(lsl_pull_sample_f, buf, timeout) } } impl Pullable<f64> for StreamInlet { fn pull_sample(&self, timeout: f64) -> Result<(vec::Vec<f64>, f64)> { self.safe_pull_numeric(lsl_pull_sample_d, timeout) } fn pull_sample_buf(&self, buf: &mut vec::Vec<f64>, timeout: f64) -> Result<f64> { self.safe_pull_numeric_buf(lsl_pull_sample_d, buf, timeout) } } #[cfg(not(windows))] // TODO: once we upgrade to liblsl 1.14, we can drop this platform restriction impl Pullable<i64> for StreamInlet { fn pull_sample(&self, timeout: f64) -> Result<(vec::Vec<i64>, f64)> { self.safe_pull_numeric(lsl_pull_sample_l, timeout) } fn pull_sample_buf(&self, buf: &mut vec::Vec<i64>, timeout: f64) -> Result<f64> { self.safe_pull_numeric_buf(lsl_pull_sample_l, buf, timeout) } } impl Pullable<i32> for StreamInlet { fn pull_sample(&self, timeout: f64) -> Result<(vec::Vec<i32>, f64)> { self.safe_pull_numeric(lsl_pull_sample_i, timeout) } fn pull_sample_buf(&self, buf: &mut vec::Vec<i32>, timeout: f64) -> Result<f64> { self.safe_pull_numeric_buf(lsl_pull_sample_i, buf, timeout) } } impl Pullable<i16> for StreamInlet { fn pull_sample(&self, timeout: f64) -> Result<(vec::Vec<i16>, f64)> { self.safe_pull_numeric(lsl_pull_sample_s, timeout) } fn pull_sample_buf(&self, buf: &mut vec::Vec<i16>, timeout: f64) -> Result<f64> { self.safe_pull_numeric_buf(lsl_pull_sample_s, buf, timeout) } } impl Pullable<i8> for StreamInlet { fn pull_sample(&self, timeout: f64) -> Result<(vec::Vec<i8>, f64)> { self.safe_pull_numeric(lsl_pull_sample_c, timeout) } fn pull_sample_buf(&self, buf: &mut vec::Vec<i8>, timeout: f64) -> Result<f64> { self.safe_pull_numeric_buf(lsl_pull_sample_c, buf, timeout) } } impl Pullable<String> for StreamInlet { fn pull_sample(&self, timeout: f64) -> Result<(vec::Vec<String>, f64)> { self.safe_pull_blob(|x| String::from_utf8_lossy(x).into_owned(), timeout) } fn pull_sample_buf(&self, buf: &mut vec::Vec<String>, timeout: f64) -> Result<f64> { self.safe_pull_blob_buf(|x| String::from_utf8_lossy(x).into_owned(), buf, timeout) } } impl Pullable<vec::Vec<u8>> for StreamInlet { fn pull_sample(&self, timeout: f64) -> Result<(vec::Vec<vec::Vec<u8>>, f64)> { self.safe_pull_blob(|x| x.to_vec(), timeout) } fn pull_sample_buf(&self, buf: &mut vec::Vec<vec::Vec<u8>>, timeout: f64) -> Result<f64> { self.safe_pull_blob_buf(|x| x.to_vec(), buf, timeout) } } // ===================== // ==== XML Element ==== // ===================== /** A lightweight XML element tree; models the `.desc()` field of `StreamInfo`. This class can be tought of as a "cursor" in an XML document owned by the `StreamInfo`, which provides operations for navigating to parent, children and sibling elements, as well as modification operations for inserting or removing content. Each element has a name and can have multiple named children or have text content as value; attributes are omitted. Most operations return a node, which allows you to chain multiple operations. The API is modeled after a subset of pugixml's node type and is compatible with it. See also [here](https://pugixml.org/docs/manual.html#access) for additional documentation. **Note:** operations on non-existent nodes become safe no-ops instead of returning error variants or crashing. Since in most cases you will be writing data instead of navigating the tree and/or reading, you will rarely encounter this. You can rely on the `is_valid()` method to check the validity of the current element. **Examples:** the `*advanced.rs` examples (found in the crate's github repository) illustrate the use of `XMLElement` cursors. **Panics:** any strings passed into this function must be valid UTF8-encoded strings and contain no intermittent zero bytes (otherwise this will trigger an assertion). */ #[derive(Clone, Debug)] pub struct XMLElement { // internal fields cursor: lsl_xml_ptr, doc: rc::Rc<StreamInfoHandle>, } impl XMLElement { // === Tree Navigation === /// Get the first child of the element. pub fn first_child(&self) -> XMLElement { unsafe { XMLElement { cursor: lsl_first_child(self.cursor), doc: self.doc.clone(), } } } /// Get the last child of the element. pub fn last_child(&self) -> XMLElement { unsafe { XMLElement { cursor: lsl_last_child(self.cursor), doc: self.doc.clone(), } } } /// Get the next sibling in the children list of the parent node. pub fn next_sibling(&self) -> XMLElement { unsafe { XMLElement { cursor: lsl_next_sibling(self.cursor), doc: self.doc.clone(), } } } /// Get the previous sibling in the children list of the parent node. pub fn previous_sibling(&self) -> XMLElement { unsafe { XMLElement { cursor: lsl_previous_sibling(self.cursor), doc: self.doc.clone(), } } } /// Get the parent node. pub fn parent(&self) -> XMLElement { unsafe { XMLElement { cursor: lsl_parent(self.cursor), doc: self.doc.clone(), } } } // === Tree Navigation by Name === /// Get a child with a specified name. pub fn child(&self, name: &str) -> XMLElement { unsafe { let name = make_cstring(name); XMLElement { cursor: lsl_child(self.cursor, name.as_ptr()), doc: self.doc.clone(), } } } /// Get the next sibling with the specified name. pub fn next_sibling_named(&self, name: &str) -> XMLElement { unsafe { let name = make_cstring(name); XMLElement { cursor: lsl_next_sibling_n(self.cursor, name.as_ptr()), doc: self.doc.clone(), } } } /// Get the previous sibling with the specified name. pub fn previous_sibling_named(&self, name: &str) -> XMLElement { unsafe { let name = make_cstring(name); XMLElement { cursor: lsl_previous_sibling_n(self.cursor, name.as_ptr()), doc: self.doc.clone(), } } } // === Content Queries === /// Whether this node is empty. pub fn empty(&self) -> bool { unsafe { lsl_empty(self.cursor) != 0 } } /// Whether this is a text body (instead of an XML element). True both for plain char /// data and CData. pub fn is_text(&self) -> bool { unsafe { lsl_is_text(self.cursor) != 0 } } /// Name of the element. pub fn name(&self) -> String { unsafe { make_string(lsl_name(self.cursor)) } } /// Value of the element. pub fn value(&self) -> String { unsafe { make_string(lsl_value(self.cursor)) } } /// Get child value (value of the first child that is text). pub fn child_value(&self) -> String { unsafe { make_string(lsl_child_value(self.cursor)) } } /// Get child value of a child with a specified name. pub fn child_value_named(&self, name: &str) -> String { unsafe { let name = make_cstring(name); make_string(lsl_child_value_n(self.cursor, name.as_ptr())) } } // === Modification === /** Append a child node with a given name, and give it a (nameless) plain-text child with the given text value. Returns the same element on which the operation was performed (not the child). */ pub fn append_child_value(&mut self, name: &str, value: &str) -> XMLElement { unsafe { let name = make_cstring(name); let value = make_cstring(value); XMLElement { cursor: lsl_append_child_value(self.cursor, name.as_ptr(), value.as_ptr()), doc: self.doc.clone(), } } } /** Prepend a child node with a given name and give it a (nameless) plain-text child with the given text value. Returns the same element on which the operation was performed (not the child). */ pub fn prepend_child_value(&mut self, name: &str, value: &str) -> XMLElement { unsafe { let name = make_cstring(name); let value = make_cstring(value); XMLElement { cursor: lsl_prepend_child_value(self.cursor, name.as_ptr(), value.as_ptr()), doc: self.doc.clone(), } } } /// Set the text value of the (nameless) plain-text child of a named child node. pub fn set_child_value(&mut self, name: &str, value: &str) -> bool { unsafe { let name = make_cstring(name); let value = make_cstring(value); lsl_set_child_value(self.cursor, name.as_ptr(), value.as_ptr()) != 0 } } /// Set the element's name. Returns false if the node is empty (or if out of memory). pub fn set_name(&mut self, rhs: &str) -> bool { unsafe { let rhs = make_cstring(rhs); lsl_set_name(self.cursor, rhs.as_ptr()) != 0 } } /// Set the element's value. Returns false if the node is empty (or if out of memory). pub fn set_value(&mut self, rhs: &str) -> bool { unsafe { let rhs = make_cstring(rhs); lsl_set_value(self.cursor, rhs.as_ptr()) != 0 } } /// Append a child element with the specified name and return it. pub fn append_child(&mut self, name: &str) -> XMLElement { unsafe { let name = make_cstring(name); XMLElement { cursor: lsl_append_child(self.cursor, name.as_ptr()), doc: self.doc.clone(), } } } /// Prepend a child element with the specified name and return it. pub fn prepend_child(&mut self, name: &str) -> XMLElement { unsafe { let name = make_cstring(name); XMLElement { cursor: lsl_prepend_child(self.cursor, name.as_ptr()), doc: self.doc.clone(), } } } /// Append a copy of the specified element as a child and return a cursor to the result. pub fn append_copy(&mut self, e: XMLElement) -> XMLElement { unsafe { XMLElement { cursor: lsl_append_copy(self.cursor, e.cursor), doc: self.doc.clone(), } } } /// Prepend a child element with the specified name and return a cursor to the result. pub fn prepend_copy(&mut self, e: XMLElement) -> XMLElement { unsafe { XMLElement { cursor: lsl_prepend_copy(self.cursor, e.cursor), doc: self.doc.clone(), } } } /// Remove a specified child element. pub fn remove_child(&mut self, e: XMLElement) { unsafe { lsl_remove_child(self.cursor, e.cursor); } } /// Remove a child element with the specified name. pub fn remove_child_named(&mut self, name: &str) { unsafe { let name = make_cstring(name); lsl_remove_child_n(self.cursor, name.as_ptr()); } } /// Returns true if the current node is valid, false otherwise pub fn is_valid(&self) -> bool { !self.cursor.is_null() } } impl fmt::Display for XMLElement { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { if self.is_valid() { write!( f, "(name={}, value={}, parent name={})", self.name(), self.value(), self.parent().name() ) } else { write!(f, "(not valid)") } } } // ============================= // ==== Continuous Resolver ==== // ============================= /** A convenience class that resolves streams continuously in the background. This object can be queried at any time for the set of streams that are currently visible on the network. **Examples:** the `resolving_continuously.rs` example (found in the crate's github repository) illustrates the use of the `ContinuousResolver`. */ #[derive(Debug)] pub struct ContinuousResolver { handle: lsl_continuous_resolver, } impl ContinuousResolver { /** Construct a new continuous_resolver that resolves all streams on the network. This is analogous to the functionality offered by the free function `resolve_streams()`. Arguments: * `forget_after` When a stream is no longer visible on the network (e.g., because it was shut down), this is the time in seconds after which it is no longer reported by the resolver. A good value here is 5.0 to report any stream that had been visible in the last 5 seconds. */ pub fn new(forget_after: f64) -> Result<ContinuousResolver> { if forget_after <= 0.0 { return Err(Error::BadArgument); } unsafe { let handle = lsl_create_continuous_resolver(forget_after); match handle.is_null() { false => Ok(ContinuousResolver { handle }), true => Err(Error::ResourceCreation), } } } /** Construct a new `ContinuousResolver` that resolves all streams with a specific value for a given property. This is analogous to the functionality provided by the free function `resolve_stream(prop,value)`. Arguments: * `prop`: The `StreamInfo` property that should have a specific value (e.g., "name", "type", "source_id", or "desc/manufaturer"). * `value`: The string value that the property should have (e.g., "EEG" as the type property). * `forget_after`: When a stream is no longer visible on the network (e.g., because it was shut down), this is the time in seconds after which it is no longer reported by the resolver. */ pub fn new_with_prop(prop: &str, value: &str, forget_after: f64) -> Result<ContinuousResolver> { if forget_after <= 0.0 { return Err(Error::BadArgument); } let prop = ffi::CString::new(prop)?; let value = ffi::CString::new(value)?; unsafe { let handle = lsl_create_continuous_resolver_byprop(prop.as_ptr(), value.as_ptr(), forget_after); match handle.is_null() { false => Ok(ContinuousResolver { handle }), true => Err(Error::ResourceCreation), } } } /** Construct a new `ContinuousResolver` that resolves all streams with a specific value for a given property. This is analogous to the functionality provided by the free function `resolve_stream(prop,value)`. Arguments: * `prop`: The `StreamInfo` property that should have a specific value (e.g., "name", "type", "source_id", or "desc/manufaturer"). * `value`: The string value that the property should have (e.g., "EEG" as the type property). * `forget_after`: When a stream is no longer visible on the network (e.g., because it was shut down), this is the time in seconds after which it is no longer reported by the resolver. */ pub fn new_with_pred(pred: &str, forget_after: f64) -> Result<ContinuousResolver> { if forget_after <= 0.0 { return Err(Error::BadArgument); } let pred = ffi::CString::new(pred)?; unsafe { let handle = lsl_create_continuous_resolver_bypred(pred.as_ptr(), forget_after); match handle.is_null() { false => Ok(ContinuousResolver { handle }), true => Err(Error::ResourceCreation), } } } /** Obtain the set of currently present streams on the network (i.e. resolve result). Returns a vector of matching stream info objects (excluding their meta-data), any of which can subsequently be used to open an inlet. */ pub fn results(&self) -> Result<vec::Vec<StreamInfo>> { // the fixed-size buffer is safe since the native function uses it as the max number of // results let mut buffer = [0 as lsl_streaminfo; 1024]; unsafe { let num_resolved = errcode_to_result(lsl_resolver_results( self.handle, buffer.as_mut_ptr(), buffer.len() as u32, ))? as usize; let results: Vec<_> = buffer[0..num_resolved] .iter() .map(|x| StreamInfo::from_handle(*x)) .collect(); Ok(results) } } } impl Drop for ContinuousResolver { fn drop(&mut self) { unsafe { lsl_destroy_continuous_resolver(self.handle); } } } // ======================== // === Internal Helpers === // ======================== // wrapper around a native streaminfo handle #[derive(Debug)] struct StreamInfoHandle { handle: lsl_streaminfo } impl Drop for StreamInfoHandle { fn drop(&mut self) { unsafe { lsl_destroy_streaminfo(self.handle); } } } // internal signature of one of the lsl_push_sample_*tp functions type NativePushFunction<T> = unsafe extern "C" fn(lsl_outlet, *const T, f64, i32) -> i32; // internal signature of one of the lsl_pull_sample_* functions type NativePullFunction<T> = unsafe extern "C" fn(lsl_inlet, *mut T, i32, f64, *mut i32) -> f64; // helper functions for interop with native data types in the lsl_sys module impl ChannelFormat { /// Convert to corresponding native data type. pub fn to_native(&self) -> lsl_channel_format_t { match self { ChannelFormat::Float32 => lsl_channel_format_t_cft_float32, ChannelFormat::Double64 => lsl_channel_format_t_cft_double64, ChannelFormat::String => lsl_channel_format_t_cft_string, ChannelFormat::Int32 => lsl_channel_format_t_cft_int32, ChannelFormat::Int16 => lsl_channel_format_t_cft_int16, ChannelFormat::Int8 => lsl_channel_format_t_cft_int8, ChannelFormat::Int64 => lsl_channel_format_t_cft_int64, ChannelFormat::Undefined => lsl_channel_format_t_cft_undefined, } } /// Convert from the corresponding native data type. pub fn from_native(fmt: lsl_channel_format_t) -> ChannelFormat { #[allow(non_upper_case_globals)] match fmt { lsl_channel_format_t_cft_float32 => ChannelFormat::Float32, lsl_channel_format_t_cft_double64 => ChannelFormat::Double64, lsl_channel_format_t_cft_string => ChannelFormat::String, lsl_channel_format_t_cft_int32 => ChannelFormat::Int32, lsl_channel_format_t_cft_int16 => ChannelFormat::Int16, lsl_channel_format_t_cft_int8 => ChannelFormat::Int8, lsl_channel_format_t_cft_int64 => ChannelFormat::Int64, // Note that this will convert any unknown values that come ouf of the lib // into Undefined _ => ChannelFormat::Undefined, } } } impl fmt::Display for ChannelFormat { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { let s = match self { ChannelFormat::Float32 => "float32", ChannelFormat::Double64 => "double64", ChannelFormat::String => "string", ChannelFormat::Int32 => "int32", ChannelFormat::Int16 => "int16", ChannelFormat::Int8 => "int8", ChannelFormat::Int64 => "int64", ChannelFormat::Undefined => "undefined", }; write!(f, "{}", s) } } // error type conversion impl From<ffi::NulError> for Error { fn from(_: ffi::NulError) -> Error { Error::BadArgument } } // human-readable error messages impl fmt::Display for Error { // This trait requires `fmt` with this exact signature. fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { // Write strictly the first element into the supplied output // stream: `f`. Returns `fmt::Result` which indicates whether the // operation succeeded or failed. Note that `write!` uses syntax which // is very similar to `println!`. let msg = match self { Error::Timeout => "operation timed out", Error::StreamLost => "stream has been lost", Error::BadArgument => "incorrectly specified argument.", Error::ResourceCreation => "resource creation failed.", Error::Internal => "internal error in native library", Error::Unknown => "unknown error", }; write!(f, "{}", msg) } } /// Error trait for the custom Error enum. /// Since no further source information is available, this is omitted. impl std::error::Error for Error {} // Internal function that creates a CString from a well-formed utf8-encoded &str. This function // *panics* if a null byte is contained in s, therefore this should only be used in APIs that do // not return error values. fn make_cstring(s: &str) -> ffi::CString { // If you're getting this, you passed a string containing 0 bytes to the library. In the // context where it happened, this is a fatal error. ffi::CString::new(s).expect( "Embedded zero bytes are invalid in strings passed to liblsl.", ) } // Internal function that creates a String from a const char* returned by a trusted C routine. // Replaces invalid bytes by placeholder UTF8 characters. This function *panics* if a null pointer // is given it it, and therefore it should only be used with API return values where that's // unexpected, i.e., fatal. unsafe fn make_string(s: *const ::std::os::raw::c_char) -> String { // If this happens, the native library has returned a NULL pointer in a place where it // should not. This indicates a fatal library bug. assert!( !s.is_null(), "Attemt to create a string from a NULL pointer." ); ffi::CStr::from_ptr(s).to_string_lossy().into_owned() } // check whether a given value that may be an error code signals an error, // and convert to the correct Err() type or Ok(value) otherwise fn errcode_to_result(ec: i32) -> Result<i32> { if ec < 0 { #[allow(non_upper_case_globals)] match ec { lsl_error_code_t_lsl_timeout_error => Err(Error::Timeout), lsl_error_code_t_lsl_argument_error => Err(Error::BadArgument), lsl_error_code_t_lsl_lost_error => Err(Error::StreamLost), lsl_error_code_t_lsl_internal_error => Err(Error::Internal), _ => Err(Error::Unknown), } } else { Ok(ec) } }