Skip to content

Commit 6bf725d

Browse files
committed
Merge branch 'master' of github.com:Theodeus/tuna
2 parents bd2da11 + fcde5cd commit 6bf725d

2 files changed

Lines changed: 4 additions & 172 deletions

File tree

README.md

Lines changed: 1 addition & 169 deletions
Original file line numberDiff line numberDiff line change
@@ -42,172 +42,4 @@ Effect list:
4242
Usage
4343
====
4444

45-
Start by creating a new Tuna object like so:
46-
47-
```javascript
48-
var context = new AudioContext();
49-
var tuna = new Tuna(context);
50-
```
51-
52-
You need to pass the audio context you're using in your application. Tuna will be using it to create its effects.
53-
54-
You create a new tuna node as such:
55-
56-
```javascript
57-
var chorus = new tuna.Chorus({
58-
rate: 1.5,
59-
feedback: 0.2,
60-
delay: 0.0045,
61-
bypass: 0
62-
});
63-
```
64-
You can then connect the tuna node to native Web Audio just as you would normally:
65-
66-
```javascript
67-
var input = context.createGain();
68-
var output = context.createGain();
69-
gain.connect(chorus);
70-
chorus.connect(output);
71-
```
72-
73-
Tuna masquerades as a normal web audio node so you can
74-
seamlessly connect with AudioNodes created by the AudioContext.
75-
76-
77-
The nodes
78-
====
79-
80-
A basic chorus effect.
81-
```javascript
82-
var chorus = new tuna.Chorus({
83-
rate: 1.5, //0.01 to 8+
84-
feedback: 0.2, //0 to 1+
85-
delay: 0.0045, //0 to 1
86-
bypass: 0 //the value 1 starts the effect as bypassed, 0 or 1
87-
});
88-
```
89-
90-
A delay effect with feedback and a lowpass filter applied to the delayed signal.
91-
```javascript
92-
var delay = new tuna.Delay({
93-
feedback: 0.45, //0 to 1+
94-
delayTime: 150, //how many milliseconds should the wet signal be delayed?
95-
wetLevel: 0.25, //0 to 1+
96-
dryLevel: 1, //0 to 1+
97-
cutoff: 2000, //cutoff frequency of the built in lowpass-filter. 20 to 22050
98-
bypass: 0
99-
});
100-
```
101-
102-
A basic phaser effect.
103-
```javascript
104-
var phaser = new tuna.Phaser({
105-
rate: 1.2, //0.01 to 8 is a decent range, but higher values are possible
106-
depth: 0.3, //0 to 1
107-
feedback: 0.2, //0 to 1+
108-
stereoPhase: 30, //0 to 180
109-
baseModulationFrequency: 700, //500 to 1500
110-
bypass: 0
111-
});
112-
```
113-
114-
A basic overdrive effect.
115-
```javascript
116-
var overdrive = new tuna.Overdrive({
117-
outputGain: 0.5, //0 to 1+
118-
drive: 0.7, //0 to 1
119-
curveAmount: 1, //0 to 1
120-
algorithmIndex: 0, //0 to 5, selects one of our drive algorithms
121-
bypass: 0
122-
});
123-
```
124-
125-
A compressor with the option to use automatic makeup gain.
126-
```javascript
127-
var compressor = new tuna.Compressor({
128-
threshold: 0.5, //-100 to 0
129-
makeupGain: 1, //0 and up
130-
attack: 1, //0 to 1000
131-
release: 0, //0 to 3000
132-
ratio: 4, //1 to 20
133-
knee: 5, //0 to 40
134-
automakeup: true, //true/false
135-
bypass: 0
136-
});
137-
```
138-
139-
A convolver with high- and lowcut. You can find a lot of impulse resonses <a href="http://chromium.googlecode.com/svn/trunk/samples/audio/impulse-responses/">here</a>, or by searching for "free impulse response files".
140-
```javascript
141-
var convolver = new tuna.Convolver({
142-
highCut: 22050, //20 to 22050
143-
lowCut: 20, //20 to 22050
144-
dryLevel: 1, //0 to 1+
145-
wetLevel: 1, //0 to 1+
146-
level: 1, //0 to 1+, adjusts total output of both wet and dry
147-
impulse: "impulses/impulse_rev.wav", //the path to your impulse response
148-
bypass: 0
149-
});
150-
```
151-
152-
A basic filter.
153-
```javascript
154-
var filter = new tuna.Filter({
155-
frequency: 440, //20 to 22050
156-
Q: 1, //0.001 to 100
157-
gain: 0, //-40 to 40
158-
filterType: "lowpass", //lowpass, highpass, bandpass, lowshelf, highshelf, peaking, notch, allpass
159-
bypass: 0
160-
});
161-
```
162-
163-
A cabinet/speaker emulator.
164-
```javascript
165-
var cabinet = new tuna.Cabinet({
166-
makeupGain: 1, //0 to 20
167-
impulsePath: "impulses/impulse_guitar.wav", //path to your speaker impulse
168-
bypass: 0
169-
});
170-
```
171-
172-
A basic tremolo.
173-
```javascript
174-
var tremolo = new tuna.Tremolo({
175-
intensity: 0.3, //0 to 1
176-
rate: 4, //0.001 to 8
177-
stereoPhase: 0, //0 to 180
178-
bypass: 0
179-
});
180-
```
181-
182-
A wahwah with an auto wah option.
183-
```javascript
184-
var wahwah = new tuna.WahWah({
185-
automode: true, //true/false
186-
baseFrequency: 0.5, //0 to 1
187-
excursionOctaves: 2, //1 to 6
188-
sweep: 0.2, //0 to 1
189-
resonance: 10, //1 to 100
190-
sensitivity: 0.5, //-1 to 1
191-
bypass: 0
192-
});
193-
```
194-
195-
A lo-fi bitcrusher effect.
196-
197-
```javascript
198-
var bitcrusher = new tuna.Bitcrusher({
199-
bits: 4, //1 to 16
200-
normfreq: 0.1, //0 to 1
201-
bufferSize: 4096 //256 to 16384
202-
});
203-
```
204-
205-
A resonant, analog-sounding filter.
206-
207-
```javascript
208-
var moog = new tuna.MoogFilter({
209-
cutoff: 0.065, //0 to 1
210-
resonance: 3.5, //0 to 4
211-
bufferSize: 4096 //256 to 16384
212-
});
213-
```
45+
Check the wiki: https://github.com/Theodeus/tuna/wiki

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
},
1313
"repository": {
1414
"type": "git",
15-
"url": "git+https://github.com/Dinahmoe/tuna.git"
15+
"url": "git+https://github.com/Theodeus/tuna.git"
1616
},
1717
"keywords": [
1818
"web audio",
@@ -24,9 +24,9 @@
2424
"author": "Oskar Eriksson",
2525
"license": "MIT",
2626
"bugs": {
27-
"url": "https://github.com/Dinahmoe/tuna/issues"
27+
"url": "https://github.com/Theodeus/tuna/issues"
2828
},
29-
"homepage": "https://github.com/Dinahmoe/tuna#readme",
29+
"homepage": "https://github.com/Theodeus/tuna#readme",
3030
"devDependencies": {
3131
"uglify": "^0.1.5"
3232
}

0 commit comments

Comments
 (0)