Skip to content

Commit d8d902c

Browse files
committed
Don't make controller a default feature
1 parent fb332bc commit d8d902c

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

.github/workflows/site.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,6 @@ jobs:
2828
steps:
2929
- name: Checkout
3030
uses: actions/checkout@v4
31-
- name: Setup Ruby
32-
uses: ruby/setup-ruby@v1
33-
with:
34-
ruby-version: 3.0
35-
bundler-cache: true
36-
cache-version: 0 # Increment this number to re-download cached gems.
3731
- name: Setup Pages
3832
id: pages
3933
uses: actions/configure-pages@v5

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,6 @@ crossbeam-channel = "0.5"
2424
ctor = "0.2"
2525

2626
[features]
27-
default = ["dynamic_loading", "log", "controller"]
27+
default = ["dynamic_loading", "log"]
2828
dynamic_loading = ["jack-sys/dynamic_loading"]
2929
controller = ["rtrb"]

docs/src/contrib/controller.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Controller
22

3+
**Note:** This module requires the `controller` feature, which is not enabled by default.
4+
Add `jack = { version = "...", features = ["controller"] }` to your `Cargo.toml`.
5+
36
The controller module provides utilities for building controllable JACK processors
47
with lock-free communication. This is useful when you need to send commands to or
58
receive notifications from your audio processor without blocking the real-time thread.

docs/src/features.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,11 @@ Default: Yes
3030
Load `libjack` at runtime as opposed to the standard dynamic linking. This is
3131
preferred as it allows `pw-jack` to intercept the loading at runtime to provide
3232
the Pipewire JACK server implementation.
33+
34+
## `controller`
35+
36+
Default: No
37+
38+
Enables the `jack::contrib::controller` module which provides utilities for
39+
building controllable JACK processors with lock-free communication. See the
40+
[Controller documentation](contrib/controller.md) for usage details.

src/contrib/controller.rs

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -145,12 +145,7 @@ impl<T: ControlledProcessorTrait> ProcessHandler for ControlledProcessorInstance
145145
self.inner.buffer_size(client, size, &mut self.channels)
146146
}
147147

148-
fn sync(
149-
&mut self,
150-
client: &Client,
151-
state: TransportState,
152-
pos: &TransportPosition,
153-
) -> bool {
148+
fn sync(&mut self, client: &Client, state: TransportState, pos: &TransportPosition) -> bool {
154149
self.inner.sync(client, state, pos, &mut self.channels)
155150
}
156151
}

0 commit comments

Comments
 (0)