├── .gitignore ├── CHANGELOG.md ├── Cargo.lock ├── Cargo.toml ├── DISCLAIMER ├── EXTERNAL_DEPENDENCY_LICENSES ├── CLAP_4_4_3 │ ├── LICENSE │ └── README ├── HOUND_3_4_0 │ ├── LICENSE │ └── README └── RUST_PEG_0_6 │ ├── LICENSE │ └── README ├── LICENSE ├── NOTICE ├── README.md ├── build.rs ├── daisy.hum ├── simple_sample.hum └── src ├── bin.rs ├── hum_error.rs ├── hum_io.rs ├── hum_parse.rs ├── hum_process ├── hum_math.rs ├── hum_voice.rs └── mod.rs └── lib.rs /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | **/*.rs.bk 3 | .DS_Store 4 | *.wav 5 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | All notable changes to this project will be documented in this file. 3 | 4 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 5 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 6 | 7 | ## [0.6.0] - 2023-09-17 8 | ### Changed 9 | - removed public `play` function due to dependency on unmaintained portaudio library 10 | - simplified CLI options 11 | 12 | ## [0.5.0] - 2020-12-27 13 | ### Changed 14 | - Library interfaces: play/save accept the file contents instead of the file name. 15 | - Library error handling: errors in library functions are consistently propagated. 16 | 17 | ## [0.4.0] - 2018-11-28 18 | ### Changed 19 | - Language API: make syntax more flexible and closer to traditional notation. 20 | - Adjust volume of square wave voice. 21 | 22 | ## [0.3.0] - 2018-11-24 23 | ### Added 24 | - public `play` function to the library which streams audio directly to speakers. 25 | - ability to stream audio from hum files directly in the CLI app. 26 | 27 | ### Changed 28 | - CLI API: new syntax for picking between streaming audio and saving to WAV. 29 | 30 | ## [0.2.1] - 2018-11-18 31 | ### Added 32 | - The ability to use Hum as a Rust library. 33 | 34 | ### Changed 35 | - README to reflect addition of library functionality. 36 | 37 | ## [0.2.0] - 2018-11-17 38 | ### Added 39 | - Support for rests (silent notes). 40 | - Sawtooth wave voice. 41 | - New scale \*.hum example. 42 | 43 | ### Changed 44 | - Language API: Octaves now roll over on "C natural" instead of "A natural". 45 | - Documentation and examples to demonstrate new API. 46 | 47 | ### Fixed 48 | - Incorrect output on unknown note error. 49 | 50 | ## [0.1.2] - 2018-11-15 51 | ### Added 52 | - Square wave voice. 53 | 54 | ### Changed 55 | - README and readme_demo.hum to include square wave voice examples. 56 | - README language regarding licensing. 57 | 58 | ### Removed 59 | - WAV files from repository; they can be generated by the user after download. 60 | 61 | ### Fixed 62 | - Bug which caused extra silence to be appended to the end of WAV files. 63 | 64 | ## [0.1.1] - 2018-11-13 65 | ### Added 66 | - Add change log. 67 | 68 | ### Changed 69 | - Edit language in README. 70 | 71 | ## [0.1.0] - 2018-11-13 72 | ### Added 73 | - Add entirety of experimental code repository for publication. 74 | -------------------------------------------------------------------------------- /Cargo.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Cargo. 2 | # It is not intended for manual editing. 3 | version = 3 4 | 5 | [[package]] 6 | name = "anstream" 7 | version = "0.5.0" 8 | source = "registry+https://github.com/rust-lang/crates.io-index" 9 | checksum = "b1f58811cfac344940f1a400b6e6231ce35171f614f26439e80f8c1465c5cc0c" 10 | dependencies = [ 11 | "anstyle", 12 | "anstyle-parse", 13 | "anstyle-query", 14 | "anstyle-wincon", 15 | "colorchoice", 16 | "utf8parse", 17 | ] 18 | 19 | [[package]] 20 | name = "anstyle" 21 | version = "1.0.3" 22 | source = "registry+https://github.com/rust-lang/crates.io-index" 23 | checksum = "b84bf0a05bbb2a83e5eb6fa36bb6e87baa08193c35ff52bbf6b38d8af2890e46" 24 | 25 | [[package]] 26 | name = "anstyle-parse" 27 | version = "0.2.1" 28 | source = "registry+https://github.com/rust-lang/crates.io-index" 29 | checksum = "938874ff5980b03a87c5524b3ae5b59cf99b1d6bc836848df7bc5ada9643c333" 30 | dependencies = [ 31 | "utf8parse", 32 | ] 33 | 34 | [[package]] 35 | name = "anstyle-query" 36 | version = "1.0.0" 37 | source = "registry+https://github.com/rust-lang/crates.io-index" 38 | checksum = "5ca11d4be1bab0c8bc8734a9aa7bf4ee8316d462a08c6ac5052f888fef5b494b" 39 | dependencies = [ 40 | "windows-sys", 41 | ] 42 | 43 | [[package]] 44 | name = "anstyle-wincon" 45 | version = "2.1.0" 46 | source = "registry+https://github.com/rust-lang/crates.io-index" 47 | checksum = "58f54d10c6dfa51283a066ceab3ec1ab78d13fae00aa49243a45e4571fb79dfd" 48 | dependencies = [ 49 | "anstyle", 50 | "windows-sys", 51 | ] 52 | 53 | [[package]] 54 | name = "clap" 55 | version = "4.4.3" 56 | source = "registry+https://github.com/rust-lang/crates.io-index" 57 | checksum = "84ed82781cea27b43c9b106a979fe450a13a31aab0500595fb3fc06616de08e6" 58 | dependencies = [ 59 | "clap_builder", 60 | ] 61 | 62 | [[package]] 63 | name = "clap_builder" 64 | version = "4.4.2" 65 | source = "registry+https://github.com/rust-lang/crates.io-index" 66 | checksum = "2bb9faaa7c2ef94b2743a21f5a29e6f0010dff4caa69ac8e9d6cf8b6fa74da08" 67 | dependencies = [ 68 | "anstream", 69 | "anstyle", 70 | "clap_lex", 71 | "strsim", 72 | ] 73 | 74 | [[package]] 75 | name = "clap_lex" 76 | version = "0.5.1" 77 | source = "registry+https://github.com/rust-lang/crates.io-index" 78 | checksum = "cd7cc57abe963c6d3b9d8be5b06ba7c8957a930305ca90304f24ef040aa6f961" 79 | 80 | [[package]] 81 | name = "colorchoice" 82 | version = "1.0.0" 83 | source = "registry+https://github.com/rust-lang/crates.io-index" 84 | checksum = "acbf1af155f9b9ef647e42cdc158db4b64a1b61f743629225fde6f3e0be2a7c7" 85 | 86 | [[package]] 87 | name = "hound" 88 | version = "3.4.0" 89 | source = "registry+https://github.com/rust-lang/crates.io-index" 90 | checksum = "8a164bb2ceaeff4f42542bdb847c41517c78a60f5649671b2a07312b6e117549" 91 | 92 | [[package]] 93 | name = "hum" 94 | version = "0.6.0" 95 | dependencies = [ 96 | "clap", 97 | "hound", 98 | "peg", 99 | ] 100 | 101 | [[package]] 102 | name = "peg" 103 | version = "0.6.3" 104 | source = "registry+https://github.com/rust-lang/crates.io-index" 105 | checksum = "9f76678828272f177ac33b7e2ac2e3e73cc6c1cd1e3e387928aa69562fa51367" 106 | dependencies = [ 107 | "peg-macros", 108 | "peg-runtime", 109 | ] 110 | 111 | [[package]] 112 | name = "peg-macros" 113 | version = "0.6.3" 114 | source = "registry+https://github.com/rust-lang/crates.io-index" 115 | checksum = "636d60acf97633e48d266d7415a9355d4389cea327a193f87df395d88cd2b14d" 116 | dependencies = [ 117 | "peg-runtime", 118 | "proc-macro2", 119 | "quote", 120 | ] 121 | 122 | [[package]] 123 | name = "peg-runtime" 124 | version = "0.6.3" 125 | source = "registry+https://github.com/rust-lang/crates.io-index" 126 | checksum = "9555b1514d2d99d78150d3c799d4c357a3e2c2a8062cd108e93a06d9057629c5" 127 | 128 | [[package]] 129 | name = "proc-macro2" 130 | version = "1.0.19" 131 | source = "registry+https://github.com/rust-lang/crates.io-index" 132 | checksum = "04f5f085b5d71e2188cb8271e5da0161ad52c3f227a661a3c135fdf28e258b12" 133 | dependencies = [ 134 | "unicode-xid", 135 | ] 136 | 137 | [[package]] 138 | name = "quote" 139 | version = "1.0.7" 140 | source = "registry+https://github.com/rust-lang/crates.io-index" 141 | checksum = "aa563d17ecb180e500da1cfd2b028310ac758de548efdd203e18f283af693f37" 142 | dependencies = [ 143 | "proc-macro2", 144 | ] 145 | 146 | [[package]] 147 | name = "strsim" 148 | version = "0.10.0" 149 | source = "registry+https://github.com/rust-lang/crates.io-index" 150 | checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623" 151 | 152 | [[package]] 153 | name = "unicode-xid" 154 | version = "0.2.1" 155 | source = "registry+https://github.com/rust-lang/crates.io-index" 156 | checksum = "f7fe0bb3479651439c9112f72b6c505038574c9fbb575ed1bf3b797fa39dd564" 157 | 158 | [[package]] 159 | name = "utf8parse" 160 | version = "0.2.1" 161 | source = "registry+https://github.com/rust-lang/crates.io-index" 162 | checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a" 163 | 164 | [[package]] 165 | name = "windows-sys" 166 | version = "0.48.0" 167 | source = "registry+https://github.com/rust-lang/crates.io-index" 168 | checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9" 169 | dependencies = [ 170 | "windows-targets", 171 | ] 172 | 173 | [[package]] 174 | name = "windows-targets" 175 | version = "0.48.5" 176 | source = "registry+https://github.com/rust-lang/crates.io-index" 177 | checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c" 178 | dependencies = [ 179 | "windows_aarch64_gnullvm", 180 | "windows_aarch64_msvc", 181 | "windows_i686_gnu", 182 | "windows_i686_msvc", 183 | "windows_x86_64_gnu", 184 | "windows_x86_64_gnullvm", 185 | "windows_x86_64_msvc", 186 | ] 187 | 188 | [[package]] 189 | name = "windows_aarch64_gnullvm" 190 | version = "0.48.5" 191 | source = "registry+https://github.com/rust-lang/crates.io-index" 192 | checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8" 193 | 194 | [[package]] 195 | name = "windows_aarch64_msvc" 196 | version = "0.48.5" 197 | source = "registry+https://github.com/rust-lang/crates.io-index" 198 | checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc" 199 | 200 | [[package]] 201 | name = "windows_i686_gnu" 202 | version = "0.48.5" 203 | source = "registry+https://github.com/rust-lang/crates.io-index" 204 | checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e" 205 | 206 | [[package]] 207 | name = "windows_i686_msvc" 208 | version = "0.48.5" 209 | source = "registry+https://github.com/rust-lang/crates.io-index" 210 | checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406" 211 | 212 | [[package]] 213 | name = "windows_x86_64_gnu" 214 | version = "0.48.5" 215 | source = "registry+https://github.com/rust-lang/crates.io-index" 216 | checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e" 217 | 218 | [[package]] 219 | name = "windows_x86_64_gnullvm" 220 | version = "0.48.5" 221 | source = "registry+https://github.com/rust-lang/crates.io-index" 222 | checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc" 223 | 224 | [[package]] 225 | name = "windows_x86_64_msvc" 226 | version = "0.48.5" 227 | source = "registry+https://github.com/rust-lang/crates.io-index" 228 | checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538" 229 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "hum" 3 | version = "0.6.0" 4 | authors = ["Connor Bulakites "] 5 | include = [ 6 | "**/*.rs", 7 | "**/*.rustpeg", 8 | "Cargo.toml", 9 | "LICENSE", 10 | "DISCLAIMER", 11 | "README.md", 12 | "EXTERNAL_DEPENDENCY_LICENSES/*", 13 | ] 14 | build = "build.rs" 15 | description = "A music notation language and synthesizer written in Rust." 16 | repository = "https://github.com/crbulakites/hum" 17 | readme = "README.md" 18 | keywords = ["music", "notation", "synthesizer", "sine", "wave"] 19 | categories = ["multimedia", "multimedia::audio"] 20 | license = "GPL-3.0-or-later" 21 | 22 | [lib] 23 | name = "hum" 24 | path = "src/lib.rs" 25 | 26 | [[bin]] 27 | name = "hum" 28 | path = "src/bin.rs" 29 | 30 | [badges] 31 | maintenance = { status = "experimental" } 32 | 33 | [dependencies] 34 | clap = "4.4.3" 35 | hound = "3.4.0" 36 | peg = "0.6.3" 37 | 38 | [build-dependencies] 39 | -------------------------------------------------------------------------------- /DISCLAIMER: -------------------------------------------------------------------------------- 1 | DISCLAIMER: THIS PROGRAM IS NOT YET STABLE. PLEASE TURN DOWN YOUR VOLUME BEFORE 2 | PLAYING ANY OUTPUTTED WAV FILES TO PROTECT YOUR SPEAKERS AND HEARING, ESPECIALLY 3 | AFTER MODIFYING THE CODE YOURSELF. USE AT YOUR OWN RISK. 4 | -------------------------------------------------------------------------------- /EXTERNAL_DEPENDENCY_LICENSES/CLAP_4_4_3/LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) Individual contributors 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is 8 | furnished to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in all 11 | copies or substantial portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 19 | SOFTWARE. 20 | -------------------------------------------------------------------------------- /EXTERNAL_DEPENDENCY_LICENSES/CLAP_4_4_3/README: -------------------------------------------------------------------------------- 1 | Clap v4.4.3 is an external dependency linked via crates.io which is used to 2 | parse CLI arguments. It is licensed under the Apache License version 2 or 3 | the MIT License. 4 | 5 | Hound source: https://github.com/clap-rs/clap 6 | 7 | -------------------------------------------------------------------------------- /EXTERNAL_DEPENDENCY_LICENSES/HOUND_3_4_0/LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /EXTERNAL_DEPENDENCY_LICENSES/HOUND_3_4_0/README: -------------------------------------------------------------------------------- 1 | Hound v3.4.0 is an external dependency linked via crates.io which is used to 2 | write data to WAV files. It is licensed under the Apache License version 2. 3 | 4 | Hound author: Ruud van Asseldonk 5 | Hound source: https://github.com/ruuda/hound 6 | -------------------------------------------------------------------------------- /EXTERNAL_DEPENDENCY_LICENSES/RUST_PEG_0_6/LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (C) 2013 Kevin Mehall 2 | 3 | Permission is hereby granted, free of charge, to any 4 | person obtaining a copy of this software and associated 5 | documentation files (the "Software"), to deal in the 6 | Software without restriction, including without 7 | limitation the rights to use, copy, modify, merge, 8 | publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software 10 | is furnished to do so, subject to the following 11 | conditions: 12 | 13 | The above copyright notice and this permission notice 14 | shall be included in all copies or substantial portions 15 | of the Software. 16 | 17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 18 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 19 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 20 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 21 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 22 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 23 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 24 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 25 | DEALINGS IN THE SOFTWARE. 26 | -------------------------------------------------------------------------------- /EXTERNAL_DEPENDENCY_LICENSES/RUST_PEG_0_6/README: -------------------------------------------------------------------------------- 1 | Rust Peg v0.6 is an external dependency linked via crates.io which allows us 2 | to concisely define grammars and generate parsers from them. It is licensed 3 | under the MIT License. 4 | 5 | Rust Peg author: Kevin Mehall 6 | Rust Peg source: https://github.com/kevinmehall/rust-peg 7 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | The song DAISY BELL by Harry Dacre is from 1892 and is presumed to be in the 2 | public domain in the United States. To the extent that they reflect my original 3 | arrangements differing from the score of DAISY BELL made available for download 4 | at https://levysheetmusic.mse.jhu.edu/collection/140/090, all *.hum files in 5 | this project are Copyright (C) 2018 Connor R. Bulakites and provided to you 6 | under the terms of the GNU GENERAL PUBLIC LICENSE, the text of which is provided 7 | in full in the LICENSE file. 8 | 9 | The Hum file format does not yet support rich comments, and thus this NOTICE 10 | file is made temporarily necessary. 11 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Hum Synthesizer 0.6.0 👄 2 | ======================== 3 | A music notation language and synthesizer written in Rust. 4 | 5 | Hum converts markup text files to playable music saved as WAV files. 6 | 7 | _This project is in early development, and its public API is possibly subject to breaking changes at any time. If I knowingly make a breaking change, I will update the MINOR version in the semantic versioning scheme, where the version numbers are MAJOR.MINOR.PATCH._ 8 | 9 | _DISCLAIMER: This program produces sound output in the form of \*.wav files, and it is not yet considered stable. You should turn down your volume before experimenting with sound output to protect your ears and speakers._ 10 | 11 | 12 | Requirements 13 | ------------ 14 | - Rust: https://www.rust-lang.org/en-US/install.html 15 | 16 | Building the Project 17 | -------------------- 18 | To build the project, use `cargo build` in the root directory. 19 | 20 | Testing the Project 21 | ------------------- 22 | To test the project, use `cargo run` in the root directory. 23 | 24 | Hum has two required, positional command-line arguments: 25 | 1. the path of the \*.hum input file 26 | 2. the path of the \*.wav output file 27 | 28 | To convert the included \*.hum file, "daisy.hum," to a file called "daisy.wav," use the following command in the root directory: 29 | 30 | `cargo run daisy.hum daisy.wav` 31 | 32 | Installing the Latest Release 33 | ----------------------------- 34 | To install the latest release as a CLI tool, first make sure that you have fulfilled the requirements by [_installing Rust_](#requirements). 35 | 36 | Then you can run the following command in the terminal: 37 | 38 | `cargo install hum` 39 | 40 | Now you can use hum like any other CLI tool. For example, presuming the file `daisy.hum` exists in the current directory, you could use: 41 | 42 | `hum daisy.hum daisy.wav` 43 | 44 | Using Hum as a Library 45 | ---------------------- 46 | You can also use Hum as a library in your own Rust programs. Right now, there is one method which implements the functionality of the CLI tool: 47 | 48 | ``` 49 | extern crate hum; 50 | ... 51 | hum::convert_to_wav(input, output); 52 | ``` 53 | 54 | An Explanation of the Hum Music Notation Language: 55 | -------------------------------------------------- 56 | The Hum music notation language is intended to be easily interpreted by human musicians and computers. It is still in early development and subject to change, but here is a brief explanation of the features available so far. I encourage you to look at the included example files and modify them to help you understand how the language works. First off, here is what the language looks like: 57 | 58 | ``` 59 | ~ DAISY BELL by Harry Dacre 60 | ~ Based on an 1892 print in The Johns Hopkins University Lester S Levy Sheet Music Collection 61 | ~ Arranged by Connor Bulakites to demonstrate the Hum Synthesizer 62 | 63 | [ 180_bpm ][ 3/4 ] 64 | 65 | *********************************************************************** 66 | 67 | % square 68 | | (Dn_5 1/2)+ -------------------- | (Bn_4 1/2)+ -------------------- ; 69 | ~ Dai- ~ sy! 70 | 71 | % sine 72 | | (Rest 1/4) (Bn_4 1/4) (Bn_4 1/4) | (Rest 1/4) (Gn_4 1/4) (Gn_4 1/4) ; 73 | | (Rest 1/4) (Gn_4 1/4) (Gn_4 1/4) | (Rest 1/4) (Dn_4 1/4) (Dn_4 1/4) ; 74 | | (Rest 1/4) (Dn_4 1/4) (Dn_4 1/4) | (Rest 1/4) (Bn_3 1/4) (Bn_3 1/4) ; 75 | | (Dn_4 1/2)+ -------------------- | (Bn_3 1/2)+ -------------------- ; 76 | 77 | % sawtooth 78 | | (Gn_2 1/2)+ -------------------- | (Dn_2 1/2)+ -------------------- ; 79 | 80 | 81 | *********************************************************************** 82 | 83 | % square 84 | | (Gn_4 1/2)+ -------------------- | (Dn_4 1/2)+ -------------------- ; 85 | ~ Dai- ~ sy! 86 | 87 | % sine 88 | | (Rest 1/4) (Dn_4 1/4) (Dn_4 1/4) | (Rest 1/4) (Bn_3 1/4) (Bn_3 1/4) ; 89 | | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) ; 90 | | (Gn_3 1/2)+ -------------------- | (Dn_3 1/2)+ -------------------- ; 91 | 92 | % sawtooth 93 | | (Bn_1 1/2)+ -------------------- | (Gn_1 1/2)+ -------------------- ; 94 | ``` 95 | 96 | Now for some explanation of what you're seeing: 97 | 98 | - The tilde character `~` indicates a single-line comment. Everything that appears after this symbol on a line is ignored by the computer. I use this for annotations and for lyrics. 99 | 100 | - The tempo tag `[ 100_bpm ]` sets the tempo of the song to 100 _beats per minute_. You can change the numeric portion of the tag to change the tempo, but you must keep the `_bpm` suffix. You can change the tempo partway through a song by putting another tempo tag between any two measures. 101 | 102 | - The time signature tag `[ 3/4 ]` sets the time signature of the music. The numerator corresponds to the number of beats per measure, and the denominator corresponds to the reciprocal of the length value of one beat. So in 3/4 time, there are 3 beats with length "1/4" per measure. For a more in-depth explanation of time signatures, see: https://en.wikipedia.org/wiki/Time_signature. You can change the time signature partway through a song by putting another time signature tag between any two measures. 103 | 104 | - The line of asterisks `*` indicates a write checkpoint. You should have at least one of these before your first measure. _All lines of music written before the next checkpoint are presumed to occur concurrently_. Lines of music written after the next checkpoint are presumed to start immediately after the last measure in the previous checkpoint. The number of measures or horizontal columns of music you allow per checkpoint and the total number of checkpoints you use are a matter of style and up to you. In the included examples, I put two measures per checkpoint because it fits nicely on an 80-column terminal screen, but you are under no obligation to follow this convention. Additionally, the number of asterisks in the checkpoint line is also a matter of style (you just have to have at least one). 105 | 106 | - The division sign `%` is used to switch the voice or "instrument" of lines of music. When you switch to a particular voice, all lines of music underneath the command will be played with that voice until you switch to a new voice. As of now, there are three supported voices: `sine`, `square`, and `sawtooth`. 107 | 108 | - The pipe operator `|` indicates the start of a new measure. To ensure that your music is played back correctly, _you must start every measure with the pipe operator_. Additionally, you should make sure that the total length of notes and rests in your measure adds up to the value of the current time signature. Otherwise, music from one measure may bleed over incorrectly into another measure. 109 | 110 | - The semicolon `;` serves as the reset character. When a semicolon is encountered, Hum knows that you are done writing one line of music and want to start writing another line of music starting at the last checkpoint. Typically, _all lines of music after a checkpoint which are meant to be played concurrently should end in a semicolon_. 111 | 112 | - Hum ignores minus signs `-`. Essentially, they're treated the same as whitespace. This is done to make it easier for you to vertically align concurrent lines of music within a checkpoint so that it is more readable to humans. Exactly how you choose to utilize this feature is up to your stylistic discretion. 113 | 114 | - Finally, we must provide an explanation for notes: 115 | 116 | - A note consists of two values enclosed within parentheses and separated by a space. The first value is the note name, and the second value is the note length. The note length divided by the current time signature determines the fraction of the measure that the note takes up. Within a single line of music, notes are added to a measure one after another in succession, reading from left to right. 117 | 118 | - The `+` operator can be appended to the end of a note outside the parentheses to increase the length of the note by one half of its original length value. This corresponds to a "dot" in traditional music notation. So, for example, the note (An_4 1/2)+ has a total length of `1/2 + 1/4 = 3/4`. You can append as many plus signs to the end of a note as you want to keep increasing the length value by one half its original value. 119 | 120 | - There are currently _96_ possible note names corresponding roughly to the keys on a grand piano. The note names are formatted like so: `{pitch}_{octave}`. If you are writing in a key that uses sharps, these are the pitches that you should use: 121 | 122 | `["Cn", "Cs", "Dn", "Ds", "En", "Fn", "Fs", "Gn", "Gs", "An", "As", "Bn"]` 123 | 124 | - If you are writing in a key that uses flats, these are the pitches that you should use: 125 | 126 | `["Cn", "Df", "Dn", "Ef", "En", "Fn", "Gf", "Gn", "Af", "An", "Bf", "Bn"]` 127 | 128 | - In this style, "n" refers to "natural," "s" refers to "sharp," and "f" refers to "flat." Although it's unusual, you can mix sharps and flats in the same song if you wish. 129 | 130 | - Additionally, the octave part of a note can range from 0 to 7, with the lowest possible note being `Cn_0` and the highest possible note being `Bn_7`. Note that octave numbers roll over on C natural, so this is how part of the sequence of notes in order of pitch goes: `An_4, As_4, Bn_4, Cn_5, Cs_5, Dn_5, etc...`. 131 | 132 | - There is also a special note called `Rest` which corresponds to silence within a single voice. 133 | 134 | - If you use a note value that is not recognized, the current behavior is to not insert the note, which will throw off the timing of your measure. I will work on fixing this in a later version. 135 | 136 | Why Did I Make This? 137 | -------------------- 138 | I thought it was cool, and I've never programmed a large project in Rust before, so obviously I'm the person for the job 😎. Also, I like the idea of an open music markup language being easily readable by both humans and computers. I think if it's implemented correctly, it might make it easier to preserve musical scores in digital format. This has been a fun project to get started with so far, and I hope that people make awesome music with it. 139 | 140 | Why the Choice of License? 141 | -------------------------- 142 | For more insight on what you currently _are_ and _aren't_ allowed to do with this code, you can read more about the terms of the GPL at [the GNU website](https://www.gnu.org/licenses/licenses.html). If anybody actually starts contributing to or using this code and wants to convince me to release it under an alternative license, then just contact me, and I am open to having a conversation regarding the matter 🙂. 143 | -------------------------------------------------------------------------------- /build.rs: -------------------------------------------------------------------------------- 1 | fn main() { 2 | } 3 | -------------------------------------------------------------------------------- /daisy.hum: -------------------------------------------------------------------------------- 1 | ~ DAISY BELL by Harry Dacre 2 | ~ Based on an 1892 print in The Johns Hopkins University Lester S Levy Sheet Music Collection 3 | ~ Arranged by Connor Bulakites to demonstrate the Hum Synthesizer 4 | 5 | [ 180_bpm ][ 3/4 ] 6 | 7 | *********************************************************************** 8 | 9 | % square 10 | | (Dn_5 1/2)+ -------------------- | (Bn_4 1/2)+ -------------------- ; 11 | ~ Dai- ~ sy! 12 | 13 | % sine 14 | | (Rest 1/4) (Bn_4 1/4) (Bn_4 1/4) | (Rest 1/4) (Gn_4 1/4) (Gn_4 1/4) ; 15 | | (Rest 1/4) (Gn_4 1/4) (Gn_4 1/4) | (Rest 1/4) (Dn_4 1/4) (Dn_4 1/4) ; 16 | | (Rest 1/4) (Dn_4 1/4) (Dn_4 1/4) | (Rest 1/4) (Bn_3 1/4) (Bn_3 1/4) ; 17 | | (Dn_4 1/2)+ -------------------- | (Bn_3 1/2)+ -------------------- ; 18 | 19 | % sawtooth 20 | | (Gn_2 1/2)+ -------------------- | (Dn_2 1/2)+ -------------------- ; 21 | 22 | 23 | *********************************************************************** 24 | 25 | % square 26 | | (Gn_4 1/2)+ -------------------- | (Dn_4 1/2)+ -------------------- ; 27 | ~ Dai- ~ sy! 28 | 29 | % sine 30 | | (Rest 1/4) (Dn_4 1/4) (Dn_4 1/4) | (Rest 1/4) (Bn_3 1/4) (Bn_3 1/4) ; 31 | | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) ; 32 | | (Gn_3 1/2)+ -------------------- | (Dn_3 1/2)+ -------------------- ; 33 | 34 | % sawtooth 35 | | (Bn_1 1/2)+ -------------------- | (Gn_1 1/2)+ -------------------- ; 36 | 37 | *********************************************************************** 38 | 39 | % square 40 | | (En_4 1/4) (Fs_4 1/4) (Gn_4 1/4) | (En_4 1/2) ---------- (Gn_4 1/4) ; 41 | ~ Give ~ me ~ your ~ an- ~ swer, 42 | 43 | % sine 44 | | (En_3 1/4) (Fs_3 1/4) (Gn_3 1/4) | (En_3 1/2) ---------- (Gn_3 1/4) ; 45 | 46 | % sawtooth 47 | | (Cn_1 1/4) (Rest 1/2) ---------- | (Cn_1 1/4) (Rest 1/2) ---------- ; 48 | | (Rest 1/4) (Cn_4 1/4) (Cn_4 1/4) | (Rest 1/4) (Cn_4 1/4) (Cn_4 1/4) ; 49 | | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) ; 50 | | (Rest 1/4) (En_3 1/4) (En_3 1/4) | (Rest 1/4) (En_3 1/4) (En_3 1/4) ; 51 | 52 | *********************************************************************** 53 | 54 | % square 55 | | (Dn_4 1/2)+ -------------------- | (Dn_4 1/2) ---------- (Rest 1/4) ; 56 | ~ do! 57 | 58 | % sine 59 | | (Rest 1/4) (Bn_3 1/4) (Bn_3 1/4) | (Rest 1/4) (Bn_3 1/4) (Bn_3 1/4) ; 60 | | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) ; 61 | | (Dn_3 1/2)+ -------------------- | (Dn_3 1/2)+ -------------------- ; 62 | 63 | % sawtooth 64 | | (Gn_1 1/4) (Dn_2 1/4) (Bn_1 1/4) | (Gn_1 1/4) (Rest 1/2) ---------- ; 65 | 66 | *********************************************************************** 67 | 68 | % square 69 | | (An_4 1/2)+ -------------------- | (Dn_5 1/2)+ -------------------- ; 70 | ~ I'm ~ half 71 | 72 | % sine 73 | | (An_3 1/2)+ -------------------- | (Dn_4 1/2)+ -------------------- ; 74 | 75 | % sawtooth 76 | | (Rest 1/4) (Dn_4 1/4) (Dn_4 1/4) | (Rest 1/4) (Cn_4 1/4) (Cn_4 1/4) ; 77 | | (Rest 1/4) (Cn_4 1/4) (Cn_4 1/4) | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) ; 78 | | (Rest 1/4) (An_3 1/4) (An_3 1/4) | (Rest 1/4) (Fs_3 1/4) (Fs_3 1/4) ; 79 | | (Fs_3 1/4) (Rest 1/2) ---------- | (Dn_3 1/4) (Rest 1/2) ---------- ; 80 | 81 | *********************************************************************** 82 | 83 | % square 84 | | (Bn_4 1/2)+ -------------------- | (Gn_4 1/2)+ -------------------- ; 85 | ~ cra- ~ zy 86 | 87 | % sine 88 | | (Rest 1/4) (Gn_4 1/4) (Gn_3 1/4) | (Rest 1/4) (Gn_4 1/4) (Gn_4 1/4) ; 89 | | (Rest 1/4) (Dn_4 1/4) (Dn_3 1/4) | (Rest 1/4) (Dn_4 1/4) (Dn_4 1/4) ; 90 | | (Bn_3 1/2)+ -------------------- | (Gn_3 1/2)+ -------------------- ; 91 | 92 | % sawtooth 93 | | (Gn_2 1/2)+ -------------------- | (En_2 1/2)+ -------------------- ; 94 | 95 | *********************************************************************** 96 | 97 | % square 98 | | (En_4 1/4) (Fs_4 1/4) (Gn_4 1/4) | (An_4 1/2) ---------- (Bn_4 1/4) ; 99 | ~ All ~ for ~ the ~ love ~ of 100 | 101 | % sine 102 | | (En_3 1/4) (Fs_3 1/4) (Gn_3 1/4) | (An_3 1/2) ---------- (Bn_3 1/4) ; 103 | 104 | % sawtooth 105 | | (Rest 1/4) (Cs_4 1/4) (Cs_4 1/4) | (Rest 1/4) (Cs_4 1/4) (Cs_4 1/4) ; 106 | | (Rest 1/4) (An_3 1/4) (An_3 1/4) | (Rest 1/4) (An_3 1/4) (An_3 1/4) ; 107 | | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) ; 108 | | (An_3 1/4) (Rest 1/2) ---------- | (An_3 1/4) (Rest 1/2) ---------- ; 109 | 110 | *********************************************************************** 111 | 112 | % square 113 | | (An_4 1/2)+ -------------------- | (An_4 1/4) (Rest 1/4) (Bn_4 1/4) ; 114 | ~ you! ~ It 115 | 116 | % sine 117 | | (An_3 1/2)+ -------------------- | (An_3 1/4) (Rest 1/2) ---------- ; 118 | 119 | % sawtooth 120 | | (Rest 1/4) (Dn_4 1/4) (Dn_4 1/4) | (Rest 1/4) (Dn_4 1/4) (Dn_4 1/4) ; 121 | | (Rest 1/4) (An_3 1/4) (An_3 1/4) | (Rest 1/4) (An_3 1/4) (An_3 1/4) ; 122 | | (Rest 1/4) (Fs_3 1/4) (Fs_3 1/4) | (Rest 1/4) (Fs_3 1/4) (Fs_3 1/4) ; 123 | | (Dn_3 1/4) (Rest 1/2) ---------- | (Dn_3 1/4) (Rest 1/2) ---------- ; 124 | 125 | *********************************************************************** 126 | 127 | % square 128 | | (Cn_5 1/4) (Bn_4 1/4) (An_4 1/4) | (Dn_5 1/2) ---------- (Bn_4 1/4) ; 129 | ~ won't ~ be ~ a ~ sty- ~ lish 130 | 131 | % sine 132 | | (Cn_4 1/4) (Bn_3 1/4) (An_3 1/4) | (Dn_4 1/2) ---------- (Bn_3 1/4) ; 133 | 134 | % sawtooth 135 | | (Rest 1/4) (Dn_4 1/4) (Dn_4 1/4) | (Rest 1/4) (Cn_4 1/4) (Cn_4 1/4) ; 136 | | (Rest 1/4) (Cn_4 1/4) (Cn_4 1/4) | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) ; 137 | | (Rest 1/4) (An_3 1/4) (An_3 1/4) | (Rest 1/4) (Fs_3 1/4) (Fs_3 1/4) ; 138 | | (Fs_3 1/4) (Rest 1/2) ---------- | (Dn_3 1/4) (Rest 1/2) ---------- ; 139 | 140 | *********************************************************************** 141 | 142 | % square 143 | | (An_4 1/4) (Gn_4 1/2) ---------- | (Gn_4 1/2) ---------- (An_4 1/4) ; 144 | ~ mar- ~ riage, ~ O ~ I 145 | 146 | % sine 147 | | (An_3 1/4) (Gn_3 1/2) ---------- | (Gn_3 1/2) ---------- (An_3 1/4) ; 148 | 149 | % sawtooth 150 | | (Rest 1/4) (Dn_4 1/4) (Dn_4 1/4) | (Rest 1/4) (Dn_4 1/4) (Dn_4 1/4) ; 151 | | (Rest 1/4) (Bn_3 1/4) (Bn_3 1/4) | (Rest 1/4) (Bn_3 1/4) (Bn_3 1/4) ; 152 | | (Gn_3 1/4) (Rest 1/2) ---------- | (Gn_2 1/4) (Rest 1/2) ---------- ; 153 | 154 | *********************************************************************** 155 | 156 | % square 157 | | (Bn_4 1/2) ---------- (Gn_4 1/4) | (En_4 1/2) ---------- (Gn_4 1/4) ; 158 | ~ can't ~ af- ~ fford ~ a 159 | 160 | % sine 161 | | (Bn_3 1/2) ---------- (Gn_3 1/4) | (En_3 1/2) ---------- (Gn_3 1/4) ; 162 | 163 | % sawtooth 164 | | (Rest 1/4) (En_4 1/4) (En_4 1/4) | (Rest 1/4) (Cn_4 1/4) (Cn_4 1/4) ; 165 | | (Rest 1/4) (Bn_3 1/4) (Bn_3 1/4) | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) ; 166 | | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) | (Rest 1/4) (En_3 1/4) (En_3 1/4) ; 167 | | (En_2 1/4) (Rest 1/2) ---------- | (Cn_2 1/4) (Rest 1/2) ---------- ; 168 | 169 | *********************************************************************** 170 | 171 | % square 172 | | (En_4 1/4) (Dn_4 1/2) ---------- | (Dn_4 1/4) (Rest 1/4) (Dn_4 1/4) ; 173 | ~ car- ~ riage, ~ but 174 | 175 | % sine 176 | | (En_3 1/4) (Dn_3 1/2) ---------- | (Dn_3 1/4) (Rest 1/4) (Dn_3 1/4) ; 177 | 178 | % sawtooth 179 | | (Rest 1/4) (Bn_3 1/4) (Bn_3 1/4) | (Rest 1/4) (Cn_4 1/4) (Cn_4 1/4) ; 180 | | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) | (Rest 1/4) (An_3 1/4) (An_3 1/4) ; 181 | | (Rest 1/4) (Dn_3 1/4) (Dn_3 1/4) | (Rest 1/4) (Dn_3 1/4) (Dn_3 1/4) ; 182 | | (Gn_1 1/4) (Rest 1/2) ---------- | (Fs_1 1/4) (Rest 1/2) ---------- ; 183 | 184 | *********************************************************************** 185 | 186 | % square 187 | | (Gn_4 1/2) ---------- (Bn_4 1/4) | (An_4 1/4) (Rest 1/4) (An_4 1/4) ; 188 | ~ you'll- ~ look ~ sweet, ~ up- 189 | 190 | % sine 191 | | (Gn_3 1/2) ---------- (Bn_3 1/4) | (An_3 1/4) (Rest 1/4) (An_3 1/4) ; 192 | 193 | % sawtooth 194 | | (Rest 1/4) (Bn_3 1/4) (Bn_3 1/4) | (Rest 1/4) (Cn_4 1/4) (Cn_4 1/4) ; 195 | | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) | (Rest 1/4) (An_3 1/4) (An_3 1/4) ; 196 | | (Rest 1/4) (Dn_3 1/4) (Dn_3 1/4) | (Rest 1/4) (Dn_3 1/4) (Dn_3 1/4) ; 197 | | (Gn_2 1/4) (Rest 1/2) ---------- | (Fs_2 1/4) (Rest 1/2) ---------- ; 198 | 199 | ********************************************************************************** 200 | 201 | % square 202 | | (Gn_4 1/2) ---------- (Bn_4 1/4) | (An_4 1/4) (Rest 1/4) (Bn_4 1/8) (Cn_5 1/8) ; 203 | ~ on ~ the ~ seat ~ of ~ a 204 | 205 | % sine 206 | | (Gn_3 1/2) ---------- (Bn_3 1/4) | (An_3 1/4) (Rest 1/4) (Bn_3 1/8) (Cn_4 1/8) ; 207 | 208 | % sawtooth 209 | | (Rest 1/4) (Bn_3 1/4) (Bn_3 1/4) | -- (Rest 1/4) - (Cn_4 1/4) - (Cn_4 1/4) --- ; 210 | | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) | -- (Rest 1/4) - (An_3 1/4) - (An_3 1/4) --- ; 211 | | (Rest 1/4) (Dn_3 1/4) (Dn_3 1/4) | -- (Rest 1/4) - (Dn_3 1/4) - (Dn_3 1/4) --- ; 212 | | (Gn_2 1/4) (Rest 1/2) ---------- | -- (Fs_2 1/4) - (Rest 1/2) ---------------- ; 213 | 214 | ********************************************************************************** 215 | 216 | % square 217 | | (Dn_5 1/4) (Bn_4 1/4) (Gn_4 1/4) | (An_4 1/2) ---------- (Dn_4 1/4) ; 218 | ~ by- ~ cy- ~ cle ~ built ~ for 219 | 220 | % sine 221 | | (Dn_4 1/4) (Bn_3 1/4) (Gn_3 1/4) | (An_3 1/2) ---------- (Dn_3 1/4) ; 222 | 223 | % sawtooth 224 | | (Rest 1/4) (Bn_3 1/4) (Bn_3 1/4) | (Rest 1/4) (Cn_4 1/4) (Cn_4 1/4) ; 225 | | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) | (Rest 1/4) (Gn_3 1/4) (Gn_3 1/4) ; 226 | | (Rest 1/4) (Dn_3 1/4) (Dn_3 1/4) | (Rest 1/4) (Dn_3 1/4) (Dn_3 1/4) ; 227 | | (Gn_2 1/4) (Rest 1/2) ---------- | (Dn_2 1/4) (Rest 1/2) ---------- ; 228 | 229 | ********************************************************************************** 230 | 231 | % square 232 | | (Gn_4 1/2)+ -------------------- | (Gn_4 1/2)+ ; 233 | ~ two! 234 | 235 | % sine 236 | | (Gn_5 1/2)+ -------------------- | (Gn_5 1/2)+ ; 237 | | (Gn_3 1/2)+ -------------------- | (Gn_3 1/2)+ ; 238 | 239 | % sawtooth 240 | | (Gn_2 1/4) (Dn_2 1/4) (Bn_1 1/4) | (Gn_1 1/2)+ ; 241 | -------------------------------------------------------------------------------- /simple_sample.hum: -------------------------------------------------------------------------------- 1 | ~ This is a simple sample file to demonstrate the Hum Synthesizer 2 | 3 | [ 80_bpm ][ 3/4 ] 4 | 5 | *************************************************************************************** 6 | % square 7 | | - (Dn_4 1/4) - (Fs_4 1/4) - (An_4 1/4) - | - (Dn_4 1/4) - (Fs_4 1/4) - (An_4 1/4) - ; 8 | 9 | % sine 10 | | - (Dn_4 1/2)+ -------------------------- | - (Dn_4 1/2)+ -------------------------- ; 11 | | - (Fs_4 1/2)+ -------------------------- | - (Fs_4 1/2)+ -------------------------- ; 12 | | - (An_4 1/2)+ -------------------------- | - (An_4 1/2)+ -------------------------- ; 13 | 14 | *************************************************************************************** 15 | % square 16 | | - (Dn_4 1/4) - (Fs_4 1/4) - (An_4 1/4) - | - (Dn_4 1/4) - (Fs_4 1/4) - (An_4 1/4) - ; 17 | 18 | % sine 19 | | - (Dn_4 1/2)+ -------------------------- | - (Dn_4 1/2)+ -------------------------- ; 20 | | - (Fs_4 1/2)+ -------------------------- | - (Fs_4 1/2)+ -------------------------- ; 21 | | - (An_4 1/2)+ -------------------------- | - (An_4 1/2)+ -------------------------- ; 22 | 23 | ~ :) 24 | -------------------------------------------------------------------------------- /src/bin.rs: -------------------------------------------------------------------------------- 1 | /* 2 | Hum: A Music Markup Language Synthesizer 3 | Copyright (C) 2018 Connor R. Bulakites 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | extern crate clap; 20 | extern crate hum; 21 | 22 | 23 | fn main() { 24 | // Parse command line arguments. 25 | let matches = clap::Command::new("hum") 26 | .version(hum::VERSION) 27 | .author(hum::AUTHOR) 28 | .about(hum::ABOUT) 29 | .arg( 30 | clap::Arg::new("INPUT") 31 | .help("Sets the path of the hum notation file.") 32 | .required(true) 33 | .index(1) 34 | ) 35 | .arg( 36 | clap::Arg::new("OUTPUT") 37 | .help("Sets the path of the output WAV file.") 38 | .required(true) 39 | .index(2) 40 | ) 41 | .get_matches(); 42 | 43 | let input = matches.get_one::("INPUT").unwrap(); 44 | let output = matches.get_one::("OUTPUT").unwrap(); 45 | 46 | // Read the contents of the input file. 47 | let score_contents = hum::hum_io::read(input) 48 | .expect("There was a problem reading the score file."); 49 | 50 | // Run the program. 51 | match hum::convert_to_wav(score_contents, output) { 52 | Ok(_) => {}, 53 | Err(message) => eprintln!("{}", message), 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /src/hum_error.rs: -------------------------------------------------------------------------------- 1 | /* 2 | Hum: A Music Markup Language Synthesizer 3 | Copyright (C) 2018 Connor R. Bulakites 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | extern crate hound; 20 | extern crate peg; 21 | 22 | use std::error; 23 | use std::fmt; 24 | 25 | 26 | // Custom type for general Hum processing errors 27 | #[derive(Debug)] 28 | pub struct GenerateError { 29 | pub message: String, 30 | } 31 | 32 | impl fmt::Display for GenerateError { 33 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 34 | write!(f, "{}", self.message) 35 | } 36 | } 37 | 38 | impl error::Error for GenerateError {} 39 | 40 | 41 | // Declaration of Peg ParseError (type specification required) 42 | pub type ParseError = peg::error::ParseError; 43 | 44 | 45 | // Custom type for catch-all Hum errors. 46 | #[derive(Debug)] 47 | pub enum HumError { 48 | FileSaveError(hound::Error), 49 | GenerateError(GenerateError), 50 | HumParseError(ParseError), 51 | } 52 | 53 | impl From for HumError { 54 | fn from(err: hound::Error) -> HumError { 55 | HumError::FileSaveError(err) 56 | } 57 | } 58 | 59 | impl From for HumError { 60 | fn from(err: GenerateError) -> HumError { 61 | HumError::GenerateError(err) 62 | } 63 | } 64 | 65 | impl From for HumError { 66 | fn from(err: ParseError) -> HumError { 67 | HumError::HumParseError(err) 68 | } 69 | } 70 | 71 | impl fmt::Display for HumError { 72 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 73 | match *self { 74 | HumError::FileSaveError(ref err) => write!(f, "FileSaveError: {}", err), 75 | HumError::GenerateError(ref err) => write!(f, "GenerateError: {}", err), 76 | HumError::HumParseError(ref err) => write!(f, "HumParseError: {}", err), 77 | } 78 | } 79 | } 80 | 81 | impl error::Error for HumError { 82 | fn cause(&self) -> Option<&dyn error::Error> { 83 | match *self { 84 | HumError::FileSaveError(ref err) => Some(err), 85 | HumError::GenerateError(ref err) => Some(err), 86 | HumError::HumParseError(ref err) => Some(err), 87 | } 88 | } 89 | } 90 | 91 | -------------------------------------------------------------------------------- /src/hum_io.rs: -------------------------------------------------------------------------------- 1 | /* 2 | Hum: A Music Markup Language Synthesizer 3 | Copyright (C) 2018 Connor R. Bulakites 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | extern crate hound; 20 | 21 | use std::fs::File; 22 | use std::i16; 23 | use std::io; 24 | use std::io::Read; 25 | 26 | 27 | static NUM_CHANNELS: u16 = 1; 28 | static BIT_DEPTH: u16 = 16; 29 | static SAMPLE_RATE: u32 = 44_100; 30 | 31 | 32 | pub fn read(filename: &str) -> Result { 33 | let mut score_file = File::open(filename)?; 34 | let mut score_contents = String::new(); 35 | score_file.read_to_string(&mut score_contents)?; 36 | Ok(score_contents) 37 | } 38 | 39 | 40 | pub fn save(waveform: Vec, filename: &str) -> Result<(), hound::Error> { 41 | let spec = hound::WavSpec { 42 | channels: NUM_CHANNELS, 43 | sample_rate: SAMPLE_RATE, 44 | bits_per_sample: BIT_DEPTH, 45 | sample_format: hound::SampleFormat::Int, 46 | }; 47 | 48 | let mut writer = hound::WavWriter::create(filename, spec)?; 49 | 50 | for sample in waveform { 51 | let amplitude = i16::MAX as f32; 52 | writer.write_sample((sample * amplitude) as i16)?; 53 | } 54 | 55 | Ok(writer.finalize()?) 56 | } 57 | -------------------------------------------------------------------------------- /src/hum_parse.rs: -------------------------------------------------------------------------------- 1 | /* 2 | Hum: A Music Markup Language Synthesizer 3 | Copyright (C) 2018 Connor R. Bulakites 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | extern crate peg; 20 | 21 | 22 | peg::parser!{ 23 | pub grammar hum_grammar() for str { 24 | pub rule score() -> Vec<(String, String)> 25 | = commands:command()* { 26 | commands 27 | } 28 | 29 | rule command() -> (String, String) 30 | = comment() 31 | / tempo() 32 | / time() 33 | / checkpoint() 34 | / voice() 35 | / measure() 36 | / reset() 37 | / note() 38 | 39 | rule comment() -> (String, String) 40 | = ws()* "~" text:$((!['\n'][_])*) eol() { 41 | ("comment".to_string(), text.trim().to_string()) 42 | } 43 | 44 | rule tempo() -> (String, String) 45 | = ws()* "[" ws()* text:$(number()) "_bpm" ws()* "]" ws()* { 46 | ("tempo".to_string(), text.to_string()) 47 | } 48 | 49 | rule time() -> (String, String) 50 | = ws()* "[" ws()* text:$(fraction()) ws()* "]" ws()* { 51 | ("time".to_string(), text.to_string()) 52 | } 53 | 54 | rule checkpoint() -> (String, String) 55 | = ws()* "*"+ ws()* { 56 | // The second value doesn't matter for this one :) 57 | ("checkpoint".to_string(), "(｡^‿^｡)".to_string()) 58 | } 59 | 60 | rule voice() -> (String, String) 61 | = ws()* "%" ws()* text:$(name()) ws()* { 62 | ("voice".to_string(), text.to_string()) 63 | } 64 | 65 | rule measure() -> (String, String) 66 | = ws()* "|" ws()* { 67 | // The second value doesn't matter for this one :) 68 | ("measure".to_string(), "(｡￣▽￣｡)θ～♪♪".to_string()) 69 | } 70 | 71 | rule reset() -> (String, String) 72 | = ws()* ";" ws_not_newline()* (!['\n'][_])* eol() { 73 | // The second value doesn't matter for this one :) 74 | ("reset".to_string(), "ヽ(｡＾▽＾｡)ノ".to_string()) 75 | } 76 | 77 | rule note() -> (String, String) 78 | = ws()* 79 | "(" ws()* note_name:$(name()) ws()+ length:$(fraction()) ws()* ")" 80 | dots:$("+"*) ws()* { 81 | (note_name.to_string(), format!("{}{}", length, dots).to_string()) 82 | } 83 | 84 | rule name() 85 | = ['a'..='z' | 'A'..='Z' | '0'..='9' | '_']+ 86 | 87 | rule fraction() 88 | = ['0'..='9' | '/']+ 89 | 90 | rule number() 91 | = ['0'..='9']+ 92 | 93 | rule ws() 94 | = " " 95 | / "-" // Special whitespace character allowed in hum scores 96 | / "\t" 97 | / "\r" 98 | / "\n" 99 | 100 | rule eol() 101 | = "\n" 102 | / ![_] // "End of file" 103 | 104 | rule ws_not_newline() 105 | = " " 106 | / "-" // Special whitespace character allowed in hum scores 107 | / "\t" 108 | / "\r" 109 | } 110 | } 111 | -------------------------------------------------------------------------------- /src/hum_process/hum_math.rs: -------------------------------------------------------------------------------- 1 | /* 2 | Hum: A Music Markup Language Synthesizer 3 | Copyright (C) 2018 Connor R. Bulakites 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | use std::collections::HashMap; 20 | use std::f32::NAN; 21 | 22 | 23 | pub fn generate_wave(signal: &dyn Fn(f32, &f32) -> f32, frequency: &f32, duration: f32) -> Vec { 24 | let sample_rate = 44_100_f32; // The number of samples per second 25 | let num_samples = (sample_rate * duration) as usize; 26 | // Find all of the time values in the wave and calculate the function of time (signal): 27 | (0..num_samples) 28 | .map(|sample_index| sample_index as f32 / sample_rate) 29 | .map(|time_in_seconds| signal(time_in_seconds, frequency)) 30 | .map(|signal_value| { 31 | // Clip all signal values outside of the allowable range: 32 | if signal_value > 1.0 { 33 | 1.0 34 | } else if signal_value < -1.0 { 35 | -1.0 36 | } else { 37 | signal_value 38 | } 39 | }) 40 | .collect() 41 | } 42 | 43 | 44 | // Returns eight octaves of the standard 12 note scale tuned to A 440Hz: 45 | pub fn get_standard_note_frequencies(key: &str) -> HashMap { 46 | let note_names = if key == "sharps" { 47 | vec![ 48 | "Cn", "Cs", "Dn", "Ds", "En", "Fn", "Fs", "Gn", "Gs", "An", "As", "Bn", 49 | ] 50 | } else { 51 | vec![ 52 | "Cn", "Df", "Dn", "Ef", "En", "Fn", "Gf", "Gn", "Af", "An", "Bf", "Bn", 53 | ] 54 | }; 55 | 56 | let lowest_octave = 0_u8; 57 | let highest_octave = 7_u8; 58 | let concert_pitch_name = "An"; 59 | let concert_pitch_octave = 4_u8; 60 | let concert_pitch_frequency = 440_f32; 61 | 62 | calculate_note_frequencies( 63 | note_names, 64 | lowest_octave, 65 | highest_octave, 66 | concert_pitch_name, 67 | concert_pitch_octave, 68 | concert_pitch_frequency, 69 | ) 70 | } 71 | 72 | 73 | // Calculates the frequencies of notes with an arbitrary scale and tuning (concert) pitch: 74 | fn calculate_note_frequencies( 75 | note_names: Vec<&str>, 76 | lowest_octave: u8, 77 | highest_octave: u8, 78 | concert_pitch_name: &str, 79 | concert_pitch_octave: u8, 80 | concert_pitch_frequency: f32, 81 | ) -> HashMap { 82 | assert!( 83 | lowest_octave <= highest_octave, 84 | "Hum ERR: the lowest octave is indexed higher than the highest octave." 85 | ); 86 | assert!( 87 | note_names.contains(&concert_pitch_name), 88 | "Hum ERR: the concert pitch is not represented in the options for note names." 89 | ); 90 | assert!( 91 | concert_pitch_octave >= lowest_octave && concert_pitch_octave <= highest_octave, 92 | "Hum ERR: the concert pitch octave is outside the range of possible octaves." 93 | ); 94 | 95 | let notes_per_octave = note_names.len(); 96 | let root = 2_f32.powf(1_f32 / notes_per_octave as f32); 97 | 98 | let concert_pitch_position = note_names 99 | .iter() 100 | .position(|&name| name == concert_pitch_name) 101 | .unwrap(); 102 | 103 | let mut note_frequencies: HashMap = HashMap::new(); 104 | 105 | for octave in lowest_octave..(highest_octave + 1) { 106 | for (position, note) in note_names.iter().enumerate() { 107 | let name_offset = position as i32 - concert_pitch_position as i32; 108 | let octave_offset = octave as i32 - concert_pitch_octave as i32; 109 | let note_offset = name_offset + octave_offset * notes_per_octave as i32; 110 | let frequency = concert_pitch_frequency * root.powi(note_offset); 111 | note_frequencies.insert(format!("{}_{}", note, octave), frequency); 112 | } 113 | } 114 | 115 | // Insert the "rest" note with a frequency of "not a number": 116 | note_frequencies.insert("Rest".to_string(), NAN); 117 | 118 | note_frequencies 119 | } 120 | -------------------------------------------------------------------------------- /src/hum_process/hum_voice.rs: -------------------------------------------------------------------------------- 1 | /* 2 | Hum: A Music Markup Language Synthesizer 3 | Copyright (C) 2018 Connor R. Bulakites 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | use std::f32::consts::PI; 20 | 21 | 22 | pub fn silence(_: f32, _: &f32) -> f32 { 23 | 0.0 // coerce every value to 0 24 | } 25 | 26 | 27 | pub fn sine(time: f32, frequency: &f32) -> f32 { 28 | (time * frequency * 2.0 * PI).sin() 29 | } 30 | 31 | 32 | pub fn square(time: f32, frequency: &f32) -> f32 { 33 | let sine_value: f32 = sine(time, frequency); 34 | 35 | if sine_value >= 0.0 { 36 | 0.7 37 | } else { 38 | -0.7 39 | } 40 | } 41 | 42 | 43 | pub fn sawtooth(time: f32, frequency: &f32) -> f32 { 44 | 2.0 * (time * frequency - (0.5 + time * frequency).floor()) 45 | } 46 | -------------------------------------------------------------------------------- /src/hum_process/mod.rs: -------------------------------------------------------------------------------- 1 | /* 2 | Hum: A Music Markup Language Synthesizer 3 | Copyright (C) 2018 Connor R. Bulakites 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | mod hum_math; 20 | mod hum_voice; 21 | 22 | use super::hum_error::GenerateError; 23 | 24 | 25 | // The number of samples of the waveform per seconds of audio: 26 | static SAMPLE_RATE: u32 = 44_100; 27 | 28 | 29 | pub fn run_commands(score_commands: Vec<(String, String)>) -> Result, GenerateError> { 30 | // The following variables may or will change as we iterate through the *.hum file: 31 | // ------------------------------------------------------------------------------------------- 32 | // The current number of beats per second (defaults to 1.0 for a tempo of 60.0): 33 | let mut beats_per_second: f32 = 1.0; 34 | // The current measure being operated on, indexed from 0: 35 | // This starts at -1 because it should be immediately indexed at the start of the song: 36 | let mut measure_index: i32 = -1; 37 | // The greatest measure index seen so far, indexed from 0: 38 | let mut measure_greatest: i32 = -1; 39 | // The anticipated value of measure index immediately after a checkpoint: 40 | let mut checkpoint_index: i32 = -1; 41 | // The floating point value of the current time signature (defaults to 1.0): 42 | let mut time_signature: f32 = 1.0; 43 | // The number of beats in the current measure (defaults to 4): 44 | let mut beats_per_measure: f32 = 4.0; 45 | // The duration of the current measure in seconds: 46 | let mut measure_duration = beats_per_measure / beats_per_second; 47 | // The number of seconds into the track at the start of the current measure: 48 | let mut timestamp_at_measure_start: f32 = 0.0; 49 | // The number of seconds into the current measure from the start of the current measure: 50 | let mut timestamp_offset_in_measure: f32 = 0.0; 51 | // The current "instrument" or "sound" for notes being inserted into the track (default sine): 52 | let mut voice: String = "sine".to_string(); 53 | // The audio track itself; waveforms will be added to this as the *hum file is parsed: 54 | let mut track: Vec = Vec::new(); 55 | // ------------------------------------------------------------------------------------------- 56 | 57 | // Get all of the frequencies for the 12-note scale with redundant sharps and flats: 58 | let mut note_frequencies = hum_math::get_standard_note_frequencies("sharps"); 59 | let note_frequencies_flats = hum_math::get_standard_note_frequencies("flats"); 60 | note_frequencies.extend(note_frequencies_flats); 61 | 62 | // Carry out the commands of all the sentences in the order that they appear: 63 | for command in score_commands { 64 | // Separate the command into its verb clause and its noun clause: 65 | let verb = command.0; 66 | let noun = command.1; 67 | 68 | // Each possible match should correspond to a command as defined in hum_parse.rustpeg 69 | match verb.as_ref() { 70 | "comment" => { 71 | // Don't do anything on a comment 72 | } 73 | "tempo" => { 74 | // Beats per second corresponds to tempo (beats per minute) divided by seconds: 75 | beats_per_second = noun.parse::().unwrap() / 60.0; 76 | } 77 | "time" => { 78 | // Parse the numerator and denominator of the time signature: 79 | let time_signature_parts: Vec<&str> = noun.split("/").collect(); 80 | let numerator: f32 = time_signature_parts[0].parse::().unwrap(); 81 | let denominator: f32 = time_signature_parts[1].parse::().unwrap(); 82 | 83 | // Calculate the floating point value of the time signature: 84 | time_signature = numerator / denominator; 85 | 86 | // The denominator of the time signature corresponds to the beats per measure: 87 | beats_per_measure = numerator; 88 | measure_duration = beats_per_measure / beats_per_second; 89 | } 90 | "checkpoint" => { 91 | // Advance checkpoint by index of the next measure (disregarding first measure): 92 | // Using greatest measure in case tracks within one checkpoint have different 93 | // numbers of measures (which is erroneous anyway): 94 | checkpoint_index = measure_greatest + 1; 95 | measure_index = measure_greatest; 96 | } 97 | "voice" => { 98 | voice = noun; 99 | } 100 | "measure" => { 101 | // Indicate that a measure was added: 102 | measure_index += 1; 103 | 104 | // Advance timestamp to the beginning of the new measure: 105 | timestamp_at_measure_start = measure_duration * (measure_index as f32); 106 | 107 | // Always set measure offset to 0.0 at the beginning of a new measure: 108 | timestamp_offset_in_measure = 0.0; 109 | 110 | // The measure index can backtrack, but the greatest measure should not: 111 | if measure_index > measure_greatest { 112 | measure_greatest = measure_index; 113 | } 114 | } 115 | "reset" => { 116 | // Reset the measure index back to the last checkpoint: 117 | measure_index = checkpoint_index - 1; 118 | } 119 | // Assume that anything else is a note: 120 | _ => { 121 | match note_frequencies.get(&verb[..]) { 122 | // Calculate note duration: 123 | // If the note is recognized: 124 | Some(note_frequency) => { 125 | let length_parts: Vec<&str> = noun.split("/").collect(); 126 | let length_numerator: f32 = length_parts[0].parse::().unwrap(); 127 | 128 | // Count the number of pluses "dots" in note before parsing denominator: 129 | let mut length_denominator = length_parts[1].to_string(); 130 | let mut pluses = 0; 131 | 132 | for (i, ch) in length_parts[1].chars().enumerate() { 133 | if ch == '+' { 134 | pluses += 1; 135 | // Remove after counting so we don't break f32 parsing: 136 | length_denominator.remove(i); 137 | } 138 | } 139 | 140 | // Shadow previous text value with evaluated floating point: 141 | let length_denominator: f32 = length_denominator.parse::().unwrap(); 142 | 143 | // The fraction of the measure that a note takes up is its indicated 144 | // length divided by the time signature: 145 | let note_length_of_measure = 146 | (length_numerator / length_denominator) / time_signature; 147 | 148 | // Calcaulate the note duration: 149 | let mut note_duration = measure_duration * note_length_of_measure; 150 | 151 | // A "plus" or "dot" increases the note duration by 50 percent: 152 | note_duration = note_duration + (pluses as f32) * (0.5 * note_duration); 153 | 154 | // Get the current note position in the track in seconds: 155 | let note_position = 156 | timestamp_at_measure_start + timestamp_offset_in_measure; 157 | 158 | add_note_to_track( 159 | note_position, // Start position of the note in the track in seconds 160 | note_duration, // Duration of the note to add in seconds 161 | note_frequency, // Frequency of the note 162 | &voice[..], // "instrument" or "sound" of the note 163 | &mut track, // Master audio track to be mutated 164 | ); 165 | 166 | // Update the measure offset: 167 | timestamp_offset_in_measure += note_duration; 168 | } 169 | // If the note isn't recognized: 170 | None => { 171 | return Err(GenerateError{message: format!("There is no note named {}", verb)}); 172 | } 173 | } 174 | } 175 | } 176 | } 177 | 178 | Ok(track) 179 | } 180 | 181 | 182 | fn add_note_to_track( 183 | position: f32, // Start position of the note in the track in seconds 184 | duration: f32, // Duration of the note to add in seconds 185 | frequency: &f32, // Frequency of the note 186 | voice: &str, // "instrument" or "sound" of the note 187 | track: &mut Vec, // Master audio track to be mutated 188 | ) { 189 | // Generate the appropriate waveform for the note: 190 | let note = if frequency.is_nan() { 191 | // A frequency of NAN corresponds to a rest: 192 | hum_math::generate_wave(&hum_voice::silence, frequency, duration) 193 | } else { 194 | match voice { 195 | "square" => hum_math::generate_wave(&hum_voice::square, frequency, duration), 196 | "sawtooth" => hum_math::generate_wave(&hum_voice::sawtooth, frequency, duration), 197 | _ => hum_math::generate_wave(&hum_voice::sine, frequency, duration), 198 | } 199 | }; 200 | 201 | // Find the start sample for the note and the duration in number of samples: 202 | let sample_position = (position * (SAMPLE_RATE as f32)) as usize; 203 | let sample_duration = (duration * (SAMPLE_RATE as f32)) as usize; 204 | 205 | // Find the end sample for the note: 206 | let extended_position = sample_position + sample_duration; 207 | 208 | // Extend the master track if it isn't long enough to contain the new note: 209 | match track.len().checked_sub(extended_position) { 210 | Some(_) => (), 211 | None => { 212 | let num_samples_to_add = extended_position - track.len(); 213 | track.extend(vec![0.0; num_samples_to_add]); 214 | } 215 | } 216 | 217 | // Please be careful with your ears and speakers! :) 218 | let volume = 0.05; 219 | 220 | // Add the waveform to the waveforms already present in the master track: 221 | for i in 0..sample_duration { 222 | track[sample_position + i] += note[i] * volume; 223 | } 224 | } 225 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | /* 2 | Hum: A Music Markup Language Synthesizer 3 | Copyright (C) 2018 Connor R. Bulakites 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | mod hum_parse; 20 | mod hum_process; 21 | 22 | pub mod hum_error; 23 | pub mod hum_io; 24 | 25 | 26 | // Some information about the library. 27 | pub const VERSION: &str = "0.6.0"; 28 | pub const AUTHOR: &str = "Connor Bulakites "; 29 | pub const ABOUT: &str = "Hum is a music notation language and synthesizer."; 30 | 31 | 32 | fn parse_score_contents(score_contents: String) -> Result, hum_error::HumError> { 33 | // Parse the score file and use the derived commands to generate the waveform. 34 | let score_commands = hum_parse::hum_grammar::score(&score_contents[..])?; 35 | Ok(hum_process::run_commands(score_commands)?) 36 | } 37 | 38 | 39 | pub fn convert_to_wav(score_contents: String, outfname: &str) -> Result<(), hum_error::HumError> { 40 | // Generate the waveform and save it to a WAV file. 41 | let waveform = parse_score_contents(score_contents)?; 42 | Ok(hum_io::save(waveform, outfname)?) 43 | } 44 | --------------------------------------------------------------------------------