License	BSD(see LICENSE file)
Maintainer	Nicholas Shaheed
Stability	Alpha
Safe Haskell	None
Language	Haskell2010

Web.Audio

Contents

Set-Up
Connecting nodes, params, and the audio context
Data Types
Procedures
- Instantiation functions
- Other Procedures
Playback control
- OscillatorNode specific playback controls
- Disconnecting functions
Change AudioParam value

Description

wahsp (Web Audio HaSkell Protocol) is a binding for Haskell to the Web Audio API ala blank-canvas. Audio sources, effects, etc. can be combined, manipulated, and otherwise controlled using haskell and are then rendered in the the browser (see the above link for browser compatibility).

Synopsis

Set-Up

webAudio :: WAOptions -> (Document -> IO ()) -> IO () Source #

webAudio is the starting point for connecting and interacting with the API. A simple example of how to use this is:

 module Main where
 import Web.Audio
 
 main :: IO ()
 main = do
   webAudio 3000 $ \doc -> do
     send doc $ do
       osc1  <- createOscillator 200 0 Sine -- create an OscillatorNode
       gain1 <- createGain 0.5              -- create a GainNode
 
       connect $ osc1 .|. gain1 .||. eCtx   -- connect these nodes together, and then connect them to the audio context
 
       start osc1 -- make sounds!

When running, go to http://localhost:3000/ in a browser to hear a 200Hz sine wave!

More examples can be found here.

data WAOptions Source #

Various options when sending info to the browser

Constructors

WAOptions
Fields port :: Int which port to send to events :: [Int] not implemented yet debug :: Bool turns on debugging, defaults to `False` root :: String location of static files weak :: Bool not implemented yet

Instances

Num WAOptions Source #
Methods (+) :: WAOptions -> WAOptions -> WAOptions # (-) :: WAOptions -> WAOptions -> WAOptions # (*) :: WAOptions -> WAOptions -> WAOptions # negate :: WAOptions -> WAOptions # abs :: WAOptions -> WAOptions # signum :: WAOptions -> WAOptions # fromInteger :: Integer -> WAOptions #

send :: Document -> WebAudio a -> IO a Source #

Connecting nodes, params, and the audio context

The Web Audio API is comprised of nodes (AudioNodes, AudioParams, and the AudioContext) that are connected, input to output, to form a chain comprised of sources, effects, and a destination.

This chain is typically organized as a source -> effects -> destination, where destination is either the AudioContext (if you actually want to produce sound in this chain), some AudioParam (if you want to control a param with an audio signal, e.g. a low-frequency oscillator (lfo)), or some AudioNode.

To chain together AudioNodes and AudioParams, use .|. and end the chain with .||. For example:

osc1  <- createOscillator 200 0 Sine
gain1 <- createGain 0.5

connect $ osc1 .|. gain1 .||. eCtx
start osc1

See the official docs for a more detailed overview.

connect :: AudioGraph AudNode b -> WebAudio () Source #

Connects the AudioGraph chain (made by connecting AudioNodes, AudioParams, and AudioContexts with .|. and .||.)

(.|.) :: forall b a. AudioNode a => a -> AudioGraph AudNode b -> AudioGraph AudNode b infix 7 Source #

Connect the front of the chain of nodes together, end the chain with .||.

(.||.) :: forall b a. AudioNode a => a -> AudioGraph AudNode b -> AudioGraph AudNode b infix 8 Source #

End the chain of AudioNodes.

To end the chain at the audio context:

connect $ osc1 .|. gain1 .||. eCtx

To end with an AudioParam (that is located in the AudioNode gain1):

connect $ osc1 .|. gain1 .||. eParam (gain gain1)

To end with the AudioNode gain1:

connect $ osc1 .|. gain1 .||. eNode gain1

connector :: forall b a. AudioNode a => a -> AudioGraph AudNode b -> AudioGraph AudNode b Source #

function implementation of .|.

connectorLast :: forall b a. AudioNode a => a -> AudioGraph AudNode b -> AudioGraph AudNode b Source #

function implementation of .||.

eNode :: AudioNode a => a -> AudioGraph AudNode AudNode Source #

Set the ending node to an AudioNode

eParam :: AudioParam -> AudioGraph AudNode AudioParam Source #

Set the ending node to an AudioParam

eCtx :: AudioGraph AudNode AudioContext Source #

Set the ending node to the AudioContext

Data Types

newtype WebAudio a Source #

Contains the commands and procedures to be sent to the web browser

Constructors

WebAudio (RemoteMonad Command Procedure a)

Instances

