diff --git a/.gitignore b/.gitignore index 5361247..a221ac1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,2 @@ -out -bin -build -.vs -__pycache__ - -*.json -res \ No newline at end of file +target/ +.vscode/ diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..f80eeeb --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,45 @@ +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "type": "lldb", + "request": "launch", + "name": "Debug executable 'spectralyze'", + "cargo": { + "args": [ + "build", + "--bin=spectralyze", + "--package=spectralyze" + ], + "filter": { + "name": "spectralyze", + "kind": "bin" + } + }, + "args": [], + "cwd": "${workspaceFolder}" + }, + { + "type": "lldb", + "request": "launch", + "name": "Debug unit tests in executable 'spectralyze'", + "cargo": { + "args": [ + "test", + "--no-run", + "--bin=spectralyze", + "--package=spectralyze" + ], + "filter": { + "name": "spectralyze", + "kind": "bin" + } + }, + "args": [], + "cwd": "${workspaceFolder}" + } + ] +} \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt deleted file mode 100644 index 0fecd2c..0000000 --- a/CMakeLists.txt +++ /dev/null @@ -1,16 +0,0 @@ -cmake_minimum_required(VERSION 3.14) -set(CMAKE_CXX_STANDARD 17) -set(CMAKE_CXX_STANDARD_REQUIRED ON) - -project(spectralyze) - -add_executable(spectralyze - "src/main.cpp" - "src/FFT.hpp" "src/FFT.cpp" - ) - -target_include_directories(spectralyze PRIVATE - "lib/AudioFile" - "lib/json" - "lib/cxxopts" -) \ No newline at end of file diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..13a4782 --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,329 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 3 + +[[package]] +name = "bitflags" +version = "1.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" + +[[package]] +name = "cc" +version = "1.0.79" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "50d30906286121d95be3d479533b458f87493b30a4b5f79a607db8f5d11aa91f" + +[[package]] +name = "clap" +version = "4.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3d7ae14b20b94cb02149ed21a86c423859cbe18dc7ed69845cace50e52b40a5" +dependencies = [ + "bitflags", + "clap_derive", + "clap_lex", + "is-terminal", + "once_cell", + "strsim", + "termcolor", +] + +[[package]] +name = "clap_derive" +version = "4.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "44bec8e5c9d09e439c4335b1af0abaab56dcf3b94999a936e1bb47b9134288f0" +dependencies = [ + "heck", + "proc-macro-error", + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "clap_lex" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "350b9cf31731f9957399229e9b2adc51eeabdfbe9d71d9a0552275fd12710d09" +dependencies = [ + "os_str_bytes", +] + +[[package]] +name = "errno" +version = "0.2.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f639046355ee4f37944e44f60642c6f3a7efa3cf6b78c78a0d989a8ce6c396a1" +dependencies = [ + "errno-dragonfly", + "libc", + "winapi", +] + +[[package]] +name = "errno-dragonfly" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aa68f1b12764fab894d2755d2518754e71b4fd80ecfb822714a1206c2aab39bf" +dependencies = [ + "cc", + "libc", +] + +[[package]] +name = "heck" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8" + +[[package]] +name = "hermit-abi" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fed44880c466736ef9a5c5b5facefb5ed0785676d0c02d612db14e54f0d84286" + +[[package]] +name = "io-lifetimes" +version = "1.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cfa919a82ea574332e2de6e74b4c36e74d41982b335080fa59d4ef31be20fdf3" +dependencies = [ + "libc", + "windows-sys", +] + +[[package]] +name = "is-terminal" +version = "0.4.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "21b6b32576413a8e69b90e952e4a026476040d81017b80445deda5f2d3921857" +dependencies = [ + "hermit-abi", + "io-lifetimes", + "rustix", + "windows-sys", +] + +[[package]] +name = "libc" +version = "0.2.140" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "99227334921fae1a979cf0bfdfcc6b3e5ce376ef57e16fb6fb3ea2ed6095f80c" + +[[package]] +name = "linux-raw-sys" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f051f77a7c8e6957c0696eac88f26b0117e54f52d3fc682ab19397a8812846a4" + +[[package]] +name = "once_cell" +version = "1.17.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7e5500299e16ebb147ae15a00a942af264cf3688f47923b8fc2cd5858f23ad3" + +[[package]] +name = "os_str_bytes" +version = "6.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b7820b9daea5457c9f21c69448905d723fbd21136ccf521748f23fd49e723ee" + +[[package]] +name = "proc-macro-error" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da25490ff9892aab3fcf7c36f08cfb902dd3e71ca0f9f9517bea02a73a5ce38c" +dependencies = [ + "proc-macro-error-attr", + "proc-macro2", + "quote", + "syn", + "version_check", +] + +[[package]] +name = "proc-macro-error-attr" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a1be40180e52ecc98ad80b184934baf3d0d29f979574e439af5a55274b35f869" +dependencies = [ + "proc-macro2", + "quote", + "version_check", +] + +[[package]] +name = "proc-macro2" +version = "1.0.51" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5d727cae5b39d21da60fa540906919ad737832fe0b1c165da3a34d6548c849d6" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quote" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8856d8364d252a14d474036ea1358d63c9e6965c8e5c1885c18f73d70bff9c7b" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "rustix" +version = "0.36.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fd5c6ff11fecd55b40746d1995a02f2eb375bf8c00d192d521ee09f42bef37bc" +dependencies = [ + "bitflags", + "errno", + "io-lifetimes", + "libc", + "linux-raw-sys", + "windows-sys", +] + +[[package]] +name = "spectralyze" +version = "0.1.0" +dependencies = [ + "clap", +] + +[[package]] +name = "strsim" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623" + +[[package]] +name = "syn" +version = "1.0.109" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "termcolor" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "be55cf8942feac5c765c2c993422806843c9a9a45d4d5c407ad6dd2ea95eb9b6" +dependencies = [ + "winapi-util", +] + +[[package]] +name = "unicode-ident" +version = "1.0.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5464a87b239f13a63a501f2701565754bae92d243d4bb7eb12f6d57d2269bf4" + +[[package]] +name = "version_check" +version = "0.9.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f" + +[[package]] +name = "winapi" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" +dependencies = [ + "winapi-i686-pc-windows-gnu", + "winapi-x86_64-pc-windows-gnu", +] + +[[package]] +name = "winapi-i686-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" + +[[package]] +name = "winapi-util" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "70ec6ce85bb158151cae5e5c87f95a8e97d2c0c4b001223f33a334e3ce5de178" +dependencies = [ + "winapi", +] + +[[package]] +name = "winapi-x86_64-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" + +[[package]] +name = "windows-sys" +version = "0.45.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "75283be5efb2831d37ea142365f009c02ec203cd29a3ebecbc093d52315b66d0" +dependencies = [ + "windows-targets", +] + +[[package]] +name = "windows-targets" +version = "0.42.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e2522491fbfcd58cc84d47aeb2958948c4b8982e9a2d8a2a35bbaed431390e7" +dependencies = [ + "windows_aarch64_gnullvm", + "windows_aarch64_msvc", + "windows_i686_gnu", + "windows_i686_msvc", + "windows_x86_64_gnu", + "windows_x86_64_gnullvm", + "windows_x86_64_msvc", +] + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.42.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8c9864e83243fdec7fc9c5444389dcbbfd258f745e7853198f365e3c4968a608" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.42.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4c8b1b673ffc16c47a9ff48570a9d85e25d265735c503681332589af6253c6c7" + +[[package]] +name = "windows_i686_gnu" +version = "0.42.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "de3887528ad530ba7bdbb1faa8275ec7a1155a45ffa57c37993960277145d640" + +[[package]] +name = "windows_i686_msvc" +version = "0.42.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bf4d1122317eddd6ff351aa852118a2418ad4214e6613a50e0191f7004372605" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.42.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c1040f221285e17ebccbc2591ffdc2d44ee1f9186324dd3e84e99ac68d699c45" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.42.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "628bfdf232daa22b0d64fdb62b09fcc36bb01f05a3939e20ab73aaf9470d0463" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.42.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "447660ad36a13288b1db4d4248e857b510e8c3a225c822ba4fb748c0aafecffd" diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..5ea9876 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,9 @@ +[package] +name = "spectralyze" +version = "0.1.0" +edition = "2021" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +clap = { version = "4.1.8", features = ["derive"] } diff --git a/LICENSE b/LICENSE deleted file mode 100644 index f288702..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/README.md b/README.md deleted file mode 100644 index 3926af0..0000000 --- a/README.md +++ /dev/null @@ -1,89 +0,0 @@ -# spectralyze -A commandline tool for fourier transforming audio files - -## Usage -Spectralyze is a commandline tool, type `spectralyze -h` to get a list of available options. Anyways, here is an example command you might run: - -``` -spectralyze -i 50 coolSong.wav -``` - -This would read in a file called `coolSong.wav`, split it into 50ms long audio segments and then transform each of those individually. The resulting spectrums will be stored in `coolSong.json` - -## Setting a frequency range -By default, spectralyze will output the entire frequency spectrum, all the way up to the nyquist limit (which is half the sampling rate). If you are not interested in the entire spectrum you can tell the program the only output frequencies in the range you specify: -``` -spectralyze -f 0,2500 coolSong.wav -``` -This command would only output frequencies ranging from 0kHz-2.5kHz, greatly decreasing file size. - -## Disabling channels -By default this program will analyze all channels in the given audio file, if you are only interested in noe specific channel you can tell the program that via the `-m` flag: -``` -spectralyze -m 1 coolSong.wav -``` -will only analyze the first audio channel - -## Zero-padding -The FFT algorithm implemented here can only work if the number of samples is a power of 2. So by default, before performing the transformation, this program will zero-pad the signal until we reach such a sample size. Essentially, it appends a bunch of zeros to the end until it is a power of two. By using the `-p` flag you can go further than this. `-p 2` will tell the program to pad up until the power of two *after* the next one, essentially doubling the sample size. This results in a higher resolution in the frequency spectrum -``` -spectralyze -p 3 coolSong.wav -``` -This will tell the program to pad to the 3rd-next power of 2! This means, if the number if samples given is 100, it would pad it to 256 by default, and due to the `-p` switch all the way to 1024. - -**RESOLUTION (and thus file size) SCALES WITH 2^p** - -## Window functions -Window functions are used to "cut out" parts of the signal. When you use the `-i` flag, you are only looking at a certain interval in the audio file. This is equivalent to multiplying the whole audio file with a rectangular window function (it is 0 everywhere except in the interval, where it is 1). With the `-w` flag you can choose between different window functions. Currently supported are the Von-Hann function, and the Gauss function. Both of these yield "smoother" spectra and get rid of a lot of noise. - -## Example command -``` -spectralyze -i 20 -f 0,1000 -p 3 coolSong.wav -``` -After the file coolSong.wav is read, the audio signal is split into 20ms long clips, which are then each individually given to the transformation function. - -Due to `-p 3`, the zero padding will go two powers of two higher than it normally would, essentially quadrupling output resolution. - -`-f 0,1000` will limit the outputted spectrum to a range between 0kHz and 1kHz - -## Supported Formats -* WAV -* AIFF - -## What does it do -Spectralyze reads one or more audio files from the standard arguments and creates JSON files containing the spectrum of the file. -Each audio channel in the file is transformed separately. The resulting JSON has the following structure -``` -{ - "channel_1": [ | Channel of the current spectrum - { | - "begin": 0, | Index of the first sample of this segment - "end": 1000, | Index of the last sample of this segment - "spectrum": [ | - {"freq": 0.0, "mag": 1.0"}, | First spectrum datapoint - {"freq": 0.1, "mag": 1.1"}, | Second spectrum datapoint - ... - ] - }, - ... - ], - "channel_2": ... -} -``` -Every supplied audio file will result in one JSON file. The magnitude is the absolute value of the real and imaginary part of the Fourier transformation. - -## Example use case -This tool can theoretically be used to visualize music. The visualization part has to be written by you, though. For my little experiment I used python with matplotlib to create a line diagram from the spectra: - - -https://user-images.githubusercontent.com/24511538/116720172-2d217a00-a9dc-11eb-945f-5db40300da78.mp4 - - -https://user-images.githubusercontent.com/24511538/116688886-a22e8880-a9b7-11eb-9a3d-b9b5069de697.mp4 - -Visualization written by [mpsparrow](https://github.com/mpsparrow) - -## Used libraries -* [AudioFile](https://github.com/adamstark/AudioFile) for loading audio files -* [JSON for Modern C++](https://github.com/nlohmann/json) for writing JSON data -* [cxxopts](https://github.com/jarro2783/cxxopts) for parsing commandline arguments diff --git a/lib/AudioFile/AudioFile.h b/lib/AudioFile/AudioFile.h deleted file mode 100644 index 6fe30c2..0000000 --- a/lib/AudioFile/AudioFile.h +++ /dev/null @@ -1,1293 +0,0 @@ -//======================================================================= -/** @file AudioFile.h - * @author Adam Stark - * @copyright Copyright (C) 2017 Adam Stark - * - * This file is part of the 'AudioFile' library - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ -//======================================================================= - -#ifndef _AS_AudioFile_h -#define _AS_AudioFile_h - -#include -#include -#include -#include -#include -#include -#include -#include -#include - -// disable some warnings on Windows -#if defined (_MSC_VER) - __pragma(warning (push)) - __pragma(warning (disable : 4244)) - __pragma(warning (disable : 4457)) - __pragma(warning (disable : 4458)) - __pragma(warning (disable : 4389)) - __pragma(warning (disable : 4996)) -#elif defined (__GNUC__) - _Pragma("GCC diagnostic push") - _Pragma("GCC diagnostic ignored \"-Wconversion\"") - _Pragma("GCC diagnostic ignored \"-Wsign-compare\"") - _Pragma("GCC diagnostic ignored \"-Wshadow\"") -#endif - -//============================================================= -/** The different types of audio file, plus some other types to - * indicate a failure to load a file, or that one hasn't been - * loaded yet - */ -enum class AudioFileFormat -{ - Error, - NotLoaded, - Wave, - Aiff -}; - -//============================================================= -template -class AudioFile -{ -public: - - //============================================================= - typedef std::vector > AudioBuffer; - - //============================================================= - /** Constructor */ - AudioFile(); - - /** Constructor, using a given file path to load a file */ - AudioFile (std::string filePath); - - //============================================================= - /** Loads an audio file from a given file path. - * @Returns true if the file was successfully loaded - */ - bool load (std::string filePath); - - /** Saves an audio file to a given file path. - * @Returns true if the file was successfully saved - */ - bool save (std::string filePath, AudioFileFormat format = AudioFileFormat::Wave); - - //============================================================= - /** @Returns the sample rate */ - uint32_t getSampleRate() const; - - /** @Returns the number of audio channels in the buffer */ - int getNumChannels() const; - - /** @Returns true if the audio file is mono */ - bool isMono() const; - - /** @Returns true if the audio file is stereo */ - bool isStereo() const; - - /** @Returns the bit depth of each sample */ - int getBitDepth() const; - - /** @Returns the number of samples per channel */ - int getNumSamplesPerChannel() const; - - /** @Returns the length in seconds of the audio file based on the number of samples and sample rate */ - double getLengthInSeconds() const; - - /** Prints a summary of the audio file to the console */ - void printSummary() const; - - //============================================================= - - /** Set the audio buffer for this AudioFile by copying samples from another buffer. - * @Returns true if the buffer was copied successfully. - */ - bool setAudioBuffer (AudioBuffer& newBuffer); - - /** Sets the audio buffer to a given number of channels and number of samples per channel. This will try to preserve - * the existing audio, adding zeros to any new channels or new samples in a given channel. - */ - void setAudioBufferSize (int numChannels, int numSamples); - - /** Sets the number of samples per channel in the audio buffer. This will try to preserve - * the existing audio, adding zeros to new samples in a given channel if the number of samples is increased. - */ - void setNumSamplesPerChannel (int numSamples); - - /** Sets the number of channels. New channels will have the correct number of samples and be initialised to zero */ - void setNumChannels (int numChannels); - - /** Sets the bit depth for the audio file. If you use the save() function, this bit depth rate will be used */ - void setBitDepth (int numBitsPerSample); - - /** Sets the sample rate for the audio file. If you use the save() function, this sample rate will be used */ - void setSampleRate (uint32_t newSampleRate); - - //============================================================= - /** Sets whether the library should log error messages to the console. By default this is true */ - void shouldLogErrorsToConsole (bool logErrors); - - //============================================================= - /** A vector of vectors holding the audio samples for the AudioFile. You can - * access the samples by channel and then by sample index, i.e: - * - * samples[channel][sampleIndex] - */ - AudioBuffer samples; - - //============================================================= - /** An optional iXML chunk that can be added to the AudioFile. - */ - std::string iXMLChunk; - -private: - - //============================================================= - enum class Endianness - { - LittleEndian, - BigEndian - }; - - //============================================================= - AudioFileFormat determineAudioFileFormat (std::vector& fileData); - bool decodeWaveFile (std::vector& fileData); - bool decodeAiffFile (std::vector& fileData); - - //============================================================= - bool saveToWaveFile (std::string filePath); - bool saveToAiffFile (std::string filePath); - - //============================================================= - void clearAudioBuffer(); - - //============================================================= - int32_t fourBytesToInt (std::vector& source, int startIndex, Endianness endianness = Endianness::LittleEndian); - int16_t twoBytesToInt (std::vector& source, int startIndex, Endianness endianness = Endianness::LittleEndian); - int getIndexOfString (std::vector& source, std::string s); - int getIndexOfChunk (std::vector& source, const std::string& chunkHeaderID, int startIndex, Endianness endianness = Endianness::LittleEndian); - - //============================================================= - T sixteenBitIntToSample (int16_t sample); - int16_t sampleToSixteenBitInt (T sample); - - //============================================================= - uint8_t sampleToSingleByte (T sample); - T singleByteToSample (uint8_t sample); - - uint32_t getAiffSampleRate (std::vector& fileData, int sampleRateStartIndex); - bool tenByteMatch (std::vector& v1, int startIndex1, std::vector& v2, int startIndex2); - void addSampleRateToAiffData (std::vector& fileData, uint32_t sampleRate); - T clamp (T v1, T minValue, T maxValue); - - //============================================================= - void addStringToFileData (std::vector& fileData, std::string s); - void addInt32ToFileData (std::vector& fileData, int32_t i, Endianness endianness = Endianness::LittleEndian); - void addInt16ToFileData (std::vector& fileData, int16_t i, Endianness endianness = Endianness::LittleEndian); - - //============================================================= - bool writeDataToFile (std::vector& fileData, std::string filePath); - - //============================================================= - void reportError (std::string errorMessage); - - //============================================================= - AudioFileFormat audioFileFormat; - uint32_t sampleRate; - int bitDepth; - bool logErrorsToConsole {true}; -}; - - -//============================================================= -// Pre-defined 10-byte representations of common sample rates -static std::unordered_map > aiffSampleRateTable = { - {8000, {64, 11, 250, 0, 0, 0, 0, 0, 0, 0}}, - {11025, {64, 12, 172, 68, 0, 0, 0, 0, 0, 0}}, - {16000, {64, 12, 250, 0, 0, 0, 0, 0, 0, 0}}, - {22050, {64, 13, 172, 68, 0, 0, 0, 0, 0, 0}}, - {32000, {64, 13, 250, 0, 0, 0, 0, 0, 0, 0}}, - {37800, {64, 14, 147, 168, 0, 0, 0, 0, 0, 0}}, - {44056, {64, 14, 172, 24, 0, 0, 0, 0, 0, 0}}, - {44100, {64, 14, 172, 68, 0, 0, 0, 0, 0, 0}}, - {47250, {64, 14, 184, 146, 0, 0, 0, 0, 0, 0}}, - {48000, {64, 14, 187, 128, 0, 0, 0, 0, 0, 0}}, - {50000, {64, 14, 195, 80, 0, 0, 0, 0, 0, 0}}, - {50400, {64, 14, 196, 224, 0, 0, 0, 0, 0, 0}}, - {88200, {64, 15, 172, 68, 0, 0, 0, 0, 0, 0}}, - {96000, {64, 15, 187, 128, 0, 0, 0, 0, 0, 0}}, - {176400, {64, 16, 172, 68, 0, 0, 0, 0, 0, 0}}, - {192000, {64, 16, 187, 128, 0, 0, 0, 0, 0, 0}}, - {352800, {64, 17, 172, 68, 0, 0, 0, 0, 0, 0}}, - {2822400, {64, 20, 172, 68, 0, 0, 0, 0, 0, 0}}, - {5644800, {64, 21, 172, 68, 0, 0, 0, 0, 0, 0}} -}; - -//============================================================= -enum WavAudioFormat -{ - PCM = 0x0001, - IEEEFloat = 0x0003, - ALaw = 0x0006, - MULaw = 0x0007, - Extensible = 0xFFFE -}; - -//============================================================= -enum AIFFAudioFormat -{ - Uncompressed, - Compressed, - Error -}; - -//============================================================= -/* IMPLEMENTATION */ -//============================================================= - -//============================================================= -template -AudioFile::AudioFile() -{ - static_assert(std::is_floating_point::value, "ERROR: This version of AudioFile only supports floating point sample formats"); - - bitDepth = 16; - sampleRate = 44100; - samples.resize (1); - samples[0].resize (0); - audioFileFormat = AudioFileFormat::NotLoaded; -} - -//============================================================= -template -AudioFile::AudioFile (std::string filePath) - : AudioFile() -{ - load (filePath); -} - -//============================================================= -template -uint32_t AudioFile::getSampleRate() const -{ - return sampleRate; -} - -//============================================================= -template -int AudioFile::getNumChannels() const -{ - return (int)samples.size(); -} - -//============================================================= -template -bool AudioFile::isMono() const -{ - return getNumChannels() == 1; -} - -//============================================================= -template -bool AudioFile::isStereo() const -{ - return getNumChannels() == 2; -} - -//============================================================= -template -int AudioFile::getBitDepth() const -{ - return bitDepth; -} - -//============================================================= -template -int AudioFile::getNumSamplesPerChannel() const -{ - if (samples.size() > 0) - return (int) samples[0].size(); - else - return 0; -} - -//============================================================= -template -double AudioFile::getLengthInSeconds() const -{ - return (double)getNumSamplesPerChannel() / (double)sampleRate; -} - -//============================================================= -template -void AudioFile::printSummary() const -{ - std::cout << "|======================================|" << std::endl; - std::cout << "Num Channels: " << getNumChannels() << std::endl; - std::cout << "Num Samples Per Channel: " << getNumSamplesPerChannel() << std::endl; - std::cout << "Sample Rate: " << sampleRate << std::endl; - std::cout << "Bit Depth: " << bitDepth << std::endl; - std::cout << "Length in Seconds: " << getLengthInSeconds() << std::endl; - std::cout << "|======================================|" << std::endl; -} - -//============================================================= -template -bool AudioFile::setAudioBuffer (AudioBuffer& newBuffer) -{ - int numChannels = (int)newBuffer.size(); - - if (numChannels <= 0) - { - assert (false && "The buffer your are trying to use has no channels"); - return false; - } - - size_t numSamples = newBuffer[0].size(); - - // set the number of channels - samples.resize (newBuffer.size()); - - for (int k = 0; k < getNumChannels(); k++) - { - assert (newBuffer[k].size() == numSamples); - - samples[k].resize (numSamples); - - for (size_t i = 0; i < numSamples; i++) - { - samples[k][i] = newBuffer[k][i]; - } - } - - return true; -} - -//============================================================= -template -void AudioFile::setAudioBufferSize (int numChannels, int numSamples) -{ - samples.resize (numChannels); - setNumSamplesPerChannel (numSamples); -} - -//============================================================= -template -void AudioFile::setNumSamplesPerChannel (int numSamples) -{ - int originalSize = getNumSamplesPerChannel(); - - for (int i = 0; i < getNumChannels();i++) - { - samples[i].resize (numSamples); - - // set any new samples to zero - if (numSamples > originalSize) - std::fill (samples[i].begin() + originalSize, samples[i].end(), (T)0.); - } -} - -//============================================================= -template -void AudioFile::setNumChannels (int numChannels) -{ - int originalNumChannels = getNumChannels(); - int originalNumSamplesPerChannel = getNumSamplesPerChannel(); - - samples.resize (numChannels); - - // make sure any new channels are set to the right size - // and filled with zeros - if (numChannels > originalNumChannels) - { - for (int i = originalNumChannels; i < numChannels; i++) - { - samples[i].resize (originalNumSamplesPerChannel); - std::fill (samples[i].begin(), samples[i].end(), (T)0.); - } - } -} - -//============================================================= -template -void AudioFile::setBitDepth (int numBitsPerSample) -{ - bitDepth = numBitsPerSample; -} - -//============================================================= -template -void AudioFile::setSampleRate (uint32_t newSampleRate) -{ - sampleRate = newSampleRate; -} - -//============================================================= -template -void AudioFile::shouldLogErrorsToConsole (bool logErrors) -{ - logErrorsToConsole = logErrors; -} - -//============================================================= -template -bool AudioFile::load (std::string filePath) -{ - std::ifstream file (filePath, std::ios::binary); - - // check the file exists - if (! file.good()) - { - reportError ("ERROR: File doesn't exist or otherwise can't load file\n" + filePath); - return false; - } - - std::vector fileData; - - file.unsetf (std::ios::skipws); - - file.seekg (0, std::ios::end); - size_t length = file.tellg(); - file.seekg (0, std::ios::beg); - - // allocate - fileData.resize (length); - - file.read(reinterpret_cast (fileData.data()), length); - file.close(); - - if (file.gcount() != length) - { - reportError ("ERROR: Couldn't read entire file\n" + filePath); - return false; - } - - // get audio file format - audioFileFormat = determineAudioFileFormat (fileData); - - if (audioFileFormat == AudioFileFormat::Wave) - { - return decodeWaveFile (fileData); - } - else if (audioFileFormat == AudioFileFormat::Aiff) - { - return decodeAiffFile (fileData); - } - else - { - reportError ("Audio File Type: Error"); - return false; - } -} - -//============================================================= -template -bool AudioFile::decodeWaveFile (std::vector& fileData) -{ - // ----------------------------------------------------------- - // HEADER CHUNK - std::string headerChunkID (fileData.begin(), fileData.begin() + 4); - //int32_t fileSizeInBytes = fourBytesToInt (fileData, 4) + 8; - std::string format (fileData.begin() + 8, fileData.begin() + 12); - - // ----------------------------------------------------------- - // try and find the start points of key chunks - int indexOfDataChunk = getIndexOfChunk (fileData, "data", 12); - int indexOfFormatChunk = getIndexOfChunk (fileData, "fmt ", 12); - int indexOfXMLChunk = getIndexOfChunk (fileData, "iXML", 12); - - // if we can't find the data or format chunks, or the IDs/formats don't seem to be as expected - // then it is unlikely we'll able to read this file, so abort - if (indexOfDataChunk == -1 || indexOfFormatChunk == -1 || headerChunkID != "RIFF" || format != "WAVE") - { - reportError ("ERROR: this doesn't seem to be a valid .WAV file"); - return false; - } - - // ----------------------------------------------------------- - // FORMAT CHUNK - int f = indexOfFormatChunk; - std::string formatChunkID (fileData.begin() + f, fileData.begin() + f + 4); - //int32_t formatChunkSize = fourBytesToInt (fileData, f + 4); - uint16_t audioFormat = twoBytesToInt (fileData, f + 8); - uint16_t numChannels = twoBytesToInt (fileData, f + 10); - sampleRate = (uint32_t) fourBytesToInt (fileData, f + 12); - uint32_t numBytesPerSecond = fourBytesToInt (fileData, f + 16); - uint16_t numBytesPerBlock = twoBytesToInt (fileData, f + 20); - bitDepth = (int) twoBytesToInt (fileData, f + 22); - - uint16_t numBytesPerSample = static_cast (bitDepth) / 8; - - // check that the audio format is PCM or Float or extensible - if (audioFormat != WavAudioFormat::PCM && audioFormat != WavAudioFormat::IEEEFloat && audioFormat != WavAudioFormat::Extensible) - { - reportError ("ERROR: this .WAV file is encoded in a format that this library does not support at present"); - return false; - } - - // check the number of channels is mono or stereo - if (numChannels < 1 || numChannels > 128) - { - reportError ("ERROR: this WAV file seems to be an invalid number of channels (or corrupted?)"); - return false; - } - - // check header data is consistent - if (numBytesPerSecond != static_cast ((numChannels * sampleRate * bitDepth) / 8) || numBytesPerBlock != (numChannels * numBytesPerSample)) - { - reportError ("ERROR: the header data in this WAV file seems to be inconsistent"); - return false; - } - - // check bit depth is either 8, 16, 24 or 32 bit - if (bitDepth != 8 && bitDepth != 16 && bitDepth != 24 && bitDepth != 32) - { - reportError ("ERROR: this file has a bit depth that is not 8, 16, 24 or 32 bits"); - return false; - } - - // ----------------------------------------------------------- - // DATA CHUNK - int d = indexOfDataChunk; - std::string dataChunkID (fileData.begin() + d, fileData.begin() + d + 4); - int32_t dataChunkSize = fourBytesToInt (fileData, d + 4); - - int numSamples = dataChunkSize / (numChannels * bitDepth / 8); - int samplesStartIndex = indexOfDataChunk + 8; - - clearAudioBuffer(); - samples.resize (numChannels); - - for (int i = 0; i < numSamples; i++) - { - for (int channel = 0; channel < numChannels; channel++) - { - int sampleIndex = samplesStartIndex + (numBytesPerBlock * i) + channel * numBytesPerSample; - - if ((sampleIndex + (bitDepth / 8) - 1) >= fileData.size()) - { - reportError ("ERROR: read file error as the metadata indicates more samples than there are in the file data"); - return false; - } - - if (bitDepth == 8) - { - T sample = singleByteToSample (fileData[sampleIndex]); - samples[channel].push_back (sample); - } - else if (bitDepth == 16) - { - int16_t sampleAsInt = twoBytesToInt (fileData, sampleIndex); - T sample = sixteenBitIntToSample (sampleAsInt); - samples[channel].push_back (sample); - } - else if (bitDepth == 24) - { - int32_t sampleAsInt = 0; - sampleAsInt = (fileData[sampleIndex + 2] << 16) | (fileData[sampleIndex + 1] << 8) | fileData[sampleIndex]; - - if (sampleAsInt & 0x800000) // if the 24th bit is set, this is a negative number in 24-bit world - sampleAsInt = sampleAsInt | ~0xFFFFFF; // so make sure sign is extended to the 32 bit float - - T sample = (T)sampleAsInt / (T)8388608.; - samples[channel].push_back (sample); - } - else if (bitDepth == 32) - { - int32_t sampleAsInt = fourBytesToInt (fileData, sampleIndex); - T sample; - - if (audioFormat == WavAudioFormat::IEEEFloat) - sample = (T)reinterpret_cast (sampleAsInt); - else // assume PCM - sample = (T) sampleAsInt / static_cast (std::numeric_limits::max()); - - samples[channel].push_back (sample); - } - else - { - assert (false); - } - } - } - - // ----------------------------------------------------------- - // iXML CHUNK - if (indexOfXMLChunk != -1) - { - int32_t chunkSize = fourBytesToInt (fileData, indexOfXMLChunk + 4); - iXMLChunk = std::string ((const char*) &fileData[indexOfXMLChunk + 8], chunkSize); - } - - return true; -} - -//============================================================= -template -bool AudioFile::decodeAiffFile (std::vector& fileData) -{ - // ----------------------------------------------------------- - // HEADER CHUNK - std::string headerChunkID (fileData.begin(), fileData.begin() + 4); - //int32_t fileSizeInBytes = fourBytesToInt (fileData, 4, Endianness::BigEndian) + 8; - std::string format (fileData.begin() + 8, fileData.begin() + 12); - - int audioFormat = format == "AIFF" ? AIFFAudioFormat::Uncompressed : format == "AIFC" ? AIFFAudioFormat::Compressed : AIFFAudioFormat::Error; - - // ----------------------------------------------------------- - // try and find the start points of key chunks - int indexOfCommChunk = getIndexOfChunk (fileData, "COMM", 12, Endianness::BigEndian); - int indexOfSoundDataChunk = getIndexOfChunk (fileData, "SSND", 12, Endianness::BigEndian); - int indexOfXMLChunk = getIndexOfChunk (fileData, "iXML", 12, Endianness::BigEndian); - - // if we can't find the data or format chunks, or the IDs/formats don't seem to be as expected - // then it is unlikely we'll able to read this file, so abort - if (indexOfSoundDataChunk == -1 || indexOfCommChunk == -1 || headerChunkID != "FORM" || audioFormat == AIFFAudioFormat::Error) - { - reportError ("ERROR: this doesn't seem to be a valid AIFF file"); - return false; - } - - // ----------------------------------------------------------- - // COMM CHUNK - int p = indexOfCommChunk; - std::string commChunkID (fileData.begin() + p, fileData.begin() + p + 4); - //int32_t commChunkSize = fourBytesToInt (fileData, p + 4, Endianness::BigEndian); - int16_t numChannels = twoBytesToInt (fileData, p + 8, Endianness::BigEndian); - int32_t numSamplesPerChannel = fourBytesToInt (fileData, p + 10, Endianness::BigEndian); - bitDepth = (int) twoBytesToInt (fileData, p + 14, Endianness::BigEndian); - sampleRate = getAiffSampleRate (fileData, p + 16); - - // check the sample rate was properly decoded - if (sampleRate == 0) - { - reportError ("ERROR: this AIFF file has an unsupported sample rate"); - return false; - } - - // check the number of channels is mono or stereo - if (numChannels < 1 ||numChannels > 2) - { - reportError ("ERROR: this AIFF file seems to be neither mono nor stereo (perhaps multi-track, or corrupted?)"); - return false; - } - - // check bit depth is either 8, 16, 24 or 32-bit - if (bitDepth != 8 && bitDepth != 16 && bitDepth != 24 && bitDepth != 32) - { - reportError ("ERROR: this file has a bit depth that is not 8, 16, 24 or 32 bits"); - return false; - } - - // ----------------------------------------------------------- - // SSND CHUNK - int s = indexOfSoundDataChunk; - std::string soundDataChunkID (fileData.begin() + s, fileData.begin() + s + 4); - int32_t soundDataChunkSize = fourBytesToInt (fileData, s + 4, Endianness::BigEndian); - int32_t offset = fourBytesToInt (fileData, s + 8, Endianness::BigEndian); - //int32_t blockSize = fourBytesToInt (fileData, s + 12, Endianness::BigEndian); - - int numBytesPerSample = bitDepth / 8; - int numBytesPerFrame = numBytesPerSample * numChannels; - int totalNumAudioSampleBytes = numSamplesPerChannel * numBytesPerFrame; - int samplesStartIndex = s + 16 + (int)offset; - - // sanity check the data - if ((soundDataChunkSize - 8) != totalNumAudioSampleBytes || totalNumAudioSampleBytes > static_cast(fileData.size() - samplesStartIndex)) - { - reportError ("ERROR: the metadatafor this file doesn't seem right"); - return false; - } - - clearAudioBuffer(); - samples.resize (numChannels); - - for (int i = 0; i < numSamplesPerChannel; i++) - { - for (int channel = 0; channel < numChannels; channel++) - { - int sampleIndex = samplesStartIndex + (numBytesPerFrame * i) + channel * numBytesPerSample; - - if ((sampleIndex + (bitDepth / 8) - 1) >= fileData.size()) - { - reportError ("ERROR: read file error as the metadata indicates more samples than there are in the file data"); - return false; - } - - if (bitDepth == 8) - { - int8_t sampleAsSigned8Bit = (int8_t)fileData[sampleIndex]; - T sample = (T)sampleAsSigned8Bit / (T)128.; - samples[channel].push_back (sample); - } - else if (bitDepth == 16) - { - int16_t sampleAsInt = twoBytesToInt (fileData, sampleIndex, Endianness::BigEndian); - T sample = sixteenBitIntToSample (sampleAsInt); - samples[channel].push_back (sample); - } - else if (bitDepth == 24) - { - int32_t sampleAsInt = 0; - sampleAsInt = (fileData[sampleIndex] << 16) | (fileData[sampleIndex + 1] << 8) | fileData[sampleIndex + 2]; - - if (sampleAsInt & 0x800000) // if the 24th bit is set, this is a negative number in 24-bit world - sampleAsInt = sampleAsInt | ~0xFFFFFF; // so make sure sign is extended to the 32 bit float - - T sample = (T)sampleAsInt / (T)8388608.; - samples[channel].push_back (sample); - } - else if (bitDepth == 32) - { - int32_t sampleAsInt = fourBytesToInt (fileData, sampleIndex, Endianness::BigEndian); - T sample; - - if (audioFormat == AIFFAudioFormat::Compressed) - sample = (T)reinterpret_cast (sampleAsInt); - else // assume uncompressed - sample = (T) sampleAsInt / static_cast (std::numeric_limits::max()); - - samples[channel].push_back (sample); - } - else - { - assert (false); - } - } - } - - // ----------------------------------------------------------- - // iXML CHUNK - if (indexOfXMLChunk != -1) - { - int32_t chunkSize = fourBytesToInt (fileData, indexOfXMLChunk + 4); - iXMLChunk = std::string ((const char*) &fileData[indexOfXMLChunk + 8], chunkSize); - } - - return true; -} - -//============================================================= -template -uint32_t AudioFile::getAiffSampleRate (std::vector& fileData, int sampleRateStartIndex) -{ - for (auto it : aiffSampleRateTable) - { - if (tenByteMatch (fileData, sampleRateStartIndex, it.second, 0)) - return it.first; - } - - return 0; -} - -//============================================================= -template -bool AudioFile::tenByteMatch (std::vector& v1, int startIndex1, std::vector& v2, int startIndex2) -{ - for (int i = 0; i < 10; i++) - { - if (v1[startIndex1 + i] != v2[startIndex2 + i]) - return false; - } - - return true; -} - -//============================================================= -template -void AudioFile::addSampleRateToAiffData (std::vector& fileData, uint32_t sampleRate) -{ - if (aiffSampleRateTable.count (sampleRate) > 0) - { - for (int i = 0; i < 10; i++) - fileData.push_back (aiffSampleRateTable[sampleRate][i]); - } -} - -//============================================================= -template -bool AudioFile::save (std::string filePath, AudioFileFormat format) -{ - if (format == AudioFileFormat::Wave) - { - return saveToWaveFile (filePath); - } - else if (format == AudioFileFormat::Aiff) - { - return saveToAiffFile (filePath); - } - - return false; -} - -//============================================================= -template -bool AudioFile::saveToWaveFile (std::string filePath) -{ - std::vector fileData; - - int32_t dataChunkSize = getNumSamplesPerChannel() * (getNumChannels() * bitDepth / 8); - int16_t audioFormat = bitDepth == 32 ? WavAudioFormat::IEEEFloat : WavAudioFormat::PCM; - int32_t formatChunkSize = audioFormat == WavAudioFormat::PCM ? 16 : 18; - int32_t iXMLChunkSize = static_cast (iXMLChunk.size()); - - // ----------------------------------------------------------- - // HEADER CHUNK - addStringToFileData (fileData, "RIFF"); - - // The file size in bytes is the header chunk size (4, not counting RIFF and WAVE) + the format - // chunk size (24) + the metadata part of the data chunk plus the actual data chunk size - int32_t fileSizeInBytes = 4 + formatChunkSize + 8 + 8 + dataChunkSize; - if (iXMLChunkSize > 0) - { - fileSizeInBytes += (8 + iXMLChunkSize); - } - - addInt32ToFileData (fileData, fileSizeInBytes); - - addStringToFileData (fileData, "WAVE"); - - // ----------------------------------------------------------- - // FORMAT CHUNK - addStringToFileData (fileData, "fmt "); - addInt32ToFileData (fileData, formatChunkSize); // format chunk size (16 for PCM) - addInt16ToFileData (fileData, audioFormat); // audio format - addInt16ToFileData (fileData, (int16_t)getNumChannels()); // num channels - addInt32ToFileData (fileData, (int32_t)sampleRate); // sample rate - - int32_t numBytesPerSecond = (int32_t) ((getNumChannels() * sampleRate * bitDepth) / 8); - addInt32ToFileData (fileData, numBytesPerSecond); - - int16_t numBytesPerBlock = getNumChannels() * (bitDepth / 8); - addInt16ToFileData (fileData, numBytesPerBlock); - - addInt16ToFileData (fileData, (int16_t)bitDepth); - - if (audioFormat == WavAudioFormat::IEEEFloat) - addInt16ToFileData (fileData, 0); // extension size - - // ----------------------------------------------------------- - // DATA CHUNK - addStringToFileData (fileData, "data"); - addInt32ToFileData (fileData, dataChunkSize); - - for (int i = 0; i < getNumSamplesPerChannel(); i++) - { - for (int channel = 0; channel < getNumChannels(); channel++) - { - if (bitDepth == 8) - { - uint8_t byte = sampleToSingleByte (samples[channel][i]); - fileData.push_back (byte); - } - else if (bitDepth == 16) - { - int16_t sampleAsInt = sampleToSixteenBitInt (samples[channel][i]); - addInt16ToFileData (fileData, sampleAsInt); - } - else if (bitDepth == 24) - { - int32_t sampleAsIntAgain = (int32_t) (samples[channel][i] * (T)8388608.); - - uint8_t bytes[3]; - bytes[2] = (uint8_t) (sampleAsIntAgain >> 16) & 0xFF; - bytes[1] = (uint8_t) (sampleAsIntAgain >> 8) & 0xFF; - bytes[0] = (uint8_t) sampleAsIntAgain & 0xFF; - - fileData.push_back (bytes[0]); - fileData.push_back (bytes[1]); - fileData.push_back (bytes[2]); - } - else if (bitDepth == 32) - { - int32_t sampleAsInt; - - if (audioFormat == WavAudioFormat::IEEEFloat) - sampleAsInt = (int32_t) reinterpret_cast (samples[channel][i]); - else // assume PCM - sampleAsInt = (int32_t) (samples[channel][i] * std::numeric_limits::max()); - - addInt32ToFileData (fileData, sampleAsInt, Endianness::LittleEndian); - } - else - { - assert (false && "Trying to write a file with unsupported bit depth"); - return false; - } - } - } - - // ----------------------------------------------------------- - // iXML CHUNK - if (iXMLChunkSize > 0) - { - addStringToFileData (fileData, "iXML"); - addInt32ToFileData (fileData, iXMLChunkSize); - addStringToFileData (fileData, iXMLChunk); - } - - // check that the various sizes we put in the metadata are correct - if (fileSizeInBytes != static_cast (fileData.size() - 8) || dataChunkSize != (getNumSamplesPerChannel() * getNumChannels() * (bitDepth / 8))) - { - reportError ("ERROR: couldn't save file to " + filePath); - return false; - } - - // try to write the file - return writeDataToFile (fileData, filePath); -} - -//============================================================= -template -bool AudioFile::saveToAiffFile (std::string filePath) -{ - std::vector fileData; - - int32_t numBytesPerSample = bitDepth / 8; - int32_t numBytesPerFrame = numBytesPerSample * getNumChannels(); - int32_t totalNumAudioSampleBytes = getNumSamplesPerChannel() * numBytesPerFrame; - int32_t soundDataChunkSize = totalNumAudioSampleBytes + 8; - int32_t iXMLChunkSize = static_cast (iXMLChunk.size()); - - // ----------------------------------------------------------- - // HEADER CHUNK - addStringToFileData (fileData, "FORM"); - - // The file size in bytes is the header chunk size (4, not counting FORM and AIFF) + the COMM - // chunk size (26) + the metadata part of the SSND chunk plus the actual data chunk size - int32_t fileSizeInBytes = 4 + 26 + 16 + totalNumAudioSampleBytes; - if (iXMLChunkSize > 0) - { - fileSizeInBytes += (8 + iXMLChunkSize); - } - - addInt32ToFileData (fileData, fileSizeInBytes, Endianness::BigEndian); - - addStringToFileData (fileData, "AIFF"); - - // ----------------------------------------------------------- - // COMM CHUNK - addStringToFileData (fileData, "COMM"); - addInt32ToFileData (fileData, 18, Endianness::BigEndian); // commChunkSize - addInt16ToFileData (fileData, getNumChannels(), Endianness::BigEndian); // num channels - addInt32ToFileData (fileData, getNumSamplesPerChannel(), Endianness::BigEndian); // num samples per channel - addInt16ToFileData (fileData, bitDepth, Endianness::BigEndian); // bit depth - addSampleRateToAiffData (fileData, sampleRate); - - // ----------------------------------------------------------- - // SSND CHUNK - addStringToFileData (fileData, "SSND"); - addInt32ToFileData (fileData, soundDataChunkSize, Endianness::BigEndian); - addInt32ToFileData (fileData, 0, Endianness::BigEndian); // offset - addInt32ToFileData (fileData, 0, Endianness::BigEndian); // block size - - for (int i = 0; i < getNumSamplesPerChannel(); i++) - { - for (int channel = 0; channel < getNumChannels(); channel++) - { - if (bitDepth == 8) - { - uint8_t byte = sampleToSingleByte (samples[channel][i]); - fileData.push_back (byte); - } - else if (bitDepth == 16) - { - int16_t sampleAsInt = sampleToSixteenBitInt (samples[channel][i]); - addInt16ToFileData (fileData, sampleAsInt, Endianness::BigEndian); - } - else if (bitDepth == 24) - { - int32_t sampleAsIntAgain = (int32_t) (samples[channel][i] * (T)8388608.); - - uint8_t bytes[3]; - bytes[0] = (uint8_t) (sampleAsIntAgain >> 16) & 0xFF; - bytes[1] = (uint8_t) (sampleAsIntAgain >> 8) & 0xFF; - bytes[2] = (uint8_t) sampleAsIntAgain & 0xFF; - - fileData.push_back (bytes[0]); - fileData.push_back (bytes[1]); - fileData.push_back (bytes[2]); - } - else if (bitDepth == 32) - { - // write samples as signed integers (no implementation yet for floating point, but looking at WAV implementation should help) - int32_t sampleAsInt = (int32_t) (samples[channel][i] * std::numeric_limits::max()); - addInt32ToFileData (fileData, sampleAsInt, Endianness::BigEndian); - } - else - { - assert (false && "Trying to write a file with unsupported bit depth"); - return false; - } - } - } - - // ----------------------------------------------------------- - // iXML CHUNK - if (iXMLChunkSize > 0) - { - addStringToFileData (fileData, "iXML"); - addInt32ToFileData (fileData, iXMLChunkSize, Endianness::BigEndian); - addStringToFileData (fileData, iXMLChunk); - } - - // check that the various sizes we put in the metadata are correct - if (fileSizeInBytes != static_cast (fileData.size() - 8) || soundDataChunkSize != getNumSamplesPerChannel() * numBytesPerFrame + 8) - { - reportError ("ERROR: couldn't save file to " + filePath); - return false; - } - - // try to write the file - return writeDataToFile (fileData, filePath); -} - -//============================================================= -template -bool AudioFile::writeDataToFile (std::vector& fileData, std::string filePath) -{ - std::ofstream outputFile (filePath, std::ios::binary); - - if (outputFile.is_open()) - { - for (size_t i = 0; i < fileData.size(); i++) - { - char value = (char) fileData[i]; - outputFile.write (&value, sizeof (char)); - } - - outputFile.close(); - - return true; - } - - return false; -} - -//============================================================= -template -void AudioFile::addStringToFileData (std::vector& fileData, std::string s) -{ - for (size_t i = 0; i < s.length();i++) - fileData.push_back ((uint8_t) s[i]); -} - -//============================================================= -template -void AudioFile::addInt32ToFileData (std::vector& fileData, int32_t i, Endianness endianness) -{ - uint8_t bytes[4]; - - if (endianness == Endianness::LittleEndian) - { - bytes[3] = (i >> 24) & 0xFF; - bytes[2] = (i >> 16) & 0xFF; - bytes[1] = (i >> 8) & 0xFF; - bytes[0] = i & 0xFF; - } - else - { - bytes[0] = (i >> 24) & 0xFF; - bytes[1] = (i >> 16) & 0xFF; - bytes[2] = (i >> 8) & 0xFF; - bytes[3] = i & 0xFF; - } - - for (int i = 0; i < 4; i++) - fileData.push_back (bytes[i]); -} - -//============================================================= -template -void AudioFile::addInt16ToFileData (std::vector& fileData, int16_t i, Endianness endianness) -{ - uint8_t bytes[2]; - - if (endianness == Endianness::LittleEndian) - { - bytes[1] = (i >> 8) & 0xFF; - bytes[0] = i & 0xFF; - } - else - { - bytes[0] = (i >> 8) & 0xFF; - bytes[1] = i & 0xFF; - } - - fileData.push_back (bytes[0]); - fileData.push_back (bytes[1]); -} - -//============================================================= -template -void AudioFile::clearAudioBuffer() -{ - for (size_t i = 0; i < samples.size();i++) - { - samples[i].clear(); - } - - samples.clear(); -} - -//============================================================= -template -AudioFileFormat AudioFile::determineAudioFileFormat (std::vector& fileData) -{ - std::string header (fileData.begin(), fileData.begin() + 4); - - if (header == "RIFF") - return AudioFileFormat::Wave; - else if (header == "FORM") - return AudioFileFormat::Aiff; - else - return AudioFileFormat::Error; -} - -//============================================================= -template -int32_t AudioFile::fourBytesToInt (std::vector& source, int startIndex, Endianness endianness) -{ - int32_t result; - - if (endianness == Endianness::LittleEndian) - result = (source[startIndex + 3] << 24) | (source[startIndex + 2] << 16) | (source[startIndex + 1] << 8) | source[startIndex]; - else - result = (source[startIndex] << 24) | (source[startIndex + 1] << 16) | (source[startIndex + 2] << 8) | source[startIndex + 3]; - - return result; -} - -//============================================================= -template -int16_t AudioFile::twoBytesToInt (std::vector& source, int startIndex, Endianness endianness) -{ - int16_t result; - - if (endianness == Endianness::LittleEndian) - result = (source[startIndex + 1] << 8) | source[startIndex]; - else - result = (source[startIndex] << 8) | source[startIndex + 1]; - - return result; -} - -//============================================================= -template -int AudioFile::getIndexOfString (std::vector& source, std::string stringToSearchFor) -{ - int index = -1; - int stringLength = (int)stringToSearchFor.length(); - - for (size_t i = 0; i < source.size() - stringLength;i++) - { - std::string section (source.begin() + i, source.begin() + i + stringLength); - - if (section == stringToSearchFor) - { - index = static_cast (i); - break; - } - } - - return index; -} - -//============================================================= -template -int AudioFile::getIndexOfChunk (std::vector& source, const std::string& chunkHeaderID, int startIndex, Endianness endianness) -{ - constexpr int dataLen = 4; - if (chunkHeaderID.size() != dataLen) - { - assert (false && "Invalid chunk header ID string"); - return -1; - } - - int i = startIndex; - while (i < source.size() - dataLen) - { - if (memcmp (&source[i], chunkHeaderID.data(), dataLen) == 0) - { - return i; - } - - i += dataLen; - auto chunkSize = fourBytesToInt (source, i, endianness); - i += (dataLen + chunkSize); - } - - return -1; -} - -//============================================================= -template -T AudioFile::sixteenBitIntToSample (int16_t sample) -{ - return static_cast (sample) / static_cast (32768.); -} - -//============================================================= -template -int16_t AudioFile::sampleToSixteenBitInt (T sample) -{ - sample = clamp (sample, -1., 1.); - return static_cast (sample * 32767.); -} - -//============================================================= -template -uint8_t AudioFile::sampleToSingleByte (T sample) -{ - sample = clamp (sample, -1., 1.); - sample = (sample + 1.) / 2.; - return static_cast (sample * 255.); -} - -//============================================================= -template -T AudioFile::singleByteToSample (uint8_t sample) -{ - return static_cast (sample - 128) / static_cast (128.); -} - -//============================================================= -template -T AudioFile::clamp (T value, T minValue, T maxValue) -{ - value = std::min (value, maxValue); - value = std::max (value, minValue); - return value; -} - -//============================================================= -template -void AudioFile::reportError (std::string errorMessage) -{ - if (logErrorsToConsole) - std::cout << errorMessage << std::endl; -} - -#if defined (_MSC_VER) - __pragma(warning (pop)) -#elif defined (__GNUC__) - _Pragma("GCC diagnostic pop") -#endif - -#endif /* AudioFile_h */ \ No newline at end of file diff --git a/lib/cxxopts/cxxopts.hpp b/lib/cxxopts/cxxopts.hpp deleted file mode 100644 index 8d293ed..0000000 --- a/lib/cxxopts/cxxopts.hpp +++ /dev/null @@ -1,2385 +0,0 @@ -/* - -Copyright (c) 2014, 2015, 2016, 2017 Jarryd Beck - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. - -*/ - -#ifndef CXXOPTS_HPP_INCLUDED -#define CXXOPTS_HPP_INCLUDED - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#ifdef __cpp_lib_optional -#include -#define CXXOPTS_HAS_OPTIONAL -#endif - -#if __cplusplus >= 201603L -#define CXXOPTS_NODISCARD [[nodiscard]] -#else -#define CXXOPTS_NODISCARD -#endif - -#ifndef CXXOPTS_VECTOR_DELIMITER -#define CXXOPTS_VECTOR_DELIMITER ',' -#endif - -#define CXXOPTS__VERSION_MAJOR 3 -#define CXXOPTS__VERSION_MINOR 0 -#define CXXOPTS__VERSION_PATCH 0 - -namespace cxxopts -{ - static constexpr struct { - uint8_t major, minor, patch; - } version = { - CXXOPTS__VERSION_MAJOR, - CXXOPTS__VERSION_MINOR, - CXXOPTS__VERSION_PATCH - }; -} // namespace cxxopts - -//when we ask cxxopts to use Unicode, help strings are processed using ICU, -//which results in the correct lengths being computed for strings when they -//are formatted for the help output -//it is necessary to make sure that can be found by the -//compiler, and that icu-uc is linked in to the binary. - -#ifdef CXXOPTS_USE_UNICODE -#include - -namespace cxxopts -{ - using String = icu::UnicodeString; - - inline - String - toLocalString(std::string s) - { - return icu::UnicodeString::fromUTF8(std::move(s)); - } - - class UnicodeStringIterator : public - std::iterator - { - public: - - UnicodeStringIterator(const icu::UnicodeString* string, int32_t pos) - : s(string) - , i(pos) - { - } - - value_type - operator*() const - { - return s->char32At(i); - } - - bool - operator==(const UnicodeStringIterator& rhs) const - { - return s == rhs.s && i == rhs.i; - } - - bool - operator!=(const UnicodeStringIterator& rhs) const - { - return !(*this == rhs); - } - - UnicodeStringIterator& - operator++() - { - ++i; - return *this; - } - - UnicodeStringIterator - operator+(int32_t v) - { - return UnicodeStringIterator(s, i + v); - } - - private: - const icu::UnicodeString* s; - int32_t i; - }; - - inline - String& - stringAppend(String& s, String a) - { - return s.append(std::move(a)); - } - - inline - String& - stringAppend(String& s, size_t n, UChar32 c) - { - for (size_t i = 0; i != n; ++i) - { - s.append(c); - } - - return s; - } - - template - String& - stringAppend(String& s, Iterator begin, Iterator end) - { - while (begin != end) - { - s.append(*begin); - ++begin; - } - - return s; - } - - inline - size_t - stringLength(const String& s) - { - return s.length(); - } - - inline - std::string - toUTF8String(const String& s) - { - std::string result; - s.toUTF8String(result); - - return result; - } - - inline - bool - empty(const String& s) - { - return s.isEmpty(); - } -} - -namespace std -{ - inline - cxxopts::UnicodeStringIterator - begin(const icu::UnicodeString& s) - { - return cxxopts::UnicodeStringIterator(&s, 0); - } - - inline - cxxopts::UnicodeStringIterator - end(const icu::UnicodeString& s) - { - return cxxopts::UnicodeStringIterator(&s, s.length()); - } -} - -//ifdef CXXOPTS_USE_UNICODE -#else - -namespace cxxopts -{ - using String = std::string; - - template - T - toLocalString(T&& t) - { - return std::forward(t); - } - - inline - size_t - stringLength(const String& s) - { - return s.length(); - } - - inline - String& - stringAppend(String& s, const String& a) - { - return s.append(a); - } - - inline - String& - stringAppend(String& s, size_t n, char c) - { - return s.append(n, c); - } - - template - String& - stringAppend(String& s, Iterator begin, Iterator end) - { - return s.append(begin, end); - } - - template - std::string - toUTF8String(T&& t) - { - return std::forward(t); - } - - inline - bool - empty(const std::string& s) - { - return s.empty(); - } -} // namespace cxxopts - -//ifdef CXXOPTS_USE_UNICODE -#endif - -namespace cxxopts -{ - namespace - { -#ifdef _WIN32 - const std::string LQUOTE("\'"); - const std::string RQUOTE("\'"); -#else - const std::string LQUOTE("‘"); - const std::string RQUOTE("’"); -#endif - } // namespace - -#if defined(__GNUC__) -// GNU GCC with -Weffc++ will issue a warning regarding the upcoming class, we want to silence it: -// warning: base class 'class std::enable_shared_from_this' has accessible non-virtual destructor -#pragma GCC diagnostic push -#pragma GCC diagnostic ignored "-Wnon-virtual-dtor" -#pragma GCC diagnostic ignored "-Weffc++" -// This will be ignored under other compilers like LLVM clang. -#endif - class Value : public std::enable_shared_from_this - { - public: - - virtual ~Value() = default; - - virtual - std::shared_ptr - clone() const = 0; - - virtual void - parse(const std::string& text) const = 0; - - virtual void - parse() const = 0; - - virtual bool - has_default() const = 0; - - virtual bool - is_container() const = 0; - - virtual bool - has_implicit() const = 0; - - virtual std::string - get_default_value() const = 0; - - virtual std::string - get_implicit_value() const = 0; - - virtual std::shared_ptr - default_value(const std::string& value) = 0; - - virtual std::shared_ptr - implicit_value(const std::string& value) = 0; - - virtual std::shared_ptr - no_implicit_value() = 0; - - virtual bool - is_boolean() const = 0; - }; -#if defined(__GNUC__) -#pragma GCC diagnostic pop -#endif - class OptionException : public std::exception - { - public: - explicit OptionException(std::string message) - : m_message(std::move(message)) - { - } - - CXXOPTS_NODISCARD - const char* - what() const noexcept override - { - return m_message.c_str(); - } - - private: - std::string m_message; - }; - - class OptionSpecException : public OptionException - { - public: - - explicit OptionSpecException(const std::string& message) - : OptionException(message) - { - } - }; - - class OptionParseException : public OptionException - { - public: - explicit OptionParseException(const std::string& message) - : OptionException(message) - { - } - }; - - class option_exists_error : public OptionSpecException - { - public: - explicit option_exists_error(const std::string& option) - : OptionSpecException("Option " + LQUOTE + option + RQUOTE + " already exists") - { - } - }; - - class invalid_option_format_error : public OptionSpecException - { - public: - explicit invalid_option_format_error(const std::string& format) - : OptionSpecException("Invalid option format " + LQUOTE + format + RQUOTE) - { - } - }; - - class option_syntax_exception : public OptionParseException { - public: - explicit option_syntax_exception(const std::string& text) - : OptionParseException("Argument " + LQUOTE + text + RQUOTE + - " starts with a - but has incorrect syntax") - { - } - }; - - class option_not_exists_exception : public OptionParseException - { - public: - explicit option_not_exists_exception(const std::string& option) - : OptionParseException("Option " + LQUOTE + option + RQUOTE + " does not exist") - { - } - }; - - class missing_argument_exception : public OptionParseException - { - public: - explicit missing_argument_exception(const std::string& option) - : OptionParseException( - "Option " + LQUOTE + option + RQUOTE + " is missing an argument" - ) - { - } - }; - - class option_requires_argument_exception : public OptionParseException - { - public: - explicit option_requires_argument_exception(const std::string& option) - : OptionParseException( - "Option " + LQUOTE + option + RQUOTE + " requires an argument" - ) - { - } - }; - - class option_not_has_argument_exception : public OptionParseException - { - public: - option_not_has_argument_exception - ( - const std::string& option, - const std::string& arg - ) - : OptionParseException( - "Option " + LQUOTE + option + RQUOTE + - " does not take an argument, but argument " + - LQUOTE + arg + RQUOTE + " given" - ) - { - } - }; - - class option_not_present_exception : public OptionParseException - { - public: - explicit option_not_present_exception(const std::string& option) - : OptionParseException("Option " + LQUOTE + option + RQUOTE + " not present") - { - } - }; - - class option_has_no_value_exception : public OptionException - { - public: - explicit option_has_no_value_exception(const std::string& option) - : OptionException( - option.empty() ? - ("Option " + LQUOTE + option + RQUOTE + " has no value") : - "Option has no value") - { - } - }; - - class argument_incorrect_type : public OptionParseException - { - public: - explicit argument_incorrect_type - ( - const std::string& arg - ) - : OptionParseException( - "Argument " + LQUOTE + arg + RQUOTE + " failed to parse" - ) - { - } - }; - - class option_required_exception : public OptionParseException - { - public: - explicit option_required_exception(const std::string& option) - : OptionParseException( - "Option " + LQUOTE + option + RQUOTE + " is required but not present" - ) - { - } - }; - - template - void throw_or_mimic(const std::string& text) - { - static_assert(std::is_base_of::value, - "throw_or_mimic only works on std::exception and " - "deriving classes"); - -#ifndef CXXOPTS_NO_EXCEPTIONS - // If CXXOPTS_NO_EXCEPTIONS is not defined, just throw - throw T{ text }; -#else - // Otherwise manually instantiate the exception, print what() to stderr, - // and exit - T exception{ text }; - std::cerr << exception.what() << std::endl; - std::exit(EXIT_FAILURE); -#endif - } - - namespace values - { - namespace - { - std::basic_regex integer_pattern - ("(-)?(0x)?([0-9a-zA-Z]+)|((0x)?0)"); - std::basic_regex truthy_pattern - ("(t|T)(rue)?|1"); - std::basic_regex falsy_pattern - ("(f|F)(alse)?|0"); - } // namespace - - namespace detail - { - template - struct SignedCheck; - - template - struct SignedCheck - { - template - void - operator()(bool negative, U u, const std::string& text) - { - if (negative) - { - if (u > static_cast((std::numeric_limits::min)())) - { - throw_or_mimic(text); - } - } - else - { - if (u > static_cast((std::numeric_limits::max)())) - { - throw_or_mimic(text); - } - } - } - }; - - template - struct SignedCheck - { - template - void - operator()(bool, U, const std::string&) const {} - }; - - template - void - check_signed_range(bool negative, U value, const std::string& text) - { - SignedCheck::is_signed>()(negative, value, text); - } - } // namespace detail - - template - void - checked_negate(R& r, T&& t, const std::string&, std::true_type) - { - // if we got to here, then `t` is a positive number that fits into - // `R`. So to avoid MSVC C4146, we first cast it to `R`. - // See https://github.com/jarro2783/cxxopts/issues/62 for more details. - r = static_cast(-static_cast(t - 1) - 1); - } - - template - void - checked_negate(R&, T&&, const std::string& text, std::false_type) - { - throw_or_mimic(text); - } - - template - void - integer_parser(const std::string& text, T& value) - { - std::smatch match; - std::regex_match(text, match, integer_pattern); - - if (match.length() == 0) - { - throw_or_mimic(text); - } - - if (match.length(4) > 0) - { - value = 0; - return; - } - - using US = typename std::make_unsigned::type; - - constexpr bool is_signed = std::numeric_limits::is_signed; - const bool negative = match.length(1) > 0; - const uint8_t base = match.length(2) > 0 ? 16 : 10; - - auto value_match = match[3]; - - US result = 0; - - for (auto iter = value_match.first; iter != value_match.second; ++iter) - { - US digit = 0; - - if (*iter >= '0' && *iter <= '9') - { - digit = static_cast(*iter - '0'); - } - else if (base == 16 && *iter >= 'a' && *iter <= 'f') - { - digit = static_cast(*iter - 'a' + 10); - } - else if (base == 16 && *iter >= 'A' && *iter <= 'F') - { - digit = static_cast(*iter - 'A' + 10); - } - else - { - throw_or_mimic(text); - } - - const US next = static_cast(result * base + digit); - if (result > next) - { - throw_or_mimic(text); - } - - result = next; - } - - detail::check_signed_range(negative, result, text); - - if (negative) - { - checked_negate(value, result, text, std::integral_constant()); - } - else - { - value = static_cast(result); - } - } - - template - void stringstream_parser(const std::string& text, T& value) - { - std::stringstream in(text); - in >> value; - if (!in) { - throw_or_mimic(text); - } - } - - inline - void - parse_value(const std::string& text, uint8_t& value) - { - integer_parser(text, value); - } - - inline - void - parse_value(const std::string& text, int8_t& value) - { - integer_parser(text, value); - } - - inline - void - parse_value(const std::string& text, uint16_t& value) - { - integer_parser(text, value); - } - - inline - void - parse_value(const std::string& text, int16_t& value) - { - integer_parser(text, value); - } - - inline - void - parse_value(const std::string& text, uint32_t& value) - { - integer_parser(text, value); - } - - inline - void - parse_value(const std::string& text, int32_t& value) - { - integer_parser(text, value); - } - - inline - void - parse_value(const std::string& text, uint64_t& value) - { - integer_parser(text, value); - } - - inline - void - parse_value(const std::string& text, int64_t& value) - { - integer_parser(text, value); - } - - inline - void - parse_value(const std::string& text, bool& value) - { - std::smatch result; - std::regex_match(text, result, truthy_pattern); - - if (!result.empty()) - { - value = true; - return; - } - - std::regex_match(text, result, falsy_pattern); - if (!result.empty()) - { - value = false; - return; - } - - throw_or_mimic(text); - } - - inline - void - parse_value(const std::string& text, std::string& value) - { - value = text; - } - - // The fallback parser. It uses the stringstream parser to parse all types - // that have not been overloaded explicitly. It has to be placed in the - // source code before all other more specialized templates. - template - void - parse_value(const std::string& text, T& value) { - stringstream_parser(text, value); - } - - template - void - parse_value(const std::string& text, std::vector& value) - { - std::stringstream in(text); - std::string token; - while (!in.eof() && std::getline(in, token, CXXOPTS_VECTOR_DELIMITER)) { - T v; - parse_value(token, v); - value.emplace_back(std::move(v)); - } - } - -#ifdef CXXOPTS_HAS_OPTIONAL - template - void - parse_value(const std::string& text, std::optional& value) - { - T result; - parse_value(text, result); - value = std::move(result); - } -#endif - - inline - void parse_value(const std::string& text, char& c) - { - if (text.length() != 1) - { - throw_or_mimic(text); - } - - c = text[0]; - } - - template - struct type_is_container - { - static constexpr bool value = false; - }; - - template - struct type_is_container> - { - static constexpr bool value = true; - }; - - template - class abstract_value : public Value - { - using Self = abstract_value; - - public: - abstract_value() - : m_result(std::make_shared()) - , m_store(m_result.get()) - { - } - - explicit abstract_value(T* t) - : m_store(t) - { - } - - ~abstract_value() override = default; - - abstract_value& operator=(const abstract_value&) = default; - - abstract_value(const abstract_value& rhs) - { - if (rhs.m_result) - { - m_result = std::make_shared(); - m_store = m_result.get(); - } - else - { - m_store = rhs.m_store; - } - - m_default = rhs.m_default; - m_implicit = rhs.m_implicit; - m_default_value = rhs.m_default_value; - m_implicit_value = rhs.m_implicit_value; - } - - void - parse(const std::string& text) const override - { - parse_value(text, *m_store); - } - - bool - is_container() const override - { - return type_is_container::value; - } - - void - parse() const override - { - parse_value(m_default_value, *m_store); - } - - bool - has_default() const override - { - return m_default; - } - - bool - has_implicit() const override - { - return m_implicit; - } - - std::shared_ptr - default_value(const std::string& value) override - { - m_default = true; - m_default_value = value; - return shared_from_this(); - } - - std::shared_ptr - implicit_value(const std::string& value) override - { - m_implicit = true; - m_implicit_value = value; - return shared_from_this(); - } - - std::shared_ptr - no_implicit_value() override - { - m_implicit = false; - return shared_from_this(); - } - - std::string - get_default_value() const override - { - return m_default_value; - } - - std::string - get_implicit_value() const override - { - return m_implicit_value; - } - - bool - is_boolean() const override - { - return std::is_same::value; - } - - const T& - get() const - { - if (m_store == nullptr) - { - return *m_result; - } - return *m_store; - } - - protected: - std::shared_ptr m_result{}; - T* m_store{}; - - bool m_default = false; - bool m_implicit = false; - - std::string m_default_value{}; - std::string m_implicit_value{}; - }; - - template - class standard_value : public abstract_value - { - public: - using abstract_value::abstract_value; - - CXXOPTS_NODISCARD - std::shared_ptr - clone() const override - { - return std::make_shared>(*this); - } - }; - - template <> - class standard_value : public abstract_value - { - public: - ~standard_value() override = default; - - standard_value() - { - set_default_and_implicit(); - } - - explicit standard_value(bool* b) - : abstract_value(b) - { - set_default_and_implicit(); - } - - std::shared_ptr - clone() const override - { - return std::make_shared>(*this); - } - - private: - - void - set_default_and_implicit() - { - m_default = true; - m_default_value = "false"; - m_implicit = true; - m_implicit_value = "true"; - } - }; - } // namespace values - - template - std::shared_ptr - value() - { - return std::make_shared>(); - } - - template - std::shared_ptr - value(T& t) - { - return std::make_shared>(&t); - } - - class OptionAdder; - - class OptionDetails - { - public: - OptionDetails - ( - std::string short_, - std::string long_, - String desc, - std::shared_ptr val - ) - : m_short(std::move(short_)) - , m_long(std::move(long_)) - , m_desc(std::move(desc)) - , m_value(std::move(val)) - , m_count(0) - { - m_hash = std::hash{}(m_long + m_short); - } - - OptionDetails(const OptionDetails& rhs) - : m_desc(rhs.m_desc) - , m_value(rhs.m_value->clone()) - , m_count(rhs.m_count) - { - } - - OptionDetails(OptionDetails&& rhs) = default; - - CXXOPTS_NODISCARD - const String& - description() const - { - return m_desc; - } - - CXXOPTS_NODISCARD - const Value& - value() const { - return *m_value; - } - - CXXOPTS_NODISCARD - std::shared_ptr - make_storage() const - { - return m_value->clone(); - } - - CXXOPTS_NODISCARD - const std::string& - short_name() const - { - return m_short; - } - - CXXOPTS_NODISCARD - const std::string& - long_name() const - { - return m_long; - } - - size_t - hash() const - { - return m_hash; - } - - private: - std::string m_short{}; - std::string m_long{}; - String m_desc{}; - std::shared_ptr m_value{}; - int m_count; - - size_t m_hash{}; - }; - - struct HelpOptionDetails - { - std::string s; - std::string l; - String desc; - bool has_default; - std::string default_value; - bool has_implicit; - std::string implicit_value; - std::string arg_help; - bool is_container; - bool is_boolean; - }; - - struct HelpGroupDetails - { - std::string name{}; - std::string description{}; - std::vector options{}; - }; - - class OptionValue - { - public: - void - parse - ( - const std::shared_ptr& details, - const std::string& text - ) - { - ensure_value(details); - ++m_count; - m_value->parse(text); - m_long_name = &details->long_name(); - } - - void - parse_default(const std::shared_ptr& details) - { - ensure_value(details); - m_default = true; - m_long_name = &details->long_name(); - m_value->parse(); - } - -#if defined(__GNUC__) -#if __GNUC__ <= 10 && __GNUC_MINOR__ <= 1 -#pragma GCC diagnostic push -#pragma GCC diagnostic ignored "-Werror=null-dereference" -#endif -#endif - - CXXOPTS_NODISCARD - size_t - count() const noexcept - { - return m_count; - } - -#if defined(__GNUC__) -#if __GNUC__ <= 10 && __GNUC_MINOR__ <= 1 -#pragma GCC diagnostic pop -#endif -#endif - - // TODO: maybe default options should count towards the number of arguments - CXXOPTS_NODISCARD - bool - has_default() const noexcept - { - return m_default; - } - - template - const T& - as() const - { - if (m_value == nullptr) { - throw_or_mimic( - m_long_name == nullptr ? "" : *m_long_name); - } - -#ifdef CXXOPTS_NO_RTTI - return static_cast&>(*m_value).get(); -#else - return dynamic_cast&>(*m_value).get(); -#endif - } - - private: - void - ensure_value(const std::shared_ptr& details) - { - if (m_value == nullptr) - { - m_value = details->make_storage(); - } - } - - - const std::string* m_long_name = nullptr; - // Holding this pointer is safe, since OptionValue's only exist in key-value pairs, - // where the key has the string we point to. - std::shared_ptr m_value{}; - size_t m_count = 0; - bool m_default = false; - }; - - class KeyValue - { - public: - KeyValue(std::string key_, std::string value_) - : m_key(std::move(key_)) - , m_value(std::move(value_)) - { - } - - CXXOPTS_NODISCARD - const std::string& - key() const - { - return m_key; - } - - CXXOPTS_NODISCARD - const std::string& - value() const - { - return m_value; - } - - template - T - as() const - { - T result; - values::parse_value(m_value, result); - return result; - } - - private: - std::string m_key; - std::string m_value; - }; - - using ParsedHashMap = std::unordered_map; - using NameHashMap = std::unordered_map; - - class ParseResult - { - public: - - ParseResult() = default; - ParseResult(const ParseResult&) = default; - - ParseResult(NameHashMap&& keys, ParsedHashMap&& values, std::vector sequential, std::vector&& unmatched_args) - : m_keys(std::move(keys)) - , m_values(std::move(values)) - , m_sequential(std::move(sequential)) - , m_unmatched(std::move(unmatched_args)) - { - } - - ParseResult& operator=(ParseResult&&) = default; - ParseResult& operator=(const ParseResult&) = default; - - size_t - count(const std::string& o) const - { - auto iter = m_keys.find(o); - if (iter == m_keys.end()) - { - return 0; - } - - auto viter = m_values.find(iter->second); - - if (viter == m_values.end()) - { - return 0; - } - - return viter->second.count(); - } - - const OptionValue& - operator[](const std::string& option) const - { - auto iter = m_keys.find(option); - - if (iter == m_keys.end()) - { - throw_or_mimic(option); - } - - auto viter = m_values.find(iter->second); - - if (viter == m_values.end()) - { - throw_or_mimic(option); - } - - return viter->second; - } - - const std::vector& - arguments() const - { - return m_sequential; - } - - const std::vector& - unmatched() const - { - return m_unmatched; - } - - private: - NameHashMap m_keys{}; - ParsedHashMap m_values{}; - std::vector m_sequential{}; - std::vector m_unmatched{}; - }; - - struct Option - { - Option - ( - std::string opts, - std::string desc, - std::shared_ptr value = ::cxxopts::value(), - std::string arg_help = "" - ) - : opts_(std::move(opts)) - , desc_(std::move(desc)) - , value_(std::move(value)) - , arg_help_(std::move(arg_help)) - { - } - - std::string opts_; - std::string desc_; - std::shared_ptr value_; - std::string arg_help_; - }; - - using OptionMap = std::unordered_map>; - using PositionalList = std::vector; - using PositionalListIterator = PositionalList::const_iterator; - - class OptionParser - { - public: - OptionParser(const OptionMap& options, const PositionalList& positional, bool allow_unrecognised) - : m_options(options) - , m_positional(positional) - , m_allow_unrecognised(allow_unrecognised) - { - } - - ParseResult - parse(int argc, const char* const* argv); - - bool - consume_positional(const std::string& a, PositionalListIterator& next); - - void - checked_parse_arg - ( - int argc, - const char* const* argv, - int& current, - const std::shared_ptr& value, - const std::string& name - ); - - void - add_to_option(OptionMap::const_iterator iter, const std::string& option, const std::string& arg); - - void - parse_option - ( - const std::shared_ptr& value, - const std::string& name, - const std::string& arg = "" - ); - - void - parse_default(const std::shared_ptr& details); - - private: - - void finalise_aliases(); - - const OptionMap& m_options; - const PositionalList& m_positional; - - std::vector m_sequential{}; - bool m_allow_unrecognised; - - ParsedHashMap m_parsed{}; - NameHashMap m_keys{}; - }; - - class Options - { - public: - - explicit Options(std::string program, std::string help_string = "") - : m_program(std::move(program)) - , m_help_string(toLocalString(std::move(help_string))) - , m_custom_help("[OPTION...]") - , m_positional_help("positional parameters") - , m_show_positional(false) - , m_allow_unrecognised(false) - , m_width(76) - , m_tab_expansion(false) - , m_options(std::make_shared()) - { - } - - Options& - positional_help(std::string help_text) - { - m_positional_help = std::move(help_text); - return *this; - } - - Options& - custom_help(std::string help_text) - { - m_custom_help = std::move(help_text); - return *this; - } - - Options& - show_positional_help() - { - m_show_positional = true; - return *this; - } - - Options& - allow_unrecognised_options() - { - m_allow_unrecognised = true; - return *this; - } - - Options& - set_width(size_t width) - { - m_width = width; - return *this; - } - - Options& - set_tab_expansion(bool expansion = true) - { - m_tab_expansion = expansion; - return *this; - } - - ParseResult - parse(int argc, const char* const* argv); - - OptionAdder - add_options(std::string group = ""); - - void - add_options - ( - const std::string& group, - std::initializer_list