Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Ulydev/wave
A LÖVE sound manager with advanced audio parsing
https://github.com/Ulydev/wave
Last synced: 3 days ago
JSON representation
A LÖVE sound manager with advanced audio parsing
- Host: GitHub
- URL: https://github.com/Ulydev/wave
- Owner: Ulydev
- License: mit
- Created: 2016-05-05T15:38:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-09T22:27:33.000Z (over 6 years ago)
- Last Synced: 2024-08-02T06:19:11.775Z (3 months ago)
- Language: Lua
- Size: 4.36 MB
- Stars: 90
- Watchers: 6
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-love2d - wave - A sound manager with audio parsing and rhythm functionalities. (Music)
README
wave
==============
wave is a LÖVE sound manager with advanced audio parsing functionalities.
Setup
----------------
```lua
local audio = require "wave" --require the library
```
Usage
----------------
Create a new source
```lua
local beep = audio:newSource("beep.wav", "static")
```
Play it
```lua
beep:play()
```
Parsing audio
----------------
wave parses audio files to get the "energy" of the song. This allows you to add visual effects that are synchronized with the music.
First, load and parse the audio, then set its intensity
```lua
music = audio:newSource("music.wav", "stream")
music:parse()
music:setIntensity(20)
```
Update it every frame
```lua
function love.update(dt)
music:update(dt)
end
```
Then, get the current energy of the song
```lua
function love.draw()
love.graphics.circle(100, 100, 100+music:getEnergy()*10)
end
```
Working with rhythm
----------------
wave lets you set the BPM of your song to add rhythm-based mechanics to your game.
Load the audio and set its BPM
```lua
music = audio:newSource("music.wav", "stream")
music:setBPM(120)
```
Set a beat callback
```lua
music:onBeat(function()
print("Beat!")
end)
```
Update the music every frame
```lua
function love.update(dt)
music:update(dt)
end
```
Smooth transitions
----------------
Both **pitch** and **volume** properties of a source can be smoothly transitioned.
Set targets
```lua
source:setPitchTarget(1.2)
source:setVolumeTarget(.5)
```
Update the source every frame
```lua
function love.update(dt)
source:update(dt)
end
```
You can also fade music in and out. When faded out, the source will pause until it's played back.
```lua
source:fadeIn()
source:fadeOut()
```
Chaining functions
----------------
**Source** objects are passed through most of the methods. This allows you to chain function calls like so:
```lua
dog = audio
:newSource("dog.wav", "static")
:setVolume(.5)
:play()
```
Methods and aliases
----------------
Create a new source
```lua
source = audio:newSource(path, type)
```
Play, pause, resume and stop a source
```lua
source:play(pitched) --if pitched == true, source will play with a slightly random pitch (useful for recurrent sounds)
source:stop()
source:pause()
source:resume()
```
Parse source
```lua
source:parse()
```
Set/get source properties
```lua
source:setBPM(bpm)
--or--
source:detectBPM() --automatic BPM detection - very experimental
source:setOffset(offset) --set beat offset (milliseconds)
source:setIntensity(intensity)
--if **force** is specified, target attribute will be reset to value
source:setPitch(pitch, force)
//-> source:getPitch()
source:setVolume(volume, force)
//-> source:getVolume()
source:setLooping(bool)
```
Set/get source target properties (will transition smoothly)
```lua
source:setTargetPitch(pitch)
//-> source:getTargetPitch()
source:setTargetVolume(volume)
//-> source:getTargetVolume()
```
Fade in/out
```lua
source:fadeIn()
source:fadeOut()
source:fade(str) --"in" or "out"
```
Get tone-shifted pitch
```lua
source:tone(offset)
//-> source:setPitch( source:tone(4) ) --shift source by 4 semitones
```
Get octave-shifted pitch
```lua
source:octave(offset)
//-> source:setPitch( source:octave(-2) ) --shift source by -2 octaves
```