Usage - staxrip/staxrip GitHub Wiki

Video Processing

Video processing is supported via AviSynth and VapourSynth, both being equally well supported.

The script code of AviSynth and VapourSynth can be edited directly or easily be generated via menu selection for which a profile system is available to integrate and customize custom filters and plugins.

With the help of a macro system script parameters can be changed with convenient GUI features like a resize slider and menu or a cropping dialog, due to the macro system the parameters can change at any time allowing much greater flexibility compared to a one dimensional and limiting one step after another approach.

Filter Profiles

StaxRip includes a large set of filter plugins and filter presets for the plugins. The presets can be selected in the filter menu.

Once a preset is selected, it can be modified using the Code Editor that can be accessed by double-clicking on any filter entry. When the Code Editor is open, the syntax of the filters can be edited. Parameters can be tweaked or added. This requires some knowledge of AviSynth/VapourSynth.

Custom Filter Profiles

[!NOTE] This paragraph describes advanced customization, for advanced users.

The filter profiles editor can be used to customize the included filter profiles and to create new custom filter profiles.

The profile editor can be found at: Filter Menu > Profiles

The filter profiles use the INI format:

[Filter Type]

Menu item name = Filter code

Cascading/sub menus:

Top level | Level 2 | Level 3 = Filter code

Multi-line code:

Menu name =
    code line 1
    code line 2

Many of the included presets use macros to show a selection box. (https://github.com/staxrip/staxrip/wiki/Macros)

Example:

[Field]

yadifmod2 =
    LoadPlugin("D:\yadifmod2\yadifmod2.dll")
    yadifmod2()

Opening scripts externally

Opening AviSynth and VapourSynth scripts with external apps from outside of StaxRip might require adding various directories to the PATH environment variable.

The Apps dialog has a feature that helps adding the directories: Apps > Manage > Tools > Path Env Var

Consider adding the following directories to PATH:

  • Apps\FrameServer\AviSynth
  • Apps\FrameServer\VapourSynth

Legacy apps like VirtualDub2 or MPC player are VFW based and therefore require AviSynth/VapourSynth being installed. For modern apps like mpv.net it's sufficient to add the portable AviSynth/VapourSynth folder to PATH.

  • Apps\Support\VC

This is a VC++ runtime All-in-One package which many apps, libraries and plugins depend on.

  • Apps\Support\FFTW

This a library which many AviSynth and VapourSynth plugins depend on.

Templates

StaxRip uses a template system, technically a template is a empty project file. When StaxRip starts it loads a default template, this default template can be changed at:

Main Menu > Tools > Settings > General > Startup Template

Project options are saved in templates/projects while Tools > Settings are global settings.

A template can be saved using:

Main Menu > File > Save Project As Template

[!NOTE] Saving a template is possible only if no video is loaded in StaxRip.

Video Encoding

Supported encoders are:

  • x264
  • x265
  • nvenc
  • qsvenc
  • vceenc
  • aomenc
  • rav1e
  • SVT-AV1
  • ffmpeg (many encoders including xvid)

Parallel Processing

Job Processing

The jobs list can be processed with multiple StaxRip instances in parallel. This feature is only recommended for power users that know exactly what their hardware is capable of.

Chunk Encoding

StaxRip supports chunk encoding for the x265 and aomenc encoder, it splits the encoding into multiple chunks and encodes the chunks in parallel. Only recommended for power users that know exactly what their hardware is capable of.

Setting the number of chunks:

Encoder Options > Input/Output > Chunks

Setting the number of allowed parallel processes:

Main Menu > Tools > Settings > General > Maximum number of parallel processes

Batch Processing

For Batch Processing first wanted options have to be changed, after that files can be added at:

File > Open Video File > File Batch

Not only encoding is supported but any task like remuxing, demuxing or AviSynth/VapourSynth script generation, this can be achieved by disabling unwanted features, almost every feature can be disabled:

  • The video encoder profiles have a Copy/Mux profile.
  • The muxer profiles have a No Muxing profile.
  • The audio profiles have a Copy/Mux and a No Audio profile.
  • Indexing can be disabled by installing LAV Filters and by enabling the DSS2 source filter.
  • Audio and subtitle demuxing can be disabled in the Options dialog.

Command Engine

StaxRip uses a command engine for the following features:

  • StaxRips command line interface
  • StaxRips configurable main menu and various other menus
  • StaxRips Event Command Feature: Main Menu > Tools > Advanced > Event Commands

The Event Command feature allows to run commands on defined events under defined conditions.