Struct WaveShaperNode

pub struct WaveShaperNode { /* private fields */ }

WaveShaperNode allows to apply non-linear distortion effect on a audio signal. Arbitrary non-linear shaping curves may be specified.

• MDN documentation: https://developer.mozilla.org/en-US/docs/Web/API/WaveShaperNode
• specification: https://webaudio.github.io/web-audio-api/#WaveShaperNode
• see also: BaseAudioContext::create_wave_shaper

Usage

use std::fs::File;
use web_audio_api::context::{BaseAudioContext, AudioContext};
use web_audio_api::node::{AudioNode, AudioScheduledSourceNode};

let context = AudioContext::default();

let file = File::open("sample.wav").unwrap();
let buffer = context.decode_audio_data_sync(file).unwrap();
let curve = make_distortion_curve(2048);
let drive = 4.;

let post_gain = context.create_gain();
post_gain.connect(&context.destination());
post_gain.gain().set_value(1. / drive);

let mut shaper = context.create_wave_shaper();
shaper.connect(&post_gain);
shaper.set_curve(curve);

let pre_gain = context.create_gain();
pre_gain.connect(&shaper);
pre_gain.gain().set_value(drive);

let mut src = context.create_buffer_source();
src.connect(&pre_gain);
src.set_buffer(buffer);

src.start();

Example

• cargo run --release --example waveshaper

Implementations

impl WaveShaperNode

pub fn new<C: BaseAudioContext>(context: &C, options: WaveShaperOptions) -> Self

returns a WaveShaperNode instance

Arguments

• context - audio context in which the audio node will live.
• options - waveshaper options

pub fn curve(&self) -> Option<&[f32]>

Returns the distortion curve

pub fn set_curve(&mut self, curve: Vec<f32>)

Set the distortion curve of this node

Arguments

• curve - the desired distortion curve

Panics

Panics if a curve has already been given to the source (though new or through set_curve)

pub fn oversample(&self) -> OverSampleType

Returns the oversample faactor of this node

pub fn set_oversample(&mut self, oversample: OverSampleType)

set the oversample factor of this node

Arguments

• oversample - the desired OversampleType variant

Trait Implementations

impl AudioNode for WaveShaperNode

fn registration(&self) -> &AudioContextRegistration

Handle of the associated BaseAudioContext.

fn channel_config(&self) -> &ChannelConfig

Config for up/down-mixing of input channels for this node.

fn number_of_inputs(&self) -> usize

The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

fn number_of_outputs(&self) -> usize

The number of outputs coming out of the AudioNode.

fn context(&self) -> &ConcreteBaseAudioContext

The BaseAudioContext concrete type which owns this AudioNode.

fn connect<'a>(&self, dest: &'a dyn AudioNode) -> &'a dyn AudioNode

Connect the output of this AudioNode to the input of another node.

fn connect_from_output_to_input<'a>( &self, dest: &'a dyn AudioNode, output: usize, input: usize, ) -> &'a dyn AudioNode

Connect a specific output of this AudioNode to a specific input of another node.

fn disconnect(&self)

Disconnects all outgoing connections from the AudioNode.

fn disconnect_dest(&self, dest: &dyn AudioNode)

Disconnects all outputs of the AudioNode that go to a specific destination AudioNode.

fn disconnect_output(&self, output: usize)

Disconnects all outgoing connections at the given output port from the AudioNode.

fn disconnect_dest_from_output(&self, dest: &dyn AudioNode, output: usize)

Disconnects a specific output of the AudioNode to a specific destination AudioNode

fn disconnect_dest_from_output_to_input( &self, dest: &dyn AudioNode, output: usize, input: usize, )

Disconnects a specific output of the AudioNode to a specific input of some destination AudioNode

fn channel_count_mode(&self) -> ChannelCountMode

Represents an enumerated value describing the way channels must be matched between the node’s inputs and outputs.

fn set_channel_count_mode(&self, v: ChannelCountMode)

Update the channel_count_mode attribute

fn channel_interpretation(&self) -> ChannelInterpretation

Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen.

fn set_channel_interpretation(&self, v: ChannelInterpretation)

Update the channel_interpretation attribute

fn channel_count(&self) -> usize

Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node.

fn set_channel_count(&self, v: usize)

Update the channel_count attribute

fn set_onprocessorerror( &self, callback: Box<dyn FnOnce(ErrorEvent) + Send + 'static>, )

Register callback to run when an unhandled exception occurs in the audio processor.

fn clear_onprocessorerror(&self)

Unset the callback to run when an unhandled exception occurs in the audio processor.

impl Debug for WaveShaperNode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.