eyecandy

README

eyecandy

ASS(Advanced SubStation Alpha) karaoke effect generator (http://www.aegisub.org/)

Generated Docs

https://gowalker.org/github.com/Alquimista/eyecandy https://godoc.org/github.com/Alquimista/eyecandy

Rewrite of Eyecandy (Python)

https://github.com/Alquimista/Eyecandy-py

Documentation

Overview

Package eyecandy read/write SSA/ASS Subtitle Script

Index

• Constants
• func GetSyls(text string) [][]string
• func NewDialog(text string) *writer.Dialog
• func NewStyle(name string) *writer.Style
• func StripSSATags(text string) string
• func StripSSATagsNotKDur(text string) string
• type Char
• type Dialog
• type Line
  • func (d *Line) Chars() (chars []*Char)
  • func (d *Line) Syls() (syls []*Syl)
• type Script
  • func NewEffect(inFN string) *Script
  • func (fx *Script) Add(dialog interface{})
  • func (fx *Script) AddStyle(sty *writer.Style)
  • func (fx *Script) CopyChar(dialog *Char) Char
  • func (fx *Script) CopyLine(dialog *Line) Line
  • func (fx *Script) CopySyl(dialog *Syl) Syl
  • func (fx *Script) GetStyle(name string) (*reader.Style, bool)
  • func (fx *Script) Lines() (dialogs []*Line)
  • func (fx *Script) Save(fn string)
  • func (fx *Script) Styles() map[string]*reader.Style
• type Syl

Constants

const (
	// AlignBottomLeft Bottom Left SSA numbered Alignment
	AlignBottomLeft int = 1 + iota
	// AlignBottomCenter Bottom Center SSA numbered Alignment
	AlignBottomCenter
	// AlignBottomRight Bottom Right SSA numbered Alignment
	AlignBottomRight

	// AlignMiddleLeft Middle Left SSA numbered Alignment
	AlignMiddleLeft
	// AlignMiddleCenter Middle Center SSA numbered Alignment
	AlignMiddleCenter
	// AlignMiddleRight Middle Right SSA numbered Alignment
	AlignMiddleRight

	// AlignTopLeft Top Left SSA numbered Alignment
	AlignTopLeft
	// AlignTopCenter Top Left SSA numbered Alignment
	AlignTopCenter
	// AlignTopRight Top Right SSA numbered Alignment
	AlignTopRight
)

Functions

func GetSyls

func GetSyls(text string) [][]string

func NewDialog

func NewDialog(text string) *writer.Dialog

NewDialog create a new Dialog

func NewStyle

func NewStyle(name string) *writer.Style

NewStyle create a new Style

func StripSSATags

func StripSSATags(text string) string

func StripSSATagsNotKDur

func StripSSATagsNotKDur(text string) string

Types

type Char

type Char struct {
	Dialog
	Inline        string
	SylStartTime  int
	SylEndTime    int
	SylMidEndTime int
	SylDuration   int
}

Char Represent the subtitle"s lines.

type Dialog

type Dialog struct {
	Layer     int
	StartTime int
	EndTime   int
	StyleName string
	Actor     string
	Effect    string
	Text      string
	Tags      string
	Duration  int
	MidTime   int
	Style     *reader.Style
	Comment   bool
	Width     float64
	Height    float64
	Size      [2]float64
	XFix      float64
	X         float64
	Y         float64
	Top       float64
	Middle    float64
	Bottom    float64
	Left      float64
	Center    float64
	Right     float64
}

type Line

type Line struct {
	Dialog
	Kara  string
	SylN  int
	CharN int
	// contains filtered or unexported fields
}

Line Represent the subtitle"s lines.

func (*Line) Chars

func (d *Line) Chars() (chars []*Char)

Chars list all characters in a Line

func (*Line) Syls

func (d *Line) Syls() (syls []*Syl)

Syls list all syllables in a Line

type Script

type Script struct {
	Resolution         [2]int // WIDTH, HEIGHT
	VideoPath          string
	VideoZoom          float64
	VideoPosition      int
	VideoAR            float64
	MetaFilename       string
	MetaTitle          string
	MetaOriginalScript string
	MetaTranslation    string
	MetaTiming         string
	Audio              string
	LineN              int
	Shift              int
	XFix               float64
	// contains filtered or unexported fields
}

Script represent the SSA Script

func NewEffect

func NewEffect(inFN string) *Script

NewEffect create a new script

func (*Script) Add

func (fx *Script) Add(dialog interface{})

Add append a Dialog (Syl, Char, Line) to Script

func (*Script) AddStyle

func (fx *Script) AddStyle(sty *writer.Style)

AddStyle append a Style to Script

func (*Script) CopyChar

func (fx *Script) CopyChar(dialog *Char) Char

CopyChar create a copy of the current Char

func (*Script) CopyLine

func (fx *Script) CopyLine(dialog *Line) Line

CopyLine create a copy of the current Line

func (*Script) CopySyl

func (fx *Script) CopySyl(dialog *Syl) Syl

CopySyl create a copy of the current Syl

func (*Script) GetStyle

func (fx *Script) GetStyle(name string) (*reader.Style, bool)

GetStyle get a style corresponding to name provided

func (*Script) Lines

func (fx *Script) Lines() (dialogs []*Line)

Lines List all the lines in a Script

func (*Script) Save

func (fx *Script) Save(fn string)

Save create the final script file (.ass)

func (*Script) Styles

func (fx *Script) Styles() map[string]*reader.Style

Styles list styles use the Script

type Syl

type Syl struct {
	Dialog
	Inline string
}

Syl Represent the subtitle"s lines.