notesFromTextGrid.lua

SCRIPT_TITLE = "RV Notes from TextGrid"
-- Ver.1 - loads notes from Pratt textGrid object, pitch is quantized from pitch object
-- Ver.2 - added support for loading a pitch encoded in the textGrid lyrics (without pitch quantization),
--   encoding can be generated by "RV Notes to TextGrid"
--   the pitch is encoded as MIDI's note index minus 69 offset (ie 0 = A4)
-- Ver.3 - updat to ver 1.9.0 of SynthV Pro, should work with 1.8 too
--   exclamation mark functionality has been (temporarily) removed due some bug in 1.9.0 version
--   refactored pitch dev timing to consume less resources
--   added option to load phoneme labeled segments (adds a dot before lyrics of every note)

function getClientInfo()
  return {
    name = SV:T(SCRIPT_TITLE),
    author = "Hataori@protonmail.com",
    category = "Real Voice",
    versionNumber = 3,
    minEditorVersion = 0x010800
  }
end

local NOTES = {'C', 'C#', 'D', 'D#', 'E', 'F', 'F#', 'G', 'G#', 'A', 'Bb', 'B'}

local SCALES = {
  ['chroma'] = 'C-C#-D-D#-E-F-F#-G-G#-A-Bb-B-',
  ['C/a'] = 'C-D-E-F-G-A-B-',
  ['C#/Db/bb'] = 'C#-D#-F-F#-G#-Bb-C-',
  ['D/b'] = 'D-E-F#-G-A-B-C#-',
  ['Eb/c'] = 'D#-F-G-G#-Bb-C-D-',
  ['E/c#'] = 'E-F#-G#-A-B-C#-D#-',
  ['F/d'] = 'F-G-A-Bb-C-D-E-',
  ['F#/Gb/d#/eb'] = 'F#-G#-Bb-B-C#-D#-F-',
  ['G/e'] = 'G-A-B-C-D-E-F#-',
  ['Ab/f'] = 'G#-Bb-C-C#-D#-F-G-',
  ['A/f#'] = 'A-B-C#-D-E-F#-G#-',
  ['Bb/g'] = 'Bb-C-D-D#-F-G-A-',
  ['B/Cb/g#'] = 'B-C#-D#-E-F#-G#-Bb-'
}

local inputForm = {
    title = SV:T("Notes from Praat TextGrid and Pitch"),
    message = SV:T("Timing and pitch to be loaded as notes into current track"),
    buttons = "OkCancel",
    widgets = {
      {
        name = "scale", type = "ComboBox",
        label = SV:T("Scale (Maj/Min)"),
        choices = {"chroma", "C/a", "C#/Db/bb", "D/b", "Eb/c", "E/c#", "F/d", "F#/Gb/d#/eb", "G/e", "Ab/f", "A/f#", "Bb/g", "B/Cb/g#"},
        default = 0
      },
      {
        name = "loadPitchCheck", type = "CheckBox",
        text = SV:T("Load pitch automation"),
        default = false
      },
      {
        name = "phonemesInLyrics", type = "CheckBox",
        text = SV:T("TextGrid is marked as phonemes (add a dot before every lyrics)"),
        default = false
      }
    }
  }

------------ Praat pitch
local praatPitch = {} -- class

do

local PitchHeader = {
{n="File_type", v="File type = \"ooTextFile\"", t="del"},
{n="Object_class", v="Object class = \"Pitch 1\"", t="del"},
{t="del"},
{n="xmin", t="num"},
{n="xmax", t="num"},
{n="nx", t="num"},
{n="dx", t="num"},
{n="x1", t="num"},
{n="ceiling", t="num"},
{n="maxnCandidates", t="num"}
}

function praatPitch:loadPitch(fnam) -- constructor, short text format
  local o = {}
  setmetatable(o, self)
  self.__index = self

  local data, header = {}, {}

  local fi = io.open(fnam)
  assert(fi, "cannot open pitch file")
  for i = 1, #PitchHeader do
    local lin = fi:read("*l")
    local h = PitchHeader[i]

    if h.v then
      if lin ~= h.v then return end
    elseif h.t == "num" then
      lin = tonumber(lin)
    end

    if h.n and h.t ~= "del" then
      header[h.n] = lin
    end
  end

  header["fileType"] = "ooTextFile"
  header["objectClass"] = "Pitch 1"
  assert(header.nx, "no nx in pitch file")

  for i = 1, header.nx do
    local pitch = { i = i }
    pitch.t = (i - 1) * header.dx + header.x1

    local int = fi:read("*n", "*l") -- intensity
    local cand = fi:read("*n", "*l") -- candidates
    assert(cand, "no candidates in pitch file")

    for k = 1, cand do
      local f = fi:read("*n", "*l")
      if k == 1 then
        pitch.f = f
      end
      fi:read("*n", "*l")
    end

    table.insert(data, pitch)
  end;
  fi:close()

  o.header = header
  o.data = data
  return o
