aegisub.register_macro(tr"Apply karaoke template", tr"Applies karaoke effects from templates", macro_apply_templates, macro_can_template)
aegisub.register_filter(tr"Karaoke template", tr"Apply karaoke effect templates to the subtitles.\n\nSee the help file for information on how to use this.", 2000, filter_apply_templates)

type ProcessFunction = (subtitle: Subtitle, selected: lines[], active: number) => void;
declare function aegisub.register_macro(
  name: string,
  desc: string,
  processing: ProcessFunction,
  validation: ProcessFunction,
  is_active: ProcessFunction
)

type ConfigPanelFunction = (subtitles: Subtitle, old_settings: Table<Setting>) => Table<Dialog>;
declare function aegisub.register_filter(
  name: string,
  description: string,
  priority: number,
  processing: ProcessFunction,
  configuration_panel_provider
);

function macro_can_template(subs)
  -- 检测文件中是否有模板，当不存在模板时不允许宏运行
  local num_dia = 0
  for i = 1, #subs do
    local l = subs[i]
    if l.class == "dialogue" then
      num_dia = num_dia + 1
      -- 检测该行是否为 template 行
      if (string.headtail(l.effect)):lower() == "template" then
        return true
      end
      -- 不尝试匹配所有行以减短执行时间
      if num_dia > 50 then
        return false
      end
    end
  end
  return false
end

function macro_apply_templates(subs, sel)
  filter_apply_templates(subs, {ismacro=true, sel=sel})
  aegisub.set_undo_point("apply karaoke template")
end

-- 模板的主函数
function filter_apply_templates(subs, config)
  aegisub.progress.task("Collecting header data...")
  local meta, styles = karaskel.collect_head(subs, true)
  aegisub.progress.task("Parsing templates...")
  local templates = parse_templates(meta, styles, subs)
  aegisub.progress.task("Applying templates...")
  apply_templates(meta, styles, subs, templates)
end

-- 从字幕文件中收集样式和 metadata
function karaskel.collect_head(subs, generate_furigana)
  local meta = {
    -- X and Y script resolution
    res_x = 0, res_y = 0,
    -- 对视频和脚本分辨率不一致的修正因子
    video_x_correct_factor = 1.0
  }
  local styles = { n = 0 }
  local toinsert = {}
  local first_style_line = nil
  if not karaskel.furigana_scale then
    karaskel.furigana_scale = 0.5
  end

  -- First pass: collect all existing styles and get resolution info
  for i = 1, #subs do
    if aegisub.progress.is_cancelled() then error("User cancelled") end
    local l = subs[i]
    if l.class == "style" then
      if not first_style_line then first_style_line = i end
      -- Store styles into the style table
      styles.n = styles.n + 1
      styles[styles.n] = l
      styles[l.name] = l
      l.margin_v = l.margin_t -- convenience
      -- And also generate furigana styles if wanted
      if generate_furigana and not l.name:match("furigana") then
        aegisub.debug.out(5, "Creating furigana style for style: " .. l.name .. "\n")
        local fs = table.copy(l)
        fs.fontsize = l.fontsize * karaskel.furigana_scale
        fs.outline = l.outline * karaskel.furigana_scale
        fs.shadow = l.shadow * karaskel.furigana_scale
        fs.name = l.name .. "-furigana"
        table.insert(toinsert, fs) -- queue to insert in file
      end
    elseif l.class == "info" then
      -- Also look for script resolution
      local k = l.key:lower()
      meta[k] = l.value
    end
  end

  -- Second pass: insert all toinsert styles that don't already exist
  for i = 1, #toinsert do
    if not styles[toinsert[i].name] then
      -- 加入样式表
      styles.n = styles.n + 1
      styles[styles.n] = toinsert[i]
      styles[toinsert[i].name] = toinsert[i]
      -- 加入字幕文件
      subs[-first_style_line] = toinsert[i]
    end
  end

  -- 修复分辨率
  if meta.playresx then
    meta.res_x = math.floor(meta.playresx)
  end
  if meta.playresy then
    meta.res_y = math.floor(meta.playresy)
  end
  if meta.res_x == 0 and meta_res_y == 0 then
    meta.res_x = 384
    meta.res_y = 288
  elseif meta.res_x == 0 then
    -- This is braindead, but it's how TextSub does things...
    if meta.res_y == 1024 then
      meta.res_x = 1280
    else
      meta.res_x = meta.res_y / 3 * 4
    end
  elseif meta.res_y == 0 then
    -- As if 1280x960 didn't exist
    if meta.res_x == 1280 then
      meta.res_y = 1024
    else
      meta.res_y = meta.res_x * 3 / 4
    end
  end

  local video_x, video_y = aegisub.video_size()
  if video_y then
    -- Correction factor for TextSub weirdness when render resolution does
    -- not match script resolution. Text pixels are considered square in
    -- render resolution rather than in script resolution, which is
    -- logically inconsistent. Correct for that.
    meta.video_x_correct_factor =
      (video_y / video_x) / (meta.res_y / meta.res_x)
  end
  aegisub.debug.out(4, "Karaskel: Video X correction factor = %f\n\n", meta.video_x_correct_factor)
  return meta, styles
