ponyboy47/plex-monitr

Features:

• Cross-system compatability

Linux (tested on Ubuntu 16.04) <- This is my primary development environment macOS (tested on macOS Sierra 10.12)

• Monitors a downloads directory for when files are moved into it
• Supports most Plex media types

Movies & TV Shows Including subtitles Music Home Videos

• Automatically converts media to Plex Direct Play/Stream capable formats

It uses the most common Direct Play/Stream formats by default, but you can configure the conversion settings however you'd like Automatic media transcoding can be ran immediately when new media is added, or later as a scheduled task when the server will most likely not be in use

Installation

Linux (Tested on Ubuntu 16.04)

# transcode_video dependency installation (only needed if you're going to enable automatic media conversion)
sudo add-apt-repository ppa:stebbins/handbrake-releases
sudo add-apt-repository ppa:jonathonf/ffmpeg-3
sudo apt-get remove handbrake* ffmpeg && sudo apt autoremove
sudo apt-get update
sudo apt-get install -y ruby handbrake-cli ffmpeg mkvtoolnix mp4v2-utils libav-tools x264 x265

# transcode_video installation (only needed if you're going to enable automatic media conversion)
sudo gem install video_transcoding

# Swiftenv installation (makes installing and updating swift super easy)
git clone https://github.com/kylef/swiftenv.git ~/.swiftenv
echo 'export SWIFTENV_ROOT="$HOME/.swiftenv"' >> ~/.bash_profile
echo 'export PATH="$SWIFTENV_ROOT/bin:$PATH"' >> ~/.bash_profile
echo 'eval "$(swiftenv init -)"' >> ~/.bash_profile
source ~/.bash_profile

# Plex-Monitr and swift installation
git clone https://github.com/Ponyboy47/Plex-Monitr.git
cd Plex-Monitr
swiftenv install $(cat .swift-version)
swift build
swift run monitr

macOS (Tested on macOS High Sierra 10.13.2)

# Homebrew installation (To install swiftenv and also the transcode_video dependencies)
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

# transcode_video dependencies and installation (only needed if you're going to enable automatic media conversion)
brew install handbrake ffmpeg mkvtoolnix mp4v2 && gem install video_transcoding

# Makes installing and updating swift super easy
brew install kylef/formulae/swiftenv

# Plex-Monitr and swift installation
git clone https://github.com/Ponyboy47/Plex-Monitr.git
cd Plex-Monitr
swiftenv install $(cat .swift-version)
swift build
swift run monitr

Updating

cd ~/Plex-Monitr
rm Package.{resolved,pins}
# If config changes have been made, you will need to regenerate and save your new config
rm ~/.config/monitr/settings.json
git pull
swiftenv install $(.swift-version)
swift package update
swift build
swift run monitr

Usage:

### CLI Arguments:
There are a number of ways to configure your Monitr. Like any CLI application, any of these arguments can be used at the same time to create the exact Monitr that you need.

#### See the usage/help text:
`-h` or `--help`

#### See the current version of monitr:
`-v` or `--version`

#### Set the Config file to use/save to:
`-f` or `--config`
<p>The default value for this is ~/.config/monitr/settings.json.</p>

#### Set the Plex Library directory:
`-p` or `--plex-dir`
<p>If this is not specified, then /var/lib/plexmediaserver/Library is used (the default location on Ubuntu).</p>

