Rate.hs

module Sound.SC3.UGen.Rate ( Rate(..)
                           , rateId
                           , ar, kr, ir, dr ) where

-- | Operating rate of unit generator.
data Rate = IR | KR | AR | DR 
            deriving (Eq, Show, Enum)

instance Ord Rate where
    compare a b = compare (rate_ord a) (rate_ord b)

-- | Rate constructors.
ar, kr, ir, dr :: Rate
ar = AR
kr = KR
ir = IR
dr = DR

-- | Integer rate identifier, as required for scsynth bytecode.
rateId :: Rate -> Int
rateId = fromEnum

-- Rates as ordered for filter rate selection.
rate_ord :: Rate -> Int
rate_ord IR = 0
rate_ord KR = 1
rate_ord AR = 2
rate_ord DR = 3