Export Automation Reference

Exporting calibrations can be a complex task, since it reflects all aspects of a system setup: outputs, multiple clients, conversions, etc. Such tasks can be automated.

Export scripts are defined in a standard XML file located under this folder C:\ProgramData\VIOSO6\SPExtCalibCommOpDef.ini

You can use arbitrary scripts from the export dialog: File > Export Mapping then check the box "use settings from file"

Below you can find the dictionary of the scripting language and file examples:

Dictionary

Tag and attribute names and values are case-sensitive! You may specify a file version (currently it's 1.0), we do not expect any changes in future.

CalibCommerceTask

There is one root object:

attribute

parameters

description

version

Typ

the type of task, set to export

5.0

Format

vwf

standard format, one file contains all data

5.0

vwf separated

separate file for every display, mapping file and blend-bitmap for each projector

5.0

x-file

DirectX compatible mesh file. Uses a viewport of -8,8 horizontally. Vertically multiply by screen aspect. Example a 16:10 screen gets -5,5 vertical viewport.

5.0

openwarp

Text file containing u-v coordinates; import to OpenWarp calibrator

5.0

mips

xml and blend bitmap, use only for testing; use TransferTask instead

5.0

MPCDI

exports a VESA MPCDI v2 conform warp file

5.0

SGC

exports to Sciss’ Uniview warp mesh

5.0

Grid based exports (x-file, openwarp, mips and MPCDI) use SpecialParam:

SpecialParam

description

version

qGridDimX

horizontal grid dimension

5.0

qGridDimY

vertical grid dimension

5.0

In case CommonParam:bVirtualContentRect is used:

SpecialParam

description

version

vParam0_X

width of virtual content

5.0

vParam0_Y

height of virtual content

5.0

Sub tags

CommonParam
SpecialParam
Task
TransferTask

CommonParam

Sets options in context of export and conversion operations. These are Boolean Attributes, set to nonzero to switch on and 0 to switch off. If an attribute is omitted, default is used.

Attribute

default value

description

version

bSilent

needs to be 1, as we are operating without GUI

5.0

bNoVC

do not apply warping grid, this is like having a full-screened VC

5.0

bNoGeomCorr

no geometric correction is applied

5.0

bNoMask

no masks are applied

5.0

bSeparatedSplitDisp

keep splits as separate mapping; if not set, spitted displays get stitched to a mapping in desktop monitor size

5.0

bAllToMaster

if set and a Super Compound is exported, all mappings from participating clients are copied to the master and processed there

5.0

bBlankUnusedSplitDispParts

if set: splitted parts are masked to black; if unset: parts are filled uniformly to appear unwarped not used if bSeparatedSplitDisp is set

5.0

bExactFileName

if set, the export file name does not get decorated by the current Display Compound name Note: if set and there are more than one Display Compound exported, the latter will overwrite the former files!

5.0

bUse3D

exports 3D mapping instead of a distortion map Note: this is only intended for dynamic eye warping and an already converted mapping (fisheye to pano/cylinder, flat screen or custom content space) is required

5.0

bVirtualContentRect

scales mapping coordinates to a virtual content rect, based on the scan. It calculates an optimal content size and based on this rects, to fill one channel. An extra .def file is written, containing the total virtual content size and all display channel’s rects. To preset content size use SpecialParam:vParam0_X and _Y. To preset region offset or size, you must use a TransferTask. Use attibutes vCntOffsetX and Y and vCntSizeX and Y.

5.0

bNiceFrustum

does a nice AutoFrustum, it widenes FoV by 1° and rounds up to next full degree

5.0

bSymmetricFrustum

causes the AutoFrustum to be symmetric, that means upper and lower as well as right and left FoV are the same angle. This is useful, if the IG does not support asymmetric frustum and just provides FoVX and FoVY.

5.0

blendFormat

applies to MPCDI and PULSE export. Set to number:

0 - RGB8
1 - RGB16
2 - Grey8
3 - Grey16

Use Grey formats for UnrealEngine nDisplay

5.1

FileName

needs to be set if bExactFileName is used. Specify the export file name in export folder or path

bMergeRemote

all clients (remote and local) will be merged to one export file

6.0

bMPCDIForward

MPCDI export will use forward manner (the destination position for each content pixel) instead of reverse (source content position for each display pixel)

6.0

bMPCDITopDown

flips the mapping along vertical axis. v'=1-v

6.0

bMPCDIRotate

prerotate mapping to display rotation

6.0.2

bUseDisplaySize

uses display size as region size. This will lower the effective resolution of the content, as it gets scaled down to make the biggest region fit, thus smaller regions get unused data. If not set, each region gets its individual optimal size depending on the set or calculated content size.

6.0

bNoBlacklevel

no blacklevel uplift correction is applied, the texture is not written to the export file. Use this for compatibility with old vwf and VIOSOWarpBlend implementations.

5.3

SpecialParam

Set input parameter in context of an export or a conversion operation.

Attribute

default value

description

version

vParam0_X vParam0_Y vParam0_Z vParam0_W

IEEE float 4-Vector

5.0

vParam1_X vParam1_Y vParam1_Z vParam1_W

IEEE float 4-Vector

5.0

vEyePoint_X vEyePoint_Y vEyePoint_Z

an eye point (IEEE float) in 3D

5.0

customCntSpaceName

name of a frustum or model definition defining a view port or texture space

5.0

baseCntSpaceName

name of a frustum defining a straight ahead view

5.0

templateFileName

filename of a template to export a frustum with

5.0

qGridDimX

export grid dimension, horizontally

5.0

qGridDimY

export grid dimension, vertically

5.0

fGammaCorr

exponent each blend value is raised to. Defaults to 0 which does no change and is internally changed to 1. Required if the graphic pipeline of the client application has set gamma adjustment. Set to a value greater than 1, if blend regions are too bright or to a value less than 1, if blend regions appear too dark. If you know the set gamma value use same for correction.

5.0

Task

Describes a computing operation on the current data

Attribute

value

description

version

Typ

convert

type of the task, converts a mapping

5.0

Format

custom content space conversion

converts to a model’s texture coordinate space, creates 3D mapping

use SpecialParam:customCntSpaceName to specify a model

5.0

observer conversion

converts a 3D mapping to a frustum

use SpecialParam:customCntSpaceName to specify the frustum
set SpecialParam:customCntSpaceName to * to use the display names like created on AutoFrustum. This enables to convert multiple displays or compounds at once using appropriate frustums
set offset and scale for the source content
- vParam0_X to specify horizontal scale, this is 1
- vParam0_Y to specify horizontal offset, this is 0
- vParam0_Z to specify vertical scale, this is 1
- vParam0_W to specify vertical offset, this is 0

Other values for scale and offset are only used, if there is a splitted windows display used as a single export. Then x=1/number of horiziontal displays, z=1/number of vertical displays, y=hIndex*1/number of horizontal displays.

Example for a 2x2 split (i.e. Mosaic/Eyefinity, Datapath x4, etc):
- left-top: (hIndex=0,vIndex=0): x=0.5, y=0, z=0.5, w=0
- left-bottom (hIndex=0,vIndex=1): x=0.5, y=0, z=0.5, w=0.5
- right-top: (hIndex=1,vIndex=0): x=0.5, y=0.5, z=0.5, w=0
- right-bottom: (hIndex=1,vIndex=1): x=0.5, y=0.5, z=0.5,w=0.5
Example of a 3x1 split (i.e. Mosaic/Eyefinit, Matrox triple-head-2go, etc.):
- left: (hIndex=0): x=0.3333333, y=0, z=1, w=0
- center: (hIndex=0): x=0.3333333, y=0.333333333, z=1, w=0
- right: (hIndex=0): x=0.3333333, y=0.666666666, z=1, w=0

5.0

pseudo 3D plane

creates a 3D mapping from a normal camera scan

- uses SpecialParam; "bend" = the distance between curve and chord
  - vParam0_X to specify width
  - vParam0_Y to specify horizontal bend
  - vParam0_Z to specify height
  - vParam0_W to specify vertical bend

5.0

pseudo 3D cylinder

creates a 360° panorama from a fisheye camera scan, creates 3D mapping

use SpecialParam:vParam1_X to specify cylinder radius

5.0

pseudo 3D sphere

creates 3D mapping of fisheye camera scan

use SpecialParam:
- vParam1_X to specify sphere radius
- vParam0_Z to specify v-mapping start angle defaults to 0, which is the Equator, thus makes a hemisphere. Giving a positive angle, up to 90°, makes the sphere more shallow, giving a negative angle, down to -90°, makes it more total sphere

5.0

pseudo 3D equirectangular

creates 3D mapping of fisheye camera scan

use SpecialParam:
- vParam1_X to specify sphere radius
- vParam0_Z to specify v-mapping start angle defaults to 0, which is the Equator, thus makes a hemisphere. Giving a positive angle, up to 90°, makes the sphere more shallow, giving a negative angle, down to -90°, makes it more total sphere
- the image content space is transformed to sample from a panoramic image in equirectangular format

5.0

auto frustum

creates a frustum from 3D data of each display, named after the display

uses CommonParam:
- bUse3D enables automatic frustum export
- Filename specifies a filename the frustum will be exported to, if not set the filename set for exporting the mapping is used
uses SpecialParam:
- vEyePoint specifies an eye for that frustum
- templateFileName specifies a template to export
- baseCntSpaceName specifies the main view (straight ahead)

5.0

apply vc

the VC is applied to the 2D mapping. Use before a conversion to effect positions, use after to warp and mask

uses CommonParam:FimeName to specify a VC file

5.0

Device

a device (display or camera) name. This task is only applied to mappings coming from a device with that name

5.0

Core

a core IP address or (computer’s network) name. This task is only applied to mappings coming from a client with that IP or name

5.0

Sub tags, see Format attribute for exact usage:

CommonParam
SpecialParam

TransferTask

Used to transfer a mapping or part of a mapping to a device or file. Note:

Always use Format=”vwf” in CalibCommerceTask to gather all data
You need the attribute bUse3D, if you do the conversion creating the 3D mapping in an export definition file

Attribute

default value

description

since version

Format

export format, see CalibCommerceTask:Format

5.0

Device

a device (display) name. This task is only applied to mappings referring to a device with that name.

5.0

Core

a core IP address or (computer’s network) name. This task is only applied to mappings referring to a client with that IP or name

5.0

bUse3D

use 3D mapping, if just created by a conversion

5.0

vCntOffsetX

horizontal pixel offset of input content to virtual content. Make sure to specify virtual content size in <task><SpecialParam>

5.0

vCntOffsetY

vertical pixel offset of input content to virtual content. Make sure to specify virtual content size in <task><SpecialParam>

5.0

vCntSizeX

width of input content. Keep 0 to use projector width

5.4

vCntSizeY

height of input content. Keep 0 to use projector height

5.4

customCntSpaceName

name of a frustum embedded in export file

5.0

baseCntSpaceName

name of a frustum giving the straight ahead view for relative angles of the exported view

5.0

Sub tags:

Destination: describes a device or file to write the mapping to
- Attributes:
  - Core: a client/device IP address or computer name to send the data to. This is a PC running SPCalibrator/Anyblend or a warping device
  - FileName: a path, to write the mapping to, on the destination machine

Examples

3D vwf Export with custom content space conversion

<VIOSO>
<File version="1.0.0" /
<CalibCommerceTask Typ="export" Format="vwf" >
<CommonParam bUse3D="1" bSilent="0" bNoVC="0" bNoGeomCorr="0" bNoBlending="0" bNoMask="0" bSeparatedSplitDisp="1" bAllToMaster="1" bBlankUnusedSplitDispParts="0" bExactFileName="0"
FileName="vioso_local.vwf" />
<SpecialParam qGridDimX="21" qGridDimY="21" />
<Task Typ="convert" Format="custom content space conversion" >
<SpecialParam customCntSpaceName="Cylinder2x1" />
</Task>
<!-- transfer to clients -->
<TransferTask Format="vwf" Core="192.168.1.31" bUse3D="1" >
<Destination Core="192.168.1.31" FileName="C:\VIOSO\channel.vwf" />
</TransferTask>
<TransferTask Format="vwf" Core="192.168.1.32" bUse3D="1" >
<Destination Core="192.168.1.32" FileName="C:\VIOSO\channel2.vwf" />
</TransferTask>
<TransferTask Format="vwf" Core="192.168.1.33" bUse3D="1" >
<Destination Core="192.168.1.33" FileName="C:\VIOSO\channel3.vwf" />
</TransferTask>
</CalibCommerceTask>
</VIOSO>

2D vwf Export with a pseudo 3D sphere conversion

<?xml version="1.0"?>
<VIOSO>
  <File version="1.0.0" />
  <CalibCommerceTask Typ="export" Format="vwf">
    <CommonParam bSilent="1" bNoVC="0" bNoGeomCorr="0" bNoBlending="0" bNoMask="0" bSeparatedSplitDisp="0" bAllToMaster="1" bBlankUnusedSplitDispParts="1" bExactFileName="1" bUse3D="0" />
    <Task Typ="convert" Format="pseudo 3D sphere" >
      <SpecialParam vParam1_X="1000.0"/>
    </Task>
    <TransferTask Format="vwf " Core="192.168.100.5" >
      <Destination Core="192.168.100.5" FileName="D:\Export\EXPORT_Client.vwf" />
    </TransferTask>
  </CalibCommerceTask>
</VIOSO>

MPCDI Export for Unreal Engine

<?xml version="1.0"?> 
<VIOSO>
<CalibCommerceTask Typ="export" Format="MPCDI" >
<CommonParam blendFormat="3" bUse3D="1" bSilent="0" bSeparatedSplitDisp="1" bAllToMaster="1" bBlankUnusedSplitDispParts="0" bExactFileName="0"
FileName="D:\UE_ndisplay\f1_auto" />
<SpecialParam qGridDimX="2000" qGridDimY="2000" />
</CalibCommerceTask>
</VIOSO>

PreviousRemote Control Reference NextScripting for VIOSO applications

Last updated 3 months ago