DirectShowSource

DirectShowSource reads media files using Microsoft DirectShow, the same multimedia playback system that WMP (Windows Media Player) uses. It can read most formats that WMP can, including MP4, MP3, most MOV (QuickTime) files, as well as AVI files that AVISource doesn't support (like DV type 1, or files using DirectShow-only codecs). There is also support for GraphEdit (grf) files.

There are some caveats:

• Some decoders (notably MS MPEG-4) will produce upside-down video. You'll have to use FlipVertical.
• DirectShow video decoders are not required to support frame-accurate seeking. In most cases seeking will work, but on some it might not.
• DirectShow video decoders are not even required to tell you the frame rate of the incoming video. Most do, but the ASF decoder doesn't. You have to specify the frame rate using the fps parameter, like this: DirectShowSource("video.asf", fps=15).
• This version automatically detects the Microsoft DV codec and sets it to decode at full (instead of half) resolution. I guess this isn't a caveat. :-)
• Also this version attempts to disable any decoder based deinterlacing.

Try reading AVI files with AviSource first. For non-AVI files, try FFmpegSource or LSMASHSource. If that doesn't work then try this filter instead.

Syntax and Parameters

DirectShowSource(string filename [, float fps, bool seek, bool audio, bool video,
      bool convertfps, bool seekzero, int timeout, string pixel_type, int framecount, string logfile, int logmask ] )

string  filename =

The path of the source file; path can be omitted if the source file is in the same directory as the AviSynth script (*.avs).

float  fps = (auto)

Frames Per Second of the resulting clip. This is sometimes needed to specify the framerate. If the framerate or the number of frames is incorrect (this can happen with ASF or MOV clips), use this option to force the correct framerate. For live sources, this is like "max fps" that will be displayed.

bool  seek = true

There is full seeking support available on most file formats. If problems occur, try setting seekzero=true first. If seeking still causes problems, disable seeking completely with seek=false. With seeking disabled and trying to seek backwards, the audio stream returns silence, and the video stream returns the most recently rendered frame. Note the Avisynth cache may provide limited access to the previous few frames, but beyond that the most recently frame rendered will be returned.

bool  audio = true

Enable audio on the resulting clip. The channel ordering is the same as in the wave-format-extensible format, because the input is always decompressed to WAV. For more information, see also GetChannel. AviSynth loads 8, 16, 24 and 32 bit int PCM samples, and float PCM format, and any number of channels.

bool  video = true

Enable video on the resulting clip.

bool  convertfps = false

If true, it turns VFR (variable framerate) video into CFR (constant framerate) video by adding frames. This allows you to open VFR video in AviSynth. It is most useful when fps is set to the least common multiple of the component frame rates, e.g. 120 or 119.880.

bool  seekzero = false

If true, restrict backwards seeking only to the beginning, and seeking forwards is done the hard way (by reading all samples). Limited backwards seeking is allowed with non-indexed ASF.^{[dubious – discuss]}

int  timeout = 2000

Set time (in milliseconds) to wait when DirectShow refuses to render. When the timeout period has expired and the frame has not been rendered, AviSynth returns a blank frame and/or silence. Negative timeout values will result in an error message.^{[dubious – discuss]}

string  pixel_type = "RGB32"

Request a color format from the decompressor. Valid values are listed in the table below, plus "AUTO" and "FULL".^{[dubious – discuss]}

pixel_type="AUTO" negotiates to use all relevant official formats, YUV plus RGB.

pixel_type="FULL" includes the non-standard pixel types listed in addition to those supported by "AUTO". See DirectShowSource

pixel_type	Color formats, listed by decoding priority (high to low)
FULL	YV24	YV16	YV12	I420	NV12	YUY2	AYUV	Y41P	Y411	ARGB	RGB32	RGB24
AUTO	YV24		YV12			YUY2		Y41P			RGB32	RGB24

In other words, if pixel_type="AUTO", it will try to output YV24; if that isn't possible it tries YV16, and if that isn't possible it tries YV12, etc...

For planar color formats, adding a '+' prefix, e.g. DirectShowSource(..., pixel_type="+YV12"), tells AviSynth the video rows are DWORD aligned in memory instead of packed. This can fix skew or tearing of the decoded video when the width of the picture is not divisible by 4.

Note this documentation is a work in progress. The old documentation for this parameter follows, verbatim:

