muskel

README

MUsical SKEtch Language - MUSKEL

Documentation

Index

• Constants
• Variables
• func Convert(mainFile path.Local, params []string, smffile path.Local, opts ...score.Option) error
• func Format(filename path.Local, params []string, rd io.Reader, wr io.Writer, ...) error
• func FormatFS(fsys fs.FS, filename path.Relative, params []string, rd io.Reader, ...) error
• func LilypondScore(mainFile path.Local, params []string, opts ...score.Option) (string, error)
• func PDFScore(mainFile path.Local, params []string, pdffile path.Local, opts ...score.Option) error
• func ParseFile(mainFile path.Local, params []string, opts ...score.Option) (sc *score.Score, err error)
• func ReadWDVersionFile(dir path.Local) (*version.Version, error)
• func Unroll(mainFile path.Local, params []string, rd io.Reader, wr io.Writer, ...) error
• func UnrollFS(fsys fs.FS, mainFile path.Relative, params []string, rd io.Reader, ...) error
• func WriteImage(sc *score.Score, outfile path.Local, opts ...smfimage.Option) error
• func WritePredefinedTemplates(fsys fs.FS) error
• func WriteSMF(filename path.Local, params []string, rd io.Reader, fmtwr io.Writer, ...) error
• func WriteSMFFile(sc *score.Score, smffile path.Local) error
• func WriteWDVersionFile(dir string) error

Constants

const MUSKEL_VERSION_FILE = "muskel_version.txt"

Variables

var FILE_EXTENSION = ".mskl"

var USER_DIR path.Local

var WORKING_DIR = path.MustWD()

Functions

func Convert

func Convert(mainFile path.Local, params []string, smffile path.Local, opts ...score.Option) error

func Format

func Format(filename path.Local, params []string, rd io.Reader, wr io.Writer, opts ...score.Option) error

func FormatFS

func FormatFS(fsys fs.FS, filename path.Relative, params []string, rd io.Reader, wr io.Writer, opts ...score.Option) error

func LilypondScore

func LilypondScore(mainFile path.Local, params []string, opts ...score.Option) (string, error)

func PDFScore

func PDFScore(mainFile path.Local, params []string, pdffile path.Local, opts ...score.Option) error

func ParseFile

func ParseFile(mainFile path.Local, params []string, opts ...score.Option) (sc *score.Score, err error)

func ReadWDVersionFile

func ReadWDVersionFile(dir path.Local) (*version.Version, error)

func Unroll

func Unroll(mainFile path.Local, params []string, rd io.Reader, wr io.Writer, opts ...score.Option) error

func UnrollFS

func UnrollFS(fsys fs.FS, mainFile path.Relative, params []string, rd io.Reader, wr io.Writer, opts ...score.Option) error

func WriteImage

func WriteImage(sc *score.Score, outfile path.Local, opts ...smfimage.Option) error

WriteImage expects the given score to be unrolled

func WritePredefinedTemplates

func WritePredefinedTemplates(fsys fs.FS) error

func WriteSMF

func WriteSMF(filename path.Local, params []string, rd io.Reader, fmtwr io.Writer, midwr io.Writer, opts ...score.Option) error

func WriteSMFFile

func WriteSMFFile(sc *score.Score, smffile path.Local) error

func WriteSMFFile(sc *score.Score, smffile string, opts ...smfwriter.Option) error {

func WriteWDVersionFile

func WriteWDVersionFile(dir string) error