Add parameters for extra args

Added parameters that accept additional x265/ffmpeg arguments not covered in the rest of the script.
patrickenfuego · Aug 17, 2021 · 5724b0d · 5724b0d
1 parent fe2fe36
commit 5724b0d
Show file tree

Hide file tree

Showing 4 changed files with 99 additions and 20 deletions.
diff --git a/FFEncoder.ps1 b/FFEncoder.ps1
@@ -36,6 +36,12 @@
     .EXAMPLE 
         ## Adjust psycho visual settings and aq-mode level/strength ##
         ./FFEncoder.ps1 "~/Movies/Ex.Machina.2014.DTS-HD.mkv" -PsyRd 4.0 -PsyRdoq 1.50 -AqMode 1 -AqStrength 0.90 -o "C:\Users\user\Videos\Ex Machina (2014) DTS-HD.mkv"
+    .EXAMPLE
+        ## Pass additional ffmpeg arguments not covered by other script parameters ##
+        .\FFEncoder.ps1 -i "C:\Users\user\Videos\Ex.Machina.2014.DTS-HD.mkv" -CRF 18 -FFMpegExtra @{'-t' = 20}, 'nostats' -o "C:\Users\user\Videos\Ex Machina (2014) DTS-HD.mkv"
+    .EXAMPLE
+        ## Pass additional x265 arguments not covered by other script parameters ##
+        ./FFEncoder.ps1 "~/Movies/Ex.Machina.2014.DTS-HD.mkv" -PsyRd 4.0 -CRF 20 -x265Extra @{'max-merge' = 1} -o "C:\Users\user\Videos\Ex Machina (2014) DTS-HD.mkv"
     .INPUTS
         HD/FHD/UHD video file 
     .OUTPUTS
@@ -130,6 +136,12 @@
         Sets the quantizer curve compression factor, which effects the bitrate variance throughout the encode
     .PARAMETER OutputPath
         Location of the encoded output video file
+    .PARAMETER FFMpegExtra
+        Pass additional settings to ffmpeg that are not supplied by the script. Accepts single array arguments or hashtables in the form of <key = value>.
+        WARNING: The script does not check for valid syntax, and assumes you know what you're doing
+    .PARAMETER x265Extra
+        Pass additional settings to the x265 encoder that are not supplied by the script. Settings must be passed as a hashtable in the form of <key = value>.
+        WARNING: The script does not check for valid syntax, and assumes you know what you're doing
     .PARAMETER RemoveFiles
         Switch to delete extraneous files generated by the script (crop file, log file, etc.). The input, output, and report files will not be deleted
     .PARAMETER Deinterlace
@@ -314,6 +326,16 @@ param (
     [Alias("FT")]
     [int]$FrameThreads,
 
+    [Parameter(Mandatory = $false, ParameterSetName = "CRF")]
+    [Parameter(Mandatory = $false, ParameterSetName = "Pass")]
+    [Alias("FE")]
+    [array]$FFMpegExtra,
+
+    [Parameter(Mandatory = $false, ParameterSetName = "CRF")]
+    [Parameter(Mandatory = $false, ParameterSetName = "Pass")]
+    [Alias("XE")]
+    [hashtable]$x265Extra,
+
     [Parameter(Mandatory = $true, ParameterSetName = "CRF")]
     [Parameter(Mandatory = $true, ParameterSetName = "Pass")]
     [ValidateNotNullOrEmpty()]
@@ -515,6 +537,8 @@ $ffmpegParams = @{
     Subme          = $Subme 
     IntraSmoothing = $StrongIntraSmoothing
     FrameThreads   = $FrameThreads
+    FFMpegExtra    = $FFMpegExtra
+    x265Extra      = $x265Extra
     Paths          = $paths
     TestFrames     = $TestFrames
 }

diff --git a/README.md b/README.md
@@ -9,6 +9,7 @@
   - [Automatic HDR Metadata](#automatic-hdr-metadata)
   - [Rate Control Options](#rate-control-options)
   - [Script Parameters](#script-parameters)
+    - [Using the Extra Parameter Options](#using-the-extra-parameter-options)
   - [Hard Coded Parameters](#hard-coded-parameters)
     - [Exclusive to First Pass ABR](#exclusive-to-first-pass-abr)
     - [Exclusive to 4K UHD Content](#exclusive-to-4k-uhd-content)
@@ -79,18 +80,20 @@ To install PowerShell Core, run the following command using Homebrew:
 
 > `brew install --cask powershell`
 
-&nbsp;
+---
 
 ## Auto-Cropping
 
 FFEncoder will auto-crop your video, and works similarly to programs like Handbrake. The script uses ffmpeg's `cropdetect` argument to analyze up to 5 separate segments of the source simultaneously. The collected output of each cropping instance is then saved to a file, which is used to determine the ideal cropping width and height for encoding.
 
-&nbsp;
+---
 
 ## Automatic HDR Metadata
 
 FFEncoder will automatically fetch and fill HDR metadata before encoding begins. This includes:
 
+> **NOTE:** Color Range (Limited) and Chroma Subsampling (4:2:0) are currently hard coded as they are the same for every source I've seen.
+
 - Mastering Display Color Primaries (Display P3 and BT.2020 supported)
 - Pixel format
 - Color Space (Matrix Coefficients)
@@ -101,9 +104,7 @@ FFEncoder will automatically fetch and fill HDR metadata before encoding begins.
 - Maximum Frame Average Light Level
 - HDR10+ SEI packets (optional, see [dependencies](#dependency-installation))
 
-Color Range (Limited) and Chroma Subsampling (4:2:0) are currently hard coded as they are the same for every source I've seen.
-
-&nbsp;
+---
 
 ## Rate Control Options
 
@@ -112,11 +113,11 @@ FFEncoder supports the following rate control options:
 - **Constant Rate Factor (CRF)** - CRF encoding targets a specific quality level throughout, and isn't concerned with file size. Lower CRF values will result in a higher perceived quality and bitrate
   - Recommended values for 1080p content are between 16-24
   - Recommended values for 2160p content are between 17-26
-- **Average Bitrate** - Average bitrate encoding targets a specific output file size, and isn't concerned with quality. Output size is determined by dividing the average bitrate by the video length. There are 2 varieties of ABR encoding that FFEncoder supports:
+- **Average Bitrate** - Average bitrate encoding targets a specific output file size, and isn't concerned with quality. There are 2 varieties of ABR encoding that FFEncoder supports:
   - **1-Pass** - This option uses a single pass, and isn't aware of the complexities of future frames and can only be scaled based on the past. This generally leads to lower overall quality, but is significantly faster than 2-pass
   - **2-Pass** - 2-Pass encoding uses a first pass to calculate bitrate distribution, which is then used to allocate bits more accurately on the second pass. While it's more time consuming than a single pass encode, quality is generally improved significantly. This script uses a custom combination of parameters for the first pass to help strike a balance between speed and quality
 
-&nbsp;
+---
 
 ## Script Parameters
 
@@ -153,15 +154,37 @@ FFEncoder can accept the following parameters from the command line. Most parame
 | **BFrames**              | Preset  | False         | **B**                  | The number of consecutive B-Frames within a GOP. This is especially helpful for test encodes to determine the ideal number of B-Frames to use            |
 | **BIntra**               | Preset  | False         | **BINT**               | Enables the evaluation of intra modes in B slices. Has a minor impact on performance                                                                     |
 | **StrongIntraSmoothing** | 1 (on)  | False         | **SIS**                | Enable/disable strong-intra-smoothing. Accepted values are 1 (on) and 0 (off)                                                                            |
-| **FrameThreads**         | System  | False         | **ST**                 | Set frame threads. More threads equate to faster encoding, but with a decrease in quality. System default is based on the number of logical CPU cores    |
+| **FrameThreads**         | System  | False         | **FT**                 | Set frame threads. More threads equate to faster encoding, but with a decrease in quality. System default is based on the number of logical CPU cores    |
 | **Subme**                | Preset  | False         | **SM**, **SPM**        | The amount of subpel motion refinement to perform. At values larger than 2, chroma residual cost is included. Has a significant performance impact       |
+| **FFMpegExtra**          | N/A     | False         | **FE**                 | Pass additional settings to ffmpeg as a generic array of single and multi-valued elements. Useful for options not covered by other parameters            |
+| **x265Extra**            | N/A     | False         | **XE**                 | Pass additional settings to the x265 encoder as a hashtable of values. Useful for options not covered by other parameters                                |
 | **NoiseReduction**       | 0, 0    | False         | **NR**                 | Noise reduction filter. The first value represents intra frames, and the second value inter frames; values range from 0-2000. Useful for grainy sources  |
 | **OutputPath**           | N/A     | True          | **O**                  | The path to the encoded output file                                                                                                                      |
 | **RemoveFiles**          | False   | False         | **Del**, **RM**        | Switch that deletes extra files generated by the script (crop file, log file, etc.). Does not delete the input, output, or report files                  |
 | **GenerateReport**       | False   | False         | **Report**, **GR**     | Switch that generates a report of the encode. Data is pulled from the log file and written in a reading friendly format                                  |
 | **Deinterlace**          | False   | False         | **DI**                 | Switch to enable deinterlacing of interlaced content using yadif                                                                                         |
 
-&nbsp;
+### Using the Extra Parameter Options
+
+> **WARNING**: The script **does not** check syntax, and assumes you know what you're doing. Be sure to test, test, test!
+
+You can pass additional arguments not provided by the script to both ffmpeg and x265 using the `-FFMpegExtra` and `-x265Extra` parameters, respectively.
+
+`-FFMpegExtra` accepts a generic array that can receive single and multi-valued arguments. For options that receive no argument, i.e. `stats/nostats`, pass it as a single element; otherwise, use a hashtable. For example:
+
+```PowerShell
+#Pass additional arguments to ffmpeg using an array with a hashtable and a single value
+.\FFEncoder.ps1 $InputPath -CRF 18 -FFMpegExtra @{ '-t', 20; '-stats_period' = 5 }, '-autorotate' -o $OutputPath
+```
+
+`-x265Extra` accepts a hashtable of values as input, in the form of `<key = value>`. For example:
+
+```PowerShell
+#Pass additional arguments to the x265 encoder using a hashtable of values
+.\FFEncoder.ps1 $InputPath -CRF 18 -x265Extra @{ 'max-merge' = 1; 'max-tu-size' = 16 } -o $OutputPath
+```
+
+---
 
 ## Hard Coded Parameters
 
@@ -189,7 +212,7 @@ x265 offers a `--no-slow-firstpass` option to speed up the first pass of a 2-Pas
 
 - `merange=44` - The default value of 57 is a bit much for 1080p content, and it slows the encode with no noticeable gain
 
-&nbsp;
+---
 
 ## Audio Options
 
@@ -217,7 +240,7 @@ FFEncoder currently supports the following audio options wih the `-Audio`/`-Audi
 | **Stream #** | `0-5`            | N/A            | Select an audio stream using its stream identifier in ffmpeg/ffprobe. Not compatible with the `-Stereo` parameters                      |
 | **None**     | `none`, `n`      | N/A            | No audio streams will be added to the output file                                                                                       |
 
-&nbsp;
+---
 
 ### Using the libfdk_aac Encoder
 
@@ -241,7 +264,7 @@ With FFEncoder, you can downmix either of the two output streams to stereo using
 
 When using any combination of `copy`/`c`/`copyall`/`ca` and `-Stereo`/`-Stereo2`, the script will multiplex the primary audio stream out of the container and encode it separately; this is because ffmpeg cannot stream copy and filter at the same time. See [here](https://stackoverflow.com/questions/53518589/how-to-use-filtering-and-stream-copy-together-with-ffmpeg) for a nice explanation. Once the primary encode finishes, the external audio file (now converted to stereo) is multiplexed back into the primary container with the other streams selected.
 
-&nbsp;
+---
 
 ## Subtitle Options
 

diff --git a/modules/FFTools/Private/Set-FFMpegArgs.ps1 b/modules/FFTools/Private/Set-FFMpegArgs.ps1
@@ -79,6 +79,12 @@ function Set-FFMpegArgs {
         [Parameter(Mandatory = $false)]
         [int]$FrameThreads,
 
+        [Parameter(Mandatory = $false)]
+        [array]$FFMpegExtra,
+
+        [Parameter(Mandatory = $false)]
+        [hashtable]$x265Extra,
+
         # Parameter help description
         [Parameter(Mandatory = $false)]
         [hashtable]$HDR,
@@ -167,6 +173,28 @@ function Set-FFMpegArgs {
 
     ## End base array declarations ##
 
+    ## Unpack extra parameters
+
+    if ($PSBoundParameters['FFMpegExtra']) {
+        [string[]]$ffmpegExtraArray = @()
+        foreach ($arg in $FFMpegExtra) {
+            if ($arg -is [hashtable]) {
+                foreach ($entry in $arg.GetEnumerator()) {
+                    $ffmpegExtraArray += "$($entry.Name)"
+                    $ffmpegExtraArray += "$($entry.Value)"
+                }
+            }
+            else { $ffmpegExtraArray += $arg }
+        }
+    }
+
+    if ($PSBoundParameters['x265Extra']) {
+        [string[]]$x265ExtraArray = @()
+        foreach ($arg in $x265Extra.GetEnumerator()) {
+            $x265ExtraArray += "$($arg.Name)=$($arg.Value)"
+        }
+    }
+
     ## Build Argument Arrays ##
 
     #Add frame threads parameter if set by user
@@ -216,12 +244,14 @@ function Set-FFMpegArgs {
 
     $ffmpegArgsAL += $vfArray
     if ($testArray) { $ffmpegArgsAL += $testArray }
+    if ($ffmpegExtraArray) { $ffmpegArgsAL += $ffmpegExtraArray }
     $ffmpegArgsAL += $pxFormatArray
 
     #Build x265 arguments for CRF/ 1-pass
     if (!$twoPass) {
         #Combine x265 args and join
-        $tmpArray = $x265Array + $resArray 
+        $tmpArray = $x265Array + $resArray
+        if ($x265ExtraArray) { $tmpArray += $x265ExtraArray }
         $x265String = $tmpArray -join ":"
         $ffmpegArgsAL += @('-x265-params', "`"$x265String`"")
 
@@ -237,16 +267,10 @@ function Set-FFMpegArgs {
         $ffmpegArgsAL += @('-x265-params', "`"$x265String`"")
         #Second pass
         $tmpArray = @('pass=2', "stats='$($Paths.X265Log)'") + $x265Array + $resArray
+        if ($x265ExtraArray) { $tmpArray += $x265ExtraArray }
         $x265String = $tmpArray -join ":"
         $ffmpegPassTwoArgsAL += @('-x265-params', "`"$x265String`"")
 
         return @($ffmpegArgsAL, $ffmpegPassTwoArgsAL)
     }
 }
-
-
-
-
-
-
-
diff --git a/modules/FFTools/Public/Invoke-FFMpeg.ps1 b/modules/FFTools/Public/Invoke-FFMpeg.ps1
@@ -101,6 +101,12 @@ function Invoke-FFMpeg {
         [Parameter(Mandatory = $false)]
         [int]$FrameThreads,
 
+        [Parameter(Mandatory = $false)]
+        [array]$FFMpegExtra,
+
+        [Parameter(Mandatory = $false)]
+        [hashtable]$x265Extra,
+
         # Path to the log file
         [Parameter(Mandatory = $true)]
         [Alias("L")]
@@ -188,6 +194,8 @@ function Invoke-FFMpeg {
         NoiseReduction = $NoiseReduction
         IntraSmoothing = $IntraSmoothing
         FrameThreads   = $FrameThreads
+        FFMpegExtra    = $FFMpegExtra
+        x265Extra      = $x265Extra
         HDR            = $HDR
         Paths          = $Paths
         TestFrames     = $TestFrames