pixel_type (in v2.56): The mnemonic for the videomedia subtype negotiated for the IPin connection. It can be "YV24", "YV16", "YV12", "I420", "YUY2", "AYUV", "Y41P", "Y411", "NV12", "ARGB", "RGB32", "RGB24", "YUV", "YUVex", "RGB", "AUTO" or "FULL". By default, upstream DirectShow filters are free to bid all of their supported media types in the order of their choice. A few DirectShow filters get this wrong. The pixel_type argument limits the acceptable video stream subformats for the IPin negotiation. Note the graph builder may add a format converter to satisfy your request, so make sure the codec in use can actually decode to your chosen format. The M$ format converter is just adequate. The "YUV" and "RGB" pseudo-types restrict the negotiation to all official supported YUV or RGB formats respectively. The "YUVex" also includes YV24, YV16, I420 and NV12 non-standard pixel types. The "AUTO" pseudo-type permits the negotiation to use all relevant official formats, YUV plus RGB. The "FULL" pseudo-type includes the non-standard pixel types in addition to those supported by "AUTO". The full order of preference is YV24, YV16, YV12, I420, NV12, YUY2, AYUV, Y41P, Y411, ARGB, RGB32, RGB24. Many DirectShow filters get this wrong, which is why it is not enabled by default. The option exists so you have enough control to encourage the maximum range of filters to serve your media. (See discussion.)

The non-standard pixel types use the following GUID's respectively :-
MEDIASUBTYPE_I420 = {'024I', 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71};
MEDIASUBTYPE_YV24 = {'42VY', 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71};
MEDIASUBTYPE_YV16 = {'61VY', 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71};
MEDIASUBTYPE_NV12 = {'21VN', 0x0000, 0x0010, 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71};

int  framecount = (auto)

Sometimes needed to specify the frame count of the video. If the framerate or the number of frames is incorrect (this can happen with ASF or MOV clips), use this option to force the correct number of frames. If fps is also specified, the length of the audio stream is adjusted. For live sources, specify a very large number.

string  logfile =

Use this option to specify the name of a log file for debugging.

int  logmask = 35

When a logfile is specified, use this option to select which information is logged.

Value	Data
1	Format Negotiation
2	Receive samples
4	GetFrame/GetAudio calls
8	Directshow callbacks
16	Requests to Directshow
32	Errors
64	COM object use count
128	New objects
256	Extra info
512	Wait events

Add the values together of the data you need logged. Specify -1 to log everything.

The default, 35, logs 1+2+32, or Format Negotiation, Received samples and Errors.

Examples

Opens an AVI with the first available RGB format (without audio):

DirectShowSource("F:\TestStreams\xvid.avi",fps=25, audio=false, pixel_type="RGB")

Opens a DV clip with the default DV decoder:

DirectShowSource("F:\DVCodecs\Analysis\Ced_dv.avi") # MS-DV

Opens a variable framerate MKV as 119.88 by adding frames (ensuring sync):

DirectShowSource("F:\Guides\Hybrid\vfr_startrek.mkv", fps=119.88, convertfps=true)

Opens a realmedia *rmvb clip:

DirectShowSource("F:\test.rmvb", fps=24, convertfps=true)

Opens a GraphEdit file:

V=DirectShowSource("F:\vid_graph.grf", audio=False) # video only (audio renderer removed)
A=DirectShowSource("F:\aud_graph.grf", video=False) # audio only (video renderer removed)
AudioDub(V, A)

See below for an audio example.

Troubleshooting video and audio problems

AviSynth will by default try to open only the media it can open without any problems. If one component cannot be opened it will simply not be added to the output. This will also mean that if there is a problem, you will not see the error. To get the error message to the missing component, use audio=false or video=false and disable the component that is actually working. This way AviSynth will print out the error message of the component that doesn't work.

Renderfile, the filter graph won't talk to me

This is a common error that occurs when DirectShow isn't able to deliver any format that is readable to AviSynth. Try creating a filter graph manually and see if you are able to construct a filter graph that delivers any output AviSynth can open. If not, you might need to download additional DirectShow filters that can deliver correct material.

The picture is skewed or torn and the colors are wrong

Some DirectShow components incorrectly pad the lines of planar data to be DWORD aligned as is done for RGB24 DIB format. This is incorrect, but it is a fairly common mistake. By adding a '+' to the start of the pixel_type string you can inform DirectShowSource to treat planar data formats as padded DWORD aligned. This problem shows up when the width of the picture is not divisible by 4.

DirectShowSource("NonMod4Video.mp4", pixel_type="+YV12") # Bad DWORD aligned planar

The sample rate is wrong

Some filters might have problems reporting the right sample rate, and then correct this when the file is actually playing. Unfortunately there is no way for AviSynth to correct this once the file has been opened. Use AssumeSampleRate and set the correct sample rate to fix this problem.

