ARToolkitModule Video Configuration

This page describes various configuration parameters for the ARToolkit module embedded in OpenTracker. These configuration strings need to be specified in the videomode and videomode2 attributes of the ARToolKitModule configuration element.

Windows DirectShow driver

parameter format is either NULL or a list of tokens, separated by commas ","

Binary Tokens

• flipH flip image horizontally (WARNING: non-optimal performance)
• flipV flip image vertically (WARNING: non-optimal performance)
• showDlg displays either WDM capture filter's property page or MSDV decoder format dialog (depending on source media type). only applies to WDM_CAP, will be ignored for AVI_FILE
• loopAVI continuously loops through an AVI file (applies only to AVI_FILE)
• noClock does not use a Reference Clock to synchronize samples; use this flag for offline post-processing (applies only to AVI_FILE)
• renderSec render secondary streams (applies only to AVI_FILE) An AVI file can contain an arbitrary number of multiplexed A/V substreams, usually there are at most 2 substreams (1st: video, 2nd: audio). the AVI_FILE input module will only try to render stream 0x00 (assuming that it's video) and ignore the remaning substreams. Use this flag to force IGraphBuilder->Render(IPin*) calls on substreams 1..n DO NOT SET this flag if your AVI file contains more than one video stream

Parametrized Tokens

• inputDevice=? supported parameters:
  "WDM_CAP" (WDM_VIDEO_CAPTURE_FILTER) use the DirectShow WDM wrapper to obtain live video input from a streaming capture device such as a IEEE 1394 DV camera or USB webcam.
  OPTIONAL: set deviceName=? and/or ieee1394id=? for better control over the choice of suitable WDM drivers "AVI_FILE" (ASYNC_FILE_INPUT_FILTER) use an Asynchronous File Input Filter to read & decode AVI video data
  NOTE: be sure to specify the input file name by pointing fileName=? to a valid AVI file.
  EXAMPLE: "inputDevive=WDM_CAP", or "inputDevice=AVI_FILE"
  DEFAULT: "WDM_CAP" will be selected if you omit this token

• videoWidth=? preferred video width, EXAMPLE: "videoWidth=720" only applies to WDM_CAP, will be ignored for AVI_FILE
• videoHeight=? preferred video height, EXAMPLE: "videoHeight=576" only applies to WDM_CAP, will be ignored for AVI_FILE

• pixelFormat=? internal pixel format (see PixelFormat.h for supported types)
  PERFORMANCE WARNING: Be sure to match your IDirect3DTexture/OpenGL texture formats to whatever you specify here, i.e. use PXtoOpenGL(format), PXtoD3D(format) for creating your textures! (see PixelFormat.h for details)
  EXAMPLE: "pixelFormat=PIXELFORMAT_RGB32"
  NOTE: if you omit the pixelFormat=? token, the global constant (default_PIXELFORMAT, usually PIXELFORMAT_RGB32) will be selected.

• friendlyName=? only applies to WDM_CAP, will be IGNORED if "inputDevice=WDM_CAP" is not set.) preferred WDM device (WARNING: WDM "friendly names" are locale-dependent), i.e. try to match substring <?> with the "friendly names" of enumerated DirectShow WDM wrappers (ksproxy.ax). WILL BE IGNORED IF deviceName=? IS SET. EXAMPLE: "deviceName=Microsoft DV Camera" for IEEE1394 DV devices "deviceName=QuickCam" for Logitech QuickCam.

• deviceName=? only applies to WDM_CAP, will be IGNORED if "inputDevice=WDM_CAP" is not set.) preferred WDM device, i.e. try to match substring <?> with the "device names" of enumerated DirectShow WDM wrappers (ksproxy.ax). Device names look like: "@device:*:{860BB310-5D01-11d0-BD3B-00A0C911CE86}" Use GraphEdit to figure out your camera's device name. deviceName=? WILL ALWAYS WILL OVERRIDE friendlyName=? EXAMPLE: "1394#unibrain&fire-i_1.2#4510000061431408"

• fileName=? only applies to AVI_FILE, will be IGNORED if "inputDevice=AVI_FILE" is not set. input file name, if just use a file's name (without its full path), the WIN32 API fuction SearchPath() (Winbase.h) will be used to locate the file.
  EXAMPLE: "fileName=C:\Some Directory\Another Directory\Video.AVI"
  "fileName=video.AVI" (will succeed if C: Directory Directory\ is: * the application's startup directory * the current directory * listed in the PATH environment variable)

• ieee1394id=? only applies to WDM_CAP, will be IGNORED if "inputDevice=WDM_CAP" is not set. Unique 64-bit device identifier, as defined by IEEE 1394. Hexadecimal value expected, i.e. "ieee1394id=437d3b0201460008" Use /bin/IEEE394_id.exe to determine your camera's ID.

• deinterlaceEvent=? supported parameters (see VFX_STATE_names[])
  "off" : disable deinterlacing (DEFAULT)
  "on" : force deinterlacing (even for progressive frames)
  "auto" : enable deinterlacing only if (VIDEOINFOHEADER.dwInterlaceFlags & AMINTERLACE_IsInterlaced)
  WARNING: EXPERIMENTAL FEATURE!

• deinterlaceMethod=? deinterlacing method (see VFxDeinterlaceParam.h for supported modes) supported parameters (see DEINTERLACE_METHOD_names[]):
  "blend" : blend fields (best quality)
  "duplicate1" : duplicate first field
  "duplicate2" : duplicate second field
  NOTE: omitting this token results in default mode (DEINTERLACE_BLEND) being used.
  WARNING: EXPERIMENTAL FEATURE!

Examples

   videomode="inputDevice=WDM_CAP,showDlg"
   videomode="flipH,flipV,showDlg"
   videomode="pixelFormat=PIXELFORMAT_RGB24,showDlg"
   videomode="showDlg,deinterlaceEvent=on,deinterlaceMethod=duplicate1"
   videomode="videoWidth=640,flipH,videoHeight=480,showDlg,deinterlaceEvent=auto"
   videomode="inputDevice=WDM_CAP,friendlyName=Microsoft DV Camera,videoWidth=720,videoHeight=480"
   videomode="inputDevice=WDM_CAP,friendlyName=Logitech,videoWidth=320,videoHeight=240,flipV"
   videomode="inputDevice=WDM_CAP,frendlyName=Microsoft DV Camera,ieee1394id=437d3b0201460008"
   videomode="inputDevive=WDM_CAP,deviceName=1394#unibrain&fire-i_1.2#4510000061431408"
   videomode="inputDevice=AVI_FILE,fileName=C:\Some Directory\Another Directory\Video.AVI"
   videomode="inputDevice=AVI_FILE,fileName=Video.AVI,pixelFormat=PIXELFORMAT_RGB24"

---