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 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Hydrogen v1.1 Manual</title><link rel="stylesheet" type="text/css" href="res/docbook.css"><script src="res/docbook.js" type="text/javascript"></script><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><meta name="description" content="Hydrogen is a software synthesizer which can be used alone, emulating a drum machine based on patterns, or via an external MIDI keyboard/sequencer software. Hydrogen runs on Linux, Mac OS X and Windows."><meta name="viewport" content="width=device-width,initial-scale=1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div lang="en" class="book"><div class="titlepage"><div><div><h1 class="title"><a name="Hydrogen-manual"></a>Hydrogen v1.1 Manual</h1></div><div><h2 class="subtitle">2021-03-04</h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Antonio</span> <span class="surname">Piraino</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Alessandro</span> <span class="surname">Cominu</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Thijs</span> <span class="surname">Van Severen</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Sebastian</span> <span class="surname">Moors</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Colin</span> <span class="surname">Evans</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Philipp</span> <span class="surname">Mller</span></h3></div></div></div><div><div class="abstract"><p class="title"><b>Abstract</b></p><p>Hydrogen is a software synthesizer which can be used alone,
emulating a drum machine based on patterns, or via an external <abbr class="abbrev">MIDI</abbr>
keyboard/sequencer software. Hydrogen runs on Linux, Mac OS X and Windows.</p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="part"><a href="#part.1">I. Introduction</a></span></dt><dd><dl><dt><span class="chapter"><a href="#chpt.download">1. Download</a></span></dt><dt><span class="chapter"><a href="#chpt.compilation">2. Build</a></span></dt><dt><span class="chapter"><a href="#chpt.keyboard_and_mouse">3. Keyboard and Mouse</a></span></dt></dl></dd><dt><span class="part"><a href="#part.using_hydrogen">II. Using Hydrogen</a></span></dt><dd><dl><dt><span class="chapter"><a href="#chpt.overview">4. Overview</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.overview.gui">4.1. Main User Interface</a></span></dt><dt><span class="sect1"><a href="#chpt.overview.drumkits">4.2. Drumkit Concept</a></span></dt><dt><span class="sect1"><a href="#chpt.overview.midi_mapping_and_virtual_keyboard">4.3. MIDI-mapping and Virtual Keyboard</a></span></dt><dt><span class="sect1"><a href="#chpt.overview.recording">4.4. Recording in Hydrogen</a></span></dt><dt><span class="sect1"><a href="#chpt.overview.session_management">4.5. Session Management</a></span></dt><dt><span class="sect1"><a href="#chpt.overview.cli">4.6. Command-line Options</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.preferences">5. Preferences</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.preferences.general_tab">5.1. General</a></span></dt><dt><span class="sect1"><a href="#chpt.preferences.audio_tab">5.2. Audio System</a></span></dt><dt><span class="sect1"><a href="#chpt.preferences.midi_tab">5.3. MIDI System</a></span></dt><dt><span class="sect1"><a href="#chpt.preferences.osc_tab">5.4. OSC</a></span></dt><dt><span class="sect1"><a href="#chpt.preferences.appearance_tab">5.5. Appearance</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.main_menu">6. Main Menu</a></span></dt><dd><dl><dt><span class="sect1"><a href="#sect.main_menu.projects">6.1. Project</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.undo">6.2. Undo</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.drumkits">6.3. Drumkits</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.instruments">6.4. Instruments</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.view">6.5. View</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.options">6.6. Options</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.debug">6.7. Debug</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.info">6.8. Info</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.main_toolbar">7. Main Toolbar</a></span></dt><dd><dl><dt><span class="sect1"><a href="#sect.main_toolbar.transport_control">7.1.
Transport Control
</a></span></dt><dt><span class="sect1"><a href="#sect.main_toolbar.tap_tempo_beat_counter">7.2. Tap Tempo and Beat Counter</a></span></dt><dt><span class="sect1"><a href="#sect.main_toolbar.bpm_control_and_metronome">7.3. BPM Control and Metronome</a></span></dt><dt><span class="sect1"><a href="#sect.main_toolbar.cpu_usage_midi_in">7.4. CPU Usage and MIDI in</a></span></dt><dt><span class="sect1"><a href="#sect.main_toolbar.jack_control">7.5. JACK Control</a></span></dt><dt><span class="sect1"><a href="#sect.main_toolbar.gui_state">7.6. GUI State</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.song_editor">8. Song Editor</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.song_editor.main_controls">8.1. Main Controls</a></span></dt><dt><span class="sect1"><a href="#chpt.song_editor.editor_modes">8.2. Song Editor modes</a></span></dt><dt><span class="sect1"><a href="#chpt.song_editor.sidebar">8.3. Sidebar</a></span></dt><dt><span class="sect1"><a href="#chpt.song_editor.timeline">8.4. Timeline</a></span></dt><dt><span class="sect1"><a href="#chpt.song_editor.tag">8.5. Tags</a></span></dt><dt><span class="sect1"><a href="#chpt.song_editor.playbackTrack">8.6. Playback Track</a></span></dt><dt><span class="sect1"><a href="#sect.song_editor.automation_path">8.7. Automation Path</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.pattern_editor">9. Pattern Editor</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.pattern_editor.general">9.1. General</a></span></dt><dt><span class="sect1"><a href="#chpt.pattern_editor.drumkit">9.2. Drum Pattern Editor</a></span></dt><dt><span class="sect1"><a href="#chpt.pattern_editor.note_properties">9.3. Note Properties Editor</a></span></dt><dt><span class="sect1"><a href="#chpt.pattern_editor.piano_mode">9.4. Piano Roll Editor</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.sound_library">10. Sound Library (Drumkit/Pattern/Song Manager)</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.sound_library.drumkits">10.1. Drumkits</a></span></dt><dt><span class="sect1"><a href="#sect.sl.songs">10.2. Songs</a></span></dt><dt><span class="sect1"><a href="#sect.sl.patterns">10.3. Patterns</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.instrument_editor">11. Instrument Editor</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.instrument_editor.general">11.1. General</a></span></dt><dt><span class="sect1"><a href="#chpt.instrument_editor.layers">11.2. Layers</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.sample_editor">12. Sample Editor</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.sample_editor.wave_display">12.1. Wave Display and Region Editing</a></span></dt><dt><span class="sect1"><a href="#chpt.sample_editor.pitch">12.2. Pitch Shifting</a></span></dt><dt><span class="sect1"><a href="#chpt.sample_editor.playback_and_envelope_editor">12.3. Playback and Envelope Editor</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.mixer">13. Mixer</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.mixer.channel_strips">13.1. Instrument Channel Strips</a></span></dt><dt><span class="sect1"><a href="#chpt.mixer.component_strips">13.2. Component Channel Strips</a></span></dt><dt><span class="sect1"><a href="#sect.fx_rack_LADSPA">13.3. FX Rack and LADSPA Plugins</a></span></dt><dt><span class="sect1"><a href="#chpt.mixer.master_fader_strip">13.4. Master Fader Strip</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.director">14. Director</a></span></dt><dt><span class="chapter"><a href="#chpt.playlist_editor">15. Playlist Editor</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.playlist_editor.main_window">15.1. Main Window</a></span></dt><dt><span class="sect1"><a href="#chpt.playlist_editor.menu">15.2. Menu</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.midi">16. MIDI API</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.midi.actions">16.1. MIDI Actions</a></span></dt><dt><span class="sect1"><a href="#chpt.midi.learnable">16.2. MIDI-learnable Widgets</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.osc">17. OSC API</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.osc.basics">17.1. Basics</a></span></dt><dt><span class="sect1"><a href="#chpt.osc.commands">17.2. Commands</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="#part.demos">III. Examples</a></span></dt><dd><dl><dt><span class="chapter"><a href="#chpt.create_song">18. A New Song</a></span></dt><dd><dl><dt><span class="sect1"><a href="#sect.song_vs_pattern">18.1. Song Mode and Pattern Mode</a></span></dt><dt><span class="sect1"><a href="#sect.create_pattern">18.2. A New Pattern</a></span></dt><dt><span class="sect1"><a href="#sect.create_sequence">18.3. A New Sequence</a></span></dt><dt><span class="sect1"><a href="#sect.create_song.adjust_mixer">18.4. Adjust from the Mixer</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.examples.drumkit">19. Create a New Drumkit</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.examples.drumkit.new_kit">19.1. Creating a New Drumkit</a></span></dt><dt><span class="sect1"><a href="#chpt.examples.drumkit.new_instrument">19.2. Creating a New Instrument</a></span></dt><dt><span class="sect1"><a href="#chpt.instrument_editor.tips">19.3. Tips on Editing Instruments</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="#appendix">IV. Appendix</a></span></dt><dd><dl><dt><span class="chapter"><a href="#chpt.file_types">20. Used File Types</a></span></dt><dt><span class="chapter"><a href="#chap.shortcuts">21. Shortcut Lists</a></span></dt><dt><span class="glossary"><a href="#glossary">Glossary</a></span></dt></dl></dd></dl></div><div class="list-of-figures"><p><b>List of Figures</b></p><dl><dt>4.1. <a href="#fig.UI_overview">The Main UI in Single Pane mode</a></dt><dt>4.2. <a href="#fig.tabbed_UI_overview">The Main UI in Tabbed mode</a></dt><dt>5.1. <a href="#fig.preferences.general_tab">The General Tab</a></dt><dt>5.2. <a href="#fig.preferences.audio_tab">The Audio System Tab</a></dt><dt>5.3. <a href="#fig.preferences.midi_tab">The MIDI System Tab</a></dt><dt>5.4. <a href="#fig.preferences.osc_tab">The OSC Tab</a></dt><dt>5.5. <a href="#fig.preferences.appearance_tab">The Appearance Tab</a></dt><dt>6.1. <a href="#fig.main_menu">The Main Menu</a></dt><dt>6.2. <a href="#fig.import_drumkit">Import Drumkit</a></dt><dt>6.3. <a href="#fig.preferences.audio_engine_tab">The Audio Engine View</a></dt><dt>7.1. <a href="#fig.main_toolbar">The Main Toolbar</a></dt><dt>8.1. <a href="#fig.song_editor">The Song Editor</a></dt><dt>8.2. <a href="#fig.song_editor.virtualPattern.selectedMenu">The Pattern Options menu</a></dt><dt>8.3. <a href="#fig.pattern_properties">The Dialog to Change the Pattern Properties</a></dt><dt>8.4. <a href="#fig.add_tag">Dialog Window for Adding Tags</a></dt><dt>8.5. <a href="#fig.automation_path">The Automation Path Widget</a></dt><dt>9.1. <a href="#fig.PatternEditor_DrumMode">Pattern Editor in Drum Mode</a></dt><dt>9.2. <a href="#fig.PatternEditorControls">Pattern Editor Controls</a></dt><dt>9.3. <a href="#fig.pattern_editor.sidebar">The Sidebar of the Pattern Editor</a></dt><dt>9.4. <a href="#fig.PatternEditor_drumkit">Pattern Editor in Drum Mode</a></dt><dt>9.5. <a href="#fig.note_properties_ruler">The Note Properties Ruler set to Velocity</a></dt><dt>9.6. <a href="#fig.NoteKey">The Note Properties Ruler showing the NoteKey Property</a></dt><dt>9.7. <a href="#fig.PatternEditor_PianoMode">Pattern Editor in Piano Mode</a></dt><dt>10.1. <a href="#fig.soundlibrary">The Soundlibrary</a></dt><dt>11.1. <a href="#instrumenteditor.general">The Instrument editor General view</a></dt><dt>11.2. <a href="#instrumenteditor.layers">The Instrument Editor Layers View</a></dt><dt>11.3. <a href="#fig.instrument_editor.layers.layers">The Layer Section of the Instrument Editor</a></dt><dt>12.1. <a href="#sample.editor">The Sample Editor</a></dt><dt>12.2. <a href="#fig.sample_editor.wave_display">The Wave Display Section of the Sample Editor</a></dt><dt>12.3. <a href="#fig.sample_editor.pitch_shift">The Pitch Shifting Section of the Playlist Editor</a></dt><dt>12.4. <a href="#fig.sample_editor.envelope">The Envelope Section of the Sample Editor</a></dt><dt>13.1. <a href="#fig.mixer">The Mixer</a></dt><dt>13.2. <a href="#fig.mixer.channel_strip">The Instrument Channel Strip in the Mixer</a></dt><dt>13.3. <a href="#fig.mixer.component_strip">The Component Channel Strip in the Mixer</a></dt><dt>13.4. <a href="#fig.mixer.fx_strip">The FX Rack in the Mixer</a></dt><dt>13.5. <a href="#fig.select_effect">Select an Effect</a></dt><dt>13.6. <a href="#fig.mixer.master_strip">The Master Fader Strip in the Mixer</a></dt><dt>14.1. <a href="#fig.director">The Director</a></dt><dt>15.1. <a href="#fig.playlist_editor">The Playlist Editor with Demo Songs loaded</a></dt><dt>16.1. <a href="#midi_actions">MIDI Actions are set in MIDI System tab of the Preferences Dialog</a></dt><dt>18.1. <a href="#fig.pattern_editor.2">The Pattern Editor</a></dt><dt>18.2. <a href="#fig.insert_patterns">Inserting Patterns in the Song Sequence</a></dt><dt>18.3. <a href="#fig.mixer.2">The Mixer</a></dt><dt>44. <a href="#matryoshkaPanning">Visualization of the Interaction of the Different Pan Parameters</a></dt></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>4.1. <a href="#chpt.pattern_editor.midi_mapping"><abbr class="abbrev">MIDI</abbr> Mapping</a></dt><dt>17.1. <a href="#idm3932">All <abbr class="abbrev">OSC</abbr> Messages</a></dt><dt>21.1. <a href="#sect.shortcut.table">Shortcut Table</a></dt></dl></div><div class="part"><div class="titlepage"><div><div><h1 class="title"><a name="part.1"></a>Part I. Introduction</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="chapter"><a href="#chpt.download">1. Download</a></span></dt><dt><span class="chapter"><a href="#chpt.compilation">2. Build</a></span></dt><dt><span class="chapter"><a href="#chpt.keyboard_and_mouse">3. Keyboard and Mouse</a></span></dt></dl></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.download"></a>Chapter 1. Download</h2></div></div></div><p>
You can download Hydrogen from
<a class="ulink" href="http://www.hydrogen-music.org" target="_top">http://www.hydrogen-music.org</a>.
On the <span class="emphasis"><em>Downloads</em></span> page you can find several binaries (installers) for MacOS and Windows.
</p><p>
Due to the variety of distributions we do not provide packages for Linux. If you do not find Hydrogen in the repository of your distribution, please ask the people behind it to include Hydrogen.
</p></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.compilation"></a>Chapter 2. Build</h2></div></div></div><p>
If you want to compile Hydrogen yourself, you can download the latest source files directly from our
<span class="command"><strong>git</strong></span> repository with
</p>
bla
blub
hermel
<pre class="screen">
<code class="prompt">$</code><span class="command"><strong> git clone git://github.com/hydrogen-music/hydrogen.git</strong></span>
</pre>
schni
<p>
A certain release can be fetched with
</p>
bla
blub
hermel
<pre class="screen">
<code class="prompt">$</code><span class="command"><strong> git checkout tags/1.0.0</strong></span>
</pre>
schni
<p>Compiling Hydrogen depends on the following libraries (among others):</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: opencircle; "><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Qt 5</strong></span>: at <a class="ulink" href="http://www.qt.io" target="_top">http://www.qt.io</a></p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>libsndfile</strong></span>: at <a class="ulink" href="http://www.mega-nerd.com/libsndfile/" target="_top">http://www.mega-nerd.com/libsndfile/</a></p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong><abbr class="abbrev">ALSA</abbr></strong></span>: (>= 1.x) at <a class="ulink" href="http://www.alsa-project.org" target="_top">http://www.alsa-project.org</a>
(only if you wish to use <abbr class="abbrev">ALSA</abbr> as audio driver)</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Jack Audio Connection Kit (>= 0.80)</strong></span>: at
<a class="ulink" href="http://jackaudio.org/" target="_top">http://jackaudio.org/</a>
(only if you wish to use <abbr class="abbrev">JACK</abbr> as audio driver)</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>PortAudio</strong></span>: at <a class="ulink" href="http://www.portaudio.com" target="_top">http://www.portaudio.com</a>
(only if you wish to use PortAudio as audio driver)</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>PulseAudio</strong></span>: at <a class="ulink" href="http://www.pulseaudio.org" target="_top">http://www.pulseaudio.org</a>
(only if you wish to use PulseAudio as audio driver)</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Flac</strong></span>: at <a class="ulink" href="http://flac.sf.net" target="_top">http://flac.sf.net</a> (only if you
wish to use Flac samples)</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>LADSPA</strong></span>: at <a class="ulink" href="http://www.ladspa.org" target="_top">http://www.ladspa.org</a> (only if you wish
to use <abbr class="abbrev">LADSPA</abbr> effects)</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>liblrdf</strong></span>: at <a class="ulink" href="http://sf.net/projects/lrdf" target="_top">http://sf.net/projects/lrdf</a> (only if you wish to use lrdf to categorise effects)</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong><abbr class="abbrev">LASH</abbr></strong></span>: at <a class="ulink" href="http://lash.nongnu.org" target="_top">http://lash.nongnu.org</a> (only if
you wish to use <abbr class="abbrev">LASH</abbr>)</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>liblo</strong></span>: at <a class="ulink" href="http://liblo.sourceforge.net/" target="_top">http://liblo.sourceforge.net/</a> for <a class="link" href="#chpt.osc" title="Chapter 17. OSC API"><abbr class="abbrev">OSC</abbr></a> and <a class="link" href="#chpt.overview.session_management.nsm" title="4.5.1. NSM"><abbr class="abbrev">NSM</abbr></a> support
</p></li></ul></div><p>Please install them with your distribution's package manager. If
you're running a Debian-based system, you can install the libraries
with:</p>
bla
blub
hermel
<pre class="screen"><code class="prompt">$</code> <span class="command"><strong>apt-get install qtbase5-dev qtbase5-dev-tools \
qttools5-dev qttools5-dev-tools libqt5xmlpatterns5-dev \
libarchive-dev libsndfile1-dev libasound2-dev liblo-dev \
libpulse-dev libcppunit-dev liblrdf-dev \
liblash-compat-dev librubberband-dev libjack-jackd2-dev</strong></span>
</pre>
schni
<p>Compiling with <span class="command"><strong>cmake</strong></span> can be done easily by using the <code class="filename">build.sh</code> script. Go to the directory where the <span class="command"><strong>git</strong></span> repository
was cloned and run the <code class="filename">build.sh</code> script without any arguments to display the help :</p>
bla
blub
hermel
<pre class="screen">
<code class="prompt">$</code> <span class="command"><strong>./build.sh</strong></span>
</pre>
schni
<p>The help is now displayed (and is self-explanatory) :
</p>
bla
blub
hermel
<pre class="screen">
<span class="command"><strong> r[m] => all built, temp and cache files</strong></span>
<span class="command"><strong> c[lean] => remove cache files</strong></span>
<span class="command"><strong> m[ake] => launch the build process</strong></span>
<span class="command"><strong> mm => launch the build process using ccache</strong></span>
<span class="command"><strong> mt => launch the build process with clang tidy checks enabled</strong></span>
<span class="command"><strong> d[oc] => build html documentation</strong></span>
<span class="command"><strong> g[raph] => draw a dependencies graph</strong></span>
<span class="command"><strong> h[elp] => show the build options</strong></span>
<span class="command"><strong> x|exec => execute hydrogen</strong></span>
<span class="command"><strong> t[ests] => execute tests</strong></span>
<span class="command"><strong> p[kg] => build source package</strong></span>
<span class="command"><strong> z => build using ccache and run from tree</strong></span>
</pre>
schni
<p>To build Hydrogen and execute the result, run the build script with the <em class="parameter"><code>m</code></em> option
</p>
bla
blub
hermel
<pre class="screen">
<code class="prompt">$</code> <span class="command"><strong>./build.sh m x</strong></span>
</pre>
schni
<p>and to install it permanently on your computer, change into the <code class="filename">build</code> folder and use the <span class="command"><strong>make</strong></span> command.
</p>
bla
blub
hermel
<pre class="screen">
<code class="prompt">$</code> <span class="command"><strong>cd build</strong></span>
<code class="prompt">$</code> <span class="command"><strong>sudo make install</strong></span>
</pre>
schni
<div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>For further details about the installation process please have a look the <code class="filename">INSTALL.txt</code> file (located in the top level directory once you downloaded the sources).</p></td></tr></table></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.keyboard_and_mouse"></a>Chapter 3. Keyboard and Mouse</h2></div></div></div><p>
The Hydrogen user interface is designed so that it can be
used entirely with the mouse, with the exception of text entry.
</p><p>
Most actions are performed with the left mouse button, and
implement what should be the most obvious behaviour for any
control. The right mouse button may sometimes perform an
alternate action, or bring up a context menu. Some common
controls also have alternate actions accessed by clicking
while holding a modifier key:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<span class="keycap"><strong>Ctrl</strong></span> + <span class="emphasis"><em>left click</em></span> : restore default value of knob or fader
</p></li><li class="listitem"><p>
<span class="keycap"><strong>Shift</strong></span> + <span class="emphasis"><em>left click</em></span> : bind <abbr class="abbrev">MIDI</abbr> event to <abbr class="abbrev">MIDI</abbr>-learnable widget (see <a class="xref" href="#chpt.midi.learnable" title="16.2. MIDI-learnable Widgets">Section 16.2</a>)
</p></li></ul></div><p>
Some controls will also respond to scroll wheel events for
convenience.
</p><p>
The keyboard can also be used for navigating and editing in
the <a class="link" href="#chpt.pattern_editor" title="Chapter 9. Pattern Editor">Pattern</a> and <a class="link" href="#chpt.song_editor" title="Chapter 8. Song Editor">Song Editors</a>, using a combination of
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<span class="bold"><strong><span class="keycap"><strong>↑</strong></span>|<span class="keycap"><strong>↓</strong></span>|<span class="keycap"><strong>←</strong></span>|<span class="keycap"><strong>→</strong></span></strong></span> : move the
keyboard input cursor's position, or adjust values under
the cursor.
</p></li><li class="listitem"><p>
<span class="bold"><strong><span class="keycap"><strong>Shift</strong></span> + <span class="keycap"><strong>↑</strong></span>|<span class="keycap"><strong>↓</strong></span>|<span class="keycap"><strong>←</strong></span>|<span class="keycap"><strong>→</strong></span></strong></span> :
can be used to make selections of notes or pattern
groups as if the mouse had been dragged over them.
</p></li><li class="listitem"><p>
<span class="bold"><strong><span class="keycap"><strong>Enter</strong></span> and <span class="keycap"><strong>Return</strong></span></strong></span> : generally
performs the same action as a mouse click, but can also
start or end a move (or copy) of items in the same way
a mouse drag would.
</p></li><li class="listitem"><p>
<span class="bold"><strong><span class="keycap"><strong>Tab</strong></span> and <span class="keycap"><strong>Shift</strong></span> + <span class="keycap"><strong>Tab</strong></span></strong></span> : move
between the Pattern, Song and Note Property Editor.
</p></li><li class="listitem"><p>
<span class="bold"><strong><span class="keycap"><strong>Delete</strong></span></strong></span> :
delete notes or patterns.
</p></li><li class="listitem"><p>
<span class="bold"><strong><span class="keycap"><strong>Esc</strong></span></strong></span> :
cancels an ongoing selection, move or copy.
</p></li></ul></div><p>
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The keyboard input cursor is hidden from view until one of
the above keys is pressed. This keeps the display clear and
uncluttered when using the mouse. You can alter this default behavior in the <a class="link" href="#chpt.preferences.general_tab" title="5.1. General">General tab</a> of the Preferences.
</p></td></tr></table></div><p>
Most other keys on the keyboard can be used to play
<a class="link" href="#def.sample" title="Sample">samples</a> and enter notes in the same way a <abbr class="abbrev">MIDI</abbr> keyboard can be.
</p></div></div><div class="part"><div class="titlepage"><div><div><h1 class="title"><a name="part.using_hydrogen"></a>Part II. Using Hydrogen</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="chapter"><a href="#chpt.overview">4. Overview</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.overview.gui">4.1. Main User Interface</a></span></dt><dt><span class="sect1"><a href="#chpt.overview.drumkits">4.2. Drumkit Concept</a></span></dt><dt><span class="sect1"><a href="#chpt.overview.midi_mapping_and_virtual_keyboard">4.3. MIDI-mapping and Virtual Keyboard</a></span></dt><dt><span class="sect1"><a href="#chpt.overview.recording">4.4. Recording in Hydrogen</a></span></dt><dt><span class="sect1"><a href="#chpt.overview.session_management">4.5. Session Management</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.overview.session_management.nsm">4.5.1. NSM</a></span></dt></dl></dd><dt><span class="sect1"><a href="#chpt.overview.cli">4.6. Command-line Options</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.preferences">5. Preferences</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.preferences.general_tab">5.1. General</a></span></dt><dt><span class="sect1"><a href="#chpt.preferences.audio_tab">5.2. Audio System</a></span></dt><dt><span class="sect1"><a href="#chpt.preferences.midi_tab">5.3. MIDI System</a></span></dt><dt><span class="sect1"><a href="#chpt.preferences.osc_tab">5.4. OSC</a></span></dt><dt><span class="sect1"><a href="#chpt.preferences.appearance_tab">5.5. Appearance</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.main_menu">6. Main Menu</a></span></dt><dd><dl><dt><span class="sect1"><a href="#sect.main_menu.projects">6.1. Project</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.undo">6.2. Undo</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.drumkits">6.3. Drumkits</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.instruments">6.4. Instruments</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.view">6.5. View</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.options">6.6. Options</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.debug">6.7. Debug</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.info">6.8. Info</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.main_toolbar">7. Main Toolbar</a></span></dt><dd><dl><dt><span class="sect1"><a href="#sect.main_toolbar.transport_control">7.1.
Transport Control
</a></span></dt><dt><span class="sect1"><a href="#sect.main_toolbar.tap_tempo_beat_counter">7.2. Tap Tempo and Beat Counter</a></span></dt><dd><dl><dt><span class="sect2"><a href="#sect.main_toolbar.tap_tempo_beat_counter.tap_tempo">7.2.1. Tap Tempo</a></span></dt><dt><span class="sect2"><a href="#sect.main_toolbar.tap_tempo_beat_counter.beat_counter">7.2.2. Beat Counter</a></span></dt></dl></dd><dt><span class="sect1"><a href="#sect.main_toolbar.bpm_control_and_metronome">7.3. BPM Control and Metronome</a></span></dt><dt><span class="sect1"><a href="#sect.main_toolbar.cpu_usage_midi_in">7.4. CPU Usage and MIDI in</a></span></dt><dt><span class="sect1"><a href="#sect.main_toolbar.jack_control">7.5. JACK Control</a></span></dt><dt><span class="sect1"><a href="#sect.main_toolbar.gui_state">7.6. GUI State</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.song_editor">8. Song Editor</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.song_editor.main_controls">8.1. Main Controls</a></span></dt><dt><span class="sect1"><a href="#chpt.song_editor.editor_modes">8.2. Song Editor modes</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.song_editor.editor_modes.select">8.2.1. Select Mode</a></span></dt><dt><span class="sect2"><a href="#chpt.song_editor.editor_modes.draw">8.2.2. Draw Mode</a></span></dt><dt><span class="sect2"><a href="#chpt.song_editor.editor_modes.song_mode">8.2.3. Song Mode</a></span></dt><dt><span class="sect2"><a href="#chpt.song_editor.editor_modes.pattern_mode">8.2.4. Pattern Mode</a></span></dt><dt><span class="sect2"><a href="#chpt.song_editor.editor_modes.stacked">8.2.5. Stacked Mode</a></span></dt></dl></dd><dt><span class="sect1"><a href="#chpt.song_editor.sidebar">8.3. Sidebar</a></span></dt><dt><span class="sect1"><a href="#chpt.song_editor.timeline">8.4. Timeline</a></span></dt><dt><span class="sect1"><a href="#chpt.song_editor.tag">8.5. Tags</a></span></dt><dt><span class="sect1"><a href="#chpt.song_editor.playbackTrack">8.6. Playback Track</a></span></dt><dt><span class="sect1"><a href="#sect.song_editor.automation_path">8.7. Automation Path</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.pattern_editor">9. Pattern Editor</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.pattern_editor.general">9.1. General</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.pattern_editor.controls">9.1.1. Controls</a></span></dt><dt><span class="sect2"><a href="#chpt.pattern_editor.sidebar">9.1.2. Sidebar</a></span></dt></dl></dd><dt><span class="sect1"><a href="#chpt.pattern_editor.drumkit">9.2. Drum Pattern Editor</a></span></dt><dt><span class="sect1"><a href="#chpt.pattern_editor.note_properties">9.3. Note Properties Editor</a></span></dt><dt><span class="sect1"><a href="#chpt.pattern_editor.piano_mode">9.4. Piano Roll Editor</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.sound_library">10. Sound Library (Drumkit/Pattern/Song Manager)</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.sound_library.drumkits">10.1. Drumkits</a></span></dt><dt><span class="sect1"><a href="#sect.sl.songs">10.2. Songs</a></span></dt><dt><span class="sect1"><a href="#sect.sl.patterns">10.3. Patterns</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.instrument_editor">11. Instrument Editor</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.instrument_editor.general">11.1. General</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.instrument_editor.envelope_parameters">11.1.1. Envelope Parameters</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.gain_and_mute_group">11.1.2. Gain and Mute Group</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.filter">11.1.3. Filter Parameters</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.pitch_shift_parameters">11.1.4. Pitch Shift Parameters</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.midi_out_settings">11.1.5. <abbr class="abbrev">MIDI</abbr> Out Settings</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.HH_pressure_group">11.1.6. Hi-Hat Pressure Group</a></span></dt></dl></dd><dt><span class="sect1"><a href="#chpt.instrument_editor.layers">11.2. Layers</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.instrument_editor.layers.components">11.2.1. Components</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.layers.layers">11.2.2. Layers</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.layers.sample_selection">11.2.3. Sample Selection</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.layers.controls">11.2.4. Controls</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#chpt.sample_editor">12. Sample Editor</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.sample_editor.wave_display">12.1. Wave Display and Region Editing</a></span></dt><dt><span class="sect1"><a href="#chpt.sample_editor.pitch">12.2. Pitch Shifting</a></span></dt><dt><span class="sect1"><a href="#chpt.sample_editor.playback_and_envelope_editor">12.3. Playback and Envelope Editor</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.mixer">13. Mixer</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.mixer.channel_strips">13.1. Instrument Channel Strips</a></span></dt><dt><span class="sect1"><a href="#chpt.mixer.component_strips">13.2. Component Channel Strips</a></span></dt><dt><span class="sect1"><a href="#sect.fx_rack_LADSPA">13.3. FX Rack and LADSPA Plugins</a></span></dt><dt><span class="sect1"><a href="#chpt.mixer.master_fader_strip">13.4. Master Fader Strip</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.mixer.master_fader_strip.humanization">13.4.1. Humanization</a></span></dt><dt><span class="sect2"><a href="#chpt.mixer.master_fader_strip.mixer_settings">13.4.2. Mixer Settings</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#chpt.director">14. Director</a></span></dt><dt><span class="chapter"><a href="#chpt.playlist_editor">15. Playlist Editor</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.playlist_editor.main_window">15.1. Main Window</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.playlist_editor.main_window.song_list">15.1.1. Song List</a></span></dt><dt><span class="sect2"><a href="#chpt.playlist_editor.main_window.controls">15.1.2. Controls</a></span></dt><dt><span class="sect2"><a href="#chpt.playlist_editor.main_window.scripts">15.1.3. Scripts</a></span></dt></dl></dd><dt><span class="sect1"><a href="#chpt.playlist_editor.menu">15.2. Menu</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.playlist_editor.menu.playlist">15.2.1. Playlist</a></span></dt><dt><span class="sect2"><a href="#chpt.playlist_editor.menu.scripts">15.2.2. Scripts</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#chpt.midi">16. MIDI API</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.midi.actions">16.1. MIDI Actions</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.midi.actions.events">16.1.1. Events</a></span></dt><dt><span class="sect2"><a href="#chpt.midi.actions.actions">16.1.2. Actions</a></span></dt></dl></dd><dt><span class="sect1"><a href="#chpt.midi.learnable">16.2. MIDI-learnable Widgets</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.osc">17. OSC API</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.osc.basics">17.1. Basics</a></span></dt><dt><span class="sect1"><a href="#chpt.osc.commands">17.2. Commands</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.osc.commands.syntax">17.2.1. Syntax</a></span></dt><dt><span class="sect2"><a href="#chpt.osc.commands.all_messages">17.2.2. All Commands</a></span></dt></dl></dd></dl></dd></dl></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.overview"></a>Chapter 4. Overview</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#chpt.overview.gui">4.1. Main User Interface</a></span></dt><dt><span class="sect1"><a href="#chpt.overview.drumkits">4.2. Drumkit Concept</a></span></dt><dt><span class="sect1"><a href="#chpt.overview.midi_mapping_and_virtual_keyboard">4.3. MIDI-mapping and Virtual Keyboard</a></span></dt><dt><span class="sect1"><a href="#chpt.overview.recording">4.4. Recording in Hydrogen</a></span></dt><dt><span class="sect1"><a href="#chpt.overview.session_management">4.5. Session Management</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.overview.session_management.nsm">4.5.1. NSM</a></span></dt></dl></dd><dt><span class="sect1"><a href="#chpt.overview.cli">4.6. Command-line Options</a></span></dt></dl></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.overview.gui"></a>4.1. Main User Interface</h2></div></div></div><div class="figure"><a name="fig.UI_overview"></a><p class="title"><b>Figure 4.1. The Main UI in Single Pane mode</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/GUI_Sections_0.9.5_v2.png" alt="The Main UI in Single Pane mode"></div></div></div><br class="figure-break"><p>The Main UI comes in 2 flavors : the (classic) Single Pane mode (ideal for
large- and medium size screens), and the Tabbed mode (optimized for netbook screen
sizes).
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
You can switch between these two modes in the <a class="link" href="#chpt.preferences.appearance_tab" title="5.5. Appearance">Appearance</a> tab of the Preferences.
</p></td></tr></table></div><p>
Below you can see the main UI split up in 5 parts: the <a class="link" href="#chpt.main_menu" title="Chapter 6. Main Menu">Main Menu</a>, <a class="link" href="#chpt.main_toolbar" title="Chapter 7. Main Toolbar">Main
Toolbar</a>, <a class="link" href="#chpt.song_editor" title="Chapter 8. Song Editor">Song Editor</a>, <a class="link" href="#chpt.pattern_editor" title="Chapter 9. Pattern Editor">Pattern Editor</a> and the <a class="link" href="#chpt.instrument_editor" title="Chapter 11. Instrument Editor">Instrument</a> and <a class="link" href="#chpt.sound_library" title="Chapter 10. Sound Library (Drumkit/Pattern/Song Manager)">Sound Library Editor</a>.
These sections will be explained in detail further down in this
manual.
</p><div class="figure"><a name="fig.tabbed_UI_overview"></a><p class="title"><b>Figure 4.2. The Main UI in Tabbed mode</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/MainUI_tabbed.png" alt="The Main UI in Tabbed mode"></div></div></div><br class="figure-break"></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.overview.drumkits"></a>4.2. Drumkit Concept</h2></div></div></div><p>Let's start with a little history on the concept of Drumkits within in Hydrogen. It began as a
dedicated drum machine but has evolved into a versatile <a class="link" href="#def.sample" title="Sample">sample</a>-based sound synthesizer/sequencer
that is capable of generating and manipulating all sorts of sounds. Hence the original
"Drumkit" terminology is slightly misleading. You can load any kind of sound into a
"Drumkit" and manipulate that sound just like playing a regular synthesizer. This is
also the main reason why the <a class="link" href="#chpt.pattern_editor.piano_mode" title="9.4. Piano Roll Editor">Piano Roll Editor</a> was introduced.
</p><p>
To sum it up, nowadays a Drumkit is a collection of a number
of instruments (snare, kick, sampled voice, bass sound ...), using one or more <a class="link" href="#def.component" title="Component">components</a> which each can consist of multiple
<a class="link" href="#def.layer" title="Layer">layered</a> samples.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
In case you are not familiar with the world of sound synthesis, you can check out the <a class="link" href="#glossary" title="Glossary">Glossary</a> for a number of useful definitions.
</p></td></tr></table></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.overview.midi_mapping_and_virtual_keyboard"></a>4.3. MIDI-mapping and Virtual Keyboard</h2></div></div></div><p>
Instead of playing back programmed patterns Hydrogen can also be used synthesize drum sounds for incoming <abbr class="abbrev">MIDI</abbr> or keyboard events.
</p><p>
Using the <span class="bold"><strong>Input mode</strong></span> in the <a class="link" href="#sect.main_menu.options" title="6.6. Options">Options</a> tab of the Main Menu you can choose between two different ways to emulate sound. <code class="option">Drumkit</code> maps different <abbr class="abbrev">MIDI</abbr> events and keyboard inputs to different instruments of the current drumkit while <code class="option">Instrument</code> maps them to pitch-shifted samples of the instrument currently selected in the <a class="link" href="#chpt.song_editor" title="Chapter 8. Song Editor">Song Editor</a>. You can think of these modes as input versions of both the <a class="link" href="#chpt.pattern_editor.drumkit" title="9.2. Drum Pattern Editor">Drumkit Editor</a> and the <a class="link" href="#chpt.pattern_editor.piano_mode" title="9.4. Piano Roll Editor">Piano Roll Editor</a>.
</p><p>
Which <span class="bold"><strong><abbr class="abbrev">MIDI</abbr> input</strong></span> maps to which instrument is depending of the <a class="link" href="#chpt.instrument_editor.midi_out_settings" title="11.1.5. MIDI Out Settings">Note</a> parameter in the Instrument Editor set for in each particular drumkit. An example for the <span class="emphasis"><em>GMRockKit</em></span> is shown in the <a class="link" href="#chpt.pattern_editor.midi_mapping" title="Table 4.1. MIDI Mapping">table</a> below.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
In order to process incoming <abbr class="abbrev">MIDI</abbr> messages, you have to enable the <span class="bold"><strong>Use output note as input</strong></span> option and set up the overall <abbr class="abbrev">MIDI</abbr> support in the <a class="link" href="#chpt.preferences.midi_tab" title="5.3. MIDI System"><abbr class="abbrev">MIDI</abbr> system</a> tab of the Preferences dialog first.
</p></td></tr></table></div><p>
Alternatively you can use the <span class="bold"><strong>Virtual keyboard</strong></span> provided in Hydrogen. It maps a number of keys of your computer keyboard to incoming note and allows you to use it as a traditional <abbr class="abbrev">MIDI</abbr> keyboard. The mapping is shown in the <a class="link" href="#chpt.pattern_editor.midi_mapping" title="Table 4.1. MIDI Mapping">table</a> as well as in <a class="link" href="#fig.letters_keyboard">figure</a> below.
</p><div class="table"><a name="chpt.pattern_editor.midi_mapping"></a><p class="title"><b>Table 4.1. <abbr class="abbrev">MIDI</abbr> Mapping</b></p><div class="table-contents"><table class="table" summary="MIDI Mapping" border="1"><colgroup><col><col><col><col><col></colgroup><thead><tr><th align="left">
Instr. Pos.
</th><th align="left">
<abbr class="abbrev">MIDI</abbr> Note
</th><th align="left">
PC Keyboard Key
</th><th align="left">
Hydrogen GMRockKit
</th><th align="left">
GM Standard
</th></tr></thead><tbody><tr><td align="left"></td><td align="left">35</td><td align="left"></td><td align="left"></td><td align="left">Bass Drum 2</td></tr><tr><td align="left">1</td><td align="left">36</td><td align="left">Z</td><td align="left">Kick</td><td align="left">Bass Drum 1</td></tr><tr><td align="left">2</td><td align="left">37</td><td align="left">S</td><td align="left">Stick</td><td align="left">Side Stick/Rimshot</td></tr><tr><td align="left">3</td><td align="left">38</td><td align="left">X</td><td align="left">Snare</td><td align="left">Snare Drum 1</td></tr><tr><td align="left">4</td><td align="left">39</td><td align="left">D</td><td align="left">Hand Clap</td><td align="left">Hand Clap</td></tr><tr><td align="left">5</td><td align="left">40</td><td align="left">C</td><td align="left">Snare Rimshot</td><td align="left">Snare Drum 2</td></tr><tr><td align="left">6</td><td align="left">41</td><td align="left">V</td><td align="left">Floor Tom</td><td align="left">Low Tom 2</td></tr><tr><td align="left">7</td><td align="left">42</td><td align="left">G</td><td align="left">Hat Closed</td><td align="left">Closed Hi-hat</td></tr><tr><td align="left">8</td><td align="left">43</td><td align="left">B</td><td align="left">Tom 2</td><td align="left">Low Tom 1</td></tr><tr><td align="left">9</td><td align="left">44</td><td align="left">H</td><td align="left">Hat Pedal</td><td align="left">Pedal Hi-hat</td></tr><tr><td align="left">10</td><td align="left">45</td><td align="left">N</td><td align="left">Tom 1</td><td align="left">Mid Tom 2</td></tr><tr><td align="left">11</td><td align="left">46</td><td align="left">J</td><td align="left">Hat Open</td><td align="left">Open Hi-hat</td></tr><tr><td align="left">12</td><td align="left">47</td><td align="left">M</td><td align="left">Cowbell</td><td align="left">Mid Tom 1</td></tr><tr><td align="left">13</td><td align="left">48</td><td align="left">Q</td><td align="left">Ride</td><td align="left">High Tom 2</td></tr><tr><td align="left">14</td><td align="left">49</td><td align="left">2</td><td align="left">Crash</td><td align="left">Crash Cymbal 1</td></tr><tr><td align="left">15</td><td align="left">50</td><td align="left">W</td><td align="left">Ride 2</td><td align="left">High Tom 1</td></tr><tr><td align="left">16</td><td align="left">51</td><td align="left">3</td><td align="left">Splash</td><td align="left">Ride Cymbal 1</td></tr><tr><td align="left">17</td><td align="left">52</td><td align="left">E</td><td align="left">Hat Semi-Open</td><td align="left">Chinese Cymbal</td></tr><tr><td align="left">18</td><td align="left">53</td><td align="left">R</td><td align="left">Bell</td><td align="left">Ride Bell</td></tr><tr><td align="left">19</td><td align="left">54</td><td align="left">5</td><td align="left"></td><td align="left">Tambourine</td></tr><tr><td align="left">20</td><td align="left">55</td><td align="left">T</td><td align="left"></td><td align="left">Splash Cymbal</td></tr><tr><td align="left">21</td><td align="left">56</td><td align="left">6</td><td align="left"></td><td align="left">Cowbell</td></tr><tr><td align="left">22</td><td align="left">57</td><td align="left">Y</td><td align="left"></td><td align="left">Crash Cymbal 2</td></tr><tr><td align="left">23</td><td align="left">58</td><td align="left">7</td><td align="left"></td><td align="left">Vibra Slap</td></tr><tr><td align="left">24</td><td align="left">59</td><td align="left">U</td><td align="left"></td><td align="left">Ride Cymbal 2</td></tr><tr><td align="left">25</td><td align="left">60</td><td align="left"></td><td align="left"></td><td align="left">High Bongo</td></tr><tr><td align="left">26</td><td align="left">61</td><td align="left"></td><td align="left"></td><td align="left">Low Bongo</td></tr><tr><td align="left">27</td><td align="left">62</td><td align="left"></td><td align="left"></td><td align="left">Mute High Conga</td></tr><tr><td align="left">28</td><td align="left">63</td><td align="left"></td><td align="left"></td><td align="left">Open High Conga</td></tr><tr><td align="left">29</td><td align="left">64</td><td align="left"></td><td align="left"></td><td align="left">Low Conga</td></tr><tr><td align="left">30</td><td align="left">65</td><td align="left"></td><td align="left"></td><td align="left">High Timbale</td></tr><tr><td align="left">31</td><td align="left">66</td><td align="left"></td><td align="left"></td><td align="left">Low Timbale</td></tr><tr><td align="left">32</td><td align="left">67</td><td align="left"></td><td align="left"></td><td align="left">High Agog</td></tr><tr><td align="left">33</td><td align="left">68</td><td align="left"></td><td align="left"></td><td align="left">Low Agog</td></tr><tr><td align="left">34</td><td align="left">69</td><td align="left"></td><td align="left"></td><td align="left">Cabasa</td></tr><tr><td align="left">35</td><td align="left">70</td><td align="left"></td><td align="left"></td><td align="left">Maracas</td></tr><tr><td align="left">36</td><td align="left">71</td><td align="left"></td><td align="left"></td><td align="left">Short Whistle</td></tr><tr><td align="left">37</td><td align="left">72</td><td align="left"></td><td align="left"></td><td align="left">Long Whistle</td></tr><tr><td align="left">38</td><td align="left">73</td><td align="left"></td><td align="left"></td><td align="left">Short Giro</td></tr><tr><td align="left">39</td><td align="left">74</td><td align="left"></td><td align="left"></td><td align="left">Long Giro</td></tr><tr><td align="left">40</td><td align="left">75</td><td align="left"></td><td align="left"></td><td align="left">Claves</td></tr><tr><td align="left">41</td><td align="left">76</td><td align="left"></td><td align="left"></td><td align="left">High Wood Block</td></tr><tr><td align="left">42</td><td align="left">77</td><td align="left"></td><td align="left"></td><td align="left">Low Wood Block</td></tr><tr><td align="left">43</td><td align="left">78</td><td align="left"></td><td align="left"></td><td align="left">Mute Cuca</td></tr><tr><td align="left">44</td><td align="left">79</td><td align="left"></td><td align="left"></td><td align="left">Open Cuca</td></tr><tr><td align="left">45</td><td align="left">80</td><td align="left"></td><td align="left"></td><td align="left">Mute Triangle</td></tr><tr><td align="left">46</td><td align="left">81</td><td align="left"></td><td align="left"></td><td align="left">Open Triangle</td></tr></tbody></table></div></div><br class="table-break"><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The names of the instruments depend on the
drumkit that is loaded. This table below refers to the GMRockKit that is shipped with Hydrogen and loaded by default.
</p></td></tr></table></div><p>When adjusting the mapping or creating your own custom drumkit try to follow the <span class="bold"><strong>General <abbr class="abbrev">MIDI</abbr> (GM)</strong></span> standard as accurately as possible. This will ensure that switching between
drumkits goes smoothly. You are of course free to place your instruments anywhere in your drumkit, and
sometimes it isn't even possible to follow the GM standard, but it makes life a lot easier if you do.</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Keep in mind that it is the <span class="emphasis"><em>position</em></span> of the instrument (within the loaded drumkit) that
is linked to a <abbr class="abbrev">MIDI</abbr>-note/keyboard-key and <span class="emphasis"><em>not the name</em></span> of the instrument.
</p></td></tr></table></div><p>For a better visualization you can also find the mapping notes to your PC's keyboard key in the figure below.</p><div class="informalfigure"><a name="fig.letters_keyboard"></a><div class="mediaobject"><img src="img/tastiera.png" alt="Picture illustrating the mapping of Hydrogen's virtual keyboard to the layout of the computers' keyboard."></div></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.overview.recording"></a>4.4. Recording in Hydrogen</h2></div></div></div><p>
In addition to manually program pattern using mouse and keyboard you can also record one or multiple pattern. You can do so using an external <abbr class="abbrev">MIDI</abbr> device, like an e-drum, or use the <a class="link" href="#chpt.overview.midi_mapping_and_virtual_keyboard" title="4.3. MIDI-mapping and Virtual Keyboard">virtual keyboard</a> provided by Hydrogen.
</p><p>
In order to start recording, first activate the record button
<span class="inlinemediaobject"><img src="img/Rec_button.png" alt="Grey record button with a red circle in its center."></span>
in the <a class="link" href="#sect.main_toolbar.transport_control" title="7.1. Transport Control">Main Toolbar</a> and afterwards press the
<span class="inlinemediaobject"><img src="img/btn_play_off.png" alt="Grey play and pause button containing two vertical black lines (left) and a black triangle (right) pointing to the right."></span>
button located right next to it (like in a classical tape recorder).
</p><p>
Using the playback mode of the <a class="link" href="#chpt.song_editor" title="Chapter 8. Song Editor">Song Editor</a> you can choose between the following two scenarios. When in <a class="link" href="#chpt.song_editor.editor_modes.pattern_mode" title="8.2.4. Pattern Mode">Pattern mode</a> all inserted notes will be added to pattern currently selected in the <a class="link" href="#chpt.song_editor.sidebar" title="8.3. Sidebar">Sidebar</a> of the Song Editor. When, on the other hand, in <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a> the input notes will be added to the active pattern (the one the playhead is located in and is currently used for playback). If several patterns are selected in a single row, the input notes will only be added to the pattern at the bottom.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The incoming notes will be added in a non-destructive way. This means when adding two notes at the same position, you will have two notes being played back at once (with double the volume of a single one).
</p></td></tr></table></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.overview.session_management"></a>4.5. Session Management</h2></div></div></div><p>
With Session Management you can easily restore complex sessions involving numerous applications including their particular state. Hydrogen does support some Session Management systems too.
</p><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>
All the supported Session Management protocols are Linux only. There is no (tested) support for MacOS and Windows yet.
</p></td></tr></table></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<span class="bold"><strong><abbr class="abbrev">NSM</abbr></strong></span>:
<a class="ulink" href="http://non.tuxfamily.org/nsm/API.html" target="_top">Non Session Manager (<abbr class="abbrev">NSM</abbr>)</a> is of 2021 the de facto standard in Session Management tools within the Linux audio community and Hydrogen does over full support and compliance to its API.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
We highly recommend using this protocol for Session Management.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong><abbr class="abbrev">LASH</abbr></strong></span>:
Hydrogen provides a basic support for <a class="ulink" href="http://lash.nongnu.org" target="_top">LASH Audio Session Handler (<abbr class="abbrev">LASH</abbr>)</a>. This covers recalling the song used within the session but, unlike the NSM support, no recalling of the <abbr class="abbrev">JACK</abbr> connections and no per-session preferences.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
You have to activate <abbr class="abbrev">LASH</abbr> support in the <a class="link" href="#fig.preferences.general_tab" title="Figure 5.1. The General Tab">General</a> tab of the Preference dialog in order to use it.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong><abbr class="abbrev">JACK</abbr> Session</strong></span>:
<a class="ulink" href="https://jackaudio.org" target="_top"><abbr class="abbrev">JACK</abbr> Session</a> has been marked <a class="ulink" href="https://jackaudio.org/news/2020/10/15/jack2-v1915-release-and-current-status.html" target="_top">deprecated</a> by the <abbr class="abbrev">JACK</abbr> project.
</p><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>
Hydrogen versions <= 1.1 still feature this Session Management protocol. But it will be removed in future releases.
</p></td></tr></table></div><p>
</p></li></ul></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.overview.session_management.nsm"></a>4.5.1. NSM</h3></div></div></div><p>
Hydrogen will be under session management if you start it via a <abbr class="abbrev">NSM</abbr> server application, like <span class="command"><strong>Non Session Manager</strong></span> or <span class="command"><strong>RaySession</strong></span>. You can easily check whether Hydrogen is aware of the session by checking out the <code class="option">Project</code> option of the <a class="link" href="#chpt.main_menu" title="Chapter 6. Main Menu">Main Menu</a> as some action will have changed in order to comply to the <abbr class="abbrev">NSM</abbr> API.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<span class="bold"><strong>Replace With New Song</strong></span>:
instead of <a class="link" href="#sect.main_menu.projects.new">New</a>. Replaces the song associated with the session by an empty one.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Import Into Session</strong></span>:
instead of <a class="link" href="#sect.main_menu.projects.open">Open</a>. Replaces the song associated with the session by a song of your choice.
</p><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>
In Hydrogen version 1.1 the import into a session is not yet fully supported. While the selected file will be loaded and you can work with it, Hydrogen won't recall it after closing and opening the session. You need to copy the corresponding <a class="link" href="#chpt.file_types.h2song">.h2song</a> file manually into the session folder to make your choice permanent.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Import Recent Info Session</strong></span>:
instead of <a class="link" href="#sect.main_menu.projects.open_recent">Open Recent</a>. Replaces the song associated with the session by one of the recently used songs.
</p><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>
In Hydrogen version 1.1 the import into a session is not yet fully supported. While the selected file will be loaded and you can work with it, Hydrogen won't recall it after closing and opening the session. You need to copy the corresponding <a class="link" href="#chpt.file_types.h2song">.h2song</a> file manually into the session folder to make your choice permanent.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Export From Session As</strong></span>:
instead of <a class="link" href="#sect.main_menu.projects.save_as">Save As</a>. Stores the song associated with the session at a location of your choice as <a class="link" href="#chpt.file_types.h2song">.h2song</a> file.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
In contrast to the <span class="emphasis"><em>Save As</em></span> command the underlying path of the current song will not be changed. All subsequent <span class="emphasis"><em>Save</em></span> actions will store the current state of the song to the file in the session folder and <span class="bold"><strong>not</strong></span> to the path of the exported file.
</p></td></tr></table></div><p>
</p></li></ul></div><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The <a class="link" href="#sect.main_menu.projects.open_demo">Open Demo</a> option will be missing.
</p></td></tr></table></div><p>
Both the song and the preferences associated with the session will be stored in a session folder called <code class="filename">Hydrogen.*</code>. In addition, the drumkit (and its samples) used with the song will linked into the session folder as well. If the link is replaced by a folder containing a valid drumkit, this one will be used over the system and user drumkits.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
This allows you to create fully self sufficient backup of your Hydrogen session using <span class="command"><strong>tar -chf</strong></span>. These can be even ported and used to systems which do not have the required drumkits installed.
</p></td></tr></table></div><p>
</p></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.overview.cli"></a>4.6. Command-line Options</h2></div></div></div><p>
After <a class="link" href="#chpt.download" title="Chapter 1. Download">installing</a> Hydrogen on your system you can invoke it from the command-line with a number of different options.
bla
blub
hermel
</p><pre class="screen">
<span class="command"><strong>-h, --help Displays this help.</strong></span>
<span class="command"><strong>-v, --version Displays version information.</strong></span>
<span class="command"><strong>-d, --driver <Audiodriver> Use the selected audio driver (jack, alsa, oss)</strong></span>
<span class="command"><strong>-i, --install <File> Install a drumkit (*.h2drumkit)</strong></span>
<span class="command"><strong>-n, --nosplash Hide splash screen</strong></span>
<span class="command"><strong>-p, --playlist <File> Load a playlist (*.h2playlist) at startup</strong></span>
<span class="command"><strong>-P, --data <Path> Use an alternate system data path</strong></span>
<span class="command"><strong>-s, --song <File> Load a song (*.h2song) at startup</strong></span>
<span class="command"><strong>-k, --kit <DrumkitName> Load a drumkit at startup</strong></span>
<span class="command"><strong>-V, --verbose <Level> Level, if present, may be None, Error, Warning, Info, Debug or 0xHHHH</strong></span>
</pre><p>
schni
</p></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.preferences"></a>Chapter 5. Preferences</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#chpt.preferences.general_tab">5.1. General</a></span></dt><dt><span class="sect1"><a href="#chpt.preferences.audio_tab">5.2. Audio System</a></span></dt><dt><span class="sect1"><a href="#chpt.preferences.midi_tab">5.3. MIDI System</a></span></dt><dt><span class="sect1"><a href="#chpt.preferences.osc_tab">5.4. OSC</a></span></dt><dt><span class="sect1"><a href="#chpt.preferences.appearance_tab">5.5. Appearance</a></span></dt></dl></div><p>Via this window most of the configurations and customization can be altered. The Preferences Dialog can be accessed via the <em class="parameter"><code>Options</code></em> element in the <a class="link" href="#chpt.main_menu" title="Chapter 6. Main Menu">Main Menu</a>.</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
All changes done in the Preferences Dialog - if not noted otherwise via a popup - will take effect when clicking the <span class="bold"><strong>Ok</strong></span> button at the bottom of the window.
</p></td></tr></table></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.preferences.general_tab"></a>5.1. General</h2></div></div></div><div class="figure"><a name="fig.preferences.general_tab"></a><p class="title"><b>Figure 5.1. The General Tab</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/PreferencesGeneral_V3.png" alt="The General Tab"></div></div></div><br class="figure-break"><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<span class="bold"><strong>Language</strong></span>:
chooses one of the translations Hydrogen is available in.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
For this setting to take effect you have to restart Hydrogen.
</p></td></tr></table></div><p>
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
If your mother tongue is not available or the corresponding translation is flawed or incomplete, you would have an accessible way to contribute to Hydrogen at hand. Please see the <a class="link" href="#sect.main_menu.info" title="6.8. Info">About</a> dialog in the Info option of the Main menu for information of how to contact the Hydrogen dev team.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Reopen last used song</strong></span>:
determines whether Hydrogen will open the last used song during startup or an empty song instead.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Reopen last used playlist</strong></span>:
determines whether the last used <a class="link" href="#chpt.playlist_editor" title="Chapter 15. Playlist Editor">Playlist</a> will be loaded during startup or none at all.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
This can come in handy when you are using Hydrogen live.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Use relative paths for playlist</strong></span>:
specifies whether the path names in the stored <a class="link" href="#chpt.file_types.h2playlist">.h2playlist</a> file will contain absolute paths or a path relative to the <code class="filename">playlist</code> folder in the Hydrogen data
directory (usually <code class="filename">$HOME/.hydrogen/data/</code>).
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
Using relative paths might be handy when using your playlist on different computers or user profiles.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Hide keyboard input cursor</strong></span>:
hides the keyboard cursor until you press a key on you keyboard (see <a class="xref" href="#chpt.keyboard_and_mouse" title="Chapter 3. Keyboard and Mouse">Chapter 3</a>). By enabling this feature you can switch to the look and feel of the interaction with the <a class="link" href="#chpt.pattern_editor" title="Chapter 9. Pattern Editor">Pattern Editor</a> and <a class="link" href="#chpt.song_editor" title="Chapter 8. Song Editor">Song Editor</a> prior to Hydrogen v1.1.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Use LASH</strong></span>:
enables <abbr class="abbrev">LASH</abbr> (<abbr class="abbrev">LASH</abbr> Audio Session Handler) support within Hydrogen. This allows you to recover a particular song associated with a session.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
You may consider using the more advanced <a class="link" href="#chpt.overview.session_management.nsm" title="4.5.1. NSM">NSM</a> support of Hydrogen which gives you many additional features, like restoring all <abbr class="abbrev">JACK</abbr> connections or creating a per-session configuration.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Beat counter drift compensation in 1/10 ms</strong></span>:
allows you to compensate for system latency. The provided number will be added to each consecutive triggering of the <a class="link" href="#sect.main_toolbar.tap_tempo_beat_counter.beat_counter" title="7.2.2. Beat Counter">Beat Counter</a>. The allowed range is from <code class="option">-200</code> to <code class="option">200</code>.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
This is quite handy if you are using different sound cards or external <abbr class="abbrev">MIDI</abbr> devices, like a keyboard or an e-drum, with mismatching clocks.
</p><p>
In order to find useful values for these, you will need to take some
time to play with it. Also, you may want different values depending on
the speed of your hardware, audio devices, drivers, etc. Using the
Beat Counter effectively requires practice.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Beat counter start offset in ms</strong></span>:
sets the time between the
Beat Counter's last input stroke and when the song starts playing. Its allowed range is from <code class="option">-500</code> to <code class="option">500</code>.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The Beat Counter has to be set to <span class="bold"><strong>Set <abbr class="abbrev">BPM</abbr> and play</strong></span> -
<span class="inlinemediaobject"><img src="img/btn_set_play_on.png" alt='Blue button containing a "P".'></span>
should be displayed in the bottom right corner - for this setting to take effect.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Maximum number of bars</strong></span>:
sets the maximum number of supported bars/patterns for a single song. Its allowed range is from <code class="option">1</code> to <code class="option">800</code>.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Maximum number of layers</strong></span>:
sets the maximum number of <a class="link" href="#def.layer" title="Layer">layers</a> for a single instrument. Its allowed range is from <code class="option">16</code> to <code class="option">8192</code>.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
For this setting to take effect you have to restart Hydrogen.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Path to the Rubberband command-line utility</strong></span>:
sets the absolute path to the <span class="command"><strong>rubberband</strong></span> command line interface (CLI) Hydrogen will use for stretching samples in the <a class="link" href="#chpt.sample_editor.pitch" title="12.2. Pitch Shifting">Sample Editor</a>.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This option is only available if your version of Hydrogen does <span class="emphasis"><em>not</em></span> already has Rubber Band support compiled into it. If it does and the option is hot shown, everything is already configured and you don't have to worry about Rubber Band at all.
</p></td></tr></table></div><p>
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
If you are using Ubuntu, you can install Rubber Band from the Software Center
via the package <code class="option">rubberband-cli</code>. For other Linux distros please check your package manager and for other platforms
please check <a class="ulink" href="http://breakfastquay.com/rubberband/" target="_top">the Rubber Band site
</a>.
</p></td></tr></table></div><p>
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
If Rubber Band is installed and configured correctly, you will see an extra button
<span class="inlinemediaobject"><img src="img/rubber_off.png" alt='Grey vertical button containing the characters "R", "U", and "B" in adjacent lines.'></span>
button in the <a class="link" href="#sect.main_toolbar.bpm_control_and_metronome" title="7.3. BPM Control and Metronome">Main Toolbar</a>. You can use this behavior to verify your configuration.
</p></td></tr></table></div><p>
</p></li></ul></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.preferences.audio_tab"></a>5.2. Audio System</h2></div></div></div><div class="figure"><a name="fig.preferences.audio_tab"></a><p class="title"><b>Figure 5.2. The Audio System Tab</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/PreferencesAudioSystem_V3.png" alt="The Audio System Tab"></div></div></div><br class="figure-break"><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<span class="bold"><strong>Audio System</strong></span>: let's you choose the audio driver used by Hydrogen to connect to your computer's sound card.
</p><p>
Available options:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"><p><code class="option">Auto</code>: Hydrogen will try a
number of different drivers in a predetermined order, choose the
first working one, and display the result.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
This option is recommended for beginners.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p><a name="sect.preferences.jack"></a><code class="option">JACK</code>: The <abbr class="abbrev">JACK</abbr> driver is a
professional audio server which permits very low lag and exchanges
with other audio software. The <abbr class="abbrev">JACK</abbr>
server will start automatically if not already running.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
We strongly recommend using
this driver to have the best out of Hydrogen.
</p></td></tr></table></div></li><li class="listitem"><p><code class="option">ALSA</code>: The widely adopted
Linux standard audio driver.</p></li><li class="listitem"><p><code class="option">OSS</code>: The <abbr class="abbrev">OSS</abbr> audio driver
uses <code class="filename">/dev/dsp</code> and it's based on the <abbr class="abbrev">OSS</abbr> interface which is supported
by the vast majority of sound cards available for Linux; this said,
the use of this audio driver blocks <code class="filename">/dev/dsp</code> until Hydrogen is
closed i.e. unusable by any other software. Use it as last
resort.
</p></li><li class="listitem"><p><code class="option">PortAudio</code>: An open-source
multi platform audio driver.</p></li><li class="listitem"><p><code class="option">CoreAudio</code>: A driver for MacOS.</p></li><li class="listitem"><p><code class="option">PulseAudio</code>: A driver for the cross platform
PulseAudio sound server.</p></li></ul></div></li><li class="listitem"><p>
<span class="bold"><strong>Device</strong></span>:
specifies the particular sound card the audio driver will use.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Buffer size</strong></span>:
specifies the size of the batch of time Hydrogen will process in one run. Supported values are from <code class="option">100</code> to <code class="option">5000</code>.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Sample rate</strong></span>:
specifies the number of data points the audio signal will contain within one second.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
If you are using the <abbr class="abbrev">JACK</abbr> audio driver, the sample rate can not be altered from within Hydrogen and the audio driver
configuration should happen before starting the <abbr class="abbrev">JACK</abbr> server.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p><a name="sect.preferences.jack.track_output"></a><span class="bold"><strong>Track output</strong></span>: determines which audio settings will be applied to the outgoing
audio of the per-instrument <abbr class="abbrev">JACK</abbr> output ports.</p><p><code class="option">Post-Fader</code>:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"><p>note <a class="link" href="#chpt.pattern_editor.note_properties.velocity">velocity</a> and <a class="link" href="#chpt.pattern_editor.note_properties.pan">pan</a></p></li><li class="listitem"><p><a class="link" href="#chpt.instrument_editor.layers.controls.layer_gain">layer gain</a></p></li><li class="listitem"><p>component <a class="link" href="#chpt.instrument_editor.layers.controls.component_volume">gain</a> and <a class="link" href="#chpt.mixer.component_strips.fader_and_lcd">volume</a></p></li><li class="listitem"><p>instrument <a class="link" href="#chpt.instrument_editor.gain_and_mute_group" title="11.1.2. Gain and Mute Group">gain</a>, <a class="link" href="#chpt.mixer.channel_strips.pan">pan</a>, and <a class="link" href="#chpt.mixer.channel_strips.fader_and_lcd">volume</a></p></li></ul></div><p><code class="option">Pre-Fader</code>:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"><p>note <a class="link" href="#chpt.pattern_editor.note_properties.velocity">velocity</a></p></li><li class="listitem"><p><a class="link" href="#chpt.instrument_editor.layers.controls.layer_gain">layer gain</a></p></li></ul></div><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This option is only available if the <abbr class="abbrev">JACK</abbr> audio driver was selected and it will only take effect if the <span class="bold"><strong>Connect to default <abbr class="abbrev">JACK</abbr> output ports</strong></span> option is checked.
</p></td></tr></table></div></li><li class="listitem"><p><a name="sect.preferences.jack.bbt"></a><span class="bold"><strong>BBT sync method</strong></span>: if
Hydrogen uses <abbr class="abbrev">JACK</abbr> transport in the presence of an external <abbr class="abbrev">JACK</abbr>
Timebase master (TBM), it will use the provided measure and
tempo information instead of the local one of either the <a class="link" href="#sect.main_toolbar.bpm_control_and_metronome" title="7.3. BPM Control and Metronome">song's
tempo</a> or the Tempo Markers
added to the <a class="link" href="#chpt.song_editor.timeline" title="8.4. Timeline">Timeline</a>. But due to
limitations in the current implementation, Hydrogen can not set
both measure and speed provided by <abbr class="abbrev">JACK</abbr> for arbitrary pattern
combinations. You have two options here. Either drop all measure
changes in the TBM and work with tempo changes only to support
arbitrary patterns (using option <code class="option">constant
measure</code>) or to keep the length of each pattern
consistent with the corresponding measure in the TBM and to use
both tempo and measure provided by <abbr class="abbrev">JACK</abbr> (option
<code class="option">matching bars</code>).</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This option is only available if the <abbr class="abbrev">JACK</abbr> audio driver was selected.
</p><p>
For this option to take effect the
<span class="inlinemediaobject"><img src="img/btn_jack_transport_off.png" alt='Grey button containing the text "J.TRANS".'></span>
button has to be activated and the
<span class="inlinemediaobject"><img src="img/btn_jack_master_off.png" alt='Grey button containing the text "J.MASTER".'></span>
button deactivated in the <a class="link" href="#sect.main_toolbar.jack_control" title="7.5. JACK Control">Main Toolbar</a> (next to
having a <abbr class="abbrev">JACK</abbr> TBM application).</p></td></tr></table></div><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
Hydrogen can be registered as <abbr class="abbrev">JACK</abbr> Timebase Master via the <a class="link" href="#sect.main_toolbar.jack_control" title="7.5. JACK Control">Main Toolbar</a>.
</p></td></tr></table></div></li><li class="listitem"><p><span class="bold"><strong>Connect to default <abbr class="abbrev">JACK</abbr> output
ports</strong></span>: connects the main stereo <abbr class="abbrev">JACK</abbr> output ports of the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master Fader Strip</a> to
the default <abbr class="abbrev">JACK</abbr> input ports of your system
(<span class="emphasis"><em>system:playback_1</em></span> and
<span class="emphasis"><em>system:playback_2</em></span>). This will be done every time Hydrogen
starts up or the <abbr class="abbrev">JACK</abbr> audio driver is restarted.</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This option is only available if the <abbr class="abbrev">JACK</abbr> audio driver was selected.
</p></td></tr></table></div></li><li class="listitem"><p><a name="sect.preferences.jack.per_instrument_outs"></a><span class="bold"><strong>Create per-instrument
<abbr class="abbrev">JACK</abbr> output ports</strong></span>: in addition to the main stereo output
Hydrogen will register <abbr class="abbrev">JACK</abbr> output ports for every single
instrument.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
This can be useful if you want to add effects to a
single instrument with jack-rack for example.
</p></td></tr></table></div><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This option is only available if the <abbr class="abbrev">JACK</abbr> audio driver was selected.
</p></td></tr></table></div><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>
There are no <abbr class="abbrev">JACK</abbr> output ports for the <a class="link" href="#sect.main_toolbar.bpm_control_and_metronome" title="7.3. BPM Control and Metronome">Metronome</a> and the <a class="link" href="#chpt.song_editor.playbackTrack" title="8.6. Playback Track">Playback Track</a>. Their audio is only available via the main stereo output ports of Hydrogen.
</p></td></tr></table></div></li><li class="listitem"><p>
<span class="bold"><strong>Enable <abbr class="abbrev">JACK</abbr> timebase master support</strong></span>:
whether Hydrogen will respond to or ignore the incoming BBT (tempo and measure) information sent by the <abbr class="abbrev">JACK</abbr> server.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
Some <abbr class="abbrev">JACK</abbr> clients are not well written or have fallen into despair. As a result Hydrogen could receive nuisance signals messing up its playback. If you encounter weird jumps in the transport position and/or Hydrogen is out of sync after relocating the transport position, you might try to uncheck this option.
</p></td></tr></table></div><p>
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This option is only available if the <abbr class="abbrev">JACK</abbr> audio driver was selected.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Apply and restart output</strong></span>:
restarts the audio driver and makes all settings specified above take effect without closing and reopening the entire Preferences dialog.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Polyphony</strong></span>:
specifies the maximum number of notes played simultaneously. Supported values are from <code class="option">1</code> to <code class="option">512</code>.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
Depending on your CPU Hydrogen might be overrunning your audio driver due to this parameter.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Metronome volume</strong></span>:
sets the volume of the <a class="link" href="#sect.main_toolbar.bpm_control_and_metronome" title="7.3. BPM Control and Metronome">Metronome</a>. Supported values are from <code class="option">1</code> to <code class="option">100</code>.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Interpolate resampling</strong></span>:
specifies the type of resampling applied if a <a class="link" href="#def.sample" title="Sample">sample</a> does not use the same Sample Rate as Hydrogen.
</p></li></ul></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.preferences.midi_tab"></a>5.3. MIDI System</h2></div></div></div><div class="figure"><a name="fig.preferences.midi_tab"></a><p class="title"><b>Figure 5.3. The MIDI System Tab</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/MidiSystem_V2.png" alt="The MIDI System Tab"></div></div></div><br class="figure-break"><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<span class="bold"><strong><abbr class="abbrev">MIDI</abbr> driver</strong></span>:
selects the <abbr class="abbrev">MIDI</abbr> driver Hydrogen will use to send <abbr class="abbrev">MIDI</abbr> messages.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Input</strong></span>:
selects the device Hydrogen will expect <abbr class="abbrev">MIDI</abbr> messages to receive from.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Output</strong></span>:
selects the device Hydrogen will send <abbr class="abbrev">MIDI</abbr> messages to.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Channel</strong></span>:
specifies whether Hydrogen should listen to <abbr class="abbrev">MIDI</abbr> messages on one particular of the 16 available channels or on all of them.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Ignore note-off</strong></span>:
specifies whether Hydrogen will respond to the <span class="emphasis"><em>note-off</em></span> <abbr class="abbrev">MIDI</abbr> message.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This makes better use of the drumkit samples used in Hydrogen when working with certain external <abbr class="abbrev">MIDI</abbr> devices. But it may also discard <span class="emphasis"><em>Cymbal choke</em></span> messages in some e-drums.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Enable <abbr class="abbrev">MIDI</abbr> feedback</strong></span>:
specifies whether Hydrogen will send a message about updated values every time a certain parameter is changed. These parameters are
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"><p>
the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master Fader Strip</a> volume and mute state
</p></li><li class="listitem"><p>
an Instrument Strip <a class="link" href="#chpt.mixer.channel_strips.pan">pan</a>, <a class="link" href="#chpt.mixer.channel_strips.fader_and_lcd">volume</a>, <a class="link" href="#chpt.mixer.channel_strips.mute">mute</a> and <a class="link" href="#chpt.mixer.channel_strips.solo">solo</a> state
</p></li><li class="listitem"><p>
whether the <a class="link" href="#sect.main_toolbar.bpm_control_and_metronome" title="7.3. BPM Control and Metronome">Metronome</a> is activated
</p></li></ul></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Discard <abbr class="abbrev">MIDI</abbr> messages after action has been triggered</strong></span>:
specifies whether a <abbr class="abbrev">MIDI</abbr> note - after performing the <abbr class="abbrev">MIDI</abbr> action associated with it - should be played back or be discard.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Use output note as input note</strong></span>:
specifies whether the output <abbr class="abbrev">MIDI</abbr> note of an instrument specified in the <a class="link" href="#chpt.instrument_editor.midi_out_settings" title="11.1.5. MIDI Out Settings"><abbr class="abbrev">MIDI</abbr> Out Settings</a> of the Instrument Editor should be used to map the input as well.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
If this option is unchecked, only the currently selected instrument will used to play back the received <abbr class="abbrev">MIDI</abbr> notes.
</p></td></tr></table></div><p>
</p></li></ul></div><p>
Using the table in the lower part of the tab you can associate <a class="link" href="#chpt.midi.actions" title="16.1. MIDI Actions"><abbr class="abbrev">MIDI</abbr> actions</a> provided by Hydrogen with incoming <abbr class="abbrev">MIDI</abbr> messages. How this is done will be explained in the <a class="xref" href="#chpt.midi.actions" title="16.1. MIDI Actions">Section 16.1</a>.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.preferences.osc_tab"></a>5.4. OSC</h2></div></div></div><div class="figure"><a name="fig.preferences.osc_tab"></a><p class="title"><b>Figure 5.4. The OSC Tab</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/PreferencesOSC.png" alt="The OSC Tab"></div></div></div><br class="figure-break"><p>The <abbr class="abbrev">OSC</abbr> tab (<a class="xref" href="#fig.preferences.osc_tab" title="Figure 5.4. The OSC Tab">Figure 5.4</a>) let's
you modify all options associated with <abbr class="abbrev">OSC</abbr> (Open Sound Control) (see
chapter <a class="link" href="#chpt.osc" title="Chapter 17. OSC API">OSC API</a> for details).
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
In order to see and access the <span class="bold"><strong>Enable OSC feedback</strong></span> and <span class="bold"><strong>Import port</strong></span> option, <span class="bold"><strong>Enable OSC support</strong></span> has to be checked first.
</p></td></tr></table></div><p>
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="bold"><strong>Enable OSC support</strong></span>: Allows
Hydrogen to receive <abbr class="abbrev">OSC</abbr> commands send by external programs.</p></li><li class="listitem"><p><span class="bold"><strong>Enable OSC feedback</strong></span>: Hydrogen
will broadcast <abbr class="abbrev">OSC</abbr> messages to all registered clients each time does
change. A client can register to receive <abbr class="abbrev">OSC</abbr> messages by sending
a message to Hydrogen previously. The <span class="bold"><strong>state broadcast as feedback</strong></span> is
composed of the following <abbr class="abbrev">OSC</abbr> paths:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"><p><a class="link" href="#chpt.osc.command.master_volume_absolute">/Hydrogen/<span class="bold"><strong>MASTER_VOLUME_ABSOLUTE</strong></span></a></p></li><li class="listitem"><p><a class="link" href="#chpt.osc.command.toggle_metronome">/Hydrogen/<span class="bold"><strong>TOGGLE_METRONOME</strong></span></a></p></li><li class="listitem"><p><a class="link" href="#chpt.osc.command.mute_toggle">/Hydrogen/<span class="bold"><strong>MUTE_TOGGLE</strong></span></a></p></li><li class="listitem"><p><a class="link" href="#chpt.osc.command.strip_volume_absolute">/Hydrogen/<span class="bold"><strong>STRIP_VOLUME_ABSOLUTE/X</strong></span></a></p></li><li class="listitem"><p><a class="link" href="#chpt.osc.command.strip_volume_relative">/Hydrogen/<span class="bold"><strong>STRIP_VOLUME_RELATIVE/X</strong></span></a></p></li><li class="listitem"><p><a class="link" href="#chpt.osc.command.pan_absolute">/Hydrogen/<span class="bold"><strong>PAN_ABSOLUTE/X</strong></span></a></p></li><li class="listitem"><p><a class="link" href="#chpt.osc.command.strip_mute_toggle">/Hydrogen/<span class="bold"><strong>STRIP_MUTE_TOGGLE/X</strong></span></a></p></li><li class="listitem"><p><a class="link" href="#chpt.osc.command.strip_solo_toggle">/Hydrogen/<span class="bold"><strong>STRIP_SOLO_TOGGLE/X</strong></span></a></p></li></ul></div><p>
</p></li><li class="listitem"><p><span class="bold"><strong>Incoming port</strong></span>: Specifies the
<abbr class="abbrev">OSC</abbr> port Hydrogen will be register to. Values up to <code class="option">20000</code> are supported.</p></li></ul></div><p>
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>If the chosen <abbr class="abbrev">OSC</abbr> port is already occupied, Hydrogen will pick
an alternative one on startup and displays it via a popup as well as
in the <abbr class="abbrev">OSC</abbr> tab of the Preferences.
</p></td></tr></table></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.preferences.appearance_tab"></a>5.5. Appearance</h2></div></div></div><div class="figure"><a name="fig.preferences.appearance_tab"></a><p class="title"><b>Figure 5.5. The Appearance Tab</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/PreferencesAppearance_V2.png" alt="The Appearance Tab"></div></div></div><br class="figure-break"><p>The Appearance tab let's you modify Hydrogen's look
and feel.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<span class="bold"><strong>Application font</strong></span>:
specifies both the font family and point size of the application font used for the grid in <a class="link" href="#chpt.pattern_editor" title="Chapter 9. Pattern Editor">Pattern Editor</a> and <a class="link" href="#chpt.song_editor" title="Chapter 8. Song Editor">Song Editor</a> as well as for the pattern names in the <a class="link" href="#chpt.song_editor.sidebar" title="8.3. Sidebar">Sidebar</a> of the Song Editor.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
In order for this setting to take effect, Hydrogen has to be restarted.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Style</strong></span>:
specifies a certain look of GUI elements like menus, scrollbars, and dialog windows.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
Using this option you might can make Hydrogen integrate with you operating system better.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Mixer font</strong></span>:
specifies both the font family and point size of the mixer font used for the instrument names in the <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strips</a> and the component names in the <a class="link" href="#chpt.mixer.component_strips" title="13.2. Component Channel Strips">Component Channel Strips</a>.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
In order for this setting to take effect, Hydrogen has to be restarted.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Meters falloff speed</strong></span>:
specifies for how fast the update of the maximum value of the audio signal will be shown in the LCD displays of the <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strips</a>, <a class="link" href="#chpt.mixer.component_strips" title="13.2. Component Channel Strips">Component Channel Strips</a>, and the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master Fader Strip</a> before its replacement with a more recent value will take place.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Default interface layout</strong></span>:
specifies whether the GUI of Hydrogen will be arranged in Single Pane mode or Tabbed mode (see <a class="link" href="#chpt.overview.gui" title="4.1. Main User Interface">Main User Interface</a> for details).
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
In order for this setting to take effect, Hydrogen has to be restarted.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>High-resolution display scaling</strong></span>:
specifies whether the underlying bitmap graphics of the GUI should be scaled to larger sizes by Qt in order for Hydrogen to look nice with your system's resolution settings.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Coloring method for Song Editor elements</strong></span>:
determines the coloring of the boxes indicating the presence of a pattern in the <a class="link" href="#chpt.song_editor" title="Chapter 8. Song Editor">Song editor</a>. The available options are:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"><p>
<code class="option">Automatic</code>:
Uses as much colors as there are patterns in the song.
</p></li><li class="listitem"><p>
<code class="option">Steps</code>:
Uses a certain number <em class="parameter"><code>n</code></em> of colors you have to enter via a second input widget. After coloring the first <em class="parameter"><code>n</code></em> patterns with different colors the same set of colors will be used for the next <em class="parameter"><code>n</code></em> patterns and so on.
</p></li><li class="listitem"><p>
<code class="option">Fixed</code>:
Colors all patterns using a single color determined via its hue in a separate input widget.
</p></li></ul></div><p>
</p></li></ul></div></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.main_menu"></a>Chapter 6. Main Menu</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#sect.main_menu.projects">6.1. Project</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.undo">6.2. Undo</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.drumkits">6.3. Drumkits</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.instruments">6.4. Instruments</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.view">6.5. View</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.options">6.6. Options</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.debug">6.7. Debug</a></span></dt><dt><span class="sect1"><a href="#sect.main_menu.info">6.8. Info</a></span></dt></dl></div><div class="figure"><a name="fig.main_menu"></a><p class="title"><b>Figure 6.1. The Main Menu</b></p><div class="figure-contents"><div class="mediaobject"><img src="img/MainMenu.png" alt="The Main Menu"></div></div></div><br class="figure-break"><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.main_menu.projects"></a>6.1. Project</h2></div></div></div><p>This menu offers file
related functions.</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
If you are using Hydrogen within a <abbr class="abbrev">NSM</abbr> session, some of the options below will be called and behave differently (see <a class="xref" href="#chpt.overview.session_management.nsm" title="4.5.1. NSM">Section 4.5.1</a> for details).
</p></td></tr></table></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a name="sect.main_menu.projects.new"></a><span class="bold"><strong>New</strong></span>: creates a new and empty song.</p></li><li class="listitem"><p><span class="bold"><strong>Show Info</strong></span>: sets general properties of the
song such as name, author, license, and generic notes.</p></li><li class="listitem"><p><a name="sect.main_menu.projects.open"></a><span class="bold"><strong>Open</strong></span>: opens an existing song (a <a class="link" href="#chpt.file_types.h2song">.h2song</a> file).</p></li><li class="listitem"><p><a name="sect.main_menu.projects.open_demo"></a><span class="bold"><strong>Open Demo</strong></span>: opens one of the demo song shipped with Hydrogen.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The demo songs are stored in <code class="filename">$INSTALL_PATH/share/hydrogen/data/demo_songs</code>).
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p><a name="sect.main_menu.projects.open_recent"></a><span class="bold"><strong>Open recent</strong></span>: opens a menu showing the last used songs (ordered from most recent to least recent).</p></li><li class="listitem"><p><span class="bold"><strong>Save</strong></span>: saves changes to current song.</p></li><li class="listitem"><p><a name="sect.main_menu.projects.save_as"></a><span class="bold"><strong>Save as</strong></span>: saves current song as <a class="link" href="#chpt.file_types.h2song">.h2song</a> file to a path of your choice.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
In order for Hydrogen to automatically list it in the <a class="link" href="#sect.sl.songs" title="10.2. Songs">Songs section of the Sound Library</a>, you have to store it in
<code class="filename">$HOME/.hydrogen/data/songs/</code>.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p><span class="bold"><strong>Open pattern</strong></span>: opens a pattern (a <a class="link" href="#chpt.file_types.h2pattern">.h2pattern</a> file)
belonging to the current drumkit.</p></li><li class="listitem"><p><a name="sect.main_menu.projects.export_pattern_as"></a><span class="bold"><strong>Export Pattern As</strong></span>: saves a
pattern as a <a class="link" href="#chpt.file_types.h2pattern">.h2pattern</a> file.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
In order for Hydrogen to automatically list it in the <a class="link" href="#sect.sl.patterns" title="10.3. Patterns">Patterns section of the Sound Library</a>, you have to store it in
<code class="filename">$HOME/.hydrogen/data/patterns/drumkit_name/</code>.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p><span class="bold"><strong>Export MIDI file</strong></span>: exports the current song in
<abbr class="abbrev">MIDI</abbr> format.</p></li><li class="listitem"><p><a name="sect.main_form.export_song"></a><span class="bold"><strong>Export song</strong></span>: exports the current song into an audio file.</p><p>The <span class="bold"><strong>Export mode</strong></span> option <code class="option">Export to a single track</code> will export one stereo downmix of your song - the master output. <code class="option">Export to separate tracks</code> will create files for each
instrument/track. <code class="option">Both</code> will create a stereo downmix + audio files for all individual
instruments.
</p></li><li class="listitem"><p><span class="bold"><strong>Export Lilypond file</strong></span>: exports the current song to LilyPond.</p><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>
It has the following limitations: Only the <span class="emphasis"><em>GMRockKit</em></span> and no triplets are supported.</p></td></tr></table></div></li><li class="listitem"><p><span class="bold"><strong>Quit</strong></span>: exists Hydrogen.</p></li></ul></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.main_menu.undo"></a>6.2. Undo</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="bold"><strong>Undo</strong></span>: lets you undo your last action.</p></li><li class="listitem"><p><span class="bold"><strong>Redo</strong></span>: lets you redo the last undone action.</p></li><li class="listitem"><p><span class="bold"><strong>Undo History</strong></span>: gives you an overview of your previous
actions.</p></li></ul></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.main_menu.drumkits"></a>6.3. Drumkits</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a name="sect.main_menu.drumkits.new"></a><span class="bold"><strong>New</strong></span>: creates a new and empty <a class="link" href="#chpt.overview.drumkits" title="4.2. Drumkit Concept">drumkit</a> by clearing all the instruments of the current one.
</p></li><li class="listitem"><p><a name="sect.main_menu.drumkits.open"></a>
<span class="bold"><strong>Open</strong></span>:
opens one of the registered drumkits and replaces the currently loaded one.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Via this option you can only load drumkits that have been already imported into Hydrogen. If you just received a new one from an external source, be sure to use the <a class="link" href="#sect.main_form.import_drumkit">Import</a> option described below.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Properties</strong></span>:
sets general properties of the drumkit such as its name, author, license, general information, image, and image license.
</p></li><li class="listitem"><p><span class="bold"><strong>Save</strong></span>: saves all settings of the current drumkit (including those of their instruments and sound samples).
</p></li><li class="listitem"><p><a name="sect.main_menu.drumkits.save_as"></a><span class="bold"><strong>Save As</strong></span>: saves all settings of the current drumkit (including those of their instruments and sound samples) as new drumkit.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The new drumkit will be a physical copy of the old one and is stored into the <code class="filename">$HOME/.hydrogen/data/drumkits/</code> folder.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p><a name="sect.main_form.export_drumkit"></a><span class="bold"><strong>Export</strong></span>: compress and stores all instruments samples and settings of any drumkit (not just the current one) into a folder of your choice as <a class="link" href="#chpt.file_types.h2drumkit">.h2drumkit</a> file.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
For compatibility reasons you can also export your drumkit in a format used in older versions ( <= 0.9.6 ) of Hydrogen. By doing so you need to select a single <a class="link" href="#def.component" title="Component">component</a> to export since this functionality was not supported back than.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p><a name="sect.main_form.import_drumkit"></a><span class="bold"><strong>Import</strong></span>: imports a drumkit (a <a class="link" href="#chpt.file_types.h2drumkit">.h2drumkit</a> file) from the local filesystem.
</p></li><li class="listitem"><p><a name="sect.main_form.online_import_drumkit"></a><span class="bold"><strong>Online Import</strong></span>: imports another drumkit from a remote location
through a <abbr class="abbrev">XML</abbr> feed. The <abbr class="abbrev">XML</abbr> file that should be provided is <span class="bold"><strong>NOT</strong></span> <abbr class="abbrev">RSS</abbr> compliant (see <a class="ulink" href="http://www.hydrogen-music.org/feeds/drumkit_list.php" target="_top">Hydrogen
website</a> for an example).
</p><p>
</p><div class="figure"><a name="fig.import_drumkit"></a><p class="title"><b>Figure 6.2. Import Drumkit</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/Sound_Library_import.png" alt="Import Drumkit"></div></div></div><p><br class="figure-break">
The Import window will pop up with the Internet tab selected.
By default the link to the drumkit list (on hydrogen-music.org) will be filled in,
and after pressing the <span class="bold"><strong>Update list</strong></span> button you will get a complete list of all
drumkits that are available for download. In the status column you can see
if a kit is installed or not.
</p><p>
If you select one of the drumkits you will see info about this kit in the right
pane of the Import window: name, description, author and also the
license type.
</p><p>
You can install a drumkit by selecting it and clicking <span class="bold"><strong>Download and Install</strong></span>.
</p><div class="informalfigure"><a name="fig.downloading_soundlibrary"></a><div class="mediaobject"><img src="img/Downloading_SoundLibrary.png" alt="Widget with progress bar popping up during the download of a drumit."></div></div><p>
Once the kit has been downloaded it will be available in the <a class="link" href="#chpt.sound_library.drumkits" title="10.1. Drumkits">Sound Library</a> under <span class="emphasis"><em>User drumkits</em></span>.
</p></li></ul></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.main_menu.instruments"></a>6.4. Instruments</h2></div></div></div><p>This menu offers
instruments functions.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="bold"><strong>Add Instrument</strong></span>: adds a new instrument to the current drumkit.</p></li><li class="listitem"><p><span class="bold"><strong>Clear All</strong></span>: deletes all instruments from the current drumkit.</p></li><li class="listitem"><p><span class="bold"><strong>Add Component</strong></span>: adds a <a class="link" href="#def.component" title="Component">component</a> to the current drumkit.</p></li></ul></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.main_menu.view"></a>6.5. View</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="bold"><strong>Playlist Editor</strong></span>: opens the <a class="link" href="#chpt.playlist_editor" title="Chapter 15. Playlist Editor">Playlist Editor</a> window.</p></li><li class="listitem"><p><span class="bold"><strong>Director</strong></span>: opens the <a class="link" href="#chpt.director" title="Chapter 14. Director">Director</a> window.</p></li><li class="listitem"><p><span class="bold"><strong>Mixer</strong></span>: opens the <a class="link" href="#chpt.mixer" title="Chapter 13. Mixer">Mixer</a> window.</p></li><li class="listitem"><p><span class="bold"><strong>Instrument Rack</strong></span>: shows or hides the widget of the main window containing both the <a class="link" href="#chpt.instrument_editor" title="Chapter 11. Instrument Editor">Instrument Editor</a> and the <a class="link" href="#chpt.sound_library" title="Chapter 10. Sound Library (Drumkit/Pattern/Song Manager)">Sound Library</a>.</p></li><li class="listitem"><p><span class="bold"><strong>Automation Path</strong></span>: shows or hides the <a class="link" href="#sect.song_editor.automation_path" title="8.7. Automation Path">Automation Path</a>
panel.</p></li><li class="listitem"><p><span class="bold"><strong>Timeline</strong></span>: shows or hides the <a class="link" href="#chpt.song_editor.timeline" title="8.4. Timeline">Timeline</a> panel.</p></li><li class="listitem"><p><span class="bold"><strong>Playback Track</strong></span>: shows or hides the <a class="link" href="#chpt.song_editor.playbackTrack" title="8.6. Playback Track">Playback Track</a> panel.</p></li><li class="listitem"><p><span class="bold"><strong>Full screen</strong></span>: maximises the window size to the whole screen area.</p></li></ul></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.main_menu.options"></a>6.6. Options</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a name="sect.main_menu.options.input_mode"></a><span class="bold"><strong>Input mode</strong></span>: when set to <code class="option">Drumkit</code> the keys on your <abbr class="abbrev">MIDI</abbr> keyboard will map to the instruments
in your drumkit. If you set it to <code class="option">Instrument</code> the keys of your <abbr class="abbrev">MIDI</abbr>
keyboard will trigger the instrument that is currently selected.
The pitch of the instrument will follow the key you press on your keyboard.
This feature is mainly used for non-drum instruments (see <a class="xref" href="#chpt.overview.midi_mapping_and_virtual_keyboard" title="4.3. MIDI-mapping and Virtual Keyboard">Section 4.3</a> for details).
An example: if you use a sample of a piano for one of your instruments, you will be able to 'play'
that piano instrument using your keyboard just like you are playing a piano synth.</p></li><li class="listitem"><p><span class="bold"><strong>Preferences</strong></span>: opens the main preferences
window (see <a class="xref" href="#chpt.preferences" title="Chapter 5. Preferences">Preferences</a> for details).</p></li></ul></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.main_menu.debug"></a>6.7. Debug</h2></div></div></div><p>Tools mainly for debugging
and monitoring Hydrogen.</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The Debug option is only available if Hydrogen was compiled with
debug support.
</p></td></tr></table></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a name="chpt.preferences.audio_engine_tab"></a><span class="bold"><strong>Show Audio Engine Info</strong></span>: opens a window that shows
various stats about Hydrogen and the audio driver.
</p><div class="figure"><a name="fig.preferences.audio_engine_tab"></a><p class="title"><b>Figure 6.3. The Audio Engine View</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/AudioEngineInfoDialog.png" alt="The Audio Engine View"></div></div></div><p><br class="figure-break">
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
In case <abbr class="abbrev">JACK</abbr> is used,
buffer and sampling rate should be set in the configuration of the <abbr class="abbrev">JACK</abbr>
server before starting Hydrogen (<abbr class="abbrev">JACK</abbr> automatically starts when an
application tries to connect).
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p><a name="chpt.main_menu.debug.show_filesystem_info"></a><span class="bold"><strong>Show Filesystem Info</strong></span>:
opens a window that shows you the paths to the user and system data directory as well as to the folder used to create temporary files.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Log Level</strong></span>:
specifies which log messages will be written into the log file.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"><p>
<code class="option">None</code>: No messages will be written at all.
</p></li><li class="listitem"><p>
<code class="option">Error</code>: Only messages concerning critical errors will be written out.
</p></li><li class="listitem"><p>
<code class="option">Warning</code>: Like <code class="option">Error</code> but in addition also general warnings about potential bugs or inconsistencies will be written out.
</p></li><li class="listitem"><p>
<code class="option">Info</code>: Like <code class="option">Warning</code> but also all info messages indicating the correct behavior of Hydrogen will be written out.
</p></li><li class="listitem"><p>
<code class="option">Debug</code>: Like <code class="option">Info</code> but also internal help messages used for developing will be written out.
</p></li></ul></div><p>
</p></li><li class="listitem"><p><span class="bold"><strong>Open Log File</strong></span>:
opens Hydrogen's log in either the terminal the application was started in or in a new terminal instance.</p></li></ul></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.main_menu.info"></a>6.8. Info</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="bold"><strong>User Manual</strong></span>: opens a window with a version of this manual installed on your local computer.</p></li><li class="listitem"><p><span class="bold"><strong>About</strong></span>: the usual window with license
information, acknowledgments, etc.</p></li><li class="listitem"><p><span class="bold"><strong>Report Bug</strong></span>: opens the <a class="ulink" href="https://github.com/hydrogen-music/hydrogen/issues" target="_top">Hydrogen issue page at github.com</a> in your default Internet browser.
You can open a new issue to communicate a bug here (first search if there exists already an issue about it).</p></li><li class="listitem"><p><span class="bold"><strong>Donate</strong></span>: make a donation to developers/maintainers.</p></li></ul></div></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.main_toolbar"></a>Chapter 7. Main Toolbar</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#sect.main_toolbar.transport_control">7.1.
Transport Control
</a></span></dt><dt><span class="sect1"><a href="#sect.main_toolbar.tap_tempo_beat_counter">7.2. Tap Tempo and Beat Counter</a></span></dt><dd><dl><dt><span class="sect2"><a href="#sect.main_toolbar.tap_tempo_beat_counter.tap_tempo">7.2.1. Tap Tempo</a></span></dt><dt><span class="sect2"><a href="#sect.main_toolbar.tap_tempo_beat_counter.beat_counter">7.2.2. Beat Counter</a></span></dt></dl></dd><dt><span class="sect1"><a href="#sect.main_toolbar.bpm_control_and_metronome">7.3. BPM Control and Metronome</a></span></dt><dt><span class="sect1"><a href="#sect.main_toolbar.cpu_usage_midi_in">7.4. CPU Usage and MIDI in</a></span></dt><dt><span class="sect1"><a href="#sect.main_toolbar.jack_control">7.5. JACK Control</a></span></dt><dt><span class="sect1"><a href="#sect.main_toolbar.gui_state">7.6. GUI State</a></span></dt></dl></div><div class="figure"><a name="fig.main_toolbar"></a><p class="title"><b>Figure 7.1. The Main Toolbar</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/MainToolbar_V2.png" alt="The Main Toolbar"></div></div></div><br class="figure-break"><p>Before analyzing the two main frames of Hydrogen, let's take a quick
look at the main toolbar and its components.</p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.main_toolbar.transport_control"></a>7.1.
Transport Control
</h2></div></div></div><div class="informalfigure"><a name="fig.main_toolbar.transport_control"></a><div class="mediaobject"><img src="generated_en/background_Control_V2.png" alt="Part of the Main Toolbar responsible for the transport control. From left to right: rewind, record, pause and play, stop, fast forward, and loop button."></div></div><p>Using these buttons you can <span class="bold"><strong>start</strong></span> (also bound to <span class="keycap"><strong>Space</strong></span>, see <a class="xref" href="#chap.shortcuts" title="Chapter 21. Shortcut Lists">Chapter 21</a> for further related shortcuts) and <span class="bold"><strong>stop</strong></span> the playback, <span class="bold"><strong>record</strong></span> new patterns (see <a class="xref" href="#chpt.overview.recording" title="4.4. Recording in Hydrogen">Section 4.4</a> for details), <span class="bold"><strong>fast forward</strong></span> and <span class="bold"><strong>rewind</strong></span> the transport position, and <span class="bold"><strong>loop</strong></span> playback.</p><p>In addition, you can switch between <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a> and <a class="link" href="#chpt.song_editor.editor_modes.pattern_mode" title="8.2.4. Pattern Mode">Pattern mode</a>.</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
When using the <a class="link" href="#chpt.keyboard_and_mouse" title="Chapter 3. Keyboard and Mouse">Keyboard</a> to navigate in the <a class="link" href="#chpt.song_editor" title="Chapter 8. Song Editor">Song Editor</a> and <a class="link" href="#chpt.pattern_editor" title="Chapter 9. Pattern Editor">Pattern Editor</a> the shortcut <span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>Space</strong></span> (or <span class="keycap"><strong>Alt</strong></span> + <span class="keycap"><strong>Space</strong></span> on MacOS) will change the mode to the one corresponding to the editor. In addition, it will move the current transport position to either the note (Pattern Editor) or the pattern (Song Editor) focused by the cursor and starts the playback.
</p></td></tr></table></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.main_toolbar.tap_tempo_beat_counter"></a>7.2. Tap Tempo and Beat Counter</h2></div></div></div><div class="informalfigure"><a name="fig.main_toolbar.beat_counter"></a><div class="mediaobject"><img src="generated_en/MeasureSettings.png" alt="Part of the Main Toolbar responsible for the tempo settings using the Beat Counter. In the center there is a LCD displaying to the left the beat type and to the right on top the current mode of the Beat Counter and the value of the Countdown Counter below. To the left and right of the LCD there are buttons to decrease or increase the beat type (left) and Countdown Counter value (right)."></div></div><p>This section covers how to interactively change tempo using the <span class="emphasis"><em>Beat Counter</em></span>. Due to conceptional similarities the <span class="emphasis"><em>Tap Tempo</em></span> will be covered as well which itself is not related to the widget displayed above.</p><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="sect.main_toolbar.tap_tempo_beat_counter.tap_tempo"></a>7.2.1. Tap Tempo</h3></div></div></div><p>The Tap Tempo allows you to change the tempo at any time - with playback rolling or stopped - within Hydrogen. To change the tempo, hit the
<span class="keycap"><strong>\</strong></span> key in the tempo you want.
</p><p>
After two keystrokes the tempo will be first changed according to the time difference between the two taps. With each addition keystroke the tempo will be changed again to the rolling average value of the last up top eight hits of the <span class="keycap"><strong>\</strong></span> button. If you tap
accidentally, or if you wait too long between taps, the Tap Tempo
counter will start over.</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The widget shown above is the one of the Beat Counter. The Tap Tempo itself does neither have a dedicated widget nor any option to be set by the user.
</p></td></tr></table></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="sect.main_toolbar.tap_tempo_beat_counter.beat_counter"></a>7.2.2. Beat Counter</h3></div></div></div><p>The Beat Counter is essentially a Tap Tempo on steroids. By default the Beat Counter widget is not
visible. To see the Beat Counter widget click the
<span class="inlinemediaobject"><img src="generated_en/btn_bc_off.png" alt='Grey vertical button containing the characters "B" and "C" in adjacent rows.'></span>
button or simply press <span class="keycap"><strong>,</strong></span>.</p><p>The tempo that you tap will be considered to correspond to even beats of the song's
beat type. The beat type can be set to 1/8 (for eight-note beats), 1/4 (for
quarter-note beats), 1/2 (for half-note beats), and 1/1 (for whole-note
beats). To change the beat type use the left <span class="keycap"><strong>+</strong></span> / <span class="keycap"><strong>-</strong></span> buttons. To change
the Countdown Counter value, use the right <span class="keycap"><strong>+</strong></span> / <span class="keycap"><strong>-</strong></span> buttons. The Countdown
Counter value can be set between 2 and 16 beats. (I.e. if you set the beat to 6, you will
have to tap 6 times before the new tempo is computed and set.) When the
display shows an <em class="parameter"><code>R</code></em>, it means that the Beat Counter
is ready to start from 0. When you tap <span class="keycap"><strong>,</strong></span>, the <em class="parameter"><code>R</code></em> will change to
1, and will increment with every keystroke until it reaches the Countdown
Counter value (shown just below the <em class="parameter"><code>R</code></em>).</p><p>The button in the bottom right-hand controls the auto-start
feature, and it toggles between
<span class="inlinemediaobject"><img src="img/btn_set_play_off.png" alt='Grey button containing a "S".'></span>
and
<span class="inlinemediaobject"><img src="img/btn_set_play_on.png" alt='Blue button containing a "P".'></span>
. When it shows the latter (for <span class="emphasis"><em>Play</em></span>), the song will set the new tempo and
automatically start to play after you tap the right number of beats (if
it's not already playing, of course). This way, if you have the
Beat Counter set up for 4/4, you can tap 1-2-3-4, and start playing on
the next beat. When it shows
<span class="inlinemediaobject"><img src="img/btn_set_play_off.png" alt='Grey button containing a "S".'></span>
(for <span class="emphasis"><em>Set BPM</em></span>), the auto-start is disabled.</p><p>For example: Suppose you have a live band, Hydrogen, and a
softsynth that is controlled by <span class="command"><strong>Seq24</strong></span>)... and you want them all to start
at the same time. Set the beat type to 1/4 and the number of beats to
4. Enable auto-start (button shows
<span class="inlinemediaobject"><img src="img/btn_set_play_on.png" alt='Blue button containing a "P".'></span>
). Count off
the band 1-2-3-4 (while tapping the <span class="keycap"><strong>,</strong></span> key) and everyone
starts on 1.</p><p>Another example: Same situation, but the song doesn't require
Hydrogen or synths until some point later. During that time, a human
(e.g. guitar player) will be setting the tempo. On the measure before
Hydrogen is supposed to play, tap the comma key 1-2-3-4 with the
beat... and you're in on the next beat (at the right tempo).</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>An temporal offset when starting the playback after setting the tempo and a latency compensation for the Beat Counter can be configured in the <a class="link" href="#chpt.preferences.general_tab" title="5.1. General">General tab</a> of the Preferences Dialog.
</p></td></tr></table></div><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
If you are using <abbr class="abbrev">JACK</abbr> transport in the presence of an external <a class="link" href="#sect.preferences.jack.bbt"><abbr class="abbrev">JACK</abbr> Timebase Master</a>, Hydrogen is supposed to be a <span class="emphasis"><em>slave</em></span> and both Tap Tempo and Beat Counter will be disabled. If Hydrogen itself is the <abbr class="abbrev">JACK</abbr> Transport Master, tempo changes from
Hydrogen will be broadcasted to other <abbr class="abbrev">JACK</abbr> clients.
</p></td></tr></table></div></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.main_toolbar.bpm_control_and_metronome"></a>7.3. BPM Control and Metronome</h2></div></div></div><div class="informalfigure"><a name="fig.main_toolbar.bpm_control_and_metronome"></a><div class="mediaobject"><img src="generated_en/background_BPM.png" alt="Part of the Main Toolbar responsible for the tempo settings. To the left there are on top two buttons for decreasing and increasing the tempo and below one to activate the metronome. To the right and covering most of the area is a LCD showing the current BPM. At the far right there is a tall button activating the recalculation of samples processed by Rubber Band at tempo changes."></div></div><p>Set the speed of the song in the range from <code class="option">10</code> to <code class="option">400</code> bpm (beats per minute).
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
You can use the <span class="emphasis"><em>mouse wheel</em></span> to decrease and increase the value of this widget.
</p></td></tr></table></div><p>In addition you can use
<span class="inlinemediaobject"><img src="img/btn_metronome_off.png" alt='Grey button for toggling the metronome. It contains a non-filled black triangle pointing to the left (left), a black dot (middle), and a black closing bracket ")" (right).'></span>
to toggle the metronome.</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
The volume of the metronome can be adjusted in the <a class="link" href="#chpt.preferences.audio_tab" title="5.2. Audio System">Audio tab</a> of the Preferences.
</p></td></tr></table></div><p>
If either Rubber Band support is compiled into your current version of Hydrogen or correctly configured in the <a class="link" href="#chpt.preferences.general_tab" title="5.1. General">General tab</a> of the Preferences, you will also find the
<span class="inlinemediaobject"><img src="img/rubber_off.png" alt='Grey vertical button containing the characters "R", "U", and "B" in adjacent lines.'></span>
button next to the BPM widget. Activating it will enable recalculation of all sample pitches using Rubber Band whenever the tempo of the song will be changed (see <a class="xref" href="#chpt.sample_editor.pitch" title="12.2. Pitch Shifting">Section 12.2</a> for details.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.main_toolbar.cpu_usage_midi_in"></a>7.4. CPU Usage and MIDI in</h2></div></div></div><div class="informalfigure"><a name="fig.main_toolbar.cpu_usage_midi_in"></a><div class="mediaobject"><img src="generated_en/MidiIN_CPU.png" alt='A block horizontal line in the upper part will contain a meter showing the load of the CPU. Below a small LED-like symbol next to the text "MIDI-IN" will indicated when there is MIDI input.'></div></div><p>The CPU bargraph gives you an indication of the CPU load. The <abbr class="abbrev">MIDI</abbr> led lights up every time Hydrogen receives a <abbr class="abbrev">MIDI</abbr> message.</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
The <abbr class="abbrev">MIDI</abbr> settings can be adjusted in the <a class="link" href="#chpt.preferences.midi_tab" title="5.3. MIDI System">MIDI tab</a> of the Preferences.
</p></td></tr></table></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.main_toolbar.jack_control"></a>7.5. JACK Control</h2></div></div></div><div class="informalfigure"><a name="fig..main_toolbar.jack_control"></a><div class="mediaobject"><img src="generated_en/JackTrans_Master.png" alt='Part of the Main Toolbar responsible for the JACK configuration. The left button is titled "J.TRANS" and the right one "J.MASTER".'></div></div><p>Clicking
<span class="inlinemediaobject"><img src="img/btn_jack_transport_off.png" alt='Grey button containing the text "J.TRANS".'></span>
will enable <abbr class="abbrev">JACK</abbr> transport. If disabled, Hydrogen will still use the <abbr class="abbrev">JACK</abbr> driver and registered audio ports. But it decouples its own transport state from the one of the JACK server and will not be in sync with other clients anymore.
</p><p>
Using
<span class="inlinemediaobject"><img src="img/btn_jack_master_off.png" alt='Grey button containing the text "J.MASTER".'></span>
Hydrogen can be registered as <abbr class="abbrev">JACK</abbr> Timebase Master and will send additional information, like the current speed, to other <abbr class="abbrev">JACK</abbr>
clients. Else it will either act as <span class="emphasis"><em>slave</em></span> in the presence of another
Timebase Master, like <span class="command"><strong>Ardour</strong></span>, or as a stand-alone client in the
absence of a Master.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
You can check whether Hydrogen is in <span class="emphasis"><em>slave</em></span> mode by hovering over the disabled <a class="link" href="#sect.main_toolbar.tap_tempo_beat_counter.beat_counter" title="7.2.2. Beat Counter">Beat Counter</a> or <a class="link" href="#chpt.song_editor.timeline" title="8.4. Timeline">Timeline</a>.
</p></td></tr></table></div><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The support of <abbr class="abbrev">JACK</abbr> Timebase can disabled in the <a class="link" href="#chpt.preferences.audio_tab" title="5.2. Audio System">Audio tab</a> of the Preferences. This can be useful in the presence of a fault Master broadcasting nuisance information.
</p></td></tr></table></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.main_toolbar.gui_state"></a>7.6. GUI State</h2></div></div></div><div class="informalfigure"><a name="fig.main_toolbar.gui_state"></a><div class="mediaobject"><img src="generated_en/mixer-instrrack_btn.png" alt='In the upper part there are two buttons. The smaller one to the left is titled "Mixer" and the larger one "Instrument rack". Below there is a large blue LCD showing the default message of Hydrogen after startup "Hydrogen Ready.".'></div></div><p>
Toggles the <a class="link" href="#chpt.mixer" title="Chapter 13. Mixer">Mixer</a> window and the Instrument Rack (containing both the <a class="link" href="#chpt.instrument_editor" title="Chapter 11. Instrument Editor">Instrument Editor</a> and the <a class="link" href="#chpt.sound_library" title="Chapter 10. Sound Library (Drumkit/Pattern/Song Manager)">Sound Library</a>).
</p><p>
The LCD screen below displays what Hydrogen is up to and gives an optical feedback of the parameters set in the <a class="link" href="#chpt.mixer" title="Chapter 13. Mixer">Mixer</a>.
</p></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.song_editor"></a>Chapter 8. Song Editor</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#chpt.song_editor.main_controls">8.1. Main Controls</a></span></dt><dt><span class="sect1"><a href="#chpt.song_editor.editor_modes">8.2. Song Editor modes</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.song_editor.editor_modes.select">8.2.1. Select Mode</a></span></dt><dt><span class="sect2"><a href="#chpt.song_editor.editor_modes.draw">8.2.2. Draw Mode</a></span></dt><dt><span class="sect2"><a href="#chpt.song_editor.editor_modes.song_mode">8.2.3. Song Mode</a></span></dt><dt><span class="sect2"><a href="#chpt.song_editor.editor_modes.pattern_mode">8.2.4. Pattern Mode</a></span></dt><dt><span class="sect2"><a href="#chpt.song_editor.editor_modes.stacked">8.2.5. Stacked Mode</a></span></dt></dl></dd><dt><span class="sect1"><a href="#chpt.song_editor.sidebar">8.3. Sidebar</a></span></dt><dt><span class="sect1"><a href="#chpt.song_editor.timeline">8.4. Timeline</a></span></dt><dt><span class="sect1"><a href="#chpt.song_editor.tag">8.5. Tags</a></span></dt><dt><span class="sect1"><a href="#chpt.song_editor.playbackTrack">8.6. Playback Track</a></span></dt><dt><span class="sect1"><a href="#sect.song_editor.automation_path">8.7. Automation Path</a></span></dt></dl></div><p>
</p><div class="figure"><a name="fig.song_editor"></a><p class="title"><b>Figure 8.1. The Song Editor</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/EnablePlaybackTrack.png" alt="The Song Editor"></div></div></div><p><br class="figure-break">
</p><p>
The Song Editor gives an overview of the whole song
(e.g. intro, verse, bridge, chorus and so on). Each blue
colored square on this panel represents a playing pattern.
It gives you complete freedom to add/remove
patterns to the song and to move or copy any part of your
song.
</p><p>
Columns represent time periods within the song. While they're
shown as the same width in the Song Editor, the length of time
taken to play through a column is set by the length of the
pattern or patterns which are active and playing during that
time slot.
</p><p>
Multiple patterns can be active at the same time in a
column, and they will play simultaneously. This allows
instrument parts to be separated out into different patterns,
or to add ornamentation or fills on top of basic patterns
without duplicating the basics into both patterns.
</p><p>
In the case of multiple patterns of different lengths in one
column only the largest one(s) will be represented by a
square. The shorter patterns are indicated by rectangles whose
width indicate their length relative to the longest one.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
Instead of having the same color for all patterns you can set different colors schemes in the <a class="link" href="#chpt.preferences.appearance_tab" title="5.5. Appearance">Appearance tab</a> in the Preferences.
</p></td></tr></table></div><div class="informalfigure"><a name="fig.song_editor.song_ruler"></a><div class="mediaobject"><img src="img/SongRuler.png" alt='Picture of a part of the Song Ruler used for naviagation. It indicates the position of certains bars by their number - "1", "5", "9", "13", "17". All remaining bars are indicated with a vertical line - "|". In addition, light-blue colored "T"s indicate the presence of a Tag.'></div></div><p>
In addition to the transport control provided in the <a class="link" href="#sect.main_toolbar.transport_control" title="7.1. Transport Control">Main Toolbar</a> you can use the song ruler for navigation. This the area above the grid and right of the Main Controls. The position clicked will be rounded to the nearest pattern beginning and transport will be relocated there.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Navigation in Hydrogen is always quantized. It is only possible to move forward / backwards or locate to whole patterns.
</p></td></tr></table></div><p>
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
You can also locate the keyboard cursor (see <a class="xref" href="#chpt.keyboard_and_mouse" title="Chapter 3. Keyboard and Mouse">Chapter 3</a>) to a desired pattern and press <a class="link" href="#chap.shortcuts.ctrl_space"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>Space</strong></span></a> to relocate to this position.
</p></td></tr></table></div><p>
</p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.song_editor.main_controls"></a>8.1. Main Controls</h2></div></div></div><div class="informalfigure"><a name="fig.song_editor.main_controls"></a><div class="mediaobject"><img src="generated_en/bg_topPanel.png" alt='Main Controls for the Song Editor. From left to right: larger button bearing the text "CLEAR" for deleting all patterns, new pattern button, two buttons to move the selected pattern down and up, two buttons to activate the Draw and the Select mode, and the button to switch between Single Pattern and Stacked mode.'></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="inlinemediaobject"><img src="generated_en/btn_clear_off.png" alt='Grey button containing the text "CLEAR".'></span> : deletes all patterns
(asks for confirmation!).
</p></li><li class="listitem"><p><span class="inlinemediaobject"><img src="generated_en/btn_new_on.png" alt="Grey button containing a plus sign."></span> : creates a new pattern (and asks for a name).
</p></li><li class="listitem"><p><span class="inlinemediaobject"><img src="generated_en/btn_updown.png" alt="Two grey button horizontally aligned. The left contains a black arrow tip pointing downwards and the right one one pointing upwards."></span> : moves currently selected pattern
up or down.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
You can also <span class="emphasis"><em>drag-and-drop</em></span> a pattern up/down in
the pattern list.
</p></td></tr></table></div></li><li class="listitem"><p><span class="inlinemediaobject"><img src="generated_en/btn_draw.png" alt="Grey button containing a black brush."></span> : enables Select mode (<a class="xref" href="#chpt.song_editor.editor_modes.select" title="8.2.1. Select Mode">Section 8.2.1</a>).
</p></li><li class="listitem"><p><span class="inlinemediaobject"><img src="generated_en/btn_select.png" alt="Blue button containing four black horizontal dots in the lower part joined by three black vertical dots at the right bottom corner."></span> : enables Draw mode (<a class="xref" href="#chpt.song_editor.editor_modes.select" title="8.2.1. Select Mode">Section 8.2.1</a>).</p></li><li class="listitem"><p><a name="chpt.song_editor.main_controls.single_vs_stacked"></a><span class="inlinemediaobject"><img src="generated_en/btn_pattern_mode.png" alt="Grey button with a horizontal black line."></span> : sets Hydrogen to <span class="emphasis"><em>Single Pattern mode</em></span>
<span class="inlinemediaobject"><img src="generated_en/btn_stacked_mode.png" alt="Grey button with three horizontal black lines stacked vertically."></span>
or to <span class="emphasis"><em>Stacked mode</em></span> (<a class="xref" href="#chpt.song_editor.editor_modes.stacked" title="8.2.5. Stacked Mode">Section 8.2.5</a>).</p></li></ul></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.song_editor.editor_modes"></a>8.2. Song Editor modes</h2></div></div></div><p>
The Song Editor has two different <span class="emphasis"><em>interaction modes</em></span>. The
default <a class="link" href="#chpt.song_editor.editor_modes.select" title="8.2.1. Select Mode"><span class="bold"><strong>Select mode</strong></span></a> allows
pattern blocks to be set, cleared, selected, moved and
copied. The <a class="link" href="#chpt.song_editor.editor_modes.draw" title="8.2.2. Draw Mode"><span class="bold"><strong>Draw mode</strong></span></a>
instead allows pattern sequences to be drawn freehand.
</p><p>
In both modes, you can perform basic editing: clicking an
empty square activates the pattern in that time slot, and
clicking again will deactivate it.
</p><p>
They keyboard can also be used for editing. The arrow keys
<span class="keycap"><strong>↑</strong></span>|<span class="keycap"><strong>↓</strong></span>|<span class="keycap"><strong>←</strong></span>|<span class="keycap"><strong>→</strong></span>
will move the keyboard input cursor, and pressing
<span class="keycap"><strong>Return</strong></span> will activate or deactivate the
pattern in the current column.
</p><p>
In addition, there are two major <span class="emphasis"><em>playback modes</em></span>, <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode"><span class="bold"><strong>Song mode</strong></span></a> and <a class="link" href="#chpt.song_editor.editor_modes.pattern_mode" title="8.2.4. Pattern Mode"><span class="bold"><strong>Pattern mode</strong></span></a>, with two minor submodes, <span class="bold"><strong>Single Pattern mode</strong></span> (covered in the <a class="link" href="#chpt.song_editor.editor_modes.pattern_mode" title="8.2.4. Pattern Mode">Pattern mode</a> section), and <a class="link" href="#chpt.song_editor.editor_modes.stacked" title="8.2.5. Stacked Mode"><span class="bold"><strong>Stacked mode</strong></span></a>. These will determine which parts of the song you will listen too during playback.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
While Select mode, Draw mode, Single Pattern mode, and Stacked mode are activated via the <a class="link" href="#chpt.song_editor.main_controls" title="8.1. Main Controls">Main Controls</a> of the Song Editor, Song mode and Pattern mode are activated via the <a class="link" href="#sect.main_toolbar.transport_control" title="7.1. Transport Control">Transport Control</a> section of the Main Toolbar.
</p></td></tr></table></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.song_editor.editor_modes.select"></a>8.2.1. Select Mode</h3></div></div></div><p>
This mode allows
you to select multiple patterns in the Song Editor and
delete/move/copy them.
</p><p>
Once you have selected a part of your song you can
<span class="bold"><strong>delete</strong></span> it by pressing
<span class="keycap"><strong>Delete</strong></span>. You can <span class="bold"><strong>move</strong></span> it by simply <span class="emphasis"><em>dragging</em></span> your
selection to another location with your mouse, or by
cutting (<span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>x</strong></span>) and
pasting (<span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>v</strong></span>) using
your keyboard. You can also <span class="bold"><strong>copy</strong></span> your selection by either
holding <span class="keycap"><strong>Ctrl</strong></span> while <span class="emphasis"><em>dragging</em></span> it to a new
location, or by copying (<span class="keycap"><strong>Ctrl</strong></span> +
<span class="keycap"><strong>c</strong></span>) and pasting (<span class="keycap"><strong>Ctrl</strong></span> +
<span class="keycap"><strong>v</strong></span>) using your keyboard.
</p><p>
Selections can be modified by holding <span class="keycap"><strong>Ctrl</strong></span> while clicking to select
additional blocks, or to remove selected blocks from the
selection.
</p><p>
The arrow keys on the keyboard can also be used, along
with <span class="keycap"><strong>Return</strong></span>, to <span class="bold"><strong>select</strong></span>, <span class="bold"><strong>move</strong></span> and <span class="bold"><strong>copy</strong></span> parts of the
song:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="keycap"><strong>Shift</strong></span> +
<span class="keycap"><strong>↑</strong></span>|<span class="keycap"><strong>↓</strong></span>|<span class="keycap"><strong>←</strong></span>|<span class="keycap"><strong>→</strong></span>
can be used to make selections using the keyboard</p></li><li class="listitem"><p><span class="keycap"><strong>Return</strong></span> over a selected block
will begin a move or copy</p></li><li class="listitem"><p><span class="keycap"><strong>↑</strong></span>|<span class="keycap"><strong>↓</strong></span>|<span class="keycap"><strong>←</strong></span>|<span class="keycap"><strong>→</strong></span> to
move the selected cells into position</p></li><li class="listitem"><p><span class="keycap"><strong>Return</strong></span> to move the selected
blocks into place</p></li><li class="listitem"><p><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>Return</strong></span> to
<span class="bold"><strong>copy</strong></span> the selected
blocks into place</p></li></ul></div><p>
</p><p>
Pressing <span class="keycap"><strong>Esc</strong></span> will cancel an editing operation that's in
progress, or clear any selection.
</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.song_editor.editor_modes.draw"></a>8.2.2. Draw Mode</h3></div></div></div><p>
This mode allows you to insert patterns by drawing -
holding the left button while moving the mouse - blocks on
the song canvas.
</p><p>
Clicking a square on the song canvas will add a pattern
(the square will turn blue) and clicking it again will
remove it. Holding the mouse button down will continue
either adding or removing patterns from under the mouse
cursor.
</p><p>
Using the arrow keys on the keyboard, and the <span class="keycap"><strong>Return</strong></span>,
will also add and remove patterns from the song.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The keyboard input cursor is usually hidden unless you press one
of the keys listed in <a class="xref" href="#chpt.keyboard_and_mouse" title="Chapter 3. Keyboard and Mouse">Chapter 3</a>.
You can alter this default behavior in the <a class="link" href="#chpt.preferences.general_tab" title="5.1. General">General tab</a> of the
Preferences.
</p></td></tr></table></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.song_editor.editor_modes.song_mode"></a>8.2.3. Song Mode</h3></div></div></div><p>
When <span class="emphasis"><em>Song mode</em></span> is selected Hydrogen will play the sequence of patterns you have created in the Song Editor from left to right until it reaches the end of the song.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
By enabling <a class="link" href="#sect.main_toolbar.transport_control" title="7.1. Transport Control">Loop mode</a> in the transport control, the playback will move seamlessly to the beginning again after reaching the end of the song.
</p></td></tr></table></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.song_editor.editor_modes.pattern_mode"></a>8.2.4. Pattern Mode</h3></div></div></div><p>
When <span class="emphasis"><em>Pattern mode</em></span> is selected
Hydrogen will play the pattern that is currently selected in the Song Editor and displayed
in the <a class="link" href="#chpt.pattern_editor" title="Chapter 9. Pattern Editor">Pattern Editor</a>. This usual behavior is also called <span class="emphasis"><em>Single Pattern mode</em></span>.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
By enabling <a class="link" href="#sect.main_toolbar.transport_control" title="7.1. Transport Control">Loop mode</a> in the transport control, the playback will move seamlessly to the beginning again after reaching the end of the pattern.
</p></td></tr></table></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.song_editor.editor_modes.stacked"></a>8.2.5. Stacked Mode</h3></div></div></div><p>
Normally when composing a pattern and editing it, you'll
listen to that single pattern looping over and over again
while working on it. Sometimes, however, it's useful to
hear that pattern in the context of other patterns (for
example, other instrument parts) while working on it.
</p><p>
Stacked mode will play multiple patterns simultaneously,
on a loop. You can select which patterns play using
<span class="keycap"><strong>Ctrl</strong></span> + <span class="emphasis"><em>left click</em></span> on the
pattern's name. Selected patterns are all marked with a
triangle.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Hydrogen's playback mode must be set to <span class="bold"><strong>Pattern</strong></span> rather than
<span class="bold"><strong>Song</strong></span> for Stacked mode to take effect.
</p></td></tr></table></div></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.song_editor.sidebar"></a>8.3. Sidebar</h2></div></div></div><p>
The Sidebar of the Song Editor allows you to interact with and arrange the patterns of your song.
</p><p><span class="emphasis"><em>Left-clicking</em></span> selects a pattern, <span class="emphasis"><em>double-clicking</em></span> allows you to rename a pattern, <span class="emphasis"><em>drag-and-dropping</em></span> allows you to rearrange the patterns, and <span class="emphasis"><em>right-clicking</em></span> will show you a menu
where you can change a number of things:</p><div class="figure"><a name="fig.song_editor.virtualPattern.selectedMenu"></a><p class="title"><b>Figure 8.2. The Pattern Options menu</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/Virtual_patterns_menu.png" alt="The Pattern Options menu"></div></div></div><br class="figure-break"><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: opencircle; "><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Duplicate</strong></span>: will copy the selected pattern to a new pattern in your song.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Note that patterns with the same name are not allowed.
</p></td></tr></table></div></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Delete</strong></span>: will completely remove the selected pattern from the song.
</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Fill/Clear</strong></span>: will open a window that allows you to fill/clear a
part of the song with the selected pattern by entering the start- and end bar.
</p><div class="informalfigure"><a name="fig.fill_clear_pattern"></a><div class="mediaobject"><img src="generated_en/fill_clear_pattern.png" alt='Dialog appearing when filling or clearing a pattern. To the left either "Fill" or "Clear" (below) can be checked and to the right the numerical text input form "From" and "To" (below) indicate the range of the operation. At the bottom there are "Cancel" (left) and "OK" (right) buttons.'></div></div><p>
</p></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.song_editor.sidebar.properties"></a><span class="bold"><strong>Properties</strong></span>: will open a window where you can change
the name of the pattern and also assign it to a certain category. Using the latter you can group pattern in in the <a class="link" href="#sect.sl.patterns" title="10.3. Patterns">Sound Library</a>.
</p><div class="figure"><a name="fig.pattern_properties"></a><p class="title"><b>Figure 8.3. The Dialog to Change the Pattern Properties</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/pattern_properties.png" alt='Dialog appearing when changing the properties of a pattern. At the top text input one specifies the "New Pattern Name". In the larger one below the "Pattern description". Underneath one can select the "Pattern category". At the bottom there are "Cancel" (left) and "OK" (right) buttons.'></div></div></div><br class="figure-break"><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Note that you can choose one of the existing categories from the dropdown list,
but you can also enter a new category name in the Pattern Category
box.
</p></td></tr></table></div></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Load Pattern</strong></span>: will
load a pattern from a saved pattern file.
</p></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.song_editor.sidebar.save_pattern"></a><span class="bold"><strong>Save Pattern</strong></span>: stores the
pattern in the <code class="filename">patterns</code> folder
within the Hydrogen data directory (usually <code class="filename">$HOME/.hydrogen/data/</code>).
</p></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.song_editor.sidebar.export_pattern"></a><span class="bold"><strong>Export Pattern</strong></span>: stores the
pattern at a location determined via a file browser.
</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Virtual Pattern</strong></span>: will
open the virtual pattern editor.
</p><p>
Virtual patterns are a convenient way of grouping patterns together.
For example, say you have a song in which three patterns are always
played together at the start of each bar. Previously, the way to do this
in the pattern matrix was to explicitly enable the three patterns at each bar.
</p><p>
With virtual patterns we can assign a pattern to be a sort of meta-pattern
that implicitly invokes these three patterns together when the new virtual pattern
is enabled in the pattern matrix. This way, we only need to set one pattern every
bar, instead of three.
</p><p>
Virtual patterns provide a function that's similar to the regular pattern editor, and one could argue that
since a virtual pattern is also a regular pattern, we could have just merged the three
patterns into this new one. However, the advantage that virtual patterns provide is that
if one of the original three patterns changes, the virtual pattern automatically inherits
the change. A virtual pattern can also invoke other virtual patterns.
</p></li></ul></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.song_editor.timeline"></a>8.4. Timeline</h2></div></div></div><div class="informalfigure"><a name="fig.tempo_bar"></a><div class="mediaobject"><img src="generated_en/tempo_bar.png" alt="Picture showing the Timeline above the Song Ruler."></div></div><p>The majority of songs consist of several parts (intro, verse, chorus ...) and
often these parts will have a different tempo. Hydrogen provides an easy way
to let you change the tempo of a song at any given moment in the song. This is
done by adding <span class="emphasis"><em>Tempo Markers</em></span> to your song.</p><p>To add a Tempo Marker you first need to show the Timeline by clicking the
<span class="inlinemediaobject"><img src="generated_en/btn_viewTL_off.png" alt='Grey button containing a black "P".'></span>
button at the bottom of the Song Editor or via the <a class="link" href="#sect.main_menu.view" title="6.5. View">View</a> element of the Main Menu and enable it using the
<span class="inlinemediaobject"><img src="generated_en/btn_bpm_off.png" alt='Grey button containing the black characters "BPM".'></span>
button. Once this is done
the horizontal bar next to the button changes to a ruler with marks at every bar.
Now simply <span class="emphasis"><em>left-click</em></span> this ruler at the bar you want the tempo to change and a
window will pop up where you can enter the new tempo.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Please note that the ruler will not be available while using the <abbr class="abbrev">JACK</abbr>
transport in <span class="emphasis"><em>slave</em></span> mode (see <a class="xref" href="#sect.main_toolbar.jack_control" title="7.5. JACK Control">Section 7.5</a> for details.
</p></td></tr></table></div><p>
</p><div class="informalfigure"><a name="fig.add_tempo_change"></a><div class="mediaobject"><img src="generated_en/add_tempo_change.png" alt='Dialog for entering/altering a BPM Marker. In the two text inputs in at the upper half of the dialog one can specify the "BPM" (top) and the "Bar" (below). Underneath there is a large button titled "Delete BPM Marker". At the bottom there are "Cancel" (left) and "OK" (right) buttons.'></div></div><p>
Once you have entered the new tempo and clicked OK, the tempo change will
show up on the Timeline. If you click the Tempo Marker again you can edit
the tempo, change the bar or delete it.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.song_editor.tag"></a>8.5. Tags</h2></div></div></div><div class="informalfigure"><a name="fig.tag_bar"></a><div class="mediaobject"><img src="img/tag_bar.png" alt='Excerpt of the Song Ruler containing several Tags marked with light-blue "T"s.'></div></div><p>
In addition to altering the tempo when the song switches from e.g. the intro into a verse,
it is also very handy to have a clear indication of more general changes or special events in the song. For this purpose you can also add <span class="emphasis"><em>Tags</em></span> to the song.
These Tags are short text messages you can add at any given
moment that will be displayed whenever the song playhead passes by that Tag.
</p><p>
To add a Tag <span class="emphasis"><em>middle-click</em></span> on the song ruler (just below the
Timeline) and a window will pop up that allows you to add text for any bar.
</p><div class="figure"><a name="fig.add_tag"></a><p class="title"><b>Figure 8.4. Dialog Window for Adding Tags</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/add_tag.png" alt="Dialog Window for Adding Tags"></div></div></div><p><br class="figure-break">
Once you are done you will see a small blue <em class="parameter"><code>T</code></em> in the song ruler for every Tag
you have entered. <span class="emphasis"><em>Middle-click</em></span> anywhere on the song ruler to edit the tags.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.song_editor.playbackTrack"></a>8.6. Playback Track</h2></div></div></div><div class="informalfigure"><a name="fig.playbackTrack"></a><div class="mediaobject"><img src="generated_en/PlaybackTrack.png" alt='Figure showing the Playback track ontop of the Song Editor. At the left side there are several controls: the upper half consists of a larger fader and an "EDIT" (middle) and "MUTE" (right) button. The lower half contains the Main Controls of the Song Editor. The right half is made up by an dark-blue area may will contain the waveform of the Playback track but is empty in this example.'></div></div><p>
Using the Playback Track you can program your song alongside an existing audio file, for example a guitar track.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
When a Playback Track is loaded, it will be played back every time audio transport in Hydrogen is rolling and <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a> is activated.
</p></td></tr></table></div><p>
To add a playback track to your song, you need to enable the playback track view. This can be done by either pressing the
<span class="inlinemediaobject"><img src="img/btn_viewTL_off.png" alt='Grey button containing a black "T".'></span>
button left to the scroll bar at the bottom of the Song Editor or via the <a class="link" href="#sect.main_menu.view" title="6.5. View">View</a> element of the Main Menu.
</p><p>
Left to the wave display, the controls of the Playback Track are displayed.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: opencircle; "><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Edit</strong></span>: loads an audio file.</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
As an alternative, you can load an audio file by <span class="emphasis"><em>dragging</em></span> it into Hydrogen and dropping over the wave display.
</p></td></tr></table></div></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Mute</strong></span>: <a class="link" href="#def.mute" title="Mute">mutes</a> the Playback Track.</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Fader</strong></span>: adjusts the volume. You can think of this fader as the mixer strip of the Playback Track. The resulting audio will be pass the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master section</a> of the Mixer like any other strip too.</p></li></ul></div><p>
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
In its current implementation the Playback Track does hide the song ruler used for navigation. It is therefore advised to hide the Playback Track again once you are done setting the sound file and adjusting its volume.
</p></td></tr></table></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.song_editor.automation_path"></a>8.7. Automation Path</h2></div></div></div><div class="figure"><a name="fig.automation_path"></a><p class="title"><b>Figure 8.5. The Automation Path Widget</b></p><div class="figure-contents"><div class="mediaobject"><img src="img/AutomationPath.png" alt="The Automation Path Widget"></div></div></div><br class="figure-break"><p>
The Automation Path allows you to control the overall <a class="link" href="#def.velocity" title="Velocity">velocity</a> of all notes throughout the song. It can be viewed using the shortcut <span class="keycap"><strong>Alt</strong></span> + <span class="keycap"><strong>A</strong></span> or via the <a class="link" href="#sect.main_menu.view" title="6.5. View">View</a> option of the Main Menu.
</p><p>
<span class="emphasis"><em>Clicking</em></span> the graph area introduces a new point determining when and to which value the velocity will be changed. Currently only linear interpolations of the velocity between the individual points are supported. You can <span class="emphasis"><em>drag</em></span> a point to move it and you can delete one by dragging another point over it and "absorbing" it.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Whether the Automation Path is hidden or shown does not affect its activation state. It is <span class="bold"><strong>always active</strong></span> and can't be disabled. But in its default setting it won't alter anything. In its current implementation you have to reset the Automation Path to its original state manually in order to disable it.
</p></td></tr></table></div></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.pattern_editor"></a>Chapter 9. Pattern Editor</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#chpt.pattern_editor.general">9.1. General</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.pattern_editor.controls">9.1.1. Controls</a></span></dt><dt><span class="sect2"><a href="#chpt.pattern_editor.sidebar">9.1.2. Sidebar</a></span></dt></dl></dd><dt><span class="sect1"><a href="#chpt.pattern_editor.drumkit">9.2. Drum Pattern Editor</a></span></dt><dt><span class="sect1"><a href="#chpt.pattern_editor.note_properties">9.3. Note Properties Editor</a></span></dt><dt><span class="sect1"><a href="#chpt.pattern_editor.piano_mode">9.4. Piano Roll Editor</a></span></dt></dl></div><div class="figure"><a name="fig.PatternEditor_DrumMode"></a><p class="title"><b>Figure 9.1. Pattern Editor in Drum Mode</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/PatternEditor_DrumMode.png" alt="Pattern Editor in Drum Mode"></div></div></div><br class="figure-break"><p>This is where it all happens, this is where you can make music :-)</p><p>The <span class="emphasis"><em>Pattern Editor</em></span>
allows you to create and modify the pattern selected in the <a class="link" href="#chpt.song_editor.sidebar" title="8.3. Sidebar">Sidebar</a> of the Song Editor by adding/removing notes and tuning
a number of <a class="link" href="#chpt.pattern_editor.note_properties" title="9.3. Note Properties Editor">per-note properties</a>, like velocity and pan.
The Pattern Editor
can be used in two modes: as <a class="link" href="#chpt.pattern_editor.drumkit" title="9.2. Drum Pattern Editor">Drumkit Editor</a> or as <a class="link" href="#chpt.pattern_editor.piano_mode" title="9.4. Piano Roll Editor">Piano Roll Editor</a>. You can switch between these
two by clicking the
<span class="inlinemediaobject"><img src="generated_en/btn_drum_piano_off.png" alt="Grey button containing a small piano illustration with three white and two black keys."></span>
button (located on the top-right of the Pattern Editor).
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
If you are editing a pattern in <a class="link" href="#chpt.song_editor.editor_modes.pattern_mode" title="8.2.4. Pattern Mode">Single Pattern mode</a> you will always hear the pattern you are
editing when you playback is rolling.
</p><p>
If you are working in <a class="link" href="#chpt.song_editor.editor_modes.stacked" title="8.2.5. Stacked Mode">Stacked Pattern mode</a> you will hear the <span class="emphasis"><em>active</em></span> pattern(s),
not necessarily the pattern you are currently editing.
The active patterns have a small triangle next to the pattern name in the Song Editor. (see <a class="xref" href="#chpt.song_editor.main_controls.single_vs_stacked">Single Pattern and Stacked mode</a> for details).
</p></td></tr></table></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.pattern_editor.general"></a>9.1. General</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.pattern_editor.controls"></a>9.1.1. Controls</h3></div></div></div><div class="figure"><a name="fig.PatternEditorControls"></a><p class="title"><b>Figure 9.2. Pattern Editor Controls</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/PatternEditorControls.png" alt="Pattern Editor Controls"></div></div></div><br class="figure-break"><p>The top part of the Pattern Editor contains a number of controls applying to both the <a class="link" href="#chpt.pattern_editor.drumkit" title="9.2. Drum Pattern Editor">Drumkit Editor</a> and the <a class="link" href="#chpt.pattern_editor.piano_mode" title="9.4. Piano Roll Editor">Piano Roll Editor</a>:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: opencircle; "><li class="listitem" style="list-style-type: circle"><p><a name="chpt.pattern_editor.controls.size"></a>
<span class="inlinemediaobject"><img src="generated_en/lcd_size.png" alt='Blue LCD showing "4/4" and titled "SIZE".'></span>
: lets you choose the length of the pattern (in note values).
</p><p>
It will open a dialog to enter the new size as text, in the standard music fractional notation:
</p><div class="informalfigure"><a name="fig.PatternSizeDialog"></a><div class="mediaobject"><img src="img/PatternSizeDialog.png" alt='Dialog for entering the "New Pattern length (beats/note value)" via a Text input in the middle. At the bottom there are "Cancel" (right) and "OK" (left) buttons.'></div></div><p>
Type <span class="keycap"><strong>/</strong></span> to separate numerator and denominator.
</p><p>
If you enter just the numerator (e.g. <code class="option">4</code>), the current denominator will be assumed.
You can enter a decimal numerator (e.g. <code class="option">4.5/4</code>) but since Hydrogen resolution is limited,
some values are not supported and will be approximated.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Hydrogen supports (only) the following denominators: <code class="option">1</code>, <code class="option">2</code>, <code class="option">3</code>, <code class="option">4</code>, <code class="option">6</code>, <code class="option">8</code>, <code class="option">12</code>, <code class="option">16</code>, <code class="option">24</code>, <code class="option">32</code>, <code class="option">48</code>, <code class="option">64</code>, <code class="option">96</code>, and <code class="option">192</code>
because these are the factors of the maximum resolution (192 ticks per whole note).
You can use unsupported denominators, but the size will be approximated almost all the times,
hence a warning icon will appear:
</p><div class="informalfigure"><a name="fig.DenominatorWarningIcon"></a><div class="mediaobject"><img src="generated_en/DenominatorWarningIcon.png" alt='A yellow upright triangle containing a exclamation mark is shown to the right of the "SIZE" LCD.'></div></div></td></tr></table></div></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.pattern_editor.controls.res"></a>
<span class="inlinemediaobject"><img src="generated_en/lcd_res.png" alt='Blue LCD showing "1/16" and titled "RES".'></span>
: this is the current grid resolution (<code class="option">1/4</code> through <code class="option">1/64</code> with triplet-based resolutions marked as <code class="option">1/8T</code>).
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
If you are working
with a resolution of <code class="option">1/16</code> you can't go back to <code class="option">8</code> and remove an upbeat 16th note. On
the other hand if you are working with a resolution of <code class="option">8</code> and you try to
insert a note in the middle of two bars (looking for a <code class="option">16</code> bars precision),
notes will be placed in the previous or in the following 8th bar. This
constraint can be removed if you disable the whole grid resolution (choose
<code class="option">off</code> from the grid resolution LCD control). Now you'll be able to place
notes wherever you prefer.</p></td></tr></table></div></li><li class="listitem" style="list-style-type: circle"><p>
<span class="inlinemediaobject"><img src="generated_en/btn_hear.png" alt="Blue button containing a black speaker symbol."></span>
: when enabled Hydrogen
will play back samples as they are being added to the pattern (even if transport is not rolling).
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
When disabled you will still hear the preview sound when clicking on the instrument name in the <a class="link" href="#chpt.pattern_editor.sidebar" title="9.1.2. Sidebar">Sidebar</a>. Be sure to click at the left-most position - where the preview is silent - in case you don't want to get disturbed.
</p></td></tr></table></div></li><li class="listitem" style="list-style-type: circle"><p>
<span class="inlinemediaobject"><img src="generated_en/btn_quant_off.png" alt="Blue button showing a black 2 by 3 grid."></span> : enables/disables quantization.
When enabled, beats <a class="link" href="#chpt.overview.recording" title="4.4. Recording in Hydrogen">recorded</a> from MIDI or from the
<a class="link" href="#chpt.overview.midi_mapping_and_virtual_keyboard" title="4.3. MIDI-mapping and Virtual Keyboard">virtual keyboard</a> will automatically respect the grid
resolution currently applied, just like notes inserted by
clicking. </p></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.pattern_editor.controls.input"></a>
<span class="inlinemediaobject"><img src="generated_en/btn_drum_piano_off.png" alt="Grey button containing a small piano illustration with three white and two black keys."></span> / <span class="inlinemediaobject"><img src="generated_en/btn_drum_piano_on.png" alt="Blue button with a quasi-3D display a a cylinder with black outlines, blue sides, and a white top."></span> : switches between <a class="link" href="#chpt.pattern_editor.drumkit" title="9.2. Drum Pattern Editor">Drumkit Editor</a> and <a class="link" href="#chpt.pattern_editor.piano_mode" title="9.4. Piano Roll Editor">Piano Roll Editor</a>.</p></li></ul></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.pattern_editor.sidebar"></a>9.1.2. Sidebar</h3></div></div></div><div class="figure"><a name="fig.pattern_editor.sidebar"></a><p class="title"><b>Figure 9.3. The Sidebar of the Pattern Editor</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/PatternEditorInstr_V2.png" alt="The Sidebar of the Pattern Editor"></div></div></div><br class="figure-break"><p>The section on the left shows you what drumkit is currently selected (GMRockKit by default) and below that you can see
the instruments that are part of this kit.</p><p><span class="emphasis"><em>Left-clicking</em></span> the box containing the instrument name will play back a sample of the instrument. Which layer will be select depends on the horizontal position of the mouse click representing zero <a class="link" href="#def.velocity" title="Velocity">velocity</a> to the left and maximum velocity to the right. In addition, each instrument has its own set of features that are accessible by
<span class="emphasis"><em>right-clicking</em></span> the instrument. From the context menu that pops up you can select.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: opencircle; "><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Delete notes</strong></span>:
removes all notes for this instrument in this pattern. </p></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.pattern_editor.sidebar.fill_notes"></a><span class="bold"><strong>Fill notes</strong></span>: this allows you to fill
up the pattern with notes for the selected instrument.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Depending on the choice you make (<code class="option">fill all</code>, <code class="option">fill 1/2</code>, <code class="option">fill 1/4</code> ...)
notes will be placed at all, 1/2, 1/4, etc of the note positions <span class="bold"><strong>that are allowed by
the grid setting</strong></span>. So be careful not to mix up the 'musical' 1/2-note and the 'fill 1/2' note.
</p></td></tr></table></div><p>
</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Randomize velocity</strong></span>:
automatically apply a pseudo-random velocity to each note of that
instrument in the pattern.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The more velocity you set on the instrument,
the more Hydrogen will hit <span class="quote">“<span class="quote">hard</span>”</span> on that instrument when
played.
</p></td></tr></table></div><p>
</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Select notes</strong></span>:
will select all the notes played on this instrument in the
current pattern. They can then be copied, moved etc. in the
Pattern Editor main area.
</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Edit all patterns</strong></span>:
this section of the menu has actions which operate on
notes played by the instrument in <span class="emphasis"><em>all</em></span>
the patterns of the song.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="bold"><strong>Cut notes</strong></span>:
remove <span class="emphasis"><em>all</em></span> notes played on
this instrument, in all patterns, and keep them in the
clipboard.
</p></li><li class="listitem"><p><span class="bold"><strong>Copy notes</strong></span>:
copy <span class="emphasis"><em>all</em></span> notes played on
this instrument, in all patterns, to the clipboard.
</p></li><li class="listitem"><p><span class="bold"><strong>Paste notes</strong></span> :
paste a multi-pattern selection from the clipboard to
this instrument.
</p></li><li class="listitem"><p><span class="bold"><strong>Delete notes</strong></span>:
delete all the notes associated with this instrument,
without affecting the clipboard.
</p></li></ul></div><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
These can be used together to change the instrumentation
of a song, entirely replacing one instrument with
another by just copy and pasting the notes to a new
instrument.
</p></td></tr></table></div></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Instrument</strong></span>:
this section of the menu has actions which operate on the
instrument as a whole:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="bold"><strong>Rename
instrument</strong></span>:
change the name of the instrument.
</p></li><li class="listitem"><p><span class="bold"><strong>Delete
Instrument</strong></span>: well, deletes the instrument ;-)</p></li></ul></div></li></ul></div><p>The
<span class="inlinemediaobject"><img src="generated_en/btn_mute_on.png" alt='Grey button containing a black "M".'></span>
button <a class="link" href="#def.mute" title="Mute">mutes</a> the instrument and
<span class="inlinemediaobject"><img src="generated_en/btn_solo_off.png" alt='Grey button containing a black "S".'></span>
solos it.
</p><p>The order of the instruments can be rearranged by simply <span class="emphasis"><em>dragging</em></span> an instrument
up/down in the list and <span class="emphasis"><em>dropping</em></span> it on a new position within the drumkit. Doing so
will not change the sequence of notes you have created for that instrument, nor will
it change anything about the song or pattern you are working on.</p><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>
It <span class="bold"><strong>
will</strong></span> however, have an <span class="bold"><strong>impact</strong></span> on the <a class="link" href="#chpt.overview.midi_mapping_and_virtual_keyboard" title="4.3. MIDI-mapping and Virtual Keyboard"><abbr class="abbrev">MIDI</abbr> note
mapping</a>.
</p></td></tr></table></div><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>
Rearranging the instruments will also mess up the <a class="link" href="#sect.preferences.jack.per_instrument_outs">per-instrument</a> <abbr class="abbrev">JACK</abbr> output ports. Be sure to have your drumkit set up before starting wiring.
</p></td></tr></table></div></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.pattern_editor.drumkit"></a>9.2. Drum Pattern Editor</h2></div></div></div><div class="figure"><a name="fig.PatternEditor_drumkit"></a><p class="title"><b>Figure 9.4. Pattern Editor in Drum Mode</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/PatternEditor_DrumMode.png" alt="Pattern Editor in Drum Mode"></div></div></div><br class="figure-break"><p>Right of the <a class="link" href="#chpt.pattern_editor.sidebar" title="9.1.2. Sidebar">Sidebar</a> area you can see your selected pattern and add notes for any instrument.
The simplest way to create a pattern is by adding notes using <a class="link" href="#chpt.pattern_editor.sidebar.fill_notes">Fill notes</a>. Where you can add notes
depends on the used pattern <a class="link" href="#chpt.pattern_editor.controls.size">size</a> and <a class="link" href="#chpt.pattern_editor.controls.res">resolution</a>.</p><p>If you are using Hydrogen as a pure 'drum' you just want Hydrogen to 'hit'
the instrument wherever there's a 'dot' in the pattern. If you are using Hydrogen as an 'instrument', the
length of the note becomes very important. There are 2 ways to define the length of
a note :
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
you can add a note by <span class="emphasis"><em>left-clicking</em></span>, and then can 'stretch' that note by <span class="emphasis"><em>right-click-dragging</em></span> it.
This will change the dot into a rectangle that represents the
duration of that note.
</p></li><li class="listitem"><p>
alternatively, you can add a stop-note by
<span class="keycap"><strong>Shift</strong></span> + <span class="emphasis"><em>left-clicking</em></span>. This adds a blue dot which
represents the end of the note.
</p></li></ul></div><p>
</p><div class="informalfigure"><a name="fig.NoteOff_NoteLength"></a><div class="mediaobject"><img src="generated_en/NoteOff_NoteLength.png" alt="Three notes are displayed in one line of the Pattern Editor. The one to the left is marked with a black circle. The one in the middle by a black circle from which a black triangle expands over two grid cells, and the left one is represented by a blue circle."></div></div><p>
(Figure above, from left>right : a 'normal' note, a note in 'note length' mode, a note in 'note off' mode)
</p><p>
As in the Song Editor, the arrow keys can also be used to
move around the pattern, and notes can be placed or removed
with <span class="keycap"><strong>Return</strong></span> (see <a class="xref" href="#chpt.keyboard_and_mouse" title="Chapter 3. Keyboard and Mouse">Chapter 3</a>).
</p><p>
Notes can be selected by <span class="emphasis"><em>dragging</em></span> over them with the mouse (or <span class="keycap"><strong>Shift</strong></span> + <span class="keycap"><strong>↑</strong></span>|<span class="keycap"><strong>↓</strong></span>|<span class="keycap"><strong>←</strong></span>|<span class="keycap"><strong>→</strong></span>), and can be deleted with <span class="keycap"><strong>Delete</strong></span>, or moved by
<span class="emphasis"><em>dragging</em></span> (or <span class="keycap"><strong>Return</strong></span> followed by <span class="keycap"><strong>↑</strong></span>|<span class="keycap"><strong>↓</strong></span>|<span class="keycap"><strong>←</strong></span>|<span class="keycap"><strong>→</strong></span> movements) the notes to a new location. This
allows notes to be moved between different instruments, or to adjust their
timing. Movement in the horizontal direction is constrained by the currently selected grid
<a class="link" href="#chpt.pattern_editor.controls.res">resolution</a>, however this can be overridden by holding down <span class="keycap"><strong>Alt</strong></span> while moving notes.
</p><p>
Moving a selection of notes with <span class="keycap"><strong>Ctrl</strong></span> held down will copy
them to the new location rather than moving, as in the Song Editor.
</p><p>
Selected notes can also be copied to the clipboard with <span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>C</strong></span>, and pasted with <span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>V</strong></span>. When pasting, the relative positions of the input cursor at
the time of the Copy and Paste operation will set the new position of pasted notes.
</p><p>So far we have only used the mouse or keyboard editing to create a pattern, but you can also <a class="link" href="#chpt.overview.recording" title="4.4. Recording in Hydrogen">record</a> your beats. This is probably
a more musical way of creating a pattern, but it's up to you to decide what works best for you.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
Also see <a class="xref" href="#chpt.create_song" title="Chapter 18. A New Song">Chapter 18</a> for a basic
walk-through of how the Pattern Editor works.
</p></td></tr></table></div><p>
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.pattern_editor.note_properties"></a>9.3. Note Properties Editor</h2></div></div></div><div class="figure"><a name="fig.note_properties_ruler"></a><p class="title"><b>Figure 9.5. The Note Properties Ruler set to Velocity</b></p><div class="figure-contents"><div class="mediaobject"><img src="img/NotePropertiesRuler.png" alt="The Note Properties Ruler set to Velocity"></div></div></div><br class="figure-break"><p>Clicking on an instrument or adding/removing a note associated
will select this instrument. Once an instrument is selected all note properties
of its notes will be shown in the form of vertical lines in the bottom window.
The lines represent the values for the selected property of each note of the selected instrument.
You can select a different note-property from the note property drop-down list (located bottom-left).
</p><p>
The following note properties are available:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: opencircle; "><li class="listitem" style="list-style-type: circle"><p><a name="chpt.pattern_editor.note_properties.velocity"></a><span class="bold"><strong><a class="link" href="#def.velocity" title="Velocity">Velocity</a></strong></span>: how hard the note is
played (the volume of the note). This property also determines which sample of the instrument will be <a class="link" href="#chpt.instrument_editor.layers.sample_selection" title="11.2.3. Sample Selection">selected</a>.</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The color of the vertical bar will change according to the velocity value you have defined.
A light shade of gray means a low velocity (low volume) and the higher you set the velocity the darker the color will be,
turning red when you reach the point of <a class="link" href="#def.clipping" title="Clipping">clipping</a>.
</p></td></tr></table></div></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.pattern_editor.note_properties.pan"></a><span class="bold"><strong><a class="link" href="#def.pan" title="Pan">Pan</a></strong></span>: with this property you can move
the stereo image position of the note (how loud it will be in the
left/right output).</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
For a detailed description of how this Pan value does interact with the <a class="link" href="#chpt.mixer.channel_strips.pan">instrument Pan</a> and the <a class="link" href="#chpt.mixer.master_fader_strip.mixer_settings" title="13.4.2. Mixer Settings">Pan Laws</a> in the Mixer please see <a class="xref" href="#def.pan" title="Pan">Pan</a>.
</p></td></tr></table></div></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.pattern_editor.note_properties.lead_and_lag"></a>
<span class="bold"><strong>Lead/Lag</strong></span>: Lead and Lag allows a slight note
lead or lag in respect of the actual beat. The range is ca. 5 ticks (ca. 1/10 of quarter notes) which
equals around ca. 10 ms at a tempo of 120bpm. Changing the lead/lag can make a huge
difference to the way your pattern sounds and feels. It's a groove thing ;-)
</p></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.pattern_editor.note_properties.notekey"></a>
<span class="bold"><strong>NoteKey</strong></span>: if you select this note parameter the
area where you can modify the parameter will change into a 'piano keyboard'
</p><div class="figure"><a name="fig.NoteKey"></a><p class="title"><b>Figure 9.6. The Note Properties Ruler showing the NoteKey Property</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/NoteKey.png" alt="The Note Properties Ruler showing the NoteKey Property"></div></div></div><br class="figure-break"><p>
The striped black and white area represents a piano keyboard and in the gray
area you can choose the octave. By moving the dots on the
octave scale and the 'keyboard', you can choose any note
value.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Note that the <a class="link" href="#chpt.pattern_editor.piano_mode" title="9.4. Piano Roll Editor">Piano Roll Editor</a> can also be used to
change the note value of existing notes.
</p></td></tr></table></div></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>Probability</strong></span>: changing the
Probability property of a note provides a way for Hydrogen
to automatically create some variation in patterns. By
setting the probability to less than <code class="option">1.0</code>, a note may be
randomly skipped: a note with probability <code class="option">1.0</code> will
<span class="emphasis"><em>always</em></span> be played, a note with
probability of <code class="option">0.0</code> will <span class="emphasis"><em>never</em></span> be
played.
</p></li></ul></div><p>
<span class="emphasis"><em>Clicking</em></span> or <span class="emphasis"><em>dragging</em></span> the value lines in the Note Properties Editor will
set the property value. But often you'll want to set the properties of
several notes at once, so there are a few ways to do this.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="bold"><strong>Drawing with the mouse:</strong></span></p><p>
Pressing the mouse button over the first note's property, you can
hold down the mouse button and <span class="emphasis"><em>drag</em></span> over multiple notes. This is
great for quickly creating a crescendo from a filled set of notes.
</p></li><li class="listitem"><p><span class="bold"><strong>
Selecting multiple notes:</strong></span>
</p><p>
The mouse or keyboard can be used to select multiple notes, which
can then be modified all together by <span class="emphasis"><em>dragging</em></span> them together. This
can be useful for creating really consistent quiet grace notes. Alternatively, you can use the <span class="emphasis"><em>mouse wheel</em></span> for a coarse adjustment or combine it with a pressed <span class="keycap"><strong>Ctrl</strong></span> key for fine adjustments.
</p></li></ul></div><p>
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.pattern_editor.piano_mode"></a>9.4. Piano Roll Editor</h2></div></div></div><div class="figure"><a name="fig.PatternEditor_PianoMode"></a><p class="title"><b>Figure 9.7. Pattern Editor in Piano Mode</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/PatternEditor_PianoMode.png" alt="Pattern Editor in Piano Mode"></div></div></div><br class="figure-break"><p>
The Pattern Editor can be used as Piano Roll Editor pressing the <a class="link" href="#chpt.pattern_editor.controls.input">Input</a> button.
</p><p>While the <a class="link" href="#chpt.pattern_editor.drumkit" title="9.2. Drum Pattern Editor">Drumkit Editor</a> focuses on using Hydrogen as a drum machine, you can also use it an instrument via the Piano Roll Editor.
It gives you a complete 'piano keyboard' so you can easily put down your tunes.</p><p>You can compare the Piano mode to the <a class="link" href="#chpt.pattern_editor.note_properties.notekey">NoteKey</a> property in the Note Properties Editor. Only here you have a
complete piano keyboard, so you don't have to select the octave
first.</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
When entering multiple notes in one column - as a chord - the corresponding symbol in the <a class="link" href="#chpt.pattern_editor.drumkit" title="9.2. Drum Pattern Editor">Drumkit Editor</a> will be prepended with e.g. a <code class="option">3x</code> to indicate the presence of three separate notes. Also, to adjust the note properties of the individual notes within a chord can be done by <span class="emphasis"><em>right-clicking</em></span> on the note and <span class="emphasis"><em>dragging</em></span> the mouse up or down.
</p></td></tr></table></div></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.sound_library"></a>Chapter 10. Sound Library (Drumkit/Pattern/Song Manager)</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#chpt.sound_library.drumkits">10.1. Drumkits</a></span></dt><dt><span class="sect1"><a href="#sect.sl.songs">10.2. Songs</a></span></dt><dt><span class="sect1"><a href="#sect.sl.patterns">10.3. Patterns</a></span></dt></dl></div><div class="figure"><a name="fig.soundlibrary"></a><p class="title"><b>Figure 10.1. The Soundlibrary</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/SoundLibrary.png" alt="The Soundlibrary"></div></div></div><br class="figure-break"><p>The Sound Library helps you manage your drumkits,
favourite patterns, and favourite songs. When making new songs or drum
kits, it allows you to reuse and mix instruments and patterns from other kits and songs.
</p><p>
It is located in the Instrument Rack in the lower right corner of Hydrogen, which can be shown or hidden via the <a class="link" href="#sect.main_menu.view" title="6.5. View">View</a> option in the Main Menu or via the <a class="link" href="#sect.main_toolbar.gui_state" title="7.6. GUI State">corresponding button</a> in the Main Toolbar. The Instrument Rack does either show the <a class="link" href="#chpt.instrument_editor" title="Chapter 11. Instrument Editor">Instrument Editor</a> or the Sound Library depending on what is chosen in the <a class="link" href="#sect.main_menu.view" title="6.5. View">View</a> option in the Main Menu or the corresponding buttons at the top of the Instrument Rack.
</p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.sound_library.drumkits"></a>10.1. Drumkits</h2></div></div></div><p>The list of drumkits comprises both the kits present at system level and the ones at user level.</p><p>
The <span class="bold"><strong>System drumkits</strong></span> are those installed with your package manager or when <a class="link" href="#chpt.compilation" title="Chapter 2. Build">compiling</a> Hydrogen manually. Their location is determined by the compile-time prefix. On
Unix-like operating systems, this is usually <code class="filename">/usr/share/hydrogen/data/drumkits</code>, or
possibly <code class="filename">/usr/local/share/hydrogen/data/drumkits</code>.
These kits are available to all users on the system, and you usually have no write access to them.</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
You can still modify those kids by saving a tweaked version as a user level kit.
</p></td></tr></table></div><p>The <span class="bold"><strong>User drumkits</strong></span> are those which you can manage yourself. They
are stored in the Hydrogen data
directory (usually <code class="filename">$HOME/.hydrogen/data/</code>) within the <code class="filename">drumkits</code>
folder. When you have
created a new drumkit via <a class="link" href="#sect.main_menu.drumkits.new">New</a> in the Drumkit option of the Main Menu, you can save it using <a class="link" href="#sect.main_menu.drumkits.save_as">Save As</a> from the same menu. In addition, you can also <a class="link" href="#sect.main_form.online_import_drumkit">Online Import</a> a number of drumkits provided by the dev team of Hydrogen.
</p><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>If you are using Hydrogen for commercial purposes, (creating songs and
selling these online or in any other way) you need to pay special attention to the
license type of the drumkit(s) you are using.
</p><p>
If the exact license is not available for a drumkit, do <span class="bold"><strong>not</strong></span> assume that it is a <a class="ulink" href="https://creativecommons.org/about/cclicenses/" target="_top">Creative Commons (CC)</a> or
other open and free license.
</p><p>
Even if the kit is CC licensed you should always check with the author before using
the kit in your songs.
</p><p>DISCLAIMER : Hydrogen is not responsible for the drumkits that are
made available for download by our users, either via the <a class="ulink" href="hydrogen-music.org" target="_top">hydrogen-music.org</a> or
via any other channel.</p></td></tr></table></div><p>To <span class="bold"><strong>load a drumkit</strong></span> via the Sound Library, <span class="emphasis"><em>right-click</em></span> the drumkit and select
<em class="parameter"><code>Load</code></em>. This will replace your current drumkit
with the one that you selected. To <span class="bold"><strong>load a single instrument</strong></span> from that
kit, <span class="emphasis"><em>left-click</em></span> the <code class="option">▶</code> to the left of the
drumkit's name to show all the instruments. With your left mouse
button, <span class="emphasis"><em>click</em></span> and <span class="emphasis"><em>drag</em></span> the instrument into your current kit. The
instrument will be added to the drumkit that you currently have
loaded.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.sl.songs"></a>10.2. Songs</h2></div></div></div><p>To access songs via the Sound Library, you have to put them within the Hydrogen data
directory (usually <code class="filename">$HOME/.hydrogen/data/</code>) into the <code class="filename">songs</code>
folder.
To remove them, remove the file from that folder.</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.sl.patterns"></a>10.3. Patterns</h2></div></div></div><p>To access patterns via the Sound Library, you have to put them within the Hydrogen data
directory (usually <code class="filename">$HOME/.hydrogen/data/</code>) into the <code class="filename">patterns</code>
folder.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This is done automatically when using the <a class="link" href="#chpt.song_editor.sidebar.save_pattern">Save Pattern</a> option in the Sidebar of the Song Editor but not when using <a class="link" href="#chpt.song_editor.sidebar.export_pattern">Export Pattern</a> via the same Sidebar or <a class="link" href="#sect.main_menu.projects.export_pattern_as">Export Pattern As</a> in the Project option of the Main Menu.
</p></td></tr></table></div><p>
</p><p>Before you save a pattern, be
sure to give it a title and a category. This can be done by <span class="emphasis"><em>right-clicking</em></span> on the pattern in the Sidebar of the Song Editor, selecting
<a class="link" href="#chpt.song_editor.sidebar.properties">Properties</a> and entering the details.
You can use one of the categories already
provided, or create your own categories by simply typing in a category
name. The category name is important, because the patterns will be
filed by category in the Sound Library.</p></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.instrument_editor"></a>Chapter 11. Instrument Editor</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#chpt.instrument_editor.general">11.1. General</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.instrument_editor.envelope_parameters">11.1.1. Envelope Parameters</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.gain_and_mute_group">11.1.2. Gain and Mute Group</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.filter">11.1.3. Filter Parameters</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.pitch_shift_parameters">11.1.4. Pitch Shift Parameters</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.midi_out_settings">11.1.5. <abbr class="abbrev">MIDI</abbr> Out Settings</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.HH_pressure_group">11.1.6. Hi-Hat Pressure Group</a></span></dt></dl></dd><dt><span class="sect1"><a href="#chpt.instrument_editor.layers">11.2. Layers</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.instrument_editor.layers.components">11.2.1. Components</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.layers.layers">11.2.2. Layers</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.layers.sample_selection">11.2.3. Sample Selection</a></span></dt><dt><span class="sect2"><a href="#chpt.instrument_editor.layers.controls">11.2.4. Controls</a></span></dt></dl></dd></dl></div><div class="figure"><a name="instrumenteditor.general"></a><p class="title"><b>Figure 11.1. The Instrument editor General view</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/Instrument_General.png" alt="The Instrument editor General view"></div></div></div><br class="figure-break"><p>
The Instrument Editor is located in the Instrument Rack in the lower right corner of Hydrogen, which can be shown or hidden via the <a class="link" href="#sect.main_menu.view" title="6.5. View">View</a> option in the Main Menu or via the <a class="link" href="#sect.main_toolbar.gui_state" title="7.6. GUI State">corresponding button</a> in the Main Toolbar. The Instrument Rack does either show the <a class="link" href="#chpt.instrument_editor" title="Chapter 11. Instrument Editor">Instrument Editor</a> or the Sound Library depending on what is chosen in the <a class="link" href="#sect.main_menu.view" title="6.5. View">View</a> option in the Main Menu or the corresponding buttons at the top of the Instrument Rack.
</p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.instrument_editor.general"></a>11.1. General</h2></div></div></div><p>When clicking the <code class="option">General</code> button in the Instrument Editor you can adjust several
parameters that apply to the particular instrument (and all its <a class="link" href="#def.layer" title="Layer">layers</a>) selected in the <a class="link" href="#chpt.pattern_editor.sidebar" title="9.1.2. Sidebar">Sidebar</a> of the Pattern Editor.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>It's important that you understand <a class="link" href="#chpt.overview.drumkits" title="4.2. Drumkit Concept">Drumkit Concepts</a> and a couple of basic concepts of sound synthesis described in the <a class="link" href="#glossary" title="Glossary">Glossary</a> in order to continue
on. To ease reading, several of the latter concepts are linked in the text.</p></td></tr></table></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.instrument_editor.envelope_parameters"></a>11.1.1. Envelope Parameters</h3></div></div></div><div class="informalfigure"><a name="fig.instrument_editor.envelope_parameters"></a><div class="mediaobject"><img src="generated_en/instrument_editor_envelope.png" alt='Four rotaries are displayed. From left to right: "ATTACK", "DECAY", "SUSTAIN", and "RELEASE".'></div></div><p>When a note associated with this instrument is triggered, its volume is run through an
<a class="link" href="#def.adsr" title="ADSR">ADSR Envelope</a>. Its particular settings can be adjusted using the envelope parameters located right below the instrument name.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a name="chpt.instrument_editor.general.attack"></a><span class="bold"><strong><a class="link" href="#def.attack" title="Attack">Attack</a></strong></span>: the amount
of <span class="emphasis"><em>time</em></span> that the volume of the <a class="link" href="#def.sample" title="Sample">sample</a> goes
from 0 to the full <a class="link" href="#def.velocity" title="Velocity">velocity</a> of the note. If the value is 0, the
sample will play back immediately at full velocity. If the value is
1.0, the sample volume will use the maximum time available for the
attack phase.
</p></li><li class="listitem"><p><a name="chpt.instrument_editor.general.decay"></a><span class="bold"><strong><a class="link" href="#def.decay" title="Decay">Decay</a></strong></span>: the amount of
<span class="emphasis"><em>time</em></span> for the volume of the <a class="link" href="#def.sample" title="Sample">sample</a> to go from
full <a class="link" href="#def.velocity" title="Velocity">velocity</a> down to the sustain volume. If the value is 0, the
sample will immediately skip from the full velocity to the <a class="link" href="#def.sustain" title="Sustain">sustain</a>
volume. If the value is 1.0, the sample volume will use the
maximum time available for the decay parameter.</p></li><li class="listitem"><p><span class="bold"><strong><a class="link" href="#def.sustain" title="Sustain">Sustain</a></strong></span>: the
<span class="emphasis"><em>volume</em></span> to play the note after the <a class="link" href="#def.decay" title="Decay">decay</a> phase
is over, and until the note is released. If set to 0, the note
will be silent. If set to 1.0, the note will play at full
<a class="link" href="#def.velocity" title="Velocity">velocity</a>.</p></li><li class="listitem"><p><a name="chpt.instrument_editor.general.release"></a><span class="bold"><strong><a class="link" href="#def.release" title="Release">Release</a></strong></span>: the
<span class="emphasis"><em>time</em></span> to fade out the note from the <a class="link" href="#def.sustain" title="Sustain">sustain
volume</a> back down to 0 (silent). If set to 0, the note will fade
out in the minimum amount of time (about 5 ms). If set to 1, it
will fade out for the maximum time available.</p></li></ul></div><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left"><a name="fn.adsrtimes"></a>Note</th></tr><tr><td align="left" valign="top"><p>The <a class="link" href="#chpt.instrument_editor.general.attack">Attack</a>, <a class="link" href="#chpt.instrument_editor.general.decay">Decay</a>, and <a class="link" href="#chpt.instrument_editor.general.release">Release</a> parameters are all set by
the number of <a class="link" href="#def.sample" title="Sample">audio samples</a>. This means
that the time changes depending on the sample rate of your sound
card. The max time for each of them is 100,000 audio samples
(type. 2.27 sec at 44.1 kHz).</p></td></tr></table></div><p>If the <a class="link" href="#def.sample" title="Sample">sample</a> is shorter than the times that you specify, the
sample will end, regardless of which phase of the <a class="link" href="#def.adsr" title="ADSR">ADSR</a> it is in. If
the note is sustained, it does <span class="emphasis"><em>not</em></span> draw out the
note while you are holding it. It only holds the <a class="link" href="#def.gain" title="Gain">gain</a> (volume)
parameter during that time.
</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.instrument_editor.gain_and_mute_group"></a>11.1.2. Gain and Mute Group</h3></div></div></div><div class="informalfigure"><a name="fig.instrument_editor.gain_and_mute_group"></a><div class="mediaobject"><img src="generated_en/instrument_editor_mute_group.png" alt='In the upper half there is a LCD displaying "1.00" (left) next to a rotary titled "GAIN" (middle) and a LCD with corresponding decrease and increase buttons (right) titled "MUTE GROUP". In the lower part there are two checkboxes: "AUTO-STOP-NOTE" (left) and "APPLY-VELOCITY" (right).'></div></div><p>The <span class="bold"><strong><a class="link" href="#def.gain" title="Gain">Gain</a></strong></span> adjusts the overall volume of all <a class="link" href="#def.sample" title="Sample">samples</a> associated with this Instrument. This Gain is
applied in addition to the one you set for each <a class="link" href="#chpt.instrument_editor.layers.controls.layer_gain">layer</a> and before the one
that is set in the <a class="link" href="#chpt.mixer.channel_strips.fader_and_lcd">Instrument Channel Strips</a>. If the
set to <code class="option">0</code>, the instrument will be
silent. If the Gain is <code class="option">1.0</code>, the volume of the samples will not be
adjusted. If the Gain is set higher, the samples will be
amplified.</p><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>It is very easy to set the <span class="guibutton">Gain</span> too
high, causing your sample to <a class="link" href="#def.clipping" title="Clipping">clip</a>. Remember to test the Gain with
full-<a class="link" href="#def.velocity" title="Velocity">velocity</a> notes. If you clip your signal here, it will only get
worse as Hydrogen processes it.</p></td></tr></table></div><p>Hydrogen provides more <span class="bold"><strong><a class="link" href="#def.mutegroup" title="Mute Group">Mute Groups</a></strong></span> than you know what to do with
(over 256). A Mute Group is a grouping of instruments which's playback is
mutually exclusive - only one instrument of the group may be playing at a
time. If one is playing and another instrument in the group is
triggered, the former will immediately be silence (<a class="link" href="#def.mute" title="Mute">muted</a>) and the latter starts playing. This is useful, especially, for instruments like
hi-hats where the opened and closed sound are incorporated into the drumkit as different
instruments.</p><p>If the Mute Group is set to <code class="option">Off</code>, then the
instrument is not part of any mute grouping. If the Mute Group is set
to any number, then that is the group that the instrument is a part
of. To set other instruments into the same grouping, set their Mute
Group parameter to the same number. (For example, to group all the
high-hat instruments, you can set all their Mute Group parameters to
<code class="option">1</code>. To have a snare drum Mute Group, set their Mute Group parameters
to <code class="option">2</code>.)
</p><p>If the <span class="bold"><strong>Auto-Stop-Note</strong></span> box is checked, Hydrogen will immediately stop any playing <a class="link" href="#def.sample" title="Sample">samples</a>
belonging to this instrument whenever the instrument is re-triggered, e.g. by another note.</p><p>This option is particularly useful when you are using long samples like a
crash or some existing audio that you have sampled (like a looped voice in a
dance/electro song). For the crash you will need to use the Auto Stop-Note when
you are sequencing multiple notes in fast succession and want to make it sound realistic. If you do
not check this option the cymbal will start to sound like multiple cymbals
instead of only one (since the sample of each individual hit will be played completely).
For the voice sample this option is useful if you are trying to get that 'stuttering' effect.
</p><p>
The <span class="bold"><strong>Apply Velocity</strong></span> box lets the user decide whether Hydrogen should apply the note <a class="link" href="#def.velocity" title="Velocity">velocity</a> to the <a class="link" href="#def.sample" title="Sample">sample</a> being played.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
The note velocity can set it the <a class="link" href="#chpt.pattern_editor.note_properties.velocity">Note Properties Editor</a>.
</p></td></tr></table></div><p>
When activated, Hydrogen will apply the note velocity to the sample gain in addition to the <a class="link" href="#chpt.instrument_editor.layers.controls.layer_gain">layer gain</a>,
the <a class="link" href="#chpt.instrument_editor.gain_and_mute_group" title="11.1.2. Gain and Mute Group">instrument gain</a>, the <a class="link" href="#chpt.instrument_editor.layers.controls.component_volume">component gain</a>, or the <a class="link" href="#chpt.mixer.channel_strips.fader_and_lcd">instrument volume</a>.
If all the <a class="link" href="#def.layer" title="Layer">layer</a> samples are <a class="link" href="#def.normalization" title="Normalization">normalized</a>, this option should be used.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
By default this option will be selected as this is the way older versions of Hydrogen used to work.
</p></td></tr></table></div><p>
When not activated, the note velocity will only be used to <a class="link" href="#chpt.instrument_editor.layers.sample_selection" title="11.2.3. Sample Selection">select</a> the sample to be played,
but the sample gain itself will not be changed.
This is useful for set of samples that already have their gain "hard-coded".
</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.instrument_editor.filter"></a>11.1.3. Filter Parameters</h3></div></div></div><div class="informalfigure"><a name="fig.instrument_editor.filter"></a><div class="mediaobject"><img src="generated_en/instrument_editor_filter.png" alt='From left to right: a button titled "BYP", a rotary titled "CUTOFF", and another one titled "RESONANCE".'></div></div><p>The filter used in here is a <a class="link" href="#def.lowpassfilter" title="Low-Pass Filter">low-pass</a> <a class="link" href="#def.resonancefilter" title="Resonance Filter">resonance filter</a>. If you don't wish to
use is, click the <code class="option">BYP</code> button (bypass) so that it's
red. If it's not red, then the filter is active. The <a class="link" href="#def.cutoff" title="Cutoff Frequency">cutoff</a>
parameter adjusts the cutoff frequency for the filter. The <a class="link" href="#def.resonance" title="Resonance">resonance</a>
parameter adjusts how much to boost to provide at the cutoff frequency. If the
resonance is set to <code class="option">0</code>, then the filter is just a simple low-pass
filter.</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>The cutoff frequency of the filter varies with the sample rate
of your audio card. The range of the knob <code class="option">0</code> to <code class="option">1.0</code>) is optimized
for a 48,000 kHz sample rate.</p></td></tr></table></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.instrument_editor.pitch_shift_parameters"></a>11.1.4. Pitch Shift Parameters</h3></div></div></div><div class="informalfigure"><a name="fig.instrument_editor.pitch_shift_parameters"></a><div class="mediaobject"><img src="generated_en/instrument_editor_pitch.png" alt='From left to right: a LCD displaying the total pitch and three rotaries titled "PITCH", "FINE", and "RANDOM".'></div></div><p> The first two knobs control the pitch shift offset.
You can use it to change the tuning of the instrument.
<span class="bold"><strong>Pitch</strong></span> is the <span class="emphasis"><em>Coarse</em></span> control and has quantized steps of half-tones from <code class="option">-24</code> to <code class="option">+24</code>.
<span class="bold"><strong>Fine</strong></span> is the <span class="emphasis"><em>Fine</em></span> control and has quantized steps of cents of half-tones from <code class="option">-0.50</code> to <code class="option">+0.50</code>.
</p><p>The <span class="bold"><strong>Random</strong></span> parameter allows you to randomly vary the pitch
of the <a class="link" href="#def.sample" title="Sample">sample</a> every time it is triggered. The value is set between <code class="option">0</code>
and <code class="option">1.0</code>.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The pitch change is fairly small, almost always between 1 half-steps
⨉ value. Using this sparingly can help your sequences to sound
more like a real drummer.
</p></td></tr></table></div><p>
</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.instrument_editor.midi_out_settings"></a>11.1.5. <abbr class="abbrev">MIDI</abbr> Out Settings</h3></div></div></div><div class="informalfigure"><a name="fig.instrument_editor.midi_out_settings"></a><div class="mediaobject"><img src="generated_en/instrument_editor_midi_out.png" alt='Two LCDs with corresponding decrease and increase buttons. The left one is titled "CHANNEL" and the right one "NOTE".'></div></div><p>Hydrogen is capable of generating <abbr class="abbrev">MIDI</abbr> messages that you can use
to trigger any external <abbr class="abbrev">MIDI</abbr> device or application. To do this, you
simply need to configure the <abbr class="abbrev">MIDI</abbr> output <span class="bold"><strong>Channel</strong></span> and <span class="bold"><strong>Note</strong></span> for every
instrument. You need to have a sample loaded (an empty WAV file is
fine) and make sure the proper <abbr class="abbrev">MIDI</abbr> routing/wiring is in place and
you're set. As you can see this is a very flexible approach that
enables you to trigger samples or sounds from multiple devices and/or
apps.</p><p>From now on every time a note is played for that instrument (in the Hydrogen sequencer)
a <abbr class="abbrev">MIDI</abbr> message will be sent to your external app/device and trigger a sound.
This way you can use Hydrogen as a pure sequencer for other apps, or combine the
internal Hydrogen sampler with multiple external apps/devices.</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
By enabling <span class="bold"><strong>Use output note as input</strong></span> in the <a class="link" href="#chpt.preferences.midi_tab" title="5.3. MIDI System"><abbr class="abbrev">MIDI</abbr> system</a> tab of the Preferences dialog the number specified in the <span class="bold"><strong>Note</strong></span> field will also be used to associate the current instrument with the corresponding incoming <abbr class="abbrev">MIDI</abbr> messages.
</p></td></tr></table></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.instrument_editor.HH_pressure_group"></a>11.1.6. Hi-Hat Pressure Group</h3></div></div></div><div class="informalfigure"><a name="fig.instrument_editor.HH_pressure_group"></a><div class="mediaobject"><img src="generated_en/instrument_editor_hihat_pressure_group.png" alt='Three LCDs with corresponding decrease and increase buttons titled "HH PRESS. GRP", "MIN. RANGE", and "MAX RANGE" (from left to right).'></div></div><p>The hi-hat is a particular instrument of the drumkit as its sound can be changed by pressing the foot pedal.
</p><p>For e-drum owners, the hi-hat pressure group enables to group different hi-hat instruments
together, for example closed, half closed, fully open.
</p><p><span class="bold"><strong>Pressure Group</strong></span>: you can assign more instruments to the same group.
You can create many groups. For example one group for the different opening levels of a hi-hat when playing
the top of it, another group when playing the edge.
Another example: timpanis - create a group for each timpani and the pressure will change the note.
</p><p><span class="bold"><strong>Range</strong></span>: set the minimum and maximum pressure for each instrument.
Each instrument of a given group should seat in its own separate pressure range.
The range will decide at what pressure level the instrument will be played.
For example, if your closed hi-hat has range from <code class="option">0</code> to <code class="option">20</code>,
when the hi-hat pedal is pressed between <code class="option">0</code> and <code class="option">20</code> the closed hi-hat is played.
</p></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.instrument_editor.layers"></a>11.2. Layers</h2></div></div></div><div class="figure"><a name="instrumenteditor.layers"></a><p class="title"><b>Figure 11.2. The Instrument Editor Layers View</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/Instrument_Layers.png" alt="The Instrument Editor Layers View"></div></div></div><br class="figure-break"><p>When clicking the <code class="option">Layers</code> button in the Instrument Editor you can adjust the <a class="link" href="#def.sample" title="Sample">samples</a> and synthesizer parameters of the particular <a class="link" href="#def.layer" title="Layer">layers</a> of the instrument selected in the <a class="link" href="#chpt.pattern_editor.sidebar" title="9.1.2. Sidebar">Sidebar</a> of the Pattern Editor.
</p><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.instrument_editor.layers.components"></a>11.2.1. Components</h3></div></div></div><div class="informalfigure"><a name="fig.instrument_editor.layers.components"></a><div class="mediaobject"><img src="img/InstrumentEditorLayersComponents.png" alt="In the center you can find the name of the Drumkit component and at the right end a button to open a context menu."></div></div><p>
Right below the <code class="option">General</code> and <code class="option">Layers</code> button you find the name of the currently selected <a class="link" href="#def.component" title="Component">component</a>. In the drop down menu accessible by pressing
<span class="inlinemediaobject"><img src="img/btn_dropdown_off.png" alt="Grey button with a black filled triangle pointing downwards."></span>
you find a list of all components available in the current drumkit and can select them via a <span class="emphasis"><em>left click</em></span>. Below a separator you can also find three options to <code class="option">add</code> a new component, <code class="option">delete</code> the current one, or <code class="option">rename</code> the current one.
</p><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>
The components are shared by all instruments. This means deleting it will delete it including all associated layers from a <span class="emphasis"><em>all</em></span> instruments and not just the currently selected one.
</p></td></tr></table></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.instrument_editor.layers.layers"></a>11.2.2. Layers</h3></div></div></div><div class="figure"><a name="fig.instrument_editor.layers.layers"></a><p class="title"><b>Figure 11.3. The Layer Section of the Instrument Editor</b></p><div class="figure-contents"><div class="mediaobject"><img src="img/InstrumentEditorLayersLayers.png" alt="The Layer Section of the Instrument Editor"></div></div></div><br class="figure-break"><p>
Next you find a listing of all layers of the current component in the selected instrument. The wave form of the sample loaded to the currently selected layer (the one enclosed by a red rectangle) is displayed below.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Empty layers will be displayed as <code class="option">< - ></code>.
</p></td></tr></table></div><p>
Using
<span class="inlinemediaobject"><img src="generated_en/loadLayer_off.png" alt='Grey button containing the black characters "LOAD LAYER".'></span>
you can load a sample into the currently selected layer, using
<span class="inlinemediaobject"><img src="generated_en/deleteLayer_off.png" alt='Grey button containing the black characters "DELETE LAYER".'></span>
you can delete the current layer, and using
<span class="inlinemediaobject"><img src="generated_en/editLayer_off.png" alt='Grey button containing the black characters "EDIT LAYER".'></span>
you can open the <a class="link" href="#chpt.sample_editor" title="Chapter 12. Sample Editor">Sample Editor</a> to customize the sample loaded to the currently selected layer.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
Alternatively you can also <span class="emphasis"><em>double-click</em></span> the wave display to open the <a class="link" href="#chpt.sample_editor" title="Chapter 12. Sample Editor">Sample Editor</a>.
</p></td></tr></table></div><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
When loading a sample it will per-default have its active area set to the whole velocity range. By checking the <span class="bold"><strong>Set auto velocity</strong></span> option all layers will be assigned an equally sized velocity range corresponding to their layer number (the top-most layer will have a range starting a zero velocity and the bottom-most one that ends at maximum velocity). Note however that this option will overwrite all existing velocity ranges.
</p></td></tr></table></div><p>
Above the layer listing you find boxes in different shades of grey indicating which range of note <a class="link" href="#def.velocity" title="Velocity">velocity</a> will trigger which sample (left: 0 velocity, right: maximum velocity). <span class="emphasis"><em>Left-clicking</em></span> on any of these boxes will play back the sound of associated sample modulated by the velocity corresponding to the horizontal position of the mouse cursor.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
This will be quite handy when adjusting the velocity ranges of the layers.
</p></td></tr></table></div><p>
</p><p>
You might have already noticed in the picture above or for shipped drumkits in the Hydrogen GUI that a layer row contains a light blue rectangle that those not quite fill the whole row. This rectangle indicates the range in velocity the associated sample should be triggered. This way you can separate samples for soft hits, regular hits, and so on for each instrument (component). Whenever two rectangles do overlap a triggered note with a velocity within this shared range will consult the <a class="link" href="#chpt.instrument_editor.layers.sample_selection" title="11.2.3. Sample Selection">Sample Selection</a> to determine which sample will be played back. You can adjust the velocity ranges of each layer by <span class="emphasis"><em>left-clicking</em></span> the left or right end of the light blue rectangles and <span class="emphasis"><em>dragging</em></span> it to the desired position.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
If there is a(n accidental) hole between two adjacent velocity ranges, the layer closest to the triggered velocity will be used.
</p></td></tr></table></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.instrument_editor.layers.sample_selection"></a>11.2.3. Sample Selection</h3></div></div></div><div class="informalfigure"><a name="fig.instrument_editor.layers.sample_selection"></a><div class="mediaobject"><img src="img/InstrumentEditorLayersSampleSelection.png" alt='A LCD titled "SAMPLE SEL." with a button to open display the different choices to the right.'></div></div><p>
Having a set of samples containing different sample versions of similar sound for the same note velocity is a good way to make your drumkit sound more natural. After all, drummers for example never hit the drum set twice the exact same way.
</p><p>
Hydrogen tries to emulate this behavior by providing multiple <a class="link" href="#chpt.instrument_editor.layers.layers" title="11.2.2. Layers">layers</a> with overlapping velocity ranges. <span class="emphasis"><em>How</em></span> the selection of the resulting sample will take place is for you to decide using the <span class="bold"><strong>Sample Sel.</strong></span> dropdown menu at the bottom of the Instrument Editor.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="option">First in Velocity</code>:
will select the first sample available in the velocity set - the one of the layer most further down in the layer listing.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This is the way previous versions of Hydrogen were working.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p><code class="option">Round Robin</code>:
will cycle through the different samples one after another as note a in the same velocity range are played.
</p></li><li class="listitem"><p> <code class="option">Random</code>:
will select a random sample inside the velocity range for each note played.
</p></li></ul></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.instrument_editor.layers.controls"></a>11.2.4. Controls</h3></div></div></div><div class="informalfigure"><a name="fig.instrument_editor.layers.controls"></a><div class="mediaobject"><img src="img/InstrumentEditorLayersControls.png" alt='Four rotaries with corresponding LCDs: "L. GAIN" (top left), "C. VOLUME" (top right), "PITCH" (bottom left), and "FINE" (bottom right).'></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a name="chpt.instrument_editor.layers.controls.layer_gain"></a>
<span class="bold"><strong>Layer Gain</strong></span>:
adds <a class="link" href="#def.gain" title="Gain">Gain</a> for the currently selected layer and the associated sample.
</p></li><li class="listitem"><p><a name="chpt.instrument_editor.layers.controls.component_volume"></a>
<span class="bold"><strong>Component Volume</strong></span>:
adjusts the volume of all layers within the current component with respect to the ones of the other instruments.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
The resulting audio from all layers of each instrument associated with a certain component can be controlled via its <a class="link" href="#chpt.mixer.component_strips" title="13.2. Component Channel Strips">Component Channel Strip</a> in the Mixer.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Pitch</strong></span>:
adjusts the pitch of the currently selected layer and the associated sample in quantized steps of half-tones from <code class="option">-24</code> to <code class="option">+24</code>.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Fine</strong></span>:
adjusts the pitch of the currently selected layer and the associated sample in quantized steps of cents of half-tones from <code class="option">-0.50</code> to <code class="option">+0.50</code>.
</p></li></ul></div></div></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.sample_editor"></a>Chapter 12. Sample Editor</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#chpt.sample_editor.wave_display">12.1. Wave Display and Region Editing</a></span></dt><dt><span class="sect1"><a href="#chpt.sample_editor.pitch">12.2. Pitch Shifting</a></span></dt><dt><span class="sect1"><a href="#chpt.sample_editor.playback_and_envelope_editor">12.3. Playback and Envelope Editor</a></span></dt></dl></div><div class="figure"><a name="sample.editor"></a><p class="title"><b>Figure 12.1. The Sample Editor</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/SampleEditor_V5.png" alt="The Sample Editor"></div></div></div><br class="figure-break"><p>The Sample Editor allows you to tweak and manipulate your
samples. It can be accessed by selecting a layer in the <a class="link" href="#chpt.instrument_editor.layers" title="11.2. Layers">Instrument Editor</a> and clicking the
<span class="inlinemediaobject"><img src="generated_en/editLayer_off.png" alt='Grey button containing the black characters "EDIT LAYER".'></span>
button. It will really speed up the creation of a drumkit since
you can do the fine-tuning of the <a class="link" href="#def.sample" title="Sample">samples</a> within Hydrogen and avoid a lengthy import-test-tweak workflow using an external application. This mean less switching between Hydrogen and your audio editor
and more time to make music!</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>The changes you make to
your samples in the Sample Editor are <span class="bold"><strong>non-destructive
</strong></span> and are saved <span class="bold"><strong>per song</strong></span>.
So, the original sample will not be changed,
and you can reuse the same sample in multiple songs with different Sample Editor
settings.</p></td></tr></table></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.sample_editor.wave_display"></a>12.1. Wave Display and Region Editing</h2></div></div></div><div class="figure"><a name="fig.sample_editor.wave_display"></a><p class="title"><b>Figure 12.2. The Wave Display Section of the Sample Editor</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/SampleEditor_Wave.png" alt="The Wave Display Section of the Sample Editor"></div></div></div><br class="figure-break"><p>
In the <span class="bold"><strong>larger (left) wave display</strong></span> you can see the wave form of the sample you are about to edit. In there you can set the start, stop, and loop point for the sample by <span class="emphasis"><em>dragging</em></span> the
the 3 markers:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a name="chpt.sample_editor.wave_display.start_marker"></a><span class="bold"><strong>Start Marker (green)</strong></span>: labeled with a <code class="option">S</code> and indicates the beginning of the tweaked sample.</p></li><li class="listitem"><p><a name="chpt.sample_editor.wave_display.end_marker"></a><span class="bold"><strong>End Marker (red)</strong></span>: labeled with a <code class="option">E</code> and indicates the end of the tweaked sample.</p></li><li class="listitem"><p><a name="chpt.sample_editor.wave_display.loop_marker"></a><span class="bold"><strong>Loop Marker (blue)</strong></span>: labeled with a <code class="option">L</code> and determines the loop-in point of your sample.</p></li></ul></div><p>
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
You can easily move one of the markers by grabbing them close to the letter that marks them.
</p></td></tr></table></div><p>
Underneath you can find a numerical display of the position set for the individual markers as well as some further options. The position of the markers is expressed in number of
frames from the very beginning of the sample.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<span class="bold"><strong>Start</strong></span>: position of the <a class="link" href="#chpt.sample_editor.wave_display.start_marker">Start Marker</a>.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Loop</strong></span>: position of the <a class="link" href="#chpt.sample_editor.wave_display.loop_marker">Loop Marker</a>.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Loop Mode</strong></span>:
specifies the way the individual loops will be played back.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem"><p>
<code class="option">forward</code>: plays the <span class="emphasis"><em>Loop Count</em></span> loop passages the usual way from left to right.
</p></li><li class="listitem"><p>
<code class="option">reverse</code>: plays the <span class="emphasis"><em>Loop Count</em></span> loop passages the backwards (from right to left).
</p></li><li class="listitem"><p>
<code class="option">ping-pong</code>: plays the <span class="emphasis"><em>Loop Count</em></span> loop passages alternatively backwards and forwards (starting with backwards).
</p></li></ul></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Loop Count</strong></span>: indicates the number of times the sample will be repeated between Loop and the End Marker. This section will therefore be played back <span class="emphasis"><em>Loop Count + 1</em></span> times.
</p></li><li class="listitem"><p>
<span class="bold"><strong>End</strong></span>: position of the <a class="link" href="#chpt.sample_editor.wave_display.end_marker">End Marker</a>.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Close</strong></span>: exits the Sample Editor.
</p></li></ul></div><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
These values will change if you <span class="emphasis"><em>drag</em></span> the markers,
but you can also fine-tune the marker position by using the up/down arrows of the spinboxes,
the up/down keys on your keyboard, or by using your mouse scroll wheel while hovering
above the spinboxes.
</p></td></tr></table></div><p>
Whenever you move one of the markers you will see a detail
view of the position of that marker on the <span class="bold"><strong>smaller (right) wave display</strong></span> on the right, making it easy to
find the zero-crossings in the sample. This detail window also has a <span class="bold"><strong>slider</strong></span> next to
it that allows you to zoom in and out on the vertical axis. Think of it as a sort of
volume 'zoom'.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
If you want to hear a preview of the tweaking you have done so far, you first need to
press the <a class="link" href="#chpt.sample_editor.playback_and_envelope_editor.apply_changes">Apply Changes</a> and then the <a class="link" href="#chpt.sample_editor.playback_and_envelope_editor.play">Play</a> button (both at the bottom of the window) to
hear the result.
</p></td></tr></table></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.sample_editor.pitch"></a>12.2. Pitch Shifting</h2></div></div></div><div class="figure"><a name="fig.sample_editor.pitch_shift"></a><p class="title"><b>Figure 12.3. The Pitch Shifting Section of the Playlist Editor</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/SampleEditor_PitchShift.png" alt="The Pitch Shifting Section of the Playlist Editor"></div></div></div><br class="figure-break"><p>This section of the Sample Editor allows you to use <span class="bold"><strong>Rubber Band</strong></span> - a tool that can change the tempo of a sample without changing the sample's pitch (and vice versa) - to tweak your sample.</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
These options are only available if Rubber Band support was either compiled into Hydrogen or was properly configures in the <a class="link" href="#chpt.preferences.general_tab" title="5.1. General">General</a> tab of the Preferences.
After installing Rubber Band you should check if the path to the <span class="command"><strong>rubberband cli</strong></span> is
configured correctly (see <a class="xref" href="#chpt.preferences.general_tab" title="5.1. General">Section 5.1</a>). If neither is the case, all associated widgets will be disabled.
</p><p>
When <span class="bold"><strong>Sample length to beat</strong></span> is set to <code class="option">off</code> the whole Rubber Band functionality will be disabled.
</p></td></tr></table></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: opencircle; "><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Sample length to beat</strong></span>:
specifies the length of the resulting sample (after Rubber Band was applied to it). After choosing a value other than <code class="option">off</code> the length ratio between the original and the resulting sample will be displayed to the right of the combo box under <span class="bold"><strong>new sample length</strong></span>. To ease the process of finding a proper value, the checkbox will be highlighted <span class="emphasis"><em>green</em></span> if the length is more or less the same, <span class="emphasis"><em>yellow</em></span> if there are larger changes, and <span class="emphasis"><em>red</em></span> if there are significant changes.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
This should be set to the length of the part of the sample between
the Start and End marker, expressed in number of beats.
</p></td></tr></table></div><p>
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The beat length does dependent on the current tempo of the song. If it is changed, the samples need to be recalculated using Rubber Band again. When <a class="link" href="#sect.main_form.export_song">exporting a song</a> all required recalculations will be done automatically. But while using standard playback the
<span class="inlinemediaobject"><img src="img/rubber_off.png" alt='Grey vertical button containing the characters "R", "U", and "B" in adjacent lines.'></span>
button in the <a class="link" href="#sect.main_toolbar.bpm_control_and_metronome" title="7.3. BPM Control and Metronome">Main Toolbar</a> has to be activated to enable the recalculation of all samples on the fly.
</p></td></tr></table></div><p>
</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Pitch</strong></span>:
specifies the resulting pitch of the sample, expressed in
<code class="option">semitones,cent</code>.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This pitch will affect all instances of the sample in addition to the <a class="link" href="#chpt.instrument_editor.pitch_shift_parameters" title="11.1.4. Pitch Shift Parameters">Pitch Shift Parameters</a> in the Instrument Editor and the <a class="link" href="#chpt.pattern_editor.note_properties.notekey">NoteKey</a> property of each individual note.
</p></td></tr></table></div><p>
</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>Crispness</strong></span>:
fine-tunes the processing algorithm used by Rubber Band. It does not affect tempo or pitch, but changes the way
the sample sounds.
</p></li></ul></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.sample_editor.playback_and_envelope_editor"></a>12.3. Playback and Envelope Editor</h2></div></div></div><div class="figure"><a name="fig.sample_editor.envelope"></a><p class="title"><b>Figure 12.4. The Envelope Section of the Sample Editor</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/SampleEditor_Envelope.png" alt="The Envelope Section of the Sample Editor"></div></div></div><br class="figure-break"><p>
The bottom part of the Sample Editor features some basic controls and the Envelope Editor.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a name="chpt.sample_editor.playback_and_envelope_editor.apply_changes"></a>
<span class="bold"><strong>Apply Changes</strong></span>: applies all settings of the Sample Editor to the selected sample in a non-destructive way.
</p></li><li class="listitem"><p><a name="chpt.sample_editor.playback_and_envelope_editor.play"></a>
<span class="bold"><strong>Play</strong></span>: plays back the underlying sample with the latest changes applied to it.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Play original sample</strong></span>: plays back the underlying sample (without applying any changes).
</p></li><li class="listitem"><p><a name="chpt.sample_editor.playback_and_envelope_editor.dropdown"></a>
<span class="bold"><strong>panorama/volume</strong></span>: dropdown specifying whether the <code class="option"><a class="link" href="#def.pan" title="Pan">pan(orama)</a></code> or <code class="option">volume</code> of the sample will be tweaked in the Envelope Editor.
</p></li></ul></div><p>Using the Envelope Editor you can fine-tune both the volume and panorama (pan) of your sample.
This is done by creating <a class="link" href="#def.envelopegenerator" title="Envelope Generator">envelopes</a> by
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The volume envelope is blue and the pan envelope is yellow.
</p></td></tr></table></div><div class="procedure"><a name="chpt.sample_editor.playback_and_envelope_editor.envelope"></a><ol class="procedure" type="1"><li class="step"><p>
First select <code class="option">volume</code> or <code class="option">panorama</code> in the <a class="link" href="#chpt.sample_editor.playback_and_envelope_editor.dropdown">dropdown</a> to the right.
</p></li><li class="step"><p>
<span class="emphasis"><em>Left-clicking</em></span> in the Envelope Editor will add a point to the selected envelope or allows you to <span class="emphasis"><em>drag</em></span> an existing one.
</p></li><li class="step"><p>
<span class="emphasis"><em>Right-clicking</em></span> will delete a point.
</p></li><li class="step"><p>
Hit <a class="link" href="#chpt.sample_editor.playback_and_envelope_editor.apply_changes">Apply Changes</a> to make your changes take effect.
</p></li></ol></div></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.mixer"></a>Chapter 13. Mixer</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#chpt.mixer.channel_strips">13.1. Instrument Channel Strips</a></span></dt><dt><span class="sect1"><a href="#chpt.mixer.component_strips">13.2. Component Channel Strips</a></span></dt><dt><span class="sect1"><a href="#sect.fx_rack_LADSPA">13.3. FX Rack and LADSPA Plugins</a></span></dt><dt><span class="sect1"><a href="#chpt.mixer.master_fader_strip">13.4. Master Fader Strip</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.mixer.master_fader_strip.humanization">13.4.1. Humanization</a></span></dt><dt><span class="sect2"><a href="#chpt.mixer.master_fader_strip.mixer_settings">13.4.2. Mixer Settings</a></span></dt></dl></dd></dl></div><div class="figure"><a name="fig.mixer"></a><p class="title"><b>Figure 13.1. The Mixer</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/Mixer.png" alt="The Mixer"></div></div></div><br class="figure-break"><p>The Mixer window can be opened by pressing <span class="keycap"><strong>Alt</strong></span> + <span class="keycap"><strong>M</strong></span>, by selecting Mixer in the <a class="link" href="#sect.main_menu.view" title="6.5. View">View</a> option of the Main Menu, or by clicking the Mixer button on the <a class="link" href="#sect.main_toolbar.gui_state" title="7.6. GUI State">Main Toolbar</a>.
</p><p>The Mixer consists of 3 sections (from left to right): the one containing the <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strips</a> and <a class="link" href="#chpt.mixer.component_strips" title="13.2. Component Channel Strips">Component Channel Strips</a>,
the <a class="link" href="#sect.fx_rack_LADSPA" title="13.3. FX Rack and LADSPA Plugins">FX Plugin Rack</a>, and the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master Fader Strip</a>. The Hydrogen Mixer works very
much like a hardware mixer does: it lets you set the volume, pan, FX and several
other things for every instrument as well as the volume of all of these sources mixed together.
</p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.mixer.channel_strips"></a>13.1. Instrument Channel Strips</h2></div></div></div><div class="figure"><a name="fig.mixer.channel_strip"></a><p class="title"><b>Figure 13.2. The Instrument Channel Strip in the Mixer</b></p><div class="figure-contents"><div class="mediaobject"><img src="img/MixerInstrumentStrip.png" alt="The Instrument Channel Strip in the Mixer"></div></div></div><br class="figure-break"><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<span class="inlinemediaobject"><img src="generated_en/btn_play_on_mixer.png" alt="Grey button with a filled black triangle pointing to the right."></span> : lets you trigger the instrument at maximum velocity.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
This is quite handy for checking <a class="link" href="#def.clipping" title="Clipping">clipping</a>.
</p></td></tr></table></div></li><li class="listitem"><p>
<span class="inlinemediaobject"><img src="generated_en/led_trigger_on.png" alt="Vertical, grey LED-like object."></span> :
lights up whenever this instrument is triggered, e.g. by a note in a pattern or an external <abbr class="abbrev">MIDI</abbr> controller).
</p></li><li class="listitem"><p>
<span class="inlinemediaobject"><img src="generated_en/item_selected.png" alt="Horizontal, blue LED-like object."></span> :
shows whether the instrument is currently selected (in both the Mixer and the Pattern Editor).
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
If the <a class="link" href="#sect.main_menu.options.input_mode">Input mode</a> is set to <code class="option">Instrument</code>, incoming <abbr class="abbrev">MIDI</abbr> events and <a class="link" href="#chpt.overview.midi_mapping_and_virtual_keyboard" title="4.3. MIDI-mapping and Virtual Keyboard">virtual keyboard keys</a> will trigger only (pitch shifted) sounds of the currently selected instrument.
</p></td></tr></table></div><p>
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
An instrument can be selected by interacting with its Instrument Channel Strip in the Mixer, by interacting with its associated row in the Pattern Editor, or by the corresponding <a class="link" href="#chpt.midi.actions.actions.select_instrument"><abbr class="abbrev">MIDI</abbr></a> or <a class="link" href="#chpt.osc.command.select_instrument"><abbr class="abbrev">OSC</abbr> command.</a>
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p><a name="chpt.mixer.channel_strips.mute"></a>
<span class="inlinemediaobject"><img src="generated_en/btn_mute_on.png" alt='Grey button containing a black "M".'></span> : <a class="link" href="#def.mute" title="Mute">mutes</a> all sounds related to the instrument (including the preview sound you hear when clicking on the instrument name in the <a class="link" href="#chpt.pattern_editor.sidebar" title="9.1.2. Sidebar">Sidebar</a> of the Pattern Editor).
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This button is sharing its state with the mute button of corresponding instrument in the <a class="link" href="#chpt.pattern_editor.sidebar" title="9.1.2. Sidebar">Sidebar</a> of the Pattern Editor.
</p></td></tr></table></div></li><li class="listitem"><p><a name="chpt.mixer.channel_strips.solo"></a>
<span class="inlinemediaobject"><img src="generated_en/btn_solo_on.png" alt='Grey button containing a black "S".'></span> : solos the instrument.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This button is sharing its state with the solo button of corresponding instrument in the <a class="link" href="#chpt.pattern_editor.sidebar" title="9.1.2. Sidebar">Sidebar</a> of the Pattern Editor.
</p></td></tr></table></div></li><li class="listitem"><p><a name="chpt.mixer.channel_strips.pan"></a>
<span class="inlinemediaobject"><img src="generated_en/mixer_rotary.png" alt="Grey rotary widget with black background. On the widget there is a centered black circle and a black vertical line extending from the topmost point of the circle to its center."></span> : sets a pan value affecting all note played using this instrument.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
For a detailed description of how this pan value does interact with the <a class="link" href="#chpt.pattern_editor.note_properties.pan">note pan</a> and the <a class="link" href="#chpt.mixer.master_fader_strip.mixer_settings" title="13.4.2. Mixer Settings">Pan Laws</a> in the Mixer please see <a class="xref" href="#def.pan" title="Pan">Pan</a>.
</p></td></tr></table></div></li><li class="listitem"><p><a name="chpt.mixer.channel_strips.fx_volume"></a>
<span class="inlinemediaobject"><img src="generated_en/mixer_knob.png" alt="Grey and round widget containing a grey and centered circle as well as a short grey line to indicate the position."></span> :
the four pre-fader FX send knobs that determine how much of this instrument will be sent to
the effect plugins in the <a class="link" href="#sect.fx_rack_LADSPA" title="13.3. FX Rack and LADSPA Plugins">FX Rack</a>.
</p></li><li class="listitem"><p><a name="chpt.mixer.channel_strips.fader_and_lcd"></a>
<span class="bold"><strong>Fader and LCD</strong></span>:
the fader next to the instrument's name allows you to adjust the volume of the instrument which will be applied on top of all the individual note velocities, layer gains etc. In the background of the fader a volume unit (VU) meter is included representing the instrument's signal level. The LCD displays shows its peak value.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
You can adjust the falloff speed of the peak values in the LCD display via the <a class="link" href="#fig.preferences.appearance_tab" title="Figure 5.5. The Appearance Tab">Appearance</a> tab in the Preferences.
</p></td></tr></table></div></li></ul></div><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
If the <a class="link" href="#sect.preferences.jack.per_instrument_outs">Create per-instrument outputs</a> option in the Audio Engine tab of the Preferences was selected for the <abbr class="abbrev">JACK</abbr> audio driver, Hydrogen will register ports for each instrument. All the options described above will only take effect if in addition the <a class="link" href="#sect.preferences.jack.track_output">Track output</a> option in the same tab as set to <code class="option">Post-Fader</code>.
</p><p>
This allows you to route the individual instruments directly into any other <abbr class="abbrev">JACK</abbr> enabled application, like Ardour, and gives you
a lot more flexibility.
</p></td></tr></table></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.mixer.component_strips"></a>13.2. Component Channel Strips</h2></div></div></div><div class="figure"><a name="fig.mixer.component_strip"></a><p class="title"><b>Figure 13.3. The Component Channel Strip in the Mixer</b></p><div class="figure-contents"><div class="mediaobject"><img src="img/MixerComponentStrip.png" alt="The Component Channel Strip in the Mixer"></div></div></div><br class="figure-break"><p>
Right of the <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strips</a> there additional strips corresponding to the instrument <a class="link" href="#def.component" title="Component">components</a>.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
These channels will not be exposed as <abbr class="abbrev">JACK</abbr> output ports when enabling the <a class="link" href="#sect.preferences.jack.per_instrument_outs">Create per-instrument outputs</a> option in the Preferences.
</p></td></tr></table></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a name="chpt.mixer.component_strips.mute"></a>
<span class="inlinemediaobject"><img src="generated_en/btn_mute_on.png" alt='Grey button containing a black "M".'></span> : <a class="link" href="#def.mute" title="Mute">mutes</a> the instrument.
</p></li><li class="listitem"><p><a name="chpt.mixer.component_strips.solo"></a>
<span class="inlinemediaobject"><img src="generated_en/btn_solo_on.png" alt='Grey button containing a black "S".'></span> : solos the instrument.
</p></li><li class="listitem"><p><a name="chpt.mixer.component_strips.fader_and_lcd"></a>
<span class="bold"><strong>Fader and LCD</strong></span>:
the fader next to the component's name allows you to adjust the volume of all layers (of all instruments) associated with this component. In the background of the fader a volume unit (VU) meter is included representing the instrument's signal level. The LCD displays shows its peak value.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
You can adjust the falloff speed of the peak values in the LCD display via the <a class="link" href="#fig.preferences.appearance_tab" title="Figure 5.5. The Appearance Tab">Appearance</a> tab in the Preferences.
</p></td></tr></table></div></li></ul></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.fx_rack_LADSPA"></a>13.3. FX Rack and LADSPA Plugins</h2></div></div></div><div class="figure"><a name="fig.mixer.fx_strip"></a><p class="title"><b>Figure 13.4. The FX Rack in the Mixer</b></p><div class="figure-contents"><div class="mediaobject"><img src="img/MixerFXStrip.png" alt="The FX Rack in the Mixer"></div></div></div><br class="figure-break"><p>
The FX Rack can be accessed by clicking the
<span class="inlinemediaobject"><img src="img/showFX_on.png" alt='Blue button containing the black characters "FX".'></span>
button in the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master Fader Strip</a>).
</p><p>It has 4 bays where you can load a <abbr class="abbrev">LADSPA</abbr> effect plugin, but before
you can load any plugins these must be installed on system-level.</p><p>There are dozens of plugins available for download from various sources:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="bold"><strong><abbr class="abbrev">SWH</abbr>-Plugins</strong></span>: available at <a class="ulink" href="http://plugin.org.uk" target="_top">http://plugin.org.uk</a>. </p></li><li class="listitem"><p><span class="bold"><strong><abbr class="abbrev">CMT</abbr></strong></span>: available at <a class="ulink" href="http://www.ladspa.org" target="_top">http://www.ladspa.org</a>.</p></li><li class="listitem"><p><span class="bold"><strong><abbr class="abbrev">TAP</abbr></strong></span>: available at <a class="ulink" href="http://tap-plugins.sf.net" target="_top">http://tap-plugins.sf.net</a>.</p></li><li class="listitem"><p><span class="bold"><strong>Calf plugins</strong></span>: available at <a class="ulink" href="http://calf.sourceforge.net/" target="_top">http://calf.sourceforge.net/</a>.</p></li><li class="listitem"><p><span class="bold"><strong><abbr class="abbrev">LSP</abbr> plugins</strong></span>: available at <a class="ulink" href="https://github.com/sadko4u/lsp-plugins/" target="_top">https://github.com/sadko4u/lsp-plugins/</a>.</p></li><li class="listitem"><p> ....</p></li></ul></div><p>
</p><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning: Plugins Kill"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Plugins Kill</th></tr><tr><td align="left" valign="top"><p>A badly designed <abbr class="abbrev">LADSPA</abbr> plugin is capable of
hanging, crashing, freezing, screeching, overflowing buffers, and even
phoning home. If you start having issues with Hydrogen, disable your
plugins and see if things improve. Some plugins are not designed for
real-time use, and some are just plain better than others.</p></td></tr></table></div><p>Once you have installed some plugins you can select one by clicking the
<span class="inlinemediaobject"><img src="img/edit_off.png" alt='Grey button containing the black characters "EDIT".'></span>
button.
</p><p>Now the FX selector window will pop up :
</p><div class="figure"><a name="fig.select_effect"></a><p class="title"><b>Figure 13.5. Select an Effect</b></p><div class="figure-contents"><div class="mediaobject"><img src="img/MixerFXSelect.png" alt="Select an Effect"></div></div></div><p><br class="figure-break">
Once you have selected a plugin you will immediately have access
to its parameters:
</p><div class="informalfigure"><a name="figLADSPA_FX_Properties"></a><div class="mediaobject"><img src="img/LADSPA_FX_Properties.png" alt='Example widget to alter the properties of a LADSPA FX. At the top left the name of the FX is displayed and at the top left two buttons - "Select FX" and "Deactive" - are shown. In the remainder there are several vertical strips stacked horizontally with each one carrying: an LCD displaying the current value (top), the name of the parameter (left), and a fader with included meter (right).'></div></div><p>
You can select another plugin by clicking the <span class="bold"><strong>Select FX</strong></span> button. If you quickly want to
enable/disable the effect click the <span class="bold"><strong>Deactivate</strong></span> button (or the Bypass (
<span class="inlinemediaobject"><img src="img/bypass_over.png" alt='Redish button containing the black characters "BYP".'></span>)
button in the FX Rack).
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
This can be handy for a quick A/B comparison.
</p></td></tr></table></div><p>After you have selected the FX and tweaked it's parameters you can use the
<span class="bold"><strong>Return</strong></span> knob to increase/decrease how much of this FX will be returned to the master output.</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.mixer.master_fader_strip"></a>13.4. Master Fader Strip</h2></div></div></div><div class="figure"><a name="fig.mixer.master_strip"></a><p class="title"><b>Figure 13.6. The Master Fader Strip in the Mixer</b></p><div class="figure-contents"><div class="mediaobject"><img src="img/MixerMasterStrip.png" alt="The Master Fader Strip in the Mixer"></div></div></div><br class="figure-break"><p>
The Master Fader Strip contains the Master volume fader with volume unit (VU) meter representing the signal level, and three global humanization settings.
</p><p>
Using the fader you can control the volume of the resulting audio output of Hydrogen which is the sum of all the individual <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strips</a>, the <a class="link" href="#chpt.song_editor.playbackTrack" title="8.6. Playback Track">Playback Track</a>, and the <a class="link" href="#sect.main_toolbar.bpm_control_and_metronome" title="7.3. BPM Control and Metronome">Metronome</a>. The
<span class="inlinemediaobject"><img src="img/master_mute_off.png" alt='Grey button containing the black characters "MUTE".'></span>
button <a class="link" href="#def.mute" title="Mute">mutes</a> the whole output.
</p><p>On the bottom-right of the Master section the
<span class="inlinemediaobject"><img src="img/showFX_on.png" alt='Blue button containing the black characters "FX".'></span>
button will show or hide the <a class="link" href="#sect.fx_rack_LADSPA" title="13.3. FX Rack and LADSPA Plugins">FX Rack</a>, and the
<span class="inlinemediaobject"><img src="img/showPeaks_on.png" alt='Blue button containing the black characters "PEAK".'></span>
button will enable or disable the VU meters in both the Master Fader Strip and all the individual <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strips</a> and <a class="link" href="#chpt.mixer.component_strips" title="13.2. Component Channel Strips">Component Channel Strips</a>.
</p><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.mixer.master_fader_strip.humanization"></a>13.4.1. Humanization</h3></div></div></div><p>
In order to make the resulting audio sound more natural and less artificial, Hydrogen does offer some humanization capabilities.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
Further humanization capabilities are provided via <a class="link" href="#chpt.instrument_editor.pitch_shift_parameters" title="11.1.4. Pitch Shift Parameters">Random Pitch Shift Parameter</a> in the Instrument Editor. In contrast to the global nature of the humanization in the Master Fader Strip this random pitch will only be applied to notes associated with the corresponding instrument.
</p></td></tr></table></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="bold"><strong>Velocity</strong></span>: adds a certain randomness to the note <a class="link" href="#def.velocity" title="Velocity">velocity</a> set in the <a class="link" href="#chpt.pattern_editor.note_properties.velocity">Note Properties Editor</a>.
The higher you turn this knob, the bigger will be the randomness.
</p></li><li class="listitem"><p><span class="bold"><strong>Timing</strong></span>: adds a certain randomness to the note timing set in the <a class="link" href="#chpt.pattern_editor.note_properties.lead_and_lag">Note Properties Editor</a> (as Lead/Lag).
The higher you turn this knob, the more the timing will be randomized.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>Notes are displaced in time
but the pattern duration or BPM do not change.</p></td></tr></table></div></li><li class="listitem"><p><span class="bold"><strong>Swing</strong></span>: this knob will add a certain amount of swing to the song. Swing (a slight time delay) is applied to upbeat 16th-notes,
and not to 8th-notes as it happens in traditional Jazz.</p></li></ul></div><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
In technical terms both for the <span class="bold"><strong>Velocity</strong></span> and the <span class="bold"><strong>Timing</strong></span> a random number will be sampled independently and identically distributed from a Gaussian distribution. The associated knobs provide a linear scaling of the variance of the underlying distribution.
</p></td></tr></table></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.mixer.master_fader_strip.mixer_settings"></a>13.4.2. Mixer Settings</h3></div></div></div><p>In the upper right corner of Master Fader Strip there is a small "cog" icon button:</p><div class="informalfigure"><a name="mixerSettingsButton"></a><div class="mediaobject"><img src="generated_en/mixerSettingsButton.png" alt='Button holding the cog symbol right of the "Master" title of the Master Fader Strip.'></div></div><p>
Click it to open the Mixer Settings window:
</p><div class="informalfigure"><a name="mixerSettingsDialog"></a><div class="mediaobject"><img src="generated_en/mixerSettingsDialog.png" alt='Dialog to "Select Pan Law" with a large dropdown menu in the middle, a text input title "db SPL Center Componensation" below, and the "Cancel" (left) and "OK" (right) buttons at the bottom.'></div></div><p>
Here you can select the <span class="bold"><strong>Pan Law</strong></span> used by Hydrogen Mixer.
</p><p>
The Pan Law is the relationship between the <a class="link" href="#def.pan" title="Pan">Resultant Pan</a> and the separate <a class="link" href="#def.gain" title="Gain">gains</a> of left and right audio outputs.
The aim is to control the horizontal angle the sound seems to arrive from.
</p><p>
Hydrogen features one the most customizable and accurate Pan Law set. </p><p>
You will find four categories: <code class="option">linear</code>, <code class="option">polar</code>,
<code class="option">ratio</code>, <code class="option">quadratic</code>.
Every category gives a different "scale" or "sensibility" to the pan knob:
the same knob position will make the sound appear more lateral or central depending on the category,
from the most lateral (<span class="emphasis"><em>linear</em></span>) to the most central (<span class="emphasis"><em>quadratic</em></span>).
</p><p>
Then for each category you will find four options, that define a <span class="emphasis"><em>constraint</em></span> between the
gains of the two channels:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="bold"><strong>Balance Law (0dB)</strong></span>:
when you turn the pan knob from center to right, the right gain stays constant at maximum level
while the left gain decreases from the maximum level to 0 (and symmetrically turning from center to left). </p><p>It is ideal for balancing a DUAL-channel track. It has ZERO center compensation: the sound
will be <span class="emphasis"><em>louder</em></span> when the pan knob is at <span class="emphasis"><em>center</em></span> -
unless channels are out of phase - so you may have to readjust the volume manually with the
mixer fader.
</p></li><li class="listitem"><p> <span class="bold"><strong>Constant Power (-3dB)</strong></span>: the total <span class="emphasis"><em>power</em></span>
(which is proportional to the <span class="emphasis"><em>square</em></span> of the gain) is constant for any position
of the pan knob. </p><p>Compared to the Balance Law, each channel gain is divided by the square root of 2
when the pan knob is at center (-3.0103 dB center compensation).
In a common room, this constraint <span class="emphasis"><em>may</em></span> give the general perception of uniform
volume for any pan knob position (panning a MONO track).
</p></li><li class="listitem"><p> <span class="bold"><strong>Constant Sum (-6dB)</strong></span>: the sum of left and right gains is
constant for any position of the pan knob. </p><p>This constraint preserves the mix volumes in mono export.
Compared to the Balance Law, each channel gain is halved (-6.0206 dB) when the pan knob
is at center.
If you are in an ideal anechoic room (where there are no acoustic reflections)
and you seat perfectly at the same distance from the speakers,
with this constraint the volume will be really constant for any pan position, because of the linear
<span class="emphasis"><em>super-position</em></span> of sound waves (panning a MONO track).
</p></li><li class="listitem"><p><span class="bold"><strong>Constant k-Norm (Custom dB center compensation)</strong></span>:
you can experiment adjusting the center compensation to your
taste! </p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>Some hi-end studio mixers - to be used in well tuned rooms -
have center compensation between -3dB and -6dB.
</p></td></tr></table></div></li></ul></div><p>
</p><p>The four constraints should not change the perception of the <span class="emphasis"><em>stereo angle</em></span>,
but the <span class="emphasis"><em>volume</em></span> only (depending on the pan knob).
</p><p>
The Pan Law is something you should choose <span class="emphasis"><em>before</em></span> starting the mix and keep untouched.
Hydrogen sets the <span class="emphasis"><em>ratio Balance Law</em></span> by default because it was the only available law
until version 1.0 (so old songs and drumkits will sound the same).
The setting is saved in the song file but not in preferences,
so it is NOT remembered when you create a new song.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>Unlike in advanced mixers, Hydrogen panning makes no distinction if a track is mono or dual-channel (stereo).
You cannot pan each channel of stereo tracks separately, nor use a balance law for them and another
pan law for mono tracks.
If the drumkit you are using is made of true stereo samples, you don't want a negative center compensation
probably, so you should select a Balance Law.</p></td></tr></table></div></div></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.director"></a>Chapter 14. Director</h2></div></div></div><p>
</p><div class="figure"><a name="fig.director"></a><p class="title"><b>Figure 14.1. The Director</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/screenshot-director.png" alt="The Director"></div></div></div><p><br class="figure-break">
</p><p>
The Director provides a quick overview of what Hydrogen
is currently doing. It can be opened by pressing <span class="keycap"><strong>Alt</strong></span> + <span class="keycap"><strong>D</strong></span> or by via the <a class="link" href="#sect.main_menu.view" title="6.5. View">View</a> option in the Main Menu. </p><p>
The Director shows you the song name, a visualization of the <a class="link" href="#sect.main_toolbar.bpm_control_and_metronome" title="7.3. BPM Control and Metronome">Metronome</a>, and the
<a class="link" href="#chpt.song_editor.tag" title="8.5. Tags">Tags</a>. Just below the metronome you can see the latest tag, and below that
the next upcoming tag. This way you have a nice overview of what is going on,
and what is about to happen in the song.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
This comes in very handy when you are <a class="link" href="#chpt.overview.recording" title="4.4. Recording in Hydrogen">recording</a> a song, or
if you are using Hydrogen live on stage.
</p></td></tr></table></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.playlist_editor"></a>Chapter 15. Playlist Editor</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#chpt.playlist_editor.main_window">15.1. Main Window</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.playlist_editor.main_window.song_list">15.1.1. Song List</a></span></dt><dt><span class="sect2"><a href="#chpt.playlist_editor.main_window.controls">15.1.2. Controls</a></span></dt><dt><span class="sect2"><a href="#chpt.playlist_editor.main_window.scripts">15.1.3. Scripts</a></span></dt></dl></dd><dt><span class="sect1"><a href="#chpt.playlist_editor.menu">15.2. Menu</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.playlist_editor.menu.playlist">15.2.1. Playlist</a></span></dt><dt><span class="sect2"><a href="#chpt.playlist_editor.menu.scripts">15.2.2. Scripts</a></span></dt></dl></dd></dl></div><div class="figure"><a name="fig.playlist_editor"></a><p class="title"><b>Figure 15.1. The Playlist Editor with Demo Songs loaded</b></p><div class="figure-contents"><div class="mediaobject"><img src="img/PlaylistEditor.png" alt="The Playlist Editor with Demo Songs loaded"></div></div></div><br class="figure-break"><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.playlist_editor.main_window"></a>15.1. Main Window</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.playlist_editor.main_window.song_list"></a>15.1.1. Song List</h3></div></div></div><p>
The Playlist Editor allows you to group various songs into a
playlist and is intended to ease using Hydrogen live on stage. You can access this window via the <a class="link" href="#sect.main_menu.view" title="6.5. View">View</a> option of the Main Menu.
</p><p>
Using the <a class="link" href="#chpt.playlist_editor.menu" title="15.2. Menu">menu</a> you can add various songs to the playlist and you can arrange their order using the arrow buttons to the right of the widget.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
When playback reaches the end of one song the next one won't be automatically selected and played! You can select an arbitrary song in the playlist using double <span class="emphasis"><em>left-clicking</em></span>, by pressing the hotkeys <a class="link" href="#chap.shortcuts.f5"><span class="keycap"><strong>F5</strong></span></a> and <a class="link" href="#chap.shortcuts.f6"><span class="keycap"><strong>F6</strong></span></a>, or the corresponding <a class="link" href="#chpt.osc.command.playlist_song">OSC</a> commands.
</p><p>
Also note that selecting a song won't start playback automatically.
</p></td></tr></table></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.playlist_editor.main_window.controls"></a>15.1.2. Controls</h3></div></div></div><div class="informalfigure"><a name="fig.playlist_editor.controls"></a><div class="mediaobject"><img src="img/PlaylistEditorControls.png" alt="From left to right: rewind, play and pause, stop, and fast forward."></div></div><p>
At the bottom of the widget you find a couple of <span class="bold"><strong>buttons</strong></span> you already know from the <a class="link" href="#sect.main_toolbar.transport_control" title="7.1. Transport Control">Transport Control</a> in the Main Toolbar. They do have the same purposes of starting, pausing, and stopping the playback as well as moving the transport position backwards or forwards by one pattern.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
While focusing the Playlist Editor instead of the main UI the usual <a class="link" href="#chap.shortcuts" title="Chapter 21. Shortcut Lists">shortcuts</a> of Hydrogen, like <a class="link" href="#chap.shortcuts.space"><span class="keycap"><strong>Space</strong></span></a> for starting/pausing playback, won't work.
</p></td></tr></table></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.playlist_editor.main_window.scripts"></a>15.1.3. Scripts</h3></div></div></div><p>
In addition, the Playlist Editor allows you to add <span class="bold"><strong>scripts</strong></span> executed right <span class="emphasis"><em>before</em></span> the
selected song is loaded.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This means that e.g. <a class="link" href="#chpt.osc.commands.all_messages" title="17.2.2. All Commands">OSC</a> commands can not be used to change the state of Hydrogen as the subsequent loading of the associated song would reset it immediately.
</p></td></tr></table></div><p>
The scripts supported in the Playlist Editor are <abbr class="abbrev">BASH</abbr> scripts and one has to both add a script to a song as well as to check the corresponding box in the <span class="emphasis"><em>exec Script</em></span> column in order to have it by your computer whenever you switch to the particular song.
</p><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>
Scripts are not supported in the Windows version of Hydrogen.
</p></td></tr></table></div></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.playlist_editor.menu"></a>15.2. Menu</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.playlist_editor.menu.playlist"></a>15.2.1. Playlist</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<span class="bold"><strong>Add song to Playlist</strong></span>:
let's you select a song to be added to the current playlist.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Add current song to Playlist</strong></span>:
adds the currently loaded song to the current playlist.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Remove selected song from Playlist</strong></span>:
deletes the selected song from the current playlist.
</p></li><li class="listitem"><p>
<span class="bold"><strong>New Playlist</strong></span>:
creates a new and empty playlist.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Open Playlist</strong></span>:
opens an existing playlist (file of type <a class="link" href="#chpt.file_types.h2playlist">.h2playlist</a>).
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
In the <a class="link" href="#fig.preferences.general_tab" title="Figure 5.1. The General Tab">General</a> tab of the Preferences dialog you can configure Hydrogen to reload the last used playlist.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Save Playlist</strong></span>:
saves all changes done to the current playlist.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Save Playlist as</strong></span>:
saves the current playlist into a file (of type <a class="link" href="#chpt.file_types.h2playlist">.h2playlist</a>) and location of your choice.
</p></li></ul></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.playlist_editor.menu.scripts"></a>15.2.2. Scripts</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<span class="bold"><strong>Add Script to selected song</strong></span>:
associates a <abbr class="abbrev">BASH</abbr> script (file of type <span class="command"><strong>.sh</strong></span>) to the currently selected song of the playlist.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Edit selected Script</strong></span>:
opens the selected script with your default editor (in an external window).
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
When using the function for the first time Hydrogen will ask you which program to use as your default editor.
</p></td></tr></table></div><p>
</p></li><li class="listitem"><p>
<span class="bold"><strong>Remove selected Script</strong></span>:
removes the selected script from the playlist.
</p></li><li class="listitem"><p>
<span class="bold"><strong>Create a new Script</strong></span>:
creates a new and empty <span class="command"><strong>.sh</strong></span> scrip at a location of your choice.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The default one is the <code class="filename">scripts</code> folder in the Hydrogen data
directory (usually <code class="filename">$HOME/.hydrogen/data/</code>).
</p></td></tr></table></div><p>
</p></li></ul></div></div></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.midi"></a>Chapter 16. MIDI API</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#chpt.midi.actions">16.1. MIDI Actions</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.midi.actions.events">16.1.1. Events</a></span></dt><dt><span class="sect2"><a href="#chpt.midi.actions.actions">16.1.2. Actions</a></span></dt></dl></dd><dt><span class="sect1"><a href="#chpt.midi.learnable">16.2. MIDI-learnable Widgets</a></span></dt></dl></div><p>In this section you can find more info about how to make Hydrogen respond to <abbr class="abbrev">MIDI</abbr> messages. This is either done using the <a class="link" href="#chpt.midi.actions" title="16.1. MIDI Actions">available <abbr class="abbrev">MIDI</abbr> Actions</a> or using the <a class="link" href="#chpt.midi.learnable" title="16.2. MIDI-learnable Widgets"><abbr class="abbrev">MIDI</abbr>-learnable Widgets</a>, like knobs or faders, both triggered using <a class="link" href="#chpt.midi.actions" title="16.1. MIDI Actions"><abbr class="abbrev">MIDI</abbr> Events</a>.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Before you can work with <abbr class="abbrev">MIDI</abbr> actions
you should have your <abbr class="abbrev">MIDI</abbr> devices, drivers, and connections configured
correctly in the <a class="link" href="#chpt.preferences.midi_tab" title="5.3. MIDI System">MIDI System </a> tab of the Preferences.
</p><p>
Please note that this chapter will only cover the table linking external <abbr class="abbrev">MIDI</abbr> Events to Hydrogen's <abbr class="abbrev">MIDI</abbr> Actions. For all other parameters of the <abbr class="abbrev">MIDI</abbr> API please see the <a class="link" href="#chpt.preferences.midi_tab" title="5.3. MIDI System">MIDI System </a> tab of the Preferences.
</p></td></tr></table></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.midi.actions"></a>16.1. MIDI Actions</h2></div></div></div><div class="figure"><a name="midi_actions"></a><p class="title"><b>Figure 16.1. MIDI Actions are set in MIDI System tab of the Preferences Dialog</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/MidiSystem_V2.png" alt="MIDI Actions are set in MIDI System tab of the Preferences Dialog"></div></div></div><br class="figure-break"><p>An <abbr class="abbrev">MIDI</abbr> <span class="bold"><strong>Event</strong></span> is an incoming <abbr class="abbrev">MIDI</abbr> message, originating from e.g. a <abbr class="abbrev">MIDI</abbr> controller or an external sequencer. A <abbr class="abbrev">MIDI</abbr> <span class="bold"><strong>Action</strong></span> is a function built into Hydrogen that can be used to react to a specific <abbr class="abbrev">MIDI</abbr> Event. Binding an Event to an Action can be done using the <a class="link" href="#chpt.preferences.midi_tab" title="5.3. MIDI System">MIDI System</a> tab of the Preferences.
</p><p>
You can also define <abbr class="abbrev">MIDI</abbr> bindings by simply pressing the
<span class="inlinemediaobject"><img src="img/rec.png" alt="Red circle."></span>
button left of the Event-Action binding line.
A popup will inform you that Hydrogen is waiting for your input. Press/hit/turn
the key/pad/knob on your <abbr class="abbrev">MIDI</abbr> keyboard (or controller) that you want to link to
this action. The popup will close and the <span class="bold"><strong>Event Param.</strong></span> value will now show the
<abbr class="abbrev">MIDI</abbr> note value of the key you pressed. Once this is done you can select an Action
from the action drop-down list.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
You can also define a binding without the
<span class="inlinemediaobject"><img src="img/rec.png" alt="Red circle."></span> button by setting the <span class="bold"><strong>Event Param.</strong></span> manually to the desired <abbr class="abbrev">MIDI</abbr> note.
</p></td></tr></table></div><p>
The <span class="bold"><strong>Action Param.</strong></span> column to the right of the table specifies the input parameter to the Action (see the corresponding <a class="link" href="#chpt.midi.actions.actions" title="16.1.2. Actions">Actions reference</a> for details).
</p><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.midi.actions.events"></a>16.1.1. Events</h3></div></div></div><p>
Three types of <abbr class="abbrev">MIDI</abbr> Events are available (as described in the <abbr class="abbrev">MIDI</abbr> standard):
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: opencircle; "><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>NOTE</strong></span>: an input coming from a regular black/white key of a keyboard or a drumpad.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>CC</strong></span>: controller commands coming from faders or rotary controllers.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>MMC_x</strong></span>: <a class="ulink" href="http://en.wikipedia.org/wiki/MIDI_Machine_Control" target="_top">
machine control events</a> coming from buttons, like 'play' or 'stop', on a controller.
</p></li></ul></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.midi.actions.actions"></a>16.1.2. Actions</h3></div></div></div><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Some of the <abbr class="abbrev">MIDI</abbr> Actions require that the <span class="bold"><strong>Action Param.</strong></span> is configured. This parameter usually references a specific channel, instrument, FXsend... Keep in mind that its value is <span class="emphasis"><em>zero-based</em></span>. So, if you want to reference channel 1 you
have to enter <code class="option">0</code> in the <span class="bold"><strong>Action Param.</strong></span> field (<code class="option">1</code> for channel 2, <code class="option">2</code> for channel 3, and so on).
</p></td></tr></table></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: opencircle; "><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong><<_PREVIOUS_BAR</strong></span>:
moves the playhead to the previous pattern/bar.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>>>_NEXT_BAR</strong></span>:
moves the playhead to the next pattern/bar.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>BEATCOUNTER</strong></span>: calculates the average
time passing between successive encounters of this commands and uses
it to set the current tempo using the <a class="link" href="#sect.main_toolbar.tap_tempo_beat_counter.beat_counter" title="7.2.2. Beat Counter">Beat Counter</a>.
</p></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.midi.actions.actions.bpm_cc_relative"></a>
<span class="bold"><strong>BPM_CC_RELATIVE</strong></span>: changes the tempo relative to the current tempo, using a controller. Using the <span class="bold"><strong>Action Param</strong></span> you can specify by how much the current tempo will change. If the incoming Event is <code class="option">-1</code> (negative), the tempo will be increased and if it's <code class="option">1</code> (positive), it will be increased.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This Action will have no effect if Hydrogen is both in <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a>
and the <a class="link" href="#chpt.song_editor.timeline" title="8.4. Timeline">Timeline</a> is activated.
</p></td></tr></table></div><p>
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>BPM_DECR</strong></span>: decreases the current tempo
by the supplied value.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This Action will have no effect if Hydrogen is in <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a>
or <a class="link" href="#chpt.song_editor.timeline" title="8.4. Timeline">Timeline</a> is activated.
</p></td></tr></table></div></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>BPM_FINE_CC_RELATIVE</strong></span>:
as <a class="xref" href="#chpt.midi.actions.actions.bpm_cc_relative">BPM_CC_RELATIVE</a> but with changes 100 times smaller than the value specified in <span class="bold"><strong>Action Param</strong></span>.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This Action will have no effect if Hydrogen is in <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a>
or <a class="link" href="#chpt.song_editor.timeline" title="8.4. Timeline">Timeline</a> is activated.
</p></td></tr></table></div><p>
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>BPM_INCR</strong></span>: increases the current tempo
by the supplied value.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This Action will have no effect if Hydrogen is in <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a>
or <a class="link" href="#chpt.song_editor.timeline" title="8.4. Timeline">Timeline</a> is activated.
</p></td></tr></table></div></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>EFFECTx_LEVEL_ABSOLUTE</strong></span>:
changes the <a class="link" href="#chpt.mixer.channel_strips.fx_volume">volume level of an FX</a> <code class="option">x</code> provided as an integer between <code class="option">0</code> and <code class="option">127</code>. The value you enter in the <span class="bold"><strong>Action Param</strong></span> determines the <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strip</a> the Action will be applied to.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>EFFECTx_LEVEL_RELATIVE</strong></span>:
</p><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>
Not implemented yet.
</p></td></tr></table></div><p>
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>FILTER_CUTOFF_LEVEL_ABSOLUTE</strong></span>:
for a value of <code class="option">0</code> it sets the <a class="link" href="#chpt.instrument_editor.filter" title="11.1.3. Filter Parameters">Filter Cutoff</a> of the
instrument strip specified using the <span class="bold"><strong>Action Param</strong></span> to <code class="option">0</code>. For all other
values it sets the cutoff to the provided number divided by
127.0.
</p></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.midi.actions.actions.master_volume_absolute"></a>
<span class="bold"><strong>MASTER_VOLUME_ABSOLUTE</strong></span>: sets the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master output volume</a> to the value provided by the <abbr class="abbrev">MIDI</abbr> event times 1.5 and divided by 127.
</p></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.midi.actions.actions.master_volume_relative"></a>
<span class="bold"><strong>MASTER_VOLUME_RELATIVE</strong></span>: changes the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master output volume</a>, relative
to its current setting. For a value of <code class="option">0</code> it sets the volume of
the master fader to 0. For a value of <code class="option">1</code> it increases its
volume by 0.05 and for all other values it decreases it by
0.05. (<code class="option">-1</code>: -0.05 , <code class="option">0</code>: 0 ,<code class="option">1</code>: +0.05)
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>MUTE</strong></span>: <a class="link" href="#def.mute" title="Mute">mutes</a> the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master output</a> (sequencer keeps running).
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>MUTE_TOGGLE</strong></span>: toggles the <a class="link" href="#def.mute" title="Mute">muting</a> of the
<a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master output</a> (sequencer keeps running).
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>PAN_ABSOLUTE</strong></span>: changes the <a class="link" href="#def.pan" title="Pan">pan</a> of an <a class="link" href="#chpt.mixer.channel_strips.pan">instrument</a> determined by the <span class="bold"><strong>Action Param</strong></span> to the absolute value - from <code class="option">0</code> to <code class="option">127</code> - that the linked controller sends to Hydrogen.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>PAN_RELATIVE</strong></span>: changes the <a class="link" href="#def.pan" title="Pan">pan</a> of an <a class="link" href="#chpt.mixer.channel_strips.pan">instrument</a> determined by the <span class="bold"><strong>Action Param</strong></span> relative to the current value. For a
value of <code class="option">1</code> it increase the pan by 0.05. For all other values
it decreases it by 0.05. (<code class="option">-1</code>: -0.05 , <code class="option">1</code>: +0.05).
</p></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.midi.actions.actions.pause"></a>
<span class="bold"><strong>PAUSE</strong></span>: pauses playback.
</p></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.midi.actions.actions.play"></a>
<span class="bold"><strong>PLAY</strong></span>: starts playback.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>PLAY/PAUSE_TOGGLE</strong></span>: works the same as
<a class="xref" href="#chpt.midi.actions.actions.play">PLAY</a> if the
playback has not started yet and same as.
<a class="xref" href="#chpt.midi.actions.actions.pause">PAUSE</a> otherwise. (The playhead will not return
to the start of the song, but will stay at its current position).
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>PLAY/STOP_TOGGLE</strong></span>: works the same as <a class="xref" href="#chpt.midi.actions.actions.play">PLAY</a> if the
playback has not started yet and same as.
<a class="xref" href="#chpt.midi.actions.actions.stop">STOP</a> otherwise.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>PLAYLIST_NEXT_SONG</strong></span>:
opens the song in the current <a class="link" href="#chpt.playlist_editor" title="Chapter 15. Playlist Editor">playlist</a> corresponding to the song number specified in <span class="bold"><strong>Action Param</strong></span>.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>PLAYLIST_PREV_SONG</strong></span>:
opens the previous song in the current <a class="link" href="#chpt.playlist_editor" title="Chapter 15. Playlist Editor">playlist</a>.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>PLAYLIST_SONG</strong></span>:
opens the next song in the current <a class="link" href="#chpt.playlist_editor" title="Chapter 15. Playlist Editor">playlist</a>.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>RECORD/STROBE_TOGGLE</strong></span>:
toggles <a class="link" href="#chpt.overview.recording" title="4.4. Recording in Hydrogen">recording</a> (same as pressing the <a class="link" href="#sect.main_toolbar.transport_control" title="7.1. Transport Control">record button</a>
in the main toolbar).
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>RECORD_EXIT</strong></span>:
deactivates <a class="link" href="#chpt.overview.recording" title="4.4. Recording in Hydrogen">recording</a>.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>RECORD_READY</strong></span>:
toggles <a class="link" href="#chpt.overview.recording" title="4.4. Recording in Hydrogen">recording</a> (same as pressing the <a class="link" href="#sect.main_toolbar.transport_control" title="7.1. Transport Control">record button</a>
in the main toolbar) if the playback has not started yet.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>RECORD_STROBE</strong></span>:
activates <a class="link" href="#chpt.overview.recording" title="4.4. Recording in Hydrogen">recording</a>.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>REDO_ACTION</strong></span>:
redoes the previous undone action.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>SELECT_AND_PLAY_PATTERN</strong></span>: works as
<a class="xref" href="#chpt.midi.actions.actions.select_next_pattern">SELECT_NEXT_PATTERN</a> combined with
<a class="xref" href="#chpt.midi.actions.actions.play">PLAY</a>.
</p></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.midi.actions.actions.select_instrument"></a>
<span class="bold"><strong>SELECT_INSTRUMENT</strong></span>:
selects the instrument in the drumkit corresponding to the number supplied in the incoming <abbr class="abbrev">MIDI</abbr> Event.
</p></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.midi.actions.actions.select_next_pattern"></a>
<span class="bold"><strong>SELECT_NEXT_PATTERN</strong></span>:
switches to the pattern specified in <span class="bold"><strong>Action Param</strong></span>.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
If Hydrogen is in <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a>, the command will have no effect.
</p></td></tr></table></div><p>
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>SELECT_NEXT_PATTERN_CC_ABSOLUTE</strong></span>:
like <a class="xref" href="#chpt.midi.actions.actions.select_next_pattern">SELECT_NEXT_PATTERN</a> but only take effect in <a class="link" href="#chpt.song_editor.editor_modes.stacked" title="8.2.5. Stacked Mode">Stacked mode</a>.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>SELECT_NEXT_PATTERN_RELATIVE</strong></span>:
switches <span class="bold"><strong>Action Param</strong></span> patterns forward.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
This Action does only increment the pattern number and will only take effect if Hydrogen is in <a class="link" href="#chpt.song_editor.editor_modes.stacked" title="8.2.5. Stacked Mode">Stacked mode</a>.
</p></td></tr></table></div><p>
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>SELECT_ONLY_NEXT_PATTERN</strong></span>:
clears the list of patterns scheduled to be played next and adds the one specified in <span class="bold"><strong>Action Param</strong></span>.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
If either <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a> or <a class="link" href="#chpt.song_editor.editor_modes.stacked" title="8.2.5. Stacked Mode">Stacked mode</a> is activated, this action will have no effect.
</p></td></tr></table></div><p>
</p></li><li class="listitem" style="list-style-type: circle"><p><a name="chpt.midi.actions.actions.stop"></a>
<span class="bold"><strong>STOP</strong></span>: stops playback and moves the
playhead to the beginning of the song.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>STRIP_MUTE_TOGGLE</strong></span>:
<a class="link" href="#def.mute" title="Mute">mutes</a> the instrument specified in <span class="bold"><strong>Action Param</strong></span>.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>STRIP_SOLO_TOGGLE</strong></span>:
<a class="link" href="#def.mute" title="Mute">mutes</a> the instrument specified in <span class="bold"><strong>Action Param</strong></span>.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>STRIP_VOLUME_ABSOLUTE</strong></span>: see <a class="xref" href="#chpt.midi.actions.actions.master_volume_absolute">MASTER_VOLUME_ABSOLUTE</a>, but applies to
the <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strip</a> specified in <span class="bold"><strong>Action Param</strong></span>.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>STRIP_VOLUME_RELATIVE</strong></span>: see <a class="xref" href="#chpt.midi.actions.actions.master_volume_relative">MASTER_VOLUME_RELATIVE</a>, but applies to
the <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strip</a> specified in <span class="bold"><strong>Action Param</strong></span>.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>TAP_TEMPO</strong></span>: another command
calculating the average time passing between successive encounters of
this commands and uses it to set the current tempo using <a class="link" href="#sect.main_toolbar.tap_tempo_beat_counter.tap_tempo" title="7.2.1. Tap Tempo">Tap Tempo</a>.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>TOGGLE_METRONOME</strong></span>:
toggles the metronome.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>UNDO_ACTION</strong></span>:
undoes the previous action.
</p></li><li class="listitem" style="list-style-type: circle"><p>
<span class="bold"><strong>UNMUTE</strong></span>: unmutes the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master output</a> (sequencer keeps running).
</p></li></ul></div></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.midi.learnable"></a>16.2. MIDI-learnable Widgets</h2></div></div></div><p>Apart from the dedicated <a class="link" href="#chpt.midi.actions" title="16.1. MIDI Actions"><abbr class="abbrev">MIDI</abbr> Actions</a> a lot of GUI elements, such as faders or knobs, can also be controlled via <abbr class="abbrev">MIDI</abbr> messages. To configure an element to listen for incoming <abbr class="abbrev">MIDI</abbr> Events, press <span class="keycap"><strong>Shift</strong></span> while <span class="emphasis"><em>left-clicking</em></span> it.
A 'Waiting for <abbr class="abbrev">MIDI</abbr> input...' popup informs you that Hydrogen is now waiting for you to press
a key or turn/move a controller on your <abbr class="abbrev">MIDI</abbr> device.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>If the element that does not support <abbr class="abbrev">MIDI</abbr> automation, a different popup will inform you.
</p></td></tr></table></div></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.osc"></a>Chapter 17. OSC API</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#chpt.osc.basics">17.1. Basics</a></span></dt><dt><span class="sect1"><a href="#chpt.osc.commands">17.2. Commands</a></span></dt><dd><dl><dt><span class="sect2"><a href="#chpt.osc.commands.syntax">17.2.1. Syntax</a></span></dt><dt><span class="sect2"><a href="#chpt.osc.commands.all_messages">17.2.2. All Commands</a></span></dt></dl></dd></dl></div><p>Open Sound Control (<abbr class="abbrev">OSC</abbr>) is a protocol for communication among
programs, computers, and hardware, like synthesizers or multimedia
devices, via networking protocols such as UDP or TCP. It can be thought
of as a replacement for the <abbr class="abbrev">MIDI</abbr> protocol with rich benefits, like
supporting symbolic and high-resolution numerical argument data,
providing an URL-style naming scheme in combination with a pattern
matching language, and allowing to bundle messages for a better handling
of timing and simultaneous processing.</p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.osc.basics"></a>17.1. Basics</h2></div></div></div><p>Hydrogen is able to receive and send <abbr class="abbrev">OSC</abbr> messages. This allows you
to control it using various devices, like hardware <abbr class="abbrev">OSC</abbr> controllers,
smartphones, tablets, or any PC. For Linux-based systems you can use or
test these interactions using the command line program
<span class="command"><strong>oscsend</strong></span>.</p>
bla
blub
hermel
<pre class="screen">
<code class="prompt">$</code> <span class="command"><strong>oscsend localhost 9000 /Hydrogen/NEW_SONG s /tmp/new.h2song</strong></span>
</pre>
schni
<div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
To enable <abbr class="abbrev">OSC</abbr> support in Hydrogen, open the <a class="link" href="#chpt.preferences.osc_tab" title="5.4. OSC">OSC</a> tab in the Preferences dialog. Make sure that the "Enable <abbr class="abbrev">OSC</abbr>
support" checkbox is activated, otherwise Hydrogen will not listen for
incoming <abbr class="abbrev">OSC</abbr> messages.
</p></td></tr></table></div><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
Hydrogen's port number defaults to <code class="option">9000</code> for historical reasons. Since this is also the number used in the coding examples provided by <span class="command"><strong>liblo</strong></span> package, you may encounter other applications trying to register the same port (which is not possible). In order to avoid hiccups in your audio setup, it's advised to set a different default port in such cases.
</p></td></tr></table></div><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>
<span class="command"><strong>oscsend</strong></span> should only be used for sparse interactive testing and control via a command-line. Using it in scripts is not recommended since every time it sends a command it will registers a new client at the <abbr class="abbrev">OSC</abbr> server. If the <span class="bold"><strong>Enable <abbr class="abbrev">OSC</abbr> feedback</strong></span> option in the <a class="link" href="#chpt.preferences.osc_tab" title="5.4. OSC"><abbr class="abbrev">OSC</abbr></a> tab of the Preferences dialog is checked, Hydrogen will send its current state to all registered clients causing it to become slower and slower with every <span class="command"><strong>oscsend</strong></span> command sent. Soon you will experience visual lags. When unchecking this option, however, using <span class="command"><strong>oscsend</strong></span> is fine.
</p></td></tr></table></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.osc.commands"></a>17.2. Commands</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.osc.commands.syntax"></a>17.2.1. Syntax</h3></div></div></div><p>The syntax for sending the commands is</p>
bla
blub
hermel
<pre class="screen">
<code class="prompt">$</code> <span class="command"><strong>oscsend localhost OSC_PORT_NUMBER COMMAND_URL COMMAND_TYPE COMMAND_ARGUMENT</strong></span>
</pre>
schni
<p>with the supported types</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: opencircle; "><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>' '</strong></span>: no argument required</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>i</strong></span>: int32</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>f</strong></span>: float32</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>s</strong></span>: <abbr class="abbrev">OSC</abbr>-string (ASCII)</p></li></ul></div><p>Detailed description of the formats and conventions used in the
tables below</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: opencircle; "><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>ff</strong></span>: two types placed right after each
other indicated that the command requires two distinct
arguments.</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>' ',[f]</strong></span>: two types separated by a comma
indicate that two versions of the command are available. To support
<span class="command"><strong>TouchOSC</strong></span> all commands expecting no parameter
are available in an alternative version requiring a float too. In
the latter version the argument will be ignored and it is placed in
squared brackets <span class="emphasis"><em>[f]</em></span> to indicate its
inferiority compared to the non-parametric version.</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>[0,]</strong></span>: limitations in possible values of the input parameters are
indicated in the <span class="emphasis"><em>range</em></span> column. For continuous
values squared brackets
<span class="emphasis"><em>[LOWER_LIMIT,UPPER_LIMIT]</em></span> are used and a limit
will be left empty when it is associated with a "natural" boundary,
like the total number of instrument or pattern.</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>{-1;0;1}</strong></span>: sets of discrete
values are shown in curly brackets and separated semicolon
<span class="emphasis"><em>{VALUE;...}</em></span> and usually feature the most
convenient input options.</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>1.0</strong></span>: also in order to support
<span class="command"><strong>TouchOSC</strong></span> all numerical input has to be passed as type float while
most of these numbers will be rounded to integers internally. For
all true float inputs the <span class="emphasis"><em>range</em></span> column uses a
floating point representation of the limits, like 1.0 instead of 1.</p></li><li class="listitem" style="list-style-type: circle"><p><span class="bold"><strong>X</strong></span>: all commands ending with a
<span class="emphasis"><em>/X/</em></span> require this character to be replaced by an
integer and do affect only the corresponding instrument,
e.g. <span class="command"><strong>oscsend localhost 9000 /Hydrogen/PAN_ABSOLUTE/1/ f
0.3</strong></span>. The instrument number starts at 1 and is determined
by the order of the instrument in the mixer and pattern
editor.</p></li></ul></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="chpt.osc.commands.all_messages"></a>17.2.2. All Commands</h3></div></div></div><div class="table"><a name="idm3932"></a><p class="title"><b>Table 17.1. All <abbr class="abbrev">OSC</abbr> Messages</b></p><div class="table-contents"><table class="table" summary="All OSC Messages" border="1"><colgroup><col align="left" class="cURL"><col align="left" class="cType"><col align="left" class="cDescription"></colgroup><thead><tr><th align="left">URL</th><th align="left">type</th><th align="left">range</th><th align="left">description</th></tr></thead><tbody><tr><td align="left"><a name="chpt.osc.command.play"></a>/Hydrogen/<span class="bold"><strong>PLAY</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Starts playback.</td></tr><tr><td align="left"><a name="chpt.osc.command.pause"></a>/Hydrogen/<span class="bold"><strong>PAUSE</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Stops playback.</td></tr><tr><td align="left"><a name="chpt.osc.command.stop"></a>/Hydrogen/<span class="bold"><strong>STOP</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Stops playback and moves the playhead to the beginning
of the song.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>PLAY_PAUSE_TOGGLE</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Works the same as <a class="xref" href="#chpt.osc.command.play">/Hydrogen/PLAY/</a> if the
playback has not started yet and same as.
<a class="xref" href="#chpt.osc.command.pause">/Hydrogen/PAUSE/</a> otherwise. (The playhead will not
return to the start of the song, but will stay at its current
position).</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>PLAY_STOP_TOGGLE</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Works the same as <a class="xref" href="#chpt.osc.command.play">/Hydrogen/PLAY/</a> if the
playback has not started yet and same as.
<a class="xref" href="#chpt.osc.command.stop">/Hydrogen/STOP/</a> otherwise.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>RECORD_READY</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Toggles <a class="link" href="#chpt.overview.recording" title="4.4. Recording in Hydrogen">recording</a> (same as pressing the <a class="link" href="#sect.main_toolbar.transport_control" title="7.1. Transport Control">record button</a>) if the playback has not started yet.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>RECORD_STROBE_TOGGLE</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Toggles <a class="link" href="#chpt.overview.recording" title="4.4. Recording in Hydrogen">recording</a> (same as pressing the <a class="link" href="#sect.main_toolbar.transport_control" title="7.1. Transport Control">record button</a>).</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>RECORD_STROBE</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Activates <a class="link" href="#chpt.overview.recording" title="4.4. Recording in Hydrogen">recording</a>.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>RECORD_EXIT</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Deactivates <a class="link" href="#chpt.overview.recording" title="4.4. Recording in Hydrogen">recording</a>.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>NEXT_BAR</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Moves the playhead to the next pattern/bar.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>PREVIOUS_BAR</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Moves the playhead to the previous pattern/bar.</td></tr><tr><td align="left"><a name="chpt.osc.command.select_next_pattern"></a>/Hydrogen/<span class="bold"><strong>SELECT_NEXT_PATTERN</strong></span>/</td><td align="left">f</td><td align="left">[0,]</td><td align="left">If Hydrogen is in <a class="link" href="#chpt.song_editor.editor_modes.pattern_mode" title="8.2.4. Pattern Mode">Pattern mode</a>,
switch to pattern <span class="emphasis"><em>f</em></span>. If Hydrogen is in
<a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a>, the command will have no effect.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>SELECT_AND_PLAY_NEXT_PATTERN</strong></span>/</td><td align="left">f</td><td align="left">[0,]</td><td align="left">Works as <a class="xref" href="#chpt.osc.command.select_next_pattern">/Hydrogen/SELECT_NEXT_PATTERN/</a>
combined with <a class="xref" href="#chpt.osc.command.play">/Hydrogen/PLAY/</a>.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>RELOCATE</strong></span>/</td><td align="left">f</td><td align="left">[0,]</td><td align="left">If Hydrogen is in <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a>,
locates the playhead to pattern number
<span class="emphasis"><em>f</em></span>. If Hydrogen is in <a class="link" href="#chpt.song_editor.editor_modes.pattern_mode" title="8.2.4. Pattern Mode">Pattern mode</a>, locates the playhead to the beginning of the
current pattern.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>BPM_DECR</strong></span>/</td><td align="left">f</td><td align="left"></td><td align="left">Decreases the current tempo by
<span class="emphasis"><em>f</em></span>. Note that this command will have no
effect if Hydrogen is both in <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a>
and the <a class="link" href="#chpt.song_editor.timeline" title="8.4. Timeline">Timeline</a> is activated.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>BPM_INCR</strong></span>/</td><td align="left">f</td><td align="left"></td><td align="left">Increases the current tempo by
<span class="emphasis"><em>f</em></span>.
Note that this command will have no
effect if Hydrogen is both in <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a>
and <span class="emphasis"><em>Tempo Marker</em></span> has been passed.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>BEATCOUNTER</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Calculates the average time passing between successive
encounters of this commands and uses it to set the current
tempo using the <a class="link" href="#sect.main_toolbar.tap_tempo_beat_counter.beat_counter" title="7.2.2. Beat Counter">Beat Counter</a>.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>TAP_TEMPO</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Another command calculating the average time passing
between successive encounters of this commands and uses it to
set the current tempo using <a class="link" href="#sect.main_toolbar.tap_tempo_beat_counter.tap_tempo" title="7.2.1. Tap Tempo">Tap Tempo</a>.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>TIMELINE_ACTIVATION</strong></span>/</td><td align="left">f</td><td align="left">{0,1}</td><td align="left">Activates the <a class="link" href="#chpt.song_editor.timeline" title="8.4. Timeline">Timeline</a> if <span class="emphasis"><em>f</em></span> is not
zero and deactivates it otherwise.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>TIMELINE_ADD_MARKER</strong></span>/</td><td align="left">ff</td><td align="left">[0,] [10,400]</td><td align="left">Adds a Tempo Marker to the <a class="link" href="#chpt.song_editor.timeline" title="8.4. Timeline">Timeline</a>. The first argument
specifies the pattern/bar to at the marker to and the second
its tempo.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>TIMELINE_DELETE_MARKER</strong></span>/</td><td align="left">f</td><td align="left">[0,]</td><td align="left">Deletes a Tempo Marker at pattern/bar
<span class="emphasis"><em>f</em></span> on the <a class="link" href="#chpt.song_editor.timeline" title="8.4. Timeline">Timeline</a>.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>MUTE</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left"><a class="link" href="#def.mute" title="Mute">Mutes</a> the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master output</a> (sequencer keeps running).</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>UNMUTE</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Unmutes the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master output</a> (sequencer keeps running).</td></tr><tr><td align="left"><a name="chpt.osc.command.mute_toggle"></a>/Hydrogen/<span class="bold"><strong>MUTE_TOGGLE</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Toggles the muting of the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master output</a> (sequencer keeps running).</td></tr><tr><td align="left"><a name="chpt.osc.command.master_volume_absolute"></a>/Hydrogen/<span class="bold"><strong>MASTER_VOLUME_ABSOLUTE</strong></span>/</td><td align="left">f</td><td align="left">[0.0,1.5]</td><td align="left">Sets the volume of the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master fader</a>.</td></tr><tr><td align="left"><a name="chpt.osc.command.master_volume_relative"></a>/Hydrogen/<span class="bold"><strong>MASTER_VOLUME_RELATIVE</strong></span>/</td><td align="left">f</td><td align="left">{-1;0;1}</td><td align="left">Changes the <a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master output volume</a>, relative
to the current setting. For a value of <code class="option">0</code> it sets the volume of
the master fader to 0. For a value of <code class="option">1</code> it increases its
volume by 0.05 and for all other values it decreases it by
0.05. (<code class="option">-1</code>: -0.05 ,<code class="option">0</code>: 0 ,<code class="option">1</code>: +0.05)</td></tr><tr><td align="left"><a name="chpt.osc.command.strip_volume_absolute"></a>/Hydrogen/<span class="bold"><strong>STRIP_VOLUME_ABSOLUTE/X</strong></span>/</td><td align="left">f</td><td align="left">[0.0,1.5]</td><td align="left">See <a class="xref" href="#chpt.osc.command.master_volume_absolute">/Hydrogen/MASTER_VOLUME_ABSOLUTE/</a>, but
applies to the <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strip</a> provided in the <abbr class="abbrev">OSC</abbr> command path
as <span class="emphasis"><em>X</em></span>. Please not that this only affects
<a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strips</a>. Strip volume
control for <a class="link" href="#chpt.mixer.component_strips" title="13.2. Component Channel Strips">Component Channel Strips</a> is not implemented
yet).</td></tr><tr><td align="left"><a name="chpt.osc.command.strip_volume_relative"></a>/Hydrogen/<span class="bold"><strong>STRIP_VOLUME_RELATIVE/X</strong></span>/</td><td align="left">f</td><td align="left">{-1;0;1}</td><td align="left">See <a class="xref" href="#chpt.osc.command.master_volume_relative">/Hydrogen/MASTER_VOLUME_RELATIVE/</a>, but
applies to the <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strip</a> provided in the <abbr class="abbrev">OSC</abbr> command path
as <span class="emphasis"><em>X</em></span>. Please not that this only affects
<a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strips</a>. Strip volume
control for <a class="link" href="#chpt.mixer.component_strips" title="13.2. Component Channel Strips">Component Channel Strips</a> is not implemented
yet).</td></tr><tr><td align="left"><a name="chpt.osc.command.pan_absolute"></a>/Hydrogen/<span class="bold"><strong>PAN_ABSOLUTE/X</strong></span>/</td><td align="left">f</td><td align="left">[0.0,1.0]</td><td align="left">Sets the pan of instrument strip <span class="emphasis"><em>X</em></span>.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>PAN_RELATIVE/X</strong></span>/</td><td align="left">f</td><td align="left">{-1;1}</td><td align="left">Changes the <a class="link" href="#def.pan" title="Pan">pan</a> of the <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strip</a>
<span class="emphasis"><em>X</em></span>, relative to the current value. For a
value of <code class="option">1</code> it increase the pan by 0.05. For all other values
it decreases it by 0.05. (<code class="option">-1</code>: -0.05 , <code class="option">1</code>: +0.05)</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>FILTER_CUTOFF_LEVEL_ABSOLUTE/X</strong></span>/</td><td align="left">f</td><td align="left">[0,127]</td><td align="left">For a value of <code class="option">0</code> it sets the <a class="link" href="#chpt.instrument_editor.filter" title="11.1.3. Filter Parameters">Filter Cutoff</a> of the
<a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strip</a> <span class="emphasis"><em>X</em></span> to 0. For all other
values it sets the cutoff to the provided number divided by
127.0. Please note that this parameter is not displayed
anywhere in the Mixer but in the Instrument Rack.</td></tr><tr><td align="left"><a name="chpt.osc.command.strip_mute_toggle"></a>/Hydrogen/<span class="bold"><strong>STRIP_MUTE_TOGGLE/X</strong></span>/</td><td align="left">f</td><td align="left"></td><td align="left">Toggles muting of <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strip</a>
<span class="emphasis"><em>X</em></span>. Input argument will be
ignored.</td></tr><tr><td align="left"><a name="chpt.osc.command.strip_solo_toggle"></a>/Hydrogen/<span class="bold"><strong>STRIP_SOLO_TOGGLE/X</strong></span>/</td><td align="left">f</td><td align="left"></td><td align="left">Toggles soloing of <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strip</a>
<span class="emphasis"><em>X</em></span>. Input argument will be
ignored.</td></tr><tr><td align="left"><a name="chpt.osc.command.playlist_song"></a>/Hydrogen/<span class="bold"><strong>PLAYLIST_SONG</strong></span>/</td><td align="left">f</td><td align="left">[0,]</td><td align="left">Opens song <span class="emphasis"><em>f</em></span> of the <a class="link" href="#chpt.playlist_editor" title="Chapter 15. Playlist Editor">Playlist</a>.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>PLAYLIST_NEXT_SONG</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Opens the next song in the <a class="link" href="#chpt.playlist_editor" title="Chapter 15. Playlist Editor">Playlist</a>.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>PLAYLIST_PREV_SONG</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Opens the previous song in the <a class="link" href="#chpt.playlist_editor" title="Chapter 15. Playlist Editor">Playlist</a>.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>UNDO_ACTION</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Undoes the previous action.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>REDO_ACTION</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Redoes the previous undone action.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>JACK_TRANSPORT_ACTIVATION</strong></span>/</td><td align="left">f</td><td align="left">{0;1}</td><td align="left">Deactivated the <a class="link" href="#sect.preferences.jack"><abbr class="abbrev">JACK</abbr> transport</a> support for a value of <code class="option">0</code>
and activates it for all others.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>JACK_TIMEBASE_MASTER_ACTIVATION</strong></span>/</td><td align="left">f</td><td align="left">{0;1}</td><td align="left">Unregisters Hydrogen as <a class="link" href="#sect.preferences.jack.bbt"><abbr class="abbrev">JACK</abbr> Timebase Master</a>
for a value of <code class="option">0</code> and registers it for all others.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>SONG_MODE_ACTIVATION</strong></span>/</td><td align="left">f</td><td align="left">{0;1}</td><td align="left">Deactivated <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a> for a value of <code class="option">0</code> and activates it
for all others.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>LOOP_MODE_ACTIVATION</strong></span>/</td><td align="left">f</td><td align="left">{0;1}</td><td align="left">Deactivated <a class="link" href="#sect.main_toolbar.transport_control" title="7.1. Transport Control">looped playback</a> for a value of <code class="option">0</code> and activates it
for all others.</td></tr><tr><td align="left"><a name="chpt.osc.command.toggle_metronome"></a>/Hydrogen/<span class="bold"><strong>TOGGLE_METRONOME</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Toggles the <a class="link" href="#sect.main_toolbar.bpm_control_and_metronome" title="7.3. BPM Control and Metronome">metronome</a>.</td></tr><tr><td align="left"><a name="chpt.osc.command.select_instrument"></a>/Hydrogen/<span class="bold"><strong>SELECT_INSTRUMENT</strong></span>/</td><td align="left">f</td><td align="left">[0,]</td><td align="left">Selects a specific instrument in the drumkit.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>NEW_SONG</strong></span>/</td><td align="left">s</td><td align="left"></td><td align="left">Creates an empty song which will be stored at the
absolute path <span class="emphasis"><em>s</em></span>.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>OPEN_SONG</strong></span>/</td><td align="left">s</td><td align="left"></td><td align="left">Opens an existing song associated with the absolute
path <span class="emphasis"><em>s</em></span>.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>SAVE_SONG</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Saves the current song.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>SAVE_SONG_AS</strong></span>/</td><td align="left">s</td><td align="left"></td><td align="left">Saves the current song to the absolute path <span class="emphasis"><em>s</em></span>.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>SAVE_PREFERENCES</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Saves the preferences.</td></tr><tr><td align="left">/Hydrogen/<span class="bold"><strong>QUIT</strong></span>/</td><td align="left">' ',[f]</td><td align="left"></td><td align="left">Exits Hydrogen.</td></tr></tbody></table></div></div><br class="table-break"></div></div></div></div><div class="part"><div class="titlepage"><div><div><h1 class="title"><a name="part.demos"></a>Part III. Examples</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="chapter"><a href="#chpt.create_song">18. A New Song</a></span></dt><dd><dl><dt><span class="sect1"><a href="#sect.song_vs_pattern">18.1. Song Mode and Pattern Mode</a></span></dt><dt><span class="sect1"><a href="#sect.create_pattern">18.2. A New Pattern</a></span></dt><dt><span class="sect1"><a href="#sect.create_sequence">18.3. A New Sequence</a></span></dt><dt><span class="sect1"><a href="#sect.create_song.adjust_mixer">18.4. Adjust from the Mixer</a></span></dt></dl></dd><dt><span class="chapter"><a href="#chpt.examples.drumkit">19. Create a New Drumkit</a></span></dt><dd><dl><dt><span class="sect1"><a href="#chpt.examples.drumkit.new_kit">19.1. Creating a New Drumkit</a></span></dt><dt><span class="sect1"><a href="#chpt.examples.drumkit.new_instrument">19.2. Creating a New Instrument</a></span></dt><dt><span class="sect1"><a href="#chpt.instrument_editor.tips">19.3. Tips on Editing Instruments</a></span></dt></dl></dd></dl></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.create_song"></a>Chapter 18. A New Song</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#sect.song_vs_pattern">18.1. Song Mode and Pattern Mode</a></span></dt><dt><span class="sect1"><a href="#sect.create_pattern">18.2. A New Pattern</a></span></dt><dt><span class="sect1"><a href="#sect.create_sequence">18.3. A New Sequence</a></span></dt><dt><span class="sect1"><a href="#sect.create_song.adjust_mixer">18.4. Adjust from the Mixer</a></span></dt></dl></div><p>
This chapter provides a quick-and-dirty walkthrough to Hydrogen. Refer to the
tutorials and the technical <a class="xref" href="#part.using_hydrogen" title="Part II. Using Hydrogen">Part II</a> of this document for a more detailed overview.
</p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.song_vs_pattern"></a>18.1. Song Mode and Pattern Mode</h2></div></div></div><p>Hydrogen has two main modes: <a class="link" href="#chpt.song_editor.editor_modes.pattern_mode" title="8.2.4. Pattern Mode">Pattern mode</a> and <a class="link" href="#chpt.song_editor.editor_modes.song_mode" title="8.2.3. Song Mode">Song mode</a>. When
<span class="emphasis"><em>Pattern mode</em></span> is activated the current pattern is continuously repeated.
This mode is very well suited to tweak your pattern until it's just right, since the
pattern you are working on is constantly repeated. This way you can immediately
hear the changes you have made. In <span class="emphasis"><em>Song mode</em></span> the whole song is played.
This is useful when putting together the patterns to create the structure of the song.</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.create_pattern"></a>18.2. A New Pattern</h2></div></div></div><p>We'll start from the empty song with an empty pattern created when
Hydrogen starts up: <span class="emphasis"><em>Pattern mode</em></span> should be selected by default. Now
let's click on the
<span class="inlinemediaobject"><img src="img/btn_play_off.png" alt="Grey play and pause button containing two vertical black lines (left) and a black triangle (right) pointing to the right."></span>
button in the <a class="link" href="#sect.main_toolbar.transport_control" title="7.1. Transport Control">Main Toolbar</a>, and while the pattern is playing
let's add notes by <span class="emphasis"><em>left-clicking</em></span> in the grid of the <a class="link" href="#chpt.pattern_editor" title="Chapter 9. Pattern Editor">Pattern Editor</a>
(see <a class="xref" href="#fig.pattern_editor.2" title="Figure 18.1. The Pattern Editor">Figure 18.1</a>). Adjust the <a class="link" href="#chpt.pattern_editor.controls.res">grid resolution</a> and <a class="link" href="#sect.main_toolbar.bpm_control_and_metronome" title="7.3. BPM Control and Metronome">tempo</a> if needed.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Remember some constraints of the grid: if you are
working with a resolution of <code class="option">1/16</code>, you can't go back to <code class="option">1/8</code> and remove a
16th note; same thing happens if you are working with a resolution of
<code class="option">1/8</code> and you try to insert a note in the middle of two bars (looking for
a 16 bars precision): they will be placed on the previous or on the
following 8th bar (unless you choose <code class="option">off</code> from the Grid Resolution LCD in which case
you're free to place notes wherever you prefer). <span class="bold"><strong>Be
sure to select the correct pattern in the <a class="link" href="#chpt.song_editor.sidebar" title="8.3. Sidebar">Sidebar</a> of the Song Editor before adding notes
in the Pattern Editor!</strong></span>
</p></td></tr></table></div><p>
</p><div class="figure"><a name="fig.pattern_editor.2"></a><p class="title"><b>Figure 18.1. The Pattern Editor</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/PatternEditor.png" alt="The Pattern Editor"></div></div></div><br class="figure-break"></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.create_sequence"></a>18.3. A New Sequence</h2></div></div></div><p>Once patterns are created (<a class="xref" href="#fig.insert_patterns" title="Figure 18.2. Inserting Patterns in the Song Sequence">Figure 18.2</a>), we
can copy/paste/delete them using the <a class="link" href="#chpt.song_editor.editor_modes.select" title="8.2.1. Select Mode">Select mode</a>.
</p><div class="figure"><a name="fig.insert_patterns"></a><p class="title"><b>Figure 18.2. Inserting Patterns in the Song Sequence</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/SongEditor.png" alt="Inserting Patterns in the Song Sequence"></div></div></div><br class="figure-break"></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect.create_song.adjust_mixer"></a>18.4. Adjust from the Mixer</h2></div></div></div><p>Of course we can always use the <a class="link" href="#chpt.mixer" title="Chapter 13. Mixer">Mixer</a> window, either when creating
or playing patterns.</p><p>The Mixer (see <a class="xref" href="#fig.mixer.2" title="Figure 18.3. The Mixer">Figure 18.3</a>) is made of a number
independent <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Instrument Channel Strips</a>, each of these is bound to an instrument, plus a
<a class="link" href="#chpt.mixer.master_fader_strip" title="13.4. Master Fader Strip">Master Fader Strip</a> and a
<span class="inlinemediaobject"><img src="img/showFX_on.png" alt='Blue button containing the black characters "FX".'></span>
button to show and hide the
<a class="link" href="#sect.fx_rack_LADSPA" title="13.3. FX Rack and LADSPA Plugins">FX Plugin Rack</a>.
Every line features 3 buttons (
<span class="inlinemediaobject"><img src="generated_en/btn_play_on_mixer.png" alt="Grey button with a filled black triangle pointing to the right."></span>
<span class="inlinemediaobject"><img src="generated_en/btn_solo_on.png" alt='Grey button containing a black "S".'></span>
<span class="inlinemediaobject"><img src="generated_en/btn_mute_on.png" alt='Grey button containing a black "M".'></span>
), current maximum peak, FX volume control knobs, volume fader, and name of the track. Clicking on
<span class="inlinemediaobject"><img src="generated_en/btn_solo_on.png" alt='Grey button containing a black "S".'></span>
will play the selected instrument, cutting the others. The Mute button
<span class="inlinemediaobject"><img src="generated_en/btn_mute_on.png" alt='Grey button containing a black "M".'></span>
, simply <a class="link" href="#def.mute" title="Mute">mute</a> <span class="emphasis"><em>that</em></span> instrument. The maximum peak
indicates the maximum volume reached from the instrument. The peak must
be in a range of <code class="option">0.0</code> and <code class="option">1.0</code> (in <a class="xref" href="#fig.mixer.2" title="Figure 18.3. The Mixer">Figure 18.3</a> you can
see a few volumes too loud). For a full description of the Mixer and its elements please see <a class="xref" href="#chpt.mixer" title="Chapter 13. Mixer">Mixer</a>.
</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
Peaks outside that range will get distorted
(especially with <abbr class="abbrev">OSS</abbr> audio driver). Keep an eye on each VU meter and
if distortion appears, turn the volume down for that instrument.
</p></td></tr></table></div><p>
</p><div class="figure"><a name="fig.mixer.2"></a><p class="title"><b>Figure 18.3. The Mixer</b></p><div class="figure-contents"><div class="mediaobject"><img src="generated_en/Mixer.png" alt="The Mixer"></div></div></div><br class="figure-break"></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.examples.drumkit"></a>Chapter 19. Create a New Drumkit</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="#chpt.examples.drumkit.new_kit">19.1. Creating a New Drumkit</a></span></dt><dt><span class="sect1"><a href="#chpt.examples.drumkit.new_instrument">19.2. Creating a New Instrument</a></span></dt><dt><span class="sect1"><a href="#chpt.instrument_editor.tips">19.3. Tips on Editing Instruments</a></span></dt></dl></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.examples.drumkit.new_kit"></a>19.1. Creating a New Drumkit</h2></div></div></div><p>In this chapter we will show you how to create a complete drumkit. Be sure to have a look at the <a class="link" href="#chpt.overview.drumkits" title="4.2. Drumkit Concept">conceptional design of a drumkit</a> first.
Keeping this in mind
we will use a top-down approach, so we will start at the Drumkit level and work our way
down to the <a class="link" href="#def.sample" title="Sample">samples</a>.</p><p>Creating a <a class="link" href="#sect.main_menu.drumkits.new">new drumkit</a> with Hydrogen is done with the <a class="link" href="#chpt.instrument_editor" title="Chapter 11. Instrument Editor">Instrument
Editor</a>. You can load samples, set envelope
parameters, set the gain, and other advanced features like mute groups, a low-pass resonance filter, and pitch randomization.</p><div class="tip" style="margin-left: 5%;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="img/admonitions/tip.svg"></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>
Instead of creating your own drumkit, you can also <a class="link" href="#sect.main_menu.drumkits.open">open</a> or <a class="link" href="#sect.main_form.online_import_drumkit">download</a> an existing one.
</p></td></tr></table></div><p>Lets make a brand new drum kit:</p><div class="procedure"><ol class="procedure" type="1"><li class="step"><p>in the <a class="link" href="#chpt.main_menu" title="Chapter 6. Main Menu">Main Menu</a> select
<span class="guimenu">Drumkits</span> → <span class="guimenuitem">New</span>. This will give you a single blank instruments. To add more instruments,
select
<span class="guimenu">Instruments</span> → <span class="guimenuitem">Add instrument</span> and to delete one, <span class="emphasis"><em>right-click</em></span> a instrument and select
<span class="emphasis"><em>Delete Instrument</em></span>.
</p></li><li class="step"><p>Select an instrument to start editing it. This is done by
<span class="emphasis"><em>left-clicking</em></span> on the name of the instrument in the <a class="link" href="#chpt.pattern_editor.sidebar" title="9.1.2. Sidebar">Sidebar</a>. You will notice that the name of the instrument in the
Instrument Editor matches the one that you clicked.</p></li><li class="step"><p>Once you have your drumkit working the way you want, select
<span class="guimenuitem">Drumkits</span> → <span class="guimenuitem">Save As</span>
. You will be prompted for the name of the kit to save. If you wish to
<span class="emphasis"><em>overwrite</em></span> an existing kit, you will need to type in
the same name as the kit that you want to replace.</p></li><li class="step"><p>Drumkits are automatically stored in the <code class="filename">data</code> directory (i.e. <code class="filename">$HOME/.hydrogen/data/drumkits</code>).</p></li><li class="step"><p>In order to share your drumkit with others, you have to export it using
<span class="guimenuitem">Drumkits</span> → <span class="guimenuitem">Export</span>
from the <a class="link" href="#chpt.main_menu" title="Chapter 6. Main Menu">Main Menu</a>. Select the drum kit that you wish to export, and give it
a file name to save it to.</p></li></ol></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.examples.drumkit.new_instrument"></a>19.2. Creating a New Instrument</h2></div></div></div><p>For each instrument in a drum kit, you can load several <a class="link" href="#def.sample" title="Sample">samples</a>
and set different synthesizer parameters. This section will step you
through how to create a new instrument and load the samples. For details about the individual parameters please refer to <a class="xref" href="#chpt.instrument_editor.general" title="11.1. General">Section 11.1</a>.</p><p>To begin creating an instrument, select
<span class="guimenu">Instruments</span> → <span class="guimenuitem">Add instrument</span>. This will give you a blank
instrument to start from.</p><p>Now, you need two samples. Any .WAV or .FLAC file will do.
Hydrogen provides several in the <code class="filename">data/drumkits</code> folder in the Hydrogen data
directory (usually <code class="filename">$HOME/.hydrogen/data/</code>).</p><p>In the Instrument Editor, click on <a class="link" href="#chpt.instrument_editor.layers" title="11.2. Layers">Layers</a>.
You can layer several samples into the instrument. Which one is played
depends on the <a class="link" href="#def.velocity" title="Velocity">velocity</a> of the incoming note. Click
<span class="inlinemediaobject"><img src="generated_en/loadLayer_off.png" alt='Grey button containing the black characters "LOAD LAYER".'></span> and point the <span class="emphasis"><em>Audio File Browser</em></span> to
your sample.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
The <span class="emphasis"><em>Audio File Browser</em></span> will
allow you to preview the sample before you load it. It will also allow
you to load more than one sample at a time. But for now, only load
one.
</p></td></tr></table></div><p>After you load the sample, you'll see that there is now a
<span class="guilabel">1</span> at the top, and the topmost rectangle has turned
light blue. To load a second sample, click the slot just below it, and
then click
<span class="inlinemediaobject"><img src="generated_en/loadLayer_off.png" alt='Grey button containing the black characters "LOAD LAYER".'></span>
to bring in another sample.
</p><p>After bringing in both samples, you'll probably notice that only
the <span class="emphasis"><em>first</em></span> sample is being played whenever you
trigger the instrument. This is because you need to set the
<span class="emphasis"><em>velocity</em></span> ranges for the layers. Move your mouse to
the sides of the light blue rectangles and you see that you get a
<span class="emphasis"><em>left-right drag</em></span> cursor. Now <span class="emphasis"><em>drag</em></span> the sample to the left or right (like
a curtain). You will now see Layer 2 appear.</p><p>The velocity setting for the layer is 0-velocity on the left, and
full velocity on the right. Set up Layer 1 to sound for soft notes, and
Layer 2 to sound for hard notes, i.e. Layer 1 on the left and Layer 2
on the right (see <a class="link" href="#chpt.instrument_editor.layers.sample_selection" title="11.2.3. Sample Selection">Sample Selection</a> for further info).</p><p>Now, in the <a class="link" href="#chpt.pattern_editor.drumkit" title="9.2. Drum Pattern Editor">Drumkit Editor</a>, set up a simple pattern that plays this
instrument. Adjust the velocity settings on each note in the <a class="link" href="#chpt.pattern_editor.note_properties" title="9.3. Note Properties Editor">Note Properties Editor</a> so that you can
get the different samples to sound. Now, set the playback to <a class="link" href="#sect.main_toolbar.transport_control" title="7.1. Transport Control">loop</a> and
notice how your different samples are getting triggered. To learn
about editing a pattern, see <a class="xref" href="#chpt.pattern_editor" title="Chapter 9. Pattern Editor">Chapter 9</a>.</p><p>For each layer, you can set the <span class="guibutton">Gain</span> and
the <span class="guibutton">Pitch</span>. The pitch also has a
<span class="guibutton">Fine</span> adjustment.</p><p>Use the <a class="link" href="#chpt.instrument_editor.gain_and_mute_group" title="11.1.2. Gain and Mute Group">Gain</a> adjustment to control how loud
the sample will be played. This is necessary because it's extremely
difficult to get a set of samples that all sound at about the same
volume. By adjusting here, the samples that were recorded too quietly
can be turned up to match your loud samples (that had to be turned
down).
</p><div class="warning" style="margin-left: 5%;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="img/admonitions/warning.svg"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>It is very easy to set the <span class="guibutton">Gain</span> too high,
causing your sample to <a class="link" href="#def.clipping" title="Clipping">clip</a>. Remember to test the gain with
full-velocity using the
<span class="inlinemediaobject"><img src="generated_en/btn_play_on_mixer.png" alt="Grey button with a filled black triangle pointing to the right."></span>
button in the corresponding Instrument Channel Strip. If you clip your signal here, it will only get
worse as Hydrogen processes it.</p></td></tr></table></div><p>The pitch of the sample can be modified with the pitch controls.
The <span class="guibutton">Pitch</span> knob adjust the pitch in musical
half-steps. (So, <code class="option">-12</code> is down 1 octave). The pitch on the right adjusts
the pitch 50 cents. (One half-step is 100 cents.)</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>The pitch is adjusted by playing the sample back faster or
slower. This is called the Doppler Effect. So, if you have a
1-second sample that you turn down <code class="option">12</code> (1 octave), your sample will
only last for 0.5-seconds. If you do not want this to happen you should
use Rubber Band instead (see <a class="xref" href="#chpt.sample_editor.pitch" title="12.2. Pitch Shifting">Section 12.2</a>)</p></td></tr></table></div><p>You can hear the sample in a layer by clicking the layer id (just
below the 'General' and 'Layers' buttons).</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="chpt.instrument_editor.tips"></a>19.3. Tips on Editing Instruments</h2></div></div></div><p>With all of the different parameters available to tweak, it can be
difficult to set up something that sounds nice when you're done. Here are
a few tips on setting up an instrument:</p><p><span class="bold"><strong>Turn down the gain.</strong></span> Every gain
knob (i.e. an amplifier), this is a <span class="emphasis"><em>gain stage</em></span>.
With every gain stage you have, it's
easy to overdrive your signal - which means the signal gets
distorted by <a class="link" href="#def.clipping" title="Clipping">clipping</a>. In addition, if you have two samples that, by
themselves, peg your meters - what do you think happens when you
combine them? That's right, you overdrive the signal again.</p><p>If things sound bad and distorted, start by turning down the gain
setting on the layer... especially if it's larger than 1.0. Then turn
down the instrument gain. Then any gain on a <abbr class="abbrev">LADSPA</abbr> effect. Then the
fader on the Mixer. Then the master output fader.</p><p><span class="bold"><strong>Test samples at full velocity.</strong></span>
Your sample will be played louder if the velocity is higher. So, if you
set everything to sound nice and full with velocity at 0.7, what will
happen when you get a full velocity of 1.0? (<span class="emphasis"><em>Hint:
<a class="link" href="#def.clipping" title="Clipping">clipping</a>.</em></span>)</p><p><span class="bold"><strong>Try to use samples that are -6 dB
max.</strong></span> Visually, this means samples that peak at only
1/2 of full scale. Otherwise, turn your layer gain to about
.5.</p><p><span class="bold"><strong>Remove all DC offsets from the
sample.</strong></span> In a sample editor, there is usually a line down the
center of your sample's waveform. This is the zero-line. The beginning
of your sample should be on this line. The end of your sample should
also be on this line. However, if your signal is a little above or a
little below this line, you will hear a click at the beginning and the
end of your sample whenever it is played. If your sample editor doesn't
provide any tools to fix a DC offset problem, you can eliminate the
noise by putting a slight fade-in/out at the ends of your sample.</p><p><span class="bold"><strong>The ADSR will not be longer than your
sample.</strong></span> If you have a short sample, it doesn't matter how
long you set the attack and delay - the sample will stop playing
at the end.</p><p><span class="bold"><strong>Things change with the sample
rate.</strong></span> If you have a really nice setup with all your
parameters painstakingly tweaked... things <span class="emphasis"><em>will</em></span>
change if you change the sample rate of your audio card. Many of
Hydrogen's internal settings and parameters are based on how many
samples go by, not on how many seconds go by. The sorts of things
that change are: anything time-base (like attack and release) and
anything frequency based (like the cutoff frequency).</p><p>
Typical samples that are used in Hydrogen are: the sound of a single
drum hit, the sound of a single cymbal hit, the sound of a single
cowbell hit. Whenever you put a note in the pattern (or play a note
using <abbr class="abbrev">MIDI</abbr>), Hydrogen will play whatever sound you have loaded. So,
to put together a drum kit you need to gather short recordings of the
bass drum, each tom, each cymbal, the high hat open, the high hat
closed, the snare drum (snare on), the snare drum (snare off), rim
shots, etc.
</p><p>
However, there are no rules about what a sample can be. It's not
uncommon to use Hydrogen to trigger non-drum sounds like: audio clips
of people talking, a clip from a song, sound effects, audio clips from
movies, and famous people speaking. Be creative!
</p></div></div></div><div class="part"><div class="titlepage"><div><div><h1 class="title"><a name="appendix"></a>Part IV. Appendix</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="chapter"><a href="#chpt.file_types">20. Used File Types</a></span></dt><dt><span class="chapter"><a href="#chap.shortcuts">21. Shortcut Lists</a></span></dt><dt><span class="glossary"><a href="#glossary">Glossary</a></span></dt></dl></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chpt.file_types"></a>Chapter 20. Used File Types</h2></div></div></div><p>Before working with Hydrogen, please familiarize with these
file types:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a name="chpt.file_types.h2pattern"></a><span class="bold"><strong>*.h2pattern</strong></span>: <abbr class="abbrev">XML</abbr> file
describing a single pattern. Patterns are group of beats and are
managed in the pattern editor.</p></li><li class="listitem"><p><a name="chpt.file_types.h2song"></a><span class="bold"><strong>*.h2song</strong></span>: <abbr class="abbrev">XML</abbr> file describing
the whole song (or sequence). Songs are group of patterns with their
properties and are manager using the song editor</p></li><li class="listitem"><p><a name="chpt.file_types.h2playlist"></a><span class="bold"><strong>*.h2playlist</strong></span>: <abbr class="abbrev">XML</abbr> file
describing a playlist. A Playlist is a (ordered) group of songs.</p></li><li class="listitem"><p><a name="chpt.file_types.h2drumkit"></a><span class="bold"><strong>*.h2drumkit</strong></span>: a compressed and
archived folder containing all sound samples composing a drumkit and a
description <abbr class="abbrev">XML</abbr> file. Drumkits are basically group of sound
samples.</p></li></ul></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a name="chap.shortcuts"></a>Chapter 21. Shortcut Lists</h2></div></div></div><div class="table"><a name="sect.shortcut.table"></a><p class="title"><b>Table 21.1. Shortcut Table</b></p><div class="table-contents"><table class="table" summary="Shortcut Table" border="1"><colgroup><col align="left" class="cShortcut"><col align="left" class="cDescription"></colgroup><thead><tr><th align="left">Shortcut</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>N</strong></span></td><td align="left">New Project</td></tr><tr><td align="left"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>O</strong></span></td><td align="left">Open File</td></tr><tr><td align="left"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>D</strong></span></td><td align="left">Open Demo</td></tr><tr><td align="left"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>S</strong></span></td><td align="left">Save Song</td></tr><tr><td align="left"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>Shift</strong></span> + <span class="keycap"><strong>S</strong></span></td><td align="left">Save Song as</td></tr><tr><td align="left"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>P</strong></span></td><td align="left">Export Pattern as</td></tr><tr><td align="left"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>M</strong></span></td><td align="left">Export MIDI file</td></tr><tr><td align="left"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>E</strong></span></td><td align="left">Export Song (see <a class="xref" href="#sect.main_form.export_song">Export Song</a>)</td></tr><tr><td align="left"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>L</strong></span></td><td align="left">Export LilyPond file</td></tr><tr><td align="left"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>Q</strong></span></td><td align="left">Quit Hydrogen</td></tr><tr><td align="left"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>Z</strong></span></td><td align="left">Undo an action</td></tr><tr><td align="left"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>Shift</strong></span> + <span class="keycap"><strong>Z</strong></span></td><td align="left">Redo an action</td></tr><tr><td align="left"><span class="keycap"><strong>Alt</strong></span> + <span class="keycap"><strong>D</strong></span></td><td align="left">Show <a class="link" href="#chpt.director" title="Chapter 14. Director">Director</a></td></tr><tr><td align="left"><span class="keycap"><strong>Alt</strong></span> + <span class="keycap"><strong>M</strong></span></td><td align="left">Show <a class="link" href="#chpt.mixer" title="Chapter 13. Mixer">Mixer</a></td></tr><tr><td align="left"><span class="keycap"><strong>Alt</strong></span> + <span class="keycap"><strong>I</strong></span></td><td align="left">Show <a class="link" href="#chpt.sound_library" title="Chapter 10. Sound Library (Drumkit/Pattern/Song Manager)">Instrument Rack</a></td></tr><tr><td align="left"><span class="keycap"><strong>Alt</strong></span> + <span class="keycap"><strong>A</strong></span></td><td align="left">Show <a class="link" href="#sect.song_editor.automation_path" title="8.7. Automation Path">Automation Path</a></td></tr><tr><td align="left"><span class="keycap"><strong>Alt</strong></span> + <span class="keycap"><strong>F</strong></span></td><td align="left">Toggle fullscreen mode</td></tr><tr><td align="left"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>Alt</strong></span> + <span class="keycap"><strong>I</strong></span></td><td align="left">Set <a class="link" href="#chpt.overview.midi_mapping_and_virtual_keyboard" title="4.3. MIDI-mapping and Virtual Keyboard">Input mode</a> to <code class="option">Instrument</code></td></tr><tr><td align="left"><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>Alt</strong></span> + <span class="keycap"><strong>D</strong></span></td><td align="left">Set <a class="link" href="#chpt.overview.midi_mapping_and_virtual_keyboard" title="4.3. MIDI-mapping and Virtual Keyboard">Input mode</a> to <code class="option">Drumkit</code></td></tr><tr><td align="left"><span class="keycap"><strong>Alt</strong></span> + <span class="keycap"><strong>P</strong></span></td><td align="left">Show <a class="link" href="#chpt.preferences" title="Chapter 5. Preferences">Preferences</a></td></tr><tr><td align="left"><span class="keycap"><strong>Alt</strong></span> + <span class="keycap"><strong>?</strong></span></td><td align="left">Show Manual</td></tr><tr><td align="left"><span class="keycap"><strong>Backspace</strong></span></td><td align="left">Restart song or pattern from the beginning</td></tr><tr><td align="left"><a name="chap.shortcuts.space"></a><span class="keycap"><strong>Space</strong></span></td><td align="left">Play / Pause</td></tr><tr><td align="left"><a name="chap.shortcuts.ctrl_space"></a><span class="keycap"><strong>Ctrl</strong></span> + <span class="keycap"><strong>Space</strong></span></td><td align="left">Starts playback at the current cursor position. If playback is already rolling, it will relocate to the cursor position without pausing or stopping playback. Note that on MacOS this shortcut is bound to <span class="keycap"><strong>Alt</strong></span> + <span class="keycap"><strong>Space</strong></span>.</td></tr><tr><td align="left"><span class="keycap"><strong>,</strong></span></td><td align="left">Use the <a class="link" href="#sect.main_toolbar.tap_tempo_beat_counter.beat_counter" title="7.2.2. Beat Counter">Beat Counter</a></td></tr><tr><td align="left"><span class="keycap"><strong>\</strong></span></td><td align="left">Use <a class="link" href="#sect.main_toolbar.tap_tempo_beat_counter.tap_tempo" title="7.2.1. Tap Tempo">Tap Tempo</a></td></tr><tr><td align="left"><span class="keycap"><strong>+</strong></span></td><td align="left">Increase tempo by 0.1 BPM</td></tr><tr><td align="left"><span class="keycap"><strong>-</strong></span></td><td align="left">Decrease tempo by 0.1 BPM</td></tr><tr><td align="left"><a name="chap.shortcuts.f5"></a><span class="keycap"><strong>F5</strong></span></td><td align="left">Jump to previous song in <a class="link" href="#chpt.playlist_editor" title="Chapter 15. Playlist Editor">playlist</a></td></tr><tr><td align="left"><a name="chap.shortcuts.f6"></a><span class="keycap"><strong>F6</strong></span></td><td align="left">Jump to next song in <a class="link" href="#chpt.playlist_editor" title="Chapter 15. Playlist Editor">playlist</a></td></tr><tr><td align="left"><span class="keycap"><strong>F9</strong></span></td><td align="left">Jump to previous bar in the song</td></tr><tr><td align="left"><span class="keycap"><strong>F10</strong></span></td><td align="left">Jump to next bar in the song</td></tr><tr><td align="left"><span class="keycap"><strong>F12</strong></span></td><td align="left">Panic button (stops the song and mutes all
playing sounds) </td></tr></tbody></table></div></div><br class="table-break"></div><div class="glossary"><div class="titlepage"><div><div><h2 class="title"><a name="glossary"></a>Glossary</h2></div></div></div><p>This is a glossary of general terms encountered when using Hydrogen,
synthesizers, drums, or samplers. The definitions here provide more
detail and explanation than the simplified ones in the text. For
example, the text of the manual would have you believe that an ADSR is
the only kind of envelope generator and could only ever control the
volume. While the simplified definitions help new users start using
Hydrogen quickly, they can lack the nuances presented here.</p><dl><dt><a name="def.adsr"></a><span class="glossterm">ADSR</span></dt><dd class="glossdef"><p>A type of envelope generator that allows you to control the
<a class="link" href="#def.attack" title="Attack">Attack</a>,
<a class="link" href="#def.decay" title="Decay">Decay</a>,
<a class="link" href="#def.sustain" title="Sustain">Sustain</a>, and
<a class="link" href="#def.release" title="Release">Release</a> parameters.
Generally, the
parameters are proportional to
the <a class="link" href="#def.velocity" title="Velocity">velocity</a>.</p><p>
After you trigger
a note, Hydrogen will start the <a class="link" href="#def.attack" title="Attack">attack</a> phase in which the volume of the note is increase from 0 to its full <a class="link" href="#def.velocity" title="Velocity">velocity</a>.
After reaching full velocity, the volume will <a class="link" href="#def.decay" title="Decay">decay</a> until it reaches the
<a class="link" href="#def.sustain" title="Sustain">sustain</a> level. When the note is
<a class="link" href="#def.release" title="Release">released</a>, Hydrogen reduces the volume from the
sustain level back down to 0.
</p><p>In Hydrogen, the ADSR envelope generator only controls the volume
(attenuation).</p><p>Read more about this in the Wikipedia
Article <a class="ulink" href="http://en.wikipedia.org/wiki/ADSR_envelope" target="_top">ADSR
Envelope</a></p><p>See Also <a class="glossseealso" href="#def.envelopegenerator">Envelope Generator</a>, <a class="glossseealso" href="#def.attack">Attack</a>, <a class="glossseealso" href="#def.decay">Decay</a>, <a class="glossseealso" href="#def.sustain">Sustain</a>, <a class="glossseealso" href="#def.release">Release</a>.</p></dd><dt><a name="def.attack"></a><span class="glossterm">Attack</span></dt><dd class="glossdef"><p>This is the first phase of an <a class="link" href="#def.adsr" title="ADSR">ADSR</a> envelope. It represents the amount
of <span class="emphasis"><em>time</em></span> to increase the volume of a note from
0 (triggering) to full <a class="link" href="#def.velocity" title="Velocity">velocity</a>.</p><p>See Also <a class="glossseealso" href="#def.adsr">ADSR</a>.</p></dd><dt><a name="def.attenuation"></a><span class="glossterm">Attenuation</span></dt><dd class="glossdef"><p>In filters and mixers, this the amount that a signal is reduced
(volume).</p><p>See Also <a class="glossseealso" href="#def.rolloff">Roll-off</a>.</p></dd><dt><a name="def.bandpassfilter"></a><span class="glossterm">Band-Pass Filter</span></dt><dd class="glossdef"><p>A filter that preserves a certain band of frequencies, and
attenuates (silences) all others. This is often done by combining a
high-pass and a low-pass filter.</p><p>See Also <a class="glossseealso" href="#def.filter">Filter</a>, <a class="glossseealso" href="#def.highpassfilter">High-Pass Filter</a>, <a class="glossseealso" href="#def.lowpassfilter">Low-Pass Filter</a>.</p></dd><dt><a name="def.clipping"></a><span class="glossterm">Clipping</span></dt><dd class="glossdef"><p>A phenomenon that happens to a signal when its amplitude is too large
for whatever is receiving it. The peaks of the signal (which are
normally smooth curves) get cut off straight at the max volume
(clipped). This distorts the sound and is usually undesirable.</p><p>An example of clipping is when you play music louder than your
speaker can handle. Parts of the music sound harsh and fuzzy.</p></dd><dt><a name="def.component"></a><span class="glossterm">Component</span></dt><dd class="glossdef"><p>
A component is a part of Hydrogen's instrument model.
Instrument consist of one or more components, and each component consists of one or more layers.
</p><p>To make an example: A snare could have two components.
One component includes sounds from the top side of the snare drum, and the other component includes
the sounds from the bottom side of the snare drum (where the snare wires are fitted).
Each component can consist of several layers (snare drum hits with different velocities).
Now you can adjust the volume of the two components to build your ideal drum sound.
If you want more of the attack, you can put in more of the "top head" component.
If you want more of the snare wires, you put in more of the bottom component.
</p><div class="note" style="margin-left: 5%;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="img/admonitions/note.svg"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>
Components will be created for all instruments. So, even if you just want to have two of them in the snare you will automatically have two components in all other instruments. If you thus remove an empty component in one instrument, you will remove it for all other instruments - even if they are non-empty - too.
</p><p>
In addition, all <a class="link" href="#def.layer" title="Layer">layers</a> belonging to the same component do share a common volume fader in the <a class="link" href="#chpt.mixer.component_strips" title="13.2. Component Channel Strips">Component Channel Strips</a> in the Mixer.
</p></td></tr></table></div><p>
</p></dd><dt><a name="def.cutoff"></a><span class="glossterm">Cutoff Frequency</span></dt><dd class="glossdef"><p>On high-pass and low-pass filters, this is the frequency that
divides between those that pass, and those that are attenuated
(silenced). In a high-pass resonance filter, or a low-pass resonance
filter, the cutoff is also the frequency zone that gets boosted.</p><p>For example, if you have a low-pass filter and you set the cutoff
frequency high (i.e. 20kHz)... the filter will not affect the sound.
All the audible frequencies will pass through undisturbed. As you lower
the cutoff frequency to something like 40 Hz (the low string on a bass
guitar), it sounds like someone is putting a blanket over the speaker.
The higher frequencies are being attenuated above 30 Hz.</p><p>See Also <a class="glossseealso" href="#def.filter">Filter</a>, <a class="glossseealso" href="#def.highpassfilter">High-Pass Filter</a>, <a class="glossseealso" href="#def.lowpassfilter">Low-Pass Filter</a>, <a class="glossseealso" href="#def.resonancefilter">Resonance Filter</a>.</p></dd><dt><a name="def.decay"></a><span class="glossterm">Decay</span></dt><dd class="glossdef"><p>After the <a class="link" href="#def.attack" title="Attack">attack</a> phase, this is the amount
of <span class="emphasis"><em>time</em></span> for the volume of a note to decrease from full
<a class="link" href="#def.velocity" title="Velocity">velocity</a> to the <a class="link" href="#def.sustain" title="Sustain">sustain</a> level.</p><p>See Also <a class="glossseealso" href="#def.adsr">ADSR</a>.</p></dd><dt><a name="def.dc-offsety"></a><span class="glossterm">DC-offset</span></dt><dd class="glossdef"><p>DC offset, or DC coefficient is the mean value of the waveform.</p><p>DC offset is usually undesirable. For example, in audio processing, a
sound that has DC offset will not be at its loudest possible volume when
<a class="link" href="#def.normalization" title="Normalization">normalized</a> (because the offset consumes headroom), and this problem can
possibly extend to the mix as a whole, since a sound with DC offset and a sound
without DC offset will have DC offset when mixed. It may also cause other artifacts
depending on what is being done with the signal.</p></dd><dt><a name="def.envelopegenerator"></a><span class="glossterm">Envelope Generator</span></dt><dd class="glossdef"><p>A way to control (change) a parameter over time as a response to
triggering, holding, and releasing a note.</p><p>Did your eyes just glaze over? Let's try again:</p><p>Imagine that you're playing a note on the keyboard and you have
your other hand on a knob (volume, filter cutoff, etc.). As you play
the note, you twist the knob (often up, then down... or down, then up).
You do the same thing on each note. That's what an envelope generator
does. See also <a class="link" href="#def.adsr" title="ADSR">ADSR</a></p></dd><dt><a name="def.fader"></a><span class="glossterm">Fader</span></dt><dd class="glossdef"><p>A slider control used to adjust the attenuation (volume) in a
mixer. Faders always have an "audio" taper, which means that the
attenuation amount changes on an exponential scale.</p></dd><dt><a name="def.filter"></a><span class="glossterm">Filter</span></dt><dd class="glossdef"><p>A device that changes a sound by attenuating specific frequencies.
A tone knob is an example of a simple, low-pass filter.</p><p>See Also <a class="glossseealso" href="#def.bandpassfilter">Band-Pass Filter</a>, <a class="glossseealso" href="#def.highpassfilter">High-Pass Filter</a>, <a class="glossseealso" href="#def.lowpassfilter">Low-Pass Filter</a>, <a class="glossseealso" href="#def.resonancefilter">Resonance Filter</a>.</p></dd><dt><a name="def.gain"></a><span class="glossterm">Gain</span></dt><dd class="glossdef"><p>In an amplifier, this adjust how much (or how little) a signal is
amplified (volume). A higher gain value is a louder signal.</p></dd><dt><a name="def.highpassfilter"></a><span class="glossterm">High-Pass Filter</span></dt><dd class="glossdef"><p>A filter that attenuates (silences) low frequencies, but allows
high frequencies to pass through.</p><p>See Also <a class="glossseealso" href="#def.filter">Filter</a>, <a class="glossseealso" href="#def.cutoff">Cutoff Frequency</a>.</p></dd><dt><a name="def.instrument"></a><span class="glossterm">Instrument</span></dt><dd class="glossdef"><p>In Hydrogen, an instrument is a single noise-maker (like a bass
drum kick, or a tom).</p></dd><dt><a name="def.layer"></a><span class="glossterm">Layer</span></dt><dd class="glossdef"><p>In an instrument you can load several different samples (each one
called a <span class="bold"><strong>layer</strong></span>), and have a different
sample play depending on the velocity of the note. Only one sample at a
time will play.</p><p>Suppose you have a sample of a floor tom being struck softly. If
you simply play the sample louder - it will
<span class="emphasis"><em>not</em></span> sound the same as a real tom that has been
struck very hard. If you wish to mimic this in your instrument, you can
load one sample for soft playing, and a different sample for loud
playing.</p><p>See Also <a class="glossseealso" href="#def.instrument">Instrument</a>.</p></dd><dt><a name="def.lowpassfilter"></a><span class="glossterm">Low-Pass Filter</span></dt><dd class="glossdef"><p>A filter that attenuates (silences) high frequencies, but allows
low frequencies to pass through.</p><p>See Also <a class="glossseealso" href="#def.filter">Filter</a>, <a class="glossseealso" href="#def.cutoff">Cutoff Frequency</a>.</p></dd><dt><a name="def.mute"></a><span class="glossterm">Mute</span></dt><dd class="glossdef"><p>To make no noise. A setting on an instrument that prevents any
audio output.</p></dd><dt><a name="def.mutegroup"></a><span class="glossterm">Mute Group</span></dt><dd class="glossdef"><p>A group of instruments (<a class="link" href="#def.sample" title="Sample">samples</a>) out of which only a single one can be unmuted. If another instrument from the same group is triggered, the former one will be <a class="link" href="#def.mute" title="Mute">muted</a> (stop playing) immediately.</p><p>This is typically used in hi-hats, where there's a different
instrument (sample) for when the hi-hat is open or closed. With a real
hi-hat, the sound of the open hi-hat will stop as soon as you close it.
However, if you use two samples - the open sound will continue
even after you have triggered the closed sound. By placing both
instruments in the same mute group (group #1, for example)... triggering
closed sound will immediately stop the open sound (and vice
versa).</p></dd><dt><a name="def.normalization"></a><span class="glossterm">Normalization</span></dt><dd class="glossdef"><p>Normalization is the process of applying a uniform <a class="link" href="#def.gain" title="Gain">gain</a> to an audio signal in order to make its largest amplitude peak match a predefined value (usually 0dBFS).</p></dd><dt><a name="def.octave"></a><span class="glossterm">Octave</span></dt><dd class="glossdef"><p>A span of frequencies where the top-most frequency is exactly
twice the frequency of the bottom frequency.</p><p>For example, the range 20 Hz to 40 Hz is an octave. So is 120 Hz
to 240 Hz, and 575 Hz to 1150 Hz. While the frequency differences are
very different (20 Hz, 120 Hz, and 575 Hz, respectively), to the human
ear they <span class="emphasis"><em>sound</em></span> like the same distance.</p></dd><dt><a name="def.pan"></a><span class="glossterm">Pan</span></dt><dd class="glossdef"><p>Panning allows you to change the position of both a mono and stereo sample within the stereo sound field of the resulting audio output. In other words, it controls whether the sound of e.g. the snare is coming from the left or right speaker or somewhere in between. With careful pan adjustments of the different instruments you can make you drumkit sound more natural and simulate the feeling of listening to a real kit in close distance.</p><p>
The effect of <a class="link" href="#chpt.pattern_editor.note_properties.pan">note Pan</a> depends on the <a class="link" href="#chpt.mixer.channel_strips.pan">instrument Pan</a>
knob, which is set in the <a class="link" href="#chpt.mixer.channel_strips" title="13.1. Instrument Channel Strips">Mixer</a>.
Look to next figure to see how the <span class="bold"><strong>Resultant Pan</strong></span>
is determined (from version 1.1):
</p><div class="figure"><a name="matryoshkaPanning"></a><p class="title"><b>Figure 44. Visualization of the Interaction of the Different Pan Parameters</b></p><div class="figure-contents"><div class="mediaobject"><img src="img/matrioskaPanH2.png" alt="Visualization of the Interaction of the Different Pan Parameters"></div></div></div><p><br class="figure-break">
This multi-pan model resembles a "matryoshka" in some way: the <span class="emphasis"><em>note Pan</em></span> value moves the
<span class="emphasis"><em>Resultant Pan</em></span> in a smaller pan range centered at
<span class="emphasis"><em>instrument Pan</em></span>, whose extension depends on <span class="emphasis"><em>instrument Pan</em></span> value.
Some examples:
if <span class="emphasis"><em>instrument Pan</em></span> is central, <span class="emphasis"><em>note Pan</em></span> moves the signal in the
whole stereo range (really from Left to Right);
if <span class="emphasis"><em>instrument Pan</em></span> is sided, <span class="emphasis"><em>note Pan</em></span> moves the signal in a
progressively smaller stereo range centered at <span class="emphasis"><em>instrument Pan</em></span>;
if <span class="emphasis"><em>instrument Pan</em></span> is HARD-sided, <span class="emphasis"><em>note Pan</em></span> doesn't have any effect.
</p><p>
The way the <span class="emphasis"><em>Resultant Pan</em></span> will be translated into the volume of each stereo channel is determined by the <a class="link" href="#chpt.mixer.master_fader_strip.mixer_settings" title="13.4.2. Mixer Settings">Pan Law</a> in the Mixer settings.
</p></dd><dt><a name="def.release"></a><span class="glossterm">Release</span></dt><dd class="glossdef"><p>The amount of
<span class="emphasis"><em>time</em></span> to reduce the volume of a note from the <a class="link" href="#def.sustain" title="Sustain">sustain</a> level
to 0.</p><p>See Also <a class="glossseealso" href="#def.adsr">ADSR</a>.</p></dd><dt><a name="def.resonance"></a><span class="glossterm">Resonance</span></dt><dd class="glossdef"><p>When referring to a resonance filter, this is the parameter that
determines how much of a boost (gain) to give the frequencies at the
cutoff.</p><p>See Also <a class="glossseealso" href="#def.resonancefilter">Resonance Filter</a>.</p></dd><dt><a name="def.resonancefilter"></a><span class="glossterm">Resonance Filter</span></dt><dd class="glossdef"><p>A filter that gives a large boost to a very narrow range of
frequencies. Typically it will be part of a high-pass or a low-pass
filter, where the boosted frequencies are centered on the cut-off
frequency.</p><p>See Also <a class="glossseealso" href="#def.filter">Filter</a>, <a class="glossseealso" href="#def.cutoff">Cutoff Frequency</a>, <a class="glossseealso" href="#def.lowpassfilter">Low-Pass Filter</a>, <a class="glossseealso" href="#def.highpassfilter">High-Pass Filter</a>, <a class="glossseealso" href="#def.resonance">Resonance</a>.</p></dd><dt><a name="def.rolloff"></a><span class="glossterm">Roll-off</span></dt><dd class="glossdef"><p>This is the amount that frequencies are attenuated (suppressed) as
the frequency changes (typically measured in dB/octave).</p><p>For example, in a low-pass filter the frequencies below the cutoff
frequency are not attenuated (they pass-through with the same volume).
Same with the cutoff frequency. As you go above the cutoff frequency,
the frequencies that are near the cutoff frequency are not attenuated
very much at all. However, the frequencies that are much higher than
the cutoff are attenuated (suppressed) a lot. This is usually
approximated by a straight line (on a log scale) and measured in in dB
of attenuation per octave of frequency.</p><p>See Also <a class="glossseealso" href="#def.attenuation">Attenuation</a>, <a class="glossseealso" href="#def.filter">Filter</a>.</p></dd><dt><a name="def.sample"></a><span class="glossterm">Sample</span></dt><dd class="glossdef"><p>A short recording of a sound, typically between .1 and 3.0 seconds
long. Each time a note is triggered within Hydrogen the corresponding sample will be played back (after applying all customization and effects).</p></dd><dt><a name="def.sustain"></a><span class="glossterm">Sustain</span></dt><dd class="glossdef"><p>The <span class="emphasis"><em>level</em></span> (how loud; volume) to hold the note between the <a class="link" href="#def.decay" title="Decay">decay</a> and the <a class="link" href="#def.release" title="Release">release</a>. It is given as percentage of the <a class="link" href="#def.velocity" title="Velocity">velocity</a> and does not depend on time.</p><p>See Also <a class="glossseealso" href="#def.adsr">ADSR</a>.</p></dd><dt><a name="def.velocity"></a><span class="glossterm">Velocity</span></dt><dd class="glossdef"><p>How hard you hit a note.</p><p><abbr class="abbrev">MIDI</abbr> devices are required to send this information along with the
note. Synthesizers use this information to adjust several parameters on
the sample (typically the volume). In Hydrogen, it is only used to
adjust how loud the sample is played back.</p></dd></dl></div></div></div></body></html>
|