My sound is choppy

Unfortunately Directshow is not required to support sample exact seeking. Open the sound another way, or demux your video file and serve it to AviSynth another way. Otherwise you can specify seekzero=true or seek=false as parameters or use the EnsureVBRMP3Sync filter to enforce linear access to the DirectShow audio stream.

My sound is out of sync

This can happen especially with WMV, apparently with variable frame rate video. Determine what the fps should be and set it explicitly, and use ConvertFPS to force it to a constant framerate. EnsureVBRMP3Sync reduces problems with variable rate audio.

DirectShowSource("video.wmv", fps=25, ConvertFPS=True)
EnsureVBRMP3Sync() 

My ASF renders start fast and finish slow

Microsoft in their infinite wisdom chose to implement ASF stream timing in the ASF demuxer. As a result it is not possible to strip ASF format files any faster than realtime. This is most apparent when you first start to process the streams, usually after opening the AviSynth script it takes you a while to configure your video editor, all this time the muxer is accumulating credit time. When you then start to process your stream it races away at maximum speed until you catch up to realtime at which point it slows down to the realtime rate of the source material. This feature makes it impossible to use AviSynth to reclock 24fps ASF material up to 25fps for direct PAL playback.

Windows7 users

Windows 7 forces its own DirectShow filters for decoding several audio and video formats. Changing their merits or physically removing those filters doesn't help. clsid made the tool "Win7DSFilterTweaker" to change the preferred filters. However new decoders need to be added each time so it's not the perfect solution.

Common tasks

This section will describe various tasks that might not be 100% obvious. :)

Opening GRF files

GraphEdit GRF files are automatically detected by a .grf filename extension and directly loaded by DirectShowSource. For AviSynth to be able to connect to it, you must leave a pin open in GraphEdit of a media types that AviSynth is able to connect to. AviSynth will not attempt to disconnect any filters, so it is important that the output type is correct. DirectShowSource only accepts YV24, YV16, YV12, YUY2, AYUV, Y41P, Y411, NV12, ARGB, RGB32 and RGB24 video formats and 32, 24, 16 and 8 bit PCM and IEEE FLOAT audio formats.

A given GRF file must only target one of an audio or video stream to avoid confusion when DirectShowSource attempts the connection to your open pin(s). This single stream restriction is enforced.

Down-mixing AC3 to stereo

There are essentially two ways to do this. The first is to set the down-mixing in the configuration of your AC3 decoder itself, and the second one is to use the external down-mixer of "Trombettworks":

1) Install AC3filter.

a) Open AC3Filter Config
On tab "Main" in section "Output format" select "2/0 - stereo".
[Nothing else is needed.]

-OR-

b) Open the AC3 file in WMP6.4 and select the file properties. Set the output of AC3Filter on 2/0 - stereo. If you want the best possible quality, select PCM Float as Sample format.

Make the following script:

v = Mpeg2Source("e:\movie.d2v")
a = DirectShowSource("e:\Temp\Test2\test.ac3")
AudioDub(v,a)

Finally, open the script in VirtualDub and convert the audio stream to MP3 (of course you can also demux the downmixed WAV stream if needed).

2) Register the directshow filter Channel Downmixer by Trombettworks (under start -> run):

regsvr32 ChannelDownmixer.ax

Open the AC3 file in WMP6.4 and select the file properties. Set the output of AC3Filter on 3/2+SW 5.1 channels (this downmixer can't handle PCM Float, thus PCM 16 bit is selected here). In the properties of the downmixer, the number of input and output channels should be detected automatically. Check whether this is indeed correct.

Make the following script:

v = Mpeg2Source("e:\movie.d2v")
a = DirectShowSource("e:\Temp\Test2\test.ac3")
AudioDub(v,a)

Finally, open the script in vdub and convert the audio stream to MP3 (of course you can also demux the downmixed WAV stream if needed).

For some reason, I ^(who?) can't get this to work with DTS streams :(

Changes

v2.60	Added pixel_types "YV24", "YV16", "I420", "NV12", "AYUV", "Y41P", "Y411".
	Add '+' to pixel_type for padded planar support.
v2.57	framecount overrides the length of the streams.
	logfile and logmask specify debug logging.
v2.56	convertfps turns vfr into constant cfr by adding frames
	seekzero restricts seeking to beginning only
	timeout controls response to recalcitrant graphs
	pixel_type specifies/restricts output video pixel format

See also

Haali media splitter also comes with an (unrelated) DirectShow input plugin DirectShowSource2, aka DSS2