Monad WebAudio Source #
Methods (>>=) :: WebAudio a -> (a -> WebAudio b) -> WebAudio b # (>>) :: WebAudio a -> WebAudio b -> WebAudio b # return :: a -> WebAudio a # fail :: String -> WebAudio a #
Functor WebAudio Source #
Methods fmap :: (a -> b) -> WebAudio a -> WebAudio b # (<$) :: a -> WebAudio b -> WebAudio a #
Applicative WebAudio Source #
Methods pure :: a -> WebAudio a # (<>) :: WebAudio (a -> b) -> WebAudio a -> WebAudio b # (>) :: WebAudio a -> WebAudio b -> WebAudio b # (<*) :: WebAudio a -> WebAudio b -> WebAudio a #
Semigroup a => Semigroup (WebAudio a) Source #
Methods (<>) :: WebAudio a -> WebAudio a -> WebAudio a # sconcat :: NonEmpty (WebAudio a) -> WebAudio a # stimes :: Integral b => b -> WebAudio a -> WebAudio a #
Monoid a => Monoid (WebAudio a) Source #
Methods mempty :: WebAudio a # mappend :: WebAudio a -> WebAudio a -> WebAudio a # mconcat :: [WebAudio a] -> WebAudio a #

class JSArg a => AudioNode a where Source #

And AudioNode is an interface for any audio processing module in the Web Audio API

Minimal complete definition

numberOfInputs, numberOfOutputs, channelCount, channelCountMode, channelInterpretation

Methods

numberOfInputs :: a -> Int Source #

numberOfOutputs :: a -> Int Source #

channelCount :: a -> Int Source #

channelCountMode :: a -> ChannelCountMode Source #

channelInterpretation :: a -> ChannelInterpretation Source #

Instances

AudioNode OscillatorNode Source #	Instantizes OscillatorNode with the default values
Methods numberOfInputs :: OscillatorNode -> Int Source # numberOfOutputs :: OscillatorNode -> Int Source # channelCount :: OscillatorNode -> Int Source # channelCountMode :: OscillatorNode -> ChannelCountMode Source # channelInterpretation :: OscillatorNode -> ChannelInterpretation Source #
AudioNode GainNode Source #
Methods numberOfInputs :: GainNode -> Int Source # numberOfOutputs :: GainNode -> Int Source # channelCount :: GainNode -> Int Source # channelCountMode :: GainNode -> ChannelCountMode Source # channelInterpretation :: GainNode -> ChannelInterpretation Source #

data OscillatorNode Source #

OscillatorNode represents a periodic waveform with a frequency (in hertz), detuning (in cents), an OscillatorNodeType (e.g. a sine wave, square wave, etc.), etc.

Constructors

OscillatorNode

Fields

indexOsc :: !Int
Index in javascript, for internal use
frequencyOsc :: !AudioParam
the frequency of this oscilaltor
detuneOsc :: !AudioParam
how many cents the frequencyOsc is detuned by
typeOsc :: !OscillatorNodeType
periodic wave type
numberOfInputsOsc :: !Int
number of inputs
numberOfOutputsOsc :: !Int
number of outputs
channelCountOsc :: !Int
number of channels used when up-mixing and down-mixing
channelCountModeOsc :: !ChannelCountMode
The ChannelCountMode of this oscillator
channelInterpretationOsc :: !ChannelInterpretation
The ChannelInterpretation of this oscilaltor

Instances

Eq OscillatorNode Source #
Methods (==) :: OscillatorNode -> OscillatorNode -> Bool # (/=) :: OscillatorNode -> OscillatorNode -> Bool #
Read OscillatorNode Source #
Methods readsPrec :: Int -> ReadS OscillatorNode # readList :: ReadS [OscillatorNode] # readPrec :: ReadPrec OscillatorNode # readListPrec :: ReadPrec [OscillatorNode] #
Show OscillatorNode Source #
Methods showsPrec :: Int -> OscillatorNode -> ShowS # show :: OscillatorNode -> String # showList :: [OscillatorNode] -> ShowS #
JSArg OscillatorNode Source #
Methods showtJS :: OscillatorNode -> Text Source #
AudioNode OscillatorNode Source #	Instantizes OscillatorNode with the default values
Methods numberOfInputs :: OscillatorNode -> Int Source # numberOfOutputs :: OscillatorNode -> Int Source # channelCount :: OscillatorNode -> Int Source # channelCountMode :: OscillatorNode -> ChannelCountMode Source # channelInterpretation :: OscillatorNode -> ChannelInterpretation Source #

data OscillatorNodeType Source #

Constructors

Sine
Square
Sawtooth
Triangle
Custom

Instances

