0.0.6 -> Master (#731)
* Implement webhook events for external integrations (#574) * Implement webhook events for external integrations Reference #556 * move message type to models and remove duplicate * add json header so content type can be determined * Pass at migrating webhooks to datastore + management apis (#589) * Pass at migrating webhooks to datastore + management apis * Support nil lastUsed timestamps and return back the new webhook on create * Cleanup from review feedback * Simplify a bit Co-authored-by: Aaron Ogle <aaron@geekgonecrazy.com> Co-authored-by: Gabe Kangas <gabek@real-ity.com> * Webhook query cleanup * Access tokens + Send system message external API (#585) * New add, get and delete access token APIs * Create auth token middleware * Update last_used timestamp when using an access token * Add auth'ed endpoint for sending system messages * Cleanup * Update api spec for new apis * Commit updated API documentation * Add auth'ed endpoint for sending user chat messages * Return access token string * Commit updated API documentation * Fix route * Support nil lastUsed time * Commit updated Javascript packages * Remove duplicate function post rebase * Fix msg id generation * Update controllers/admin/chat.go Co-authored-by: Aaron Ogle <geekgonecrazy@users.noreply.github.com> * Webhook query cleanup * Add SystemMessageSent to EventType Co-authored-by: Owncast <owncast@owncast.online> Co-authored-by: Aaron Ogle <geekgonecrazy@users.noreply.github.com> * Set webhook as used on completion. Closes #610 * Display webhook errors as errors * Commit updated API documentation * Add user joined chat event * Change integration API paths. Update API spec * Update development version of admin that supports integration apis * Commit updated API documentation * Add automated tests for external integration APIs * check error * quiet this test for now * Route up some additional 3rd party apis. #638 * Commit updated API documentation * Save username on user joined event * Add missing scope to valid scopes list * Add generic chat action event API for 3rd parties. Closes #666 * Commit updated API documentation * First pass at moving WIP config framework into project for #234 * Only support exported fields in custom types * Using YP get/set key as a first pass at using the data layer. Fixes + integration. * Ignore test db * Start adding getters and setters for config values * More get/set config work. Starting to populate api with data * Wire up some config edit endpoints * More endpoints * Disable cors middleware * Add more endpoints and add test to test them * Remove the in-memory change APIs * Add endpoint for changing tags * Add more config endpoints * Starting to point more things away from config file and to the datastore * Populate YP with db data * Create new util method for parsing page body markdown and return it in api * Verify proposed path to ffmpeg * For development purposes show the config key in logs * Move stats values to datastore * Moving over more values to the datastore * Move S3 config to datastore * First pass the config -> db migrator * Add the start of the video config apis * It builds pointing everything away from the config * Tweak ffmpeg path error message * Backup database every hour. Closes #549 * Config + defaults + migration work for db * Cleanup logging * Remove all the old config structs * Add descriptive info about migration * Tweak ffmpeg validation logic * Fix db backup path. backup on db version migration * Set video and s3 configurations * Update api spec with new config endpoints * Add migrator for stats file * Commit updated API documentation * Use a dynamic system port for internal HLS writes. Closes #577 (#626) * Use a dynamic system port for internal HLS writes. Closes #577 * Cleanup * YP key migration to datastore * Create a backup directory if needed before migrations * Remove config test that no longer makes sense. Cleanup. * Change number types from float32 to float64 * Update automated test suite * Allow restoring a database backup via command line flags. Closes #549 * Add new hls segment config api * Commit updated API documentation * Update apis to require a value container property * add socialHandles api * Commit updated API documentation * Add new latancy level setting to replace segment settings * Commit updated API documentation * Fix spelling * Commit updated API documentation * hardcode a json api of available social platforms * Add additional icons * Return social handles in server config api * Add socialhandles validation to test * Move list of hard coded social platforms to an api * Remove audio only code from transcoder since we do not use it * Add latency levels api + snapshot of video settings as current broadcast * Add config/serverurl endpoint * Return 404 on YP api if disabled * Surface stream title in YP response * Add stream title to web ui * Cleanup log message. Closes #520 * Rename ffmpeg package to transcoder * Add ws package for testing * Reduce chat backlog to past 5hrs, max 50. Closes #548 * Fix error formatting * Add endpoint for resetting yp registration * Add yp/reset to api spec. return status in response * Return zero viewer count if stream is offline. Closes #422 * Post-rebase fixes * Fix merge conflict in openapi file * Commit updated API documentation * Standardize controller names * Support setting the stream key via the command line. Closes #665 * Return social handles with YP data. First half of https://github.com/owncast/owncast-yp/issues/28 * Give the YP package access to server status regardless if enabled or not * Change delay in automated tests * Add stream title integration API. For #638 * Commit updated API documentation * Add storage to the migrator * Missing returning NSFW value in server config * Add flag to ignore websocket client. Closes #537 * Add error for parsing broadcaster metadata * Add support for a cli specified http server port. Closes #674 * Add cpu usage levels and a temporary mapping between it and libx264 presets * Test for valid url endpoint when saving s3 config * Re-configure storage on every stream to allow changing storage providers * After 5 minutes of a stream being stopped clear the stream title * Hide viewer count once stream goes offline instead of when player stops * Pull steamTitle from the status that gets updated instead of the config * Commit updated API documentation * Optionally show stream title in the header * Reset stream title when server starts * Show chat action when stream title is updated * Allow system messages to come back in persistence * Split out getting chat history for moderation + fix tests * Remove server title and standardize on name only * Commit updated API documentation * Bump github.com/aws/aws-sdk-go from 1.37.1 to 1.37.2 (#680) Bumps [github.com/aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) from 1.37.1 to 1.37.2. - [Release notes](https://github.com/aws/aws-sdk-go/releases) - [Changelog](https://github.com/aws/aws-sdk-go/blob/master/CHANGELOG.md) - [Commits](https://github.com/aws/aws-sdk-go/compare/v1.37.1...v1.37.2) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add video variant and stream latency config file migrator * Remove mostly unused disable upgrade check bool * Commit updated API documentation * Allow bundling the admin from the 0.0.6 branch * Fix saving port numbers * Use name instead of old title on window focus * Work on latency levels. Fix test to use levels. Clean up transcoder to only reference levels * Another place where title -> name * Fix test * Bump github.com/aws/aws-sdk-go from 1.37.2 to 1.37.3 (#690) Bumps [github.com/aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) from 1.37.2 to 1.37.3. - [Release notes](https://github.com/aws/aws-sdk-go/releases) - [Changelog](https://github.com/aws/aws-sdk-go/blob/master/CHANGELOG.md) - [Commits](https://github.com/aws/aws-sdk-go/compare/v1.37.2...v1.37.3) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update dependabot config * Bump github.com/aws/aws-sdk-go from 1.37.3 to 1.37.5 (#693) Bumps [github.com/aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) from 1.37.3 to 1.37.5. - [Release notes](https://github.com/aws/aws-sdk-go/releases) - [Changelog](https://github.com/aws/aws-sdk-go/blob/master/CHANGELOG.md) - [Commits](https://github.com/aws/aws-sdk-go/compare/v1.37.3...v1.37.5) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump video.js from 7.10.2 to 7.11.4 in /build/javascript (#694) * Bump video.js from 7.10.2 to 7.11.4 in /build/javascript Bumps [video.js](https://github.com/videojs/video.js) from 7.10.2 to 7.11.4. - [Release notes](https://github.com/videojs/video.js/releases) - [Changelog](https://github.com/videojs/video.js/blob/main/CHANGELOG.md) - [Commits](https://github.com/videojs/video.js/compare/v7.10.2...v7.11.4) Signed-off-by: dependabot[bot] <support@github.com> * Commit updated Javascript packages Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Owncast <owncast@owncast.online> * Make the latency migrator dynamic so I can tweak values easier * Split out fetching ffmpeg path from validating the path so it can be changed in the admin * Some commenting and linter cleanup * Validate the path for a logo change and throw an error if it does not exist * Logo change requests have to be a real file now * Cleanup, making linter happy * Format javascript on push * Only format js in master * Tweak latency level values * Remove unused config file examples * Fix thumbnail generation after messing with the ffmpeg path getter * Reduce how often we report high hardware utilization warnings * Bundle the 0.0.6 branch version of the admin * Return validated ffmpeg path in admin server config * Change the logo to be stored in the data directory instead of webroot * Bump postcss from 8.2.4 to 8.2.5 in /build/javascript (#702) Bumps [postcss](https://github.com/postcss/postcss) from 8.2.4 to 8.2.5. - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](https://github.com/postcss/postcss/compare/8.2.4...8.2.5) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Default config file no longer used * don't show stream title when offline addresses https://github.com/owncast/owncast/issues/677 * Remove auto-clearing stream title. #677 * webroot -> data when using logo as thumbnail * Do not list websocket/access token create/delete as integration APIs * Commit updated API documentation * Bundle updated admin * Remove pointing to the 0.0.6 admin branch * Linter cleanup * Linter cleanup * Add donations and follow links to show up under social handles * Prettified Code! * More linter cleanup * Update admin bundle * Remove use of platforms.js and return icons with social handles. Closes #732 * Update admin bundle * Support custom config path for use in migration * Remove unused platform-logos.gif * Reduce log level of message * Remove unused logo files in static dir * Handle dev vs. release build info * Restore logo.png for initial thumbnail * Cleanup some files from the build process that are not needed * Fix incorrect build-time injection var * Fix missing file getting copied to the build * Remove console directory message. * Update admin bundle * Fix comment * Report storage setup error * add some value set error checking * Use validated dynamic ffmpeg path for animated gif preview * Make chat message links be white so they don't hide in the bg. Closes #599 * Restore conditional that was accidentally removed Co-authored-by: Aaron Ogle <geekgonecrazy@users.noreply.github.com> Co-authored-by: Owncast <owncast@owncast.online> Co-authored-by: Ginger Wong <omqmail@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: nebunez <uoj2y7wak869@opayq.net> Co-authored-by: gabek <gabek@users.noreply.github.com>
This commit is contained in:
98
core/transcoder/fileWriterReceiverService.go
Normal file
98
core/transcoder/fileWriterReceiverService.go
Normal file
@@ -0,0 +1,98 @@
|
||||
package transcoder
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"io"
|
||||
"net"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"net/http"
|
||||
|
||||
"github.com/owncast/owncast/config"
|
||||
"github.com/owncast/owncast/utils"
|
||||
log "github.com/sirupsen/logrus"
|
||||
)
|
||||
|
||||
// FileWriterReceiverServiceCallback are to be fired when transcoder responses are written to disk.
|
||||
type FileWriterReceiverServiceCallback interface {
|
||||
SegmentWritten(localFilePath string)
|
||||
VariantPlaylistWritten(localFilePath string)
|
||||
MasterPlaylistWritten(localFilePath string)
|
||||
}
|
||||
|
||||
// FileWriterReceiverService accepts transcoder responses via HTTP and fires the callbacks.
|
||||
type FileWriterReceiverService struct {
|
||||
callbacks FileWriterReceiverServiceCallback
|
||||
}
|
||||
|
||||
// SetupFileWriterReceiverService will start listening for transcoder responses.
|
||||
func (s *FileWriterReceiverService) SetupFileWriterReceiverService(callbacks FileWriterReceiverServiceCallback) {
|
||||
s.callbacks = callbacks
|
||||
|
||||
httpServer := http.NewServeMux()
|
||||
httpServer.HandleFunc("/", s.uploadHandler)
|
||||
|
||||
localListenerAddress := "127.0.0.1:0"
|
||||
|
||||
go func() {
|
||||
listener, err := net.Listen("tcp", localListenerAddress)
|
||||
if err != nil {
|
||||
log.Fatalln("Unable to start internal video writing service", err)
|
||||
}
|
||||
|
||||
listenerPort := strings.Split(listener.Addr().String(), ":")[1]
|
||||
config.InternalHLSListenerPort = listenerPort
|
||||
log.Traceln("Transcoder response service listening on: " + listenerPort)
|
||||
|
||||
if err := http.Serve(listener, httpServer); err != nil {
|
||||
log.Fatalln("Unable to start internal video writing service", err)
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
func (s *FileWriterReceiverService) uploadHandler(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method != "PUT" {
|
||||
http.Error(w, http.StatusText(http.StatusBadRequest), http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
path := r.URL.Path
|
||||
writePath := filepath.Join(config.PrivateHLSStoragePath, path)
|
||||
|
||||
var buf bytes.Buffer
|
||||
_, _ = io.Copy(&buf, r.Body)
|
||||
data := buf.Bytes()
|
||||
|
||||
f, err := os.Create(writePath)
|
||||
if err != nil {
|
||||
returnError(err, w)
|
||||
return
|
||||
}
|
||||
|
||||
defer f.Close()
|
||||
_, err = f.Write(data)
|
||||
if err != nil {
|
||||
returnError(err, w)
|
||||
return
|
||||
}
|
||||
|
||||
s.fileWritten(writePath)
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}
|
||||
|
||||
func (s *FileWriterReceiverService) fileWritten(path string) {
|
||||
if utils.GetRelativePathFromAbsolutePath(path) == "hls/stream.m3u8" {
|
||||
s.callbacks.MasterPlaylistWritten(path)
|
||||
} else if strings.HasSuffix(path, ".ts") {
|
||||
s.callbacks.SegmentWritten(path)
|
||||
} else if strings.HasSuffix(path, ".m3u8") {
|
||||
s.callbacks.VariantPlaylistWritten(path)
|
||||
}
|
||||
}
|
||||
|
||||
func returnError(err error, w http.ResponseWriter) {
|
||||
log.Debugln(err)
|
||||
http.Error(w, http.StatusText(http.StatusInternalServerError)+": "+err.Error(), http.StatusInternalServerError)
|
||||
}
|
||||
79
core/transcoder/hlsFilesystemCleanup.go
Normal file
79
core/transcoder/hlsFilesystemCleanup.go
Normal file
@@ -0,0 +1,79 @@
|
||||
package transcoder
|
||||
|
||||
import (
|
||||
log "github.com/sirupsen/logrus"
|
||||
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sort"
|
||||
|
||||
"github.com/owncast/owncast/core/data"
|
||||
)
|
||||
|
||||
// CleanupOldContent will delete old files from the private dir that are no longer being referenced
|
||||
// in the stream.
|
||||
func CleanupOldContent(baseDirectory string) {
|
||||
// Determine how many files we should keep on disk
|
||||
maxNumber := int(data.GetStreamLatencyLevel().SegmentCount)
|
||||
buffer := 10
|
||||
|
||||
files, err := getAllFilesRecursive(baseDirectory)
|
||||
if err != nil {
|
||||
log.Errorln("Unable to cleanup old video files", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Delete old private HLS files on disk
|
||||
for directory := range files {
|
||||
files := files[directory]
|
||||
if len(files) < maxNumber+buffer {
|
||||
continue
|
||||
}
|
||||
|
||||
filesToDelete := files[maxNumber+buffer:]
|
||||
log.Traceln("Deleting", len(filesToDelete), "old files from", baseDirectory, "for video variant", directory)
|
||||
|
||||
for _, file := range filesToDelete {
|
||||
fileToDelete := filepath.Join(baseDirectory, directory, file.Name())
|
||||
err := os.Remove(fileToDelete)
|
||||
if err != nil {
|
||||
log.Errorln(err)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func getAllFilesRecursive(baseDirectory string) (map[string][]os.FileInfo, error) {
|
||||
var files = make(map[string][]os.FileInfo)
|
||||
|
||||
var directory string
|
||||
err := filepath.Walk(baseDirectory, func(path string, info os.FileInfo, err error) error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if info.IsDir() {
|
||||
directory = info.Name()
|
||||
}
|
||||
|
||||
if filepath.Ext(info.Name()) == ".ts" {
|
||||
files[directory] = append(files[directory], info)
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
|
||||
if err != nil {
|
||||
log.Fatalf(err.Error())
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Sort by date so we can delete old files
|
||||
for directory := range files {
|
||||
sort.Slice(files[directory], func(i, j int) bool {
|
||||
return files[directory][i].ModTime().UnixNano() > files[directory][j].ModTime().UnixNano()
|
||||
})
|
||||
}
|
||||
|
||||
return files, nil
|
||||
}
|
||||
25
core/transcoder/hlsHandler.go
Normal file
25
core/transcoder/hlsHandler.go
Normal file
@@ -0,0 +1,25 @@
|
||||
package transcoder
|
||||
|
||||
import (
|
||||
"github.com/owncast/owncast/models"
|
||||
)
|
||||
|
||||
// HLSHandler gets told about available HLS playlists and segments.
|
||||
type HLSHandler struct {
|
||||
Storage models.StorageProvider
|
||||
}
|
||||
|
||||
// SegmentWritten is fired when a HLS segment is written to disk.
|
||||
func (h *HLSHandler) SegmentWritten(localFilePath string) {
|
||||
h.Storage.SegmentWritten(localFilePath)
|
||||
}
|
||||
|
||||
// VariantPlaylistWritten is fired when a HLS variant playlist is written to disk.
|
||||
func (h *HLSHandler) VariantPlaylistWritten(localFilePath string) {
|
||||
h.Storage.VariantPlaylistWritten(localFilePath)
|
||||
}
|
||||
|
||||
// MasterPlaylistWritten is fired when a HLS master playlist is written to disk.
|
||||
func (h *HLSHandler) MasterPlaylistWritten(localFilePath string) {
|
||||
h.Storage.MasterPlaylistWritten(localFilePath)
|
||||
}
|
||||
127
core/transcoder/thumbnailGenerator.go
Normal file
127
core/transcoder/thumbnailGenerator.go
Normal file
@@ -0,0 +1,127 @@
|
||||
package transcoder
|
||||
|
||||
import (
|
||||
"io/ioutil"
|
||||
"os/exec"
|
||||
"path"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
log "github.com/sirupsen/logrus"
|
||||
|
||||
"github.com/owncast/owncast/config"
|
||||
"github.com/owncast/owncast/core/data"
|
||||
"github.com/owncast/owncast/utils"
|
||||
)
|
||||
|
||||
var _timer *time.Ticker
|
||||
|
||||
func StopThumbnailGenerator() {
|
||||
if _timer != nil {
|
||||
_timer.Stop()
|
||||
}
|
||||
}
|
||||
|
||||
// StartThumbnailGenerator starts generating thumbnails.
|
||||
func StartThumbnailGenerator(chunkPath string, variantIndex int) {
|
||||
// Every 20 seconds create a thumbnail from the most
|
||||
// recent video segment.
|
||||
_timer = time.NewTicker(20 * time.Second)
|
||||
quit := make(chan struct{})
|
||||
|
||||
go func() {
|
||||
for {
|
||||
select {
|
||||
case <-_timer.C:
|
||||
if err := fireThumbnailGenerator(chunkPath, variantIndex); err != nil {
|
||||
log.Errorln("Unable to generate thumbnail:", err)
|
||||
}
|
||||
case <-quit:
|
||||
log.Debug("thumbnail generator has stopped")
|
||||
_timer.Stop()
|
||||
return
|
||||
}
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
func fireThumbnailGenerator(segmentPath string, variantIndex int) error {
|
||||
// JPG takes less time to encode than PNG
|
||||
outputFile := path.Join(config.WebRoot, "thumbnail.jpg")
|
||||
previewGifFile := path.Join(config.WebRoot, "preview.gif")
|
||||
|
||||
framePath := path.Join(segmentPath, strconv.Itoa(variantIndex))
|
||||
files, err := ioutil.ReadDir(framePath)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
var modTime time.Time
|
||||
var names []string
|
||||
for _, fi := range files {
|
||||
if path.Ext(fi.Name()) != ".ts" {
|
||||
continue
|
||||
}
|
||||
|
||||
if fi.Mode().IsRegular() {
|
||||
if !fi.ModTime().Before(modTime) {
|
||||
if fi.ModTime().After(modTime) {
|
||||
modTime = fi.ModTime()
|
||||
names = names[:0]
|
||||
}
|
||||
names = append(names, fi.Name())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if len(names) == 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
mostRecentFile := path.Join(framePath, names[0])
|
||||
ffmpegPath := utils.ValidatedFfmpegPath(data.GetFfMpegPath())
|
||||
|
||||
thumbnailCmdFlags := []string{
|
||||
ffmpegPath,
|
||||
"-y", // Overwrite file
|
||||
"-threads 1", // Low priority processing
|
||||
"-t 1", // Pull from frame 1
|
||||
"-i", mostRecentFile, // Input
|
||||
"-f image2", // format
|
||||
"-vframes 1", // Single frame
|
||||
outputFile,
|
||||
}
|
||||
|
||||
ffmpegCmd := strings.Join(thumbnailCmdFlags, " ")
|
||||
if _, err := exec.Command("sh", "-c", ffmpegCmd).Output(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// If YP support is enabled also create an animated GIF preview
|
||||
if data.GetDirectoryEnabled() {
|
||||
makeAnimatedGifPreview(mostRecentFile, previewGifFile)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func makeAnimatedGifPreview(sourceFile string, outputFile string) {
|
||||
ffmpegPath := utils.ValidatedFfmpegPath(data.GetFfMpegPath())
|
||||
|
||||
// Filter is pulled from https://engineering.giphy.com/how-to-make-gifs-with-ffmpeg/
|
||||
animatedGifFlags := []string{
|
||||
ffmpegPath,
|
||||
"-y", // Overwrite file
|
||||
"-threads 1", // Low priority processing
|
||||
"-i", sourceFile, // Input
|
||||
"-t 1", // Output is one second in length
|
||||
"-filter_complex", "\"[0:v] fps=8,scale=w=480:h=-1:flags=lanczos,split [a][b];[a] palettegen=stats_mode=full [p];[b][p] paletteuse=new=1\"",
|
||||
outputFile,
|
||||
}
|
||||
|
||||
ffmpegCmd := strings.Join(animatedGifFlags, " ")
|
||||
if _, err := exec.Command("sh", "-c", ffmpegCmd).Output(); err != nil {
|
||||
log.Errorln(err)
|
||||
}
|
||||
}
|
||||
379
core/transcoder/transcoder.go
Normal file
379
core/transcoder/transcoder.go
Normal file
@@ -0,0 +1,379 @@
|
||||
package transcoder
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os/exec"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
log "github.com/sirupsen/logrus"
|
||||
"github.com/teris-io/shortid"
|
||||
|
||||
"github.com/owncast/owncast/config"
|
||||
"github.com/owncast/owncast/core/data"
|
||||
"github.com/owncast/owncast/models"
|
||||
"github.com/owncast/owncast/utils"
|
||||
)
|
||||
|
||||
var _commandExec *exec.Cmd
|
||||
|
||||
// Transcoder is a single instance of a video transcoder.
|
||||
type Transcoder struct {
|
||||
input string
|
||||
segmentOutputPath string
|
||||
playlistOutputPath string
|
||||
variants []HLSVariant
|
||||
appendToStream bool
|
||||
ffmpegPath string
|
||||
segmentIdentifier string
|
||||
internalListenerPort string
|
||||
|
||||
currentStreamOutputSettings []models.StreamOutputVariant
|
||||
currentLatencyLevel models.LatencyLevel
|
||||
|
||||
TranscoderCompleted func(error)
|
||||
}
|
||||
|
||||
// HLSVariant is a combination of settings that results in a single HLS stream.
|
||||
type HLSVariant struct {
|
||||
index int
|
||||
|
||||
videoSize VideoSize // Resizes the video via scaling
|
||||
framerate int // The output framerate
|
||||
videoBitrate int // The output bitrate
|
||||
isVideoPassthrough bool // Override all settings and just copy the video stream
|
||||
|
||||
audioBitrate string // The audio bitrate
|
||||
isAudioPassthrough bool // Override all settings and just copy the audio stream
|
||||
|
||||
encoderPreset string // A collection of automatic settings for the encoder. https://trac.ffmpeg.org/wiki/Encode/H.264#crf
|
||||
}
|
||||
|
||||
// VideoSize is the scaled size of the video output.
|
||||
type VideoSize struct {
|
||||
Width int
|
||||
Height int
|
||||
}
|
||||
|
||||
// getString returns a WxH formatted getString for scaling video output.
|
||||
func (v *VideoSize) getString() string {
|
||||
widthString := strconv.Itoa(v.Width)
|
||||
heightString := strconv.Itoa(v.Height)
|
||||
|
||||
if widthString != "0" && heightString != "0" {
|
||||
return widthString + ":" + heightString
|
||||
} else if widthString != "0" {
|
||||
return widthString + ":-2"
|
||||
} else if heightString != "0" {
|
||||
return "-2:" + heightString
|
||||
}
|
||||
|
||||
return ""
|
||||
}
|
||||
|
||||
func (t *Transcoder) Stop() {
|
||||
log.Traceln("Transcoder STOP requested.")
|
||||
err := _commandExec.Process.Kill()
|
||||
if err != nil {
|
||||
log.Errorln(err)
|
||||
}
|
||||
}
|
||||
|
||||
// Start will execute the transcoding process with the settings previously set.
|
||||
func (t *Transcoder) Start() {
|
||||
command := t.getString()
|
||||
|
||||
log.Tracef("Video transcoder started with %d stream variants.", len(t.variants))
|
||||
|
||||
if config.EnableDebugFeatures {
|
||||
log.Println(command)
|
||||
}
|
||||
|
||||
_commandExec = exec.Command("sh", "-c", command)
|
||||
err := _commandExec.Start()
|
||||
if err != nil {
|
||||
log.Errorln("Transcoder error. See transcoder.log for full output to debug.")
|
||||
log.Panicln(err, command)
|
||||
}
|
||||
|
||||
err = _commandExec.Wait()
|
||||
if t.TranscoderCompleted != nil {
|
||||
t.TranscoderCompleted(err)
|
||||
}
|
||||
}
|
||||
|
||||
func (t *Transcoder) getString() string {
|
||||
var port = t.internalListenerPort
|
||||
localListenerAddress := "http://127.0.0.1:" + port
|
||||
|
||||
hlsOptionFlags := []string{}
|
||||
|
||||
if t.appendToStream {
|
||||
hlsOptionFlags = append(hlsOptionFlags, "append_list")
|
||||
}
|
||||
|
||||
if t.segmentIdentifier == "" {
|
||||
t.segmentIdentifier = shortid.MustGenerate()
|
||||
}
|
||||
|
||||
hlsOptionsString := ""
|
||||
if len(hlsOptionFlags) > 0 {
|
||||
hlsOptionsString = "-hls_flags " + strings.Join(hlsOptionFlags, "+")
|
||||
}
|
||||
ffmpegFlags := []string{
|
||||
t.ffmpegPath,
|
||||
"-hide_banner",
|
||||
"-loglevel warning",
|
||||
"-i ", t.input,
|
||||
|
||||
t.getVariantsString(),
|
||||
|
||||
// HLS Output
|
||||
"-f", "hls",
|
||||
|
||||
"-hls_time", strconv.Itoa(t.currentLatencyLevel.SecondsPerSegment), // Length of each segment
|
||||
"-hls_list_size", strconv.Itoa(t.currentLatencyLevel.SegmentCount), // Max # in variant playlist
|
||||
"-hls_delete_threshold", "10", // Start deleting files after hls_list_size + 10
|
||||
hlsOptionsString,
|
||||
|
||||
// Video settings
|
||||
"-tune", "zerolatency", // Option used for good for fast encoding and low-latency streaming (always includes iframes in each segment)
|
||||
"-pix_fmt", "yuv420p", // Force yuv420p color format
|
||||
"-sc_threshold", "0", // Disable scene change detection for creating segments
|
||||
|
||||
// Filenames
|
||||
"-master_pl_name", "stream.m3u8",
|
||||
"-strftime 1", // Support the use of strftime in filenames
|
||||
|
||||
"-hls_segment_filename", localListenerAddress + "/%v/stream-" + t.segmentIdentifier + "%s.ts", // Send HLS segments back to us over HTTP
|
||||
"-max_muxing_queue_size", "400", // Workaround for Too many packets error: https://trac.ffmpeg.org/ticket/6375?cversion=0
|
||||
|
||||
"-method PUT -http_persistent 0", // HLS results sent back to us will be over PUTs
|
||||
"-fflags +genpts", // Generate presentation time stamp if missing
|
||||
localListenerAddress + "/%v/stream.m3u8", // Send HLS playlists back to us over HTTP
|
||||
"2> transcoder.log", // Log to a file for debugging
|
||||
}
|
||||
|
||||
return strings.Join(ffmpegFlags, " ")
|
||||
}
|
||||
|
||||
func getVariantFromConfigQuality(quality models.StreamOutputVariant, index int) HLSVariant {
|
||||
variant := HLSVariant{}
|
||||
variant.index = index
|
||||
variant.isAudioPassthrough = quality.IsAudioPassthrough
|
||||
variant.isVideoPassthrough = quality.IsVideoPassthrough
|
||||
|
||||
// If no audio bitrate is specified then we pass through original audio
|
||||
if quality.AudioBitrate == 0 {
|
||||
variant.isAudioPassthrough = true
|
||||
}
|
||||
|
||||
if quality.VideoBitrate == 0 {
|
||||
quality.VideoBitrate = 1200
|
||||
}
|
||||
|
||||
// If the video is being passed through then
|
||||
// don't continue to set options on the variant.
|
||||
if variant.isVideoPassthrough {
|
||||
return variant
|
||||
}
|
||||
|
||||
// Set a default, reasonable preset if one is not provided.
|
||||
// "superfast" and "ultrafast" are generally not recommended since they look bad.
|
||||
// https://trac.ffmpeg.org/wiki/Encode/H.264
|
||||
variant.encoderPreset = quality.GetEncoderPreset()
|
||||
|
||||
variant.SetVideoBitrate(quality.VideoBitrate)
|
||||
variant.SetAudioBitrate(strconv.Itoa(quality.AudioBitrate) + "k")
|
||||
variant.SetVideoScalingWidth(quality.ScaledWidth)
|
||||
variant.SetVideoScalingHeight(quality.ScaledHeight)
|
||||
variant.SetVideoFramerate(quality.GetFramerate())
|
||||
|
||||
return variant
|
||||
}
|
||||
|
||||
// NewTranscoder will return a new Transcoder, populated by the config.
|
||||
func NewTranscoder() *Transcoder {
|
||||
ffmpegPath := utils.ValidatedFfmpegPath(data.GetFfMpegPath())
|
||||
|
||||
transcoder := new(Transcoder)
|
||||
transcoder.ffmpegPath = ffmpegPath
|
||||
transcoder.internalListenerPort = config.InternalHLSListenerPort
|
||||
|
||||
transcoder.currentStreamOutputSettings = data.GetStreamOutputVariants()
|
||||
transcoder.currentLatencyLevel = data.GetStreamLatencyLevel()
|
||||
|
||||
var outputPath string
|
||||
if data.GetS3Config().Enabled {
|
||||
// Segments are not available via the local HTTP server
|
||||
outputPath = config.PrivateHLSStoragePath
|
||||
} else {
|
||||
// Segments are available via the local HTTP server
|
||||
outputPath = config.PublicHLSStoragePath
|
||||
}
|
||||
|
||||
transcoder.segmentOutputPath = outputPath
|
||||
// Playlists are available via the local HTTP server
|
||||
transcoder.playlistOutputPath = config.PublicHLSStoragePath
|
||||
|
||||
transcoder.input = utils.GetTemporaryPipePath()
|
||||
|
||||
for index, quality := range transcoder.currentStreamOutputSettings {
|
||||
variant := getVariantFromConfigQuality(quality, index)
|
||||
transcoder.AddVariant(variant)
|
||||
}
|
||||
|
||||
return transcoder
|
||||
}
|
||||
|
||||
// Uses `map` https://www.ffmpeg.org/ffmpeg-all.html#Stream-specifiers-1 https://www.ffmpeg.org/ffmpeg-all.html#Advanced-options
|
||||
func (v *HLSVariant) getVariantString(t *Transcoder) string {
|
||||
variantEncoderCommands := []string{
|
||||
v.getVideoQualityString(t),
|
||||
v.getAudioQualityString(),
|
||||
}
|
||||
|
||||
if v.videoSize.Width != 0 || v.videoSize.Height != 0 {
|
||||
variantEncoderCommands = append(variantEncoderCommands, v.getScalingString())
|
||||
}
|
||||
|
||||
if v.encoderPreset != "" {
|
||||
variantEncoderCommands = append(variantEncoderCommands, fmt.Sprintf("-preset %s", v.encoderPreset))
|
||||
}
|
||||
|
||||
return strings.Join(variantEncoderCommands, " ")
|
||||
}
|
||||
|
||||
// Get the command flags for the variants.
|
||||
func (t *Transcoder) getVariantsString() string {
|
||||
var variantsCommandFlags = ""
|
||||
var variantsStreamMaps = " -var_stream_map \""
|
||||
|
||||
for _, variant := range t.variants {
|
||||
variantsCommandFlags = variantsCommandFlags + " " + variant.getVariantString(t)
|
||||
singleVariantMap := ""
|
||||
singleVariantMap = fmt.Sprintf("v:%d,a:%d ", variant.index, variant.index)
|
||||
variantsStreamMaps = variantsStreamMaps + singleVariantMap
|
||||
}
|
||||
variantsCommandFlags = variantsCommandFlags + " " + variantsStreamMaps + "\""
|
||||
|
||||
return variantsCommandFlags
|
||||
}
|
||||
|
||||
// Video Scaling
|
||||
// https://trac.ffmpeg.org/wiki/Scaling
|
||||
// If we'd like to keep the aspect ratio, we need to specify only one component, either width or height.
|
||||
// Some codecs require the size of width and height to be a multiple of n. You can achieve this by setting the width or height to -n.
|
||||
|
||||
// SetVideoScalingWidth will set the scaled video width of this variant.
|
||||
func (v *HLSVariant) SetVideoScalingWidth(width int) {
|
||||
v.videoSize.Width = width
|
||||
}
|
||||
|
||||
// SetVideoScalingHeight will set the scaled video height of this variant.
|
||||
func (v *HLSVariant) SetVideoScalingHeight(height int) {
|
||||
v.videoSize.Height = height
|
||||
}
|
||||
|
||||
func (v *HLSVariant) getScalingString() string {
|
||||
scalingAlgorithm := "bilinear"
|
||||
return fmt.Sprintf("-filter:v:%d \"scale=%s\" -sws_flags %s", v.index, v.videoSize.getString(), scalingAlgorithm)
|
||||
}
|
||||
|
||||
// Video Quality
|
||||
|
||||
// SetVideoBitrate will set the output bitrate of this variant's video.
|
||||
func (v *HLSVariant) SetVideoBitrate(bitrate int) {
|
||||
v.videoBitrate = bitrate
|
||||
}
|
||||
|
||||
func (v *HLSVariant) getVideoQualityString(t *Transcoder) string {
|
||||
if v.isVideoPassthrough {
|
||||
return fmt.Sprintf("-map v:0 -c:v:%d copy", v.index)
|
||||
}
|
||||
|
||||
encoderCodec := "libx264"
|
||||
|
||||
// -1 to work around segments being generated slightly larger than expected.
|
||||
// https://trac.ffmpeg.org/ticket/6915?replyto=58#comment:57
|
||||
gop := (t.currentLatencyLevel.SecondsPerSegment * v.framerate) - 1
|
||||
|
||||
// For limiting the output bitrate
|
||||
// https://trac.ffmpeg.org/wiki/Limiting%20the%20output%20bitrate
|
||||
// https://developer.apple.com/documentation/http_live_streaming/about_apple_s_http_live_streaming_tools
|
||||
// Adjust the max & buffer size until the output bitrate doesn't exceed the ~+10% that Apple's media validator
|
||||
// complains about.
|
||||
maxBitrate := int(float64(v.videoBitrate) * 1.06) // Max is a ~+10% over specified bitrate.
|
||||
bufferSize := int(float64(v.videoBitrate) * 1.2) // How often it checks the bitrate of encoded segments to see if it's too high/low.
|
||||
|
||||
cmd := []string{
|
||||
"-map v:0",
|
||||
fmt.Sprintf("-c:v:%d %s", v.index, encoderCodec), // Video codec used for this variant
|
||||
fmt.Sprintf("-b:v:%d %dk", v.index, v.videoBitrate), // The average bitrate for this variant
|
||||
fmt.Sprintf("-maxrate:v:%d %dk", v.index, maxBitrate), // The max bitrate allowed for this variant
|
||||
fmt.Sprintf("-bufsize:v:%d %dk", v.index, bufferSize), // How often the encoder checks the bitrate in order to meet average/max values
|
||||
fmt.Sprintf("-g:v:%d %d", v.index, gop), // How often i-frames are encoded into the segments
|
||||
fmt.Sprintf("-profile:v:%d %s", v.index, "high"), // Encoding profile
|
||||
fmt.Sprintf("-r:v:%d %d", v.index, v.framerate),
|
||||
fmt.Sprintf("-x264-params:v:%d \"scenecut=0:open_gop=0:min-keyint=%d:keyint=%d\"", v.index, gop, gop), // How often i-frames are encoded into the segments
|
||||
}
|
||||
|
||||
return strings.Join(cmd, " ")
|
||||
}
|
||||
|
||||
// SetVideoFramerate will set the output framerate of this variant's video.
|
||||
func (v *HLSVariant) SetVideoFramerate(framerate int) {
|
||||
v.framerate = framerate
|
||||
}
|
||||
|
||||
// SetEncoderPreset will set the video encoder preset of this variant.
|
||||
func (v *HLSVariant) SetEncoderPreset(preset string) {
|
||||
v.encoderPreset = preset
|
||||
}
|
||||
|
||||
// Audio Quality
|
||||
|
||||
// SetAudioBitrate will set the output framerate of this variant's audio.
|
||||
func (v *HLSVariant) SetAudioBitrate(bitrate string) {
|
||||
v.audioBitrate = bitrate
|
||||
}
|
||||
|
||||
func (v *HLSVariant) getAudioQualityString() string {
|
||||
if v.isAudioPassthrough {
|
||||
return fmt.Sprintf("-map a:0? -c:a:%d copy", v.index)
|
||||
}
|
||||
|
||||
// libfdk_aac is not a part of every ffmpeg install, so use "aac" instead
|
||||
encoderCodec := "aac"
|
||||
return fmt.Sprintf("-map a:0? -c:a:%d %s -b:a:%d %s", v.index, encoderCodec, v.index, v.audioBitrate)
|
||||
}
|
||||
|
||||
// AddVariant adds a new HLS variant to include in the output.
|
||||
func (t *Transcoder) AddVariant(variant HLSVariant) {
|
||||
variant.index = len(t.variants)
|
||||
t.variants = append(t.variants, variant)
|
||||
}
|
||||
|
||||
// SetInput sets the input stream on the filesystem.
|
||||
func (t *Transcoder) SetInput(input string) {
|
||||
t.input = input
|
||||
}
|
||||
|
||||
// SetOutputPath sets the root directory that should include playlists and video segments.
|
||||
func (t *Transcoder) SetOutputPath(output string) {
|
||||
t.segmentOutputPath = output
|
||||
}
|
||||
|
||||
// SetAppendToStream enables appending to the HLS stream instead of overwriting.
|
||||
func (t *Transcoder) SetAppendToStream(append bool) {
|
||||
t.appendToStream = append
|
||||
}
|
||||
|
||||
// SetIdentifer enables appending a unique identifier to segment file name.
|
||||
func (t *Transcoder) SetIdentifier(output string) {
|
||||
t.segmentIdentifier = output
|
||||
}
|
||||
|
||||
func (t *Transcoder) SetInternalHTTPPort(port string) {
|
||||
t.internalListenerPort = port
|
||||
}
|
||||
46
core/transcoder/transcoder_test.go
Normal file
46
core/transcoder/transcoder_test.go
Normal file
@@ -0,0 +1,46 @@
|
||||
package transcoder
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/owncast/owncast/models"
|
||||
)
|
||||
|
||||
func TestFFmpegCommand(t *testing.T) {
|
||||
latencyLevel := models.GetLatencyLevel(3)
|
||||
|
||||
transcoder := new(Transcoder)
|
||||
transcoder.ffmpegPath = "/fake/path/ffmpeg"
|
||||
transcoder.SetInput("fakecontent.flv")
|
||||
transcoder.SetOutputPath("fakeOutput")
|
||||
transcoder.SetIdentifier("jdofFGg")
|
||||
transcoder.SetInternalHTTPPort("8123")
|
||||
transcoder.currentLatencyLevel = latencyLevel
|
||||
|
||||
variant := HLSVariant{}
|
||||
variant.videoBitrate = 1200
|
||||
variant.isAudioPassthrough = true
|
||||
variant.encoderPreset = "veryfast"
|
||||
variant.SetVideoFramerate(30)
|
||||
transcoder.AddVariant(variant)
|
||||
|
||||
variant2 := HLSVariant{}
|
||||
variant2.videoBitrate = 3500
|
||||
variant2.isAudioPassthrough = true
|
||||
variant2.encoderPreset = "faster"
|
||||
variant2.SetVideoFramerate(24)
|
||||
transcoder.AddVariant(variant2)
|
||||
|
||||
variant3 := HLSVariant{}
|
||||
variant3.isAudioPassthrough = true
|
||||
variant3.isVideoPassthrough = true
|
||||
transcoder.AddVariant(variant3)
|
||||
|
||||
cmd := transcoder.getString()
|
||||
|
||||
expected := `/fake/path/ffmpeg -hide_banner -loglevel warning -i fakecontent.flv -map v:0 -c:v:0 libx264 -b:v:0 1200k -maxrate:v:0 1272k -bufsize:v:0 1440k -g:v:0 89 -profile:v:0 high -r:v:0 30 -x264-params:v:0 "scenecut=0:open_gop=0:min-keyint=89:keyint=89" -map a:0? -c:a:0 copy -preset veryfast -map v:0 -c:v:1 libx264 -b:v:1 3500k -maxrate:v:1 3710k -bufsize:v:1 4200k -g:v:1 71 -profile:v:1 high -r:v:1 24 -x264-params:v:1 "scenecut=0:open_gop=0:min-keyint=71:keyint=71" -map a:0? -c:a:1 copy -preset faster -map v:0 -c:v:2 copy -map a:0? -c:a:2 copy -var_stream_map "v:0,a:0 v:1,a:1 v:2,a:2 " -f hls -hls_time 3 -hls_list_size 3 -hls_delete_threshold 10 -tune zerolatency -pix_fmt yuv420p -sc_threshold 0 -master_pl_name stream.m3u8 -strftime 1 -hls_segment_filename http://127.0.0.1:8123/%v/stream-jdofFGg%s.ts -max_muxing_queue_size 400 -method PUT -http_persistent 0 -fflags +genpts http://127.0.0.1:8123/%v/stream.m3u8 2> transcoder.log`
|
||||
|
||||
if cmd != expected {
|
||||
t.Errorf("ffmpeg command does not match expected.\nGot %s\n, want: %s", cmd, expected)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user