end

-- Find and parse/prepare all karaoke template lines
function parse_templates(meta, styles, subs)
  local templates = { once = {}, line = {}, syl = {}, char = {}, furi = {}, styles = {} }
  local i = 1
  while i <= #subs do
    aegisub.progress.set((i-1) / #subs * 100)
    local l = subs[i]
    i = i + 1
    if l.class == "dialogue" and l.comment then
      local fx, mods = string.headtail(l.effect)
      fx = fx:lower()
      if fx == "code" then
        parse_code(meta, styles, l, templates, mods)
      elseif fx == "template" then
        parse_template(meta, styles, l, templates, mods)
      end
      templates.styles[l.style] = true
    elseif l.class == "dialogue" and l.effect == "fx" then
      -- this is a previously generated effect line, remove it
      i = i - 1
      subs.delete(i)
    end
  end
  aegisub.progress.set(100)
  return templates
end

function parse_code(meta, styles, line, templates, mods)
  local template = {
    code = line.text,
    loops = 1,
    style = line.style
  }
  local inserted = false
  local rest = mods
  while rest ~= "" do
    local m, t = string.headtail(rest)
    rest = t
    m = m:lower()
    if m == "once" then
      aegisub.debug.out(5, "Found run-once code line: %s\n", line.text)
      table.insert(templates.once, template)
      inserted = true
    elseif m == "line" then
      aegisub.debug.out(5, "Found per-line code line: %s\n", line.text)
      table.insert(templates.line, template)
      inserted = true
    elseif m == "syl" then
      aegisub.debug.out(5, "Found per-syl code line: %s\n", line.text)
      table.insert(templates.syl, template)
      inserted = true
    elseif m == "furi" then
      aegisub.debug.out(5, "Found per-furi code line: %s\n", line.text)
      table.insert(templates.furi, template)
      inserted = true
    elseif m == "all" then
      template.style = nil
    elseif m == "noblank" then
      template.noblank = true
    elseif m == "repeat" or m == "loop" then
      local times, t = string.headtail(rest)
      template.loops = tonumber(times)
      if not template.loops then
        aegisub.debug.out(3, "Failed reading this repeat-count to a number: %s\nIn template code line: %s\nEffect field: %s\n\n", times, line.text, line.effect)
        template.loops = 1
      else
        rest = t
      end
    else
      aegisub.debug.out(3, "Unknown modifier in code template: %s\nIn template code line: %s\nEffect field: %s\n\n", m, line.text, line.effect)
    end
  end
  if not inserted then
    aegisub.debug.out(5, "Found implicit run-once code line: %s\n", line.text)
    table.insert(templates.once, template)
  end
end

-- List of reserved words that can't be used as "line" template identifiers
template_modifiers = {
  "pre-line", "line", "syl", "furi", "char", "all", "repeat", "loop",
  "notext", "keeptags", "noblank", "multi", "fx", "fxgroup"
}
function parse_template(meta, styles, line, templates, mods)
  local template = {
    t = "",
    pre = "",
    style = line.style,
    loops = 1,
    layer = line.layer,
    addtext = true,
    keeptags = false,
    fxgroup = nil,
    fx = nil,
    multi = false,
    isline = false,
    perchar = false,
    noblank = false
  }
  local inserted = false
  local rest = mods
  while rest ~= "" do
    local m, t = string.headtail(rest)
    rest = t
    m = m:lower()
    if (m == "pre-line" or m == "line") and not inserted then
      aegisub.debug.out(5, "Found line template '%s'\n", line.text)
      -- should really fail if already inserted
      local id, t = string.headtail(rest)
      id = id:lower()
      -- check that it really is an identifier and not a keyword
      for _, kw in pairs(template_modifiers) do
        if id == kw then
          id = nil
          break
        end
      end
      if id == "" then
        id = nil
      end
      if id then
        rest = t
      end
      -- get old template if there is one
      if id and templates.line[id] then
        template = templates.line[id]
      elseif id then
        template.id = id
        templates.line[id] = template
      else
        table.insert(templates.line, template)
      end
      inserted = true
      template.isline = true
      -- apply text to correct string
      if m == "line" then
        template.t = template.t .. line.text
      else -- must be pre-line
        template.pre = template.pre .. line.text
      end
    elseif m == "syl" and not template.isline then
      table.insert(templates.syl, template)
      inserted = true
    elseif m == "furi" and not template.isline then
      table.insert(templates.furi, template)
      inserted = true
    elseif (m == "pre-line" or m == "line") and inserted then
      aegisub.debug.out(2, "Unable to combine %s class templates with other template classes\n\n", m)
    elseif (m == "syl" or m == "furi") and template.isline then
      aegisub.debug.out(2, "Unable to combine %s class template lines with line or pre-line classes\n\n", m)
    elseif m == "all" then
      template.style = nil
    elseif m == "repeat" or m == "loop" then
      local times, t = string.headtail(rest)
      template.loops = tonumber(times)
      if not template.loops then
        aegisub.debug.out(3, "Failed reading this repeat-count to a number: %s\nIn template line: %s\nEffect field: %s\n\n", times, line.text, line.effect)
        template.loops = 1
      else
        rest = t
      end
    elseif m == "notext" then
      template.addtext = false
    elseif m == "keeptags" then
      template.keeptags = true
    elseif m == "multi" then
      template.multi = true
    elseif m == "char" then
      template.perchar = true
    elseif m == "noblank" then
      template.noblank = true
    elseif m == "fx" then
      local fx, t = string.headtail(rest)
      if fx ~= "" then
        template.fx = fx
        rest = t
      else
        aegisub.debug.out(3, "No fx name following fx modifier\nIn template line: %s\nEffect field: %s\n\n", line.text, line.effect)
        template.fx = nil
      end
    elseif m == "fxgroup" then
      local fx, t = string.headtail(rest)
      if fx ~= "" then
        template.fxgroup = fx
        rest = t
      else
        aegisub.debug.out(3, "No fxgroup name following fxgroup modifier\nIn template linee: %s\nEffect field: %s\n\n", line.text, line.effect)
        template.fxgroup = nil
      end
    else
      aegisub.debug.out(3, "Unknown modifier in template: %s\nIn template line: %s\nEffect field: %s\n\n", m, line.text, line.effect)
    end
  end
  if not inserted then
    table.insert(templates.syl, template)
  end
  if not template.isline then
    template.t = line.text
  end
end

  -- the environment the templates will run in
  local tenv = {
    meta = meta,
    -- put in some standard libs
    string = string,
    math = math,
    _G = _G
  }
  tenv.tenv = tenv

  tenv.retime = function(mode, addstart, addend)
    local line, syl = tenv.line, tenv.syl
    local newstart, newend = line.start_time, line.end_time
    addstart = addstart or 0
    addend = addend or 0

    if mode == "syl" then
      newstart = line.start_time + syl.start_time + addstart
      newend = line.start_time + syl.end_time + addend

    elseif mode == "presyl" then
      newstart = line.start_time + syl.start_time + addstart
      newend = line.start_time + syl.start_time + addend

    elseif mode == "postsyl" then
      newstart = line.start_time + syl.end_time + addstart
      newend = line.start_time + syl.end_time + addend

    elseif mode == "line" then
      newstart = line.start_time + addstart
      newend = line.end_time + addend

    elseif mode == "preline" then
      newstart = line.start_time + addstart
      newend = line.start_time + addend

    elseif mode == "postline" then
      newstart = line.end_time + addstart
      newend = line.end_time + addend

    elseif mode == "start2syl" then
      newstart = line.start_time + addstart
      newend = line.start_time + syl.start_time + addend

    elseif mode == "syl2end" then
      newstart = line.start_time + syl.end_time + addstart
      newend = line.end_time + addend

    elseif mode == "set" or mode == "abs" then
      newstart = addstart
      newend = addend

    elseif mode == "sylpct" then
      newstart = line.start_time + syl.start_time + addstart*syl.duration/100
      newend = line.start_time + syl.start_time + addend*syl.duration/100

    -- wishlist: something for fade-over effects,
    -- "time between previous line and this" and
    -- "time between this line and next"
    end

    line.start_time = newstart
    line.end_time = newend
    line.duration = newend - newstart
    return ""
  end

  tenv.relayer = function(layer)
    tenv.line.layer = layer
    return ""
  end

  tenv.restyle = function(style)
    tenv.line.style = style
    tenv.line.styleref = styles[style]
    return ""
  end

  tenv.maxloop = function(newmaxj)
    tenv.maxj = newmaxj
    return ""
  end
  tenv.maxloops = tenv.maxloop

  tenv.loopctl = function(newj, newmaxj)
    tenv.j = newj
    tenv.maxj = newmaxj
    return ""
  end

  tenv.recall = {}
  setmetatable(tenv.recall, {
    decorators = {},

    __call = function(tab, name, default)
      local decorator = getmetatable(tab).decorators[name]
      if decorator then
        name = decorator(tostring(name))
      end
      aegisub.debug.out(5, "Recalling '%s'\n", name)
      return tab[name] or default
    end,

    decorator_line = function(name)
      return string.format("_%s_%s", tostring(tenv.orgline), name)
    end,
    decorator_syl = function(name)
      return string.format("_%s_%s", tostring(tenv.syl), name)
    end,
    decorator_basesyl = function(name)
      return string.format("_%s_%s", tostring(tenv.basesyl), name)
    end
  })

  tenv.remember = function(name, value, decorator)
    getmetatable(tenv.recall).decorators[name] = decorator
    if decorator then
      name = decorator(tostring(name))
    end
    aegisub.debug.out(5, "Remembering '%s' as '%s'\n", name, tostring(value))

    tenv.recall[name] = value
    return value
  end

{\t(!remember("time", math.random(10,20)*10)!, !line.duration!, !recall.time!}

  tenv.remember_line = function(name, value)
    return tenv.remember(name, value, getmetatable(tenv.recall).decorator_line)
  end
  tenv.remember_syl = function(name, value)
    return tenv.remember(name, value, getmetatable(tenv.recall).decorator_syl)
  end
  tenv.remember_basesyl = function(name, value)
    return tenv.remember(name, value, getmetatable(tenv.recall).decorator_basesyl)
  end

  tenv.remember_if = function(name, value, condition, decorator)
    if condition then
      return tenv.remember(name, value, decorator)
    end
    return value
  end

  -- 运行所有的 code once 代码片段
  for k, t in pairs(templates.once) do
    assert(t.code, "WTF, a 'once' template without code?")
    run_code_template(t, tenv)
  end

function run_code_template(template, tenv)
  local f, err = loadstring(template.code, "template code")
  if not f then
    aegisub.debug.out(2, "Failed to parse Lua code: %s\nCode that failed to parse: %s\n\n", err, template.code)

  else
    local pcall = pcall
    setfenv(f, tenv)
    for j, maxj in template_loop(tenv, template.loops) do

-- 迭代器函数，返回一个以 tenv.j 和 tenv.maxj 控制的迭代器
function template_loop(tenv, initmaxj)
  local oldmaxj = initmaxj
  tenv.maxj = initmaxj
  tenv.j = 0
  local function itor()
    if tenv.j >= tenv.maxj or aegisub.progress.is_cancelled() then
      return nil
    else
      tenv.j = tenv.j + 1
      if oldmaxj ~= tenv.maxj then
        aegisub.debug.out(5, "Number of loop iterations changed from %d to %d\n", oldmaxj, tenv.maxj)
        oldmaxj = tenv.maxj
      end
      return tenv.j, tenv.maxj
    end
  end
  return itor
end

      local res, err = pcall(f)
      if not res then
        aegisub.debug.out(2, "Runtime error in template code: %s\nCode producing error: %s\n\n", err, template.code)
      end
    end
  end
end

  -- 开始处理行
  local i, n = 0, #subs
  while i < n do
    aegisub.progress.set(i/n*100)
    i = i + 1

    local l = subs[i]
    if l.class == "dialogue" and ((l.effect == "" and not l.comment) or l.effect:match("[Kk]araoke")) then

        l.i = i
        l.comment = false
        karaskel.preproc_line(subs, meta, styles, l)

      if apply_line(meta, styles, subs, l, templates, tenv) then
        -- 有样式应用到这行了 将其标记为 karaoke 行
        l.comment = true
        l.effect = "karaoke"
        subs[i] = l
      end
    end
  end
end

-- 预计算行的一些信息
-- 会修改 line 参数
function karaskel.preproc_line(subs, meta, styles, line)
  -- subs 参数不会用到 并且可能永远不会用到
  -- (哪一行突然改变 index 这件事情就不大对)
  -- 随便传入，但小心直接调用 preproc_line_pos，函数签名可能会变
  karaskel.preproc_line_pos(meta, styles, line)
end

-- 布置行布局 包括注音布局
-- 会修改行对象
function karaskel.preproc_line_pos(meta, styles, line)
  if not line.styleref then
    karaskel.preproc_line_size(meta, styles, line)
  end

  -- 注音布局必须在其他步骤之前进行，因为其可能会改变整行宽度
  if line.furistyle then
    karaskel.do_furigana_layout(meta, styles, line)

  else
    karaskel.do_basic_layout(meta, styles, line)
  end

-- 进行基本音节布局（无注音）
function karaskel.do_basic_layout(meta, styles, line)
  local curx = 0
  for i = 0, line.kara.n do
    local syl = line.kara[i]
    syl.left = curx + syl.prespacewidth
    syl.center = syl.left + syl.width / 2
    syl.right = syl.left + syl.width
    curx = curx + syl.prespacewidth + syl.width + syl.postspacewidth
  end
end

  -- 有效（实际）外边距
  line.margin_v = line.margin_t
  line.eff_margin_l = ((line.margin_l > 0) and line.margin_l) or line.styleref.margin_l
  line.eff_margin_r = ((line.margin_r > 0) and line.margin_r) or line.styleref.margin_r
  line.eff_margin_t = ((line.margin_t > 0) and line.margin_t) or line.styleref.margin_t
  line.eff_margin_b = ((line.margin_b > 0) and line.margin_b) or line.styleref.margin_b
  line.eff_margin_v = ((line.margin_v > 0) and line.margin_v) or line.styleref.margin_v

  -- 以及定位
  if line.styleref.align == 1 or line.styleref.align == 4 or line.styleref.align == 7 then
    -- 左对齐
    line.left = line.eff_margin_l
    line.center = line.left + line.width / 2
    line.right = line.left + line.width
    line.x = line.left
    line.halign = "left"

  elseif line.styleref.align == 2 or line.styleref.align == 5 or line.styleref.align == 8 then
    -- 居中对齐
    line.left = (meta.res_x - line.eff_margin_l - line.eff_margin_r - line.width) / 2 + line.eff_margin_l
    line.center = line.left + line.width / 2
    line.right = line.left + line.width
    line.x = line.center
    line.halign = "center"

  elseif line.styleref.align == 3 or line.styleref.align == 6 or line.styleref.align == 9 then
    -- 右对齐
    line.left = meta.res_x - line.eff_margin_r - line.width
    line.center = line.left + line.width / 2
    line.right = line.left + line.width
    line.x = line.right
    line.halign = "right"
  end
  line.hcenter = line.center

  if line.styleref.align >=1 and line.styleref.align <= 3 then
    -- 底部对齐
    line.bottom = meta.res_y - line.eff_margin_b
    line.middle = line.bottom - line.height / 2
    line.top = line.bottom - line.height
    line.y = line.bottom
    line.valign = "bottom"
  elseif line.styleref.align >= 4 and line.styleref.align <= 6 then
    -- 垂直居中
    line.top = (meta.res_y - line.eff_margin_t - line.eff_margin_b - line.height) / 2 + line.eff_margin_t
    line.middle = line.top + line.height / 2
    line.bottom = line.top + line.height
    line.y = line.middle
    line.valign = "middle"
  elseif line.styleref.align >= 7 and line.styleref.align <= 9 then
    -- 顶部对齐
    line.top = line.eff_margin_t
    line.middle = line.top + line.height / 2
    line.bottom = line.top + line.height
    line.y = line.top
    line.valign = "top"
  end
  line.vcenter = line.middle
end

-- 预计算指定行的大小信息，不作布局处理
-- 会修改行对象
function karaskel.preproc_line_size(meta, styles, line)
  if not line.kara then
    karaskel.preproc_line_text(meta, styles, line)
  end

  -- 增加样式信息
  if styles[line.style] then
    line.styleref = styles[line.style]
  else
    aegisub.debug.out(2, "WARNING: Style not found: " .. line.style .. "\n")
    line.styleref = styles[1]
  end

  -- 计算整行大小
  line.width, line.height, line.descent, line.extlead = aegisub.text_extents(line.styleref, line.text_stripped)
  line.width = line.width * meta.video_x_correct_factor

  -- 计算音节大小
  for s = 0, line.kara.n do
    local syl = line.kara[s]
    syl.style = line.styleref
    syl.width, syl.height = aegisub.text_extents(syl.style, syl.text_spacestripped)
    syl.width = syl.width * meta.video_x_correct_factor
    syl.prespacewidth = aegisub.text_extents(syl.style, syl.prespace) * meta.video_x_correct_factor
    syl.postspacewidth = aegisub.text_extents(syl.style, syl.postspace) * meta.video_x_correct_factor
  end