O formato funscript, campo por campo

A estrutura

Um funscript é um único objeto JSON salvo como texto UTF-8 com a extensão .funscript. Um arquivo pequeno completo, no formato em que o AutoScript Sync salva:

{
  "version": "1.0",
  "inverted": false,
  "range": 100,
  "metadata": {
    "creator": "AutoScript Sync",
    "format": "funscript"
  },
  "actions": [
    {"at": 0,    "pos": 50},
    {"at": 350,  "pos": 95},
    {"at": 720,  "pos": 5},
    {"at": 1080, "pos": 95},
    {"at": 1500, "pos": 5},
    {"at": 5500, "pos": 5}
  ]
}

Os dois últimos pontos mantêm a mesma posição por quatro segundos: uma pausa é escrita como dois pontos com o mesmo pos, não como uma lacuna. A ordem das chaves não importa em JSON, e os espaços em branco são livres.

Os campos

actions

Uma matriz de pontos, cada um um objeto com at e pos. É o único campo de que um player precisa. Um arquivo sem ele não é um script utilizável.

at

O momento do ponto em milissegundos a partir do início do vídeo, como número inteiro. 1500 é um segundo e meio de vídeo.

pos

A posição em que estar naquele momento, como número inteiro de 0 a 100. O que 0 e 100 significam fisicamente depende do dispositivo e das configurações dele; o arquivo só diz "até este ponto da faixa".

version

A versão do formato como string, geralmente "1.0".

inverted

true ou false. Quando for true, as posições devem ser lidas de cabeça para baixo, como 100 − pos.

range

Um número, geralmente 100, que descreve a amplitude de pos. A maioria dos arquivos o deixa em 100.

metadata

Um objeto para qualquer coisa sobre o script: o programa que o criou, um título, notas, tags. Os players não precisam dele para reproduzir o arquivo.

Arquivos de editores costumam trazer chaves extras no nível superior, como capítulos ou marcadores. Elas são permitidas; um leitor que não as entenda deve ignorá-las e, idealmente, mantê-las.

Convenções que um arquivo bem formado segue

• at é um número inteiro de milissegundos, contado a partir do início do vídeo, nunca negativo.
• pos é um número inteiro de 0 a 100.
• As ações são ordenadas por at, da mais cedo para a mais tarde.
• Nenhuma ação compartilha o mesmo at com outra.
• Os números são números JSON, não strings: "at": 400, e não "at": "400".

Os programas variam na tolerância quando um arquivo quebra essas regras. O app para desktop conserta o que consegue, como descrito abaixo. Nossa própria ferramenta de navegador, o Report Studio, não conserta: ela assume que as ações já estão ordenadas, pega a duração da última ação, ignora inverted e range, e rejeita um arquivo cujos valores de at sejam strings. Um arquivo que segue as cinco convenções evita essas diferenças.

Como o AutoScript Sync lê um arquivo

Quando você abre um script com Load Funscript…, solta o arquivo na janela ou abre um vídeo com um script de mesmo nome ao lado, o app conserta as ações em vez de recusar o arquivo:

• ordena as ações por tempo;
• funde ações que compartilham o mesmo tempo, mantendo a última;
• limita pos a 0–100 e tempos negativos a 0;
• pula entradas que não consegue ler, sem dizer quantas;
• lê range, mas nunca o usa para reescalar, então um arquivo com range diferente de 100 ainda é tratado como 0–100;
• mantém version como encontrado ("1.0" se estiver ausente).

A próxima atualização (2.121.2, já compilada, mas ainda não lançada) faz o leitor aceitar mais arquivos e preservar mais do que há neles:

• arquivos salvos com byte-order mark, ou em UTF-16, são carregados em vez de recusados;
• inverted: true é aplicado uma vez ao carregar (100 − pos), com um aviso para você, e o arquivo é salvo de volta com inverted: false, para que todos os outros players vejam o mesmo movimento. O app lançado ignora a flag, então um arquivo invertido toca de cabeça para baixo;
• valores fracionários de at e pos são arredondados para o inteiro mais próximo, e valores NaN ou infinitos são pulados;
• chaves de nível superior desconhecidas, como capítulos ou marcadores, são mantidas e gravadas de volta quando você salva; o app lançado as descarta ao salvar;
• um arquivo que não é texto, não é JSON, não é um objeto ou não tem lista actions recebe uma mensagem em linguagem simples, e um script sem ações utilizáveis não é associado ao vídeo.

Como o AutoScript Sync grava um arquivo

Todo script que o app salva, gerado ou editado, segue as convenções acima, não importa o que tenha acontecido no editor:

• Ações são gravadas em ordem crescente de tempo, com tempos únicos, at como número inteiro não negativo de milissegundos e pos como número inteiro de 0 a 100. Se dois pontos arredondarem para o mesmo milissegundo, prevalece o mais tardio.
• Cabeçalho: version, inverted e range são gravados como estão; um script gerado recebe "1.0", false e 100.
• Metadados: creator é sempre definido como "AutoScript Sync" e format como "funscript". Salvar por cima do script de outra ferramenta substitui o criador dele.
• Detalhes da análise nos scripts gerados: gerador, resumo do reconhecimento, tempos, caminho de rastreamento e um bloco ai com o rótulo de tipo de cena de cada janela de dois segundos, a região rastreada, quanto foi preenchido em vez de medido e as pontuações da eleição de âncora.
• Salvamento seguro: o JSON é gravado, indentado, num arquivo temporário e depois trocado pelo original, para que uma falha no meio do salvamento não corrompa o script existente.
• Backup: quando o Generate salva ao lado do vídeo, qualquer script existente é primeiro copiado para <name>.funscript.bak. Só um backup é mantido; o próximo Generate o sobrescreve.

O arquivo no disco nunca é ajustado a um dispositivo. Quando o app envia um script ao Autoblow AI Ultra, ele ajusta uma cópia aos limites do dispositivo e remove os metadados de análise, mantendo apenas o movimento e alguns campos do cabeçalho (generator, creator, format, version, range, stroke_expansion e um id, se houver).

Perguntas

Leia a seguir

• Verifique um arquivo com o validadorEncontra no seu navegador os erros descritos nesta página e oferece uma cópia consertada.
• Uma introdução em linguagem simplesO que é um funscript e como um dispositivo o usa, sem o detalhamento dos campos.
• Como criar um script, à mão ou geradoO fluxo do vídeo até um arquivo salvo e verificado.
• A central de aprendizadoAs quatro páginas de referência.