mirror of
https://github.com/master-of-zen/Av1an.git
synced 2024-11-25 02:29:40 +00:00
140 lines
6.4 KiB
Markdown
140 lines
6.4 KiB
Markdown
<h1 align="center">
|
|
<br>
|
|
Av1an
|
|
</br>
|
|
</h1>
|
|
|
|
<h2 align="center">All-in-one tool for streamlining av1 encoding</h2>
|
|
|
|
|
|
|
|
<h4 align="center"> <img src="https://ci.appveyor.com/api/projects/status/cvweipdgphbjkkar?svg=true" alt="Project Badge"> <a href="https://codeclimate.com/github/master-of-zen/Av1an/maintainability"><img src="https://api.codeclimate.com/v1/badges/41ea7ad221dcdad3fe8d/maintainability" />
|
|
<img= src="https://app.codacy.com/manual/Grenight/Av1an?utm_source=github.com&utm_medium=referral&utm_content=master-of-zen/Av1an&utm_campaign=Badge_Grade_Dashboard"></a>
|
|
<a href="https://www.codacy.com/manual/Grenight/Av1an?utm_source=github.com&utm_medium=referral&utm_content=master-of-zen/Av1an&utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/4632dbb2f6f34ad199142c01a3eb2aaf"/></a>
|
|
</h4>
|
|
<h2 align="center">Easy And Efficient </h2>
|
|
|
|
Start using AV1 encoding. All open-source encoders are supported (Aom, Rav1e, SVT-AV1).
|
|
Image to .ivf encoding supported (Aomenc, Rav1e)
|
|
|
|
Example with default parameters:
|
|
|
|
./av1an.py -i input
|
|
|
|
With your own parameters:
|
|
|
|
./av1an.py -i input -enc aom -v ' --cpu-used=3 --end-usage=q --cq-level=30' -ff ' -vf scale=1280:-1 '
|
|
-w 10 -p 2 -a '-c:a libopus -b:a 24k' -s scenes.csv -log my_log -o output_file
|
|
|
|
<h2 align="center">Usage</h2>
|
|
|
|
-i --file_path Input file (relative or absolute path)
|
|
|
|
-o --output_file Name/Path for output file (Default: (input file name)_av1.mkv)
|
|
|
|
-enc --encoder Encoder to use (aom or rav1e or svt_av1. Default: aom)
|
|
Example: -enc rav1e
|
|
|
|
-v --video_params Encoder settings flags (If not set, will be used default parameters.
|
|
Required for SVT-AV1s)
|
|
Can be set for both video and image mode
|
|
Must be inside ' ' or " "
|
|
|
|
-p --passes Set number of passes for encoding
|
|
(Default: Aomenc: 2, Rav1e: 1, SVT-AV1: 2)
|
|
At current moment 2nd pass Rav1e not working
|
|
|
|
-a --audio_params FFmpeg audio settings flags (Default: copy audio from source to output)
|
|
Example: -a '-c:a libopus -b:a 64k'
|
|
|
|
-w --workers Overrides automatically set number of workers.
|
|
Adjust accordingly to your system
|
|
Aomenc recommended value is YOUR_THREADS - 2 (Single thread per worker)
|
|
Rav1e and SVT-AV1 uses multiple threads,
|
|
Example: Rav1e settings ' ... --tile-rows 2 --tile-cols 2 ... ' -t 3
|
|
|
|
-s --scenes Path to file with scenes timestamps.
|
|
If given `0` spliting will be ignored
|
|
If file not exist, new will be generated in current folder
|
|
First run to generate stamps, all next reuse it.
|
|
Example: `-s scenes.csv`
|
|
|
|
-tr --threshold PySceneDetect threshold for scene detection
|
|
|
|
-ff --ffmpeg FFmpeg options. Example:
|
|
--ff ' -r 24 -vf scale=320:240 '
|
|
|
|
-fmt --pix_format Setting custom pixel/bit format(Default: 'yuv420p')
|
|
Example for 10 bit: 'yuv420p10le'
|
|
Encoding options should be adjusted accordingly.
|
|
|
|
--resume If encode was stopped/quit resumes encode with saving all progress
|
|
Resuming automatically skips scenedetection, audio encoding/copy,
|
|
spliting, so resuming only possible after actuall encoding is started.
|
|
/.temp folder must be presented for resume.
|
|
|
|
--no_check Skip checking numbers of frames for source and encoded chunks
|
|
Needed if framerate changes.
|
|
By default any differences in frames of encoded files will be reported
|
|
|
|
-m --mode 0 - Video encoding (Default),
|
|
1 - Image encoding. Using 10 bit encoding and constant quality mode Aom.
|
|
|
|
-log --logging Path to .log file(Default: no logging)
|
|
|
|
<h2 align="center">Main Features</h2>
|
|
|
|
**Spliting video by scenes for parallel encoding** because AV1 encoders currently not good at multithreading, encoding is limited to single or couple of threads at the same time.
|
|
|
|
* [PySceneDetect](https://pyscenedetect.readthedocs.io/en/latest/) used for spliting video by scenes and running multiple encoders.
|
|
|
|
* Both Video and Image encoding* (Single frame to .ivf, can be viewed by videoplayer).
|
|
|
|
* Resuming encoding without loss of encoded progress.
|
|
|
|
* Simple and clean console look.
|
|
|
|
* Automatic determination of how many workers the host can handle.
|
|
|
|
* Building encoding queue with bigger files first, minimizing waiting for last scene to encode.
|
|
|
|
* Both video and audio encoding option with FFmpeg.
|
|
|
|
* Logging of progress of all encoders.
|
|
|
|
## Install on Windows
|
|
|
|
### 1. Use ready [Release](https://github.com/master-of-zen/Av1an/releases)
|
|
Autobuilding .exe from current git available at [AppVeyour](https://ci.appveyor.com/project/master-of-zen/av1an).
|
|
|
|
All .exe for ffmpeg, and encoders should be in same folder
|
|
|
|
### 2. Install with dependancies
|
|
* [Python3](https://www.python.org/downloads/)
|
|
* [FFmpeg](https://ffmpeg.org/download.html)
|
|
* [AOMENC](https://aomedia.googlesource.com/aom/) For Aomenc encoder
|
|
* [Rav1e](https://github.com/xiph/rav1e) For Rav1e encoder
|
|
* [SVT-AV1](https://github.com/OpenVisualCloud/SVT-AV1) For SVT-AV1 encoder
|
|
|
|
All .exe for ffmpeg, ffprobe, and encoders should be in same folder
|
|
|
|
Install all requirements listed in `requirements` file.
|
|
|
|
If installed programs don't added to enviroment variable,
|
|
executables can be put in same folder with av1an
|
|
|
|
Run with command: `python -i ./avian.py params..`
|
|
|
|
## Install on Linux
|
|
|
|
* [Python3](https://www.python.org/downloads/)
|
|
* [FFmpeg](https://ffmpeg.org/download.html)
|
|
* [AOMENC](https://aomedia.googlesource.com/aom/) For Aomenc encoder
|
|
* [Rav1e](https://github.com/xiph/rav1e) For Rav1e encoder
|
|
* [SVT-AV1](https://github.com/OpenVisualCloud/SVT-AV1) For SVT-AV1 encoder
|
|
|
|
Install all requirements listed in `requirements` file
|
|
|
|
Optionally add Av1an to your PATH
|
|
|
|
Run with command: `av1an.py params...`
|