perception.lua

--- percpetion v0.7 @fellowfinch
--- llllllll.co/t/url
---
--- ▼▼▼ instructions below ▼▼▼
---
--- "There is no fundamental 
--- difference between man and 
--- animals in their ability to
--- feel pleasure and pain,
--- happiness, and misery." 
-- - Charles Darwin
---
--- record or load samples and
--- experience them through
--- the world of animals
---
--- E1 change the species 
--- E2 volume
--- E3 fine tune
--- K1 shift
--- K2 start/stop
--- K3 flip
--- K1 + K2 record
--- K1 + K2 clear buffer



-- TO DO: record loop greater than what it is shown -- what do you mean excactly and by how much? ff. now its set to 6 seconds by default, I kinda want it to be for as long as it is recording (like in wrms or cranes)
-- DONE: make the CFF value change with moving the rate in params ff, awesome! will try to connect it to the main screan as well. 
-- TO DO: flip should stay on when we from one animal to the other unless bat physics see setRate proposition. also why bat physics? that sets pan no?...ff. yes, bats make pretty cool menouvers when foraging, and I just found it to be quite a nice little way of describing it 
-- TO DO: hearing range dry wet, should jump from one to the other when yes or no (i'd ditch the dry/wet params then) ff...good calL, I purged those motherfuckers

-- vars
current_animal = 8
MAX_BUFFER = 350
sample_voice = 4
rec_voice = 1
sample_level = 0.5
detune_semi = 0
detune_cent = 0
sample_is_planted = false
pos = 1
rec = 0
play = 1
pre = 0.8
k1_pressed = false
k3_pressed = false
f_engage = false
pre_level = 1
voice_level = 0.7
loop_end = 6
loop_start = 0.1
last_pre_level = 1


-- init
function init()
  audio.level_adc_cut(1)
  audio.level_tape_cut(0)
  softcut.buffer_clear()
  
  --smpl
  softcut.enable(sample_voice, 1) 
  softcut.buffer(sample_voice, 2)
  softcut.level(sample_voice, 0.5)
  softcut.pan_slew_time(sample_voice, 1)
  softcut.rate(sample_voice, 1)
  softcut.loop(sample_voice, 1)
  softcut.loop_start(sample_voice, 1)
  softcut.loop_end(sample_voice, MAX_BUFFER)
  softcut.position(sample_voice, 1)
  softcut.rate_slew_time(sample_voice, 4)
  softcut.play(sample_voice, 1)
  softcut.rec(sample_voice, 0)
  softcut.fade_time(sample_voice, 0.5)
  
  --rec buffer
  softcut.enable(rec_voice,1)
  softcut.buffer(rec_voice,1)
  softcut.level_input_cut(1,rec_voice,1.0)
  softcut.level_input_cut(2,rec_voice,1.0)
  softcut.level(rec_voice,1.0)
  softcut.pan_slew_time(rec_voice, 1)
  softcut.rate(rec_voice,1.0)
  softcut.position(rec_voice,1)
  softcut.loop(rec_voice,1)
  softcut.loop_start(rec_voice,loop_start)
  softcut.loop_end(rec_voice, loop_end)
  softcut.fade_time(rec_voice, 0.5)
  softcut.rate_slew_time(rec_voice, 5)
  softcut.play(rec_voice, 1)
  softcut.rec(rec_voice, 1)
  softcut.rec_level(rec_voice,0)
  softcut.pre_level(rec_voice, pre_level) 
        
--params
  params:add_separator("rec_params", "Recording")
  
  params:add_control("rec_level", "rec level", controlspec.new(0, 1, 'lin', 0, 1), function(param) return (round_form(util.linlin(0, 1, 0, 100, param:get()), 1, "%")) end)
  params:set_action("rec_level", function(val) rec_level = val set_rec() end)
  
  params:add_control("pre_level", "feedback", controlspec.new(0, 1, 'lin', 0, pre_level), function(param) return (round_form(util.linlin(0, 1, 0, 100, param:get()), 1, "%")) end)
  params:set_action("pre_level", function(val) pre_level = val set_rec() end)
  
  params:add_control("voice_level", "volume", controlspec.new(0, 1, 'lin', 0, voice_level), function(param) return (round_form(util.linlin(0, 1, 0, 100, param:get()), 1, "%")) end)
  params:set_action("voice_level", function(val) voice_level = val set_rec() end)
  
  params:add_control("loop_start", "loop start", controlspec.new(0, 20, 'lin', 0.001, 0, "s"))
  params:set_action("loop_start", function(val) softcut.loop_start(1, val) end)

  params:add_control("loop_end", "loop end", controlspec.new(0, 20, 'lin', 0.001, 6, "s"))
  params:set_action("loop_end", function(val) softcut.loop_end(1, val) local loop_start_max = val - 0.001
  params:set("loop_start", util.clamp(params:get("loop_start"), 0, loop_start_max)) end)

  params:add_control("rec_rate_slew_time", "slew", controlspec.new(0, 10, 'lin', 0.1, 5, "s"))
  params:set_action("rec_rate_slew_time", function(val) softcut.rate_slew_time(1, val) end)
  
  params:add_separator("freq_params", "Hearing Range")
  params:add_option("freq_view", "implement?", {"No", "Yes"}, 1)
  params:set_action("freq_view", function(view_state) updateFreqView(view_state) end)
  
  
  -- PARAMS TRASH!!!
  -- do you really want to keep this? because you'll be overriding anything set by hearing range.
  -- probably will ditch it yes
  -- params:add_control("post_filter_dry", "dry", controlspec.new(0, 1, 'lin', 0.01, 1))
  -- params:set_action("post_filter_dry", function(val) softcut.post_filter_dry(sample_voice, val) softcut.post_filter_dry(rec_voice, val) end)

  -- -- do you really want to keep this? because you'll be overriding anything set by hearing range.
  -- params:add_control("post_filter_wet", "wet", controlspec.new(0, 1, 'lin', 0.01, 1))
  -- params:set_action("post_filter_wet", function(val) softcut.post_filter_bp(sample_voice, val) softcut.post_filter_bp(rec_voice, val) end)
  
  params:add_separator("fine_tune", "Fine Tune")
  
  -- need separate variables for semi and cent. otherwise one overrides the other. ff, aha gotcha!
  params:add_number("detune_semitones", "semitones", -12, 12, 0, function(param) return round_form(param:get(), 1, "st") end)
  params:set_action("detune_semitones", function(semi) detune_semi = semi / 12 setRate(animal_tab[current_animal].cff) end)

  params:add_number("detune", "cents", -600, 600, 0, function(param) return (round_form(param:get(), 1, "cents")) end)
  params:set_action("detune", function(cent) detune_cent = cent / 1200 setRate(animal_tab[current_animal].cff) end)

  -- fixed now displaying correctly
  params:add{type = "text", id = "cff_display", name = "CFF/DETUNED"}
  
  params:add_separator("chaos_playground", "CHAOS PLAYGROUND")
  
  params:add_separator("skin_walker", "Yee Naaldlooshii")
  params:add_option("shape_shifter", "Summon?", {"no", "yes"}, 1)
  params:set_action("shape_shifter", function(mode) shape_shifter_state = mode == 2 and true or false end)
  params:add_control("shape_shifter_interval", "shapeshifts every...", controlspec.new(1, 60, "lin", 1, 6, "s")) 
  params:set_action("shape_shifter_interval", function(value) shape_shifter_time = value end)
  
  params:add_separator("bats", "Bats!")
  params:add_option("panning_shifter", "Bat Physics", {"off", "on"}, 1)
  params:set_action("panning_shifter", function(mode) pan_shifter_state = mode == 2 and true or false end)
  params:add_control("panning_shifter_interval", "swoop every...", controlspec.new(1, 60, "lin", 1, 1, "s"))
  params:set_action("panning_shifter_interval", function(value) pan_shifter_time = value end)
  params:add_control("panning_slew", "aeroBATics", controlspec.new(0, 10, 'lin', 0.1, 5, "s"))
  params:set_action("panning_slew", function(val) softcut.pan_slew_time(1, val) end)
  
  params:add_separator("time_machine", "Time Machine")
  params:add_option("rate_shifter", "Use fancy quantum?", {"no", "yes"}, 1)
  params:set_action("rate_shifter", function(mode) rate_shifter_state = mode == 2 and true or false end)
  params:add_control("rate_shifter_interval", "travel every...", controlspec.new(1, 60, "lin", 1, 6, "s"))
  params:set_action("rate_shifter_interval", function(value) rate_shifter_time = value end)
  
  params:add_separator("sample_params", "Sample")
  
  params:add_file("load_sample", "> select sample", "")
  params:set_action("load_sample", function(path) load_audio(path) end)
  
  params:add_control("sample_level", "intensity", controlspec.new(0, 1, 'lin', 0, 0.7), function(param) return (round_form(util.linlin(0, 1, 0, 100, param:get()), 1, "%")) end)
  params:set_action("sample_level", function(val) sample_level = val softcut.level(sample_voice, val) end)
  
  params:add_control("sample_rate_slew_time", "slew", controlspec.new(0, 10, 'lin', 0.1, 5, "s"))
  params:set_action("sample_rate_slew_time", function(val) softcut.rate_slew_time(sample_voice, val) end)
  
  params:add_option("plant_sample", "load?", {"no", "yes"}, 2)
  params:set_action("plant_sample", function(val) sample_is_planted = val == 2 and true or false toggle_sample() end)
  
  params:bang()

  -- clocks
  shape_shifter_clock = clock.run(skin_walkr)
  bat_shifter_clock = clock.run(bat_phyikz)
  rate_shifter_clock = clock.run(zeit_machine)
  -- why clocks tho, and not metros? ff.

end


-- animal table
-- to be updated once in a while...if ya wanna help, send me a DM on discord @fellowfinch
animal_tab = {
    {name = "Cane Toad", species = "Rhinella marina", order = "Anura", class = "Amphibia", phylum = "Chordata", lifespan = 12.5, cff = 6.7, lp = 3000, hp = 20, bp = 245, q = 10},
    {name = "Green Frog", species = "Rana clamitans", order = "Anura", class = "Amphibia", phylum = "Chordata", lifespan = 3, cff = 21, lp = 20000, hp = 20, bp = 10010, q = 0.1},
    {name = "Rainbow Trout", species = "Oncorhynchus mykiss", order = "Salmoniformes", class = "Actinopterygii", phylum = "Chordata", lifespan = 3.5, cff = 27, lp = 500, hp = 100, bp = 223, q = 20},
    {name = "Harp Seal", species = "Pagophilus groenlandicus", order = "Carnivora", class = "Mammalia", phylum = "Chordata", lifespan = 32, cff = 33, lp = 20000, hp = 950, bp = 4356, q = 2},
    {name = "Brown Rat", species = "Rattus norvegicus", order = "Rodentia", class = "Mammalia", phylum = "Chordata", lifespan = 2, cff = 39, lp = 20000, hp = 500, bp = 3162, q = 2},
    {name = "Horned Owl", species = "Bubo virginianus", order = "Strigiformes", class = "Aves", phylum = "Chordata", lifespan = 25, cff = 45, lp = 12000, hp = 200, bp = 1650, q = 2},
    {name = "Cat", species = "Felis catus", order = "Carnivora", class = "Mammalia", phylum = "Chordata", lifespan = 14, cff = 55, lp = 20000, hp = 45, bp = 2000, q = 2},
    {name = "Human", species = "Homo sapiens", order = "Primates", class = "Mammalia", phylum = "Chordata", lifespan = 77, cff = 60, lp = 20000, hp = 20, bp = 2000, q = 5},
    {name = "Tussah Moth", species = "Antheraea pernyi", order = "Lepidoptera", class = "Insecta", phylum = "Arthropoda", lifespan = 0.02, cff = 70, lp = 20000, hp = 10000, bp = 4472, q = 5},
    {name = "Dog",species = "Canis lupus", order = "Carnivora", class = "Mammalia", phylum = "Chordata", lifespan = 13, cff = 80, lp = 20000, hp = 67, bp = 2000, q = 5},
    {name = "Treeshrew", species = "Tupaia glis", order = "Scandentia", class = "Mammalia", phylum = "Chordata", lifespan = 2.5, cff = 90, lp = 6000, hp = 250, bp = 1224, q = 2},
    {name = "Starling", species = "Sturnus vulgaris", order = "Passeriformes", class = "Aves", phylum = "Chordata", lifespan = 2.5, cff = 100, lp = 8700, hp = 700, bp = 2466, q = 5},
    {name = "Ground Squirrel", species = "Spermophilus lateralis", order = "Rodentia", class = "Mammalia", phylum = "Chordata", lifespan = 7, cff = 120, lp = 32000, hp = 50, bp = 2000, q = 2},
    {name = "Tsetse Fly", species = "Glossina morsitans", order = "Diptera", class = "Insecta", phylum = "Arthropoda", lifespan = 0.08, cff = 145, lp = 7200, hp = 5300, bp = 6175, q = 5},
    {name = "Honey Bee", species = "Apis mellifera", order = "Hymenoptera", class = "Insecta", phylum = "Arthropoda", lifespan = 0.1, cff = 200, lp = 500, hp = 100, bp = 250, q = 8}
}

-- sciency stuff here
-- cff rate now includes the detune settings
function setRate(cff)
  local cffrate = 60 / cff
  local n = math.pow(2, detune_semi + detune_cent)
  local new_rate = cffrate * n
  softcut.rate(sample_voice, new_rate)
  softcut.rate(rec_voice, new_rate)
  params:set("cff_display", cff.."/"..util.round(cff * n, 0.001))
  redraw()
end


--- here my proposition for including direction:
-- add variable
playback_direction = 1 -- expects 1 or -1

function setRate_with_dir() -- now no arg is required
  local dir = direction and -1 or 1
  local cff = animal_tab[current_animal].cff
  local cffrate = 60 / cff
  local n = math.pow(2, detune_semi + detune_cent)
  local rate = cffrate * n * playback_direction
  softcut.rate(sample_voice, rate)
  softcut.rate(rec_voice, rate)
  params:set("cff_display", cff.."/"..util.round(cff * n, 0.001))
  redraw()
end

-- hearing range
-- simplified a bit. you want to se the levels in updateFreqView and the freq/q here...ff, sorry what do ya mean?
function setFreq()
  local bp = animal_tab[current_animal].bp
  local q = animal_tab[current_animal].q
  softcut.post_filter_rq (sample_voice, 1 / q)
  softcut.post_filter_fc(sample_voice, bp)
  softcut.post_filter_rq (rec_voice, 1 / q)
  softcut.post_filter_fc(rec_voice, bp)
end

function updateFreqView(view_state)
  softcut.post_filter_dry(sample_voice, view_state == 1 and 1 or 0)
  softcut.post_filter_dry(rec_voice, view_state == 1 and 1 or 0)
  softcut.post_filter_bp(sample_voice, view_state == 2 and 1 or 0)
  softcut.post_filter_bp(rec_voice, view_state == 2 and 1 or 0)
  f_engage = view_state == 2 and true or false
  setFreq()
end

-- load sample file
function load_audio(path)
  if path ~= "cancel" and path ~= "" then
    local ch, len = audio.file_info(path)
    if ch > 0 and len > 0 then
      softcut.buffer_clear_channel(2)
      softcut.buffer_read_mono(path, 0, 1, -1, 1, 2, 0, 1)
      local l = math.min(len / 48000, MAX_BUFFER)
      softcut.loop_start(sample_voice, 1)
      softcut.loop_end(sample_voice, 1 + l)
      params:set("plant_sample", 2)
      params:set("load_sample", "")
      print("file loaded: "..path.." is "..l.."s")
    else
      print("not a sound file")
    end
  end
end
  
function toggle_sample()
  if sample_is_planted then
    softcut.position(sample_voice, 1)
    softcut.play(sample_voice, 1)
    softcut.level(sample_voice, sample_level)
  else
    softcut.level(sample_voice, 0)
  end
end

-- added se set_rec() let me know if sis is intended behaviour.
function set_rec()
  if (play == 0 or rec == 0) then
    softcut.rec_level(rec_voice, 0)
    softcut.pre_level(rec_voice, 1)
    softcut.level(rec_voice, voice_level)
  elseif rec == 1 then
    softcut.rec_level(rec_voice, 1)
    softcut.pre_level(rec_voice, pre_level)
    softcut.level(rec_voice, voice_level)
  end
end

-- clock funcs for se modulation live here:
function skin_walkr()
  while true do
    clock.sleep(shape_shifter_time)
    if shape_shifter_state then
      current_animal = math.random(1, #animal_tab)
      setRate(animal_tab[current_animal].cff)
      if params:get("freq_view") == 2 then
        setFreq(animal_tab[current_animal].bp)
      end
      redraw()
    end
  end
end

function bat_phyikz()
  while true do
    clock.sleep(pan_shifter_time)
    if pan_shifter_state then
      local pan = math.random() * 2 - 1
      -- do you want both voices to pan the same?
      -- othewise you can do somthing like:
      -- softcut.pan(rec_voice, math.random() * 2 - 1)
      -- softcut.pan(sample_voice, math.random() * 2 - 1)
      softcut.pan(rec_voice, pan)
      softcut.pan(sample_voice, pan)
    end
  end
end

function zeit_machine()
  while true do
    clock.sleep(rate_shifter_time)
    if rate_shifter_state then
      -- here you're only flipping reverse if there is a sample playing back. is that the intention? -- ah probably a problem, I wanted to do the same with the recorded material as well.
      -- also you want to have direction as a variable and and toggle between 1 and -1 and multifly your cff in setRate by this value.
      if sample_is_planted then
        setRate(-animal_tab[current_animal].cff)
      else
        setRate(animal_tab[current_animal].cff)
      end
    end
  end
end

--UI--
function key(n, z)
  if n == 1 then
    k1_pressed = (z == 1)
  elseif n == 2 and z == 1 then
    if k1_pressed then
      rec = rec == 0 and 1 or 0
      set_rec()
    else
      play = play == 0 and 1 or 0
      sample_is_planted = play == 1
      if play == 1 then
        setRate(animal_tab[current_animal].cff)
        print("stop/start")
      else
        set_rec()
        softcut.rate(sample_voice, 0)
        softcut.rate(rec_voice, 0)
      end
    end
  elseif n == 3 then -- sorry, 3 before 2 is a no no for my brain :) feel free to change back.
    k3_pressed = (z == 1)
    if k1_pressed and k3_pressed then
      softcut.buffer_clear(1)
    elseif z == 1 then
      sample_is_planted = not sample_is_planted
      if sample_is_planted then
        setRate(animal_tab[current_animal].cff)
      else
        setRate(-animal_tab[current_animal].cff) -- again, just se the direction here,, hmm weird, since it reverses the recorded material as well ...hmm ff
      end
    end
  end
  redraw()
end

-- encoder control
function enc(n, d)
    if n == 1 then
    current_animal = util.clamp(current_animal + d, 1, #animal_tab)
    setRate(animal_tab[current_animal].cff)
    if params:get("freq_view") == 2 then
      setFreq(animal_tab[current_animal].bp)
    end
  elseif n == 2 then 
    params:delta("sample_level", d)
    params:delta("voice_level", d)
  elseif n == 3 then
    params:delta("detune", d)
  end
  redraw()
end

--SCREEN
function redraw()
  screen.clear()
  -- symbols
  if rec == 1 then
    screen.move(45, 62)
    screen.level(15)
    screen.text("[REC]")
  elseif play == 1 then
    screen.move(45, 62)
    screen.level(4)
    screen.text("[...]")
  end

  -- main
  screen.level(15)
  screen.font_size(15)
  screen.font_face(49)
  screen.move(5, 10)
  screen.text(animal_tab[current_animal].name)
  screen.move(5, 23)
  screen.font_size(9)
  screen.font_face(17)
  screen.text(animal_tab[current_animal].species)
  screen.font_size(8)
  screen.font_face(1)
  screen.move(5, 35)
  screen.level(5)
  screen.text("Order: " .. animal_tab[current_animal].order)
  screen.move(5, 44)
  screen.text("CFF: " .. params:string("cff_display"))

  -- f_check
  screen.move(5, 53)
  screen.font_size(8)
  screen.font_face(1)
  if f_engage == true then
    screen.level(15)
  else
    screen.level(5)
  end
  screen.text("HR: " .. animal_tab[current_animal].hp.. "-" .. animal_tab[current_animal].lp.."hz")

  -- vol
  screen.move(5, 62)
  screen.level(5)
  screen.text("Vol: " .. params:string("sample_level"))

  --pngs
    if animal_tab[current_animal].name == "Human" then
      screen.display_png(_path.code .. "/perception/assets/human.png", 55, 0)
  elseif animal_tab[current_animal].name == "Cane Toad" then
      screen.display_png(_path.code .. "/perception/assets/toad.png", 78, 20)
  elseif animal_tab[current_animal].name == "Green Frog" then
      screen.display_png(_path.code .. "/perception/assets/gfrog.png", 75, 20)
  elseif animal_tab[current_animal].name == "Rainbow Trout" then
      screen.display_png(_path.code .. "/perception/assets/trout.png", 85, 25)
  elseif animal_tab[current_animal].name == "Harp Seal" then
      screen.display_png(_path.code .. "/perception/assets/seal.png", 85, 25)
  elseif animal_tab[current_animal].name == "Brown Rat" then
      screen.display_png(_path.code .. "/perception/assets/rat.png", 76, 8)
  elseif animal_tab[current_animal].name == "Horned Owl" then
      screen.display_png(_path.code .. "/perception/assets/owl.png", 95, 8)
  elseif animal_tab[current_animal].name == "Cat" then
      screen.display_png(_path.code .. "/perception/assets/cat.png", 73, 7)
  elseif animal_tab[current_animal].name == "Tussah Moth" then
      screen.display_png(_path.code .. "/perception/assets/moth.png", 92, -5)
  elseif animal_tab[current_animal].name == "Dog" then
      screen.display_png(_path.code .. "/perception/assets/dog.png", 75, 4)
  elseif animal_tab[current_animal].name == "Treeshrew" then
      screen.display_png(_path.code .. "/perception/assets/shrew.png", 70, 1)
  elseif animal_tab[current_animal].name == "Starling" then
      screen.display_png(_path.code .. "/perception/assets/starling.png", 75, 1)
  elseif animal_tab[current_animal].name == "Ground Squirrel" then
      screen.display_png(_path.code .. "/perception/assets/squirrel.png", 80, 25)
  elseif animal_tab[current_animal].name == "Tsetse Fly" then
      screen.display_png(_path.code .. "/perception/assets/fly.png", 75, 0)
  elseif animal_tab[current_animal].name == "Honey Bee" then
      screen.display_png(_path.code .. "/perception/assets/bee.png", 80, -4)
  end
  screen.update()
end

--util
function r()
  norns.script.load(norns.state.script)
end

function round_form(param, quant, form)
  return(util.round(param, quant)..form)
end

function screen_redraw()
  if dirtyscreen then
    redraw()
    dirtyscreen = false
  end
end