diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index 38c6487c..a2ede5aa 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: 'v0.6.1', + VERSION: 'v0.6.2', LANGUAGE: 'None', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/compatibility.html b/docs/compatibility.html index b6fde547..e190ed8d 100644 --- a/docs/compatibility.html +++ b/docs/compatibility.html @@ -10,7 +10,7 @@ - + @@ -20,7 +20,7 @@ - Plugin Compatibility - Pedalboard v0.6.1 Documentation + Plugin Compatibility - Pedalboard v0.6.2 Documentation @@ -138,7 +138,7 @@
-
Pedalboard v0.6.1 Documentation
 +
Pedalboard v0.6.2 Documentation
@@ -164,7 +164,7 @@
- Pedalboard v0.6.1 Documentation + Pedalboard v0.6.2 Documentation
-
Pedalboard v0.6.1 Documentation
 +
Pedalboard v0.6.2 Documentation
@@ -164,7 +164,7 @@
- Pedalboard v0.6.1 Documentation + Pedalboard v0.6.2 Documentation diff --git a/docs/faq.html b/docs/faq.html index 565812dd..204658ec 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -10,7 +10,7 @@ - + @@ -20,7 +20,7 @@ - Frequently Asked Questions - Pedalboard v0.6.1 Documentation + Frequently Asked Questions - Pedalboard v0.6.2 Documentation @@ -138,7 +138,7 @@
-
Pedalboard v0.6.1 Documentation
 +
Pedalboard v0.6.2 Documentation
@@ -164,7 +164,7 @@
- Pedalboard v0.6.1 Documentation + Pedalboard v0.6.2 Documentation diff --git a/docs/genindex.html b/docs/genindex.html index 97bb9168..2e78d371 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -4,7 +4,7 @@ - Index - Pedalboard v0.6.1 Documentation + Index - Pedalboard v0.6.2 Documentation @@ -122,7 +122,7 @@
-
Pedalboard v0.6.1 Documentation
 +
Pedalboard v0.6.2 Documentation
@@ -148,7 +148,7 @@
- Pedalboard v0.6.1 Documentation + Pedalboard v0.6.2 Documentation @@ -254,6 +254,8 @@

