/usr/include/csound/csound.h is in libcsound64-dev 1:6.08.0~dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 | #ifndef CSOUND_H
#define CSOUND_H
/*! \mainpage
*
* Csound is a unit generator-based, user-programmable,
* user-extensible computer music system. It was originally written
* by Barry Vercoe at the Massachusetts Institute of Technology in
* 1984 as the first C language version of this type of
* software. Since then Csound has received numerous contributions
* from researchers, programmers, and musicians from around the world.
*
* \section section_api_outline Outline of the API
*
* \subsection section_api_apilist The Csound Application Programming Interfaces
*
* The Csound Application Programming Interface (API) reference is contained
* herein.
* The Csound API actually consists of several APIs:
*
* - The basic Csound C API. Include csound.h and link with libcsound.a.
* This also includes the Cscore API (see below).
* - The basic Csound C++ API. Include csound.hpp and link with libcsound.a.
* - The interfaces API, includes a number of auxiliary C++ classes, which
* add functionality and support the wrapping of the Csound API by various
* languages (e.g. Python, Java, Lua).
*
* \b Purposes
*
* The purposes of the Csound API are as follows:
*
* \li Declare a stable public application programming interface (API)
* for Csound in csound.h. This is the only header file that needs
* to be \#included by users of the Csound API.
*
* \li Hide the internal implementation details of Csound from users of
* the API, so that development of Csound can proceed without affecting
* code that uses the API.
*
* \b Users
*
* Users of the Csound API fall into two main categories: hosts, and plugins.
*
* \li Hosts are applications that use Csound as a software synthesis engine.
* Hosts can link with the Csound API either statically or dynamically.
*
* \li Plugins are shared libraries loaded by Csound at run time to implement
* external opcodes and/or drivers for audio or MIDI input and output.
* Plugin opcodes need only include the csdl.h header which brings all
* necessary functions and data structures.
*
* \section section_api_c_example An Example Using the Csound API
*
* The Csound command--line program is itself built using the Csound API.
* Its code reads as follows:
*
* \code
* #include "csound.h"
*
* int main(int argc, char **argv)
* {
* // Create Csound.
* void *csound = csoundCreate(0);
* // One complete compile/perform cycle.
* int result = csoundCompile(csound, argc, argv);
* if(!result) {
* while(csoundPerformKsmps(csound) == 0){}
* csoundCleanup(csound);
* }
* // Destroy Csound.
* csoundDestroy(csound);
* return result;
* }
* \endcode
*
*
* Everything that can be done using C as in the above examples can also be done
* in a similar manner in Python or any of the other Csound API languages.
*
* \file csound.h
*
* \brief Declares the public Csound application programming interface (API).
* \author John P. ffitch, Michael Gogins, Matt Ingalls, John D. Ramsdell,
* Istvan Varga, Victor Lazzarini, Andres Cabrera and Steven Yi.
*
* Hosts using the Csound API must \#include <csound.h>, and link with the
* Csound API library. Plugin libraries should \#include <csdl.h> to get
* access to the API function pointers in the CSOUND structure, and do not
* need to link with the Csound API library.
* Only one of csound.h and csdl.h may be included by a compilation unit.
*
* Hosts must first create an instance of Csound using the \c csoundCreate
* API function. When hosts are finished using Csound, they must destroy the
* instance of csound using the \c csoundDestroy API function.
* Most of the other Csound API functions take the Csound instance as their
* first argument.
* Hosts can only call the standalone API functions declared in csound.h.
*
* Here is the complete code for the simplest possible Csound API host,
* a command-line Csound application:
*
* \code
*
* #include <csound.h>
*
* int main(int argc, char **argv)
* {
* CSOUND *csound = csoundCreate(NULL);
* int result = csoundCompile(csound, argc, argv);
* if (!result)
* result = csoundPerform(csound);
* csoundDestroy(csound);
* return (result >= 0 ? 0 : result);
* }
*
* \endcode
*
* All opcodes, including plugins, receive a pointer to their host
* instance of Csound as the first argument. Therefore, plugins MUST NOT
* compile, perform, or destroy the host instance of Csound, and MUST call
* the Csound API function pointers off the Csound instance pointer.
*
* \code
* MYFLT sr = csound->GetSr(csound);
* \endcode
*
* In general, plugins should ONLY access Csound functionality through the
* API function pointers and public members of the #CSOUND_ structure.
*
* \section section_licenses License
*
* \subsection section_csound_license Csound
*
* Copyright (C) 2001-2013 Michael Gogins, Matt Ingalls, John D. Ramsdell,
* John P. ffitch, Istvan Varga, Victor Lazzarini,
* Andres Cabrera and Steven Yi
*
* This software is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*
* Platform-dependent definitions and declarations.
*/
#if (defined(WIN32) || defined(_WIN32)) && !defined(SWIG)
# if defined(__BUILDING_LIBCSOUND)
# define PUBLIC __declspec(dllexport)
# define PUBLIC_DATA __declspec(dllexport)
# else
# define PUBLIC __declspec(dllexport)
# define PUBLIC_DATA __declspec(dllimport)
# endif
#elif defined(__GNUC__) && (__GNUC__ >= 4) /* && !defined(__MACH__) */
# define PUBLIC __attribute__ ( (visibility("default")) )
# define PUBLIC_DATA __attribute__ ( (visibility("default")) )
#else
# define PUBLIC
# define PUBLIC_DATA
#endif
#if defined(MSVC)
# include <intrin.h> /* for _InterlockedExchange */
#endif
#if defined(__MACH__)
// on OSX 10.6 i386 does not have all builtins
#if defined(MAC_OS_X_VERSION_10_6)
#ifdef HAVE_ATOMIC_BUILTIN
#ifndef __x86_64__
#undef HAVE_ATOMIC_BUILTIN
#endif
#endif
#endif
#endif
/**
* Enables Python interface.
*/
#ifdef SWIG
#define CS_PRINTF2
#define CS_PRINTF3
#include "float-version.h"
#ifndef __MYFLT_DEF
#define __MYFLT_DEF
#ifndef USE_DOUBLE
#define MYFLT float
#else
#define MYFLT double
#endif
#endif
%module csnd6
%{
# include "sysdep.h"
# include "text.h"
# include <stdarg.h>
%}
#else
# include "sysdep.h"
# include "text.h"
# include <stdarg.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
/**
* ERROR DEFINITIONS
*/
typedef enum
{
/* Completed successfully. */
CSOUND_SUCCESS = 0,
/* Unspecified failure. */
CSOUND_ERROR = -1,
/* Failed during initialization. */
CSOUND_INITIALIZATION = -2,
/* Failed during performance. */
CSOUND_PERFORMANCE = -3,
/* Failed to allocate requested memory. */
CSOUND_MEMORY = -4,
/* Termination requested by SIGINT or SIGTERM. */
CSOUND_SIGNAL = -5
} CSOUND_STATUS;
/* Compilation or performance aborted, but not as a result of an error
(e.g. --help, or running an utility with -U). */
#define CSOUND_EXITJMP_SUCCESS (256)
/**
* Flags for csoundInitialize().
*/
#define CSOUNDINIT_NO_SIGNAL_HANDLER 1
#define CSOUNDINIT_NO_ATEXIT 2
/**
* Types for keyboard callbacks set in csoundRegisterKeyboardCallback()
*/
#define CSOUND_CALLBACK_KBD_EVENT (0x00000001U)
#define CSOUND_CALLBACK_KBD_TEXT (0x00000002U)
/**
* The following constants are used with csound->FileOpen2() and
* csound->ldmemfile2() to specify the format of a file that is being
* opened. This information is passed by Csound to a host's FileOpen
* callback and does not influence the opening operation in any other
* way. Conversion from Csound's TYP_XXX macros for audio formats to
* CSOUND_FILETYPES values can be done with csound->type2csfiletype().
*/
typedef enum {
CSFTYPE_UNIFIED_CSD = 1, /* Unified Csound document */
CSFTYPE_ORCHESTRA, /* the primary orc file (may be temporary) */
CSFTYPE_SCORE, /* the primary sco file (may be temporary)
or any additional score opened by Cscore */
CSFTYPE_ORC_INCLUDE, /* a file #included by the orchestra */
CSFTYPE_SCO_INCLUDE, /* a file #included by the score */
CSFTYPE_SCORE_OUT, /* used for score.srt, score.xtr, cscore.out */
CSFTYPE_SCOT, /* Scot score input format */
CSFTYPE_OPTIONS, /* for .csoundrc and -@ flag */
CSFTYPE_EXTRACT_PARMS, /* extraction file specified by -x */
/* audio file types that Csound can write (10-19) or read */
CSFTYPE_RAW_AUDIO,
CSFTYPE_IRCAM,
CSFTYPE_AIFF,
CSFTYPE_AIFC,
CSFTYPE_WAVE,
CSFTYPE_AU,
CSFTYPE_SD2,
CSFTYPE_W64,
CSFTYPE_WAVEX,
CSFTYPE_FLAC,
CSFTYPE_CAF,
CSFTYPE_WVE,
CSFTYPE_OGG,
CSFTYPE_MPC2K,
CSFTYPE_RF64,
CSFTYPE_AVR,
CSFTYPE_HTK,
CSFTYPE_MAT4,
CSFTYPE_MAT5,
CSFTYPE_NIST,
CSFTYPE_PAF,
CSFTYPE_PVF,
CSFTYPE_SDS,
CSFTYPE_SVX,
CSFTYPE_VOC,
CSFTYPE_XI,
CSFTYPE_UNKNOWN_AUDIO, /* used when opening audio file for reading
or temp file written with <CsSampleB> */
/* miscellaneous music formats */
CSFTYPE_SOUNDFONT,
CSFTYPE_STD_MIDI, /* Standard MIDI file */
CSFTYPE_MIDI_SYSEX, /* Raw MIDI codes, eg. SysEx dump */
/* analysis formats */
CSFTYPE_HETRO,
CSFTYPE_HETROT,
CSFTYPE_PVC, /* original PVOC format */
CSFTYPE_PVCEX, /* PVOC-EX format */
CSFTYPE_CVANAL,
CSFTYPE_LPC,
CSFTYPE_ATS,
CSFTYPE_LORIS,
CSFTYPE_SDIF,
CSFTYPE_HRTF,
/* Types for plugins and the files they read/write */
CSFTYPE_VST_PLUGIN,
CSFTYPE_LADSPA_PLUGIN,
CSFTYPE_SNAPSHOT,
/* Special formats for Csound ftables or scanned synthesis
matrices with header info */
CSFTYPE_FTABLES_TEXT, /* for ftsave and ftload */
CSFTYPE_FTABLES_BINARY, /* for ftsave and ftload */
CSFTYPE_XSCANU_MATRIX, /* for xscanu opcode */
/* These are for raw lists of numbers without header info */
CSFTYPE_FLOATS_TEXT, /* used by GEN23, GEN28, dumpk, readk */
CSFTYPE_FLOATS_BINARY, /* used by dumpk, readk, etc. */
CSFTYPE_INTEGER_TEXT, /* used by dumpk, readk, etc. */
CSFTYPE_INTEGER_BINARY, /* used by dumpk, readk, etc. */
/* image file formats */
CSFTYPE_IMAGE_PNG,
/* For files that don't match any of the above */
CSFTYPE_POSTSCRIPT, /* EPS format used by graphs */
CSFTYPE_SCRIPT_TEXT, /* executable script files (eg. Python) */
CSFTYPE_OTHER_TEXT,
CSFTYPE_OTHER_BINARY,
/* This should only be used internally by the original FileOpen()
API call or for temp files written with <CsFileB> */
CSFTYPE_UNKNOWN = 0
} CSOUND_FILETYPES;
/*
* TYPE DEFINITIONS
*/
/*
* Forward declarations.
*/
typedef struct CSOUND_ CSOUND;
typedef struct windat_ WINDAT;
typedef struct xyindat_ XYINDAT;
/**
* csound configuration structure, mirrors part of
* OPARMS, uses more meaningful names
*/
typedef struct {
int debug_mode; /* debug mode, 0 or 1 */
int buffer_frames; /* number of frames in in/out buffers */
int hardware_buffer_frames; /* ibid. hardware */
int displays; /* graph displays, 0 or 1 */
int ascii_graphs; /* use ASCII graphs, 0 or 1 */
int postscript_graphs; /* use postscript graphs, 0 or 1 */
int message_level; /* message printout control */
int tempo; /* tempo (sets Beatmode) */
int ring_bell; /* bell, 0 or 1 */
int use_cscore; /* use cscore for processing */
int terminate_on_midi; /* terminate performance at the end
of midifile, 0 or 1 */
int heartbeat; /* print heart beat, 0 or 1 */
int defer_gen01_load ; /* defer GEN01 load, 0 or 1 */
int midi_key; /* pfield to map midi key no */
int midi_key_cps; /* pfield to map midi key no as cps */
int midi_key_oct; /* pfield to map midi key no as oct */
int midi_key_pch; /* pfield to map midi key no as pch */
int midi_velocity; /* pfield to map midi velocity */
int midi_velocity_amp; /* pfield to map midi velocity as amplitude */
int no_default_paths; /* disable relative paths from files, 0 or 1 */
int number_of_threads; /* number of threads for multicore performance */
int syntax_check_only; /* do not compile, only check syntax */
int csd_line_counts; /* csd line error reporting */
int compute_weights; /* deprecated, kept for backwards comp. */
int realtime_mode; /* use realtime priority mode, 0 or 1 */
int sample_accurate; /* use sample-level score event accuracy */
MYFLT sample_rate_override; /* overriding sample rate */
MYFLT control_rate_override; /* overriding control rate */
int nchnls_override; /* overriding number of out channels */
int nchnls_i_override; /* overriding number of in channels */
MYFLT e0dbfs_override; /* overriding 0dbfs */
int daemon; /* daemon mode */
int ksmps_override; /* ksmps override */
int FFT_library; /* fft_lib */
} CSOUND_PARAMS;
/**
* Device information
*/
typedef struct {
char device_name[64];
char device_id[64];
char rt_module[64];
int max_nchnls;
int isOutput;
} CS_AUDIODEVICE;
typedef struct {
char device_name[64];
char interface_name[64];
char device_id[64];
char midi_module[64];
int isOutput;
} CS_MIDIDEVICE;
/**
* Real-time audio parameters structure
*/
typedef struct {
/** device name (NULL/empty: default) */
char *devName;
/** device number (0-1023), 1024: default */
int devNum;
/** buffer fragment size (-b) in sample frames */
unsigned int bufSamp_SW;
/** total buffer size (-B) in sample frames */
int bufSamp_HW;
/** number of channels */
int nChannels;
/** sample format (AE_SHORT etc.) */
int sampleFormat;
/** sample rate in Hz */
float sampleRate;
} csRtAudioParams;
typedef struct RTCLOCK_S {
int_least64_t starttime_real;
int_least64_t starttime_CPU;
} RTCLOCK;
typedef struct {
char *opname;
char *outypes;
char *intypes;
int flags;
} opcodeListEntry;
typedef struct CsoundRandMTState_ {
int mti;
uint32_t mt[624];
} CsoundRandMTState;
/* PVSDATEXT is a variation on PVSDAT used in
the pvs bus interface */
typedef struct pvsdat_ext {
int32 N;
int sliding; /* Flag to indicate sliding case */
int32 NB;
int32 overlap;
int32 winsize;
int wintype;
int32 format;
uint32 framecount;
float* frame;
} PVSDATEXT;
typedef struct ORCTOKEN {
int type;
char *lexeme;
int value;
double fvalue;
char *optype;
struct ORCTOKEN *next;
} ORCTOKEN;
typedef struct TREE {
int type;
ORCTOKEN *value;
int rate;
int len;
int line;
uint64_t locn;
struct TREE *left;
struct TREE *right;
struct TREE *next;
void *markup; // TEMPORARY - used by semantic checker to
// markup node adds OENTRY or synthetic var
// names to expression nodes should be moved
// to TYPE_TABLE
} TREE;
/**
* Constants used by the bus interface (csoundGetChannelPtr() etc.).
*/
typedef enum {
CSOUND_CONTROL_CHANNEL = 1,
CSOUND_AUDIO_CHANNEL = 2,
CSOUND_STRING_CHANNEL = 3,
CSOUND_PVS_CHANNEL = 4,
CSOUND_VAR_CHANNEL = 5,
CSOUND_CHANNEL_TYPE_MASK = 15,
CSOUND_INPUT_CHANNEL = 16,
CSOUND_OUTPUT_CHANNEL = 32
} controlChannelType;
typedef enum {
CSOUND_CONTROL_CHANNEL_NO_HINTS = 0,
CSOUND_CONTROL_CHANNEL_INT = 1,
CSOUND_CONTROL_CHANNEL_LIN = 2,
CSOUND_CONTROL_CHANNEL_EXP = 3
} controlChannelBehavior;
/**
* This structure holds the parameter hints for control channels
*
*/
typedef struct controlChannelHints_s {
controlChannelBehavior behav;
MYFLT dflt;
MYFLT min;
MYFLT max;
int x;
int y;
int width;
int height;
/** This member must be set explicitly to NULL if not used */
char *attributes;
} controlChannelHints_t;
typedef struct controlChannelInfo_s {
char *name;
int type;
controlChannelHints_t hints;
} controlChannelInfo_t;
typedef void (*channelCallback_t)(CSOUND *csound,
const char *channelName,
void *channelValuePtr,
const void *channelType);
#ifndef CSOUND_CSDL_H
/** @defgroup INSTANTIATION Instantiation
*
* @{ */
/**
* Initialise Csound library with specific flags. This function is called
* internally by csoundCreate(), so there is generally no need to use it
* explicitly unless you need to avoid default initilization that sets
* signal handlers and atexit() callbacks.
* Return value is zero on success, positive if initialisation was
* done already, and negative on error.
*/
PUBLIC int csoundInitialize(int flags);
/**
* Creates an instance of Csound. Returns an opaque pointer that
* must be passed to most Csound API functions. The hostData
* parameter can be NULL, or it can be a pointer to any sort of
* data; this pointer can be accessed from the Csound instance
* that is passed to callback routines.
*/
PUBLIC CSOUND *csoundCreate(void *hostData);
/**
* Destroys an instance of Csound.
*/
PUBLIC void csoundDestroy(CSOUND *);
/**
* Returns the version number times 1000 (5.00.0 = 5000).
*/
PUBLIC int csoundGetVersion(void);
/**
* Returns the API version number times 100 (1.00 = 100).
*/
PUBLIC int csoundGetAPIVersion(void);
/** @}*/
/** @defgroup PERFORMANCE Performance
*
* @{ */
/**
* Parse the given orchestra from an ASCII string into a TREE.
* This can be called during performance to parse new code.
*/
PUBLIC TREE *csoundParseOrc(CSOUND *csound, const char *str);
/**
* Compile the given TREE node into structs for Csound to use
* this can be called during performance to compile a new TREE
*/
PUBLIC int csoundCompileTree(CSOUND *csound, TREE *root);
/**
* Free the resources associated with the TREE *tree
* This function should be called whenever the TREE was
* created with csoundParseOrc and memory can be deallocated.
**/
PUBLIC void csoundDeleteTree(CSOUND *csound, TREE *tree);
/**
* Parse, and compile the given orchestra from an ASCII string,
* also evaluating any global space code (i-time only)
* this can be called during performance to compile a new orchestra.
* /code
* char *orc = "instr 1 \n a1 rand 0dbfs/4 \n out a1 \n";
* csoundCompileOrc(csound, orc);
* /endcode
*/
PUBLIC int csoundCompileOrc(CSOUND *csound, const char *str);
/**
* Parse and compile an orchestra given on an string,
* evaluating any global space code (i-time only).
* On SUCCESS it returns a value passed to the
* 'return' opcode in global space
* /code
* char *code = "i1 = 2 + 2 \n return i1 \n";
* MYFLT retval = csoundEvalCode(csound, code);
* /endcode
*/
PUBLIC MYFLT csoundEvalCode(CSOUND *csound, const char *str);
/**
* Prepares an instance of Csound for Cscore
* processing outside of running an orchestra (i.e. "standalone Cscore").
* It is an alternative to csoundCompile(), and
* csoundPerform*() and should not be used with these functions.
* You must call this function before using the interface in "cscore.h"
* when you do not wish to compile an orchestra.
* Pass it the already open FILE* pointers to the input and
* output score files.
* It returns CSOUND_SUCCESS on success and CSOUND_INITIALIZATION or other
* error code if it fails.
*/
PUBLIC int csoundInitializeCscore(CSOUND *, FILE *insco, FILE *outsco);
/**
* Read arguments, parse and compile an orchestra, read, process and
* load a score.
*/
PUBLIC int csoundCompileArgs(CSOUND *, int argc, const char **argv);
/**
* Prepares Csound for performance after compilation
* using one or more of the above functions.
* NB: this is called internally by csoundCompile(), therefore
* it is only required if performance is started without
* a call to that function
*/
PUBLIC int csoundStart(CSOUND *csound);
/**
* Compiles Csound input files (such as an orchestra and score, or CSD)
* as directed by the supplied command-line arguments,
* but does not perform them. Returns a non-zero error code on failure.
* This function cannot be called during performance, and before a
* repeated call, csoundReset() needs to be called.
* In this (host-driven) mode, the sequence of calls should be as follows:
* /code
* csoundCompile(csound, argc, argv);
* while (!csoundPerformBuffer(csound));
* csoundCleanup(csound);
* csoundReset(csound);
* /endcode
* Calls csoundStart() internally.
* Can only be called again after reset (see csoundReset())
*/
PUBLIC int csoundCompile(CSOUND *, int argc, const char **argv);
/**
* Compiles a Csound input file (CSD, .csd file)
* which includes command-line arguments,
* but does not perform the file. Returns a non-zero error code on failure.
* In this (host-driven) mode, the sequence of calls should be as follows:
* /code
* csoundCompileCsd(csound, str);
* while (!csoundPerformBuffer(csound));
* csoundCleanup(csound);
* csoundReset(csound);
* /endcode
* NB: this function can be called during performance to
* replace or add new instruments and events.
* On a first call and if called before csoundStart(), this function
* behaves similarly to csoundCompile()
*
*/
PUBLIC int csoundCompileCsd(CSOUND *csound, const char *str);
/**
* Compiles a Csound input file contained in a string of text,
* which includes command-line arguments, orchestra, score, etc.,
* but does not perform the file. Returns a non-zero error code on failure.
* In this (host-driven) mode, the sequence of calls should be as follows:
* /code
* csoundCompileCsdText(csound, csd_text);
* while (!csoundPerformBuffer(csound));
* csoundCleanup(csound);
* csoundReset(csound);
* /endcode
* NB: A temporary file is created, the csd_text is written to the temporary
* file, and csoundCompileCsd is called with the name of the temporary file,
* which is deleted after compilation. Behavior may vary by platform.
*/
PUBLIC int csoundCompileCsdText(CSOUND *csound, const char *csd_text);
/**
* Senses input events and performs audio output until the end of score
* is reached (positive return value), an error occurs (negative return
* value), or performance is stopped by calling csoundStop() from another
* thread (zero return value).
* Note that csoundCompile() or csoundCompileOrc(), csoundReadScore(),
* csoundStart() must be called first.
* In the case of zero return value, csoundPerform() can be called again
* to continue the stopped performance. Otherwise, csoundReset() should be
* called to clean up after the finished or failed performance.
*/
PUBLIC int csoundPerform(CSOUND *);
/**
* Senses input events, and performs one control sample worth (ksmps) of
* audio output.
* Note that csoundCompile() or csoundCompileOrc(), csoundReadScore(),
* csoundStart() must be called first.
* Returns false during performance, and true when performance is finished.
* If called until it returns true, will perform an entire score.
* Enables external software to control the execution of Csound,
* and to synchronize performance with audio input and output.
*/
PUBLIC int csoundPerformKsmps(CSOUND *);
/**
* Performs Csound, sensing real-time and score events
* and processing one buffer's worth (-b frames) of interleaved audio.
* Note that csoundCompile must be called first, then call
* csoundGetOutputBuffer() and csoundGetInputBuffer() to get the pointer
* to csound's I/O buffers.
* Returns false during performance, and true when performance is finished.
*/
PUBLIC int csoundPerformBuffer(CSOUND *);
/**
* Stops a csoundPerform() running in another thread. Note that it is
* not guaranteed that csoundPerform() has already stopped when this
* function returns.
*/
PUBLIC void csoundStop(CSOUND *);
/**
* Prints information about the end of a performance, and closes audio
* and MIDI devices.
* Note: after calling csoundCleanup(), the operation of the perform
* functions is undefined.
*/
PUBLIC int csoundCleanup(CSOUND *);
/**
* Resets all internal memory and state in preparation for a new performance.
* Enables external software to run successive Csound performances
* without reloading Csound. Implies csoundCleanup(), unless already called.
*/
PUBLIC void csoundReset(CSOUND *);
/** @}*/
/** @defgroup ATTRIBUTES Attributes
*
* @{ */
/**
* Returns the number of audio sample frames per second.
*/
PUBLIC MYFLT csoundGetSr(CSOUND *) ;
/**
* Returns the number of control samples per second.
*/
PUBLIC MYFLT csoundGetKr(CSOUND *);
/**
* Returns the number of audio sample frames per control sample.
*/
PUBLIC uint32_t csoundGetKsmps(CSOUND *);
/**
* Returns the number of audio output channels. Set through the nchnls
* header variable in the csd file.
*/
PUBLIC uint32_t csoundGetNchnls(CSOUND *);
/**
* Returns the number of audio input channels. Set through the
* nchnls_i header variable in the csd file. If this variable is
* not set, the value is taken from nchnls.
*/
PUBLIC uint32_t csoundGetNchnlsInput(CSOUND *csound);
/**
* Returns the 0dBFS level of the spin/spout buffers.
*/
PUBLIC MYFLT csoundGet0dBFS(CSOUND *);
/**
* Return the current performance time in samples
*/
PUBLIC int64_t csoundGetCurrentTimeSamples(CSOUND *csound);
/**
* Return the size of MYFLT in bytes.
*/
PUBLIC int csoundGetSizeOfMYFLT(void);
/**
* Returns host data.
*/
PUBLIC void *csoundGetHostData(CSOUND *);
/**
* Sets host data.
*/
PUBLIC void csoundSetHostData(CSOUND *, void *hostData);
/**
* Set a single csound option (flag). Returns CSOUND_SUCCESS on success.
* NB: blank spaces are not allowed
*/
PUBLIC int csoundSetOption(CSOUND *csound, const char *option);
/**
* Configure Csound with a given set of parameters defined in
* the CSOUND_PARAMS structure. These parameters are the part of the
* OPARMS struct that are configurable through command line flags.
* The CSOUND_PARAMS structure can be obtained using csoundGetParams().
* These options should only be changed before performance has started.
*/
PUBLIC void csoundSetParams(CSOUND *csound, CSOUND_PARAMS *p);
/**
* Get the current set of parameters from a CSOUND instance in
* a CSOUND_PARAMS structure. See csoundSetParams().
*/
PUBLIC void csoundGetParams(CSOUND *csound, CSOUND_PARAMS *p);
/**
* Returns whether Csound is set to print debug messages sent through the
* DebugMsg() internal API function. Anything different to 0 means true.
*/
PUBLIC int csoundGetDebug(CSOUND *);
/**
* Sets whether Csound prints debug messages from the DebugMsg() internal
* API function. Anything different to 0 means true.
*/
PUBLIC void csoundSetDebug(CSOUND *, int debug);
/** @}*/
/** @defgroup FILEIO General Input/Output
* Setting the device or filename name for Csound input and output. These
* functions are used to set the input and output command line flags that
* apply to both input and output of audio and MIDI. See command line flags
* -o, -i, -M and -Q in the Csound Reference Manual.
* @{ */
/**
* Returns the output audio output name (-o).
*/
PUBLIC const char *csoundGetOutputName(CSOUND *);
/**
* Set output destination, type and format
* type can be one of "wav","aiff", "au","raw", "paf", "svx", "nist", "voc",
* "ircam","w64","mat4", "mat5", "pvf","xi", "htk","sds","avr","wavex","sd2",
* "flac", "caf","wve","ogg","mpc2k","rf64", or NULL (use default or
* realtime IO).
* format can be one of "alaw", "schar", "uchar", "float", "double", "long",
* "short", "ulaw", "24bit", "vorbis", or NULL (use default or realtime IO).
* For RT audio, use device_id from CS_AUDIODEVICE for a given audio device.
*
*/
PUBLIC void csoundSetOutput(CSOUND *csound, const char *name,
const char *type, const char *format);
/**
* Get output type and format.
* type should have space for at least 5 chars excluding termination,
* and format should have space for at least 7 chars.
* On return, these will hold the current values for
* these parameters.
*/
PUBLIC void csoundGetOutputFormat(CSOUND *csound,char *type,
char *format);
/**
* Set input source
*/
PUBLIC void csoundSetInput(CSOUND *csound, const char *name);
/**
* Set MIDI input device name/number
*/
PUBLIC void csoundSetMIDIInput(CSOUND *csound, const char *name);
/**
* Set MIDI file input name
*/
PUBLIC void csoundSetMIDIFileInput(CSOUND *csound, const char *name);
/**
* Set MIDI output device name/number
*/
PUBLIC void csoundSetMIDIOutput(CSOUND *csound, const char *name);
/**
* Set MIDI file utput name
*/
PUBLIC void csoundSetMIDIFileOutput(CSOUND *csound, const char *name);
#if !defined(SWIG)
/**
* Sets an external callback for receiving notices whenever Csound opens
* a file. The callback is made after the file is successfully opened.
* The following information is passed to the callback:
* char* pathname of the file; either full or relative to current dir
* int a file type code from the enumeration CSOUND_FILETYPES
* int 1 if Csound is writing the file, 0 if reading
* int 1 if a temporary file that Csound will delete; 0 if not
*
* Pass NULL to disable the callback.
* This callback is retained after a csoundReset() call.
*/
PUBLIC void csoundSetFileOpenCallback(CSOUND *p,
void (*func)(CSOUND*, const char*, int, int, int));
#endif
/** @}*/
/** @defgroup RTAUDIOIO Realtime Audio I/O
*
* @{ */
/**
* Sets the current RT audio module
*/
PUBLIC void csoundSetRTAudioModule(CSOUND *csound, const char *module);
/**
* retrieves a module name and type ("audio" or "midi") given a
* number Modules are added to list as csound loads them returns
* CSOUND_SUCCESS on success and CSOUND_ERROR if module number
* was not found
*
* \code
* char *name, *type;
* int n = 0;
* while(!csoundGetModule(csound, n++, &name, &type))
* printf("Module %d: %s (%s) \n", n, name, type);
* \endcode
*/
PUBLIC int csoundGetModule(CSOUND *csound, int number,
char **name, char **type);
/**
* Returns the number of samples in Csound's input buffer.
*/
PUBLIC long csoundGetInputBufferSize(CSOUND *);
/**
* Returns the number of samples in Csound's output buffer.
*/
PUBLIC long csoundGetOutputBufferSize(CSOUND *);
/**
* Returns the address of the Csound audio input buffer.
* Enables external software to write audio into Csound before calling
* csoundPerformBuffer.
*/
PUBLIC MYFLT *csoundGetInputBuffer(CSOUND *);
/**
* Returns the address of the Csound audio output buffer.
* Enables external software to read audio from Csound after calling
* csoundPerformBuffer.
*/
PUBLIC MYFLT *csoundGetOutputBuffer(CSOUND *);
/**
* Returns the address of the Csound audio input working buffer (spin).
* Enables external software to write audio into Csound before calling
* csoundPerformKsmps.
*/
PUBLIC MYFLT *csoundGetSpin(CSOUND *);
/**
* Adds the indicated sample into the audio input woriing buffer (spin);
* this only ever makes sense before calling csoundPerformKsmps().
* The frame and channel must be in bounds relative to ksmps and nchnls.
*/
PUBLIC void csoundAddSpinSample(CSOUND *csound,
int frame, int channel, MYFLT sample);
/**
* Returns the address of the Csound audio output working buffer (spout).
* Enables external software to read audio from Csound after calling
* csoundPerformKsmps.
*/
PUBLIC MYFLT *csoundGetSpout(CSOUND *csound);
/**
* Returns the indicated sample from the Csound audio output
* working buffer (spout); only ever makes sense after calling
* csoundPerformKsmps(). The frame and channel must be in bounds
* relative to ksmps and nchnls.
*/
PUBLIC MYFLT csoundGetSpoutSample(CSOUND *csound, int frame, int channel);
/**
* Return pointer to user data pointer for real time audio input.
*/
PUBLIC void **csoundGetRtRecordUserData(CSOUND *);
/**
* Return pointer to user data pointer for real time audio output.
*/
PUBLIC void **csoundGetRtPlayUserData(CSOUND *);
/**
* Calling this function with a non-zero 'state' value between
* csoundCreate() and the start of performance will disable all default
* handling of sound I/O by the Csound library, allowing the host
* application to use the spin/spout/input/output buffers directly.
* If 'bufSize' is greater than zero, the buffer size (-b) will be
* set to the integer multiple of ksmps that is nearest to the value
* specified.
*/
PUBLIC void csoundSetHostImplementedAudioIO(CSOUND *,
int state, int bufSize);
/**
* This function can be called to obtain a list of available
* input or output audio devices. If list is NULL, the function
* will only return the number of devices (isOutput=1 for out
* devices, 0 for in devices).
* If list is non-NULL, then it should contain enough memory for
* one CS_AUDIODEVICE structure per device.
* Hosts will typically call this function twice: first to obtain
* a number of devices, then, after allocating space for each
* device information structure, pass an array of CS_AUDIODEVICE
* structs to be filled:
*
* \code
* int i,n = csoundGetAudioDevList(csound,NULL,1);
* CS_AUDIODEVICE *devs = (CS_AUDIODEVICE *)
* malloc(n*sizeof(CS_AUDIODEVICE));
* csoundGetAudioDevList(csound,devs,1);
* for(i=0; i < n; i++)
* csound->Message(csound, " %d: %s (%s)\n",
* i, devs[i].device_id, devs[i].device_name);
* free(devs);
* \endcode
*/
PUBLIC int csoundGetAudioDevList(CSOUND *csound,
CS_AUDIODEVICE *list, int isOutput);
/**
* Sets a function to be called by Csound for opening real-time
* audio playback.
*/
PUBLIC void csoundSetPlayopenCallback(CSOUND *,
int (*playopen__)(CSOUND *,
const csRtAudioParams *parm));
/**
* Sets a function to be called by Csound for performing real-time
* audio playback.
*/
PUBLIC void csoundSetRtplayCallback(CSOUND *,
void (*rtplay__)(CSOUND *,
const MYFLT *outBuf, int nbytes));
/**
* Sets a function to be called by Csound for opening real-time
* audio recording.
*/
PUBLIC void csoundSetRecopenCallback(CSOUND *,
int (*recopen_)(CSOUND *,
const csRtAudioParams *parm));
/**
* Sets a function to be called by Csound for performing real-time
* audio recording.
*/
PUBLIC void csoundSetRtrecordCallback(CSOUND *,
int (*rtrecord__)(CSOUND *,
MYFLT *inBuf, int nbytes));
/**
* Sets a function to be called by Csound for closing real-time
* audio playback and recording.
*/
PUBLIC void csoundSetRtcloseCallback(CSOUND *, void (*rtclose__)(CSOUND *));
/**
* Sets a function that is called to obtain a list of audio devices.
* This should be set by rtaudio modules and should not be set by hosts.
* (See csoundGetAudioDevList())
*/
PUBLIC void csoundSetAudioDeviceListCallback(CSOUND *csound,
int (*audiodevlist__)(CSOUND *, CS_AUDIODEVICE *list, int isOutput));
/** @}*/
/** @defgroup RTMIDI Realtime Midi I/O
*
* @{ */
/**
* Sets the current MIDI IO module
*/
PUBLIC void csoundSetMIDIModule(CSOUND *csound, const char *module);
/**
* call this function with state 1 if the host is implementing
* MIDI via the callbacks below.
*/
PUBLIC void csoundSetHostImplementedMIDIIO(CSOUND *csound,
int state);
/**
* This function can be called to obtain a list of available
* input or output midi devices. If list is NULL, the function
* will only return the number of devices (isOutput=1 for out
* devices, 0 for in devices).
* If list is non-NULL, then it should contain enough memory for
* one CS_MIDIDEVICE structure per device.
* Hosts will typically call this function twice: first to obtain
* a number of devices, then, after allocating space for each
* device information structure, pass an array of CS_MIDIDEVICE
* structs to be filled. (see also csoundGetAudioDevList())
*/
PUBLIC int csoundGetMIDIDevList(CSOUND *csound,
CS_MIDIDEVICE *list, int isOutput);
/**
* Sets callback for opening real time MIDI input.
*/
PUBLIC void csoundSetExternalMidiInOpenCallback(CSOUND *,
int (*func)(CSOUND *, void **userData, const char *devName));
/**
* Sets callback for reading from real time MIDI input.
*/
PUBLIC void csoundSetExternalMidiReadCallback(CSOUND *,
int (*func)(CSOUND *, void *userData,
unsigned char *buf, int nBytes));
/**
* Sets callback for closing real time MIDI input.
*/
PUBLIC void csoundSetExternalMidiInCloseCallback(CSOUND *,
int (*func)(CSOUND *, void *userData));
/**
* Sets callback for opening real time MIDI output.
*/
PUBLIC void csoundSetExternalMidiOutOpenCallback(CSOUND *,
int (*func)(CSOUND *, void **userData, const char *devName));
/**
* Sets callback for writing to real time MIDI output.
*/
PUBLIC void csoundSetExternalMidiWriteCallback(CSOUND *,
int (*func)(CSOUND *, void *userData,
const unsigned char *buf, int nBytes));
/**
* Sets callback for closing real time MIDI output.
*/
PUBLIC void csoundSetExternalMidiOutCloseCallback(CSOUND *,
int (*func)(CSOUND *, void *userData));
/**
* Sets callback for converting MIDI error codes to strings.
*/
PUBLIC void csoundSetExternalMidiErrorStringCallback(CSOUND *,
const char *(*func)(int));
/**
* Sets a function that is called to obtain a list of MIDI devices.
* This should be set by IO plugins, and should not be used by hosts.
* (See csoundGetMIDIDevList())
*/
PUBLIC void csoundSetMIDIDeviceListCallback(CSOUND *csound,
int (*mididevlist__)(CSOUND *,
CS_MIDIDEVICE *list, int isOutput));
/** @}*/
/** @defgroup SCOREHANDLING Score Handling
*
* @{ */
/**
* Read, preprocess, and load a score from an ASCII string
* It can be called repeatedly, with the new score events
* being added to the currently scheduled ones.
*/
PUBLIC int csoundReadScore(CSOUND *csound, const char *str);
/**
* Returns the current score time in seconds
* since the beginning of performance.
*/
PUBLIC double csoundGetScoreTime(CSOUND *);
/**
* Sets whether Csound score events are performed or not, independently
* of real-time MIDI events (see csoundSetScorePending()).
*/
PUBLIC int csoundIsScorePending(CSOUND *);
/**
* Sets whether Csound score events are performed or not (real-time
* events will continue to be performed). Can be used by external software,
* such as a VST host, to turn off performance of score events (while
* continuing to perform real-time events), for example to
* mute a Csound score while working on other tracks of a piece, or
* to play the Csound instruments live.
*/
PUBLIC void csoundSetScorePending(CSOUND *, int pending);
/**
* Returns the score time beginning at which score events will
* actually immediately be performed (see csoundSetScoreOffsetSeconds()).
*/
PUBLIC MYFLT csoundGetScoreOffsetSeconds(CSOUND *);
/**
* Csound score events prior to the specified time are not performed, and
* performance begins immediately at the specified time (real-time events
* will continue to be performed as they are received).
* Can be used by external software, such as a VST host,
* to begin score performance midway through a Csound score,
* for example to repeat a loop in a sequencer, or to synchronize
* other events with the Csound score.
*/
PUBLIC void csoundSetScoreOffsetSeconds(CSOUND *, MYFLT time);
/**
* Rewinds a compiled Csound score to the time specified with
* csoundSetScoreOffsetSeconds().
*/
PUBLIC void csoundRewindScore(CSOUND *);
/**
* Sets an external callback for Cscore processing.
* Pass NULL to reset to the internal cscore() function
* (which does nothing).
* This callback is retained after a csoundReset() call.
*/
PUBLIC void csoundSetCscoreCallback(CSOUND *,
void (*cscoreCallback_)(CSOUND *));
/**
* Sorts score file 'inFile' and writes the result to 'outFile'.
* The Csound instance should be initialised
* before calling this function, and csoundReset() should be called
* after sorting the score to clean up. On success, zero is returned.
*/
PUBLIC int csoundScoreSort(CSOUND *, FILE *inFile, FILE *outFile);
/**
* Extracts from 'inFile', controlled by 'extractFile', and writes
* the result to 'outFile'. The Csound instance should be initialised
* before calling this function, and csoundReset()
* should be called after score extraction to clean up.
* The return value is zero on success.
*/
PUBLIC int csoundScoreExtract(CSOUND *,
FILE *inFile, FILE *outFile, FILE *extractFile);
/** @}*/
/** @defgroup MESSAGES Messages and Text
*
* @{ */
/**
* Displays an informational message.
*/
PUBLIC CS_PRINTF2 void csoundMessage(CSOUND *, const char *format, ...);
/**
* Print message with special attributes (see msg_attr.h for the list of
* available attributes). With attr=0, csoundMessageS() is identical to
* csoundMessage().
*/
PUBLIC CS_PRINTF3 void csoundMessageS(CSOUND *,
int attr, const char *format, ...);
PUBLIC void csoundMessageV(CSOUND *,
int attr, const char *format, va_list args);
PUBLIC void csoundSetDefaultMessageCallback(
void (*csoundMessageCallback_)(CSOUND *,
int attr,
const char *format,
va_list valist));
/**
* Sets a function to be called by Csound to print an informational message.
*/
PUBLIC void csoundSetMessageCallback(CSOUND *,
void (*csoundMessageCallback_)(CSOUND *,
int attr,
const char *format,
va_list valist));
/**
* Returns the Csound message level (from 0 to 231).
*/
PUBLIC int csoundGetMessageLevel(CSOUND *);
/**
* Sets the Csound message level (from 0 to 231).
*/
PUBLIC void csoundSetMessageLevel(CSOUND *, int messageLevel);
/**
* Creates a buffer for storing messages printed by Csound.
* Should be called after creating a Csound instance andthe buffer
* can be freed by calling csoundDestroyMessageBuffer() before
* deleting the Csound instance. You will generally want to call
* csoundCleanup() to make sure the last messages are flushed to
* the message buffer before destroying Csound.
* If 'toStdOut' is non-zero, the messages are also printed to
* stdout and stderr (depending on the type of the message),
* in addition to being stored in the buffer.
* Using the message buffer ties up the internal message callback, so
* csoundSetMessageCallback should not be called after creating the
* message buffer.
*/
PUBLIC void csoundCreateMessageBuffer(CSOUND *csound, int toStdOut);
/**
* Returns the first message from the buffer.
*/
PUBLIC const char* csoundGetFirstMessage(CSOUND *csound);
/**
* Returns the attribute parameter (see msg_attr.h) of the first message
* in the buffer.
*/
PUBLIC int csoundGetFirstMessageAttr(CSOUND *csound);
/**
* Removes the first message from the buffer.
*/
PUBLIC void csoundPopFirstMessage(CSOUND *csound);
/**
* Returns the number of pending messages in the buffer.
*/
PUBLIC int csoundGetMessageCnt(CSOUND *csound);
/**
* Releases all memory used by the message buffer.
*/
void PUBLIC csoundDestroyMessageBuffer(CSOUND *csound);
/** @}*/
/** @defgroup CONTROLEVENTS Channels, Control and Events
*
* @{ */
/**
* Stores a pointer to the specified channel of the bus in *p,
* creating the channel first if it does not exist yet.
* 'type' must be the bitwise OR of exactly one of the following values,
* CSOUND_CONTROL_CHANNEL
* control data (one MYFLT value)
* CSOUND_AUDIO_CHANNEL
* audio data (csoundGetKsmps(csound) MYFLT values)
* CSOUND_STRING_CHANNEL
* string data (MYFLT values with enough space to store
* csoundGetChannelDatasize() characters, including the
* NULL character at the end of the string)
* and at least one of these:
* CSOUND_INPUT_CHANNEL
* CSOUND_OUTPUT_CHANNEL
* If the channel already exists, it must match the data type
* (control, audio, or string), however, the input/output bits are
* OR'd with the new value. Note that audio and string channels
* can only be created after calling csoundCompile(), because the
* storage size is not known until then.
* Return value is zero on success, or a negative error code,
* CSOUND_MEMORY there is not enough memory for allocating the channel
* CSOUND_ERROR the specified name or type is invalid
* or, if a channel with the same name but incompatible type
* already exists, the type of the existing channel. In the case
* of any non-zero return value, *p is set to NULL.
* Note: to find out the type of a channel without actually
* creating or changing it, set 'type' to zero, so that the return
* value will be either the type of the channel, or CSOUND_ERROR
* if it does not exist.
*
* Operations on **p are not thread-safe by default. The host is required
* to take care of threadsafety by
* 1) with control channels use __sync_fetch_and_add() or
* __sync_fetch_and_or() gcc atomic builtins to get or set a channel,
* if available.
* 2) For string and audio channels (and controls if option 1 is not
* available), retrieve the channel lock with csoundGetChannelLock()
* and use csoundSpinLock() and csoundSpinUnLock() to protect access
* to **p.
* See Top/threadsafe.c in the Csound library sources for
* examples. Optionally, use the channel get/set functions
* provided below, which are threadsafe by default.
*/
PUBLIC int csoundGetChannelPtr(CSOUND *,
MYFLT **p, const char *name, int type);
/**
* Returns a list of allocated channels in *lst. A controlChannelInfo_t
* structure contains the channel characteristics.
* The return value is the number of channels, which may be zero if there
* are none, or CSOUND_MEMORY if there is not enough memory for allocating
* the list. In the case of no channels or an error, *lst is set to NULL.
* Notes: the caller is responsible for freeing the list returned in *lst
* with csoundDeleteChannelList(). The name pointers may become invalid
* after calling csoundReset().
*/
PUBLIC int csoundListChannels(CSOUND *, controlChannelInfo_t **lst);
/**
* Releases a channel list previously returned by csoundListChannels().
*/
PUBLIC void csoundDeleteChannelList(CSOUND *, controlChannelInfo_t *lst);
/**
* Set parameters hints for a control channel. These hints have no internal
* function but can be used by front ends to construct GUIs or to constrain
* values. See the controlChannelHints_t structure for details.
* Returns zero on success, or a non-zero error code on failure:
* CSOUND_ERROR: the channel does not exist, is not a control channel,
* or the specified parameters are invalid
* CSOUND_MEMORY: could not allocate memory
*/
PUBLIC int csoundSetControlChannelHints(CSOUND *, const char *name,
controlChannelHints_t hints);
/**
* Returns special parameters (assuming there are any) of a control channel,
* previously set with csoundSetControlChannelHints() or the chnparams
* opcode.
* If the channel exists, is a control channel, the channel hints
* are stored in the preallocated controlChannelHints_t structure. The
* attributes member of the structure will be allocated inside this function
* so it is necessary to free it explicitly in the host.
*
* The return value is zero if the channel exists and is a control
* channel, otherwise, an error code is returned.
*/
PUBLIC int csoundGetControlChannelHints(CSOUND *, const char *name,
controlChannelHints_t *hints);
/**
* Recovers a pointer to a lock for the specified channel called 'name'.
* The returned lock can be locked/unlocked with the csoundSpinLock()
* and csoundSpinUnLock() functions.
* @returns the address of the lock or NULL if the channel does not exist
*/
PUBLIC int *csoundGetChannelLock(CSOUND *, const char *name);
/**
* retrieves the value of control channel identified by *name.
* If the err argument is not NULL, the error (or success) code
* finding or accessing the channel is stored in it.
*/
PUBLIC MYFLT csoundGetControlChannel(CSOUND *csound, const char *name,
int *err);
/**
* sets the value of control channel identified by *name
*/
PUBLIC void csoundSetControlChannel(CSOUND *csound,
const char *name, MYFLT val);
/**
* copies the audio channel identified by *name into array
* *samples which should contain enough memory for ksmps MYFLTs
*/
PUBLIC void csoundGetAudioChannel(CSOUND *csound,
const char *name, MYFLT *samples);
/**
* sets the audio channel identified by *name with data from array
* *samples which should contain at least ksmps MYFLTs
*/
PUBLIC void csoundSetAudioChannel(CSOUND *csound,
const char *name, MYFLT *samples);
/**
* copies the string channel identified by *name into *string
* which should contain enough memory for the string
* (see csoundGetChannelDatasize() below)
*/
PUBLIC void csoundGetStringChannel(CSOUND *csound,
const char *name, char *string);
/**
* sets the string channel identified by *name with *string
*/
PUBLIC void csoundSetStringChannel(CSOUND *csound,
const char *name, char *string);
/**
* returns the size of data stored in a channel; for string channels
* this might change if the channel space gets reallocated
* Since string variables use dynamic memory allocation in Csound6,
* this function can be called to get the space required for
* csoundGetStringChannel()
*/
PUBLIC int csoundGetChannelDatasize(CSOUND *csound, const char *name);
/** Sets the function which will be called whenever the invalue opcode
* is used. */
PUBLIC void
csoundSetInputChannelCallback(CSOUND *csound,
channelCallback_t inputChannelCalback);
/** Sets the function which will be called whenever the outvalue opcode
* is used. */
PUBLIC void
csoundSetOutputChannelCallback(CSOUND *csound,
channelCallback_t outputChannelCalback);
/**
* Sends a PVSDATEX fin to the pvsin opcode (f-rate) for channel 'name'.
* Returns zero on success, CSOUND_ERROR if the index is invalid or
* fsig framesizes are incompatible.
* CSOUND_MEMORY if there is not enough memory to extend the bus.
*/
PUBLIC int csoundSetPvsChannel(CSOUND *, const PVSDATEXT *fin,
const char *name);
/**
* Receives a PVSDAT fout from the pvsout opcode (f-rate) at channel 'name'
* Returns zero on success, CSOUND_ERROR if the index is invalid or
* if fsig framesizes are incompatible.
* CSOUND_MEMORY if there is not enough memory to extend the bus
*/
PUBLIC int csoundGetPvsChannel(CSOUND *csound, PVSDATEXT *fout,
const char *name);
/**
* Send a new score event. 'type' is the score event type ('a', 'i', 'q',
* 'f', or 'e').
* 'numFields' is the size of the pFields array. 'pFields' is an array of
* floats with all the pfields for this event, starting with the p1 value
* specified in pFields[0].
*/
PUBLIC int csoundScoreEvent(CSOUND *,
char type, const MYFLT *pFields, long numFields);
/**
* Like csoundScoreEvent(), this function inserts a score event, but
* at absolute time with respect to the start of performance, or from an
* offset set with time_ofs
*/
PUBLIC int csoundScoreEventAbsolute(CSOUND *,
char type, const MYFLT *pfields, long numFields, double time_ofs);
/**
* Input a NULL-terminated string (as if from a console),
* used for line events.
*/
PUBLIC void csoundInputMessage(CSOUND *, const char *message);
/**
* Kills off one or more running instances of an instrument identified
* by instr (number) or instrName (name). If instrName is NULL, the
* instrument number is used.
* Mode is a sum of the following values:
* 0,1,2: kill all instances (1), oldest only (1), or newest (2)
* 4: only turnoff notes with exactly matching (fractional) instr number
* 8: only turnoff notes with indefinite duration (p3 < 0 or MIDI)
* allow_release, if non-zero, the killed instances are allowed to release.
*/
PUBLIC int csoundKillInstance(CSOUND *csound, MYFLT instr,
char *instrName, int mode, int allow_release);
/**
* Register a function to be called once in every control period
* by sensevents(). Any number of functions may be registered,
* and will be called in the order of registration.
* The callback function takes two arguments: the Csound instance
* pointer, and the userData pointer as passed to this function.
* This facility can be used to ensure a function is called synchronously
* before every csound control buffer processing. It is important
* to make sure no blocking operations are performed in the callback.
* The callbacks are cleared on csoundCleanup().
* Returns zero on success.
*/
PUBLIC int csoundRegisterSenseEventCallback(CSOUND *,
void (*func)(CSOUND *, void *),
void *userData);
/**
* Set the ASCII code of the most recent key pressed.
* This value is used by the 'sensekey' opcode if a callback
* for returning keyboard events is not set (see
* csoundRegisterKeyboardCallback()).
*/
PUBLIC void csoundKeyPress(CSOUND *, char c);
/**
* Registers general purpose callback functions that will be called to query
* keyboard events. These callbacks are called on every control period by
* the sensekey opcode.
* The callback is preserved on csoundReset(), and multiple
* callbacks may be set and will be called in reverse order of
* registration. If the same function is set again, it is only moved
* in the list of callbacks so that it will be called first, and the
* user data and type mask parameters are updated. 'typeMask' can be the
* bitwise OR of callback types for which the function should be called,
* or zero for all types.
* Returns zero on success, CSOUND_ERROR if the specified function
* pointer or type mask is invalid, and CSOUND_MEMORY if there is not
* enough memory.
*
* The callback function takes the following arguments:
* void *userData
* the "user data" pointer, as specified when setting the callback
* void *p
* data pointer, depending on the callback type
* unsigned int type
* callback type, can be one of the following (more may be added in
* future versions of Csound):
* CSOUND_CALLBACK_KBD_EVENT
* CSOUND_CALLBACK_KBD_TEXT
* called by the sensekey opcode to fetch key codes. The data
* pointer is a pointer to a single value of type 'int', for
* returning the key code, which can be in the range 1 to 65535,
* or 0 if there is no keyboard event.
* For CSOUND_CALLBACK_KBD_EVENT, both key press and release
* events should be returned (with 65536 (0x10000) added to the
* key code in the latter case) as unshifted ASCII codes.
* CSOUND_CALLBACK_KBD_TEXT expects key press events only as the
* actual text that is typed.
* The return value should be zero on success, negative on error, and
* positive if the callback was ignored (for example because the type is
* not known).
*/
PUBLIC int csoundRegisterKeyboardCallback(CSOUND *,
int (*func)(void *userData, void *p,
unsigned int type),
void *userData, unsigned int type);
/**
* Removes a callback previously set with csoundRegisterKeyboardCallback().
*/
PUBLIC void csoundRemoveKeyboardCallback(CSOUND *csound,
int (*func)(void *, void *, unsigned int));
/** @}*/
/** @defgroup TABLE Tables
*
* @{ */
/**
* Returns the length of a function table (not including the guard point),
* or -1 if the table does not exist.
*/
PUBLIC int csoundTableLength(CSOUND *, int table);
/**
* Returns the value of a slot in a function table.
* The table number and index are assumed to be valid.
*/
PUBLIC MYFLT csoundTableGet(CSOUND *, int table, int index);
/**
* Sets the value of a slot in a function table.
* The table number and index are assumed to be valid.
*/
PUBLIC void csoundTableSet(CSOUND *, int table, int index, MYFLT value);
/**
* Copy the contents of a function table into a supplied array *dest
* The table number is assumed to be valid, and the destination needs to
* have sufficient space to receive all the function table contents.
*/
PUBLIC void csoundTableCopyOut(CSOUND *csound, int table, MYFLT *dest);
/**
* Copy the contents of an array *src into a given function table
* The table number is assumed to be valid, and the table needs to
* have sufficient space to receive all the array contents.
*/
PUBLIC void csoundTableCopyIn(CSOUND *csound, int table, MYFLT *src);
/**
* Stores pointer to function table 'tableNum' in *tablePtr,
* and returns the table length (not including the guard point).
* If the table does not exist, *tablePtr is set to NULL and
* -1 is returned.
*/
PUBLIC int csoundGetTable(CSOUND *, MYFLT **tablePtr, int tableNum);
/**
* Stores pointer to the arguments used to generate
* function table 'tableNum' in *argsPtr,
* and returns the number of arguments used.
* If the table does not exist, *argsPtr is set to NULL and
* -1 is returned.
* NB: the argument list starts with the GEN number and is followed by
* its parameters. eg. f 1 0 1024 10 1 0.5 yields the list {10.0,1.0,0.5}
*/
PUBLIC int csoundGetTableArgs(CSOUND *csound, MYFLT **argsPtr, int tableNum);
/**
* Checks if a given GEN number num is a named GEN
* if so, it returns the string length (excluding terminating NULL char)
* Otherwise it returns 0.
*/
PUBLIC int csoundIsNamedGEN(CSOUND *csound, int num);
/**
* Gets the GEN name from a number num, if this is a named GEN
* The final parameter is the max len of the string (excluding termination)
*/
PUBLIC void csoundGetNamedGEN(CSOUND *csound, int num, char *name, int len);
/** @}*/
/** @defgroup TABLEDISPLAY Function table display
*
* @{ */
/**
* Tells Csound whether external graphic table display is supported.
* Returns the previously set value (initially zero).
*/
PUBLIC int csoundSetIsGraphable(CSOUND *, int isGraphable);
/**
* Called by external software to set Csound's MakeGraph function.
*/
PUBLIC void csoundSetMakeGraphCallback(CSOUND *,
void (*makeGraphCallback_)(CSOUND *,
WINDAT *windat,
const char *name));
/**
* Called by external software to set Csound's DrawGraph function.
*/
PUBLIC void csoundSetDrawGraphCallback(CSOUND *,
void (*drawGraphCallback_)(CSOUND *,
WINDAT *windat));
/**
* Called by external software to set Csound's KillGraph function.
*/
PUBLIC void csoundSetKillGraphCallback(CSOUND *,
void (*killGraphCallback_)(CSOUND *,
WINDAT *windat));
/**
* Called by external software to set Csound's ExitGraph function.
*/
PUBLIC void csoundSetExitGraphCallback(CSOUND *,
int (*exitGraphCallback_)(CSOUND *));
/** @}*/
/** @defgroup OPCODES Opcodes
*
* @{ */
/**
* Finds the list of named gens
*/
PUBLIC void *csoundGetNamedGens(CSOUND *);
/**
* Gets an alphabetically sorted list of all opcodes.
* Should be called after externals are loaded by csoundCompile().
* Returns the number of opcodes, or a negative error code on failure.
* Make sure to call csoundDisposeOpcodeList() when done with the list.
*/
PUBLIC int csoundNewOpcodeList(CSOUND *, opcodeListEntry **opcodelist);
/**
* Releases an opcode list.
*/
PUBLIC void csoundDisposeOpcodeList(CSOUND *, opcodeListEntry *opcodelist);
/**
* Appends an opcode implemented by external software
* to Csound's internal opcode list.
* The opcode list is extended by one slot,
* and the parameters are copied into the new slot.
* Returns zero on success.
*/
PUBLIC int csoundAppendOpcode(CSOUND *, const char *opname,
int dsblksiz, int flags, int thread,
const char *outypes, const char *intypes,
int (*iopadr)(CSOUND *, void *),
int (*kopadr)(CSOUND *, void *),
int (*aopadr)(CSOUND *, void *));
/** @}*/
/** @defgroup THREADING Threading and concurrency
*
* @{ */
/**
* Called by external software to set a function for checking system
* events, yielding cpu time for coopertative multitasking, etc.
* This function is optional. It is often used as a way to 'turn off'
* Csound, allowing it to exit gracefully. In addition, some operations
* like utility analysis routines are not reentrant and you should use
* this function to do any kind of updating during the operation.
* Returns an 'OK to continue' boolean.
*/
PUBLIC void csoundSetYieldCallback(CSOUND *, int (*yieldCallback_)(CSOUND *));
/**
* Creates and starts a new thread of execution.
* Returns an opaque pointer that represents the thread on success,
* or NULL for failure.
* The userdata pointer is passed to the thread routine.
*/
PUBLIC void *csoundCreateThread(uintptr_t (*threadRoutine)(void *),
void *userdata);
/**
* Returns the ID of the currently executing thread,
* or NULL for failure.
*
* NOTE: The return value can be used as a pointer
* to a thread object, but it should not be compared
* as a pointer. The pointed to values should be compared,
* and the user must free the pointer after use.
*/
PUBLIC void *csoundGetCurrentThreadId(void);
/**
* Waits until the indicated thread's routine has finished.
* Returns the value returned by the thread routine.
*/
PUBLIC uintptr_t csoundJoinThread(void *thread);
/**
* Creates and returns a monitor object, or NULL if not successful.
* The object is initially in signaled (notified) state.
*/
PUBLIC void *csoundCreateThreadLock(void);
/**
* Waits on the indicated monitor object for the indicated period.
* The function returns either when the monitor object is notified,
* or when the period has elapsed, whichever is sooner; in the first case,
* zero is returned.
* If 'milliseconds' is zero and the object is not notified, the function
* will return immediately with a non-zero status.
*/
PUBLIC int csoundWaitThreadLock(void *lock, size_t milliseconds);
/**
* Waits on the indicated monitor object until it is notified.
* This function is similar to csoundWaitThreadLock() with an infinite
* wait time, but may be more efficient.
*/
PUBLIC void csoundWaitThreadLockNoTimeout(void *lock);
/**
* Notifies the indicated monitor object.
*/
PUBLIC void csoundNotifyThreadLock(void *lock);
/**
* Destroys the indicated monitor object.
*/
PUBLIC void csoundDestroyThreadLock(void *lock);
/**
* Creates and returns a mutex object, or NULL if not successful.
* Mutexes can be faster than the more general purpose monitor objects
* returned by csoundCreateThreadLock() on some platforms, and can also
* be recursive, but the result of unlocking a mutex that is owned by
* another thread or is not locked is undefined.
* If 'isRecursive' is non-zero, the mutex can be re-locked multiple
* times by the same thread, requiring an equal number of unlock calls;
* otherwise, attempting to re-lock the mutex results in undefined
* behavior.
* Note: the handles returned by csoundCreateThreadLock() and
* csoundCreateMutex() are not compatible.
*/
PUBLIC void *csoundCreateMutex(int isRecursive);
/**
* Acquires the indicated mutex object; if it is already in use by
* another thread, the function waits until the mutex is released by
* the other thread.
*/
PUBLIC void csoundLockMutex(void *mutex_);
/**
* Acquires the indicated mutex object and returns zero, unless it is
* already in use by another thread, in which case a non-zero value is
* returned immediately, rather than waiting until the mutex becomes
* available.
* Note: this function may be unimplemented on Windows.
*/
PUBLIC int csoundLockMutexNoWait(void *mutex_);
/**
* Releases the indicated mutex object, which should be owned by
* the current thread, otherwise the operation of this function is
* undefined. A recursive mutex needs to be unlocked as many times
* as it was locked previously.
*/
PUBLIC void csoundUnlockMutex(void *mutex_);
/**
* Destroys the indicated mutex object. Destroying a mutex that
* is currently owned by a thread results in undefined behavior.
*/
PUBLIC void csoundDestroyMutex(void *mutex_);
/**
* Create a Thread Barrier. Max value parameter should be equal to
* number of child threads using the barrier plus one for the
* master thread */
PUBLIC void *csoundCreateBarrier(unsigned int max);
/**
* Destroy a Thread Barrier.
*/
PUBLIC int csoundDestroyBarrier(void *barrier);
/**
* Wait on the thread barrier.
*/
PUBLIC int csoundWaitBarrier(void *barrier);
/**
* Waits for at least the specified number of milliseconds,
* yielding the CPU to other threads.
*/
PUBLIC void csoundSleep(size_t milliseconds);
/**
* If the spinlock is not locked, lock it and return;
* if is is locked, wait until it is unlocked, then lock it and return.
* Uses atomic compare and swap operations that are safe across processors
* and safe for out of order operations,
* and which are more efficient than operating system locks.
* Use spinlocks to protect access to shared data, especially in functions
* that do little more than read or write such data, for example:
*
* @code
* static int lock = 0;
* void write(size_t frames, int* signal)
* {
* csoundSpinLock(&lock);
* for (size_t frame = 0; i < frames; frame++) {
* global_buffer[frame] += signal[frame];
* }
* csoundSpinUnlock(&lock);
* }
* @endcode
*/
/* PUBLIC void csoundSpinLock(int32_t *spinlock) */
/* PUBLIC void csoundSpinUnlock(int32_t *spinlock) */
#if defined(MSVC)
/* This pragma must come before all public function declarations */
# pragma intrinsic(_InterlockedExchange)
# define csoundSpinLock(spinlock) \
{ \
while (_InterlockedExchange(spinlock, 1) == 1) { \
} \
}
# define csoundSpinUnLock(spinlock) \
{ \
_InterlockedExchange(spinlock, 0); \
}
# define CSOUND_SPIN_LOCK static int32_t spinlock = 0; csoundSpinLock(&spinlock);
# define CSOUND_SPIN_UNLOCK csoundSpinUnLock(&spinlock);
#elif defined(__GNUC__) && defined(HAVE_PTHREAD_SPIN_LOCK)
//# if defined(SWIG)
# define csoundSpinLock(spinlock) \
{ \
pthread_spin_lock((pthread_spinlock_t *)spinlock); \
}
# define csoundSpinUnLock(spinlock) \
{ \
pthread_spin_unlock((pthread_spinlock_t *)spinlock); \
}
# define CSOUND_SPIN_LOCK static int32_t spinlock = 0; csoundSpinLock(&spinlock);
# define CSOUND_SPIN_UNLOCK csoundSpinUnLock(&spinlock);
//# else
//# define csoundSpinLock(spinlock)
// pthread_spin_lock((pthread_spinlock_t *)spinlock);
//# define csoundSpinUnLock(spinlock)
// pthread_spin_unlock((pthread_spinlock_t *)spinlock);
//# define CSOUND_SPIN_LOCK
//# define CSOUND_SPIN_UNLOCK
//#endif
#elif defined(__GNUC__) && defined(HAVE_SYNC_LOCK_TEST_AND_SET)
# define csoundSpinLock(spinlock) \
{ \
while (__sync_lock_test_and_set(spinlock, 1) == 1) { \
} \
}
# define csoundSpinUnLock(spinlock) \
{ \
__sync_lock_release(spinlock); \
}
# define CSOUND_SPIN_LOCK static int32_t spinlock = 0; csoundSpinLock(&spinlock);
# define CSOUND_SPIN_UNLOCK csoundSpinUnLock(&spinlock);
#elif defined(MACOSX)
#ifndef SWIG
#include <libkern/OSAtomic.h>
#define csoundSpinLock(spinlock) \
{ \
OSSpinLockLock(spinlock); \
}
#define csoundSpinUnLock(spinlock) \
{ \
OSSpinLockUnlock(spinlock); \
}
#define CSOUND_SPIN_LOCK static int32_t spinlock = 0; csoundSpinLock(&spinlock);
#define CSOUND_SPIN_UNLOCK csoundSpinUnLock(&spinlock);
#endif
#else
/* We do not know the configuration, */
/* so we define these symbols as nothing. */
# define csoundSpinLock(spinlock)
# define csoundSpinUnLock(spinlock)
# define CSOUND_SPIN_LOCK
# define CSOUND_SPIN_UNLOCK
#endif
/** @}*/
/** @defgroup MISCELLANEOUS Miscellaneous functions
*
* @{ */
/**
* Runs an external command with the arguments specified in 'argv'.
* argv[0] is the name of the program to execute (if not a full path
* file name, it is searched in the directories defined by the PATH
* environment variable). The list of arguments should be terminated
* by a NULL pointer.
* If 'noWait' is zero, the function waits until the external program
* finishes, otherwise it returns immediately. In the first case, a
* non-negative return value is the exit status of the command (0 to
* 255), otherwise it is the PID of the newly created process.
* On error, a negative value is returned.
*/
PUBLIC long csoundRunCommand(const char * const *argv, int noWait);
/**
* Initialise a timer structure.
*/
PUBLIC void csoundInitTimerStruct(RTCLOCK *);
/**
* Return the elapsed real time (in seconds) since the specified timer
* structure was initialised.
*/
PUBLIC double csoundGetRealTime(RTCLOCK *);
/**
* Return the elapsed CPU time (in seconds) since the specified timer
* structure was initialised.
*/
PUBLIC double csoundGetCPUTime(RTCLOCK *);
/**
* Return a 32-bit unsigned integer to be used as seed from current time.
*/
PUBLIC uint32_t csoundGetRandomSeedFromTime(void);
/**
* Set language to 'lang_code' (lang_code can be for example
* CSLANGUAGE_ENGLISH_UK or CSLANGUAGE_FRENCH or many others,
* see n_getstr.h for the list of languages). This affects all
* Csound instances running in the address space of the current
* process. The special language code CSLANGUAGE_DEFAULT can be
* used to disable translation of messages and free all memory
* allocated by a previous call to csoundSetLanguage().
* csoundSetLanguage() loads all files for the selected language
* from the directory specified by the CSSTRNGS environment
* variable.
*/
PUBLIC void csoundSetLanguage(cslanguage_t lang_code);
/**
* Get pointer to the value of environment variable 'name', searching
* in this order: local environment of 'csound' (if not NULL), variables
* set with csoundSetGlobalEnv(), and system environment variables.
* If 'csound' is not NULL, should be called after csoundCompile().
* Return value is NULL if the variable is not set.
*/
PUBLIC const char *csoundGetEnv(CSOUND *csound, const char *name);
/**
* Set the global value of environment variable 'name' to 'value',
* or delete variable if 'value' is NULL.
* It is not safe to call this function while any Csound instances
* are active.
* Returns zero on success.
*/
PUBLIC int csoundSetGlobalEnv(const char *name, const char *value);
/**
* Allocate nbytes bytes of memory that can be accessed later by calling
* csoundQueryGlobalVariable() with the specified name; the space is
* cleared to zero.
* Returns CSOUND_SUCCESS on success, CSOUND_ERROR in case of invalid
* parameters (zero nbytes, invalid or already used name), or
* CSOUND_MEMORY if there is not enough memory.
*/
PUBLIC int csoundCreateGlobalVariable(CSOUND *,
const char *name, size_t nbytes);
/**
* Get pointer to space allocated with the name "name".
* Returns NULL if the specified name is not defined.
*/
PUBLIC void *csoundQueryGlobalVariable(CSOUND *, const char *name);
/**
* This function is the same as csoundQueryGlobalVariable(), except the
* variable is assumed to exist and no error checking is done.
* Faster, but may crash or return an invalid pointer if 'name' is
* not defined.
*/
PUBLIC void *csoundQueryGlobalVariableNoCheck(CSOUND *, const char *name);
/**
* Free memory allocated for "name" and remove "name" from the database.
* Return value is CSOUND_SUCCESS on success, or CSOUND_ERROR if the name is
* not defined.
*/
PUBLIC int csoundDestroyGlobalVariable(CSOUND *, const char *name);
/**
* Run utility with the specified name and command line arguments.
* Should be called after loading utility plugins.
* Use csoundReset() to clean up after calling this function.
* Returns zero if the utility was run successfully.
*/
PUBLIC int csoundRunUtility(CSOUND *, const char *name,
int argc, char **argv);
/**
* Returns a NULL terminated list of registered utility names.
* The caller is responsible for freeing the returned array with
* csoundDeleteUtilityList(), however, the names should not be
* changed or freed.
* The return value may be NULL in case of an error.
*/
PUBLIC char **csoundListUtilities(CSOUND *);
/**
* Releases an utility list previously returned by csoundListUtilities().
*/
PUBLIC void csoundDeleteUtilityList(CSOUND *, char **lst);
/**
* Get utility description.
* Returns NULL if the utility was not found, or it has no description,
* or an error occured.
*/
PUBLIC const char *csoundGetUtilityDescription(CSOUND *,
const char *utilName);
/**
* Simple linear congruential random number generator:
* (*seedVal) = (*seedVal) * 742938285 % 2147483647
* the initial value of *seedVal must be in the range 1 to 2147483646.
* Returns the next number from the pseudo-random sequence,
* in the range 1 to 2147483646.
*/
PUBLIC int csoundRand31(int *seedVal);
/**
* Initialise Mersenne Twister (MT19937) random number generator,
* using 'keyLength' unsigned 32 bit values from 'initKey' as seed.
* If the array is NULL, the length parameter is used for seeding.
*/
PUBLIC void csoundSeedRandMT(CsoundRandMTState *p,
const uint32_t *initKey, uint32_t keyLength);
/**
* Returns next random number from MT19937 generator.
* The PRNG must be initialised first by calling csoundSeedRandMT().
*/
PUBLIC uint32_t csoundRandMT(CsoundRandMTState *p);
#endif /* !CSOUND_CSDL_H */
/* typedefs, macros, and interface functions for configuration variables */
#include "cfgvar.h"
/* message attribute definitions for csoundMessageS() and csoundMessageV() */
#include "msg_attr.h"
/* macro definitions for Csound release, and API version */
#include "version.h"
/**
* Create circular buffer with numelem number of elements. The element's size is set
* from elemsize. It should be used like:
*@code
* void *rb = csoundCreateCircularBuffer(csound, 1024, sizeof(MYFLT));
*@endcode
*/
PUBLIC void *csoundCreateCircularBuffer(CSOUND *csound, int numelem, int elemsize);
/**
* Read from circular buffer
* @param csound This value is currently ignored.
* @param circular_buffer pointer to an existing circular buffer
* @param out preallocated buffer with at least items number of elements, where
* buffer contents will be read into
* @param items number of samples to be read
* @returns the actual number of items read (0 <= n <= items)
*/
PUBLIC int csoundReadCircularBuffer(CSOUND *csound, void *circular_buffer,
void *out, int items);
/**
* Read from circular buffer without removing them from the buffer.
* @param circular_buffer pointer to an existing circular buffer
* @param out preallocated buffer with at least items number of elements, where
* buffer contents will be read into
* @param items number of samples to be read
* @returns the actual number of items read (0 <= n <= items)
*/
PUBLIC int csoundPeekCircularBuffer(CSOUND *csound, void *circular_buffer,
void *out, int items);
/**
* Write to circular buffer
* @param csound This value is currently ignored.
* @param p pointer to an existing circular buffer
* @param inp buffer with at least items number of elements to be written into
* circular buffer
* @param items number of samples to write
* @returns the actual number of items written (0 <= n <= items)
*/
PUBLIC int csoundWriteCircularBuffer(CSOUND *csound, void *p,
const void *inp, int items);
/**
* Empty circular buffer of any remaining data. This function should only be
* used if there is no reader actively getting data from the buffer.
* @param csound This value is currently ignored.
* @param p pointer to an existing circular buffer
*/
PUBLIC void csoundFlushCircularBuffer(CSOUND *csound, void *p);
/**
* Free circular buffer
*/
PUBLIC void csoundDestroyCircularBuffer(CSOUND *csound, void *circularbuffer);
/**
* Platform-independent function to load a shared library.
*/
PUBLIC int csoundOpenLibrary(void **library, const char *libraryPath);
/**
* Platform-independent function to unload a shared library.
*/
PUBLIC int csoundCloseLibrary(void *library);
/**
* Platform-independent function to get a symbol address in a shared library.
*/
PUBLIC void *csoundGetLibrarySymbol(void *library, const char *symbolName);
/** @}*/
#ifdef SWIGPYTHON
PUBLIC CSOUND *csoundGetInstance(long obj){ return (CSOUND *)obj; }
#endif
#ifdef SOME_FINE_DAY /* these functions are now deprecated */
/**
* Returns a pointer to the requested interface, if available, in the
* interface argument, and its version number, in the version argument.
* Returns 0 for success.
*/
PUBLIC int csoundQueryInterface(const char *name,
void **iface, int *version);
/**
* Control values are specified by a 'channelName' string.
* Note that the 'invalue' & 'outvalue' channels can be specified by
* either a string or a number. If a number is specified, it will be
* converted to a string before making the callbacks to the external
* software.
*/
/**
* Called by external software to set a function for Csound to
* fetch input control values. The 'invalue' opcodes will
* directly call this function. If 'channelName' starts with a
* '$', then 'invalue' opcode is expecting a C string, to be copied
* to 'value', with maximum size csoundGetChannelDatasize().
*/
PUBLIC void csoundSetInputValueCallback(CSOUND *,
void (*inputValueCalback_)(CSOUND *,
const char *channelName,
MYFLT *value));
/**
* Called by external software to set a function for Csound to
* send output control values. The 'outvalue' opcodes will
* directly call this function. If 'channelName' starts with a
* '$', then the 'outvalue' opcode is sending a string appended
* to channelName in the format: "$channelName$stringOutput".
* and 'value' will be the index number into 'channelName' where
* the stringOutput begins.
*/
PUBLIC void csoundSetOutputValueCallback(CSOUND *,
void (*outputValueCalback_)(CSOUND *,
const char *channelName,
MYFLT value));
/**
* Sets callback function to be called by the opcodes 'chnsend' and
* 'chnrecv'. Should be called before csoundCompile().
* The callback function takes the following arguments:
* CSOUND *csound
* Csound instance pointer
* const char *channelName
* the channel name
* MYFLT *channelValuePtr
* pointer to the channel value. Control channels are a single MYFLT
* value, while audio channels are an array of csoundGetKsmps(csound)
* MYFLT values. In the case of string channels, the pointer should be
* cast to char *, and points to a buffer of
* csoundGetChannelDatasize() bytes
* int channelType
* bitwise OR of the channel type (CSOUND_CONTROL_CHANNEL,
* CSOUND_AUDIO_CHANNEL, or CSOUND_STRING_CHANNEL; use
* channelType & CSOUND_CHANNEL_TYPE_MASK to extract the channel
* type), and either CSOUND_INPUT_CHANNEL or CSOUND_OUTPUT_CHANNEL
* to indicate the direction of the data transfer
* The callback is not preserved on csoundReset().
*/
PUBLIC void csoundSetChannelIOCallback(CSOUND *,
CsoundChannelIOCallback_t func);
/**
* Senses input events, and performs one control sample worth (ksmps) of
* audio output.
* Note that csoundCompile() or csoundCompileOrc(),
* csoundReadScore(), csoundStart() must be called first.
* Performs audio whether or not the Csound score has finished.
* Enables external software to control the execution of Csound,
* and to synchronize performance with audio input and output.
*/
PUBLIC int csoundPerformKsmpsAbsolute(CSOUND *);
#endif
#ifdef __cplusplus
}
#endif
#endif /* CSOUND_H */
|