FFmpegSource2 Documentation

Opens files using ffmpeg and nothing else. May be frame accurate on good days. The source is MIT licensed and can be obtained from "http://svn.aegisub.net/trunk/aegisub/FFmpegSource2/". The precompiled binary is GPL licensed. If you are religious you may consider this the second coming.

Known issues

Compatibility - Video

Compatibility - Audio

Usage

FFIndex(string source, string cachefile = source + ".ffindex", int indexmask = 0, int dumpmask = 0, string audiofile = source, bool overwrite = false)
Used to invoke indexing separately and to write audio tracks to disk as wave64 files

FFVideoSource(string source, int track, bool cache = true, string cachefile = source + ".ffindex", int fpsnum = -1, int fpsden = 1, string pp, int threads = -1, string timecodes, int seekmode = 1)
Opens video, will invoke indexing with the defaults if no preexisting index is found

FFAudioSource(string source, int track, bool cache = true, string cachefile = source + ".ffindex")
Opens audio, if an index already exists it needs to contain a suitable audio index or empty audio will be returned, will invoke indexing with the defaults if no preexisting index is found

FFPP(clip, string pp)
Separate postprocessing which also seems to include a few simple deinterlacers

SWScale(clip, width = -1, height = -1, resizer = "BICUBIC", colorspace = "")
Separate postprocessing which also seems to include a few simple deinterlacers

FFSetLogLevel(int Level)
Sets the log FFmpeg logging level, defaults to quiet (-8) and the FFmpeg default is 16, all different values can be found in avutil/log.h

FFGetLogLevel()
Returns the current level of logging as an int

source: Source file.

indexmask & dumpmask: Which audio tracks to index/write to disk. Dumping a track also implies indexing since the same work has to be done anyway. It is a binary mask meaning that 7 corresponds to writing tracks 1-3. Non-audio tracks are ignored. -1 writes all tracks.

audiofile: The base name to use for the decoded audio. Track number and delay is appended.

overwrite: Forces reindexing even if a valid index already exists. May be useful for trackmask changes or testing.

track: Track number as seen by the relevant demuxer, starts from 0, -1 means it will pick the first suitable track.

fpsnum & fpsden: For VFR -> CFR conversion. Setting fpsnum <= 0 means a 1:1 relation with the encoded frames.

timecodes: File to output timecodes to, if the file exists it will be overwritten.

cache: Write indexing information to a file for later use. This setting does not control if the video index is loaded which it always is if it exists.

cachefile Where to write the cache information.

pp: See the table below for a full description, an empty string means no processing. It is recommended to avoid the autoq option since it's currently unknown what effect it will have on the processing.

threads: Sets the number of decoder threads used. Defaults to the number of cpus reported by windows. Ignored by lavc if the used decoder doesn't implement it.

seekmode: Force how seeking is handled, has no effect on matroska files which always use the equivalent of seekmode=1
-1: linear access without rewind, will throw an error if each successive requested frame number isn't bigger than the last one, only intended for opening images but might work on well with some obscure video format
0: linear access, the definition of slow but should make some formats "usable"
1: safe normal, bases seeking decisions on the reported keyframe positions
2: unsafe normal, same as 1 but no error will be thrown if the exact destination has to be guessed
3: aggressive, seek in the forward direction even if no closer keyframe is known to exist, only useful for testing and containers where avformat doesn't report keyframes properly

width & height: Width and height to resize to. Value below or equal to 0 is the same as specifying the input dimensions.

resizer: Selects the resizer used for resampling the chroma planes and normal resizing. The available methods are: FAST_BILINEAR, BILINEAR, BICUBIC, X, POINT, AREA, BICUBLIN, GAUSS, SINC, LANCZOS and SPLINE.

colorspace: The colorspace to convert to. The names are YV12, YUY2, RGB24, RGB32 and the empty string for same as input.

Exported Avisynth variables

FFSAR_NUM, FFSAR_DEN, FFSAR: The playback aspect ratio specified by the container. FFSAR_NUM and FFSAR_DEN make up the rational number of the ratio and FFSAR is only provided for convenience.

FFCROP_LEFT, FFCROP_RIGHT, FFCROP_TOP, FFCROP_BOTTOM: The on playback cropping specified by the container.

FFPICT_TYPE: The picture type of the most recently requested frame. Use after_frame=true in Avisynth's conditional scripting for proper results. The FFmpeg source definition of the numbers: 

FF_I_TYPE  1 ///< Intra
FF_P_TYPE  2 ///< Predicted
FF_B_TYPE  3 ///< Bi-dir predicted
FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
FF_SI_TYPE 5 ///< Switching Intra
FF_SP_TYPE 6 ///< Switching Predicted
FF_BI_TYPE 7

PP string format

Available postprocessing filters:
Filters                        Options
short  long name       short   long option     Description
*      *               a       autoq           CPU power dependent enabler
                       c       chrom           chrominance filtering enabled
                       y       nochrom         chrominance filtering disabled
                       n       noluma          luma filtering disabled
hb     hdeblock        (2 threshold)           horizontal deblocking filter
       1. difference factor: default=32, higher -> more deblocking
       2. flatness threshold: default=39, lower -> more deblocking
                       the h & v deblocking filters share these
                       so you can't set different thresholds for h / v
vb     vdeblock        (2 threshold)           vertical deblocking filter
ha     hadeblock       (2 threshold)           horizontal deblocking filter
va     vadeblock       (2 threshold)           vertical deblocking filter
h1     x1hdeblock                              experimental h deblock filter 1
v1     x1vdeblock                              experimental v deblock filter 1
dr     dering                                  deringing filter
al     autolevels                              automatic brightness / contrast
                       f        fullyrange     stretch luminance to (0..255)
lb     linblenddeint                           linear blend deinterlacer
li     linipoldeint                            linear interpolating deinterlace
ci     cubicipoldeint                          cubic interpolating deinterlacer
md     mediandeint                             median deinterlacer
fd     ffmpegdeint                             ffmpeg deinterlacer
l5     lowpass5                                FIR lowpass deinterlacer
de     default                                 hb:a,vb:a,dr:a
fa     fast                                    h1:a,v1:a,dr:a
ac                                             ha:a:128:7,va:a,dr:a
tn     tmpnoise        (3 threshold)           temporal noise reducer
                     1. <= 2. <= 3.            larger -> stronger filtering
fq     forceQuant                   force quantizer
Usage:
[:

Compiling

zlib from http://www.zlib.net/

FFmpeg svn from http://ffmpeg.mplayerhq.hu/

pthreads only required for FFmpeg-mt compiles

Required FFmpeg Configuration: ./configure --enable-memalign-hack --enable-gpl --enable-postproc

Suggested Additional Options: --enable-w32threads --disable-encoders --disable-muxers --disable-network --disable-debug --enable-libfaad --disable-decoder=aac

Note that --enable-w32threads or --enable-pthreads is required for multithreaded decoding to work. For FFmpeg-mt only --enable-pthreads will work.

Changes