chore: scaffold Kolmekivi from nih-plug-template
A stereo delay/echo plugin. Scaffolded rather than forked: the template
and the plugins built from it diverge on branding immediately, so they
share code by file copy — as codename-206 does — not by merge base. This
repo starts its own history.
Branded with tools/brand-plugin.sh. Everything derives from PLUGIN_NAME
("Kolmekivi" -> kolmekivi / Kolmekivi / KolmekiviParams), so no override
is pinned. CODENAME is set to the repo name and, by convention, stays
there even if the plugin is later renamed.
Two identity constants are now frozen and must never move, because hosts
key saved projects and presets off them:
CLAP_ID org.novoyuuparosk.kolmekivi
VST3_CLASS_ID KolmekiviDelay!! (exactly 16 bytes)
Host categorisation is set for a delay rather than left at the template's
generic placeholders — ClapFeature::{AudioEffect,Delay,Stereo} and
Vst3SubCategory::{Fx,Delay}. These decide where the plugin appears in a
host's browser and are not covered by the branding checker, which knows
about names rather than categories.
The DSP is not written. src/lib.rs still carries the template's example
gain parameter, so the plugin builds, bundles and loads while the delay is
implemented.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WHt4DykxXaQnyaJfyS8KCn
This commit is contained in:
@@ -0,0 +1,2 @@
|
||||
[alias]
|
||||
xtask = "run --package xtask --release --"
|
||||
@@ -0,0 +1,4 @@
|
||||
# Shell scripts must keep LF endings. core.autocrlf=true on Windows would
|
||||
# otherwise check them out CRLF, which a strict POSIX sh (dash, CI containers)
|
||||
# rejects at the shebang.
|
||||
*.sh text eol=lf
|
||||
@@ -0,0 +1,61 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
paths:
|
||||
- 'src/**'
|
||||
- 'xtask/**'
|
||||
- 'Cargo.toml'
|
||||
- 'Cargo.lock'
|
||||
- 'bundler.toml'
|
||||
- 'tools/**'
|
||||
pull_request:
|
||||
branches: [ master ]
|
||||
workflow_dispatch:
|
||||
|
||||
# Target the self-hosted Rust/audio runner registered to the `musiikki` org.
|
||||
#
|
||||
# The runner is host-mode, so the rustup toolchain installed for the
|
||||
# `gitea-runner` user is used directly — nothing installs per run, and the cargo
|
||||
# registry cache stays warm between jobs.
|
||||
#
|
||||
# NOTE: `rust-audio` is an ORG-SCOPED label. A plugin cloned from this template
|
||||
# into a different org will not see that runner, and its jobs will queue
|
||||
# indefinitely rather than fail. Either register a runner advertising this label
|
||||
# for that org, or change `runs-on` below.
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: Build
|
||||
runs-on: rust-audio
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Toolchain
|
||||
run: |
|
||||
cargo --version
|
||||
rustc --version
|
||||
echo "CARGO_HOME=${CARGO_HOME:?not set on this runner}"
|
||||
|
||||
# Cheap and needs no toolchain, so it runs first: a rename that only
|
||||
# landed in half the files is worth catching before spending a build on it.
|
||||
- name: Branding consistency
|
||||
run: sh tools/check-branding.sh
|
||||
|
||||
# The default build is CLAP-only; the vst3 feature is opt-in, so both
|
||||
# configurations have to be built to know the cfg gates are still correct.
|
||||
- name: Build (default, CLAP only)
|
||||
run: cargo build --release
|
||||
|
||||
- name: Build (--features vst3)
|
||||
run: cargo build --release --features vst3
|
||||
|
||||
- name: Test
|
||||
run: cargo test --release --features vst3
|
||||
|
||||
# Proves the xtask bundler still works, which a plain `cargo build` does
|
||||
# not exercise — the bundle step is where bundler.toml and the crate name
|
||||
# have to agree.
|
||||
- name: Bundle
|
||||
run: cargo xtask bundle kolmekivi --release --features vst3
|
||||
@@ -0,0 +1,7 @@
|
||||
/target
|
||||
|
||||
# Local NIH-plug reference clone ("deluxe kit") and cookiecutter template.
|
||||
# Kept out of version control; the build depends on nih-plug via a pinned git rev,
|
||||
# not on these working copies. Clone them locally for reading the examples.
|
||||
/nih-plug
|
||||
/_template
|
||||
Generated
+2534
File diff suppressed because it is too large
Load Diff
+48
@@ -0,0 +1,48 @@
|
||||
[package]
|
||||
name = "kolmekivi"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
authors = ["Mikkeli Matlock <mikkeli@novoyuuparosk.org>"]
|
||||
homepage = "http://192.168.2.199:3005/musiikki/kolmekivi"
|
||||
description = "A stereo delay/echo plugin built with NIH-plug"
|
||||
license = "GPL-3.0-or-later"
|
||||
|
||||
[workspace]
|
||||
members = ["xtask"]
|
||||
|
||||
[features]
|
||||
# CLAP only by default. This crate is GPL-3.0-or-later, so enabling VST3 no
|
||||
# longer raises a licensing question — the gate now just keeps the default build
|
||||
# light, since `vst3-sys` and its macro machinery are a sizeable dependency a
|
||||
# CLAP-only plugin never needs. Flip `default` to ["vst3"] if you always want it:
|
||||
# cargo xtask bundle kolmekivi --release --features vst3
|
||||
default = []
|
||||
vst3 = ["nih_plug/vst3"]
|
||||
|
||||
[lib]
|
||||
# `cdylib` is the plugin binary; `lib` (rlib) lets `cargo test` link the unit tests.
|
||||
crate-type = ["cdylib", "lib"]
|
||||
|
||||
# Future-incompatibility warnings are deferred hard errors: rustc is telling you
|
||||
# this code stops compiling on some later release. Denying the group turns that
|
||||
# into a build failure the day it appears, rather than accumulating unnoticed
|
||||
# until a toolchain bump breaks the build on a day you did not choose. Style and
|
||||
# clippy lints are deliberately untouched - they stay warnings.
|
||||
[lints.rust]
|
||||
future_incompatible = { level = "deny", priority = -1 }
|
||||
|
||||
[dependencies]
|
||||
# Pinned to the same commit as musiikki/codename-206.
|
||||
# Update the `rev` when you want to update NIH-plug.
|
||||
# `default-features = false` drops nih_plug's default `vst3` feature; see [features] above.
|
||||
nih_plug = { git = "https://github.com/robbert-vdh/nih-plug.git", rev = "f36931f7af4646065488a9845d8f8c2f95252c23", default-features = false, features = ["assert_process_allocs"] }
|
||||
nih_plug_egui = { git = "https://github.com/robbert-vdh/nih-plug.git", rev = "f36931f7af4646065488a9845d8f8c2f95252c23" }
|
||||
|
||||
[profile.release]
|
||||
lto = "thin"
|
||||
strip = "symbols"
|
||||
|
||||
[profile.profiling]
|
||||
inherits = "release"
|
||||
debug = true
|
||||
strip = "none"
|
||||
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
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.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) 2026 Mikkeli Matlock
|
||||
|
||||
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 <https://www.gnu.org/licenses/>.
|
||||
|
||||
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:
|
||||
|
||||
<program> Copyright (C) 2026 Mikkeli Matlock
|
||||
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
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
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
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
@@ -0,0 +1,46 @@
|
||||
Kolmekivi
|
||||
Copyright 2026 Mikkeli Matlock
|
||||
|
||||
This product is licensed under the GNU General Public License v3.0 or later.
|
||||
See LICENSE for the full terms.
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
Third-party material
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
Portions of src/lib.rs derive from the NIH-plug cookiecutter template and from
|
||||
NIH-plug's `gain` example plugin, both by Robbert van der Helm:
|
||||
|
||||
https://github.com/robbert-vdh/nih-plug-template
|
||||
https://github.com/robbert-vdh/nih-plug
|
||||
|
||||
Those portions are licensed under the ISC License:
|
||||
|
||||
ISC License
|
||||
|
||||
Copyright (c) 2022 Robbert van der Helm
|
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for any
|
||||
purpose with or without fee is hereby granted, provided that the above
|
||||
copyright notice and this permission notice appear in all copies.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
|
||||
SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
|
||||
OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
|
||||
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
ISC is GPL-compatible, so this notice is retained rather than superseded.
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
Note on the `vst3` feature
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
Building with `--features vst3` links `vst3-sys`, which is licensed GPLv3 or
|
||||
later. This is the reason a distributed VST3 build must be GPL-licensed. No
|
||||
Steinberg SDK source is vendored or redistributed by this project; "VST" is a
|
||||
trademark of Steinberg Media Technologies GmbH, and using it to describe a
|
||||
distributed product is governed by Steinberg's trademark terms, separately from
|
||||
any copyright licence above.
|
||||
@@ -0,0 +1,177 @@
|
||||
# Kolmekivi
|
||||
|
||||
A stereo delay/echo plugin — Rust, CLAP/VST3, egui.
|
||||
|
||||
Scaffolded from [`musiikki/nih-plug-template`](http://192.168.2.199:3005/musiikki/nih-plug-template);
|
||||
the DSP is not written yet, the plugin currently passes audio through an example gain stage.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Clone this repo as your starting point
|
||||
git clone http://192.168.2.199:3005/musiikki/nih-plug-template my-plugin
|
||||
cd my-plugin
|
||||
|
||||
# Edit: src/lib.rs, Cargo.toml, bundler.toml — replace placeholder values
|
||||
# See musiikki/codename-206 for a real-world example of how to fill these in
|
||||
|
||||
# Then verify the rename landed everywhere
|
||||
sh check-branding.sh
|
||||
```
|
||||
|
||||
## Renaming
|
||||
|
||||
Identity is duplicated across `Cargo.toml`, `bundler.toml`, `src/lib.rs`, `NOTICE`,
|
||||
`Cargo.lock`, the CI workflow and the docs. Nothing makes those agree, so a half-finished
|
||||
rename builds a bundle under one name while CI bundles another.
|
||||
|
||||
Everything for it lives in `tools/`:
|
||||
|
||||
```
|
||||
tools/branding.conf the names, and what derives from what
|
||||
tools/branding-sites.tsv where each name has to appear, and in what form
|
||||
tools/brand-plugin.sh changes names
|
||||
tools/check-branding.sh verifies them
|
||||
```
|
||||
|
||||
```bash
|
||||
sh tools/brand-plugin.sh # interactive; Enter keeps a value
|
||||
sh tools/brand-plugin.sh --display "Fuzz Box" # or non-interactive; dry run
|
||||
sh tools/brand-plugin.sh --display "Fuzz Box" --apply
|
||||
sh tools/check-branding.sh # exit 0 = consistent, 1 = drift
|
||||
```
|
||||
|
||||
**One name drives the rest.** `PLUGIN_NAME` derives the package name (`Fuzz Box` →
|
||||
`fuzz_box`), the Rust types (`FuzzBox`, `FuzzBoxParams`) and the display name. Each is
|
||||
overridable in `branding.conf`, because the derivation is sometimes wrong and sometimes
|
||||
outright invalid — `206 Prototype` derives to `206_prototype`, which Cargo rejects since a
|
||||
package name cannot start with a digit. The helper refuses those, along with Rust keywords
|
||||
and built-in crate names.
|
||||
|
||||
**The checker does both halves.** Every canonical value is asserted *present* where it
|
||||
belongs, and every retired spelling is swept for. Absence alone is not enough: renaming to
|
||||
the wrong new spelling would pass a stale-sweep and still break CI.
|
||||
|
||||
**Two things it will not do for you.** `CLAP_ID` and `VST3_CLASS_ID` are how hosts recognise
|
||||
saved projects and presets — change either and every existing session silently loses the
|
||||
plugin, with no error. They need `--allow-identity-change`, and the 16-byte class ID is
|
||||
*proposed* rather than derived, because that choice is yours. And `CLAP_DESCRIPTION` is
|
||||
rejected if it carries a retired name or the repo codename: hosts show it to users who never
|
||||
knew your development history.
|
||||
|
||||
**The repo name is deliberately not derived.** It is fixed when the repo is created and keeps
|
||||
its development codename while the plugin gets a product name. `CODENAME` records it so it
|
||||
can be kept out of user-facing text.
|
||||
|
||||
Adding a site the template doesn't ship is one row in `branding-sites.tsv` with owner
|
||||
`custom` — no shell to edit, and it survives regeneration. Rows the helper owns are rewritten
|
||||
on each rename; custom rows are carried through and value-substituted like any other file.
|
||||
Both files can be hand-edited; the helper is what keeps them agreeing, so run the checker
|
||||
after if you do.
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
# Install Rust via rustup: https://rustup.rs
|
||||
# No VST3 SDK needed — NIH-plug bundles its own bindings.
|
||||
|
||||
# Build + bundle the CLAP (default)
|
||||
cargo xtask bundle kolmekivi --release
|
||||
|
||||
# Add the VST3 as well — see the licensing note below before you do this
|
||||
cargo xtask bundle kolmekivi --release --features vst3
|
||||
```
|
||||
|
||||
**Output:** `target/bundled/<name>.clap` (and `<name>.vst3` with `--features vst3`), where
|
||||
`<name>` is the `name` set in `bundler.toml` — **not** the crate name. Out of the box that
|
||||
means `target/bundled/Kolmekivi.clap`.
|
||||
|
||||
On Linux the egui editor needs the GUI development headers:
|
||||
|
||||
```bash
|
||||
sudo apt install pkg-config libgl-dev libx11-dev libxcursor-dev libxcb1-dev \
|
||||
libxcb-icccm4-dev libxcb-dri2-0-dev libx11-xcb-dev libxkbcommon-dev libxkbcommon-x11-dev
|
||||
```
|
||||
|
||||
## Deploy
|
||||
|
||||
### FL Studio
|
||||
|
||||
Build with `--features vst3` first if you want the VST3 (see the licensing note below).
|
||||
|
||||
FL Studio scans `C:\Program Files\Common Files\VST3` by default, **ignores directory junctions**
|
||||
(so a symlinked bundle is invisible to its scanner), and caches failed scans.
|
||||
|
||||
1. Copy the `.vst3` bundle to a folder FL scans (e.g. `C:\Program Files\Common Files\VST3`).
|
||||
2. Copy the `.clap` bundle to a folder FL scans (e.g. `C:\Program Files\Common Files\CLAP`).
|
||||
3. In FL Studio: **Options → Manage plugins → tick "Rescan previously failed plugins" → Find installed plugins**, then search for your plugin name (set in `bundler.toml`).
|
||||
|
||||
### Linux
|
||||
|
||||
```bash
|
||||
# CLAP
|
||||
cp -r "target/bundled/Kolmekivi.clap" ~/.clap/
|
||||
|
||||
# VST3 (only exists if you built with --features vst3)
|
||||
cp -r "target/bundled/Kolmekivi.vst3" ~/.vst3/
|
||||
|
||||
# Or globally:
|
||||
# sudo cp -r "target/bundled/Kolmekivi.clap" /usr/lib/clap/
|
||||
# sudo cp -r "target/bundled/Kolmekivi.vst3" /usr/lib/vst3/
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
Cargo.toml # Package deps + the opt-in `vst3` feature — NIH-plug pinned to codename-206's rev
|
||||
bundler.toml # Bundle name for `cargo xtask bundle`
|
||||
src/lib.rs # Plugin skeleton — params, DSP, and egui editor, with one example gain param
|
||||
xtask/ # Bundler xtask (cargo xtask bundle)
|
||||
.cargo/config.toml # xtask alias
|
||||
tools/ # Branding toolkit — see Renaming
|
||||
.gitattributes # Pins *.sh to LF so Windows checkouts keep a valid shebang
|
||||
.github/workflows/ # CI: branding check, both feature sets build, test, bundle
|
||||
```
|
||||
|
||||
## CI
|
||||
|
||||
`.github/workflows/ci.yaml` gates pushes and PRs on the branding check, a build of both
|
||||
feature sets, `cargo test`, and a bundle — enough to catch a rename that only half-landed,
|
||||
a `cfg(feature = "vst3")` gate that stopped compiling, or a `bundler.toml` that no longer
|
||||
matches the crate name.
|
||||
|
||||
It targets `runs-on: rust-audio`, an **org-scoped** runner label. A plugin cloned into a
|
||||
different org will not see that runner and its jobs will queue indefinitely rather than fail
|
||||
— register a runner advertising the label for that org, or change `runs-on`.
|
||||
|
||||
Deliberately not covered: plugin performance. Realtime cost can only be measured meaningfully
|
||||
against a real audio deadline, and `Plugin::process()` cannot be called from a test at all
|
||||
(`ProcessContext` requires a `Transport`, whose constructor and fields are `pub(crate)` to
|
||||
nih-plug). Benchmark your DSP types directly if you need it.
|
||||
|
||||
## License
|
||||
|
||||
**GPL-3.0-or-later.** See `LICENSE` for the terms and `NOTICE` for third-party attribution.
|
||||
|
||||
Plugins cloned from this template inherit GPL-3.0-or-later, because the template's own code
|
||||
is under it. If you need a permissive plugin, this is the wrong starting point — write the
|
||||
skeleton yourself against NIH-plug directly, which is ISC.
|
||||
|
||||
Parts of `src/lib.rs` derive from Robbert van der Helm's NIH-plug cookiecutter template and
|
||||
`gain` example, both ISC. ISC is GPL-compatible, so that notice is retained in `NOTICE`
|
||||
rather than superseded.
|
||||
|
||||
## VST3 and Steinberg
|
||||
|
||||
`vst3-sys`, which `nih_export_vst3!()` needs, is GPLv3-or-later — chosen by its own authors,
|
||||
who describe their port as a derivative of Steinberg's SDK that "was not made in isolation."
|
||||
That obligation is what makes a distributed VST3 build GPL-licensed, and it holds regardless
|
||||
of any question about Steinberg's own rights. Being GPL-3.0-or-later already, this template
|
||||
satisfies it.
|
||||
|
||||
No Steinberg SDK source is vendored or redistributed here, so there is nothing to accept at
|
||||
build time. Separately from copyright, **"VST" is a trademark of Steinberg Media Technologies
|
||||
GmbH**; describing a distributed product as a VST plugin is governed by their trademark terms.
|
||||
If you intend to distribute commercially under that name, that is the part worth legal advice.
|
||||
|
||||
CLAP carries none of this — no GPL dependency and no trademark encumbrance.
|
||||
@@ -0,0 +1,7 @@
|
||||
# Metadata for NIH-plug's `cargo xtask bundle <package>` bundler.
|
||||
#
|
||||
# [package_name]
|
||||
# name = "Human Readable Bundle Name" # defaults to <package_name>
|
||||
|
||||
[kolmekivi]
|
||||
name = "Kolmekivi"
|
||||
+147
@@ -0,0 +1,147 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
use nih_plug::prelude::*;
|
||||
use nih_plug_egui::{create_egui_editor, egui, widgets, EguiState};
|
||||
use std::sync::Arc;
|
||||
|
||||
// ──────────────────────────────────────────────
|
||||
// Params — add your plugin parameters here.
|
||||
// See musiikki/codename-206/src/params.rs for a real example.
|
||||
// ──────────────────────────────────────────────
|
||||
|
||||
#[derive(Params)]
|
||||
struct KolmekiviParams {
|
||||
/// Editor window size, persisted with the plugin state.
|
||||
#[persist = "editor-state"]
|
||||
editor_state: Arc<EguiState>,
|
||||
|
||||
/// Example parameter — replace with your own. The `id` is the stable key the host
|
||||
/// stores automation against, so never change it once you've shipped.
|
||||
#[id = "gain"]
|
||||
gain: FloatParam,
|
||||
}
|
||||
|
||||
impl Default for KolmekiviParams {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
editor_state: EguiState::from_size(320, 160),
|
||||
gain: FloatParam::new(
|
||||
"Gain",
|
||||
util::db_to_gain(0.0),
|
||||
FloatRange::Skewed {
|
||||
min: util::db_to_gain(-30.0),
|
||||
max: util::db_to_gain(30.0),
|
||||
factor: FloatRange::gain_skew_factor(-30.0, 30.0),
|
||||
},
|
||||
)
|
||||
.with_smoother(SmoothingStyle::Logarithmic(50.0))
|
||||
.with_unit(" dB")
|
||||
.with_value_to_string(formatters::v2s_f32_gain_to_db(2))
|
||||
.with_string_to_value(formatters::s2v_f32_gain_to_db()),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ──────────────────────────────────────────────
|
||||
// Plugin
|
||||
// ──────────────────────────────────────────────
|
||||
|
||||
#[derive(Default)]
|
||||
struct Kolmekivi {
|
||||
params: Arc<KolmekiviParams>,
|
||||
}
|
||||
|
||||
impl Plugin for Kolmekivi {
|
||||
// TODO: Replace these placeholder values with your plugin's metadata.
|
||||
const NAME: &'static str = "Kolmekivi";
|
||||
const VENDOR: &'static str = "Novoyuuparosk";
|
||||
const URL: &'static str = env!("CARGO_PKG_HOMEPAGE");
|
||||
const EMAIL: &'static str = "mikkeli@novoyuuparosk.org";
|
||||
|
||||
const VERSION: &'static str = env!("CARGO_PKG_VERSION");
|
||||
|
||||
const AUDIO_IO_LAYOUTS: &'static [AudioIOLayout] = &[AudioIOLayout {
|
||||
main_input_channels: NonZeroU32::new(2),
|
||||
main_output_channels: NonZeroU32::new(2),
|
||||
..AudioIOLayout::const_default()
|
||||
}];
|
||||
|
||||
const MIDI_INPUT: MidiConfig = MidiConfig::None;
|
||||
const MIDI_OUTPUT: MidiConfig = MidiConfig::None;
|
||||
|
||||
const SAMPLE_ACCURATE_AUTOMATION: bool = true;
|
||||
|
||||
type SysExMessage = ();
|
||||
type BackgroundTask = ();
|
||||
|
||||
fn params(&self) -> Arc<dyn Params> {
|
||||
self.params.clone()
|
||||
}
|
||||
|
||||
fn editor(&mut self, _async_executor: AsyncExecutor<Self>) -> Option<Box<dyn Editor>> {
|
||||
// TODO: Build your own egui layout here.
|
||||
let params = self.params.clone();
|
||||
create_egui_editor(
|
||||
self.params.editor_state.clone(),
|
||||
(),
|
||||
|_, _| {},
|
||||
move |egui_ctx, setter, _state| {
|
||||
egui::CentralPanel::default().show(egui_ctx, |ui| {
|
||||
ui.label("Gain");
|
||||
ui.add(widgets::ParamSlider::for_param(¶ms.gain, setter));
|
||||
});
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
fn initialize(
|
||||
&mut self,
|
||||
_audio_io_layout: &AudioIOLayout,
|
||||
_buffer_config: &BufferConfig,
|
||||
_context: &mut impl InitContext<Self>,
|
||||
) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
fn reset(&mut self) {}
|
||||
|
||||
fn process(
|
||||
&mut self,
|
||||
buffer: &mut Buffer,
|
||||
_aux: &mut AuxiliaryBuffers,
|
||||
_context: &mut impl ProcessContext<Self>,
|
||||
) -> ProcessStatus {
|
||||
// TODO: Implement your DSP here. This applies the example gain parameter; note that
|
||||
// the smoother is advanced once per frame so automation doesn't zipper.
|
||||
for mut frame in buffer.iter_samples() {
|
||||
let gain = self.params.gain.smoothed.next();
|
||||
for sample in frame.iter_mut() {
|
||||
*sample *= gain;
|
||||
}
|
||||
}
|
||||
|
||||
ProcessStatus::Normal
|
||||
}
|
||||
}
|
||||
|
||||
impl ClapPlugin for Kolmekivi {
|
||||
// Frozen identity: hosts key saved projects and presets off this. Never change it.
|
||||
const CLAP_ID: &'static str = "org.novoyuuparosk.kolmekivi";
|
||||
const CLAP_DESCRIPTION: Option<&'static str> = Some("Stereo delay with feedback and mix control");
|
||||
const CLAP_MANUAL_URL: Option<&'static str> = Some(Self::URL);
|
||||
const CLAP_SUPPORT_URL: Option<&'static str> = None;
|
||||
const CLAP_FEATURES: &'static [ClapFeature] =
|
||||
&[ClapFeature::AudioEffect, ClapFeature::Delay, ClapFeature::Stereo];
|
||||
}
|
||||
|
||||
#[cfg(feature = "vst3")]
|
||||
impl Vst3Plugin for Kolmekivi {
|
||||
// Frozen identity, exactly 16 bytes. Never change it once distributed.
|
||||
const VST3_CLASS_ID: [u8; 16] = *b"KolmekiviDelay!!";
|
||||
const VST3_SUBCATEGORIES: &'static [Vst3SubCategory] =
|
||||
&[Vst3SubCategory::Fx, Vst3SubCategory::Delay];
|
||||
}
|
||||
|
||||
nih_export_clap!(Kolmekivi);
|
||||
#[cfg(feature = "vst3")]
|
||||
nih_export_vst3!(Kolmekivi);
|
||||
Executable
+355
@@ -0,0 +1,355 @@
|
||||
#!/bin/sh
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
# brand-plugin.sh - rename this plugin, everywhere, in one go.
|
||||
#
|
||||
# check-branding.sh tells you what disagrees. This changes it. They share
|
||||
# branding.conf: this script rewrites that file and every copy of the old values
|
||||
# in tracked files, then runs the checker and reports what it says. A run that
|
||||
# ends with the checker green is a rename that landed.
|
||||
#
|
||||
# Dry run by default:
|
||||
# sh brand-plugin.sh --display "Bari 206"
|
||||
# sh brand-plugin.sh --display "Bari 206" --vendor Novoyuuparosk --apply
|
||||
#
|
||||
# Options:
|
||||
# --display NAME the product name, with spaces and capitals. Everything
|
||||
# else that can be derived, is derived from this.
|
||||
# --pkg NAME override the derived Cargo package name.
|
||||
# --vendor NAME --email ADDR --homepage URL
|
||||
# --description D --clap-description D
|
||||
# --struct NAME override the derived Rust type name.
|
||||
# --allow-identity-change permit CLAP_ID / VST3_CLASS_ID to move. See below.
|
||||
# --apply actually write. Without it, nothing is modified.
|
||||
|
||||
set -u
|
||||
# Resolve the repo root: these live in tools/, every path they touch is
|
||||
# repo-relative, and they must behave the same wherever they are invoked from.
|
||||
cd "$(dirname "$0")/.." || exit 1
|
||||
[ -f tools/branding.conf ] || { printf 'tools/branding.conf not found\n' >&2; exit 1; }
|
||||
# shellcheck disable=SC1091
|
||||
. ./tools/branding.conf
|
||||
|
||||
OLD_PKG="$PKG"; OLD_DISPLAY="$DISPLAY"; OLD_PLUGIN_NAME="$PLUGIN_NAME"
|
||||
OLD_VENDOR="$VENDOR"; OLD_EMAIL="$EMAIL"; OLD_HOMEPAGE="$HOMEPAGE"; OLD_AUTHOR="$AUTHOR"
|
||||
OLD_DESCRIPTION="$DESCRIPTION"; OLD_CLAP_DESCRIPTION="$CLAP_DESCRIPTION"
|
||||
OLD_CLAP_ID="$CLAP_ID"; OLD_VST3="$VST3_CLASS_ID"
|
||||
OLD_STRUCT="$STRUCT"; OLD_PARAMS_STRUCT="$PARAMS_STRUCT"
|
||||
|
||||
new_display=""; new_pkg=""; new_vendor=""; new_email=""; new_homepage=""
|
||||
new_description=""; new_clap_description=""; new_struct=""; new_author=""
|
||||
new_clap_id=""; new_vst3=""; apply=0; allow_identity=0
|
||||
|
||||
while [ $# -gt 0 ]; do
|
||||
case "$1" in
|
||||
--display) new_display="${2:?}"; shift 2 ;;
|
||||
--pkg) new_pkg="${2:?}"; shift 2 ;;
|
||||
--vendor) new_vendor="${2:?}"; shift 2 ;;
|
||||
--author) new_author="${2:?}"; shift 2 ;;
|
||||
--email) new_email="${2:?}"; shift 2 ;;
|
||||
--homepage) new_homepage="${2:?}"; shift 2 ;;
|
||||
--description) new_description="${2:?}"; shift 2 ;;
|
||||
--clap-description) new_clap_description="${2:?}"; shift 2 ;;
|
||||
--struct) new_struct="${2:?}"; shift 2 ;;
|
||||
--clap-id) new_clap_id="${2:?}"; shift 2 ;;
|
||||
--vst3-class-id) new_vst3="${2:?}"; shift 2 ;;
|
||||
--allow-identity-change) allow_identity=1; shift ;;
|
||||
--apply) apply=1; shift ;;
|
||||
-h|--help) sed -n '3,25p' "$0"; exit 0 ;;
|
||||
*) printf 'unknown option: %s\n' "$1" >&2; exit 2 ;;
|
||||
esac
|
||||
done
|
||||
|
||||
# Interactive when nothing was passed and there is a terminal to ask at. Every
|
||||
# prompt offers the current value; Enter keeps it, so a run that answers nothing
|
||||
# is a no-op rather than a surprise. Optional fields additionally accept "-" to
|
||||
# clear them.
|
||||
ask() { # ask VARNAME PROMPT CURRENT
|
||||
printf ' %s [%s]: ' "$2" "$3" > /dev/tty
|
||||
IFS= read -r _reply < /dev/tty || _reply=""
|
||||
[ -n "$_reply" ] || _reply="$3"
|
||||
[ "$_reply" = "-" ] && _reply=""
|
||||
eval "$1=\$_reply"
|
||||
}
|
||||
if [ -z "$new_display" ] && [ -t 0 ] && [ -c /dev/tty ]; then
|
||||
printf 'branding this plugin - Enter keeps the current value, "-" clears an optional one\n\n'
|
||||
ask new_display "display name " "$OLD_DISPLAY"
|
||||
ask new_vendor "vendor (org) " "$OLD_VENDOR"
|
||||
ask new_author "cargo author " "$OLD_AUTHOR"
|
||||
ask new_email "email " "$OLD_EMAIL"
|
||||
ask new_homepage "homepage " "$OLD_HOMEPAGE"
|
||||
ask new_description "cargo description" "$OLD_DESCRIPTION"
|
||||
ask new_clap_description "clap description" "$OLD_CLAP_DESCRIPTION"
|
||||
printf '\n'
|
||||
fi
|
||||
[ -n "$new_display" ] || { printf 'nothing to do: pass --display "New Name" (or run interactively)\n' >&2; exit 2; }
|
||||
|
||||
# --- derivation -------------------------------------------------------------
|
||||
# Package name: lowercase, every run of non-alphanumerics becomes one separator,
|
||||
# ends trimmed. Cargo accepts both hyphens and underscores in a package name and
|
||||
# converts to underscores for the built artifact, which nih_plug_xtask already
|
||||
# accounts for; underscores are used here to match the Rust convention.
|
||||
derive_pkg() {
|
||||
printf '%s' "$1" | tr '[:upper:]' '[:lower:]' \
|
||||
| sed -e 's/[^a-z0-9]\{1,\}/_/g' -e 's/^_//' -e 's/_$//'
|
||||
}
|
||||
# Rust type name: CamelCase, non-alphanumerics dropped entirely.
|
||||
derive_struct() {
|
||||
printf '%s' "$1" | sed -e 's/[^A-Za-z0-9]\{1,\}/ /g' \
|
||||
| awk '{for(i=1;i<=NF;i++) printf "%s%s", toupper(substr($i,1,1)), substr($i,2); print ""}'
|
||||
}
|
||||
[ -n "$new_pkg" ] || new_pkg=$(derive_pkg "$new_display")
|
||||
[ -n "$new_struct" ] || new_struct=$(derive_struct "$new_display")
|
||||
new_params_struct="${new_struct}Params"
|
||||
[ -n "$new_vendor" ] || new_vendor="$OLD_VENDOR"
|
||||
[ -n "$new_author" ] || new_author="$OLD_AUTHOR"
|
||||
[ -n "$new_email" ] || new_email="$OLD_EMAIL"
|
||||
[ -n "$new_homepage" ] || new_homepage="$OLD_HOMEPAGE"
|
||||
[ -n "$new_description" ] || new_description="$OLD_DESCRIPTION"
|
||||
[ -n "$new_clap_description" ] || new_clap_description="$OLD_CLAP_DESCRIPTION"
|
||||
|
||||
# --- validation -------------------------------------------------------------
|
||||
fail=0
|
||||
die() { printf ' INVALID %s\n' "$1"; fail=$((fail+1)); }
|
||||
|
||||
case "$new_pkg" in
|
||||
"") die "derived package name is empty" ;;
|
||||
[0-9]*) die "package name \"$new_pkg\" starts with a digit - cargo rejects this outright" ;;
|
||||
esac
|
||||
case "$new_pkg" in
|
||||
test|core|std|alloc|proc_macro)
|
||||
die "package name \"$new_pkg\" collides with a built-in crate" ;;
|
||||
as|break|const|continue|crate|dyn|else|enum|extern|false|fn|for|if|impl|in|let|loop|match|mod|move|mut|pub|ref|return|self|static|struct|super|trait|true|type|unsafe|use|where|while|async|await|box|do|final|macro|override|priv|typeof|unsized|virtual|yield|try)
|
||||
die "package name \"$new_pkg\" is a Rust keyword - cargo rejects this" ;;
|
||||
esac
|
||||
# bundler.toml uses the package name as a TOML bare key.
|
||||
case "$new_pkg" in *[!a-zA-Z0-9_-]*) die "package name \"$new_pkg\" is not a valid TOML bare key" ;; esac
|
||||
case "$new_struct" in ""|[0-9]*) die "derived type name \"$new_struct\" is not a valid Rust identifier" ;; esac
|
||||
|
||||
# --- frozen identity --------------------------------------------------------
|
||||
identity_note=""
|
||||
if [ -n "$new_clap_id" ] || [ -n "$new_vst3" ]; then
|
||||
if [ "$allow_identity" -eq 0 ]; then
|
||||
die "CLAP_ID / VST3_CLASS_ID are frozen identity; pass --allow-identity-change to move them"
|
||||
fi
|
||||
fi
|
||||
[ -n "$new_clap_id" ] || new_clap_id="$OLD_CLAP_ID"
|
||||
[ -n "$new_vst3" ] || new_vst3="$OLD_VST3"
|
||||
|
||||
# VST3_CLASS_ID is a fixed 16-byte array, so it cannot simply be derived. Propose
|
||||
# one from the new name and let a human decide - it is frozen the moment it ships.
|
||||
proposed_vst3=$(printf '%s' "${new_struct}Plugin000000000000" | cut -c1-16)
|
||||
n=$(printf '%s' "$new_vst3" | wc -c | tr -d ' ')
|
||||
[ "$n" -eq 16 ] || die "VST3_CLASS_ID \"$new_vst3\" is $n bytes, must be exactly 16"
|
||||
|
||||
case "$new_clap_id" in
|
||||
*\ *|*[A-Z]*) die "CLAP_ID \"$new_clap_id\" must be lowercase with no spaces" ;;
|
||||
*.*) ;;
|
||||
*) die "CLAP_ID \"$new_clap_id\" should be dotted reverse-DNS" ;;
|
||||
esac
|
||||
|
||||
# CLAP_DESCRIPTION is user-facing: keep development history out of it.
|
||||
for hist in "$CODENAME" "$OLD_DISPLAY" "$OLD_PKG"; do
|
||||
case "$new_clap_description" in
|
||||
*"$hist"*) die "CLAP_DESCRIPTION still mentions \"$hist\" - it is shown to users, who never knew the development name" ;;
|
||||
esac
|
||||
done
|
||||
|
||||
# --- plan -------------------------------------------------------------------
|
||||
printf 'rename plan\n\n'
|
||||
row() { [ "$2" = "$3" ] && printf ' %-18s %s (unchanged)\n' "$1" "$2" || printf ' %-18s %s -> %s\n' "$1" "$2" "$3"; }
|
||||
row "package" "$OLD_PKG" "$new_pkg"
|
||||
row "display" "$OLD_DISPLAY" "$new_display"
|
||||
row "Plugin::NAME" "$OLD_PLUGIN_NAME" "$new_display"
|
||||
row "vendor" "$OLD_VENDOR" "$new_vendor"
|
||||
row "cargo author" "$OLD_AUTHOR" "$new_author"
|
||||
row "email" "$OLD_EMAIL" "$new_email"
|
||||
row "homepage" "$OLD_HOMEPAGE" "$new_homepage"
|
||||
row "description" "$OLD_DESCRIPTION" "$new_description"
|
||||
row "clap desc" "$OLD_CLAP_DESCRIPTION" "$new_clap_description"
|
||||
row "struct" "$OLD_STRUCT" "$new_struct"
|
||||
row "params struct" "$OLD_PARAMS_STRUCT" "$new_params_struct"
|
||||
row "CLAP_ID" "$OLD_CLAP_ID" "$new_clap_id"
|
||||
row "VST3_CLASS_ID" "$OLD_VST3" "$new_vst3"
|
||||
printf '\n repo codename stays %s - fixed at creation, never renamed\n' "$CODENAME"
|
||||
if [ "$new_vst3" = "$OLD_VST3" ]; then
|
||||
printf ' suggested VST3_CLASS_ID for this name (16 bytes): "%s"\n' "$proposed_vst3"
|
||||
printf ' apply with --vst3-class-id "%s" --allow-identity-change, and only before first release\n' "$proposed_vst3"
|
||||
fi
|
||||
|
||||
if [ "$fail" -ne 0 ]; then
|
||||
printf '\n%d problem(s); nothing written.\n' "$fail"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ "$apply" -eq 0 ]; then
|
||||
printf '\nDry run. Re-run with --apply to write these changes.\n'
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# --- apply ------------------------------------------------------------------
|
||||
# Three scratch files, one trap: the regenerated site table, the rows carried
|
||||
# through from the old one, and the value-substitution pairs.
|
||||
gen="$(mktemp)"; keep="$(mktemp)"; subst_file="$(mktemp)"
|
||||
trap 'rm -f "$gen" "$keep" "$subst_file"' EXIT
|
||||
|
||||
T="$(printf '\t')"
|
||||
{
|
||||
printf 'req%spkg.cargo%sCargo.toml%sname = "%s"\n' "$T" "$T" "$T" "$new_pkg"
|
||||
printf 'req%spkg.bundler%sbundler.toml%s[%s]\n' "$T" "$T" "$T" "$new_pkg"
|
||||
printf 'opt%spkg.lock%sCargo.lock%sname = "%s"\n' "$T" "$T" "$T" "$new_pkg"
|
||||
printf 'opt%spkg.ci%s.github/workflows/ci.yaml%scargo xtask bundle %s\n' "$T" "$T" "$T" "$new_pkg"
|
||||
printf 'opt%spkg.readme%sREADME.md%scargo xtask bundle %s\n' "$T" "$T" "$T" "$new_pkg"
|
||||
printf 'req%sdisplay.bundler%sbundler.toml%sname = "%s"\n' "$T" "$T" "$T" "$new_display"
|
||||
printf 'opt%sdisplay.notice%sNOTICE%s%s\n' "$T" "$T" "$T" "$new_display"
|
||||
printf 'req%sname.plugin%s%s%sconst NAME: &'"'"'static str = "%s"\n' "$T" "$T" "$LIB_FILE" "$T" "$new_display"
|
||||
printf 'req%svendor.plugin%s%s%sconst VENDOR: &'"'"'static str = "%s"\n' "$T" "$T" "$LIB_FILE" "$T" "$new_vendor"
|
||||
printf 'req%semail.plugin%s%s%sconst EMAIL: &'"'"'static str = "%s"\n' "$T" "$T" "$LIB_FILE" "$T" "$new_email"
|
||||
printf 'req%sauthors.cargo%sCargo.toml%sauthors = ["%s <%s>"]\n' "$T" "$T" "$T" "$new_author" "$new_email"
|
||||
printf 'req%shomepage.cargo%sCargo.toml%shomepage = "%s"\n' "$T" "$T" "$T" "$new_homepage"
|
||||
printf 'req%surl.plugin%s%s%sconst URL: &'"'"'static str = env!("CARGO_PKG_HOMEPAGE")\n' "$T" "$T" "$LIB_FILE" "$T"
|
||||
printf 'req%sdescription.cargo%sCargo.toml%sdescription = "%s"\n' "$T" "$T" "$T" "$new_description"
|
||||
# Narrowest distinctive fragment, not the whole statement: rustfmt wraps a long
|
||||
# CLAP_DESCRIPTION onto its own line, and a pattern spanning the assignment
|
||||
# would then never match a correctly formatted file.
|
||||
printf 'req%sdescription.clap%s%s%sSome("%s")\n' "$T" "$T" "$LIB_FILE" "$T" "$new_clap_description"
|
||||
printf 'req%sclapid.plugin%s%s%sconst CLAP_ID: &'"'"'static str = "%s"\n' "$T" "$T" "$LIB_FILE" "$T" "$new_clap_id"
|
||||
printf 'req%svst3id.plugin%s%s%sconst VST3_CLASS_ID: [u8; 16] = *b"%s"\n' "$T" "$T" "$LIB_FILE" "$T" "$new_vst3"
|
||||
printf 'req%sstruct.def%s%s%sstruct %s {\n' "$T" "$T" "$LIB_FILE" "$T" "$new_struct"
|
||||
printf 'req%sstruct.plugin%s%s%simpl Plugin for %s {\n' "$T" "$T" "$LIB_FILE" "$T" "$new_struct"
|
||||
printf 'req%sstruct.clap%s%s%simpl ClapPlugin for %s {\n' "$T" "$T" "$LIB_FILE" "$T" "$new_struct"
|
||||
printf 'req%sstruct.vst3%s%s%simpl Vst3Plugin for %s {\n' "$T" "$T" "$LIB_FILE" "$T" "$new_struct"
|
||||
printf 'req%sstruct.exportclap%s%s%snih_export_clap!(%s);\n' "$T" "$T" "$LIB_FILE" "$T" "$new_struct"
|
||||
printf 'req%sstruct.exportvst3%s%s%snih_export_vst3!(%s);\n' "$T" "$T" "$LIB_FILE" "$T" "$new_struct"
|
||||
printf 'req%sparams.def%s%s%sstruct %s {\n' "$T" "$T" "$PARAMS_FILE" "$T" "$new_params_struct"
|
||||
printf 'req%sparams.default%s%s%simpl Default for %s {\n' "$T" "$T" "$PARAMS_FILE" "$T" "$new_params_struct"
|
||||
printf 'req%sparams.field%s%s%sparams: Arc<%s>,\n' "$T" "$T" "$LIB_FILE" "$T" "$new_params_struct"
|
||||
printf 'opt%sdeploy.pkg%sdeploy.ps1%s$Package = "%s"\n' "$T" "$T" "$T" "$new_pkg"
|
||||
printf 'opt%sdeploy.vst3%sdeploy.ps1%s$vst3Name = "%s.vst3"\n' "$T" "$T" "$T" "$new_display"
|
||||
printf 'opt%sdeploy.clap%sdeploy.ps1%s$clapName = "%s.clap"\n' "$T" "$T" "$T" "$new_display"
|
||||
} > "$gen"
|
||||
|
||||
# Pass 1 - site-directed. Each owned row in the existing table carries the OLD
|
||||
# resolved literal for its site; the regenerated row carries the new one. Rewriting
|
||||
# by that pair is unambiguous, which plain value substitution is not: AUTHOR
|
||||
# defaults to VENDOR, so both fields can hold the same old string and a global
|
||||
# replace cannot tell which occurrence belongs to which. This must run BEFORE
|
||||
# pass 2, or the global replace consumes the old literals first and leaves the
|
||||
# precise rewrite with nothing to match.
|
||||
sites="tools/branding-sites.tsv"
|
||||
T="$(printf '\t')"
|
||||
if [ -f "$sites" ]; then
|
||||
while IFS="$T" read -r ok_ oo_ of_ op_; do
|
||||
case "$ok_" in ''|\#*) continue ;; esac
|
||||
np_=$(awk -F"$T" -v o="$oo_" '$2==o {print $4; exit}' "$gen")
|
||||
[ -n "$np_" ] || continue
|
||||
[ "$np_" != "$op_" ] || continue
|
||||
[ -f "$of_" ] || continue
|
||||
esc_o=$(printf '%s' "$op_" | sed 's/[][\.*^$/|&]/\\&/g')
|
||||
esc_n=$(printf '%s' "$np_" | sed 's/[\\/&|]/\\&/g')
|
||||
tmp_=$(mktemp)
|
||||
sed "s|$esc_o|$esc_n|g" "$of_" > "$tmp_" && cat "$tmp_" > "$of_"
|
||||
rm -f "$tmp_"
|
||||
done < "$sites"
|
||||
printf ' pass 1: rewrote known sites from the table\n'
|
||||
fi
|
||||
|
||||
# Pass 2 - value substitution, for everything the table does not enumerate:
|
||||
# doc comments, use sites in other modules, prose in the README.
|
||||
# Longest values first: a shorter spelling can be a substring of a longer one
|
||||
# (the package name inside a URL, say), and replacing it first would corrupt the
|
||||
# longer match. branding.conf is excluded and rewritten wholesale below, so its
|
||||
# STALE list is never rewritten into meaninglessness.
|
||||
{
|
||||
printf '%s\t%s\n' "$OLD_CLAP_ID" "$new_clap_id"
|
||||
printf '%s\t%s\n' "$OLD_HOMEPAGE" "$new_homepage"
|
||||
printf '%s\t%s\n' "$OLD_CLAP_DESCRIPTION" "$new_clap_description"
|
||||
printf '%s\t%s\n' "$OLD_DESCRIPTION" "$new_description"
|
||||
printf '%s\t%s\n' "$OLD_PARAMS_STRUCT" "$new_params_struct"
|
||||
printf '%s\t%s\n' "$OLD_VST3" "$new_vst3"
|
||||
printf '%s\t%s\n' "$OLD_PLUGIN_NAME" "$new_display"
|
||||
printf '%s\t%s\n' "$OLD_DISPLAY" "$new_display"
|
||||
printf '%s\t%s\n' "$OLD_STRUCT" "$new_struct"
|
||||
printf '%s\t%s\n' "$OLD_EMAIL" "$new_email"
|
||||
printf '%s\t%s\n' "$OLD_AUTHOR" "$new_author"
|
||||
printf '%s\t%s\n' "$OLD_VENDOR" "$new_vendor"
|
||||
printf '%s\t%s\n' "$OLD_PKG" "$new_pkg"
|
||||
} | awk -F'\t' '$1 != $2 { print length($1)"\t"$0 }' | sort -rn | cut -f2- > "$subst_file"
|
||||
|
||||
changed=0
|
||||
git ls-files 2>/dev/null | while IFS= read -r f; do
|
||||
[ -f "$f" ] || continue
|
||||
# branding.conf alone is excluded: it is rewritten wholesale below, and its
|
||||
# STALE list names every retired spelling by design. The site table IS
|
||||
# substituted, so hand-added custom rows track the rename; owned rows are
|
||||
# regenerated afterwards regardless.
|
||||
case "$f" in tools/branding.conf) continue ;; esac
|
||||
before=$(cat "$f")
|
||||
after="$before"
|
||||
while IFS="$(printf '\t')" read -r old new; do
|
||||
[ -n "$old" ] || continue
|
||||
after=$(printf '%s' "$after" | sed "s|$(printf '%s' "$old" | sed 's/[][\.*^$/|&]/\\&/g')|$(printf '%s' "$new" | sed 's/[\\/&|]/\\&/g')|g")
|
||||
done < "$subst_file"
|
||||
if [ "$before" != "$after" ]; then printf '%s\n' "$after" > "$f"; printf ' rewrote %s\n' "$f"; fi
|
||||
done
|
||||
|
||||
# branding.conf last, with the retired spellings appended to STALE so the next
|
||||
# run of the checker sweeps for anything this pass missed.
|
||||
# Deduplicated: two fields can retire to the same spelling - DISPLAY and
|
||||
# PLUGIN_NAME are commonly identical - and listing it twice makes the checker
|
||||
# report the same drift twice. Note that neither this script nor the checker
|
||||
# contains a branding literal anywhere: both read every name from
|
||||
# branding.conf, so a rename never has to rewrite its own tooling.
|
||||
retired=$(cut -f1 "$subst_file" | awk '!seen[$0]++')
|
||||
sed -e "s|^PKG=.*|PKG=\"$new_pkg\"|" \
|
||||
-e "s|^DISPLAY=.*|DISPLAY=\"$new_display\"|" \
|
||||
-e "s|^PLUGIN_NAME=.*|PLUGIN_NAME=\"$new_display\"|" \
|
||||
-e "s|^VENDOR=.*|VENDOR=\"$new_vendor\"|" \
|
||||
-e "s|^# *AUTHOR=.*|AUTHOR=\"$new_author\"|" \
|
||||
-e "s|^AUTHOR=.*|AUTHOR=\"$new_author\"|" \
|
||||
-e "s|^EMAIL=.*|EMAIL=\"$new_email\"|" \
|
||||
-e "s|^HOMEPAGE=.*|HOMEPAGE=\"$new_homepage\"|" \
|
||||
-e "s|^DESCRIPTION=.*|DESCRIPTION=\"$new_description\"|" \
|
||||
-e "s|^CLAP_DESCRIPTION=.*|CLAP_DESCRIPTION=\"$new_clap_description\"|" \
|
||||
-e "s|^CLAP_ID=.*|CLAP_ID=\"$new_clap_id\"|" \
|
||||
-e "s|^VST3_CLASS_ID=.*|VST3_CLASS_ID=\"$new_vst3\"|" \
|
||||
-e "s|^STRUCT=.*|STRUCT=\"$new_struct\"|" \
|
||||
-e "s|^PARAMS_STRUCT=.*|PARAMS_STRUCT=\"$new_params_struct\"|" \
|
||||
tools/branding.conf > tools/branding.conf.new
|
||||
if [ -n "$retired" ]; then
|
||||
{ sed '$ s/"$//' tools/branding.conf.new; printf '%s"\n' "$retired"; } > tools/branding.conf
|
||||
else
|
||||
# Nothing retired (a no-op rename, or a regeneration): leave STALE untouched
|
||||
# rather than appending a blank line to it on every run.
|
||||
cat tools/branding.conf.new > tools/branding.conf
|
||||
fi
|
||||
rm -f tools/branding.conf.new
|
||||
if [ "$new_author" = "$new_vendor" ]; then
|
||||
# Identical to VENDOR, so re-comment it: the conf should keep showing that this
|
||||
# value derives rather than pinning a duplicate that then has to be maintained.
|
||||
tmp_c=$(mktemp)
|
||||
sed "s|^AUTHOR=.*|# AUTHOR=\"$new_author\"|" tools/branding.conf > "$tmp_c" && cat "$tmp_c" > tools/branding.conf
|
||||
rm -f "$tmp_c"
|
||||
fi
|
||||
printf ' rewrote tools/branding.conf (retired spellings appended to STALE)\n'
|
||||
|
||||
# Regenerate the site table. Rows whose owner this script recognises are
|
||||
# rewritten with the new resolved literals; every other row - anything marked
|
||||
# custom, or added by hand for a file this template does not ship - is carried
|
||||
# through untouched. Clobbering those silently is how a tool stops being trusted.
|
||||
sites="tools/branding-sites.tsv"
|
||||
|
||||
owned=$(cut -f2 "$gen")
|
||||
if [ -f "$sites" ]; then
|
||||
grep '^#' "$sites" > "$keep" 2>/dev/null || : > "$keep"
|
||||
while IFS="$T" read -r k o f pat; do
|
||||
case "$k" in ''|\#*) continue ;; esac
|
||||
printf '%s\n' "$owned" | grep -qxF "$o" || printf '%s%s%s%s%s%s%s\n' "$k" "$T" "$o" "$T" "$f" "$T" "$pat" >> "$keep"
|
||||
done < "$sites"
|
||||
else
|
||||
: > "$keep"
|
||||
fi
|
||||
{ cat "$keep"; cat "$gen"; } > "$sites"
|
||||
printf ' rewrote %s (%s owned rows, %s preserved)\n' "$sites" "$(wc -l < "$gen" | tr -d ' ')" "$(grep -cv '^#' "$keep" 2>/dev/null || echo 0)"
|
||||
|
||||
printf '\nverifying with check-branding.sh\n\n'
|
||||
sh tools/check-branding.sh
|
||||
@@ -0,0 +1,45 @@
|
||||
# branding-sites.tsv - every place a canonical name has to appear, and in what form.
|
||||
#
|
||||
# Generated and refreshed by tools/brand-plugin.sh; read by tools/check-branding.sh,
|
||||
# which asserts each pattern is present in its file. Tab-separated, four columns:
|
||||
#
|
||||
# kind req = a missing file is a failure; opt = a missing file is a skip
|
||||
# owner the brand-plugin.sh rule that manages this row, or "custom" for rows
|
||||
# you added by hand. Custom rows are preserved across regeneration;
|
||||
# owned rows are overwritten, so do not hand-edit those.
|
||||
# file repo-relative path
|
||||
# pattern literal text that must appear in that file, already resolved
|
||||
#
|
||||
# Adding a site for something the template does not ship is a one-line edit here
|
||||
# with owner "custom" - no shell to change, and it survives the next rename.
|
||||
#
|
||||
#kind owner file pattern
|
||||
req pkg.cargo Cargo.toml name = "kolmekivi"
|
||||
req pkg.bundler bundler.toml [kolmekivi]
|
||||
opt pkg.lock Cargo.lock name = "kolmekivi"
|
||||
opt pkg.ci .github/workflows/ci.yaml cargo xtask bundle kolmekivi
|
||||
opt pkg.readme README.md cargo xtask bundle kolmekivi
|
||||
req display.bundler bundler.toml name = "Kolmekivi"
|
||||
opt display.notice NOTICE Kolmekivi
|
||||
req name.plugin src/lib.rs const NAME: &'static str = "Kolmekivi"
|
||||
req vendor.plugin src/lib.rs const VENDOR: &'static str = "Novoyuuparosk"
|
||||
req email.plugin src/lib.rs const EMAIL: &'static str = "mikkeli@novoyuuparosk.org"
|
||||
req authors.cargo Cargo.toml authors = ["Mikkeli Matlock <mikkeli@novoyuuparosk.org>"]
|
||||
req homepage.cargo Cargo.toml homepage = "http://192.168.2.199:3005/musiikki/kolmekivi"
|
||||
req url.plugin src/lib.rs const URL: &'static str = env!("CARGO_PKG_HOMEPAGE")
|
||||
req description.cargo Cargo.toml description = "A stereo delay/echo plugin built with NIH-plug"
|
||||
req description.clap src/lib.rs Some("Stereo delay with feedback and mix control")
|
||||
req clapid.plugin src/lib.rs const CLAP_ID: &'static str = "org.novoyuuparosk.kolmekivi"
|
||||
req vst3id.plugin src/lib.rs const VST3_CLASS_ID: [u8; 16] = *b"KolmekiviDelay!!"
|
||||
req struct.def src/lib.rs struct Kolmekivi {
|
||||
req struct.plugin src/lib.rs impl Plugin for Kolmekivi {
|
||||
req struct.clap src/lib.rs impl ClapPlugin for Kolmekivi {
|
||||
req struct.vst3 src/lib.rs impl Vst3Plugin for Kolmekivi {
|
||||
req struct.exportclap src/lib.rs nih_export_clap!(Kolmekivi);
|
||||
req struct.exportvst3 src/lib.rs nih_export_vst3!(Kolmekivi);
|
||||
req params.def src/lib.rs struct KolmekiviParams {
|
||||
req params.default src/lib.rs impl Default for KolmekiviParams {
|
||||
req params.field src/lib.rs params: Arc<KolmekiviParams>,
|
||||
opt deploy.pkg deploy.ps1 $Package = "kolmekivi"
|
||||
opt deploy.vst3 deploy.ps1 $vst3Name = "Kolmekivi.vst3"
|
||||
opt deploy.clap deploy.ps1 $clapName = "Kolmekivi.clap"
|
||||
|
Can't render this file because it contains an unexpected character in line 7 and column 64.
|
@@ -0,0 +1,103 @@
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
# branding.conf - this plugin's canonical identity.
|
||||
#
|
||||
# Managed by tools/brand-plugin.sh, read by tools/check-branding.sh. Hand-editing
|
||||
# works and is sometimes the quickest thing, but the helper is what keeps this
|
||||
# file, the source tree and tools/branding-sites.tsv agreeing with each other.
|
||||
# Edit here and you are on the hook for running the checker afterwards.
|
||||
|
||||
# --- derivations ------------------------------------------------------------
|
||||
# Defined before the values so the defaults below can use them.
|
||||
# Package name: lowercased, every run of non-alphanumerics becomes one
|
||||
# underscore. Cargo accepts hyphens too and maps them to underscores for the
|
||||
# built artifact, which nih_plug_xtask already handles; underscores are used to
|
||||
# match the Rust convention.
|
||||
_derive_pkg() {
|
||||
printf '%s' "$1" | tr '[:upper:]' '[:lower:]' \
|
||||
| sed -e 's/[^a-z0-9]\{1,\}/_/g' -e 's/^_//' -e 's/_$//'
|
||||
}
|
||||
# Rust type name: CamelCase, non-alphanumerics dropped.
|
||||
_derive_struct() {
|
||||
printf '%s' "$1" | sed -e 's/[^A-Za-z0-9]\{1,\}/ /g' \
|
||||
| awk '{for(i=1;i<=NF;i++) printf "%s%s", toupper(substr($i,1,1)), substr($i,2); print ""}'
|
||||
}
|
||||
|
||||
# --- the names ---------------------------------------------------------------
|
||||
PLUGIN_NAME="Kolmekivi"
|
||||
VENDOR="Novoyuuparosk"
|
||||
EMAIL="mikkeli@novoyuuparosk.org"
|
||||
# Cargo's authors entry names whoever wrote it, which is not always the vendor:
|
||||
# an org ships the plugin, a person authored it. Defaults to VENDOR when the two
|
||||
# are the same, which is the common case for a one-person project.
|
||||
AUTHOR="Mikkeli Matlock"
|
||||
HOMEPAGE="http://192.168.2.199:3005/musiikki/kolmekivi"
|
||||
DESCRIPTION="A stereo delay/echo plugin built with NIH-plug"
|
||||
|
||||
# What the plugin does *now*. No codename, no "prototype", no "v2 rewrite" -
|
||||
# hosts show this to users who never knew any of that. check-branding.sh
|
||||
# enforces the mechanical half by rejecting retired names and the repo codename.
|
||||
CLAP_DESCRIPTION="Stereo delay with feedback and mix control"
|
||||
|
||||
# --- frozen identity ---------------------------------------------------------
|
||||
# Hosts key saved projects and presets off these two. Change either and every
|
||||
# existing session silently loses the plugin: the track comes up empty, with no
|
||||
# error. Choose once before the first release, then never again.
|
||||
# brand-plugin.sh refuses to move them without --allow-identity-change.
|
||||
CLAP_ID="org.novoyuuparosk.kolmekivi"
|
||||
VST3_CLASS_ID="KolmekiviDelay!!"
|
||||
|
||||
# --- fixed at repo creation --------------------------------------------------
|
||||
# The repository's own name. Deliberately NOT renamed when the plugin is: the
|
||||
# repo keeps its development codename while the plugin gets a product name.
|
||||
# Recorded only so it can be kept out of user-facing text.
|
||||
CODENAME="kolmekivi"
|
||||
|
||||
# Where the two Rust types are defined. A plugin whose params outgrow lib.rs
|
||||
# points PARAMS_FILE at src/params.rs.
|
||||
LIB_FILE="src/lib.rs"
|
||||
PARAMS_FILE="src/lib.rs"
|
||||
|
||||
# --- derived unless overridden -----------------------------------------------
|
||||
# Set one only when the derivation is wrong or rejected - a name like
|
||||
# "206 Prototype" derives to "206_prototype", which cargo refuses because a
|
||||
# package name cannot start with a digit.
|
||||
#
|
||||
# This template overrides three of them, which a real plugin usually will not:
|
||||
# its package and type names are the template's own rather than derived from a
|
||||
# product name. Delete these three lines after renaming and the derivations
|
||||
# from PLUGIN_NAME take over.
|
||||
# DISPLAY="Plugin Name" # defaults to PLUGIN_NAME
|
||||
: "${AUTHOR:=$VENDOR}"
|
||||
: "${DISPLAY:=$PLUGIN_NAME}"
|
||||
: "${PKG:=$(_derive_pkg "$PLUGIN_NAME")}"
|
||||
: "${STRUCT:=$(_derive_struct "$PLUGIN_NAME")}"
|
||||
: "${PARAMS_STRUCT:=${STRUCT}Params}"
|
||||
|
||||
# --- retired spellings -------------------------------------------------------
|
||||
# Must no longer appear in tracked files. An entry is skipped while it is still
|
||||
# part of a canonical value above and arms the moment it stops being one, so a
|
||||
# rename is self-checking in both directions. brand-plugin.sh appends here.
|
||||
STALE="nih_plug_template
|
||||
MyPlugin
|
||||
PluginParams
|
||||
A minimal NIH-plug audio plugin
|
||||
Your plugin description
|
||||
Plugin Name
|
||||
Your Name
|
||||
your@email.com
|
||||
com.your-domain.plugin-name
|
||||
Unique16CharId!!
|
||||
YOUR-USERNAME
|
||||
YOUR-PLUGIN-NAME
|
||||
your-domain
|
||||
https://github.com/YOUR-USERNAME/YOUR-PLUGIN-NAME
|
||||
A minimal NIH-plug audio plugin
|
||||
com.your-domain.plugin-name
|
||||
Your plugin description
|
||||
nih_plug_template
|
||||
Unique16CharId!!
|
||||
your@email.com
|
||||
PluginParams
|
||||
Plugin Name
|
||||
Your Name
|
||||
MyPlugin"
|
||||
Executable
+188
@@ -0,0 +1,188 @@
|
||||
#!/bin/sh
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
# check-branding.sh - verify the plugin's branding/identity strings agree everywhere.
|
||||
#
|
||||
# Plugin branding is duplicated across the build manifest, the bundler manifest,
|
||||
# the source, the docs and (once you add one) the deploy script. Nothing makes
|
||||
# them agree, so a rename drifts silently: the bundle builds under one name and
|
||||
# the deploy script looks for another. This asserts they match, and that the
|
||||
# identity constants are legal.
|
||||
#
|
||||
# In a template this matters more than usual: renaming is the first thing you do
|
||||
# with this repo, and it touches every file below. Run this immediately after,
|
||||
# and the STALE machinery will list whatever you missed.
|
||||
#
|
||||
# Usage: sh tools/check-branding.sh (exit 0 = consistent, 1 = drift found)
|
||||
#
|
||||
# The canonical identity lives in branding.conf, shared with brand-plugin.sh.
|
||||
# Edit it there, then run this to find every copy that still holds the old value.
|
||||
|
||||
set -u
|
||||
# Resolve the repo root: these live in tools/, every path they touch is
|
||||
# repo-relative, and they must behave the same wherever they are invoked from.
|
||||
cd "$(dirname "$0")/.." || exit 1
|
||||
|
||||
if [ ! -f tools/branding.conf ]; then
|
||||
printf 'tools/branding.conf not found\n' >&2
|
||||
exit 1
|
||||
fi
|
||||
# shellcheck disable=SC1091
|
||||
. ./tools/branding.conf
|
||||
|
||||
# Every canonical spelling concatenated, for the substring test below.
|
||||
CANONICAL_BLOB="$PKG
|
||||
$DESCRIPTION
|
||||
$CLAP_DESCRIPTION
|
||||
$STRUCT
|
||||
$PARAMS_STRUCT
|
||||
$DISPLAY
|
||||
$PLUGIN_NAME
|
||||
$VENDOR
|
||||
$EMAIL
|
||||
$HOMEPAGE
|
||||
$CLAP_ID
|
||||
$VST3_CLASS_ID"
|
||||
|
||||
pass=0; fail=0; skip=0
|
||||
ok() { pass=$((pass+1)); printf ' ok %s\n' "$1"; }
|
||||
bad() { fail=$((fail+1)); printf ' FAIL %s\n' "$1"; [ $# -gt 1 ] && printf ' %s\n' "$2"; return 0; }
|
||||
note() { skip=$((skip+1)); printf ' skip %s\n' "$1"; }
|
||||
# Reported for awareness only - never counted, never fails the run.
|
||||
info() { printf ' -- %s\n' "$1"; }
|
||||
|
||||
# has FILE PATTERN -> fixed-string search
|
||||
has() { grep -qF "$2" "$1" 2>/dev/null; }
|
||||
|
||||
check() { # check LABEL FILE LITERAL
|
||||
if [ ! -f "$2" ]; then bad "$1" "missing file: $2"; return; fi
|
||||
if has "$2" "$3"; then ok "$1"; else bad "$1" "$2 does not contain: $3"; fi
|
||||
}
|
||||
|
||||
# Same as check, but a missing file is "not applicable yet" rather than drift.
|
||||
# The template ships without a deploy script; this starts checking once you add one.
|
||||
opt_check() { # opt_check LABEL FILE LITERAL
|
||||
if [ ! -f "$2" ]; then note "$1 ($2 not present)"; return; fi
|
||||
if has "$2" "$3"; then ok "$1"; else bad "$1" "$2 does not contain: $3"; fi
|
||||
}
|
||||
|
||||
printf 'branding check (canonical: %s / "%s")\n\n' "$PKG" "$DISPLAY"
|
||||
|
||||
# --- consistency: every site in the table holds its resolved literal ----------
|
||||
# The table is data, so adding a site is a row rather than a shell edit, and the
|
||||
# same script runs unmodified across every plugin built from this template.
|
||||
SITES="tools/branding-sites.tsv"
|
||||
if [ ! -f "$SITES" ]; then
|
||||
bad "site table" "$SITES not found - run tools/brand-plugin.sh to generate it"
|
||||
else
|
||||
printf 'sites\n'
|
||||
while IFS="$(printf '\t')" read -r kind owner file pattern; do
|
||||
case "$kind" in ''|\#*) continue ;; esac
|
||||
[ -n "$pattern" ] || continue
|
||||
label="$owner"
|
||||
if [ ! -f "$file" ]; then
|
||||
case "$kind" in
|
||||
opt) note "$label ($file not present)" ;;
|
||||
*) bad "$label" "missing file: $file" ;;
|
||||
esac
|
||||
continue
|
||||
fi
|
||||
if has "$file" "$pattern"; then ok "$label"
|
||||
else bad "$label" "$file does not contain: $pattern"; fi
|
||||
done < "$SITES"
|
||||
fi
|
||||
|
||||
# --- validity: rules the table cannot express --------------------------------
|
||||
printf '\nvalidity\n'
|
||||
|
||||
# VST3 class IDs are a fixed 16-byte array. A wrong length is a compile error,
|
||||
# but saying so here is clearer than reading rustc on it.
|
||||
n=$(printf '%s' "$VST3_CLASS_ID" | wc -c | tr -d ' ')
|
||||
if [ "$n" -eq 16 ]; then ok "VST3_CLASS_ID is 16 bytes"
|
||||
else bad "VST3_CLASS_ID is 16 bytes" "got $n bytes: \"$VST3_CLASS_ID\""; fi
|
||||
|
||||
# CLAP IDs are reverse-DNS by convention and compared verbatim by hosts, so a
|
||||
# stray space or capital is a silent identity change between machines.
|
||||
case "$CLAP_ID" in
|
||||
*\ *|*[A-Z]*) bad "CLAP_ID is reverse-DNS safe" "no spaces or capitals allowed: \"$CLAP_ID\"" ;;
|
||||
*.*) ok "CLAP_ID is reverse-DNS safe" ;;
|
||||
*) bad "CLAP_ID is reverse-DNS safe" "expected dotted reverse-DNS, got: \"$CLAP_ID\"" ;;
|
||||
esac
|
||||
|
||||
# An overridden package name is legitimate - the derivation is sometimes invalid
|
||||
# - but a display rename that forgot the package is not, and looks identical
|
||||
# from here. Reported, never failed.
|
||||
derived_pkg=$(_derive_pkg "$PLUGIN_NAME")
|
||||
[ "$PKG" = "$derived_pkg" ] || info "PKG \"$PKG\" differs from the derivation of PLUGIN_NAME (\"$derived_pkg\") - fine if deliberate"
|
||||
|
||||
# CLAP_DESCRIPTION is shown to users in a host's plugin browser. "Free of
|
||||
# development history" is a judgement a script cannot make, but the failure it
|
||||
# produces is mechanical: a retired name or the repo codename surviving in it.
|
||||
hygiene_hits=""
|
||||
while IFS= read -r s_entry; do
|
||||
[ -n "$s_entry" ] || continue
|
||||
case "$CANONICAL_BLOB" in *"$s_entry"*) continue ;; esac
|
||||
case "$CLAP_DESCRIPTION" in *"$s_entry"*) hygiene_hits="$hygiene_hits \"$s_entry\"" ;; esac
|
||||
done <<HYGIENE_LIST
|
||||
$STALE
|
||||
$CODENAME
|
||||
HYGIENE_LIST
|
||||
if [ -z "$hygiene_hits" ]; then ok "CLAP_DESCRIPTION carries no retired name or codename"
|
||||
else bad "CLAP_DESCRIPTION carries no retired name or codename" "found:$hygiene_hits"; fi
|
||||
|
||||
printf '\nstale spellings\n'
|
||||
# File list for the scan below. Prefer git, so build output and any vendored
|
||||
# tree stay out of it. Fall back to find when this is not a checkout - an
|
||||
# exported tarball, or a CI step that fetched without git metadata - because
|
||||
# `git ls-files` there returns nothing, and an empty list would report every
|
||||
# stale spelling as absent. A check that passes hardest when it can see least
|
||||
# is worse than no check.
|
||||
if git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
|
||||
file_list() { git ls-files; }
|
||||
scan_source="git"
|
||||
else
|
||||
file_list() { find . -path ./.git -prune -o -path ./target -prune -o -type f -print | sed 's|^\./||'; }
|
||||
scan_source="find (not a git checkout)"
|
||||
fi
|
||||
info "scanning tracked files via $scan_source"
|
||||
# Fed by here-doc rather than a pipe on purpose: a piped `while` runs in a
|
||||
# subshell, and the pass/fail counters it increments would be discarded.
|
||||
while IFS= read -r s; do
|
||||
[ -n "$s" ] || continue
|
||||
|
||||
# Still part of a canonical value? Then it is current branding, not a leftover.
|
||||
# This is what lets the list ship pre-seeded: entries arm themselves as you
|
||||
# rename. Substring, not equality, because placeholders nest - "your-domain"
|
||||
# lives inside the canonical CLAP_ID, and "YOUR-USERNAME" inside the homepage.
|
||||
# Over-skipping is the safe direction: a false FAIL on a name you still use
|
||||
# would train you to ignore this section.
|
||||
case "$CANONICAL_BLOB" in
|
||||
*"$s"*) note "\"$s\" (still canonical)"; continue ;;
|
||||
esac
|
||||
|
||||
# These two name every retired spelling by definition - the STALE list lives in
|
||||
# branding.conf and this script reads it - so neither can ever be a real hit.
|
||||
hits=$(file_list 2>/dev/null | while read -r f; do
|
||||
case "$f" in tools/check-branding.sh|tools/branding.conf) continue ;; esac
|
||||
[ -f "$f" ] && grep -lF "$s" "$f" 2>/dev/null
|
||||
done)
|
||||
if [ -z "$hits" ]; then ok "no occurrences of \"$s\""
|
||||
else bad "no occurrences of \"$s\"" "still present in: $(echo "$hits" | tr '\n' ' ')"; fi
|
||||
done <<STALE_LIST
|
||||
$STALE
|
||||
STALE_LIST
|
||||
|
||||
# Template scaffolding, not drift: TODOs are legitimate while you are still
|
||||
# building. Reported so a finished plugin does not quietly ship with them.
|
||||
# `grep -c` prints 0 AND exits 1 when there are no matches, so `|| echo 0`
|
||||
# would append a second zero and make the count unparseable. Swallow the
|
||||
# status instead, and default an empty result (missing file) to zero.
|
||||
todos=$(grep -c 'TODO' src/lib.rs 2>/dev/null || :)
|
||||
[ -n "$todos" ] || todos=0
|
||||
printf '\nscaffolding\n'
|
||||
if [ "$todos" -eq 0 ]; then ok "no TODO markers left in src/lib.rs"
|
||||
else info "$todos TODO marker(s) still in src/lib.rs (not a failure)"; fi
|
||||
|
||||
printf '\n%d passed, %d failed' "$pass" "$fail"
|
||||
[ "$skip" -gt 0 ] && printf ', %d skipped' "$skip"
|
||||
printf '\n'
|
||||
[ "$fail" -eq 0 ] || exit 1
|
||||
@@ -0,0 +1,8 @@
|
||||
[package]
|
||||
name = "xtask"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
license = "GPL-3.0-or-later"
|
||||
|
||||
[dependencies]
|
||||
nih_plug_xtask = { git = "https://github.com/robbert-vdh/nih-plug.git", rev = "f36931f7af4646065488a9845d8f8c2f95252c23" }
|
||||
@@ -0,0 +1,5 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
fn main() -> nih_plug_xtask::Result<()> {
|
||||
nih_plug_xtask::main()
|
||||
}
|
||||
Reference in New Issue
Block a user