#### Set the Download directories to monitor:
`-d` or `--download-dirs`
<p>If left unspecified, then ~/Downloads is used (Where I've kept my own downloads on Ubuntu).<br />
NOTE: This can be a comma separated list of paths to watch.</p>

#### Set the Home Video directories to monitor
`--home-video-download-dirs`
<p>If left unspecified, then ~/HomeVideos is used.<br />
NOTE: This can be a comma separated list of paths to watch.</p>

#### Set the Convert flag (whether to convert media to Direct Play formats for plex):
`-c` or `--convert`
<p>Defaults to false.</p>

#### Set whether to convert media files immediately, or as a scheduled task:
`-i` or `--convert-immediately`
<p>defaults to true<br />
When true, files are converted before they are moved to their corresponding Plex directory</p>

#### Set when scheduled media file conversion tasks should begin (uses a cron string):
`-a` or `--convert-cron-start`
<p>default is "0 0 * * *" (midnight every day)<br />
For information about the Cron format, see https://en.wikipedia.org/wiki/Cron</p>

#### Set when scheduled media file conversion tasks stops (uses a cron string):
`-z` `--convert-cron-end`
<p>default is "0 8 * * *" (8am every day)<br />
For information about the Cron format, see https://en.wikipedia.org/wiki/Cron<br />
NOTE: If a job is running at this time, it will run to completion, but no new conversions will be started</p>

#### Set the number of simultaneous conversion threads we can have running at one time:
`--convert-threads`
<p>default is 1<br />
NOTE: Preliminary performance testing shows that using multiple threads will still convert the same number of files in the same amount of time. A single thread will convert one file very fast and multiple threads convert multiple files simultaneously, but each file is converted slower. Overall, it tends to take the same amount of time to convert a batch of files.</p>

#### Set whether of not to delete the original media file after converting it:
`--delete-original`
<p>defaults to false<br />
NOTE: If false, unconverted media files will be placed in the plex location along with the converted media file. The original file will have ' - original' appended to the end of the filename, but before the file's extension.</p>

#### Set the transcode-video command to use the Contrained Average Bitrate ratecontrol system:
`--abr` or `--average-bitrate-rcs`<br />
defaults to false<br />
NOTE: To determine if you should use this option, run `transcode-video --help` and read the information about the --abr option.<br />

#### Use the h265 encoder instead of the default handbrake encoder (h264):
`--x265`<br />
defaults to false<br />
NOTE: To determine if you should use this option, you may want to check out [this link](https://github.com/donmelton/video_transcoding/issues/191) if you're trying to dramatically reduce file sizes when converting and can use the h265 converter.<br />
      If you need me to expose additional options to the transcode-video command, create a new issue and I can do that pretty easily.<br />

#### The targets to use in the transcode-video command:
`-t` or `--target`<br />
May be used multiple times<br />
NOTE: To determine if/how to use this option, run `transcode-video --help` and read the information about the --target options.<br />

#### The transcode speed to use:
`--speed` or `--transcode-speed`
<p>defaults to medium<br />
NOTE: The valid options are default, quick, or veryquick. The faster the speed, the larger the file and potentially lower the quality.<br />
The quick option generally will result in 70-80% faster transcodes, with barely perceptible changes in quality.<br />
The veryquick option generally has a 100-120% faster transcode, with slightly noticeable quality differences and a noticeably larger file.</p>

#### The x264 speed preset:
`--x264-preset`
<p>defaults to medium<br />
NOTE: The valid options are veryslow, slower, slow, default, fast, faster, veryfast.<br />
The faster the preset, the lower the quality and larger the file size.</p>

#### Set the container to use when converting video files:
`--convert-video-container`
<p>defaults to mp4 since that is the most commonly supported container for DirectPlay across the various Plex devices</p>

#### Set the codec to use when converting video streams:
`--convert-video-codec`
<p>default is h264 since that is the most commonly supported codec for DirectPlay in Plex</p>

#### Set the container to use when converting audio files:
`--convert-audio-container`
<p>defaults to aac (for now)<br />
NOTE: I don't have plans for a lot of audio file conversion support. I know Plex generally supports streaming aac, which is why I use aac, but I haven't looked into the Plex audio streaming stuff as much as I have it's video streaming requirements.</p>

#### Set the codec to use when converting audio streams:
`--convert-audio-codec`
<p>default is aac since that is the most commonly supported codec for DirectPlay in Plex</p>

#### Set whether to scan for foreign audio subtitles and burn them into a video stream:
`--convert-video-subtitle-scan`<br />
defaults to false<br />
NOTE: This is an experimental feature in the transcode_video tool. If it screws up, you could end up with the wrong subtitle track burned into your video. [See @donmelton's own documentation on this feature](https://github.com/donmelton/video_transcoding#understanding-subtitles) in his transcode_video. If you are going to use this, it is HIGHLY RECOMMENDED that you do not use the `--delete-original` flag, just to be safe.<br />

#### Set the preferred language to use when converting media:
`--convert-language`
<p>defaults to eng<br />
NOTE: Uses the ISO 639-2 language codes, and I only included a handful in this project. If you need one added then file an issue</p>

#### Set the maximum framerate to use when converting video streams:
`--convert-video-max-framerate`
<p>defaults to 30.0</p>

#### Set the directory to use for conversion jobs when deleteOriginal is false:
`--convert-temp-dir`
<p>default is /tmp/monitrConversions</p>

#### Set whether or not subtitle files should be deleted or preserved for video media:
`--delete-subtitles`
<p>default is false</p>

#### Set whether or not to save these config settings to the config file:
`-s` or `--save-settings`<br />
defaults to false<br />
The current settings are saved at the `--config-file` path (defaults to ~/.config/monitr/settings.json)<br />
NOTE: If true, subsequent monitr instances will load the settings file from the `--config-file` option and use its config values instead of the usual defaults.<br />

#### Set the default logging level to use:
`--level` or `--log-level`
<p>default value is error<br />
NOTE: Valid options are error, warn, warning, info, debug, verbose.</p>

#### Set the log file to use:
`-o` or `--log-file`
<p>Default is nil, which means logs are only written to stdout.<br />
NOTE: If set, and logging level is debug or verbose, logs are written both to the file specified and also to stdout.</p>

---

TODO:

• [x] Make a graphic
• [x] Logging
• [x] The CLI boolean flags with a default value of true cannot be set to false. Fix it.
• [ ] Do something with files that failed to be moved
• [x] Don't register downloads with x264 as a TV show of Season 2 Episode 64 (Downpour)
• [x] Better subtitle file support
• [x] Make an option for deleting subtitle files upon import
• [ ] Get show name/season from parent directory? (Useful when there is an organized directory structure, but file names do not contain all the relevant info)
• [x] Convert media to Plex Direct Play/Stream formats with Handbrake CLI or ffmpeg
• [ ] Preserve TV show episode titles
• [ ] Support multi-part TV show episodes
• [ ] Create a command to display the statistics
• [x] Support monitoring multiple directories
• [x] Watch a specific directory for Home Videos
• [x] Make the entire program more asynchronous

- [x] Continue execution while converting media (Just add new stuff to a queue) - [x] Finishing conversion automatically continues to moveMedia() - [x] Set up Operations for moving & converting - [x] Set up Operation dependency chains for automatic asynchronous behaviors

• [x] Improve the stability with large amounts of conversion jobs
• [x] Swift 4
• [ ] Dynamically add paths to watch lists (such as an auto-generated directory inside users' home directories)
• [ ] Remove configurable items that aren't actually configurable (if no CLI option, then no configuration)
• [ ] Unit tests
• [x] Only allow one running instance of monitr
• [x] Moving batches of files at a time into the downloads directories causes issues

Package Metadata

Repository: ponyboy47/plex-monitr

Default branch: master

README: README.md