burner

package module

v0.2.2 Latest Latest Go to latest Published: Feb 1, 2023 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/shiroi-usagi/burner

Links

Open Source Insights

README ¶

Burner

Flags

      --ignore-font-error   skip font errors during encode
  -i, --input string        directory of the input files (default "./in")
  -m, --mode string         mode of the encoding
                              smp4 - Sample MP4. Encodes a sample with the subtitle burned on the video. Creates hardsub.
                              fmp4 - Fragmented MP4. Encodes a fragmented video (HLS) with the subtitle burned on the video. Creates hardsub.
                              mp4 - MP4. Encodes a video with the subtitle burned on the video. Creates hardsub.
                              transcode - Transcode. Encodes a video with the given options while keeping the original settings. Creates softsub.
  -o, --output string       directory of the output files (default "./out")
      --v-bitrate string    target video bitrate (default "1371k")
      --v-height int        target video height (default 720)
      --v-keep-bitrate      disables bitrate modification when the original file size smaller than the expected
      --v-upscaling         enable/disable upscaling
  -v, --verbose             make output verbose

Documentation ¶

Index ¶

Variables
func Burn(conf Config)
type Config
type Mode
- func ReadMode(reader io.RuneReader) Mode
- func StringToMode(s string) Mode
- func (m Mode) Label() string
type VersionInfo
- func GetVersionInfo() VersionInfo
type VideoConf

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	DefaultHeight  = 720
	DefaultBitrate = "1371k"
)

View Source

var (
	Modes = []Mode{
		ModeFragmentedMP4,
		ModeMP4,
		ModeTranscode,
		ModeSampleMP4,
	}
)

Functions ¶

func Burn ¶

func Burn(conf Config)

Types ¶

type Config ¶

type Config struct {
	Verbose bool

	Mode Mode

	InputDir    string
	OutputDir   string
	FFmpegPath  string
	FFprobePath string

	Video VideoConf

	IgnoreFontError bool
}

type Mode ¶

type Mode int

const (
	ModeNone Mode = iota - 1
	ModeSampleMP4
	ModeFragmentedMP4
	ModeMP4
	ModeTranscode
)

func ReadMode ¶

func ReadMode(reader io.RuneReader) Mode

ReadMode reads a rune from the given reader which value will be used to determine a Mode.

If the rune is unknown it returns ModeNone.

func StringToMode ¶

func StringToMode(s string) Mode

StringToMode recognises a string representation of modes.

If the string is unknown it returns ModeNone.

func (Mode) Label ¶

func (m Mode) Label() string

Label is a user friendly representation of m

type VersionInfo ¶

type VersionInfo struct {
	Version   string
	BuildDate string
	BuiltBy   string
}

func GetVersionInfo ¶

func GetVersionInfo() VersionInfo

type VideoConf ¶

type VideoConf struct {
	Height      int
	Bitrate     string
	Upscaling   bool
	KeepBitrate bool
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
burner
commandline
ffmpeg
ffprobe
filepathutil
internal
burn
prepare
version
ziputil

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL