Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/bmhayward/Transcode

Tools to batch transcode and process videos
https://github.com/bmhayward/Transcode

batch-transcode blu-ray makemkv transcode video-transcoding

Last synced: 3 months ago
JSON representation

Tools to batch transcode and process videos

Awesome Lists containing this project

README 

        
# Transcode



Workflow to batch transcode and process videos



![image](https://github.com/bmhayward/Transcode/blob/master/Demo/new_logo.png)

##

* Completely rewritten

* Full support for macOS Sierra

* UI for managing preferences

* UI for managing cropping when multiple possible crops are detected

* Apply multiple transcode quality options to source files for quality comparisons

* Many other improvements



## About

Transcode provides a workflow that automates the batch transcoding of Blu-ray Discs and DVDs into a smaller, more portable format while remaining high enough quality to be mistaken for the originals. The Transcode workflow is built around [Don Melton's](https://github.com/donmelton/video_transcoding) exceptional video transcoding toolset.



* [About](#about)

* [Installation](#installation)

* [Usage](#usage)

* [Acknowledgements](#acknowledgements)

* [Requirements](#requirements)

* [History](#history)



## Installation

Download the [latest release](https://github.com/bmhayward/Transcode/releases).



Launch the Transcode Setup Assistant app:

```

Select the location for the Transcode folder

```

After selecting the Transcode folder location, the Terminal will launch:

```

1. Complete the installation of the Xcode command-line tools

2. Select the open Terminal window once Xcode has been installed

3. Enter the local administrator password when prompted

4. Click OK once the Setup Assistant has completed

5. Close the open Terminal window

6. Safari has opened the download page for two additional tools you may find helpful, MakeMKV and VLC

```



## Usage

Drop `.mkv` files into:

```

/Transcode/Convert

```

to automatically batch transcode video files.



Transcoding will start after all content has been copied to the Convert folder.



### Workflow



Transcode uses a batch queue mechanism to manage content for transcoding. As content is added to the Convert folder, a ```watchFolder``` LaunchAgent waits for the Convert folder size to stabilize.



Depending upon how content is being added to the Convert folder, `watchFolder` will wait:

```

a minimum of 20 seconds after folder stabilization to start transcoding

a maximum of 60 seconds after folder stabilization to start transcoding

```

If content is added while transcoding is active, `watchFolder` will create a new batch queue for the added content. The new batch queue will start once the active queue has completed.

This queueing process allows for content to be continuously streamed or copied to the Convert folder.



### Compression



Transcode uses the `transcode-video tool` to convert audio and video. By default, Transcode uses the 

`transcode-video --quick` quality option. This setting can be modified in Settings>Output quality.



Entering comma separated values into the Output quality field, allows the transcoding of video with multiple quality settings.



![image](https://github.com/bmhayward/Transcode/blob/master/Demo/output_quality_setting.png)



When audio transcoding is required, it is done in an [AAC format](https://en.wikipedia.org/wiki/Advanced_Audio_Coding) and, if the original is [multi-channel surround sound](https://en.wikipedia.org/wiki/Surround_sound), in [Dolby Digital AC-3 format](https://en.wikipedia.org/wiki/Dolby_Digital).



### Cropping



Cropping provides faster transcoding and higher quality as there are fewer pixels to read and write.



Transcode uses the `detect-crop tool`, part of the `transcode-video` toolset, to determine the optimal video cropping bounds.

If the `detect-crop tool` detects multiple possible cropping options, a live preview of the options can be presented. If only a single cropping option is detected, the video will be auto-cropped.



![image](https://github.com/bmhayward/Transcode/blob/master/Demo/crop_selection.png)



For additional details, see this discussion of the [detect-crop tool](https://github.com/donmelton/video_transcoding#cropping).



### Audio



The `transcode-video` tool, used by Transcode, selects the first audio track in the input as the main audio track. This is the first track in the output and the default track for playback. The main audio track is transcoded in AAC format and, if the original is multi-channel surround sound, in Dolby Digital AC-3 format. Any additional audio tracks are only transcoded in AAC format.



Additional audio tracks can be added by selecting Settings>Add other audio tracks. The additional audio track width is defined by selecting the width in Settings>Audio track width.



For additional details, see this discussion about [understanding audio](https://github.com/donmelton/video_transcoding#understanding-audio).



### File Naming



Name content to be Transcoded, using the following conventions:

```

Movies: title_(Year of release) e.g. WALL-E_2008

TV Show: title_SXXEYY e.g. ANIMANIACS_S2E11

Multi-Episode TV Show: title_SXXEYYEZZ e.g. TWIN_PEAKS_S1E1E8

Movie Extras: title_(date)%extras tag-descriptive name e.g. WHITE_CHRISTMAS_(1954)%Featurettes-A Look Back with Rosemary Clooney

TV Specials: title_S00EYY%descriptive name e.g. FUTURAMA_S00E1%Interview with Matt Groening

Skip renaming & auto-move: @title e.g. @CAPTAIN_AMERICA_THE_FIRST_AVENGER

Pass-through without transcoding: ^title e.g. ^The_Incredibles_Extras

Force decomb filter: +title e.g. +FUTURAMA_S2E10

```



Where for TV Shows/Specials:

 * `XX`  is the season number

 * `YY`  is the episode number

 * `ZZ`  is the last episode number

 

### Auto-Renaming 



Transcode auto-renames transcoded files based on matches from the [TheMovieDB](https://www.themoviedb.org) and the [TheTVDB](http://thetvdb.com). A transcoded files ‘title’ metadata tag is also set to the renamed movie or TV show.



Transcode auto-renames transcoded files into these formats:

```

Movies: Name (Year of Release).ext

TV Shows: Name - sXXeYY - Episode Name.ext

Multi-Episode TV Shows: Name - sXXeYY-eZZ.ext

Extras/Specials: Descriptive Name.ext

```



For example, if the original filename of a movie is:

```

WALL-E_(2008)_t00.mkv

```

the transcoded movie filename is:

```

Wall-E (2008).m4v

```

Similarly, if the original filename of a TV show is:

```

ANIMANIACS_S2E11_t01.mkv

```

where season/episode are indicated by S2E11, the transcoded TV show filename is:

```

Animaniacs - s02e011 - Critical Condition.m4v

```

In the case of a multi-episode TV show, if the original filename is:

```

TWIN_PEAKS_S1E1E8_t00.mkv

```

where the season/episodes are indicated by S1E1E8, the transcoded multi-episode TV show filename is:

```

Twin Peaks - s01e01-e08.m4v

```

Auto-renaming can be modified via Transcode’s preferences. 



For additional details about filename formatting expressions, see this [discussion](http://www.filebot.net/naming.html).



### Ingest



Transcode converts content by adding `.mkv` files to:

```

/Transcode/Convert

```

To set an ingest folder, drag or select the ingest folder in Settings>Ingest folder.



### Remote Ingest



Transcode can accept transcoded content (`.mkv`, `.m4v` or `.mp4` files) from remote Transcode ingest sources. This allows off-loading or parallel transcoding of content. Transcode accomplishes this by connecting to the Transcode destination using `rsync` over `ssh`.



To setup remote ingest:

```

1. Install Transcode on the remote ingest destination

2. At the remote ingest destination, select Settings>Accept transcode from remote sources

3. At the ingest source, select Settings>Send transcode to remote destination

4. Enter Settings>SSH username

5. Enter Settings>SSH address

```



### File Moving



#### Default transcode destination



Transcode will move files to these default destinations once transcoding has completed:

```

Converted files are moved to /Transcode/Completed

.mkv files are moved to /Transcode/Originals

Log files are moved to /Transcode/Logs

```



#### Custom transcode destination



Transcoded content can be automatically moved to a destination other than the Completed folder, e.g. 

`/Plex`, `/iTunes Media`, etc.



To set a custom output destination, drag or select the output folder in Settings>Completed folder.



After setting the output destination, Transcode will automatically move content to the following custom destination:

```

Movies: /{custom}/Movies/{Movie Title}

Movie Extras: /{custom}/Movies/{Movie Title}/{Extras Tag}

TV Shows: /{custom}/TV Shows/{Show Title}/{Season #}

TV Specials: /{custom}/TV Shows/{Show Title}/{Season #}/Specials

```

where the `Movies`, `TV Shows`, `Extras` or `Specials` folders and subfolders are created as needed.



Custom destinations will be ignored, if the renaming format for a movie or TV show differs from the default preference or the content name starts with `@` or `^` character.



#### Movie extras



It is possible to have transcoded “extras” moved to the appropriate collection in a custom destination e.g. `/Plex/Movies/Ice Age/Shorts/Gone Nutty.m4v`.



To place an “extra” in the appropriate collection, title the originating content using the following convention:

```

{title name}%{extras tag}-{descriptive name}

```

where the extras tag identifiers are:

```

Behind The Scenes

Deleted Scenes

Featurettes

Interviews

Scenes

Shorts

Trailers

```

For example, the White Christmas DVD contains the featurette, “A Look Back with Rosemary Clooney.” To add this to the White Christmas collection in Plex or iTunes, name the title:

```

WHITE_CHRISTMAS_(1954)%Featurettes-A Look Back with Rosemary Clooney.mkv

```



The transcoded title will be placed in:

```

/Movies/White Christmas (1954)/Featurettes/A Look Back with Rosemary Clooney.m4v 

```



#### TV specials



It is possible to have transcoded “specials” moved to the appropriate collection in a custom destination e.g. `/Plex/TV Shows/Futurama/Specials/Futurama s00e01 - Interview with Matt Groening.m4v`.



To place a “special” in the appropriate collection, title the originating content using the following convention:

```

{title name}_{specials tag}%{descriptive name}

```

where the specials tag identifier is `S00EYY`.



For example, the Futurama Season 1 DVD contains an interview with Matt Groening. To add this to the Futurama collection in Plex or iTunes, name the title:

```

FUTURAMA_S00E1%Interview with Matt Groening.mkv  

```



The transcoded title will be placed in:

```

/TV Shows/Futurama/Specials/Futurama s00e01 - Interview with Matt Groening.m4v 

```



### Finder Tags



Transcode applies Finder tags to both the original files (`.mkv`), the transcoded files (`.mkv`, `.m4v` or `.mp4`), and the log files (`.log`). This makes it easy to locate any file touched by Transcode.



By default, the following Finder tags are applied:

```

Originals: Blue and Converted

Movies: Purple, Movie and VT

TV Shows: Orange, TV Show and VT

Extras/Specials: Yellow, Extra and VT

Logs: log, VT, and [video quality option], e.g. log, VT, --quick

```

Finder tags and ‘title’ metadata tags can be set in bulk with the `Transcode • Update Finder Info` Finder Service. This provides individual or mass file tagging via the Finder’s Services menu.



Tag definitions can be added, edited, or deleted in the Settings app.



### Auto-Update



Transcode checks for updates everyday at 3 a.m.. Updating includes; installed brews, brew casks, Ruby gems and Transcode itself. If a Ruby gem update (`transcode-video`) is found, an update dialog is presented asking to proceed with the update.



![image](https://github.com/bmhayward/Transcode/blob/master/Demo/ready_2_upgrade.png)

![image](https://github.com/bmhayward/Transcode/blob/master/Demo/upgrade_completed.png)



To view a list of updates or general Transcode logging, open the Console app and search for ‘brew.’, ‘gem.’, ’batch.’, or ‘ transcode.’. The Transcode log file is located in `~/Library/Logs/transcode.log`.



### Preferences



Transcode’s preferences can be modified to tailor your workflow using the Settings app. ![image](https://github.com/bmhayward/Transcode/blob/master/Demo/Settings.png)



The preference file is a plist located in `~/Library/Preferences/com.videotranscode.preferences.plist`.



### Log Analyzer



The Log Analyzer app creates a tab-delimited report from HandBrake-generated `.log` files.



Title | Quality | Created | @ | time | speed (fps) | bitrate (kbps) | ratefactor 

--- | --- | --- | --- | --- | --- | --- | ---

+Aladdin_(1992)%Featurettes-Music_t19 | quick | 05/15/2016 | 10:44:41 | 00:01:17 | 102.0933 | 1817.38 | 21.33

+FUTURAMA_S03E01 | veryquick | 04/12/2016 | 06:44:11 | 00:02:38 | 204.952179 | 1428.14 | 13.79

AIRPLANE_t00 | quick | 03/14/2016 | 13:00:48 | 00:18:34 | 113.191116 | 2247.79 | 17.16



Open or drag-n-drop individual log files or a folder of log files onto the Log Analyzer app to create log specific reports.



To set the default application to open Log Analyzer reports:

```

Launch the Log Analyzer app while holding down the Option-key

Select the application

Click Choose

```



### MakeMKV



MakeMKV is a tool designed to decrypt and extract a video track from a Blu-ray Disc or DVD, and convert it into a single [Matroska](https://github.com/donmelton/video_transcoding#why-a-single-mkv-file) format file (`.mkv`).



#### MakeMKV tips



After inserting a disc:

```

Click the Open [Blu-ray or DVD] disc icon to load a discs titles

```

To have MakeMKV automatically load a DVD:

```

Open System Preferences>CDs & DVDs

Select When you insert a video DVD: Open MakeMKV

```

Prior to transcoding a title, you can change a titles name by:

```

Selecting the titles Description in the main area

Select Properties>Name

Edit Name field in the Properties area

```

Verify a movie or TV show title before naming:

```

Movies: go to TheMovieDB (https://www.themoviedb.org) website

TV Shows: go to TheTVDB (thetvdb.com) website

```

To FLAC encode audio:

```

Select MakeMKV>Profile>FLAC

```

Default to FLAC audio encode:

```

MakeMKV>Preferences>Advanced>FLAC

```

MakeMKV can have its output sent directly to the Convert folder for ingest by Transcode:

```

MakeMKV>Preferences>Video>Custom

```

MakeMKV language defaults can be used to narrow the auto-language selection of titles:

```

MakeMKV>Preferences>Language

```

MakeMKV default selection rules control how MakeMKV selects titles, audio, languages and subtitles:

```

MakeMKV>Preferences>Advanced>Default selection rule:

```

The default selection rules are a comma-separated list of tokens. Each token has a format of {action}:{condition} and are evaluated from left to right.



For example, this default selection rule:

```

-sel:all,+sel:audio&(eng),-sel:(havemulti),-sel:mvcvideo,-sel:subtitle,-sel:special,=100:all,-10:eng

```

invokes the following:

```

-sel:all            ->	deselect all tracks

+sel:audio&(eng)    ->	select all audio tracks in English

-sel:(havemulti)    ->	Deselect all mono/stereo tracks which a multi-channel track in same language

-sel:mvcvideo       ->	Deselect 3D multi-view videos

-sel:subtitle       ->	Deselect all subtitle tracks

-sel:special        ->	Deselect all special tracks (director’s comments etc.)

=100:all            ->	set output weight 100 to all tracks

-10:eng             ->	decrement the weight of all tracks in English language by 10 (to make them the first ones in output)

```

The tokens and operators available for use by the default selection rule are:

```

  +sel      - select track

  -sel      - unselect track

  +N        - add decimal value N to track weight

  -N        - subtract decimal value N from track weight

  =N        - set track weight to decimal value N	



default selection tokens:

  all       - always matches

  xxx       - matches specific language (ISO 639-2B/T code - eng,fra,etc...)

  N         - matches if Nth (or bigger) track of the same type and language

  favlang   - matches favorite languages, always matches if no favorite language is set

  special   - matches if track is special (directors comments, childrens, etc)

  video     - matches if track is video

  audio     - matches if track is audio

  subtitle  - matches if track is subtitle



video tracks:

  mvcvideo  - matches if track is a 3D multi-view video

  

audio tracks, special tracks never match:

  mono          - matches if mono

  stereo        - matches if stereo

  multi         - matches if multi-channel

  havemulti     - matches if track is mono/stereo and there is a multi-channel track in same language

  lossy         - matches if non-lossless

  lossless      - matches if lossless

  havelossless  - matches if non-lossless track, but there is a lossless track in same language

  core          - matches if this track is core audio, logical part of hd track

  havecore      - matches if this track is hd track with core audio



subtitle tracks:

  forced  - matches if track is forced



operators:

  | 		- logical or

  & 		- logical and

  ! 		- logical not

  ~ 		- alias for "!", logical not

  * 		- alias for "&", logical and

```



## Acknowledgements

A huge “thank you” to [@donmelton](https://github.com/donmelton/video_transcoding) and the developers of the other tools used by this package.



## Requirements

OS X 10.11 El Capitan or later.



Most of the tools in this package require other software to function properly.



Transcode Setup Assistant will install these command line programs:



* `atomicparsely`

* `ffmpeg`

* `filebot`

* `handbrakecli`

* `Java`

* `mkvtoolnix`

* `mp4v2`

* `mpv`

* `rsync`

* `ruby`

* `tag`

* `terminal-notifier`

* `transcode_video`

* `Xcode command-line tools`



## History



### [2.0.1](https://github.com/bmhayward/Transcode/releases/tag/2.0.1)

Saturday, April 1, 2017

* Added time_date stamp to log file names.



### [2.0.0](https://github.com/bmhayward/Transcode/releases/tag/2.0.0)

Friday, March 31, 2017

* Version 2.0 released!



### [1.4.8](https://github.com/bmhayward/Transcode/releases/tag/1.4.8)

Friday, August 19, 2016

* Correct an issue with the % delimiter causing the files to be renamed with a # symbol.



### [1.4.7](https://github.com/bmhayward/Transcode/releases/tag/1.4.7)

Tuesday, August 16, 2016

* Moved to % delimiter for 'extras' and 'specials'.



### [1.4.6](https://github.com/bmhayward/Transcode/releases/tag/1.4.6)

Tuesday, August 3, 2016

* Corrected an issue where batch.command would sometimes get skipped if updated.



### [1.4.5](https://github.com/bmhayward/Transcode/releases/tag/1.4.5)

Monday, August 1, 2016

* Corrected a typo in the 1.4.4 release.



### [1.4.4](https://github.com/bmhayward/Transcode/releases/tag/1.4.4)

Monday, August 1, 2016

* Corrected an issue that prevented Transcode Updater.app from completing.



### [1.4.3](https://github.com/bmhayward/Transcode/releases/tag/1.4.3)

Sunday, July 31, 2016

* Added gem updater removal to uninstallTranscode.command.



### [1.4.2](https://github.com/bmhayward/Transcode/releases/tag/1.4.2)

Saturday, July 30, 2016

* Gem updater now starts looking for gem updates at 9:05 a.m.. If an update is found, will wait for two minutes of UI idle time before requesting the update from the user. The updater will wait up to eight hours for two minutes of UI idle time before giving up and trying again the next day.

* watchFolder_Ingest is now less agressive if ingest is active.

* Added Notification Center notifications for updates.

* Some minor code clean up.



### [1.4.1](https://github.com/bmhayward/Transcode/releases/tag/1.4.1)

Friday, July 15, 2016

* Third time is a charm for the gem updater code. Completely rewrote how gems are updated.

* Added colorization to batch.command to make it easier to spot what is going on in the output

* You can now get the Transcode version by running `batch.command --version` from the command-line



### [1.4.0](https://github.com/bmhayward/Transcode/releases/tag/1.4.0)

Tuesday, June 28, 2016

* In some instances, post-update code would not execute and gems would not be checked for update. Completely reworked post-Transcode and gem update code



### [1.3.9](https://github.com/bmhayward/Transcode/releases/tag/1.3.9)

Saturday, June 25, 2016

* Corrected a variable change that broke Ruby gem updates



### [1.3.8](https://github.com/bmhayward/Transcode/releases/tag/1.3.8)

Saturday, June 25, 2016

* Corrected a typo in the 1.3.7 release the prevented Ruby gems from updating



### [1.3.7](https://github.com/bmhayward/Transcode/releases/tag/1.3.7)

Saturday, June 25, 2016

* Fixed an issue with Ruby gems not getting updated when an update is available



### [1.3.6](https://github.com/bmhayward/Transcode/releases/tag/1.3.6)

Thursday, June 23, 2016

* Updated the auto-updater to correct an issue with multi-version updates



### [1.3.5](https://github.com/bmhayward/Transcode/releases/tag/1.3.5)

Tuesday, June 21, 2016

* Added SHA1 checksum to the auto-updater



### [1.3.4](https://github.com/bmhayward/Transcode/releases/tag/1.3.4)

Monday, June 20, 2016

* Fixed an issue where an extra zero would sometimes get inserted into a multi-episode name

* Improved batch queuing of files that are slow to ingest



### [1.3.3](https://github.com/bmhayward/Transcode/releases/tag/1.3.3)

Saturday, June 18, 2016

* Added a check to verify /usr/local/bin has correct permissions before installing



### [1.3.2](https://github.com/bmhayward/Transcode/releases/tag/1.3.2)

Saturday, June 18, 2016

* Fixed a regression error from v1.2.9 impacting multi-version updates



### [1.3.1](https://github.com/bmhayward/Transcode/releases/tag/1.3.1)

Saturday, June 11, 2016

* Updated the auto-updater to correct an issue with multi-version updates



### [1.3.0](https://github.com/bmhayward/Transcode/releases/tag/1.3.0)

Wednesday, June 8, 2016

* Cleaned up the auto-updater to remove all temporary files when done



### [1.2.9](https://github.com/bmhayward/Transcode/releases/tag/1.2.9)

Wednesday, June 8, 2016

* Cleaned up the auto-updater to remove all temporary files when done

* Improved messaging around crop values used if differences are found by ```detect-crop``` tool



### [1.2.8](https://github.com/bmhayward/Transcode/releases/tag/1.2.8)

Tuesday, June 7, 2016

* Transcode auto-update changed to support multi-version updates



### [1.2.7](https://github.com/bmhayward/Transcode/releases/tag/1.2.7)

Monday, June 6, 2016

* Updated Finder service Transcode • Update Finder Info to ignore original content with a '^' label and to only tag original content with Finder tags blue,Converted



### [1.2.6](https://github.com/bmhayward/Transcode/releases/tag/1.2.6)

Saturday, June 4, 2016

* Fixed an issue where Specials or Extras originating files were marked with Finder tags yellow,Extra,VT. They are now marked with Finder tags blue,Converted



### [1.2.5](https://github.com/bmhayward/Transcode/releases/tag/1.2.5)

Saturday, June 4, 2016

* Added Transcode auto-update feature

* Updated TV Show and TV multi-episode naming so that the name is always structured with a leading zero if required, e.g. s04e06.m4v or s03e01-e18.m4v

* A copy of Transcode Setup Assistant is now placed in /Transcode/Extras during installation



### [1.2.4](https://github.com/bmhayward/Transcode/releases/tag/1.2.4)

Wednesday, May 25, 2016

* Moved all terminal and Console messaging to a standardized library

* Moved all error trapping to a standardized library

* Updated Transcode Setup Assistant to support the current version of Xcode Command-Line Tools



### [1.2.3](https://github.com/bmhayward/Transcode/releases/tag/1.2.3)

Wednesday, May 18, 2016

* Updated Finder Services to use preferences read/write libraries



### [1.2.2](https://github.com/bmhayward/Transcode/releases/tag/1.2.2)

Monday, May 16, 2016

* Added `Transcode • Transmogrify Video` Finder Service



### [1.2.1](https://github.com/bmhayward/Transcode/releases/tag/1.2.1)

Sunday, May 15, 2016

* Pass-through labeled titles are no longer processed by the `detect-crop` tool

* Improved batch queuing of files that are slow to ingest



### [1.2.0](https://github.com/bmhayward/Transcode/releases/tag/1.2.0)

Saturday, May 14, 2016

* Added pass-through title naming

* Improved batch queue handling



### [1.1.9](https://github.com/bmhayward/Transcode/releases/tag/1.1.9)

Friday, May 13, 2016

* Enabled opportunistic name matching in Filebot



### [1.1.8](https://github.com/bmhayward/Transcode/releases/tag/1.1.8)

Thursday, May 12, 2016

* Fixed handling of original content folder naming

  * After transcoding completes, original content is to be moved to /Transcode/Originals/{contentTitle}. In some instances, the 

    contentTitle was not being set correctly.

* Added chmod +x for all scripts during initial install with Transcode Setup Assistant.



### [1.1.7](https://github.com/bmhayward/Transcode/releases/tag/1.1.7)

Tuesday, May 10, 2016



* Fixed handling of original content tagged as 'movie'

  * After transcoding completes, original content is to be moved to /Transcode/Originals/{movieTitle}. However, the original content 

    was not being moved, so transcoding would start again and continue on indefinitely. Corrected path to /Transcode/Originals/{movieTitle}.

* Added Transcode Log Analyzer preference for the helper app

  * You can now specify any app to open the final tab-delimited report



### [1.1.6](https://github.com/bmhayward/Transcode/releases/tag/1.1.6)

Sunday, May 8, 2016



* Initial project version