Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tgotwig/vidmerger

๐Ÿ“ผ Merge video & audio files via CLI
https://github.com/tgotwig/vidmerger

ffmpeg rust rust-lang video video-concat video-concatenation video-merge video-merger wrapper

Last synced: about 1 month ago
JSON representation

๐Ÿ“ผ Merge video & audio files via CLI

Awesome Lists containing this project

README

        

img/merge.gif

Vidmerger


A wrapper around FFmpeg which simplifies merging of multiple videos.

fusion gif

```mermaid
%%{init: {'themeVariables': { 'mainBkg': 'white', 'nodeBorder': 'black' }}}%%
graph LR;
Video_A-->Vidmerger;
Video_B-->Vidmerger;
Vidmerger-->FPS_Changer;
FPS_Changer-->Merger;
Merger-->Chapterer;
Chapterer-->Video_A+B;

Vidmerger-->Merger;
Merger-->Video_A+B;
```

| Feature | Description |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Selector | Iterates through [this list of file endings](src/main.rs#L34), selects all files which matches with the current file ending except ones which start with a dot. The list can be overwritten by `--format` or `-f`, example: `--format mp4,mkv`. |
| FPS_Changer | After detecting not matching fps values, it scales all the higher fps videos down to the lowest detecting fps value. Can be skipped by `--skip-fps-changer`. The desired fps value can be set by `--fps`, example: `--fps 23.976`. |
| Chapterer | After the merge job is done, it creates the same file but with chapters in it, the title is all in between the first dash till the file extension, example: `Video_A - Chapter 1.mp4`. Can be skipped by `--skip-chapterer`. |

## ๐Ÿ™‰ What is this exactly?

Vidmerger is a command-line-tool which uses **ffmpeg** to merge multiple video-files with the same file-extension into one file, for example running `vidmerger .` on mp4 files would create a merged video called `output.mp4` ๐Ÿฃ

Here is the usage help of vidmerger ๐Ÿค—

```shell
A wrapper around ffmpeg which simlifies merging multiple videos ๐ŸŽž Everything in between the first
`-` till the fill extension of the input files will be used as chapter titles.

USAGE:
vidmerger [OPTIONS]

ARGS:
Sets the input file to use

OPTIONS:
-f, --format Specifies which formats should be merged individually, the default is
๐Ÿ‘‰ 3g2,3gp,aac,ac3,alac,amr,ape,au,avi,awb,dts,f4a,f4b,f4p,f4v,flac,flv,m4a,m4b,m4p,m4r,m4v,mkv,mov,mp2,mp3,mp4,mpeg,mpg,oga,ogg,ogm,ogv,ogx,opus,pcm,spx,wav,webm,wma,wmv
--fps Generates videos inside a temporary folder with this fps value and
merges them
-h, --help Print help information
--shutdown For doing a shutdown at the end (needs sudo)
--skip-chapterer Skips the chapterer
--skip-fps-changer Skips the fps changer
--skip-wait Skips the wait time for reading
-V, --version Print version information
```

## โœจ Installing / Getting started

You can install it on all the three major operating systems ๐Ÿค—

### X64

| Platform | Packager | Command |
| :-------- | :----------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ๐ŸŽ MacOS | ๐Ÿบ [Homwbrew](https://github.com/TGotwig/homebrew-vidmerger/blob/master/vidmerger.rb) | brew tap tgotwig/vidmerger
brew install vidmerger |
| ๐Ÿง Linux | ๐Ÿบ [Homwbrew](https://github.com/TGotwig/homebrew-linux-vidmerger/blob/master/vidmerger.rb) | brew tap tgotwig/linux-vidmerger
brew install vidmerger |
| ๐Ÿง Linux | ๐Ÿบ CURL | sudo curl -L https://github.com/TGotwig/vidmerger/releases/latest/download/vidmerger-linux.tar.gz -o /tmp/vidmerger-linux.tar.gz && sudo tar -xzvf /tmp/vidmerger-linux.tar.gz -C /usr/local/bin |
| ๐Ÿณ๏ธโ€๐ŸŒˆ Windows | ๐Ÿซ [Chocolatey](https://community.chocolatey.org/packages/vidmerger) | choco install ffmpeg # prerequisite
choco install vidmerger |

### ARM64

| Platform | Packager | Command |
| :------- | :----------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ๐ŸŽ MacOS | ๐Ÿบ [Homwbrew](https://github.com/TGotwig/homebrew-vidmerger/blob/master/vidmerger.rb) | brew tap tgotwig/vidmerger
brew install vidmerger |
| ๐Ÿง Linux | ๐Ÿบ CURL | sudo curl -L https://github.com/tgotwig/vidmerger/releases/download/0.3.2/vidmerger-linux-arm64.tar.gz -o /tmp/vidmerger-linux-arm64.tar.gz && sudo tar -xzvf /tmp/vidmerger-linux-arm64.tar.gz -C /usr/local/bin |

## ๐Ÿณ Run it without installing

You can also use Docker to run vidmerger without installing anything except Docker, hosted on [Dockerhub](https://hub.docker.com/r/tgotwig/vidmerger).

```bash
docker container run -v :/data tgotwig/vidmerger
```

Examples with Bash:

```bash
docker container run -v ./data:/data tgotwig/vidmerger
docker container run -v ./data:/data tgotwig/vidmerger --version
```

## โš™๏ธ Developing

### Built With

Rust and some listed Crates inside of [Cargo.toml](Cargo.toml) under _dependencies_.

### Prerequisites

- [Rust 2021](https://www.rust-lang.org/tools/install)
- [yt-dlp](https://github.com/yt-dlp/yt-dlp/wiki/Installation)
- [ffmpeg](https://ffmpeg.org/download.html)
- [task](https://taskfile.dev/#/installation)

### Setting up Dev

Once you are done with installing the prerequisites, run `task`:

```shell
git clone [email protected]:TGotwig/vidmerger.git
cd vidmerger
task
```

If you see anything to improve, just create an [issue](https://github.com/tgotwig/vidmerger/issues) or directly open a [pull request](https://github.com/tgotwig/vidmerger/pulls) ๐Ÿค—โœจ

### Building

Run `task build` to build for Mac, Linux and Windows. You can find the compressed Mac & Linux .tar.gz-archives for Github under _target/tars_, the .exe file for Windows under _tools_.

### Deploying / Publishing

#### Automated steps

- Homebrew (MacOS & Linux): Gets automatically deployed by [release.yml](https://github.com/TGotwig/vidmerger/blob/master/.github/workflows/release.yml) after pushing a git tag.
- Chocolatey (Windows): Gets automatically deployed by [release.yml](https://github.com/TGotwig/vidmerger/blob/master/.github/workflows/release.yml) after pushing a git tag.

#### Manual steps

Increasing all versions by _find and replace_, then after `task build`:

- Dockerhub: Run `task publish_dockerhub`.

## ๐Ÿ“ฆ Versioning

We use [SemVer](http://semver.org/) for versioning.

## ๐Ÿงช Tests

- For major tests: `task test` (requires `yt-dlp` and `ffmpeg` to be installed)
- For linting tests: `task lint`

## ๐ŸŒŸ Style guide

- [rust-clippy](rust-clippy)
- [rls-vscode](https://github.com/rust-lang/rls-vscode)
- [conventionalcommits](https://www.conventionalcommits.org/en/v1.0.0)