end

function praatPitch:getPitch(t) -- ret: f0 [Hz]
  if t < self.data[1].t then return 0 end
  if t > self.data[#self.data].t then return 0 end

  local ll, rr = 1, #self.data
  while (rr-ll) > 1 do
    local cc = math.floor((rr + ll) / 2)
    if t <= self.data[cc].t then
      rr = cc
    else
      ll = cc
    end
  end

  local pf, pt = self.data[ll].f, self.data[rr].f
  if pf == 0 or pt == 0 then return 0 end

  local pf, pt = math.log(pf), math.log(pt)
  local fro, til = self.data[ll].t, self.data[rr].t

  return math.exp(pf + (pt - pf) / (til - fro) * (t - fro))
end

end -- end class

------------ Praat textGrid
local praatTextGrid = {} -- class

do

local TextGridHeader = {
{n="File_type", v="File type = \"ooTextFile\"", t="del"},
{n="Object_class", v="Object class = \"TextGrid\"", t="del"},
{t="del"},
{n="xmin", t="num"},
{n="xmax", t="num"},
{v="<exists>", t="del"},
{n="tireCnt", t="num"},
{n="tireType", v="\"IntervalTier\""},
{n="tireName"},
{n="txmin", t="num"},
{n="txmax", t="num"},
{n="nx", t="num"},
}

function praatTextGrid:loadFirstIntervalGridTier(fnam) -- constructor, short text format
  local o = {}
  setmetatable(o, self)
  self.__index = self

  local data, header = {}, {}

  local fi = io.open(fnam)
  assert(fi, "cannot open grid file")
  for i = 1, #TextGridHeader do
    local lin = fi:read("*l")
    local h = TextGridHeader[i]

    if h.v then
      if lin ~= h.v then return end
    elseif h.t == "num" then
      lin = tonumber(lin)
    end

    if h.n and h.t ~= "del" then
      header[h.n] = lin
    end
  end

  header["fileType"] = "ooTextFile"
  header["objectClass"] = "TextGrid"
  assert(header.nx, "no nx in pitch file")

  for i = 1, header.nx do
    local interval = {}

    local time_from = fi:read("*n", "*l")
    local time_to = fi:read("*n", "*l")
    local txt = fi:read("*l")
    txt = txt:match("\"([^\"]+)\"") or ""

    table.insert(data, {
      fr = time_from,
      to = time_to,
      tx = txt
    })
  end;
  fi:close()

  o.header = header
  o.data = data
  return o
end

end -- end class

--------- qunatization

function HzToHalftone(hz)
  if hz<=0 then return end
  return 12 * math.log(hz / 440) / math.log(2)
end

-- halftone number from HzToHalftone, 0 = 440 Hz, scale string from SCALES
function isInScale(ht, scale)
  local cbase = math.fmod(ht + 57, 12) -- every C = 0
  local nam = NOTES[cbase + 1]
  return string.find(scale, nam.."-", 1, true)
end

-- quantize to scale
function quantizeNote(hz, scale)
  local ht = HzToHalftone(hz)
  if not ht then return end

  local qht = math.floor(ht + 0.5)
  if isInScale(qht, scale) then return qht end

  local lht, hht = qht - 1, qht + 1
  while not isInScale(lht, scale) do
    lht = lht - 1
  end

  while not isInScale(hht, scale) do
    hht = hht + 1
  end

  if math.abs(ht - lht) < math.abs(ht - hht) then
    return lht
  else
    return hht
  end
end

local function getProjectPathName()
  local projectFileName = SV:getProject():getFileName()
  if not projectFileName then return end

  local projectName, projectDir
  projectFileName = projectFileName:gsub("\\", "/")
  projectDir, projectName = projectFileName:match("^(.*/)([^/]+)%.svp$")
  return projectName, projectDir
end

local function fileExists(fname)
  local fi = io.open(fname)
  if not fi then return end
  fi:close()
  return true
end

local function process()
  local sver = SV:getHostInfo().hostVersionNumber -- SynthV version
                                  -- pitch and grid files in project folder
  local projectName, projectDir = getProjectPathName()
  if not projectDir or not projectName then
    SV:showMessageBox(SV:T("Error"), SV:T("Project dir or name not found, save your project first"))
    return
  end

  local pitchFileName = projectDir..projectName.."_Pitch.txt"
  local gridFileName = projectDir..projectName.."_TextGrid.txt"

  if not fileExists(gridFileName) then
    SV:showMessageBox(SV:T("Error"), SV:T("Cannot open textGrid file").." '"..gridFileName.."' "..SV:T("(<project_name>_TextGrid.txt) & pitch (<project_name>_Pitch.txt) files are expected to be in the project dir"))
    return
  end

  if not fileExists(pitchFileName) then
    SV:showMessageBox(SV:T("Error"), SV:T("Cannot open pitch file").." '"..pitchFileName.."' "..SV:T("(<project_name>_TextGrid.txt) & pitch (<project_name>_Pitch.txt) files are expected to be in the project dir"))
    return
  end

  local grid = praatTextGrid:loadFirstIntervalGridTier(gridFileName) -- textgrid instance
  if not grid then
    SV:showMessageBox(SV:T("Error"), SV:T("Wrong textgrid file format, save it as SHORT text"))
    return
  end

  local pitch = praatPitch:loadPitch(pitchFileName) -- pitch instance
  if not pitch then
    SV:showMessageBox(SV:T("Error"), SV:T("Wrong pitch file format, save it as SHORT text"))
    return
  end

  local noPitchEnc = 0 -- number of notes with pitch not encoded
  for _, int in ipairs(grid.data) do
    if int.tx and int.tx ~= "" and not int.tx:find("!", 1, true) and not int.tx:match("%([%d-]+%)") then
      noPitchEnc = noPitchEnc + 1
    end
  end

  if noPitchEnc == 0 then table.remove(inputForm.widgets, 1) end -- scale not needed
                             -- input dialog
  local dlgResult = SV:showCustomDialog(inputForm)
  if not dlgResult.status then return end -- cancel pressed

  local scaleName = "chroma"
  if noPitchEnc > 0 then
    scaleName = inputForm.widgets[1].choices[dlgResult.answers.scale + 1]
  end
  local qScale = SCALES[scaleName]
  assert(qScale, "wrong scale")

  local timeAxis = SV:getProject():getTimeAxis()
  local scope = SV:getMainEditor():getCurrentGroup()
  local group = scope:getTarget()
--  local veam = group:getParameter("vibratoEnv") -- vibrato envelope for extra events
--  veam:removeAll()

  local notes, lastNote = {}, nil
  for _, int in ipairs(grid.data) do
    local frb, frt = timeAxis:getBlickFromSeconds(int.fr), timeAxis:getBlickFromSeconds(int.to)
                       -- normalize spaces
    if int.tx then
      int.tx = int.tx:gsub("_", "")
      int.tx = int.tx:match("^%s*(.-)%s*$") or ""
    else
      int.tx = ""
    end

    if int.tx and int.tx:find("!", 1, true) then
      -- this functionali ty removed due to some bug in vibrato envelope
      SV:showMessageBox(SV:T("Error"), SV:T("Exclamation mark functionality has been (temporarily) removed due some bug in 1.9.0 version"))
      return
--      veam:add(frb, 1)
--      if lastNote then
--        lastNote.en = frt
--      end
    elseif int.tx and int.tx ~= "" then
      local txt, pit = int.tx:match("^(.-)%s*%(([%d-]+)%)$")

      if pit then -- pitch encoded in textGrid
        lastNote = {st = frb, en = frt, pitch = tonumber(pit) + 69, lyr = txt}
        table.insert(notes, lastNote)
--        veam:add(frb, 1)
      else        -- pitch quantization
        local med, cnt, unvoc = {}, 0, 0
        local t = int.fr
        while t <= int.to do
          local f0 = pitch:getPitch(t)
          if f0 > 50 then
            local qn = quantizeNote(f0, qScale)
            table.insert(med, qn)
          else
            unvoc = unvoc + 1
          end

          t = t + 0.001
          cnt = cnt + 1
        end

        if #med > 2 and (#med / cnt) > 0.5 then -- more than 50% voiced length
          table.sort(med)
          med = med[math.floor(#med / 2) + 1] -- pitch median

          lastNote = {st = frb, en = frt, pitch = med + 69, lyr = int.tx}
          table.insert(notes, lastNote)
--          veam:add(frb, 1)
        else
          lastNote = {st = frb, en = frt, lyr = int.tx}
          table.insert(notes, lastNote)
--          veam:add(frb, 1)
        end
      end -- end if pitch
    else
      lastNote = nil
    end -- if int.tx
  end -- for
                           -- remove old notes
  local ncnt = group:getNumNotes()
  if ncnt > 0 then
    for i = ncnt, 1, -1 do
      group:removeNote(i)
    end
  end

  local addDot = dlgResult.answers.phonemesInLyrics
                           -- create notes
  for i, nt in ipairs(notes) do
    local note = SV:create("Note")
    note:setTimeRange(nt.st, nt.en - nt.st)

    if sver >= 0x010900 then
      note:setPitchAutoMode(0) -- manual pitch mode
    end

    local pitch = nt.pitch
    if not pitch then
      pitch = (i < #notes and notes[i + 1].pitch) or (i > 1 and notes[i - 1].pitch) or 69
    end
    note:setPitch(pitch)

    local lyr = nt.lyr or ""

    lyr = lyr:gsub("%d", "")
    lyr = lyr:lower()

    if addDot then
      lyr = "."..lyr
    end

    note:setLyrics(lyr)

    group:addNote(note)
  end
                        -- load pitch automation
  if dlgResult.answers.loadPitchCheck then
    local am = group:getParameter("pitchDelta") -- pitch automation
    am:removeAll()

    scope:setVoice({
      tF0Left = 0,
      tF0Right = 0,
      dF0Left = 0,
      dF0Right = 0,
      dF0Vbr = 0
    })

    local noteCnt = group:getNumNotes()

    for i = 1, noteCnt do
      local note = group:getNote(i)
      local npitch = note:getPitch()
      local ncents = 100 * (npitch - 69) -- A4

      local blOnset, blEnd = note:getOnset(), note:getEnd()

      local tons = timeAxis:getSecondsFromBlick(blOnset) -- start time
      local tend = timeAxis:getSecondsFromBlick(blEnd) -- end time

      local tempo = timeAxis:getTempoMarkAt(blOnset)
      local compensation = tempo.bpm * 6.3417442
      local t_step = math.max(SV:blick2Seconds(SV:quarter2Blick(1/64), tempo.bpm), 0.01)

      local df, f0
      local o10, e10 = tons + 0.010, tend - 0.010
      local t = tons + 0.0005
      while t < tend - 0.0001 do
        f0 = pitch:getPitch(t)
        if f0 > 50 then -- voiced
          df = 1200 * math.log(f0/440)/math.log(2) - ncents -- delta f0 in cents
          am:add(timeAxis:getBlickFromSeconds(t), df)
        end

        if t <= o10 or t >= e10 then
          t = t + 0.001
        else
          t = t + t_step -- time step
          if t >= e10 then
            t = e10
          end
        end
      end

      if i > 1 then
        local pnote = group:getNote(i - 1)
        local pnpitch = pnote:getPitch()
        local pncents = 100 * (pnpitch - 69) -- A4
        local pblOnset, pblEnd = pnote:getOnset(), pnote:getEnd()

        if pblEnd == blOnset then
          local pts = am:getPoints(blOnset, timeAxis:getBlickFromSeconds(tons + 0.010))
          local pdif = ncents - pncents

          for _, pt in ipairs(pts) do
            local b, v = pt[1], pt[2]
            local t = timeAxis:getSecondsFromBlick(b) - tons
            local cor = 1 - (1 / (1 + math.exp(-compensation * t)))
            am:add(b, v + pdif * cor)
          end
        end
      end

      if i < noteCnt then
        local pnote = group:getNote(i + 1)
        local pnpitch = pnote:getPitch()
        local pncents = 100 * (pnpitch - 69) -- A4
        local pblOnset, pblEnd = pnote:getOnset(), pnote:getEnd()

        if blEnd == pblOnset then
          local pts = am:getPoints(timeAxis:getBlickFromSeconds(tend - 0.010), blEnd - 1)
          local pdif = pncents - ncents

          for _, pt in ipairs(pts) do
            local b, v = pt[1], pt[2]
            local t = timeAxis:getSecondsFromBlick(b) - tend
            local cor = 1 / (1 + math.exp(-compensation * t))
            am:add(b, v - pdif * cor)
          end
        end
      end

      am:simplify(blOnset, blEnd, 0.0001)
    end
  end
end

function main()
  process()
  SV:finish()
end