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
use std::borrow::Borrow;
use std::ffi::c_void;
use std::mem::{self, MaybeUninit};
use std::num::NonZeroU32;
use std::ptr::NonNull;
use std::sync::atomic::Ordering;
use std::sync::Arc;
use vst3_com::vst::{DataEvent, IProcessContextRequirementsFlags, ProcessModes};
use vst3_sys::base::{kInvalidArgument, kNoInterface, kResultFalse, kResultOk, tresult, TBool};
use vst3_sys::base::{IBStream, IPluginBase};
use vst3_sys::utils::SharedVstPtr;
use vst3_sys::vst::{
kNoParamId, kNoParentUnitId, kNoProgramListId, kRootUnitId, Event, EventTypes, IAudioProcessor,
IComponent, IEditController, IEventList, IMidiMapping, INoteExpressionController,
IParamValueQueue, IParameterChanges, IProcessContextRequirements, IUnitInfo,
LegacyMidiCCOutEvent, NoteExpressionTypeInfo, NoteExpressionValueDescription, NoteOffEvent,
NoteOnEvent, ParameterFlags, PolyPressureEvent, ProgramListInfo, TChar, UnitInfo,
};
use vst3_sys::VST3;
use widestring::U16CStr;
use super::inner::{ProcessEvent, WrapperInner};
use super::note_expressions::{self, NoteExpressionController};
use super::util::{
u16strlcpy, VstPtr, VST3_MIDI_CCS, VST3_MIDI_NUM_PARAMS, VST3_MIDI_PARAMS_START,
};
use super::util::{VST3_MIDI_CHANNELS, VST3_MIDI_PARAMS_END};
use super::view::WrapperView;
use crate::prelude::{
AuxiliaryBuffers, BufferConfig, MidiConfig, NoteEvent, ParamFlags, ProcessMode, ProcessStatus,
SysExMessage, Transport, Vst3Plugin,
};
use crate::util::permit_alloc;
use crate::wrapper::state;
use crate::wrapper::util::buffer_management::{BufferManager, ChannelPointers};
use crate::wrapper::util::{clamp_input_event_timing, clamp_output_event_timing, process_wrapper};
// Alias needed for the VST3 attribute macro
use vst3_sys as vst3_com;
#[VST3(implements(
IComponent,
IEditController,
IAudioProcessor,
IMidiMapping,
INoteExpressionController,
IProcessContextRequirements,
IUnitInfo
))]
pub(crate) struct Wrapper<P: Vst3Plugin> {
inner: Arc<WrapperInner<P>>,
}
impl<P: Vst3Plugin> Wrapper<P> {
pub fn new() -> Box<Self> {
Self::allocate(WrapperInner::new())
}
}
impl<P: Vst3Plugin> Drop for Wrapper<P> {
fn drop(&mut self) {
nih_debug_assert_eq!(Arc::strong_count(&self.inner), 1);
}
}
impl<P: Vst3Plugin> IPluginBase for Wrapper<P> {
unsafe fn initialize(&self, _context: *mut c_void) -> tresult {
// We currently don't need or allow any initialization logic
kResultOk
}
unsafe fn terminate(&self) -> tresult {
kResultOk
}
}
impl<P: Vst3Plugin> IComponent for Wrapper<P> {
unsafe fn get_controller_class_id(&self, _tuid: *mut vst3_sys::IID) -> tresult {
// We won't separate the edit controller to keep the implementation a bit smaller
kNoInterface
}
unsafe fn set_io_mode(&self, _mode: vst3_sys::vst::IoMode) -> tresult {
// Not quite sure what the point of this is when the processing setup also receives similar
// information
kResultOk
}
unsafe fn get_bus_count(
&self,
type_: vst3_sys::vst::MediaType,
dir: vst3_sys::vst::BusDirection,
) -> i32 {
let current_audio_io_layout = self.inner.current_audio_io_layout.load();
// A plugin has a main input and output bus if the default number of channels is non-zero,
// and a plugin can also have auxiliary input and output busses
match type_ {
x if x == vst3_sys::vst::MediaTypes::kAudio as i32
&& dir == vst3_sys::vst::BusDirections::kInput as i32 =>
{
let main_busses = if current_audio_io_layout.main_input_channels.is_some() {
1
} else {
0
};
let aux_busses = current_audio_io_layout.aux_input_ports.len() as i32;
main_busses + aux_busses
}
x if x == vst3_sys::vst::MediaTypes::kAudio as i32
&& dir == vst3_sys::vst::BusDirections::kOutput as i32 =>
{
let main_busses = if current_audio_io_layout.main_output_channels.is_some() {
1
} else {
0
};
let aux_busses = current_audio_io_layout.aux_output_ports.len() as i32;
main_busses + aux_busses
}
x if x == vst3_sys::vst::MediaTypes::kEvent as i32
&& dir == vst3_sys::vst::BusDirections::kInput as i32
&& P::MIDI_INPUT >= MidiConfig::Basic =>
{
1
}
x if x == vst3_sys::vst::MediaTypes::kEvent as i32
&& dir == vst3_sys::vst::BusDirections::kOutput as i32
&& P::MIDI_OUTPUT >= MidiConfig::Basic =>
{
1
}
_ => 0,
}
}
unsafe fn get_bus_info(
&self,
type_: vst3_sys::vst::MediaType,
dir: vst3_sys::vst::BusDirection,
index: i32,
info: *mut vst3_sys::vst::BusInfo,
) -> tresult {
check_null_ptr!(info);
let current_audio_io_layout = self.inner.current_audio_io_layout.load();
match (type_, dir, index) {
(t, d, _)
if t == vst3_sys::vst::MediaTypes::kAudio as i32
&& d == vst3_sys::vst::BusDirections::kInput as i32 =>
{
*info = mem::zeroed();
let info = &mut *info;
info.media_type = vst3_sys::vst::MediaTypes::kAudio as i32;
info.direction = dir;
info.flags = vst3_sys::vst::BusFlags::kDefaultActive as u32;
let has_main_input = current_audio_io_layout.main_input_channels.is_some();
let aux_input_start_idx = if has_main_input { 1 } else { 0 };
let aux_input_idx = (index - aux_input_start_idx).max(0) as usize;
if index == 0 && has_main_input {
info.bus_type = vst3_sys::vst::BusTypes::kMain as i32;
info.channel_count =
current_audio_io_layout.main_input_channels.unwrap().get() as i32;
u16strlcpy(&mut info.name, ¤t_audio_io_layout.main_input_name());
kResultOk
} else if aux_input_idx < current_audio_io_layout.aux_input_ports.len() {
info.bus_type = vst3_sys::vst::BusTypes::kAux as i32;
info.channel_count =
current_audio_io_layout.aux_input_ports[aux_input_idx].get() as i32;
u16strlcpy(
&mut info.name,
¤t_audio_io_layout
.aux_input_name(aux_input_idx)
.expect("Out of bounds auxiliary input port"),
);
kResultOk
} else {
kInvalidArgument
}
}
(t, d, _)
if t == vst3_sys::vst::MediaTypes::kAudio as i32
&& d == vst3_sys::vst::BusDirections::kOutput as i32 =>
{
*info = mem::zeroed();
let info = &mut *info;
info.media_type = vst3_sys::vst::MediaTypes::kAudio as i32;
info.direction = dir;
info.flags = vst3_sys::vst::BusFlags::kDefaultActive as u32;
let has_main_output = current_audio_io_layout.main_output_channels.is_some();
let aux_output_start_idx = if has_main_output { 1 } else { 0 };
let aux_output_idx = (index - aux_output_start_idx).max(0) as usize;
if index == 0 && has_main_output {
info.bus_type = vst3_sys::vst::BusTypes::kMain as i32;
// NOTE: See above, this becomes a 0 channel output if the plugin doesn't have a
// main output
info.channel_count = current_audio_io_layout
.main_output_channels
.map(NonZeroU32::get)
.unwrap_or_default() as i32;
u16strlcpy(&mut info.name, ¤t_audio_io_layout.main_output_name());
kResultOk
} else if aux_output_idx < current_audio_io_layout.aux_output_ports.len() {
info.bus_type = vst3_sys::vst::BusTypes::kAux as i32;
info.channel_count =
current_audio_io_layout.aux_output_ports[aux_output_idx].get() as i32;
u16strlcpy(
&mut info.name,
¤t_audio_io_layout
.aux_output_name(aux_output_idx)
.expect("Out of bounds auxiliary output port"),
);
kResultOk
} else {
kInvalidArgument
}
}
(t, d, 0)
if t == vst3_sys::vst::MediaTypes::kEvent as i32
&& d == vst3_sys::vst::BusDirections::kInput as i32
&& P::MIDI_INPUT >= MidiConfig::Basic =>
{
*info = mem::zeroed();
let info = &mut *info;
info.media_type = vst3_sys::vst::MediaTypes::kEvent as i32;
info.direction = vst3_sys::vst::BusDirections::kInput as i32;
info.channel_count = 16;
u16strlcpy(&mut info.name, "Note Input");
info.bus_type = vst3_sys::vst::BusTypes::kMain as i32;
info.flags = vst3_sys::vst::BusFlags::kDefaultActive as u32;
kResultOk
}
(t, d, 0)
if t == vst3_sys::vst::MediaTypes::kEvent as i32
&& d == vst3_sys::vst::BusDirections::kOutput as i32
&& P::MIDI_OUTPUT >= MidiConfig::Basic =>
{
*info = mem::zeroed();
let info = &mut *info;
info.media_type = vst3_sys::vst::MediaTypes::kEvent as i32;
info.direction = vst3_sys::vst::BusDirections::kOutput as i32;
info.channel_count = 16;
u16strlcpy(&mut info.name, "Note Output");
info.bus_type = vst3_sys::vst::BusTypes::kMain as i32;
info.flags = vst3_sys::vst::BusFlags::kDefaultActive as u32;
kResultOk
}
_ => kInvalidArgument,
}
}
unsafe fn get_routing_info(
&self,
in_info: *mut vst3_sys::vst::RoutingInfo,
out_info: *mut vst3_sys::vst::RoutingInfo,
) -> tresult {
check_null_ptr!(in_info, out_info);
let current_audio_io_layout = self.inner.current_audio_io_layout.load();
*out_info = mem::zeroed();
let in_info = &*in_info;
let out_info = &mut *out_info;
match (in_info.media_type, in_info.bus_index) {
(t, 0)
if t == vst3_sys::vst::MediaTypes::kAudio as i32
// We only have an IO pair when the plugin has both a main input and a main output
&& current_audio_io_layout.main_input_channels.is_some()
&& current_audio_io_layout.main_output_channels.is_some() =>
{
out_info.media_type = vst3_sys::vst::MediaTypes::kAudio as i32;
out_info.bus_index = in_info.bus_index;
out_info.channel = in_info.channel;
kResultOk
}
(t, 0)
if t == vst3_sys::vst::MediaTypes::kEvent as i32
&& P::MIDI_INPUT >= MidiConfig::Basic
&& P::MIDI_OUTPUT >= MidiConfig::Basic =>
{
out_info.media_type = vst3_sys::vst::MediaTypes::kEvent as i32;
out_info.bus_index = in_info.bus_index;
out_info.channel = in_info.channel;
kResultOk
}
_ => kResultFalse,
}
}
unsafe fn activate_bus(
&self,
type_: vst3_sys::vst::MediaType,
dir: vst3_sys::vst::BusDirection,
index: i32,
_state: vst3_sys::base::TBool,
) -> tresult {
let current_audio_io_layout = self.inner.current_audio_io_layout.load();
// We don't support this, but the validator will get very angry with us if we let it know
// that
match (type_, dir, index) {
(t, d, _)
if t == vst3_sys::vst::MediaTypes::kAudio as i32
&& d == vst3_sys::vst::BusDirections::kInput as i32 =>
{
let main_busses = if current_audio_io_layout.main_input_channels.is_some() {
1
} else {
0
};
let aux_busses = current_audio_io_layout.aux_input_ports.len() as i32;
if (0..main_busses + aux_busses).contains(&index) {
kResultOk
} else {
kInvalidArgument
}
}
(t, d, _)
if t == vst3_sys::vst::MediaTypes::kAudio as i32
&& d == vst3_sys::vst::BusDirections::kOutput as i32 =>
{
let main_busses = if current_audio_io_layout.main_output_channels.is_some() {
1
} else {
0
};
let aux_busses = current_audio_io_layout.aux_output_ports.len() as i32;
if (0..main_busses + aux_busses).contains(&index) {
kResultOk
} else {
kInvalidArgument
}
}
(t, d, 0)
if t == vst3_sys::vst::MediaTypes::kEvent as i32
&& d == vst3_sys::vst::BusDirections::kInput as i32
&& P::MIDI_INPUT >= MidiConfig::Basic =>
{
kResultOk
}
(t, d, 0)
if t == vst3_sys::vst::MediaTypes::kEvent as i32
&& d == vst3_sys::vst::BusDirections::kOutput as i32
&& P::MIDI_OUTPUT >= MidiConfig::Basic =>
{
kResultOk
}
_ => kInvalidArgument,
}
}
unsafe fn set_active(&self, state: TBool) -> tresult {
// We could call initialize in `IAudioProcessor::setup_processing()`, but REAPER will set
// the bus arrangements between that function and this function. So to be able to handle
// custom channel layout overrides we need to initialize here.
match (state != 0, self.inner.current_buffer_config.load()) {
(true, Some(buffer_config)) => {
// Before initializing the plugin, make sure all smoothers are set the the default values
for param in self.inner.param_by_hash.values() {
param.update_smoother(buffer_config.sample_rate, true);
}
// NOTE: This needs to be dropped after the `plugin` lock to avoid deadlocks
let mut init_context = self.inner.make_init_context();
let audio_io_layout = self.inner.current_audio_io_layout.load();
let mut plugin = self.inner.plugin.lock();
if plugin.initialize(&audio_io_layout, &buffer_config, &mut init_context) {
// NOTE: We don't call `Plugin::reset()` here. The call is done in `set_process()`
// instead. Otherwise we would call the function twice, and `set_process()` needs
// to be called after this function before the plugin may process audio again.
// This preallocates enough space so we can transform all of the host's raw
// channel pointers into a set of `Buffer` objects for the plugin's main and
// auxiliary IO
*self.inner.buffer_manager.borrow_mut() = BufferManager::for_audio_io_layout(
buffer_config.max_buffer_size as usize,
audio_io_layout,
);
kResultOk
} else {
kResultFalse
}
}
(true, None) => kResultFalse,
(false, _) => {
self.inner.plugin.lock().deactivate();
kResultOk
}
}
}
unsafe fn set_state(&self, state: SharedVstPtr<dyn IBStream>) -> tresult {
check_null_ptr!(state);
let state = state.upgrade().unwrap();
// We need to know how large the state is before we can read it. The current position can be
// zero, but it can also be something else. Bitwig prepends the preset header in the stream,
// while some other hosts don't expose that to the plugin.
let mut current_pos = 0;
let mut eof_pos = 0;
if state.tell(&mut current_pos) != kResultOk
|| state.seek(0, vst3_sys::base::kIBSeekEnd, &mut eof_pos) != kResultOk
|| state.seek(
current_pos,
vst3_sys::base::kIBSeekSet,
std::ptr::null_mut(),
) != kResultOk
{
nih_debug_assert_failure!("Could not get the stream length");
return kResultFalse;
}
let stream_byte_size = (eof_pos - current_pos) as i32;
let mut num_bytes_read = 0;
let mut read_buffer: Vec<u8> = Vec::with_capacity(stream_byte_size as usize);
state.read(
read_buffer.as_mut_ptr() as *mut c_void,
read_buffer.capacity() as i32,
&mut num_bytes_read,
);
read_buffer.set_len(num_bytes_read as usize);
// If the size is zero, some hosts will always return `kResultFalse` even if the read was
// 'successful', so we can't check the return value but we can check the number of bytes
// read.
if read_buffer.len() != stream_byte_size as usize {
nih_debug_assert_failure!("Unexpected stream length");
return kResultFalse;
}
match state::deserialize_json(&read_buffer) {
Some(mut state) => {
if self.inner.set_state_inner(&mut state) {
nih_trace!("Loaded state ({} bytes)", read_buffer.len());
kResultOk
} else {
kResultFalse
}
}
None => kResultFalse,
}
}
unsafe fn get_state(&self, state: SharedVstPtr<dyn IBStream>) -> tresult {
check_null_ptr!(state);
let state = state.upgrade().unwrap();
let serialized = state::serialize_json::<P>(
self.inner.params.clone(),
state::make_params_iter(&self.inner.param_by_hash, &self.inner.param_id_to_hash),
);
match serialized {
Ok(serialized) => {
let mut num_bytes_written = 0;
let result = state.write(
serialized.as_ptr() as *const c_void,
serialized.len() as i32,
&mut num_bytes_written,
);
nih_debug_assert_eq!(result, kResultOk);
nih_debug_assert_eq!(num_bytes_written as usize, serialized.len());
nih_trace!("Saved state ({} bytes)", serialized.len());
kResultOk
}
Err(err) => {
nih_debug_assert_failure!("Could not save state: {:#}", err);
kResultFalse
}
}
}
}
impl<P: Vst3Plugin> IEditController for Wrapper<P> {
unsafe fn set_component_state(&self, _state: SharedVstPtr<dyn IBStream>) -> tresult {
// We have a single file component, so we don't need to do anything here
kResultOk
}
unsafe fn set_state(&self, _state: SharedVstPtr<dyn IBStream>) -> tresult {
// We don't store any separate state here. The plugin's state will have been restored
// through the component. Calling that same function here will likely lead to duplicate
// state restores
kResultOk
}
unsafe fn get_state(&self, _state: SharedVstPtr<dyn IBStream>) -> tresult {
// Same for this function
kResultOk
}
unsafe fn get_parameter_count(&self) -> i32 {
// We need to add a whole bunch of parameters if the plugin accepts MIDI CCs
if P::MIDI_INPUT >= MidiConfig::MidiCCs {
self.inner.param_hashes.len() as i32 + VST3_MIDI_NUM_PARAMS as i32
} else {
self.inner.param_hashes.len() as i32
}
}
unsafe fn get_parameter_info(
&self,
param_index: i32,
info: *mut vst3_sys::vst::ParameterInfo,
) -> tresult {
check_null_ptr!(info);
if param_index < 0 || param_index > self.get_parameter_count() {
return kInvalidArgument;
}
*info = std::mem::zeroed();
let info = &mut *info;
// If the parameter is a generated MIDI CC/channel pressure/pitch bend then it needs to be
// handled separately
let num_actual_params = self.inner.param_hashes.len() as i32;
if P::MIDI_INPUT >= MidiConfig::MidiCCs && param_index >= num_actual_params {
let midi_param_relative_idx = (param_index - num_actual_params) as u32;
// This goes up to 130 for the 128 CCs followed by channel pressure and pitch bend
let midi_cc = midi_param_relative_idx % VST3_MIDI_CCS;
let midi_channel = midi_param_relative_idx / VST3_MIDI_CCS;
let name = match midi_cc {
// kAfterTouch
128 => format!("MIDI Ch. {} Channel Pressure", midi_channel + 1),
// kPitchBend
129 => format!("MIDI Ch. {} Pitch Bend", midi_channel + 1),
n => format!("MIDI Ch. {} CC {}", midi_channel + 1, n),
};
info.id = VST3_MIDI_PARAMS_START + midi_param_relative_idx;
u16strlcpy(&mut info.title, &name);
u16strlcpy(&mut info.short_title, &name);
info.flags = ParameterFlags::kIsReadOnly as i32 | (1 << 4); // kIsHidden
} else {
let param_hash = &self.inner.param_hashes[param_index as usize];
let param_unit = &self
.inner
.param_units
.get_vst3_unit_id(*param_hash)
.expect("Inconsistent parameter data");
let param_ptr = &self.inner.param_by_hash[param_hash];
let default_value = param_ptr.default_normalized_value();
let flags = param_ptr.flags();
let automatable = !flags.contains(ParamFlags::NON_AUTOMATABLE);
let hidden = flags.contains(ParamFlags::HIDDEN);
let is_bypass = flags.contains(ParamFlags::BYPASS);
info.id = *param_hash;
u16strlcpy(&mut info.title, param_ptr.name());
u16strlcpy(&mut info.short_title, param_ptr.name());
u16strlcpy(&mut info.units, param_ptr.unit());
info.step_count = param_ptr.step_count().unwrap_or(0) as i32;
info.default_normalized_value = default_value as f64;
info.unit_id = *param_unit;
info.flags = 0;
if automatable && !hidden {
info.flags |= ParameterFlags::kCanAutomate as i32;
}
if hidden {
info.flags |= ParameterFlags::kIsReadOnly as i32 | (1 << 4); // kIsHidden
}
if is_bypass {
info.flags |= ParameterFlags::kIsBypass as i32;
}
}
kResultOk
}
unsafe fn get_param_string_by_value(
&self,
id: u32,
value_normalized: f64,
string: *mut TChar,
) -> tresult {
check_null_ptr!(string);
let dest = &mut *(string as *mut [TChar; 128]);
// TODO: We don't implement these methods at all for our generated MIDI CC parameters,
// should be fine right? They should be hidden anyways.
match self.inner.param_by_hash.get(&id) {
Some(param_ptr) => {
u16strlcpy(
dest,
¶m_ptr.normalized_value_to_string(value_normalized as f32, false),
);
kResultOk
}
_ => kInvalidArgument,
}
}
unsafe fn get_param_value_by_string(
&self,
id: u32,
string: *const TChar,
value_normalized: *mut f64,
) -> tresult {
check_null_ptr!(string, value_normalized);
let string = match U16CStr::from_ptr_str(string as *const u16).to_string() {
Ok(s) => s,
Err(_) => return kInvalidArgument,
};
match self.inner.param_by_hash.get(&id) {
Some(param_ptr) => {
let value = match param_ptr.string_to_normalized_value(&string) {
Some(v) => v as f64,
None => return kResultFalse,
};
*value_normalized = value;
kResultOk
}
_ => kInvalidArgument,
}
}
unsafe fn normalized_param_to_plain(&self, id: u32, value_normalized: f64) -> f64 {
match self.inner.param_by_hash.get(&id) {
Some(param_ptr) => param_ptr.preview_plain(value_normalized as f32) as f64,
_ => value_normalized,
}
}
unsafe fn plain_param_to_normalized(&self, id: u32, plain_value: f64) -> f64 {
match self.inner.param_by_hash.get(&id) {
Some(param_ptr) => param_ptr.preview_normalized(plain_value as f32) as f64,
_ => plain_value,
}
}
unsafe fn get_param_normalized(&self, id: u32) -> f64 {
match self.inner.param_by_hash.get(&id) {
Some(param_ptr) => param_ptr.modulated_normalized_value() as f64,
_ => 0.5,
}
}
unsafe fn set_param_normalized(&self, id: u32, value: f64) -> tresult {
// If the plugin is currently processing audio, then this parameter change will also be sent
// to the process function
if self.inner.is_processing.load(Ordering::SeqCst) {
return kResultOk;
}
let sample_rate = self
.inner
.current_buffer_config
.load()
.map(|c| c.sample_rate);
self.inner
.set_normalized_value_by_hash(id, value as f32, sample_rate)
}
unsafe fn set_component_handler(
&self,
handler: SharedVstPtr<dyn vst3_sys::vst::IComponentHandler>,
) -> tresult {
*self.inner.component_handler.borrow_mut() = handler.upgrade().map(VstPtr::from);
kResultOk
}
unsafe fn create_view(&self, _name: vst3_sys::base::FIDString) -> *mut c_void {
// Without specialization this is the least redundant way to check if the plugin has an
// editor. The default implementation returns a None here.
match self.inner.editor.borrow().as_ref() {
Some(editor) => Box::into_raw(WrapperView::new(self.inner.clone(), editor.clone()))
as *mut vst3_sys::c_void,
None => std::ptr::null_mut(),
}
}
}
impl<P: Vst3Plugin> IAudioProcessor for Wrapper<P> {
unsafe fn set_bus_arrangements(
&self,
inputs: *mut vst3_sys::vst::SpeakerArrangement,
num_ins: i32,
outputs: *mut vst3_sys::vst::SpeakerArrangement,
num_outs: i32,
) -> tresult {
check_null_ptr!(inputs, outputs);
// Why are these signed integers again?
if num_ins < 0 || num_outs < 0 {
return kInvalidArgument;
}
// NIH-plug no longer supports flexible IO layouts. Instead we'll try to find an audio IO
// layout that matches the host's requested layout.
let matching_layout = P::AUDIO_IO_LAYOUTS
.iter()
.find(|layout| {
// If the number of ports/busses doesn't match then we can immediately discard the
// layout. VST3 doesn't allow for optional switchable ports like CLAP does. Only the
// channel counts can change.
let num_layout_ins = if layout.main_input_channels.is_some() {
1
} else {
0
} + layout.aux_input_ports.len();
let num_layout_outs = if layout.main_output_channels.is_some() {
1
} else {
0
} + layout.aux_output_ports.len();
if num_ins as usize != num_layout_ins || num_outs as usize != num_layout_outs {
return false;
}
// NOTE: We completely ignore the speaker arrangements and only look at the channel
// counts here. This may cause issues at some point, but it works for now.
let has_main_input = layout.main_input_channels.is_some();
let aux_input_start_idx = if has_main_input { 0 } else { 1 };
if has_main_input
&& (*inputs).count_ones() != layout.main_input_channels.unwrap().get()
{
return false;
}
for (aux_input_idx, channel_count) in layout.aux_input_ports.iter().enumerate() {
if (*inputs.add(aux_input_idx + aux_input_start_idx)).count_ones()
!= channel_count.get()
{
return false;
}
}
let has_main_output = layout.main_output_channels.is_some();
let aux_output_start_idx = if has_main_output { 0 } else { 1 };
if (*outputs).count_ones()
!= layout
.main_output_channels
.map(NonZeroU32::get)
.unwrap_or_default()
{
return false;
}
for (aux_output_idx, channel_count) in layout.aux_output_ports.iter().enumerate() {
if (*outputs.add(aux_output_idx + aux_output_start_idx)).count_ones()
!= channel_count.get()
{
return false;
}
}
true
})
.copied();
match matching_layout {
Some(layout) => {
// This layout is used from hereon onwards, at least until this function is called
// again
self.inner.current_audio_io_layout.store(layout);
kResultOk
}
None => kResultFalse,
}
}
unsafe fn get_bus_arrangement(
&self,
dir: vst3_sys::vst::BusDirection,
index: i32,
arr: *mut vst3_sys::vst::SpeakerArrangement,
) -> tresult {
check_null_ptr!(arr);
let channel_count_to_map = |count| match count {
0 => vst3_sys::vst::kEmpty,
1 => vst3_sys::vst::kMono,
2 => vst3_sys::vst::kStereo,
5 => vst3_sys::vst::k50,
6 => vst3_sys::vst::k51,
7 => vst3_sys::vst::k70Cine,
8 => vst3_sys::vst::k71Cine,
n => {
nih_debug_assert_failure!(
"No defined layout for {} channels, making something up on the spot...",
n
);
(1 << n) - 1
}
};
let current_audio_io_layout = self.inner.current_audio_io_layout.load();
let num_channels = if dir == vst3_sys::vst::BusDirections::kInput as i32 {
let has_main_input = current_audio_io_layout.main_input_channels.is_some();
let aux_input_start_idx = if has_main_input { 1 } else { 0 };
let aux_input_idx = (index - aux_input_start_idx).max(0) as usize;
if index == 0 && has_main_input {
current_audio_io_layout.main_input_channels.unwrap().get()
} else if aux_input_idx < current_audio_io_layout.aux_input_ports.len() {
current_audio_io_layout.aux_input_ports[aux_input_idx].get()
} else {
return kInvalidArgument;
}
} else if dir == vst3_sys::vst::BusDirections::kOutput as i32 {
let has_main_output = current_audio_io_layout.main_output_channels.is_some();
let aux_output_start_idx = if has_main_output { 1 } else { 0 };
let aux_output_idx = (index - aux_output_start_idx).max(0) as usize;
if index == 0 && has_main_output {
current_audio_io_layout.main_output_channels.unwrap().get()
} else if aux_output_idx < current_audio_io_layout.aux_output_ports.len() {
current_audio_io_layout.aux_output_ports[aux_output_idx].get()
} else {
return kInvalidArgument;
}
} else {
return kInvalidArgument;
};
let channel_map = channel_count_to_map(num_channels);
nih_debug_assert_eq!(num_channels, channel_map.count_ones());
*arr = channel_map;
kResultOk
}
unsafe fn can_process_sample_size(&self, symbolic_sample_size: i32) -> tresult {
if symbolic_sample_size == vst3_sys::vst::SymbolicSampleSizes::kSample32 as i32 {
kResultOk
} else {
kResultFalse
}
}
unsafe fn get_latency_samples(&self) -> u32 {
self.inner.current_latency.load(Ordering::SeqCst)
}
unsafe fn setup_processing(&self, setup: *const vst3_sys::vst::ProcessSetup) -> tresult {
check_null_ptr!(setup);
// There's no special handling for offline processing at the moment
let setup = &*setup;
nih_debug_assert_eq!(
setup.symbolic_sample_size,
vst3_sys::vst::SymbolicSampleSizes::kSample32 as i32
);
// This is needed when activating the plugin and when restoring state
self.inner.current_buffer_config.store(Some(BufferConfig {
sample_rate: setup.sample_rate as f32,
min_buffer_size: None,
max_buffer_size: setup.max_samples_per_block as u32,
process_mode: self.inner.current_process_mode.load(),
}));
let mode = match setup.process_mode {
n if n == ProcessModes::kRealtime as i32 => ProcessMode::Realtime,
n if n == ProcessModes::kPrefetch as i32 => ProcessMode::Buffered,
n if n == ProcessModes::kOffline as i32 => ProcessMode::Offline,
n => {
nih_debug_assert_failure!("Unknown rendering mode '{}', defaulting to realtime", n);
ProcessMode::Realtime
}
};
self.inner.current_process_mode.store(mode);
// Initializing the plugin happens in `IAudioProcessor::set_active()` because the host may
// still change the channel layouts at this point
kResultOk
}
unsafe fn set_processing(&self, state: TBool) -> tresult {
let state = state != 0;
// Always reset the processing status when the plugin gets activated or deactivated
self.inner.last_process_status.store(ProcessStatus::Normal);
self.inner.is_processing.store(state, Ordering::SeqCst);
// This function is also used to reset buffers on the plugin, so we should do the same
// thing. We don't call `reset()` in `setup_processing()` for that same reason.
if state {
// HACK: See the comment in `IComponent::setActive()`. This is needed to work around
// Ardour bugs.
let mut plugin = match self.inner.plugin.try_lock() {
Some(plugin) => plugin,
None => {
nih_debug_assert_failure!(
"The host tried to call IAudioProcessor::setProcessing(true) during a \
reentrent call to IComponent::setActive(true), returning kResultOk. If \
this is Ardour then it will still call \
IAudioProcessor::setProcessing(true) later and everything will be fine. \
Hopefully."
);
return kResultOk;
}
};
process_wrapper(|| plugin.reset());
}
// We don't have any special handling for suspending and resuming plugins, yet
kResultOk
}
// Clippy doesn't understand our `event_start_idx`
#[allow(clippy::mut_range_bound)]
unsafe fn process(&self, data: *mut vst3_sys::vst::ProcessData) -> tresult {
check_null_ptr!(data);
// Panic on allocations if the `assert_process_allocs` feature has been enabled, and make
// sure that FTZ is set up correctly
process_wrapper(|| {
// We need to handle incoming automation first
let data = &*data;
let sample_rate = self
.inner
.current_buffer_config
.load()
.expect("Process call without prior setup call")
.sample_rate;
nih_debug_assert!(data.num_inputs >= 0 && data.num_outputs >= 0);
nih_debug_assert_eq!(
data.symbolic_sample_size,
vst3_sys::vst::SymbolicSampleSizes::kSample32 as i32
);
nih_debug_assert!(data.num_samples >= 0);
let total_buffer_len = data.num_samples as usize;
let current_audio_io_layout = self.inner.current_audio_io_layout.load();
let has_main_input = current_audio_io_layout.main_input_channels.is_some();
let has_main_output = current_audio_io_layout.main_output_channels.is_some();
let aux_input_start_idx = if has_main_input { 1 } else { 0 };
let aux_output_start_idx = if has_main_output { 1 } else { 0 };
// NOTE: VST3 hosts may trigger a 'parameter flush' by calling the process function for
// 0 input samples. If this is the case then we'll only handle events and skip all
// audio processing. Some hosts, like Ableton Live, implement this in a broken way
// and instead only set the number of channels to 0. In that case the
// 'buffer_is_valid' check from below should still prevent audio processing.
let mut is_param_flush = total_buffer_len == 0;
if (data.num_outputs == 0 || data.outputs.is_null())
&& (has_main_output || !current_audio_io_layout.aux_output_ports.is_empty())
{
is_param_flush = true;
}
// If `P::SAMPLE_ACCURATE_AUTOMATION` is set, then we'll split up the audio buffer into
// chunks whenever a parameter change occurs. To do that, we'll store all of those
// parameter changes in a vector. Otherwise all parameter changes are handled right here
// and now. We'll also need to store the note events in the same vector because MIDI CC
// messages are sent through parameter changes. This vector gets sorted at the end so we
// can treat it as a sort of queue.
let mut process_events = self.inner.process_events.borrow_mut();
process_events.clear();
// First we'll go through the parameter changes. This may also include MIDI CC messages
// if the plugin supports those
if let Some(param_changes) = data.input_param_changes.upgrade() {
let num_param_queues = param_changes.get_parameter_count();
for change_queue_idx in 0..num_param_queues {
if let Some(param_change_queue) =
param_changes.get_parameter_data(change_queue_idx).upgrade()
{
let param_hash = param_change_queue.get_parameter_id();
let num_changes = param_change_queue.get_point_count();
if num_changes <= 0 {
continue;
}
let mut sample_offset = 0i32;
let mut value = 0.0f64;
for change_idx in 0..num_changes {
if param_change_queue.get_point(
change_idx,
&mut sample_offset,
&mut value,
) == kResultOk
{
// Later this timing will be compensated for block splits by calling
// `event.subtract_timing(block_start)` before it is passed to the
// plugin. Out of bounds events are clamped to the buffer>
let timing = clamp_input_event_timing(
sample_offset as u32,
total_buffer_len as u32,
);
let value = value as f32;
// MIDI CC messages, channel pressure, and pitch bend are also sent
// as parameter changes
if P::MIDI_INPUT >= MidiConfig::MidiCCs
&& (VST3_MIDI_PARAMS_START..VST3_MIDI_PARAMS_END)
.contains(¶m_hash)
{
let midi_param_relative_idx =
param_hash - VST3_MIDI_PARAMS_START;
// This goes up to 130 for the 128 CCs followed by channel pressure and pitch bend
let midi_cc = (midi_param_relative_idx % VST3_MIDI_CCS) as u8;
let midi_channel =
(midi_param_relative_idx / VST3_MIDI_CCS) as u8;
process_events.push(ProcessEvent::NoteEvent(match midi_cc {
// kAfterTouch
128 => NoteEvent::MidiChannelPressure {
timing,
channel: midi_channel,
pressure: value,
},
// kPitchBend
129 => NoteEvent::MidiPitchBend {
timing,
channel: midi_channel,
value,
},
n => NoteEvent::MidiCC {
timing,
channel: midi_channel,
cc: n,
value,
},
}));
} else if P::SAMPLE_ACCURATE_AUTOMATION {
process_events.push(ProcessEvent::ParameterChange {
timing,
hash: param_hash,
normalized_value: value,
});
} else {
self.inner.set_normalized_value_by_hash(
param_hash,
value,
Some(sample_rate),
);
}
}
}
}
}
}
// Then we'll add all of our input events
if P::MIDI_INPUT >= MidiConfig::Basic {
let mut note_expression_controller =
self.inner.note_expression_controller.borrow_mut();
if let Some(events) = data.input_events.upgrade() {
let num_events = events.get_event_count();
let mut event: MaybeUninit<_> = MaybeUninit::uninit();
for i in 0..num_events {
let result = events.get_event(i, event.as_mut_ptr());
nih_debug_assert_eq!(result, kResultOk);
let event = event.assume_init();
let timing = clamp_input_event_timing(
event.sample_offset as u32,
total_buffer_len as u32,
);
if event.type_ == EventTypes::kNoteOnEvent as u16 {
let event = event.event.note_on;
// We need to keep track of note IDs to be able to handle not
// expression value events
note_expression_controller.register_note(&event);
process_events.push(ProcessEvent::NoteEvent(NoteEvent::NoteOn {
timing,
voice_id: if event.note_id != -1 {
Some(event.note_id)
} else {
None
},
channel: event.channel as u8,
note: event.pitch as u8,
velocity: event.velocity,
}));
} else if event.type_ == EventTypes::kNoteOffEvent as u16 {
let event = event.event.note_off;
process_events.push(ProcessEvent::NoteEvent(NoteEvent::NoteOff {
timing,
voice_id: if event.note_id != -1 {
Some(event.note_id)
} else {
None
},
channel: event.channel as u8,
note: event.pitch as u8,
velocity: event.velocity,
}));
} else if event.type_ == EventTypes::kPolyPressureEvent as u16 {
let event = event.event.poly_pressure;
process_events.push(ProcessEvent::NoteEvent(NoteEvent::PolyPressure {
timing,
voice_id: if event.note_id != -1 {
Some(event.note_id)
} else {
None
},
channel: event.channel as u8,
note: event.pitch as u8,
pressure: event.pressure,
}));
} else if event.type_ == EventTypes::kNoteExpressionValueEvent as u16 {
let event = event.event.note_expression_value;
match note_expression_controller.translate_event(timing, &event) {
Some(translated_event) => {
process_events.push(ProcessEvent::NoteEvent(translated_event))
}
None => nih_debug_assert_failure!(
"Unhandled note expression type: {}",
event.type_id
),
}
} else if event.type_ == EventTypes::kDataEvent as u16
&& event.event.data.type_ == 0
{
// 0 = kMidiSysEx
let event = event.event.data;
// `NoteEvent::from_midi` prints some tracing if parsing fails, which is
// not necessarily an error
assert!(!event.bytes.is_null());
let sysex_buffer =
std::slice::from_raw_parts(event.bytes, event.size as usize);
if let Ok(note_event) = NoteEvent::from_midi(timing, sysex_buffer) {
process_events.push(ProcessEvent::NoteEvent(note_event));
};
}
}
}
}
// And then we'll make sure everything is in the right order
// NOTE: It's important that this sort is stable, because parameter changes need to be
// processed before note events. Otherwise you'll get out of bounds note events
// with block splitting when the note event occurs at one index after the end (or
// on the exclusive end index) of the block.
// FIXME: Apparently stable sort allcoates if the slice is large enough. This should be
// fixed at some point.
permit_alloc(|| {
process_events.sort_by_key(|event| match event {
ProcessEvent::ParameterChange { timing, .. } => *timing,
ProcessEvent::NoteEvent(event) => event.timing(),
})
});
let mut block_start = 0usize;
let mut block_end;
let mut event_start_idx = 0;
let result = loop {
// In sample-accurate automation mode we'll handle all parameter changes from the
// sorted process event array until we run into for the current sample, and then
// process the block between the current sample and the sample containing the next
// parameter change, if any. All timings also need to be compensated for this. As
// mentioned above, for this to work correctly parameter changes need to be ordered
// before note events at the same index.
// The extra scope is here to make sure we release the borrow on input_events
{
let mut input_events = self.inner.input_events.borrow_mut();
input_events.clear();
block_end = total_buffer_len;
for event_idx in event_start_idx..process_events.len() {
match &process_events[event_idx] {
ProcessEvent::ParameterChange {
timing,
hash,
normalized_value,
} => {
// If this parameter change happens after the start of this block, then
// we'll split the block here and handle this parameter change after
// we've processed this block
if *timing != block_start as u32 {
event_start_idx = event_idx;
block_end = *timing as usize;
break;
}
self.inner.set_normalized_value_by_hash(
*hash,
*normalized_value,
Some(sample_rate),
);
}
ProcessEvent::NoteEvent(event) => {
// We need to make sure to compensate the event for any block splitting,
// since we had to create the event object beforehand
let mut event = event.clone();
event.subtract_timing(block_start as u32);
input_events.push_back(event);
}
}
}
}
let result = if is_param_flush {
kResultOk
} else {
// After processing the events we now know where/if the block should be split,
// and we can start preparing audio processing
let block_len = block_end - block_start;
// The buffer manager preallocated buffer slices for all the IO and storage for
// any axuiliary inputs.
let mut buffer_manager = self.inner.buffer_manager.borrow_mut();
let buffers =
buffer_manager.create_buffers(block_start, block_len, |buffer_source| {
if data.num_outputs > 0
&& !data.outputs.is_null()
&& !(*data.outputs).buffers.is_null()
&& has_main_output
{
let audio_output = &*data.outputs;
let ptrs =
NonNull::new(audio_output.buffers as *mut *mut f32).unwrap();
let num_channels = audio_output.num_channels as usize;
*buffer_source.main_output_channel_pointers =
Some(ChannelPointers { ptrs, num_channels });
}
if data.num_inputs > 0
&& !data.inputs.is_null()
&& !(*data.inputs).buffers.is_null()
&& has_main_input
{
let audio_input = &*data.inputs;
let ptrs =
NonNull::new(audio_input.buffers as *mut *mut f32).unwrap();
let num_channels = audio_input.num_channels as usize;
*buffer_source.main_input_channel_pointers =
Some(ChannelPointers { ptrs, num_channels });
}
if !data.inputs.is_null() {
for (aux_input_no, aux_input_channel_pointers) in buffer_source
.aux_input_channel_pointers
.iter_mut()
.enumerate()
{
let aux_input_idx = aux_input_no + aux_input_start_idx;
if aux_input_idx > data.num_outputs as usize {
break;
}
let audio_input = &*data.inputs.add(aux_input_idx);
match NonNull::new(audio_input.buffers as *mut *mut f32) {
Some(ptrs) => {
let num_channels = audio_input.num_channels as usize;
*aux_input_channel_pointers =
Some(ChannelPointers { ptrs, num_channels });
}
None => continue,
}
}
}
if !data.outputs.is_null() {
for (aux_output_no, aux_output_channel_pointers) in buffer_source
.aux_output_channel_pointers
.iter_mut()
.enumerate()
{
let aux_output_idx = aux_output_no + aux_output_start_idx;
if aux_output_idx > data.num_outputs as usize {
break;
}
let audio_output = &*data.outputs.add(aux_output_idx);
match NonNull::new(audio_output.buffers as *mut *mut f32) {
Some(ptrs) => {
let num_channels = audio_output.num_channels as usize;
*aux_output_channel_pointers =
Some(ChannelPointers { ptrs, num_channels });
}
None => continue,
}
}
}
});
// We already checked whether the host has initiated a parameter flush, but in
// case it still did something unexpected that we did not catch we'll still try
// to prevent processing audio when the slices don't contain the values we
// expect.
let mut buffer_is_valid = true;
for output_buffer_slice in
buffers.main_buffer.as_slice_immutable().iter().chain(
buffers
.aux_outputs
.iter()
.flat_map(|buffer| buffer.as_slice_immutable().iter()),
)
{
if output_buffer_slice.is_empty() {
buffer_is_valid = false;
break;
}
}
nih_debug_assert!(buffer_is_valid);
// Some of the fields are left empty because VST3 does not provide this
// information, but the methods on [`Transport`] can reconstruct these values
// from the other fields
let mut transport = Transport::new(sample_rate);
if !data.context.is_null() {
let context = &*data.context;
// These constants are missing from vst3-sys, see:
// https://steinbergmedia.github.io/vst3_doc/vstinterfaces/structSteinberg_1_1Vst_1_1ProcessContext.html
transport.playing = context.state & (1 << 1) != 0; // kPlaying
transport.recording = context.state & (1 << 3) != 0; // kRecording
if context.state & (1 << 10) != 0 {
// kTempoValid
transport.tempo = Some(context.tempo);
}
if context.state & (1 << 13) != 0 {
// kTimeSigValid
transport.time_sig_numerator = Some(context.time_sig_num);
transport.time_sig_denominator = Some(context.time_sig_den);
}
// We need to compensate for the block splitting here
transport.pos_samples =
Some(context.project_time_samples + block_start as i64);
if context.state & (1 << 9) != 0 {
// kProjectTimeMusicValid
if P::SAMPLE_ACCURATE_AUTOMATION
&& block_start > 0
&& (context.state & (1 << 10) != 0)
{
// kTempoValid
transport.pos_beats = Some(
context.project_time_music
+ (block_start as f64 / sample_rate as f64 / 60.0
* context.tempo),
);
} else {
transport.pos_beats = Some(context.project_time_music);
}
}
if context.state & (1 << 11) != 0 {
// kBarPositionValid
if P::SAMPLE_ACCURATE_AUTOMATION && block_start > 0 {
// The transport object knows how to recompute this from the other information
transport.bar_start_pos_beats =
match transport.bar_start_pos_beats() {
Some(updated) => Some(updated),
None => Some(context.bar_position_music),
};
} else {
transport.bar_start_pos_beats = Some(context.bar_position_music);
}
}
if context.state & (1 << 2) != 0 && context.state & (1 << 12) != 0 {
// kCycleActive && kCycleValid
transport.loop_range_beats =
Some((context.cycle_start_music, context.cycle_end_music));
}
}
let result = if buffer_is_valid {
// NOTE: `parking_lot`'s mutexes sometimes allocate because of their use of
// thread locals
let mut plugin = permit_alloc(|| self.inner.plugin.lock());
let mut aux = AuxiliaryBuffers {
inputs: buffers.aux_inputs,
outputs: buffers.aux_outputs,
};
let mut context = self.inner.make_process_context(transport);
let result = plugin.process(buffers.main_buffer, &mut aux, &mut context);
self.inner.last_process_status.store(result);
result
} else {
ProcessStatus::Normal
};
match result {
ProcessStatus::Error(err) => {
nih_debug_assert_failure!("Process error: {}", err);
return kResultFalse;
}
_ => kResultOk,
}
};
// Send any events output by the plugin during the process cycle
if let Some(events) = data.output_events.upgrade() {
let mut output_events = self.inner.output_events.borrow_mut();
while let Some(event) = output_events.pop_front() {
// We'll set the correct variant on this struct, or skip to the next loop
// iteration if we don't handle the event type
let mut vst3_event: Event = mem::zeroed();
vst3_event.bus_index = 0;
// There's also a ppqPos field, but uh how about no
vst3_event.sample_offset = clamp_output_event_timing(
event.timing() + block_start as u32,
total_buffer_len as u32,
) as i32;
// `voice_id.unwrap_or(|| ...)` triggers
// https://github.com/rust-lang/rust-clippy/issues/8522
#[allow(clippy::unnecessary_lazy_evaluations)]
match event {
NoteEvent::NoteOn {
timing: _,
voice_id,
channel,
note,
velocity,
} if P::MIDI_OUTPUT >= MidiConfig::Basic => {
vst3_event.type_ = EventTypes::kNoteOnEvent as u16;
vst3_event.event.note_on = NoteOnEvent {
channel: channel as i16,
pitch: note as i16,
tuning: 0.0,
velocity,
length: 0, // What?
// We'll use this for our note IDs, that way we don't have to do
// anything complicated here
note_id: voice_id
.unwrap_or_else(|| ((channel as i32) << 8) | note as i32),
};
}
NoteEvent::NoteOff {
timing: _,
voice_id,
channel,
note,
velocity,
} if P::MIDI_OUTPUT >= MidiConfig::Basic => {
vst3_event.type_ = EventTypes::kNoteOffEvent as u16;
vst3_event.event.note_off = NoteOffEvent {
channel: channel as i16,
pitch: note as i16,
velocity,
note_id: voice_id
.unwrap_or_else(|| ((channel as i32) << 8) | note as i32),
tuning: 0.0,
};
}
// VST3 does not support or need these events, but they should also not
// trigger a debug assertion failure in NIH-plug. Also notes how this is
// gated by `P::MIDI_INPUT`.
NoteEvent::VoiceTerminated { .. }
if P::MIDI_INPUT >= MidiConfig::Basic =>
{
continue;
}
NoteEvent::PolyPressure {
timing: _,
voice_id,
channel,
note,
pressure,
} if P::MIDI_OUTPUT >= MidiConfig::Basic => {
vst3_event.type_ = EventTypes::kPolyPressureEvent as u16;
vst3_event.event.poly_pressure = PolyPressureEvent {
channel: channel as i16,
pitch: note as i16,
note_id: voice_id
.unwrap_or_else(|| ((channel as i32) << 8) | note as i32),
pressure,
};
}
ref event @ (NoteEvent::PolyVolume {
voice_id,
channel,
note,
..
}
| NoteEvent::PolyPan {
voice_id,
channel,
note,
..
}
| NoteEvent::PolyTuning {
voice_id,
channel,
note,
..
}
| NoteEvent::PolyVibrato {
voice_id,
channel,
note,
..
}
| NoteEvent::PolyExpression {
voice_id,
channel,
note,
..
}
| NoteEvent::PolyBrightness {
voice_id,
channel,
note,
..
}) if P::MIDI_OUTPUT >= MidiConfig::Basic => {
match NoteExpressionController::translate_event_reverse(
voice_id
.unwrap_or_else(|| ((channel as i32) << 8) | note as i32),
event,
) {
Some(translated_event) => {
vst3_event.type_ =
EventTypes::kNoteExpressionValueEvent as u16;
vst3_event.event.note_expression_value = translated_event;
}
None => {
nih_debug_assert_failure!(
"Mishandled note expression value event"
);
}
}
}
NoteEvent::MidiChannelPressure {
timing: _,
channel,
pressure,
} if P::MIDI_OUTPUT >= MidiConfig::MidiCCs => {
vst3_event.type_ = EventTypes::kLegacyMIDICCOutEvent as u16;
vst3_event.event.legacy_midi_cc_out = LegacyMidiCCOutEvent {
control_number: 128, // kAfterTouch
channel: channel as i8,
value: (pressure * 127.0).round() as i8,
value2: 0,
};
}
NoteEvent::MidiPitchBend {
timing: _,
channel,
value,
} if P::MIDI_OUTPUT >= MidiConfig::MidiCCs => {
let scaled = (value * ((1 << 14) - 1) as f32).round() as i32;
vst3_event.type_ = EventTypes::kLegacyMIDICCOutEvent as u16;
vst3_event.event.legacy_midi_cc_out = LegacyMidiCCOutEvent {
control_number: 129, // kPitchBend
channel: channel as i8,
value: (scaled & 0b01111111) as i8,
value2: ((scaled >> 7) & 0b01111111) as i8,
};
}
NoteEvent::MidiCC {
timing: _,
channel,
cc,
value,
} if P::MIDI_OUTPUT >= MidiConfig::MidiCCs => {
vst3_event.type_ = EventTypes::kLegacyMIDICCOutEvent as u16;
vst3_event.event.legacy_midi_cc_out = LegacyMidiCCOutEvent {
control_number: cc,
channel: channel as i8,
value: (value * 127.0).round() as i8,
value2: 0,
};
}
NoteEvent::MidiProgramChange {
timing: _,
channel,
program,
} if P::MIDI_OUTPUT >= MidiConfig::MidiCCs => {
vst3_event.type_ = EventTypes::kLegacyMIDICCOutEvent as u16;
vst3_event.event.legacy_midi_cc_out = LegacyMidiCCOutEvent {
control_number: 130, // kCtrlProgramChange
channel: channel as i8,
value: program as i8,
value2: 0,
};
}
NoteEvent::MidiSysEx { timing: _, message }
if P::MIDI_OUTPUT >= MidiConfig::Basic =>
{
let (padded_sysex_buffer, length) = message.to_buffer();
let padded_sysex_buffer = padded_sysex_buffer.borrow();
nih_debug_assert!(padded_sysex_buffer.len() >= length);
let sysex_buffer = &padded_sysex_buffer[..length];
vst3_event.type_ = EventTypes::kDataEvent as u16;
vst3_event.event.data = DataEvent {
size: sysex_buffer.len() as u32,
type_: 0, // kMidiSysEx
bytes: sysex_buffer.as_ptr(),
};
// NOTE: We need to have this call here while `sysex_buffer` is
// still in scope since the event contains pointers to it
let result = events.add_event(&mut vst3_event);
nih_debug_assert_eq!(result, kResultOk);
continue;
}
_ => {
nih_debug_assert_failure!(
"Invalid output event for the current MIDI_OUTPUT setting"
);
continue;
}
};
let result = events.add_event(&mut vst3_event);
nih_debug_assert_eq!(result, kResultOk);
}
}
// If our block ends at the end of the buffer then that means there are no more
// unprocessed (parameter) events. If there are more events, we'll just keep going
// through this process until we've processed the entire buffer.
if block_end == total_buffer_len {
break result;
} else {
block_start = block_end;
}
};
// After processing audio, we'll check if the editor has sent us updated plugin state.
// We'll restore that here on the audio thread to prevent changing the values during the
// process call and also to prevent inconsistent state when the host also wants to load
// plugin state.
// FIXME: Zero capacity channels allocate on receiving, find a better alternative that
// doesn't do that
let updated_state = permit_alloc(|| self.inner.updated_state_receiver.try_recv());
if let Ok(mut state) = updated_state {
self.inner.set_state_inner(&mut state);
// We'll pass the state object back to the GUI thread so deallocation can happen
// there without potentially blocking the audio thread
if let Err(err) = self.inner.updated_state_sender.send(state) {
nih_debug_assert_failure!(
"Failed to send state object back to GUI thread: {}",
err
);
};
}
result
})
}
unsafe fn get_tail_samples(&self) -> u32 {
// https://github.com/steinbergmedia/vst3_pluginterfaces/blob/2ad397ade5b51007860bedb3b01b8afd2c5f6fba/vst/ivstaudioprocessor.h#L145-L159
match self.inner.last_process_status.load() {
ProcessStatus::Tail(samples) => samples,
ProcessStatus::KeepAlive => u32::MAX, // kInfiniteTail
_ => 0, // kNoTail
}
}
}
impl<P: Vst3Plugin> IMidiMapping for Wrapper<P> {
unsafe fn get_midi_controller_assignment(
&self,
bus_index: i32,
channel: i16,
midi_cc_number: vst3_com::vst::CtrlNumber,
param_id: *mut vst3_com::vst::ParamID,
) -> tresult {
if P::MIDI_INPUT < MidiConfig::MidiCCs
|| bus_index != 0
|| !(0..VST3_MIDI_CHANNELS as i16).contains(&channel)
|| !(0..VST3_MIDI_CCS as i16).contains(&midi_cc_number)
{
return kResultFalse;
}
check_null_ptr!(param_id);
// We reserve a contiguous parameter range right at the end of the allowed parameter indices
// for these MIDI CC parameters
*param_id =
VST3_MIDI_PARAMS_START + midi_cc_number as u32 + (channel as u32 * VST3_MIDI_CCS);
kResultOk
}
}
impl<P: Vst3Plugin> INoteExpressionController for Wrapper<P> {
unsafe fn get_note_expression_count(&self, bus_idx: i32, _channel: i16) -> i32 {
// Apparently you need to define the predefined note expressions. Thanks VST3.
if P::MIDI_INPUT >= MidiConfig::Basic && bus_idx == 0 {
note_expressions::KNOWN_NOTE_EXPRESSIONS.len() as i32
} else {
0
}
}
unsafe fn get_note_expression_info(
&self,
bus_idx: i32,
_channel: i16,
note_expression_idx: i32,
info: *mut NoteExpressionTypeInfo,
) -> tresult {
if P::MIDI_INPUT < MidiConfig::Basic
|| bus_idx != 0
|| !(0..note_expressions::KNOWN_NOTE_EXPRESSIONS.len() as i32)
.contains(¬e_expression_idx)
{
return kInvalidArgument;
}
check_null_ptr!(info);
*info = mem::zeroed();
let info = &mut *info;
let note_expression_info =
¬e_expressions::KNOWN_NOTE_EXPRESSIONS[note_expression_idx as usize];
info.type_id = note_expression_info.type_id;
u16strlcpy(&mut info.title, note_expression_info.title);
u16strlcpy(&mut info.short_title, note_expression_info.title);
u16strlcpy(&mut info.units, note_expression_info.unit);
info.unit_id = kNoParentUnitId;
// This should not be needed since they're predefined, but then again you'd think you also
// wouldn't need to define predefined note expressions now do you?
info.value_desc = NoteExpressionValueDescription {
default_value: 0.5,
min: 0.0,
max: 1.0,
step_count: 0,
};
info.id = kNoParamId;
info.flags = 1 << 2; // kIsAbsolute
kResultOk
}
unsafe fn get_note_expression_string_by_value(
&self,
_bus_idx: i32,
_channel: i16,
_id: u32,
_value: f64,
_string: *mut TChar,
) -> tresult {
kResultFalse
}
unsafe fn get_note_expression_value_by_string(
&self,
_bus_idx: i32,
_channel: i16,
_id: u32,
_string: *const TChar,
_value: *mut f64,
) -> tresult {
kResultFalse
}
}
impl<P: Vst3Plugin> IProcessContextRequirements for Wrapper<P> {
unsafe fn get_process_context_requirements(&self) -> u32 {
IProcessContextRequirementsFlags::kNeedProjectTimeMusic
| IProcessContextRequirementsFlags::kNeedBarPositionMusic
| IProcessContextRequirementsFlags::kNeedCycleMusic
| IProcessContextRequirementsFlags::kNeedTimeSignature
| IProcessContextRequirementsFlags::kNeedTempo
| IProcessContextRequirementsFlags::kNeedTransportState
}
}
impl<P: Vst3Plugin> IUnitInfo for Wrapper<P> {
unsafe fn get_unit_count(&self) -> i32 {
self.inner.param_units.len() as i32
}
unsafe fn get_unit_info(&self, unit_index: i32, info: *mut UnitInfo) -> tresult {
check_null_ptr!(info);
match self.inner.param_units.info(unit_index as usize) {
Some((unit_id, unit_info)) => {
*info = mem::zeroed();
let info = &mut *info;
info.id = unit_id;
info.parent_unit_id = unit_info.parent_id;
u16strlcpy(&mut info.name, &unit_info.name);
info.program_list_id = kNoProgramListId;
kResultOk
}
None => kInvalidArgument,
}
}
unsafe fn get_program_list_count(&self) -> i32 {
// TODO: Do we want program lists? Probably not, CLAP doesn't even support them.
0
}
unsafe fn get_program_list_info(
&self,
_list_index: i32,
_info: *mut ProgramListInfo,
) -> tresult {
kInvalidArgument
}
unsafe fn get_program_name(
&self,
_list_id: i32,
_program_index: i32,
_name: *mut u16,
) -> tresult {
kInvalidArgument
}
unsafe fn get_program_info(
&self,
_list_id: i32,
_program_index: i32,
_attribute_id: *const u8,
_attribute_value: *mut u16,
) -> tresult {
kInvalidArgument
}
unsafe fn has_program_pitch_names(&self, _id: i32, _index: i32) -> tresult {
// TODO: Support note names once someone requests it
kInvalidArgument
}
unsafe fn get_program_pitch_name(
&self,
_id: i32,
_index: i32,
_pitch: i16,
_name: *mut u16,
) -> tresult {
kInvalidArgument
}
unsafe fn get_selected_unit(&self) -> i32 {
// No! Steinberg! I don't want any of this! I just want to group parameters!
kRootUnitId
}
unsafe fn select_unit(&self, _id: i32) -> tresult {
kResultFalse
}
unsafe fn get_unit_by_bus(
&self,
_type_: i32,
_dir: i32,
_bus_index: i32,
_channel: i32,
_unit_id: *mut i32,
) -> tresult {
// Stahp it!
kResultFalse
}
unsafe fn set_unit_program_data(
&self,
_list_or_unit: i32,
_program_idx: i32,
_data: SharedVstPtr<dyn IBStream>,
) -> tresult {
kInvalidArgument
}
}