-
Notifications
You must be signed in to change notification settings - Fork 130
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* cleanup readme & examples * upgrade go version * add makefile with basic commands * add e2e test * add gha * update .gitignore
- Loading branch information
Showing
27 changed files
with
688 additions
and
943 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| name: Go | ||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Setup Go | ||
| uses: actions/setup-go@v4 | ||
| with: | ||
| go-version: "1.21.x" | ||
| - name: Install dependencies | ||
| run: go get . | ||
| - name: Install FFmpeg | ||
| run: sudo apt-get update && sudo apt-get install ffmpeg | ||
| - name: Build | ||
| run: go build -v ./... | ||
| - name: Test with the Go CLI | ||
| run: go test --failfast -v ./... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,6 +20,10 @@ main-test.go | |
| goffmpeg | ||
| coverage.out | ||
|
|
||
| # IDE | ||
| .DS_Store | ||
| .vscode | ||
| .idea | ||
| .idea | ||
|
|
||
| # test results | ||
| test_results | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
|
|
||
|
|
||
| test: | ||
| go test -v ./... -coverprofile=coverage.out -covermode=atomic -coverpkg=./... | ||
|
|
||
| coverage-html: | ||
| go tool cover -html=coverage.out |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,273 +1,41 @@ | ||
| # Goffmpeg | ||
| [](https://www.codacy.com/app/francisco.romero/goffmpeg?utm_source=github.com&utm_medium=referral&utm_content=xfrr/goffmpeg&utm_campaign=Badge_Grade) | ||
| [](https://dl.circleci.com/status-badge/redirect/gh/xfrr/goffmpeg/tree/master) | ||
| [](https://goreportcard.com/report/github.com/xfrr/goffmpeg) | ||
| [](https://godoc.org/github.com/xfrr/goffmpeg) | ||
| []( | ||
|
|
||
| FFMPEG wrapper written in GO which allows to obtain the progress. | ||
| FFMPEG wrapper written in GO | ||
|
|
||
| ## V2 | ||
| New implementation with an easy-to-use API and interfaces to extend the transcoding capabilities. | ||
| > New implementation with an easy-to-use API and interfaces to extend the transcoding capabilities. | ||
| > https://github.com/floostack/transcoder | ||
| # Dependencies | ||
| ## Features | ||
|
|
||
| - [x] Transcoding | ||
| - [x] Streaming | ||
| - [x] Progress | ||
| - [x] Filters | ||
| - [x] Thumbnails | ||
| - [x] Watermark | ||
| - [ ] Concatenation | ||
| - [ ] Subtitles | ||
|
|
||
| ## Dependencies | ||
| - [FFmpeg](https://www.ffmpeg.org/) | ||
| - [FFProbe](https://www.ffmpeg.org/ffprobe.html) | ||
|
|
||
| # Supported platforms | ||
| ## Supported platforms | ||
|
|
||
| - Linux | ||
| - OS X | ||
| - Windows | ||
|
|
||
| # Getting started | ||
| ## How to transcode a media file | ||
| ## Installation | ||
| Install the package with the following command: | ||
| ```shell | ||
| go get github.com/xfrr/goffmpeg | ||
| ``` | ||
|
|
||
| ```go | ||
| package main | ||
|
|
||
| import ( | ||
| "github.com/xfrr/goffmpeg/transcoder" | ||
| ) | ||
|
|
||
| var inputPath = "/data/testmov" | ||
| var outputPath = "/data/testmp4.mp4" | ||
|
|
||
| func main() { | ||
|
|
||
| // Create new instance of transcoder | ||
| trans := new(transcoder.Transcoder) | ||
|
|
||
| // Initialize transcoder passing the input file path and output file path | ||
| err := trans.Initialize( inputPath, outputPath ) | ||
| // Handle error... | ||
|
|
||
| // Start transcoder process without checking progress | ||
| done := trans.Run(false) | ||
|
|
||
| // This channel is used to wait for the process to end | ||
| err = <-done | ||
| // Handle error... | ||
|
|
||
| } | ||
| ``` | ||
| ## How to get the transcoding progress | ||
| ```go | ||
| ... | ||
| func main() { | ||
|
|
||
| // Create new instance of transcoder | ||
| trans := new(transcoder.Transcoder) | ||
|
|
||
| // Initialize transcoder passing the input file path and output file path | ||
| err := trans.Initialize( inputPath, outputPath ) | ||
| // Handle error... | ||
|
|
||
| // Start transcoder process with progress checking | ||
| done := trans.Run(true) | ||
|
|
||
| // Returns a channel to get the transcoding progress | ||
| progress := trans.Output() | ||
|
|
||
| // Example of printing transcoding progress | ||
| for msg := range progress { | ||
| fmt.Println(msg) | ||
| } | ||
|
|
||
| // This channel is used to wait for the transcoding process to end | ||
| err = <-done | ||
|
|
||
| } | ||
| ``` | ||
|
|
||
| ## How to pipe in data using the [pipe protocol](https://ffmpeg.org/ffmpeg-protocols.html#pipe) | ||
| Creating an input pipe will return [\*io.PipeReader](https://golang.org/pkg/io/#PipeReader), and creating an output pipe will return [\*io.PipeWriter](https://golang.org/pkg/io/#PipeWriter). An example is shown which uses `cat` to pipe in data, and [ioutil.ReadAll](https://golang.org/pkg/io/ioutil/#ReadAll) to read data as bytes from the pipe. | ||
| ```go | ||
| func main() { | ||
|
|
||
| // Create new instance of transcoder | ||
| trans := new(transcoder.Transcoder) | ||
|
|
||
| // Initialize an empty transcoder | ||
| err := trans.InitializeEmptyTranscoder() | ||
| // Handle error... | ||
|
|
||
| // Create a command such that its output should be passed as stdin to ffmpeg | ||
| cmd := exec.Command("cat", "/path/to/file") | ||
|
|
||
| // Create an input pipe to write to, which will return *io.PipeWriter | ||
| w, err := trans.CreateInputPipe() | ||
|
|
||
| cmd.Stdout = w | ||
|
|
||
| // Create an output pipe to read from, which will return *io.PipeReader. | ||
| // Must also specify the output container format | ||
| r, err := trans.CreateOutputPipe("mp4") | ||
|
|
||
| wg := &sync.WaitGroup{} | ||
| wg.Add(1) | ||
| go func() { | ||
| defer r.Close() | ||
| defer wg.Done() | ||
|
|
||
| // Read data from output pipe | ||
| data, err := ioutil.ReadAll(r) | ||
| // Handle error and data... | ||
| }() | ||
|
|
||
| go func() { | ||
| defer w.Close() | ||
| err := cmd.Run() | ||
| // Handle error... | ||
| }() | ||
|
|
||
| // Start transcoder process without checking progress | ||
| done := trans.Run(false) | ||
|
|
||
| // This channel is used to wait for the transcoding process to end | ||
| err = <-done | ||
| // Handle error... | ||
|
|
||
| wg.Wait() | ||
| } | ||
| ``` | ||
|
|
||
| # Progress properties | ||
| ```go | ||
| type Progress struct { | ||
| FramesProcessed string | ||
| CurrentTime string | ||
| CurrentBitrate string | ||
| Progress float64 | ||
| Speed string | ||
| } | ||
| ``` | ||
| # Media setters | ||
| Those options can be set before starting the transcoding. | ||
| ```js | ||
| SetAspect | ||
| SetResolution | ||
| SetVideoBitRate | ||
| SetVideoBitRateTolerance | ||
| SetVideoMaxBitrate | ||
| SetVideoMinBitRate | ||
| SetVideoCodec | ||
| SetVframes | ||
| SetFrameRate | ||
| SetAudioRate | ||
| SetSkipAudio | ||
| SetSkipVideo | ||
| SetMaxKeyFrame | ||
| SetMinKeyFrame | ||
| SetKeyframeInterval | ||
| SetAudioCodec | ||
| SetAudioBitRate | ||
| SetAudioChannels | ||
| SetBufferSize | ||
| SetThreads | ||
| SetPreset | ||
| SetTune | ||
| SetAudioProfile | ||
| SetVideoProfile | ||
| SetDuration | ||
| SetDurationInput | ||
| SetSeekTime | ||
| SetSeekTimeInput | ||
| SetSeekUsingTsInput | ||
| SetQuality | ||
| SetStrict | ||
| SetSingleFile | ||
| SetCopyTs | ||
| SetMuxDelay | ||
| SetHideBanner | ||
| SetInputPath | ||
| SetNativeFramerateInput | ||
| SetRtmpLive | ||
| SetHlsListSize | ||
| SetHlsSegmentDuration | ||
| SetHlsPlaylistType | ||
| SetHlsMasterPlaylistName | ||
| SetHlsSegmentFilename | ||
| SetHttpMethod | ||
| SetHttpKeepAlive | ||
| SetOutputPath | ||
| SetOutputFormat | ||
| SetAudioFilter | ||
| SetAudioVariableBitrate | ||
| SetCompressionLevel | ||
| SetFilter | ||
| SetInputInitialOffset | ||
| SetInputPipeCommand | ||
| SetMapMetadata | ||
| SetMetadata | ||
| SetStreamIds | ||
| SetTags | ||
| SetVideoFilter | ||
| ``` | ||
| Example | ||
| ```golang | ||
| func main() { | ||
|
|
||
| // Create new instance of transcoder | ||
| trans := new(transcoder.Transcoder) | ||
|
|
||
| // Initialize transcoder passing the input file path and output file path | ||
| err := trans.Initialize( inputPath, outputPath ) | ||
| // Handle error... | ||
|
|
||
| // SET FRAME RATE TO MEDIAFILE | ||
| trans.MediaFile().SetFrameRate(70) | ||
| // SET ULTRAFAST PRESET TO MEDIAFILE | ||
| trans.MediaFile().SetPreset("ultrafast") | ||
|
|
||
| // Start transcoder process to check progress | ||
| done := trans.Run(true) | ||
|
|
||
| // Returns a channel to get the transcoding progress | ||
| progress := trans.Output() | ||
|
|
||
| // Example of printing transcoding progress | ||
| for msg := range progress { | ||
| fmt.Println(msg) | ||
| } | ||
|
|
||
| // This channel is used to wait for the transcoding process to end | ||
| err = <-done | ||
|
|
||
| } | ||
| ``` | ||
|
|
||
| Example with AES encryption : | ||
|
|
||
| More information about [HLS encryption with FFMPEG](https://hlsbook.net/how-to-encrypt-hls-video-with-ffmpeg/) | ||
|
|
||
| ```bash | ||
| # Generate key | ||
| openssl rand 16 > enc.key | ||
| ``` | ||
|
|
||
| Create key file info : | ||
|
|
||
| ```enc.keyinfo | ||
| Key URI | ||
| Path to key file | ||
| ``` | ||
|
|
||
| ```golang | ||
| func main() { | ||
|
|
||
| trans := new(transcoder.Transcoder) | ||
|
|
||
| err := trans.Initialize(inputPath, outputPath) | ||
|
|
||
| trans.MediaFile().SetVideoCodec("libx264") | ||
|
|
||
| trans.MediaFile().SetHlsSegmentDuration(4) | ||
|
|
||
| trans.MediaFile().SetEncryptionKey(keyinfoPath) | ||
|
|
||
| progress := trans.Output() | ||
|
|
||
| err = <-done | ||
| } | ||
| ``` | ||
| ## Usage | ||
| Check the [examples](./examples) |
Oops, something went wrong.