Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wolfy-j/goffli
⚗️ Lua wrapper at top of FFMPEG API with nice progress bars and user friendly input arguments.
https://github.com/wolfy-j/goffli
ffmpeg ffmpeg-cli-wrapper github-gist golang lua progress-bar snippets
Last synced: 3 months ago
JSON representation
⚗️ Lua wrapper at top of FFMPEG API with nice progress bars and user friendly input arguments.
- Host: GitHub
- URL: https://github.com/wolfy-j/goffli
- Owner: wolfy-j
- License: mit
- Created: 2018-04-29T18:37:23.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-29T20:38:32.000Z (over 6 years ago)
- Last Synced: 2024-10-13T13:10:02.017Z (4 months ago)
- Topics: ffmpeg, ffmpeg-cli-wrapper, github-gist, golang, lua, progress-bar, snippets
- Language: Go
- Homepage:
- Size: 7.45 MB
- Stars: 107
- Watchers: 9
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Goffli
==========
[](https://goreportcard.com/report/github.com/wolfy-j/goffli)
Goffli is simple to use interface and FFmpeg CLI wrapper that offers the ability to convert video, audio, and other multimedia files and streams using small Lua programs which you can share over Github Gist.
> You can save and share any script with others. Every time you reuse it you will save all the time you spent in the past searching Google for ffmpeg bash scripts.
# Installation
Make sure to [install Golang 1.9](https://golang.org/doc/install) on your machine.
```
go get "github.com/wolfy-j/goffli"
```
Or you can find binaries [here](https://github.com/wolfy-j/goffli/releases).
# Usage
By default, Goffli can only display media information about a given file:
```
goffli info video.mp4
```
If you are looking to extend the possibilities of Goffli's functionality, you can load snippets using a GitHub Gist url:
```
goffli get https://gist.github.com/wolfy-j/d4ece481eb8c9bd8a438967d77603ce7 video2gif
```
These snippets can then be used immediately:
```
goffli video2gif input.mp4 result.gif
```
# Available Snippets
Snippet | URL
---- | ---
copy | https://gist.github.com/wolfy-j/8009a8b3be1004d933e105494c64c372
video2gif | https://gist.github.com/wolfy-j/d4ece481eb8c9bd8a438967d77603ce7
> Feel free to share your own snippets you create above for others in the community.
### Local snippets
You can also test your local Lua script without having to download it from GitHub Gists.
```
goffli run snippet.lua [args]
```
# Coding the Snippet
Writing the code for the snippet is easy. You can utilize a set of functions embedded to a Lua machine in order to make it more user friendly.
### Input functions
You can ask a user to enter a value
```lua
print(ask("Value"))
```
In order to validate a input value
```lua
local number = ask("Number", "number")
local float = ask("Number", "float")
local file = ask("File", "exists")
local not_empty = ask("Not Empty", "!empty")
```
Default values
```lua
local quality = ask("Quality", null, "32")
```
### Temp files and directories
In order to retrieve a name of a temp directory
```lua
local tmp = require("tmp")
print(tmp.dir())
```
In order to allocate a temporary file with a desired extension
```lua
local tmp = require("tmp")
print(tmp.file("mp4"))
```
### FFmpeg functions
This will display a spinner
```lua
require("ffmpeg").run({
"-i", input,
"-vcodec", "copy",
"-y", output
}, "spinner")
```
This will display a progress bar
```lua
require("ffmpeg").run({
"-i", input,
"-vcodec", "copy",
"-y", output
}, "progress")
```
Run Ffmpeg without showing any progress to a user
```lua
require("ffmpeg").run({
"-i", input,
"-vcodec", "copy",
"-y", output
}, "none")
```
Get media and stream details
```lua
local info = require("ffmpeg").probe(input)
print(info.format.duration)
```
Display media file details
```lua
require("ffmpeg").probe(input, true)
```
> Returned result [example](info.json).
Display media file streams
```lua
require("ffmpeg").probe(input, false, true)
```
License:
--------
The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.