C

  • Chain (class in pedalboard)
  • Chorus (class in pedalboard) +
    • +
  • Clipping (class in pedalboard)
  • close() (pedalboard.io.ReadableAudioFile method) @@ -516,6 +518,8 @@

    P

  • (pedalboard.Chain method)
  • (pedalboard.Chorus method) +
    • +
  • (pedalboard.Clipping method)
  • (pedalboard.Compressor method)
    • @@ -634,6 +638,8 @@

    R

  • (pedalboard.Chain method)
  • (pedalboard.Chorus method) +
    • +
  • (pedalboard.Clipping method)
  • (pedalboard.Compressor method)
    • diff --git a/docs/index.html b/docs/index.html index 92c237fc..93b3e66b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -10,7 +10,7 @@ - + @@ -20,7 +20,7 @@ - Pedalboard v0.6.1 Documentation + Pedalboard v0.6.2 Documentation @@ -138,7 +138,7 @@
    -
    Pedalboard v0.6.1 Documentation
     +
    Pedalboard v0.6.2 Documentation
    @@ -164,7 +164,7 @@
    - Pedalboard v0.6.1 Documentation + Pedalboard v0.6.2 Documentation diff --git a/docs/internals.html b/docs/internals.html index 0dd65eae..eba2784a 100644 --- a/docs/internals.html +++ b/docs/internals.html @@ -10,7 +10,7 @@ - + @@ -20,7 +20,7 @@ - Pedalboard Internals - Pedalboard v0.6.1 Documentation + Pedalboard Internals - Pedalboard v0.6.2 Documentation @@ -138,7 +138,7 @@
    -
    Pedalboard v0.6.1 Documentation
     +
    Pedalboard v0.6.2 Documentation
    @@ -164,7 +164,7 @@
    - Pedalboard v0.6.1 Documentation + Pedalboard v0.6.2 Documentation diff --git a/docs/license.html b/docs/license.html index 19b49dbe..c689035a 100644 --- a/docs/license.html +++ b/docs/license.html @@ -10,7 +10,7 @@ - + @@ -20,7 +20,7 @@ - License - Pedalboard v0.6.1 Documentation + License - Pedalboard v0.6.2 Documentation @@ -138,7 +138,7 @@
    -
    Pedalboard v0.6.1 Documentation
     +
    Pedalboard v0.6.2 Documentation
    @@ -164,7 +164,7 @@
    - Pedalboard v0.6.1 Documentation + Pedalboard v0.6.2 Documentation diff --git a/docs/py-modindex.html b/docs/py-modindex.html index ae011aee..b091f7be 100644 --- a/docs/py-modindex.html +++ b/docs/py-modindex.html @@ -4,7 +4,7 @@ - Python Module Index - Pedalboard v0.6.1 Documentation + Python Module Index - Pedalboard v0.6.2 Documentation @@ -122,7 +122,7 @@
    -
    Pedalboard v0.6.1 Documentation
     +
    Pedalboard v0.6.2 Documentation
    @@ -148,7 +148,7 @@
    - Pedalboard v0.6.1 Documentation + Pedalboard v0.6.2 Documentation diff --git a/docs/reference/pedalboard.html b/docs/reference/pedalboard.html index 93c57227..cc3efc33 100644 --- a/docs/reference/pedalboard.html +++ b/docs/reference/pedalboard.html @@ -10,7 +10,7 @@ - + @@ -20,7 +20,7 @@ - The pedalboard API - Pedalboard v0.6.1 Documentation + The pedalboard API - Pedalboard v0.6.2 Documentation @@ -138,7 +138,7 @@
    -
    Pedalboard v0.6.1 Documentation
     +
    Pedalboard v0.6.2 Documentation
    @@ -164,7 +164,7 @@
    - Pedalboard v0.6.1 Documentation + Pedalboard v0.6.2 Documentation @@ -405,6 +405,40 @@ +
    +
    +class pedalboard.Clipping(threshold_db: float = - 6.0)#
    +

    A distortion plugin that adds hard distortion to the signal by clipping the signal at the provided threshold (in decibels).

    +
    +
    +process(input_array: numpy.ndarray, sample_rate: float, buffer_size: int = 8192, reset: bool = True) → numpy.ndarray[Any, numpy.dtype[numpy.float32]]#
    +

    Run a 32-bit or 64-bit floating point audio buffer through this plugin. +(If calling this multiple times with multiple plugins, consider creating a +pedalboard.Pedalboard object instead.)

    +

    The returned array may contain up to (but not more than) the same number of +samples as were provided. If fewer samples were returned than expected, the +plugin has likely buffered audio inside itself. To receive the remaining +audio, pass another audio buffer into process with reset set to +True.

    +

    If the provided buffer uses a 64-bit datatype, it will be converted to 32-bit +for processing.

    +

    The provided buffer_size argument will be used to control the size of +each chunk of audio provided to the plugin. Higher buffer sizes may speed up +processing at the expense of memory usage.

    +

    The reset flag determines if all of the plugins should be reset before +processing begins, clearing any state from previous calls to process. +If calling process multiple times while processing the same audio file +or buffer, set reset to False.

    +
    + +
    +
    +reset() → None#
    +

    Clear any internal state stored by this plugin (e.g.: reverb tails, delay lines, LFO state, etc). The values of plugin parameters will remain unchanged.

    +
    + +
    +
    class pedalboard.Compressor(threshold_db: float = 0, ratio: float = 1, attack_ms: float = 1.0, release_ms: float = 100)#
    @@ -932,7 +966,7 @@
    class pedalboard.MP3Compressor(vbr_quality: float = 2.0)#

    An MP3 compressor plugin that runs the LAME MP3 encoder in real-time to add compression artifacts to the audio stream.

    -

    Currently only supports variable bit-rate mode (VBR) and accepts a floating-point VBR quality value (between 0.0 and 12.0; lower is better).

    +

    Currently only supports variable bit-rate mode (VBR) and accepts a floating-point VBR quality value (between 0.0 and 10.0; lower is better).

    Note that the MP3 format only supports 32kHz, 44.1kHz, and 48kHz audio; if an unsupported sample rate is provided, an exception will be thrown at processing time.

    diff --git a/docs/reference/pedalboard.io.html b/docs/reference/pedalboard.io.html index 8b2a9e81..b2c622c6 100644 --- a/docs/reference/pedalboard.io.html +++ b/docs/reference/pedalboard.io.html @@ -10,7 +10,7 @@ - + @@ -20,7 +20,7 @@ - The pedalboard.io API - Pedalboard v0.6.1 Documentation + The pedalboard.io API - Pedalboard v0.6.2 Documentation @@ -138,7 +138,7 @@
    -
    Pedalboard v0.6.1 Documentation
     +
    Pedalboard v0.6.2 Documentation
    @@ -164,7 +164,7 @@
    - Pedalboard v0.6.1 Documentation + Pedalboard v0.6.2 Documentation diff --git a/docs/search.html b/docs/search.html index 6d9f4b13..7db12567 100644 --- a/docs/search.html +++ b/docs/search.html @@ -4,7 +4,7 @@ - Search - Pedalboard v0.6.1 Documentation + Search - Pedalboard v0.6.2 Documentation @@ -121,7 +121,7 @@
    -
    Pedalboard v0.6.1 Documentation
     +
    Pedalboard v0.6.2 Documentation
    @@ -147,7 +147,7 @@
    - Pedalboard v0.6.1 Documentation + Pedalboard v0.6.2 Documentation diff --git a/docs/searchindex.js b/docs/searchindex.js index d2f86418..047d6251 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["compatibility","examples","faq","index","internals","license","reference/pedalboard","reference/pedalboard.io"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["compatibility.rst","examples.rst","faq.rst","index.rst","internals.rst","license.rst","reference/pedalboard.rst","reference/pedalboard.io.rst"],objects:{"":[[6,0,0,"-","pedalboard"]],"pedalboard.AudioUnitPlugin":[[6,2,1,"","get_plugin_names_for_file"],[6,3,1,"","name"],[6,2,1,"","process"],[6,2,1,"","reset"],[6,2,1,"","show_editor"]],"pedalboard.Bitcrush":[[6,3,1,"","bit_depth"],[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Chain":[[6,2,1,"","append"],[6,2,1,"","insert"],[6,2,1,"","process"],[6,2,1,"","remove"],[6,2,1,"","reset"]],"pedalboard.Chorus":[[6,2,1,"","process"],[6,3,1,"","rate_hz"],[6,2,1,"","reset"]],"pedalboard.Compressor":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Convolution":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Delay":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Distortion":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.GSMFullRateCompressor":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Gain":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.HighShelfFilter":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.HighpassFilter":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.IIRFilter":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Invert":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.LadderFilter":[[6,1,1,"","Mode"],[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.LadderFilter.Mode":[[6,4,1,"","BPF12"],[6,4,1,"","BPF24"],[6,4,1,"","HPF12"],[6,4,1,"","HPF24"],[6,4,1,"","LPF12"],[6,4,1,"","LPF24"]],"pedalboard.Limiter":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.LowShelfFilter":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.LowpassFilter":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.MP3Compressor":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Mix":[[6,2,1,"","append"],[6,2,1,"","insert"],[6,2,1,"","process"],[6,2,1,"","remove"],[6,2,1,"","reset"]],"pedalboard.NoiseGate":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.PeakFilter":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Pedalboard":[[6,2,1,"","append"],[6,2,1,"","insert"],[6,2,1,"","process"],[6,2,1,"","remove"],[6,2,1,"","reset"]],"pedalboard.Phaser":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.PitchShift":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Plugin":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.PluginContainer":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Resample":[[6,1,1,"","Quality"],[6,2,1,"","process"],[6,3,1,"","quality"],[6,2,1,"","reset"],[6,3,1,"","target_sample_rate"]],"pedalboard.Resample.Quality":[[6,4,1,"","CatmullRom"],[6,4,1,"","Lagrange"],[6,4,1,"","Linear"],[6,4,1,"","WindowedSinc"],[6,4,1,"","ZeroOrderHold"]],"pedalboard.Reverb":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.VST3Plugin":[[6,2,1,"","get_plugin_names_for_file"],[6,2,1,"","load_preset"],[6,3,1,"","name"],[6,2,1,"","process"],[6,2,1,"","reset"],[6,2,1,"","show_editor"]],"pedalboard.io":[[7,1,1,"","AudioFile"],[7,1,1,"","ReadableAudioFile"],[7,1,1,"","ResampledReadableAudioFile"],[7,1,1,"","StreamResampler"],[7,1,1,"","WriteableAudioFile"]],"pedalboard.io.ReadableAudioFile":[[7,2,1,"","close"],[7,3,1,"","closed"],[7,3,1,"","duration"],[7,3,1,"","file_dtype"],[7,3,1,"","frames"],[7,3,1,"","name"],[7,3,1,"","num_channels"],[7,2,1,"","read"],[7,2,1,"","read_raw"],[7,2,1,"","resampled_to"],[7,3,1,"","samplerate"],[7,2,1,"","seek"],[7,2,1,"","seekable"],[7,2,1,"","tell"]],"pedalboard.io.ResampledReadableAudioFile":[[7,2,1,"","close"],[7,3,1,"","closed"],[7,3,1,"","duration"],[7,3,1,"","file_dtype"],[7,3,1,"","frames"],[7,3,1,"","name"],[7,3,1,"","num_channels"],[7,2,1,"","read"],[7,3,1,"","resampling_quality"],[7,3,1,"","samplerate"],[7,2,1,"","seek"],[7,2,1,"","seekable"],[7,2,1,"","tell"]],"pedalboard.io.StreamResampler":[[7,3,1,"","input_latency"],[7,3,1,"","num_channels"],[7,2,1,"","process"],[7,3,1,"","quality"],[7,2,1,"","reset"],[7,3,1,"","source_sample_rate"],[7,3,1,"","target_sample_rate"]],"pedalboard.io.WriteableAudioFile":[[7,2,1,"","close"],[7,3,1,"","closed"],[7,3,1,"","file_dtype"],[7,2,1,"","flush"],[7,3,1,"","frames"],[7,3,1,"","num_channels"],[7,3,1,"","quality"],[7,3,1,"","samplerate"],[7,2,1,"","write"]],pedalboard:[[6,1,1,"","AudioUnitPlugin"],[6,1,1,"","Bitcrush"],[6,1,1,"","Chain"],[6,1,1,"","Chorus"],[6,1,1,"","Compressor"],[6,1,1,"","Convolution"],[6,1,1,"","Delay"],[6,1,1,"","Distortion"],[6,1,1,"","GSMFullRateCompressor"],[6,1,1,"","Gain"],[6,1,1,"","HighShelfFilter"],[6,1,1,"","HighpassFilter"],[6,1,1,"","IIRFilter"],[6,1,1,"","Invert"],[6,1,1,"","LadderFilter"],[6,1,1,"","Limiter"],[6,1,1,"","LowShelfFilter"],[6,1,1,"","LowpassFilter"],[6,1,1,"","MP3Compressor"],[6,1,1,"","Mix"],[6,1,1,"","NoiseGate"],[6,1,1,"","PeakFilter"],[6,1,1,"","Pedalboard"],[6,1,1,"","Phaser"],[6,1,1,"","PitchShift"],[6,1,1,"","Plugin"],[6,1,1,"","PluginContainer"],[6,1,1,"","Resample"],[6,1,1,"","Reverb"],[6,1,1,"","VST3Plugin"],[7,0,0,"-","io"],[6,5,1,"","load_plugin"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","property","Python property"],"4":["py","attribute","Python attribute"],"5":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:property","4":"py:attribute","5":"py:function"},terms:{"0":[1,2,6,7],"000":[2,7],"050":7,"0f":7,"1":[1,2,3,6,7],"10":[1,3,6,7],"100":[2,6,7],"1024":7,"11":3,"12":[1,6],"128":7,"1300":6,"15":1,"16":7,"160":7,"1968":6,"1khz":[2,6],"2":[3,6,7],"200":6,"2021":5,"2022":5,"22":7,"22050":7,"22_050":7,"22m":2,"24":6,"25":[1,6],"256":7,"27":3,"2g":6,"2m":2,"3":[1,3,6],"30":1,"300x":3,"32":[6,7],"32khz":6,"33":6,"3db":6,"3g2":7,"3gp":7,"4":6,"40":1,"44":[2,6,7],"440":6,"441":7,"44100":[1,7],"48khz":6,"4x":3,"5":[1,6,7],"50":[1,6],"5x":3,"6":[1,3,5,6,7],"64":[3,6],"6db":6,"7":[1,3,6],"7071067690849304":6,"707x":6,"8":[3,6],"8000":6,"8192":6,"8khz":6,"9":3,"900":1,"98":2,"abstract":6,"case":[2,3,4,6],"catch":0,"class":[6,7],"default":7,"do":[0,1,7],"final":1,"float":[6,7],"function":[2,4,6,7],"import":[1,2,4],"int":[6,7],"long":7,"new":[3,7],"public":5,"return":[6,7],"static":[4,5,6],"switch":2,"throw":[6,7],"true":[6,7],"try":[0,6],"while":[2,6,7],A:[6,7],As:7,For:[1,6,7],If:[0,3,6,7],In:2,Ins:6,It:[1,3],No:[3,6],Not:[2,4,6,7],That:3,The:[2,4,5],These:6,To:6,Will:[4,7],With:2,_:6,_audiounitplugin:6,_n_:2,_vst3plugin:6,aac:[3,7],aarch64:3,ab:5,abil:0,about:2,abov:6,ac3:[3,7],accept:[3,6,7],access:2,accur:7,ad:[3,6,7],add:[1,2,3,4,6],addit:[3,4,7],adt:7,advanc:7,af:2,affect:6,after:6,aif:7,aifc:7,aiff:[3,7],ak391:1,algorithm:[6,7],alias:6,all:[1,2,3,4,6,7],allow:[0,2,3,6,7],also:[2,3,4,6,7],although:[2,6,7],alwai:7,amd64:3,amd:3,amount:[4,6,7],amplifi:6,amr:7,an:[0,1,2,4,6,7],ani:[0,2,4,6,7],anoth:6,api:[3,4],append:[1,6,7],appl:[3,6],appli:6,applic:[2,4],appropri:[4,6],ar:[0,1,2,3,4,5,6,7],architectur:6,aren:2,arg0:6,arg:6,argument:[6,7],arm:3,around:[0,4,6],arrai:[6,7],artifact:[2,6],ask:[0,3],associ:4,assum:7,attack:6,attack_m:[1,6],attempt:[0,7],attenu:6,au:[2,7],audibl:6,audio:[0,3,4,5,6,7],audio_fil:7,audiofil:[1,2,7],audiounitplugin:6,augment:3,autom:2,automat:[0,3,7],avail:[3,4,6],avoid:[2,7],b:7,back:[1,6],band:[5,6],bar:2,base:[6,7],basic:[3,6,7],been:[0,7],befor:[6,7],begin:[6,7],behav:[0,1],being:0,below:6,benefit:7,best:7,better:6,between:[0,2,6,7],big:2,binari:[4,7],binaryio:7,bind:4,bit:[6,7],bit_depth:[6,7],bitcrush:[3,6],block:[2,6],board:[1,2],bob:6,bool:[6,7],boost:6,both:[3,6],box:3,bpf12:6,bpf24:6,buffer:[2,6,7],buffer_s:6,build:6,built:[2,3],bundl:[5,6],bwf:7,bypass:1,bytesio:7,c:[2,4],caf:7,call:[0,6,7],can:[0,1,3,4,6,7],cancel:6,cannam:6,cannot:[4,6],carri:5,catmullrom:6,caus:[2,6,7],caveat:2,ccrma:6,cellular:6,centr:6,centre_delay_m:6,centre_frequency_hz:6,certain:7,chain:[3,6],chang:[1,3,6,7],channel:7,choru:[1,3,6],chri:6,chunk:[2,6,7],classic:6,clean:2,clear:[0,6],click:2,clipper:6,close:[6,7],code:[0,2,4,5],codec:[6,7],colab:1,collect:2,commerci:5,common:[0,3],compat:[4,5,6],compil:[4,5],complex:4,complic:4,compon:6,compress:[3,6,7],compressor:[1,2,3,6],conform:0,connect:6,consid:[4,6,7],consider:3,constant:7,constraint:4,constructor:7,contain:[0,1,2,6,7],content:[3,7],context:2,control:6,convent:0,convert:[6,7],convolut:[1,3,6],copi:4,copyright:5,core:[3,5],could:[0,2,6],coupl:2,cpu:3,crash:[0,7],creat:[2,3,6,7],creation:3,cross:[4,6],current:[6,7],cut:[2,6],cutoff:6,cutoff_frequency_hz:6,cutoff_hz:[1,6],d:7,damp:6,data:[2,3,7],datatyp:[6,7],db:6,db_to_gain:6,debug:7,decept:7,decibel:6,decim:6,decompress:7,decreas:[6,7],def:6,degrad:6,delai:[1,2,3,6],delay_and_pitch_shift:1,delay_longer_and_more_pitch_shift:1,delay_second:[1,6],demo:1,depend:[3,4,6,7],depth:[6,7],design:[3,6],desir:1,detect:0,determin:6,develop:4,dict:6,dict_kei:1,dictionari:6,differ:[6,7],difficult:2,digit:[3,4,6],dimension:7,direct:6,directli:[2,6,7],disk:[1,7],distort:[1,3,6],distribut:4,divid:7,doe:[3,4,7],don:[0,1,7],down:2,downsampl:6,dr:6,dramat:2,drive:6,drive_db:6,drop:2,dry:6,dry_level:6,dsp:4,dtype:[6,7],dual:5,durat:[6,7],dynam:[3,6],e:[2,6,7],each:[6,7],easili:1,ec3:7,edu:6,effect:[3,4,6,7],either:[2,7],emul:6,enabl:3,encod:[6,7],enough:2,ensur:[0,2,4,7],entir:7,environ:4,equal:[2,3,6,7],equival:6,error:0,etc:[6,7],even:[0,3],everi:[0,4,7],exampl:[2,3,4,6,7],except:[6,7],exist:7,expand:6,expect:[6,7],expens:[2,6],experiment:[2,3],expos:4,express:6,extens:7,externalplugin:6,f:[1,7],face:1,factor:6,fade:0,fals:[2,6,7],far:7,fashion:[0,2],fast:6,faster:3,fastest:[6,7],featur:6,feeback:6,feedback:6,fewer:[4,6],fi:6,file:[1,2,3,4,6,7],file_dtyp:7,file_lik:7,filenam:[6,7],filename_or_file_lik:7,filter:[3,6],fine:[0,2],first:6,first_ten_second:7,fix:6,flac:[3,7],flag:6,flanger:6,flip:6,float32:[6,7],float64:[6,7],flush:7,fly:[3,7],folder:1,follow:[3,4,5],forc:7,format:[3,6,7],found:6,four:7,frac:6,fraction:7,frame:[1,2,7],framework:2,freeverb:6,freeze_mod:6,frequenc:6,frequent:3,from:[0,1,2,3,5,6,7],front:1,full:6,full_bandwidth:1,further:[6,7],futur:7,g:6,gain:[1,3,6],gain_db:[1,6],garbag:2,gate:6,gener:[5,6],get:6,get_audio_buff:7,get_plugin_names_for_fil:6,get_supported_read_format:7,get_supported_write_format:7,getvalu:7,gigabyt:7,gil:3,git:4,github:3,give:[2,6],given:[6,7],glibc:3,global:[2,3],gmbh:[5,6],gnu:5,goal:4,good:6,gplv2:5,gplv3:[4,5],gradio:1,gsm:6,gsmcompressor:6,gsmfullratecompressor:[3,5,6],guarante:3,guid:3,guitar:3,guitar_amp:1,guitarboard:2,ha:[0,6,7],hand:7,happen:7,hard:[6,7],harmon:6,have:[0,2,4,6,7],hear:2,heavili:3,help:3,hertz:6,hide:4,high:[2,6],higher:6,highest:6,highpassfilt:[3,6],highshelffilt:6,hood:7,horizont:6,hour:7,how:[0,6],howev:[2,6],hpf12:[1,6],hpf24:6,html:6,http:6,hug:1,hyperbol:6,hz:[6,7],i:[2,3,6,7],icorv:3,ident:[6,7],identifi:6,idiomat:4,iff:7,iir:6,iirfilt:6,implement:[4,6],importerror:6,improv:3,impuls:6,impulse_response_filenam:6,includ:[0,2,3,4,5],inclus:5,incorrectli:0,increas:[4,6,7],increment:7,index:6,indic:[6,7],infinit:6,initi:6,input:[1,2,6,7],input_arrai:6,input_lat:7,input_lvl_db:1,insert:6,insid:6,instal:[4,6,7],instanc:[1,4,6,7],instead:[3,6,7],instrument:3,int16:7,int32:7,int8:7,integ:[6,7],intel:3,intellig:3,intend:6,interact:1,interest:1,interfac:[2,4],intern:[0,3,6,7],interpret:[0,2,3],interv:2,introduc:[6,7],intuit:4,invent:6,invert:6,io:[1,2,3,6],isc:5,issu:[0,2,4],its:[6,7],itself:[2,4,6],jo:6,juce:[2,4,5],just:[0,1,2,4,7],kbp:7,kei:[1,6],keyboardinterrupt:6,kilobit:7,kind:6,known:1,kwarg:6,lab:3,ladder:6,ladderfilt:[1,3,6],lagrang:6,lame:[5,6,7],languag:2,larg:[2,7],latm:7,leak:[0,7],learn:[3,4],length:7,less:6,level:7,lfo:6,lgplv2:5,libgsm:5,libmp3lam:5,librari:[2,3,4,5,6,7],librosa:3,licens:[3,4],like:[1,6,7],limit:[1,3,6],line:[6,7],linear:[6,7],link:4,linux:[3,4,6,7],list:[1,6],liter:7,live:3,lo:6,loa:7,load:[0,1,3,4,6],load_plugin:[0,1,3,4,6],load_preset:6,loadabl:6,locat:7,lock:[2,3],logic:4,longer:7,lossi:[3,6],lot:6,loud:[3,6],low:6,lower:6,lowest:6,lowpassfilt:[3,6],lowshelffilt:6,lpf12:6,lpf24:6,m4a:7,m4b:7,m4r:7,machin:[3,4],maco:[3,4,6,7],magnitud:6,mai:[0,4,6,7],make:[2,3],makeup_db:1,mani:[0,3,6,7],manual:[2,3],manylinux:3,match:[6,7],mathemat:6,maximum:7,md:3,mean:2,meant:4,media:5,megabyt:7,memori:[2,3,6,7],mere:6,method:[6,7],midi:3,might:4,minimum:7,misbehav:0,mix:[1,6],mode:[1,6,7],model:[3,6],moder:6,modern:3,modifi:2,modul:[6,7],moog:6,more:[1,3,4,6,7],most:[0,2,3,4,6,7],mov:7,mp1:7,mp2:7,mp3:[3,6,7],mp3compressor:[3,5,6],mp4:7,mpa:7,mpeg:7,ms:6,much:[1,6],multi:[6,7],multipl:[1,2,3,6,7],multiprocess:3,music:4,must:[6,7],mutat:2,my_fil:7,name:[6,7],nativ:[6,7],ndarrai:[6,7],nearli:7,need:[3,4],nest:1,network:2,newer:5,next:0,nois:6,noiseg:6,noisi:6,non:[6,7],none:[6,7],normal:6,notabl:4,notch:6,note:[2,6,7],notebook:1,notic:0,np:7,num_channel:[2,7],num_fram:7,number:[2,3,5,6,7],numer:7,numpi:[6,7],o:[2,3,6,7],object:[1,2,6,7],obtain:7,occur:7,octav:6,off:[2,6],offlin:2,ogg:[3,7],ogg_buff:7,onc:7,one:[0,3,6,7],onli:[3,6,7],onto:6,open:[2,4,7],oper:[2,6,7],optim:7,option:[4,6,7],order:6,origin:[6,7],oscil:6,other:[0,1,3,6,7],otherwis:7,our:[1,2],out:[2,3,6,7],output:[1,2,6,7],output_lvl_db:1,over:3,overload:6,own:[5,6],packag:[4,6,7],parallel:[3,6],paramet:[1,3,6,7],parameter_valu:6,parti:[3,6],pasp:6,pass:[0,2,6,7],passthrough:1,path:[1,6,7],path_to_plugin_fil:6,paus:2,pbar:2,peak:6,peakfilt:6,pedalboard:[0,3,5],pedalboard_n:6,per:[6,7],percentag:[2,6],percentage_through_track:2,perform:4,permit:5,phaser:[1,3,6],phone:6,pip:3,pipelin:3,pitch:[1,3,6],pitchshift:[1,3,5,6],platform:[3,4,6,7],pleas:6,plug:[6,7],plugin:[3,5,6],plugin_nam:6,plugincontain:6,point:[6,7],pointer:7,polar:6,pop:2,popular:3,portabl:4,posit:7,possibl:[2,3,7],potenti:[2,7],present:6,preset:6,preset_file_path:6,pretti:1,prevent:[2,7],previou:6,print:1,prioriti:2,probabl:7,problem:7,process:[0,1,2,3,4,5,6,7],produc:6,product:3,program:[0,1,2],programm:4,progress:2,project:[2,5],properti:[6,7],provid:[4,6,7],pull:[2,5],push:7,put:1,pybind11:4,pypi:3,pysox:3,python:[0,2,3,4,6,7],q:6,qt:7,qualiti:[3,6,7],quantiz:6,question:3,quick:3,r:[1,7],rais:[6,7],ramp:2,rand:7,random:[2,7],randomli:2,rang:[2,3,6],rare:4,rate:[1,2,6,7],rate_hz:6,rather:7,ratio:[1,6],raw:[4,7],re:7,read:[1,2,3,6,7],read_raw:7,readabl:7,readableaudiofil:7,real:[3,6,7],reason:4,receiv:[2,6],reduc:6,reduct:[3,6],redund:7,regardless:7,regist:5,regular:[2,7],rel:3,releas:[3,6],release_m:[1,6],reliabl:7,reload:0,remain:[6,7],remov:[4,6],render:[0,7],repo:3,report:6,repositori:[1,4],repres:6,request:2,requir:[2,3,4,6,7],resampl:[1,3,6,7],resampled_to:[1,7],resampledreadableaudiofil:7,resampling_qu:7,reset:[2,6,7],resolut:6,reson:6,resourc:4,respect:7,respons:6,result:[2,7],reverb:[0,1,2,3,6],robust:3,roll:6,room_siz:[1,6],roughli:6,roughrider3:1,rubber:[5,6],run:[1,6],runtim:4,runtimeerror:[6,7],s:[3,4,6,7],safe:4,safeti:3,same:[1,4,6,7],sampl:[1,2,6,7],sample_r:6,sampler:[1,2,7],save:2,sc_activ:1,sc_hpf_hz:1,scan:6,sd2:7,sdk:5,second:[2,6,7],see:[1,2,6,7],seek:7,seekabl:7,self:6,semiton:[1,6],sensitivity_db:1,separ:2,seri:7,set:[0,1,2,6,7],shape:[1,2,7],shelf:6,shift:[1,6],should:[4,6,7],show:[2,4,6],show_editor:6,side:6,signal:[4,6],silenc:0,silicon:3,simpl:6,simpler:4,simplest:6,simplic:4,simul:6,simultan:1,singl:[3,6],size:[2,4,6],slightli:6,slow:[2,6],slowest:[6,7],small:2,smaller:[1,2,7],smoother:2,snd:7,so:[0,1,2,6,7],soft:2,softwar:4,some:[0,1,4,7],someth:7,somewher:2,sound:[1,6],sounddevic:2,sourc:[4,7],source_sample_r:7,soxbind:3,space:1,spatial:3,speaker:6,specif:[0,6],specifi:[6,7],speed:[2,3,4,6],spotifi:[3,5],sqrt:6,stabil:4,stage:6,standard:6,stanford:6,start:[3,7],state:[0,6,7],stefanobazzi:2,steinberg:[5,6],step:2,step_size_in_sampl:2,stereo:[6,7],still:6,store:[6,7],str:[6,7],stream:[2,3,6,7],streamresampl:7,stretch:6,string:[6,7],stringio:7,strong:3,studio:3,stutter:2,style:3,subclass:6,submodul:4,suitabl:6,suppli:7,support:[3,4,6,7],suppos:0,sweep:6,synthes:6,system:[2,6,7],t:[0,1,2,7],tail:[0,2,6],take:6,talk:2,tangent:6,tanh:6,target:7,target_sample_r:[6,7],technic:2,techniqu:[2,6],technolog:5,tell:7,tensorflow:3,test:[0,3,4],tf:3,than:[3,4,6,7],them:[1,6],themselv:1,thi:[1,2,5,6,7],thing:6,think:6,third:[3,6],thoroughli:3,thread:[2,3,4],threshold:6,threshold_db:[1,6],through:[1,2,6,7],thrown:6,time:[0,3,6,7],too:7,total:[2,7],tqdm:2,track:2,trademark:5,trail:7,transform:3,transit:2,tune:6,two:6,type:[6,7],typeerror:7,typic:7,ui:6,unavail:6,unbound:[2,7],unchang:6,under:[5,7],underli:[2,7],undesir:0,union:[6,7],uniqu:6,unit:[0,2,3,4,6],unlik:7,unsupport:[6,7],until:6,unus:[2,7],up:[2,3,6],updat:2,upgrad:5,upsampl:6,us:[3,4,5,6,7],usabl:7,usag:[3,6],user:4,usual:[2,6,7],util:[3,6],v0:7,v2:7,v3:5,v9:7,valu:[6,7],vari:2,variabl:[6,7],varieti:4,variou:6,vbr:6,vbr_qualiti:6,vendor:4,veri:2,versa:4,version:7,vertic:6,via:[1,3,6,7],vibrato:6,vice:4,volum:6,vorbi:7,vst3:[0,3,4,5,6],vst3plugin:6,vst:[1,3,5],vstpreset:6,w64:7,w:[1,2,7],wa:[3,6,7],wai:4,want:7,warn:0,wav:[1,2,3,7],wav_buff:7,waveshap:6,we:2,web:1,well:[0,3,4,6,7],were:6,wet:[2,6],wet_level:[2,6],what:6,wheel:[3,4],when:[0,2,3,4,6,7],where:4,which:[0,2,5,6,7],white_nois:7,whole:1,wide:[3,6],wider:4,width:6,window:[3,4,6,7],windowedsinc:[6,7],within:[3,4,6],without:[0,2,3,6,7],wma:[3,7],wonder:6,work:[0,3,6,7],workstat:3,worst:[0,7],would:[2,4,6,7],wrap:7,wrapper:[4,6],write:[1,2,3,6,7],writeabl:7,writeableaudiofil:7,written:[2,4,7],x86:3,x86_64:3,x:6,xhe:7,ye:2,yet:2,you:[1,3,7],your:2,zero:6,zeroorderhold:6},titles:["Plugin Compatibility","Examples","Frequently Asked Questions","Features","Pedalboard Internals","License","The pedalboard API","The pedalboard.io API"],titleterms:{"new":4,The:[6,7],accept:2,ad:4,api:[6,7],ask:2,audio:[1,2],built:4,can:2,chain:1,chang:2,compat:[0,3],consider:4,creat:1,design:4,document:3,doe:2,effect:[1,2],exampl:1,featur:3,frequent:2,guitar:1,instal:3,instead:2,instrument:2,intern:4,io:7,licens:5,live:2,make:1,midi:2,over:2,parallel:1,paramet:2,pedalboard:[1,2,4,6,7],plugin:[0,1,2,4],question:2,quick:1,real:2,refer:3,s:2,start:1,style:1,support:2,time:2,unit:1,us:[1,2],vst3:1,vst:2}}) \ No newline at end of file +Search.setIndex({docnames:["compatibility","examples","faq","index","internals","license","reference/pedalboard","reference/pedalboard.io"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["compatibility.rst","examples.rst","faq.rst","index.rst","internals.rst","license.rst","reference/pedalboard.rst","reference/pedalboard.io.rst"],objects:{"":[[6,0,0,"-","pedalboard"]],"pedalboard.AudioUnitPlugin":[[6,2,1,"","get_plugin_names_for_file"],[6,3,1,"","name"],[6,2,1,"","process"],[6,2,1,"","reset"],[6,2,1,"","show_editor"]],"pedalboard.Bitcrush":[[6,3,1,"","bit_depth"],[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Chain":[[6,2,1,"","append"],[6,2,1,"","insert"],[6,2,1,"","process"],[6,2,1,"","remove"],[6,2,1,"","reset"]],"pedalboard.Chorus":[[6,2,1,"","process"],[6,3,1,"","rate_hz"],[6,2,1,"","reset"]],"pedalboard.Clipping":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Compressor":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Convolution":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Delay":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Distortion":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.GSMFullRateCompressor":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Gain":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.HighShelfFilter":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.HighpassFilter":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.IIRFilter":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Invert":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.LadderFilter":[[6,1,1,"","Mode"],[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.LadderFilter.Mode":[[6,4,1,"","BPF12"],[6,4,1,"","BPF24"],[6,4,1,"","HPF12"],[6,4,1,"","HPF24"],[6,4,1,"","LPF12"],[6,4,1,"","LPF24"]],"pedalboard.Limiter":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.LowShelfFilter":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.LowpassFilter":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.MP3Compressor":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Mix":[[6,2,1,"","append"],[6,2,1,"","insert"],[6,2,1,"","process"],[6,2,1,"","remove"],[6,2,1,"","reset"]],"pedalboard.NoiseGate":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.PeakFilter":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Pedalboard":[[6,2,1,"","append"],[6,2,1,"","insert"],[6,2,1,"","process"],[6,2,1,"","remove"],[6,2,1,"","reset"]],"pedalboard.Phaser":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.PitchShift":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Plugin":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.PluginContainer":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.Resample":[[6,1,1,"","Quality"],[6,2,1,"","process"],[6,3,1,"","quality"],[6,2,1,"","reset"],[6,3,1,"","target_sample_rate"]],"pedalboard.Resample.Quality":[[6,4,1,"","CatmullRom"],[6,4,1,"","Lagrange"],[6,4,1,"","Linear"],[6,4,1,"","WindowedSinc"],[6,4,1,"","ZeroOrderHold"]],"pedalboard.Reverb":[[6,2,1,"","process"],[6,2,1,"","reset"]],"pedalboard.VST3Plugin":[[6,2,1,"","get_plugin_names_for_file"],[6,2,1,"","load_preset"],[6,3,1,"","name"],[6,2,1,"","process"],[6,2,1,"","reset"],[6,2,1,"","show_editor"]],"pedalboard.io":[[7,1,1,"","AudioFile"],[7,1,1,"","ReadableAudioFile"],[7,1,1,"","ResampledReadableAudioFile"],[7,1,1,"","StreamResampler"],[7,1,1,"","WriteableAudioFile"]],"pedalboard.io.ReadableAudioFile":[[7,2,1,"","close"],[7,3,1,"","closed"],[7,3,1,"","duration"],[7,3,1,"","file_dtype"],[7,3,1,"","frames"],[7,3,1,"","name"],[7,3,1,"","num_channels"],[7,2,1,"","read"],[7,2,1,"","read_raw"],[7,2,1,"","resampled_to"],[7,3,1,"","samplerate"],[7,2,1,"","seek"],[7,2,1,"","seekable"],[7,2,1,"","tell"]],"pedalboard.io.ResampledReadableAudioFile":[[7,2,1,"","close"],[7,3,1,"","closed"],[7,3,1,"","duration"],[7,3,1,"","file_dtype"],[7,3,1,"","frames"],[7,3,1,"","name"],[7,3,1,"","num_channels"],[7,2,1,"","read"],[7,3,1,"","resampling_quality"],[7,3,1,"","samplerate"],[7,2,1,"","seek"],[7,2,1,"","seekable"],[7,2,1,"","tell"]],"pedalboard.io.StreamResampler":[[7,3,1,"","input_latency"],[7,3,1,"","num_channels"],[7,2,1,"","process"],[7,3,1,"","quality"],[7,2,1,"","reset"],[7,3,1,"","source_sample_rate"],[7,3,1,"","target_sample_rate"]],"pedalboard.io.WriteableAudioFile":[[7,2,1,"","close"],[7,3,1,"","closed"],[7,3,1,"","file_dtype"],[7,2,1,"","flush"],[7,3,1,"","frames"],[7,3,1,"","num_channels"],[7,3,1,"","quality"],[7,3,1,"","samplerate"],[7,2,1,"","write"]],pedalboard:[[6,1,1,"","AudioUnitPlugin"],[6,1,1,"","Bitcrush"],[6,1,1,"","Chain"],[6,1,1,"","Chorus"],[6,1,1,"","Clipping"],[6,1,1,"","Compressor"],[6,1,1,"","Convolution"],[6,1,1,"","Delay"],[6,1,1,"","Distortion"],[6,1,1,"","GSMFullRateCompressor"],[6,1,1,"","Gain"],[6,1,1,"","HighShelfFilter"],[6,1,1,"","HighpassFilter"],[6,1,1,"","IIRFilter"],[6,1,1,"","Invert"],[6,1,1,"","LadderFilter"],[6,1,1,"","Limiter"],[6,1,1,"","LowShelfFilter"],[6,1,1,"","LowpassFilter"],[6,1,1,"","MP3Compressor"],[6,1,1,"","Mix"],[6,1,1,"","NoiseGate"],[6,1,1,"","PeakFilter"],[6,1,1,"","Pedalboard"],[6,1,1,"","Phaser"],[6,1,1,"","PitchShift"],[6,1,1,"","Plugin"],[6,1,1,"","PluginContainer"],[6,1,1,"","Resample"],[6,1,1,"","Reverb"],[6,1,1,"","VST3Plugin"],[7,0,0,"-","io"],[6,5,1,"","load_plugin"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","property","Python property"],"4":["py","attribute","Python attribute"],"5":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:property","4":"py:attribute","5":"py:function"},terms:{"0":[1,2,6,7],"000":[2,7],"050":7,"0f":7,"1":[1,2,3,6,7],"10":[1,3,6,7],"100":[2,6,7],"1024":7,"11":3,"12":[1,6],"128":7,"1300":6,"15":1,"16":7,"160":7,"1968":6,"1khz":[2,6],"2":[3,6,7],"200":6,"2021":5,"2022":5,"22":7,"22050":7,"22_050":7,"22m":2,"24":6,"25":[1,6],"256":7,"27":3,"2g":6,"2m":2,"3":[1,3,6],"30":1,"300x":3,"32":[6,7],"32khz":6,"33":6,"3db":6,"3g2":7,"3gp":7,"4":6,"40":1,"44":[2,6,7],"440":6,"441":7,"44100":[1,7],"48khz":6,"4x":3,"5":[1,6,7],"50":[1,6],"5x":3,"6":[1,3,5,6,7],"64":[3,6],"6db":6,"7":[1,3,6],"7071067690849304":6,"707x":6,"8":[3,6],"8000":6,"8192":6,"8khz":6,"9":3,"900":1,"98":2,"abstract":6,"case":[2,3,4,6],"catch":0,"class":[6,7],"default":7,"do":[0,1,7],"final":1,"float":[6,7],"function":[2,4,6,7],"import":[1,2,4],"int":[6,7],"long":7,"new":[3,7],"public":5,"return":[6,7],"static":[4,5,6],"switch":2,"throw":[6,7],"true":[6,7],"try":[0,6],"while":[2,6,7],A:[6,7],As:7,For:[1,6,7],If:[0,3,6,7],In:2,Ins:6,It:[1,3],No:[3,6],Not:[2,4,6,7],That:3,The:[2,4,5],These:6,To:6,Will:[4,7],With:2,_:6,_audiounitplugin:6,_n_:2,_vst3plugin:6,aac:[3,7],aarch64:3,ab:5,abil:0,about:2,abov:6,ac3:[3,7],accept:[3,6,7],access:2,accur:7,ad:[3,6,7],add:[1,2,3,4,6],addit:[3,4,7],adt:7,advanc:7,af:2,affect:6,after:6,aif:7,aifc:7,aiff:[3,7],ak391:1,algorithm:[6,7],alias:6,all:[1,2,3,4,6,7],allow:[0,2,3,6,7],also:[2,3,4,6,7],although:[2,6,7],alwai:7,amd64:3,amd:3,amount:[4,6,7],amplifi:6,amr:7,an:[0,1,2,4,6,7],ani:[0,2,4,6,7],anoth:6,api:[3,4],append:[1,6,7],appl:[3,6],appli:6,applic:[2,4],appropri:[4,6],ar:[0,1,2,3,4,5,6,7],architectur:6,aren:2,arg0:6,arg:6,argument:[6,7],arm:3,around:[0,4,6],arrai:[6,7],artifact:[2,6],ask:[0,3],associ:4,assum:7,attack:6,attack_m:[1,6],attempt:[0,7],attenu:6,au:[2,7],audibl:6,audio:[0,3,4,5,6,7],audio_fil:7,audiofil:[1,2,7],audiounitplugin:6,augment:3,autom:2,automat:[0,3,7],avail:[3,4,6],avoid:[2,7],b:7,back:[1,6],band:[5,6],bar:2,base:[6,7],basic:[3,6,7],been:[0,7],befor:[6,7],begin:[6,7],behav:[0,1],being:0,below:6,benefit:7,best:7,better:6,between:[0,2,6,7],big:2,binari:[4,7],binaryio:7,bind:4,bit:[6,7],bit_depth:[6,7],bitcrush:[3,6],block:[2,6],board:[1,2],bob:6,bool:[6,7],boost:6,both:[3,6],box:3,bpf12:6,bpf24:6,buffer:[2,6,7],buffer_s:6,build:6,built:[2,3],bundl:[5,6],bwf:7,bypass:1,bytesio:7,c:[2,4],caf:7,call:[0,6,7],can:[0,1,3,4,6,7],cancel:6,cannam:6,cannot:[4,6],carri:5,catmullrom:6,caus:[2,6,7],caveat:2,ccrma:6,cellular:6,centr:6,centre_delay_m:6,centre_frequency_hz:6,certain:7,chain:[3,6],chang:[1,3,6,7],channel:7,choru:[1,3,6],chri:6,chunk:[2,6,7],classic:6,clean:2,clear:[0,6],click:2,clip:6,clipper:6,close:[6,7],code:[0,2,4,5],codec:[6,7],colab:1,collect:2,commerci:5,common:[0,3],compat:[4,5,6],compil:[4,5],complex:4,complic:4,compon:6,compress:[3,6,7],compressor:[1,2,3,6],conform:0,connect:6,consid:[4,6,7],consider:3,constant:7,constraint:4,constructor:7,contain:[0,1,2,6,7],content:[3,7],context:2,control:6,convent:0,convert:[6,7],convolut:[1,3,6],copi:4,copyright:5,core:[3,5],could:[0,2,6],coupl:2,cpu:3,crash:[0,7],creat:[2,3,6,7],creation:3,cross:[4,6],current:[6,7],cut:[2,6],cutoff:6,cutoff_frequency_hz:6,cutoff_hz:[1,6],d:7,damp:6,data:[2,3,7],datatyp:[6,7],db:6,db_to_gain:6,debug:7,decept:7,decibel:6,decim:6,decompress:7,decreas:[6,7],def:6,degrad:6,delai:[1,2,3,6],delay_and_pitch_shift:1,delay_longer_and_more_pitch_shift:1,delay_second:[1,6],demo:1,depend:[3,4,6,7],depth:[6,7],design:[3,6],desir:1,detect:0,determin:6,develop:4,dict:6,dict_kei:1,dictionari:6,differ:[6,7],difficult:2,digit:[3,4,6],dimension:7,direct:6,directli:[2,6,7],disk:[1,7],distort:[1,3,6],distribut:4,divid:7,doe:[3,4,7],don:[0,1,7],down:2,downsampl:6,dr:6,dramat:2,drive:6,drive_db:6,drop:2,dry:6,dry_level:6,dsp:4,dtype:[6,7],dual:5,durat:[6,7],dynam:[3,6],e:[2,6,7],each:[6,7],easili:1,ec3:7,edu:6,effect:[3,4,6,7],either:[2,7],emul:6,enabl:3,encod:[6,7],enough:2,ensur:[0,2,4,7],entir:7,environ:4,equal:[2,3,6,7],equival:6,error:0,etc:[6,7],even:[0,3],everi:[0,4,7],exampl:[2,3,4,6,7],except:[6,7],exist:7,expand:6,expect:[6,7],expens:[2,6],experiment:[2,3],expos:4,express:6,extens:7,externalplugin:6,f:[1,7],face:1,factor:6,fade:0,fals:[2,6,7],far:7,fashion:[0,2],fast:6,faster:3,fastest:[6,7],featur:6,feeback:6,feedback:6,fewer:[4,6],fi:6,file:[1,2,3,4,6,7],file_dtyp:7,file_lik:7,filenam:[6,7],filename_or_file_lik:7,filter:[3,6],fine:[0,2],first:6,first_ten_second:7,fix:6,flac:[3,7],flag:6,flanger:6,flip:6,float32:[6,7],float64:[6,7],flush:7,fly:[3,7],folder:1,follow:[3,4,5],forc:7,format:[3,6,7],found:6,four:7,frac:6,fraction:7,frame:[1,2,7],framework:2,freeverb:6,freeze_mod:6,frequenc:6,frequent:3,from:[0,1,2,3,5,6,7],front:1,full:6,full_bandwidth:1,further:[6,7],futur:7,g:6,gain:[1,3,6],gain_db:[1,6],garbag:2,gate:6,gener:[5,6],get:6,get_audio_buff:7,get_plugin_names_for_fil:6,get_supported_read_format:7,get_supported_write_format:7,getvalu:7,gigabyt:7,gil:3,git:4,github:3,give:[2,6],given:[6,7],glibc:3,global:[2,3],gmbh:[5,6],gnu:5,goal:4,good:6,gplv2:5,gplv3:[4,5],gradio:1,gsm:6,gsmcompressor:6,gsmfullratecompressor:[3,5,6],guarante:3,guid:3,guitar:3,guitar_amp:1,guitarboard:2,ha:[0,6,7],hand:7,happen:7,hard:[6,7],harmon:6,have:[0,2,4,6,7],hear:2,heavili:3,help:3,hertz:6,hide:4,high:[2,6],higher:6,highest:6,highpassfilt:[3,6],highshelffilt:6,hood:7,horizont:6,hour:7,how:[0,6],howev:[2,6],hpf12:[1,6],hpf24:6,html:6,http:6,hug:1,hyperbol:6,hz:[6,7],i:[2,3,6,7],icorv:3,ident:[6,7],identifi:6,idiomat:4,iff:7,iir:6,iirfilt:6,implement:[4,6],importerror:6,improv:3,impuls:6,impulse_response_filenam:6,includ:[0,2,3,4,5],inclus:5,incorrectli:0,increas:[4,6,7],increment:7,index:6,indic:[6,7],infinit:6,initi:6,input:[1,2,6,7],input_arrai:6,input_lat:7,input_lvl_db:1,insert:6,insid:6,instal:[4,6,7],instanc:[1,4,6,7],instead:[3,6,7],instrument:3,int16:7,int32:7,int8:7,integ:[6,7],intel:3,intellig:3,intend:6,interact:1,interest:1,interfac:[2,4],intern:[0,3,6,7],interpret:[0,2,3],interv:2,introduc:[6,7],intuit:4,invent:6,invert:6,io:[1,2,3,6],isc:5,issu:[0,2,4],its:[6,7],itself:[2,4,6],jo:6,juce:[2,4,5],just:[0,1,2,4,7],kbp:7,kei:[1,6],keyboardinterrupt:6,kilobit:7,kind:6,known:1,kwarg:6,lab:3,ladder:6,ladderfilt:[1,3,6],lagrang:6,lame:[5,6,7],languag:2,larg:[2,7],latm:7,leak:[0,7],learn:[3,4],length:7,less:6,level:7,lfo:6,lgplv2:5,libgsm:5,libmp3lam:5,librari:[2,3,4,5,6,7],librosa:3,licens:[3,4],like:[1,6,7],limit:[1,3,6],line:[6,7],linear:[6,7],link:4,linux:[3,4,6,7],list:[1,6],liter:7,live:3,lo:6,loa:7,load:[0,1,3,4,6],load_plugin:[0,1,3,4,6],load_preset:6,loadabl:6,locat:7,lock:[2,3],logic:4,longer:7,lossi:[3,6],lot:6,loud:[3,6],low:6,lower:6,lowest:6,lowpassfilt:[3,6],lowshelffilt:6,lpf12:6,lpf24:6,m4a:7,m4b:7,m4r:7,machin:[3,4],maco:[3,4,6,7],magnitud:6,mai:[0,4,6,7],make:[2,3],makeup_db:1,mani:[0,3,6,7],manual:[2,3],manylinux:3,match:[6,7],mathemat:6,maximum:7,md:3,mean:2,meant:4,media:5,megabyt:7,memori:[2,3,6,7],mere:6,method:[6,7],midi:3,might:4,minimum:7,misbehav:0,mix:[1,6],mode:[1,6,7],model:[3,6],moder:6,modern:3,modifi:2,modul:[6,7],moog:6,more:[1,3,4,6,7],most:[0,2,3,4,6,7],mov:7,mp1:7,mp2:7,mp3:[3,6,7],mp3compressor:[3,5,6],mp4:7,mpa:7,mpeg:7,ms:6,much:[1,6],multi:[6,7],multipl:[1,2,3,6,7],multiprocess:3,music:4,must:[6,7],mutat:2,my_fil:7,name:[6,7],nativ:[6,7],ndarrai:[6,7],nearli:7,need:[3,4],nest:1,network:2,newer:5,next:0,nois:6,noiseg:6,noisi:6,non:[6,7],none:[6,7],normal:6,notabl:4,notch:6,note:[2,6,7],notebook:1,notic:0,np:7,num_channel:[2,7],num_fram:7,number:[2,3,5,6,7],numer:7,numpi:[6,7],o:[2,3,6,7],object:[1,2,6,7],obtain:7,occur:7,octav:6,off:[2,6],offlin:2,ogg:[3,7],ogg_buff:7,onc:7,one:[0,3,6,7],onli:[3,6,7],onto:6,open:[2,4,7],oper:[2,6,7],optim:7,option:[4,6,7],order:6,origin:[6,7],oscil:6,other:[0,1,3,6,7],otherwis:7,our:[1,2],out:[2,3,6,7],output:[1,2,6,7],output_lvl_db:1,over:3,overload:6,own:[5,6],packag:[4,6,7],parallel:[3,6],paramet:[1,3,6,7],parameter_valu:6,parti:[3,6],pasp:6,pass:[0,2,6,7],passthrough:1,path:[1,6,7],path_to_plugin_fil:6,paus:2,pbar:2,peak:6,peakfilt:6,pedalboard:[0,3,5],pedalboard_n:6,per:[6,7],percentag:[2,6],percentage_through_track:2,perform:4,permit:5,phaser:[1,3,6],phone:6,pip:3,pipelin:3,pitch:[1,3,6],pitchshift:[1,3,5,6],platform:[3,4,6,7],pleas:6,plug:[6,7],plugin:[3,5,6],plugin_nam:6,plugincontain:6,point:[6,7],pointer:7,polar:6,pop:2,popular:3,portabl:4,posit:7,possibl:[2,3,7],potenti:[2,7],present:6,preset:6,preset_file_path:6,pretti:1,prevent:[2,7],previou:6,print:1,prioriti:2,probabl:7,problem:7,process:[0,1,2,3,4,5,6,7],produc:6,product:3,program:[0,1,2],programm:4,progress:2,project:[2,5],properti:[6,7],provid:[4,6,7],pull:[2,5],push:7,put:1,pybind11:4,pypi:3,pysox:3,python:[0,2,3,4,6,7],q:6,qt:7,qualiti:[3,6,7],quantiz:6,question:3,quick:3,r:[1,7],rais:[6,7],ramp:2,rand:7,random:[2,7],randomli:2,rang:[2,3,6],rare:4,rate:[1,2,6,7],rate_hz:6,rather:7,ratio:[1,6],raw:[4,7],re:7,read:[1,2,3,6,7],read_raw:7,readabl:7,readableaudiofil:7,real:[3,6,7],reason:4,receiv:[2,6],reduc:6,reduct:[3,6],redund:7,regardless:7,regist:5,regular:[2,7],rel:3,releas:[3,6],release_m:[1,6],reliabl:7,reload:0,remain:[6,7],remov:[4,6],render:[0,7],repo:3,report:6,repositori:[1,4],repres:6,request:2,requir:[2,3,4,6,7],resampl:[1,3,6,7],resampled_to:[1,7],resampledreadableaudiofil:7,resampling_qu:7,reset:[2,6,7],resolut:6,reson:6,resourc:4,respect:7,respons:6,result:[2,7],reverb:[0,1,2,3,6],robust:3,roll:6,room_siz:[1,6],roughli:6,roughrider3:1,rubber:[5,6],run:[1,6],runtim:4,runtimeerror:[6,7],s:[3,4,6,7],safe:4,safeti:3,same:[1,4,6,7],sampl:[1,2,6,7],sample_r:6,sampler:[1,2,7],save:2,sc_activ:1,sc_hpf_hz:1,scan:6,sd2:7,sdk:5,second:[2,6,7],see:[1,2,6,7],seek:7,seekabl:7,self:6,semiton:[1,6],sensitivity_db:1,separ:2,seri:7,set:[0,1,2,6,7],shape:[1,2,7],shelf:6,shift:[1,6],should:[4,6,7],show:[2,4,6],show_editor:6,side:6,signal:[4,6],silenc:0,silicon:3,simpl:6,simpler:4,simplest:6,simplic:4,simul:6,simultan:1,singl:[3,6],size:[2,4,6],slightli:6,slow:[2,6],slowest:[6,7],small:2,smaller:[1,2,7],smoother:2,snd:7,so:[0,1,2,6,7],soft:2,softwar:4,some:[0,1,4,7],someth:7,somewher:2,sound:[1,6],sounddevic:2,sourc:[4,7],source_sample_r:7,soxbind:3,space:1,spatial:3,speaker:6,specif:[0,6],specifi:[6,7],speed:[2,3,4,6],spotifi:[3,5],sqrt:6,stabil:4,stage:6,standard:6,stanford:6,start:[3,7],state:[0,6,7],stefanobazzi:2,steinberg:[5,6],step:2,step_size_in_sampl:2,stereo:[6,7],still:6,store:[6,7],str:[6,7],stream:[2,3,6,7],streamresampl:7,stretch:6,string:[6,7],stringio:7,strong:3,studio:3,stutter:2,style:3,subclass:6,submodul:4,suitabl:6,suppli:7,support:[3,4,6,7],suppos:0,sweep:6,synthes:6,system:[2,6,7],t:[0,1,2,7],tail:[0,2,6],take:6,talk:2,tangent:6,tanh:6,target:7,target_sample_r:[6,7],technic:2,techniqu:[2,6],technolog:5,tell:7,tensorflow:3,test:[0,3,4],tf:3,than:[3,4,6,7],them:[1,6],themselv:1,thi:[1,2,5,6,7],thing:6,think:6,third:[3,6],thoroughli:3,thread:[2,3,4],threshold:6,threshold_db:[1,6],through:[1,2,6,7],thrown:6,time:[0,3,6,7],too:7,total:[2,7],tqdm:2,track:2,trademark:5,trail:7,transform:3,transit:2,tune:6,two:6,type:[6,7],typeerror:7,typic:7,ui:6,unavail:6,unbound:[2,7],unchang:6,under:[5,7],underli:[2,7],undesir:0,union:[6,7],uniqu:6,unit:[0,2,3,4,6],unlik:7,unsupport:[6,7],until:6,unus:[2,7],up:[2,3,6],updat:2,upgrad:5,upsampl:6,us:[3,4,5,6,7],usabl:7,usag:[3,6],user:4,usual:[2,6,7],util:[3,6],v0:7,v2:7,v3:5,v9:7,valu:[6,7],vari:2,variabl:[6,7],varieti:4,variou:6,vbr:6,vbr_qualiti:6,vendor:4,veri:2,versa:4,version:7,vertic:6,via:[1,3,6,7],vibrato:6,vice:4,volum:6,vorbi:7,vst3:[0,3,4,5,6],vst3plugin:6,vst:[1,3,5],vstpreset:6,w64:7,w:[1,2,7],wa:[3,6,7],wai:4,want:7,warn:0,wav:[1,2,3,7],wav_buff:7,waveshap:6,we:2,web:1,well:[0,3,4,6,7],were:6,wet:[2,6],wet_level:[2,6],what:6,wheel:[3,4],when:[0,2,3,4,6,7],where:4,which:[0,2,5,6,7],white_nois:7,whole:1,wide:[3,6],wider:4,width:6,window:[3,4,6,7],windowedsinc:[6,7],within:[3,4,6],without:[0,2,3,6,7],wma:[3,7],wonder:6,work:[0,3,6,7],workstat:3,worst:[0,7],would:[2,4,6,7],wrap:7,wrapper:[4,6],write:[1,2,3,6,7],writeabl:7,writeableaudiofil:7,written:[2,4,7],x86:3,x86_64:3,x:6,xhe:7,ye:2,yet:2,you:[1,3,7],your:2,zero:6,zeroorderhold:6},titles:["Plugin Compatibility","Examples","Frequently Asked Questions","Features","Pedalboard Internals","License","The pedalboard API","The pedalboard.io API"],titleterms:{"new":4,The:[6,7],accept:2,ad:4,api:[6,7],ask:2,audio:[1,2],built:4,can:2,chain:1,chang:2,compat:[0,3],consider:4,creat:1,design:4,document:3,doe:2,effect:[1,2],exampl:1,featur:3,frequent:2,guitar:1,instal:3,instead:2,instrument:2,intern:4,io:7,licens:5,live:2,make:1,midi:2,over:2,parallel:1,paramet:2,pedalboard:[1,2,4,6,7],plugin:[0,1,2,4],question:2,quick:1,real:2,refer:3,s:2,start:1,style:1,support:2,time:2,unit:1,us:[1,2],vst3:1,vst:2}}) \ No newline at end of file diff --git a/pedalboard/__init__.pyi b/pedalboard/__init__.pyi index db7b4d9b..f62494ab 100644 --- a/pedalboard/__init__.pyi +++ b/pedalboard/__init__.pyi @@ -14,6 +14,7 @@ _Shape = typing.Tuple[int, ...] __all__ = [ "Bitcrush", "Chorus", + "Clipping", "Compressor", "Convolution", "Delay", @@ -141,6 +142,21 @@ class Chorus(Plugin): """ pass +class Clipping(Plugin): + """ + A distortion plugin that adds hard distortion to the signal by clipping the signal at the provided threshold (in decibels). + """ + + def __init__(self, threshold_db: float = -6.0) -> None: ... + def __repr__(self) -> str: ... + @property + def threshold_db(self) -> float: + """ """ + @threshold_db.setter + def threshold_db(self, arg1: float) -> None: + pass + pass + class Compressor(Plugin): """ A dynamic range compressor, used to reduce the volume of loud sounds and "compress" the loudness of the signal. @@ -471,7 +487,7 @@ class MP3Compressor(Plugin): """ An MP3 compressor plugin that runs the LAME MP3 encoder in real-time to add compression artifacts to the audio stream. - Currently only supports variable bit-rate mode (VBR) and accepts a floating-point VBR quality value (between 0.0 and 12.0; lower is better). + Currently only supports variable bit-rate mode (VBR) and accepts a floating-point VBR quality value (between 0.0 and 10.0; lower is better). Note that the MP3 format only supports 32kHz, 44.1kHz, and 48kHz audio; if an unsupported sample rate is provided, an exception will be thrown at processing time. """ diff --git a/pedalboard/plugins/MP3Compressor.h b/pedalboard/plugins/MP3Compressor.h index dd5f7aa7..3145adc7 100644 --- a/pedalboard/plugins/MP3Compressor.h +++ b/pedalboard/plugins/MP3Compressor.h @@ -368,7 +368,7 @@ inline void init_mp3_compressor(py::module &m) { "An MP3 compressor plugin that runs the LAME MP3 encoder in real-time to " "add compression artifacts to the audio stream.\n\nCurrently only " "supports variable bit-rate mode (VBR) and accepts a floating-point VBR " - "quality value (between 0.0 and 12.0; lower is better).\n\nNote that the " + "quality value (between 0.0 and 10.0; lower is better).\n\nNote that the " "MP3 format only supports 32kHz, 44.1kHz, and 48kHz audio; if an " "unsupported sample rate is provided, an exception will be thrown at " "processing time.") diff --git a/pedalboard/version.py b/pedalboard/version.py index 0b4dcaa6..cc3a5207 100644 --- a/pedalboard/version.py +++ b/pedalboard/version.py @@ -17,6 +17,6 @@ MAJOR = 0 MINOR = 6 -PATCH = 1 +PATCH = 2 __version__ = "%d.%d.%d" % (MAJOR, MINOR, PATCH)