diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..8427141 --- /dev/null +++ b/Makefile @@ -0,0 +1,7 @@ +README.md: + gomplate -f $@.tmpl --plugin 'filters=./get_filter_support_table,ffprobe=./get_ffprobe_commands_table' > $@ + +clean: + rm README.md + +.PHONY: clean diff --git a/README.md b/README.md index a3af43b..b0d621e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + # nu-ffmpeg Utility commands for working with ffmpeg in nushell. @@ -15,7 +16,7 @@ Utility commands for working with ffmpeg in nushell. The `ffmpeg` and `ffprobe` commands are required to be installed and available in your path; they are not installed for you. -Currently nushell versions 0.87.0 - 0.88.1 are supported. +Currently only nushell version 0.89.0 is supported. After that, clone this repository and add the following code to your scripts, or to your `config.nu` file: @@ -24,3 +25,30 @@ or to your `config.nu` file: use /ffprobe use /filters * ``` + +## FFProbe + +### Commands + +| name | usage | +| --------------------- | ---------------------------------------------------------------- | +| ffprobe | Run ffprobe on a list of files and return the output as a table. | +| ffprobe dimensions | Get the dimensions of a video stream | +| ffprobe streams | Retrieve all the streams from a list of ffprobe outputs | +| ffprobe streams audio | Retrieve all the audio streams from a list of ffprobe outputs | +| ffprobe streams video | Retrieve all the video streams from a list of ffprobe outputs | + + +## FFMpeg + +## Supported Filters + +| name | usage | +| ------- | -------------------------------------------------------------------------------------------------- | +| crop | Crop the input video to given dimensions. | +| fps | Convert the video to specified constant frame rate by duplicating or dropping frames as necessary. | +| loop | loop video frames | +| overlay | Overlay one video on top of another. | +| split | | +| vflip | Flip the input video vertically. | + diff --git a/README.md.tmpl b/README.md.tmpl new file mode 100644 index 0000000..b83b4c0 --- /dev/null +++ b/README.md.tmpl @@ -0,0 +1,44 @@ +{{ if false }} +