Eq OscillatorNodeType Source #
Methods (==) :: OscillatorNodeType -> OscillatorNodeType -> Bool # (/=) :: OscillatorNodeType -> OscillatorNodeType -> Bool #
Read OscillatorNodeType Source #
Methods readsPrec :: Int -> ReadS OscillatorNodeType # readList :: ReadS [OscillatorNodeType] # readPrec :: ReadPrec OscillatorNodeType # readListPrec :: ReadPrec [OscillatorNodeType] #
Show OscillatorNodeType Source #
Methods showsPrec :: Int -> OscillatorNodeType -> ShowS # show :: OscillatorNodeType -> String # showList :: [OscillatorNodeType] -> ShowS #
FromJSON OscillatorNodeType Source #
Methods parseJSON :: Value -> Parser OscillatorNodeType # parseJSONList :: Value -> Parser [OscillatorNodeType] #

data GainNode Source #

Constructors

GainNode
Fields indexGain :: !Int gain :: !AudioParam numberOfInputsGain :: !Int numberOfOutputsGain :: !Int channelCountGain :: !Int channelCountModeGain :: !ChannelCountMode channelInterpretationGain :: !ChannelInterpretation

Instances

Eq GainNode Source #
Methods (==) :: GainNode -> GainNode -> Bool # (/=) :: GainNode -> GainNode -> Bool #
Read GainNode Source #
Methods readsPrec :: Int -> ReadS GainNode # readList :: ReadS [GainNode] # readPrec :: ReadPrec GainNode # readListPrec :: ReadPrec [GainNode] #
Show GainNode Source #
Methods showsPrec :: Int -> GainNode -> ShowS # show :: GainNode -> String # showList :: [GainNode] -> ShowS #
JSArg GainNode Source #
Methods showtJS :: GainNode -> Text Source #
AudioNode GainNode Source #
Methods numberOfInputs :: GainNode -> Int Source # numberOfOutputs :: GainNode -> Int Source # channelCount :: GainNode -> Int Source # channelCountMode :: GainNode -> ChannelCountMode Source # channelInterpretation :: GainNode -> ChannelInterpretation Source #

data AudioParam Source #

Constructors

AudioParam AudioParamType Int

Instances

Eq AudioParam Source #
Methods (==) :: AudioParam -> AudioParam -> Bool # (/=) :: AudioParam -> AudioParam -> Bool #
Read AudioParam Source #
Methods readsPrec :: Int -> ReadS AudioParam # readList :: ReadS [AudioParam] # readPrec :: ReadPrec AudioParam # readListPrec :: ReadPrec [AudioParam] #
Show AudioParam Source #
Methods showsPrec :: Int -> AudioParam -> ShowS # show :: AudioParam -> String # showList :: [AudioParam] -> ShowS #
FromJSON AudioParam Source #
Methods parseJSON :: Value -> Parser AudioParam # parseJSONList :: Value -> Parser [AudioParam] #
JSArg AudioParam Source #
Methods showtJS :: AudioParam -> Text Source #

data ChannelCountMode :: * where Source #

How channels will be matched between connected inputs and output. Detailed description.

Constructors

Max :: ChannelCountMode
ClampedMax :: ChannelCountMode
Explicit :: ChannelCountMode

Instances

Eq ChannelCountMode Source #
Methods (==) :: ChannelCountMode -> ChannelCountMode -> Bool # (/=) :: ChannelCountMode -> ChannelCountMode -> Bool #
Read ChannelCountMode Source #
Methods readsPrec :: Int -> ReadS ChannelCountMode # readList :: ReadS [ChannelCountMode] # readPrec :: ReadPrec ChannelCountMode # readListPrec :: ReadPrec [ChannelCountMode] #
Show ChannelCountMode Source #
Methods showsPrec :: Int -> ChannelCountMode -> ShowS # show :: ChannelCountMode -> String # showList :: [ChannelCountMode] -> ShowS #
FromJSON ChannelCountMode Source #
Methods parseJSON :: Value -> Parser ChannelCountMode # parseJSONList :: Value -> Parser [ChannelCountMode] #

data AudioParamType Source #

Which type of AudioParam

Constructors

Gain
Frequency
Detune

Instances

Eq AudioParamType Source #
Methods (==) :: AudioParamType -> AudioParamType -> Bool # (/=) :: AudioParamType -> AudioParamType -> Bool #
Read AudioParamType Source #
Methods readsPrec :: Int -> ReadS AudioParamType # readList :: ReadS [AudioParamType] # readPrec :: ReadPrec AudioParamType # readListPrec :: ReadPrec [AudioParamType] #
Show AudioParamType Source #
Methods showsPrec :: Int -> AudioParamType -> ShowS # show :: AudioParamType -> String # showList :: [AudioParamType] -> ShowS #