View source for FFmpegSource

{{FilterCat|External_filters|Plugins|Source_filters}}
{{Filter5
|1={{Author/Myrsloik}}, et al.
|2=v2.22
|3=[http://github.com/FFMS/ffms2/releases FFMS2 v2.22]
|4=[http://forum.doom9.org/member.php?u=135430 10bithack version]
|5=[http://github.com/FFMS/ffms2/blob/master/doc/ffms2-avisynth.md User Manual]
|6=Source filters 
|7=[http://opensource.org/licenses/MIT MIT] / binary is [http://www.gnu.org/licenses/gpl.txt GPLv3]
|8=[http://forum.doom9.org/showthread.php?t=127037 Doom9 Thread]}}

== Description ==
Opens files using FFmpeg and (almost) nothing else. May be frame accurate on good days. The source is MIT licensed and can be obtained from the [http://github.com/FFMS/ffms2/ GitHub repository]. The precompiled binary is GPL3 licensed.
<br>
<br>
== Requirements ==
* AviSynth 2.6.0 or [http://sourceforge.net/projects/avisynth2/ greater]
* Supported color formats: [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]<br>
:([[High_bit-depth_Support_with_Avisynth#Importing_High_Bit-depth_Video_into_AviSynth|10-bit formats]] are supported with the 10bithack version - see alternate download above)
<br>
== Limitations ==
*Because of LAVF's demuxer, most raw streams (such as elementary h264 and other mpeg video streams) will fail to work properly.

*FFAudioSource() will have to remake any index implicitly created by FFVideoSource() and therefore code like <code>AudioDub(FFVideoSource(X), FFAudioSource(X))</code> will require two indexing passes.<br>Apart from the time consumed this is harmless. To work around it open the audio first: <code>A = FFAudioSource(X) V = FFVideoSource(X) AudioDub(V, A)</code> or use FFIndex(), like so: <code>FFIndex(X) AudioDub(FFVideoSource(X), FFAudioSource(X))</code>.
*Interlaced H.264 mostly works these days, but seeking may occasionally result in corruption.
*Transport Streams will not decode reliably without seekmode -1.
*Open-GOP H.264 will sometimes produces corruption when seeking.
<br>
== Known Issues ==
* Interlaced H.264 is decoded in an odd way; each field gets its own full-height frame and the fieldrate is reported as the framerate, and furthermore one of the fields (odd or even) may "jump around". To get the correct behavior, you can try setting <tt>fpsnum</tt> and <tt>fpsden</tt> so that the framerate is halved (may or may not work). This issue is caused by libavcodec.
<br>
== Compatibility ==

===Video===

*AVI, MKV, MP4, FLV: Frame accurate
*WMV: Frame accurate(?) but avformat seems to pick keyframes relatively far away
*OGM: Frame accurate(?)
*VOB, MPG: Seeking seems to be off by one or two frames now and then
*M2TS, TS: Seeking seems to be off a few frames here and there
*Image files: Most formats can be opened if seekmode=-1 is set, no animation support

===Audio===

Seeking should be sample-accurate with most codecs in AVI, MKV, MP4 and FLV with two notable exceptions, namely MP3 and AC3 where FFmpeg's decoders seem to be completely broken (with MP3 in particular you can feed the decoder the same encoded data three times in a row and get a different decoded result every time). Still, results should usually be "good enough" for most purposes.

Decoding linearly will almost always work correctly.
<br>
<br>
== Indexing and You ==
Before FFMS2 can open a file, it must be indexed first so that keyframe/sample positions are known and seeking is easily accomplished. This is done automatically when using <tt>FFVideoSource()</tt> or <tt>FFAudioSource()</tt>, but if you want to you can invoke the indexing yourself by calling <tt>FFIndex()</tt>, or by running <tt>ffmsindex.exe</tt>. By default the index is written to a file so it can be reused the next time you open the same file, but this behavior can be turned off if desired.

If you wonder why FFMS2 takes so long opening files, the indexing is the answer. If you want a progress report on the indexing, you can use the supplied ffmsindex.exe commandline program.
<br>
<br>
== Function Reference ==
For complete documentation see the [http://github.com/FFMS/ffms2/blob/master/doc/ffms2-avisynth.md#function-reference FFMS2 GitHub page].
{{PluginFilterTable2}}
{{PluginFilterRow|FFmpegSource|FFIndex|
Indexes a number of tracks in a given source file and writes the index file to disk, where it can be picked up and used by <tt>FFVideoSource</tt> or <tt>FFAudioSource</tt>.
|
}} 
{{PluginFilterRow|FFmpegSource|FFAudioSource|
Opens audio. Invokes indexing of all tracks if no valid index file is found, or if the requested track isn't present in the index. 
|
}}
{{PluginFilterRow|FFmpegSource|FFVideoSource|
Opens video. Will invoke indexing of all video tracks (but no audio tracks) if no valid index file is found.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
}}
{{PluginFilterRow|FFmpegSource|FFmpegSource2|
A convenience function that combines the functionality of <tt>FFVideoSource</tt> and <tt>FFAudioSource</tt>.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
}}
{{PluginFilterRow|FFmpegSource|FFMS2|
A shorter <tt>FFmpegSource2</tt> alias, this feature was added in v2.22
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
}} 
{{PluginFilterRow|FFmpegSource|FFImageSource|
A convenience alias for <tt>FFVideoSource</tt>, with the options set optimally for using it as an image reader. Disables caching and seeking for maximum compatiblity.
| [[RGB24]], [[RGB32]], [[YUY2]], [[Y8]], [[YV12]], [[YV16]], [[YV24]], [[YV411]]
}}
{{PluginFilterRow|FFmpegSource|FFSetLogLevel|
Sets the FFmpeg logging level, i.e. how much diagnostic spam it prints to STDERR.
|
}}
{{PluginFilterRow|FFmpegSource|FFGetLogLevel|
Returns the current log level, as an integer.
|
}}
{{PluginFilterRow|FFmpegSource|FFGetVersion|
Returns the FFMS2 version, as a string.
|
}}
{{PluginFilterRowNote|
'''Note''': the following functions are provided by <tt>[http://raw.githubusercontent.com/FFMS/ffms2/master/etc/FFMS2.avsi FFMS2.avsi]</tt> and are not available unless that script has been imported or autoloaded.
}}
{{PluginFilterRow|FFmpegSource|FFFormatTime|
A helper function used to format a time given in milliseconds into a h:mm:ss.ttt string. Used internally by <tt>FFInfo</tt>.
|
}}
{{PluginFilterRow|FFmpegSource|FFInfo|
A helper function similar to Avisynth's internal [[Info|Info()]] function; shows general information about the current frame.
|
}}
|}
<br>

== Exported AviSynth variables ==
All variable names are prefixed by the <tt>varprefix</tt> argument to the respective <tt>FFVideoSource</tt> or <tt>FFAudioSource</tt> call that generated them.
<br>
<br>
<code>'''FFSAR_NUM, FFSAR_DEN, FFSAR'''</code>

The playback aspect ratio specified by the container. <tt>FFSAR_NUM</tt> and <tt>FFSAR_DEN</tt> make up the rational number of the ratio; <tt>FFSAR</tt> is only provided for convenience and may not be set in case it cannot be calculated (i.e. if <tt>FFSAR_DEN</tt> is zero).
<br>
<br>

<code>'''FFCROP_LEFT, FFCROP_RIGHT, FFCROP_TOP, FFCROP_BOTTOM'''</code>

The on-playback cropping specified by the container.
<br>
<br>

<code>'''FFCOLOR_SPACE'''</code>

The colorimetry the input claims to be using. Only meaningful for YUV inputs. The source for this variable is a metadata flag that can arbitrarily be set or manipulated at will by incompetent users or buggy programs without changing the actual video content, so blindly trusting its correctness is not recommended.

The value is exported as a cryptic numerical constant that matches the values in the MPEG-2 specification. You can find the gory details in the FFMS2 API documentation, but the important ones are:

 0: RGB (usually indicates the stream isn't actually YUV, but RGB flagged as YUV)
 1: ITU-R Rec.709
 2: Unknown or unspecified
 5 and 6: ITU-R Rec.601
<br>
<code>'''FFCOLOR_RANGE'''</code>

The color range the input video claims to be using. Much like <tt>FFCOLOR_SPACE</tt>, the source for this variable is a metadata flag that can freely be set to arbitrary values, so trusting it blindly might not be a good idea.

Note that using <tt>SWScale</tt>() or the width/height/colorspace parameters to <tt>FFVideoSource</tt> may under some circumstances change the output color range.

 0: Unknown/unspecified
 1: Limited range (usually 16-235)
 2: Full range (0-255)
<br>
<code>'''FFPICT_TYPE'''</code>

The picture type of the most recently requested frame as the ASCII number of the character listed below. Use <tt>Chr</tt>() to convert it to an actual letter in AviSynth. Use <tt>after_frame=true</tt> in AviSynth's conditional scripting for proper results. Only set when <tt>rffmode=0</tt>. The FFmpeg source definition of the characters:

 I: Intra
 P: Predicted
 B: Bi-dir predicted
 S: S(GMC)-VOP MPEG4
 i: Switching Intra
 p: Switching Predicted
 b: FF_BI_TYPE (no good explanation available)
 ?: Unknown
<br>
<code>'''FFVFR_TIME'''</code>

The actual time of the source frame in milliseconds. Only set when no type of CFR conversion is being done (<tt>rffmode</tt> and <tt>fpsnum</tt> left at their defaults).
FFCHANNEL_LAYOUT

The audio channel layout of the audio stream. This is exported as a very cryptic integer that is constructed in the same way as the <tt>dwChannelMask</tt> property of the Windows <tt>WAVEFORMATEXTENSIBLE</tt> struct. If you don't know what a <tt>WAVEFORMATEXTENSIBLE</tt> is or what the <tt>dwChannelMask</tt> does, don't worry about it.
<br>
<br>
<code>'''FFVAR_PREFIX'''</code>

The variable prefix of the last called FFMS source function. Note that this is a global variable.
<br>
<br>
==C Plugin==
The C plugin supports the additional [[planar]] colorspaces in AviSynth 2.6. Also starting with <tt>r940+64</tt> it removes the Matroska demuxer too. This means that the *only* demuxer this build of FFMS2 uses is LAVF. The test this time is whether VP8 (and maybe VP9) bearing WebM files can be used correctly with the LAVF demuxer.<br>
*'''Discussion''' - [http://forum.doom9.org/showthread.php?t=127037&page=108#post1739037 Doom9 Thread]

*'''Download''' - [http://www.mediafire.com/download/pdqaqp9xnyi7n2d/ffms2_r1072c90-avs_vsp.7z FFMS2 C-plugin r1072+90]

<span style="color:red">'''Note:'''</span> C-plugins must be loaded using [[Plugins#LoadCPlugin|LoadCPlugin]].
<br>
<br>

== External Links ==
*[http://forum.doom9.org/showthread.php?t=127037 Doom9 Forum] - FFmpegSource discussion.
*[http://github.com/FFMS/ffms2 GitHub] - Source code repository.
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Source_Filters|External Filters]] &larr;'''