Skip to content

Latest commit

 

History

History
95 lines (60 loc) · 5.35 KB

README.md

File metadata and controls

95 lines (60 loc) · 5.35 KB
Raw

FFhevc

First Time User

Copy some media to a test directory and run ffhevc against a copy. Adjust the settings and configure your media_path_keys to suit your needs. USE AT YOUR OWN RISK!

Table of Contents

About

FFhevc uses FFmpeg and FFprobe to convert to, anaylize, and re-encode mkv videos. It allows you to configure maximum qaulity and resolution per media directory. If the rename flag is enabled, it will rename your media files automatically to Plex file naming Standards. Optionally, It can process incoming files and move them to their destination directory once re-encoded. If you have mkvmerge installed (recommended), FFhevc will use it to filter out unwanted tracks such as foreign language and director comment tracks to further reduce space.

Usage

If you have a movies, movie archive, tv shows, tv show archive setup, you can set up ffhevc cronjobs to scan each media directory for videos that are above your quality/resolution set limits. FFhevc will re-encode them according to your configuration settings per media directory.

Getting Started

Prerequisites

  • Windows (with Cygwin), Linux, or MacOS
  • php 7.3.7+
      • modules:
    • SimpleXML
  • FFmpeg
  • ffprobe (included in FFmpeg install)
  • mkvmerge (optional but recommeneded)

Installing

PHP
$> php -v should meet the minimum version mentioned above.
$> php -m should show the required php modules mentioned above.

GIT CLONE ffmpeg onto your computer.
$> git clone https://github.com/Satalink/ffhevc.git ffhevc

Create a symbolic link to the ffmpeg.php file somewhere that is in your $PATH: (~/bin/ffhevc) for example. You can name the symbolic link whatever you like (I use hevc).. whatever works for you. Just make sure you create the link somewhere in your $PATH.

Ensure ffmpeg, ffprobe, mkvmerge and php are in your shell's $PATH.
which ffmpeg (etc.. etc..) to check.
$> which ffmpeg

FFhevc was written on a Windows/Cygwin environment. It should work on Apple and Linux but it hasn't been tested on those systems as of yet.

Once installed, configure the conf/settings.php and conf/media_paths_keys.php to your needs. To try it out, I recommend creating a "test" folder and copying some mkv files into it. Then cd into that directory and run ffhevc (or whatever you named your symbolic link). I suggest you try single file mode, then try the whole test directory, and lastly use the key method.
$> cd /path/to/test/media
$> ffhevc "my_first_test_media.mkv"
$> ffhevc << this will process the entire current directory

lastly... if you've properly configured your media_path_keys, you can use the key method.
$> ffhevc {key} << where key would be the array key name in your media_path_keys i.e. tv or mov

ffhevc --help to show command line options. Using command line options overrides media_path_key settings. This allows you to specifically encode an mkv file inside of a media directory with custom quality. If your custom encoding is higher than your directories media_path_key configuration allows, you can use --exclude to tell ffhevc to ignore the custom encoding when it scans the media directory during a manual scan or cron run.

Usage

$> ffhevc.php

Run in a media directory without any options or paths to scan and process the current working directory. If there is a key defined in the conf/media_paths_keys.php file that matches your current working directory, those settings will be used. Otherwise, global defaults defined in the inc/options.php file will be used.

$> ffhevc.php "My Favorite Video.mkv"

If you supply a filename, that file will be scanned and processed (no recurssive directory scanning or processing). If a key is defined that matches your current working directory, those settings will be used. Otherwise, global defaults defined inc/requires/options.php file will be used.

$> ffhevc.php mov

If you supply a "key" (defined in conf/media_paths_keys.php), the path defined in that key will be scanned and processed using the settings defined for that key.

Plex Naming Standard

ffhevc uses the Plex Naming Standard if the rename flag is set to true.

Recommend `darr Settings ()

Radarr -> Settings -> Media Management: Standard Movie Format
{Movie CleanTitle} ({Release Year}) - [ {Quality Title} {MediaInfo VideoCodec} {MediaInfo AudioCodec} ]

Sonarr -> Settings -> Media Management: Standard Episode Format
{Series CleanTitle} - s{season:00}e{episode:00} ({Series Year}) - [ {Quality Title} {MediaInfo VideoCodec} {MediaInfo AudioCodec} ]