scripts/filt.lua

   1 ardour {
   2         ["type"]    = "dsp",
   3         name        = "Biquad Filter",
   4         category    = "Filter",
   5         license     = "MIT",
   6         author      = "Robin Gareus",
   7         email       = "robin@gareus.org",
   8         site        = "http://gareus.org",
   9         description = [[Example Ardour Lua DSP Plugin]]
  10 }
  11
  12 function dsp_ioconfig ()
  13         return
  14         {
  15                 -- allow any number of I/O as long as port-count matches
  16                 { audio_in = -1, audio_out = -1},
  17         }
  18 end
  19
  20
  21 function dsp_params ()
  22         return
  23         {
  24                 { ["type"] = "input", name = "Type", min = 0, max = 4, default = 0, enum = true, scalepoints =
  25                         {
  26                                 ["Peaking"]    = 0,
  27                                 ["Low Shelf"]  = 1,
  28                                 ["High Shelf"] = 2,
  29                                 ["Low Pass"]   = 3,
  30                                 ["High Pass"]  = 4,
  31                         }
  32                 },
  33                 { ["type"] = "input", name = "Gain", min = -20, max = 20,    default = 0,    unit="dB" },
  34                 { ["type"] = "input", name = "Freq", min =  20, max = 20000, default = 1000, unit="Hz", logarithmic = true },
  35                 { ["type"] = "input", name = "Q",    min = 0.1, max = 8,     default = .707, logarithmic = true },
  36         }
  37 end
  38
  39 -- translate type parameter to DSP enum
  40 -- http://manual.ardour.org/lua-scripting/class_reference/#ARDOUR.DSP.Biquad.Type
  41 function map_type (t)
  42         if     t == 1 then
  43                 return ARDOUR.DSP.BiquadType.LowShelf
  44         elseif t == 2 then
  45                 return ARDOUR.DSP.BiquadType.HighShelf
  46         elseif t == 3 then
  47                 return ARDOUR.DSP.BiquadType.LowPass
  48         elseif t == 4 then
  49                 return ARDOUR.DSP.BiquadType.HighPass
  50         else
  51                 return ARDOUR.DSP.BiquadType.Peaking
  52         end
  53 end
  54
  55 -- these globals are *not* shared between DSP and UI
  56 local filt -- the biquad filter instance
  57 local cur = {0, 0, 0, 0} -- current parameters
  58 local lpf = 0.03 -- parameter low-pass filter time-constant
  59
  60 function dsp_init (rate)
  61         self:shmem ():allocate (1) -- shared mem to tell the GUI the samplerate
  62         local cfg = self:shmem ():to_int (0):array ()
  63         cfg[1] = rate
  64         -- http://manual.ardour.org/lua-scripting/class_reference/#ARDOUR:DSP:Biquad
  65         filt = ARDOUR.DSP.Biquad (rate) -- initialize filter
  66         lpf = 13000 / rate -- interpolation time constant
  67 end
  68
  69 -- helper functions for parameter interpolation
  70 function param_changed (ctrl)
  71         if ctrl[1] == cur[1] and ctrl[2] == cur[2] and ctrl[3] == cur[3] and ctrl[4] == cur[4] then
  72                 return false
  73         end
  74         return true
  75 end
  76
  77 function low_pass_filter_param (old, new, limit)
  78         if math.abs (old - new) < limit  then
  79                 return new
  80         else
  81                 return old + lpf * (new - old)
  82         end
  83 end
  84
  85 -- apply parameters, re-compute filter coefficients if needed
  86 function apply_params (ctrl)
  87         if not param_changed (ctrl) then
  88                 return
  89         end
  90
  91         if cur[1] ~= ctrl[1] then
  92                 -- reset filter state when type changes
  93                 filt:reset ()
  94                 for k = 1,4 do cur[k] = ctrl[k] end
  95         else
  96                 -- low-pass filter ctrl parameter values, smooth transition
  97                 cur[2] = low_pass_filter_param (cur[2], ctrl[2], 0.1) -- gain/dB
  98                 cur[3] = low_pass_filter_param (cur[3], ctrl[3], 1.0) -- freq/Hz
  99                 cur[4] = low_pass_filter_param (cur[4], ctrl[4], 0.01) -- quality
 100         end
 101
 102         filt:compute (map_type (cur[1]), cur[3], cur[4], cur[2])
 103 end
 104
 105
 106 -- the actual DSP callback
 107 function dsp_run (ins, outs, n_samples)
 108         local changed = false
 109         local siz = n_samples
 110         local off = 0
 111
 112         -- if a parameter was changed, process at most 64 samples at a time
 113         -- and interpolate parameters until the current settings match
 114         -- the target values
 115         if param_changed (CtrlPorts:array ()) then
 116                 changed = true
 117                 siz = 64
 118         end
 119
 120         while n_samples > 0 do
 121                 if changed then apply_params (CtrlPorts:array ()) end
 122                 if siz > n_samples then siz = n_samples end
 123
 124                 -- process all channels
 125                 for c = 1,#ins do
 126                         -- check if output and input buffers for this channel are identical
 127                         -- http://manual.ardour.org/lua-scripting/class_reference/#C:FloatArray
 128                         if ins[c]:sameinstance (outs[c]) then
 129                                 filt:run (ins[c]:offset (off), siz) -- in-place processing
 130                         else
 131                                 -- http://manual.ardour.org/lua-scripting/class_reference/#ARDOUR:DSP
 132                                 ARDOUR.DSP.copy_vector (outs[c]:offset (off), ins[c]:offset (off), siz)
 133                                 filt:run (outs[c]:offset (off), siz)
 134                         end
 135                 end
 136
 137                 n_samples = n_samples - siz
 138                 off = off + siz
 139         end
 140
 141         if changed then
 142                 -- notify display
 143                 self:queue_draw ()
 144         end
 145 end
 146
 147
 148 -------------------------------------------------------------------------------
 149 --- inline display
 150
 151 function round (n)
 152         return math.floor (n + .5)
 153 end
 154
 155 function freq_at_x (x, w)
 156         -- x-axis pixel for given freq, power-scale
 157         return 20 * 1000 ^ (x / w)
 158 end
 159
 160 function x_at_freq (f, w)
 161         -- frequency at given x-axis pixel
 162         return w * math.log (f / 20.0) / math.log (1000.0)
 163 end
 164
 165 function db_to_y (db, h)
 166         -- y-axis gain mapping
 167         if db < -20 then db = -20 end
 168         if db >  20 then db =  20 end
 169         return -.5 + 0.5 * h * (1 - db / 20)
 170 end
 171
 172 function grid_db (ctx, w, h, db)
 173         -- draw horizontal grid line
 174         local y = -.5 + round (db_to_y (db, h))
 175         ctx:move_to (0, y)
 176         ctx:line_to (w, y)
 177         ctx:stroke ()
 178 end
 179
 180 function grid_freq (ctx, w, h, f)
 181         -- draw vertical grid line
 182         local x = -.5 + round (x_at_freq (f, w))
 183         ctx:move_to (x, 0)
 184         ctx:line_to (x, h)
 185         ctx:stroke ()
 186 end
 187
 188 function render_inline (ctx, w, max_h)
 189         if not filt then
 190                 -- the GUI is separate from the DSP, but the GUI needs to know
 191                 -- the sample-rate that the DSP is using.
 192                 local shmem = self:shmem () -- get shared memory region
 193                 local cfg = shmem:to_int (0):array () -- "cast" into lua-table
 194                 -- instantiate filter (to calculate the transfer function's response)
 195                 filt = ARDOUR.DSP.Biquad (cfg[1])
 196         end
 197
 198         -- set filter coefficients if they have changed
 199         if param_changed (CtrlPorts:array ()) then
 200                 local ctrl = CtrlPorts:array ()
 201                 for k = 1,4 do cur[k] = ctrl[k] end
 202                 filt:compute (map_type (cur[1]), cur[3], cur[4], cur[2])
 203         end
 204
 205         -- calc height of inline display
 206         local h = math.ceil (w * 10 / 16) -- use 16:10 aspect
 207         h = 2 * round (h / 2) -- with an even number of vertical pixels
 208         if (h > max_h) then h = max_h end -- but at most max-height
 209
 210         -- ctx is a http://cairographics.org/ context
 211         -- http://manual.ardour.org/lua-scripting/class_reference/#Cairo:Context
 212
 213         -- clear background
 214         ctx:rectangle (0, 0, w, h)
 215         ctx:set_source_rgba (.2, .2, .2, 1.0)
 216         ctx:fill ()
 217
 218         -- set line width: 1px
 219         -- Note: a cairo pixel at [1,1]  spans [0.5->1.5 , 0.5->1.5]
 220         -- hence the offset -0.5 in various move_to(), line_to() calls
 221         ctx:set_line_width (1.0)
 222
 223         -- draw grid
 224         local dash3 = C.DoubleVector ()
 225         dash3:add ({1, 3})
 226         ctx:set_dash (dash3, 2) -- dotted line
 227         ctx:set_source_rgba (.5, .5, .5, .5)
 228         grid_db (ctx, w, h, 0)
 229         grid_db (ctx, w, h, 6)
 230         grid_db (ctx, w, h, 12)
 231         grid_db (ctx, w, h, 18)
 232         grid_db (ctx, w, h, -6)
 233         grid_db (ctx, w, h, -12)
 234         grid_db (ctx, w, h, -18)
 235         grid_freq (ctx, w, h, 100)
 236         grid_freq (ctx, w, h, 1000)
 237         grid_freq (ctx, w, h, 10000)
 238         ctx:unset_dash ()
 239
 240         -- draw transfer function line
 241         ctx:set_source_rgba (.8, .8, .8, 1.0)
 242         ctx:move_to (-.5, db_to_y (filt:dB_at_freq (freq_at_x (0, w)), h))
 243         for x = 1,w do
 244                 local db = filt:dB_at_freq (freq_at_x (x, w))
 245                 ctx:line_to (-.5 + x, db_to_y (db, h))
 246         end
 247         ctx:stroke_preserve ()
 248
 249         -- fill area to zero under the curve
 250         ctx:line_to (w, -.5 + h * .5)
 251         ctx:line_to (0, -.5 + h * .5)
 252         ctx:close_path ()
 253         ctx:set_source_rgba (.5, .5, .5, .5)
 254         ctx:fill ()
 255
 256         return {w, h}
 257 end