Terms and Definitions
Terms and Definitions
Terms and definitions
For the purposes of this document, the following terms and definitions apply. DIN and DKE maintain terminological databases for use in standardization at the following addresses:
- DIN-TERMinologieportal: available at https://www.din.de/go/din-term
- DKE-IEV: available at http://www.dke.de/DKE-IEV
My Virtual Rig, MVR
descriptive name of the specification
protocol to share MVR files over the network
application that participates in the MVR-xchange
group of MVR-xchange clients that work on the same project and communicate together
MVR-xchange communication via TCP packages and discovery via mDNS
MVR-xchange communication via WebSockets and discovery via DNS
MVR consists of two parts to enable any application to exchange GDTF but also general information in the same common format. Firstly the MVR file format as described in the following section. Secondly a MVR communication format to simplify exchange between applications.
File Format Definition
To describe all information within one file, a zip file according to PKWARE 6.3.3 with the extension
*.mvr is used. The archive shall contain one root file named
GeneralSceneDescription.xml, along with all other resource files referenced via this Root File. The root file
GeneralSceneDescription.xml is mandatory inside the archive to be a valid MVR file.
UTF-8 according to RFC3629 has to be used to encode the XML file. Each XML file internally consists of XML nodes. Each XML node could have XML attributes and XML node children. Each XML attribute has a value. If a XML attribute is not specified, the default value of this XML attribute will be used. If the XML attribute value is specified as a string, the format of the string will depend on the XML attribute type.
- The archive shall not use encryption or password protection.
- All files referenced by the Root File shall be placed at the root level. They shall not be placed in folders.
- Files shall be placed using either STORE (uncompressed) or DEFLATE compression. No other compression algorithms are supported.
- Files may be placed into the archive in any order.
Universal.gdttGDTF template file with a
.gdttextension can be added to define Gobos, Emitters, Filter and such for referencing.
- Filenames within the archive must not differ only by case. Eg it is prohibited to have the files
geo1.glbwithin the same archive.
- The file name of the ZIP archive can be chosen freely.
All objects used have a persistent unique ID to track changes between the different applications. If there are no changes to the original GDTF file it is mandatory to keep it in the MVR during export. If there are changes to the GDTF file it is mandatory to add a revision to the GDTF file in order to reflect it.
Only user-intended modifications of any part of the MVR file shall be processed. This is particular important if applications in the workflow do not need or accept all data of the MVR file. Such behaviour guarantees that all later steps in the workflow have access to the original intended data.
- EXAMPLE An example of a typical MVR archive is shown below:
GeneralSceneDescription.xml Custom@Fixture1.gdtf Custom@Fixture2.gdtf geo1.3ds geo1.glb Textr12.png Universal.gdtt