Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/simon-lc/framecat

Automate video and gif generation from frame sequences.
https://github.com/simon-lc/framecat

Last synced: about 1 month ago
JSON representation

Automate video and gif generation from frame sequences.

Host: GitHub
URL: https://github.com/simon-lc/framecat
Owner: simon-lc
License: mit
Created: 2023-10-09T14:26:10.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-10-16T04:30:17.000Z (2 months ago)
Last Synced: 2024-10-17T14:44:04.674Z (2 months ago)
Language: Python
Homepage:
Size: 1.98 MB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

## FrameCat
[![build](https://github.com/simon-lc/framecat/actions/workflows/build.yml/badge.svg)](https://github.com/simon-lc/framecat/actions/workflows/build.yml)
[![codecov](https://codecov.io/gh/simon-lc/framecat/graph/badge.svg?token=CUWTT7EK5E)](https://codecov.io/gh/simon-lc/framecat)
[![docs](https://github.com/simon-lc/framecat/actions/workflows/docs.yml/badge.svg)](https://github.com/simon-lc/framecat/actions/workflows/docs.yml)
[![Static Badge](https://img.shields.io/badge/documentation-latest-8A2BE2)](https://simon-lc.github.io/framecat)

**Generate videos and GIF and low-memory footprint GIF from frame sequences, video and GIF sources.**

### Install package
```
pip install framecat
```
### Install external libraries
**FFmpeg**
```
sudo apt update
sudo apt install ffmpeg
ffmpeg --version
```

**gifsicle**
```
sudo apt update
sudo apt install -y gifsicle
gifsicle --version
```

### Quick start
- Make sure you're not inside a Docker container.
- Create a virtual environment if needed
```
pip install framecat
```

#### `LATEST` mode
- execute the command in the `LATEST` input mode:
```
framecat latest --output-names name1 name2
```
- this will pull the latest 2 `.tar` files created in the `--input-folder` (defaults to `~/Downloads`).
- rename the `.tar` files as `name1.tar` and `name2.tar`.
- create a video, a GIF and a lossy GIF for each `.tar` file.
- store them in the `--output-folder` (defaults to `~/Videos/framecat`).

#### `BY-NAME` mode
- execute the command in the `BY-NAME` input mode:
```
framecat by-name --input-names in_name1 --output-names out_name1`
```
- this will pull the `in_name1.tar` file from the `--input-folder` (defaults to `~/Downloads`).
- rename the `.tar` file as `out_name1.tar`.
- create a video, a GIF and a lossy GIF for each `.tar` file.
- store these in the `--output-folder` (defaults to `~/Videos/framecat`).

#### Input type
We can choose to run the `framecat` command on different file types:
- on 'tar' files, this command will create a video, a GIF and a lossy GIF. This is the default mode.
```
framecat latest --input-type tar --output-names out_name1`
```
or equivalently:
```
framecat latest --output-names out_name1`
```
- on 'mp4' files, this command will create a GIF and a lossy GIF.
```
framecat latest --input-type mp4 --output-names out_name1`
```
- on 'gif' files, this command will create a lossy GIF.
```
framecat latest --input-type gif --output-names out_name1`
```