added readme, removed defunct dependancies.

This commit is contained in:
Luke 2020-09-19 16:32:51 -07:00
parent 3547c0eaeb
commit 49fead9c6c
2 changed files with 46 additions and 4 deletions

42
README.md Normal file
View file

@ -0,0 +1,42 @@
# burnSubs
You found my burnSubs tool. The goal for this tool is to ease the
conversion of arbitrary video files with soft-subtitles in the SSA/ASS
Substation Alpha format into simple stereo hard-subtitled video files.
## Features
* softsub to hardsub conversion
* embedded font files
* selecting specific audio streams
* selecting specific video streams
* automatic selection of language preferences
* default surround sound to stereo down-mixing
* opt out CLI flag available
* anti-clobbering default behavior
* auto-cleanup on error
## Prerequisite Tools
Firstly, the tool will yell at you if the tools it needs don't exist.
Feel free to just run the tool, and it will let you know what you're
missing.
* [`ffmpeg`](https://ffmpeg.org/) - the one and only
* `ffprobe` - usually comes with ffmpeg
* [`jq`](https://stedolan.github.io/jq/) - file/pipe based JSON processor
## How does it work?
`burnSubs` takes an input video file and tries to figure out what
audio streams and subtitle streams exist within the file. It stores
metadata in `/tmp` while it runs. When running it will pull the
streams within the input file, and try to select Japanese language
audio streams, and a non-signs subtitle stream (i.e. a full language
subtitle stream) to add to the output video.
Before transcoding it will then extract the subtitle file to pass into
`ffmpeg`'s subtitle burn in filter, and will try to down-mix any
surround sound input streams to stereo. Downmixing, track selection,
clobbering behavior, and verbosity can all be controlled to a limited
extent by CLI flags.
## Can you make it do *XYZ*.
Give me an enhancement request in github and I'll take a look.

View file

@ -5,7 +5,7 @@ set -o errexit
################################################################################
# burnSubs
# version 0.13.1
# version 0.13.2
#################
# Wishlist:
# queue encodes
@ -139,9 +139,9 @@ function setupBins() {
setAndValidateBin "ffmpeg" "FFMPEG"
setAndValidateBin "ffprobe" "FFPROBE"
setAndValidateBin "jq" "JQ"
setAndValidateBin "python3" "PYTHON3"
setAndValidateBin "awk" "AWK"
setAndValidateBin "date" "DATE"
#setAndValidateBin "python3" "PYTHON3"
#setAndValidateBin "awk" "AWK"
#setAndValidateBin "date" "DATE"
}
# Used by the above function to evaluate overrides if they are set, and