Vz:Doc:Configuration

From M1Research

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
Configuration file supplied with <b>VZ</b> is used for hardware dependent configuration.
Configuration file supplied with <b>VZ</b> is used for hardware dependent configuration.
-
Configuration file has <b>XML</b> format and consists of some section that describes some module behaviour:
+
Configuration file has <b>XML</b> format and consists of some section that describes some module behaviour, main sections described bellow.
 +
 
 +
===main===
 +
<pre>
 +
<module name="main">
 +
<!-- output module name -->
 +
<!-- <param name="output" value="bluefish" /> -->
 +
<param name="output" value="nullvideo" />
 +
<!-- <param name="output" value="streamalpha" />    -->
 +
 
 +
<!-- font (.ttf) files path -->
 +
<param name="font_path" value="C:\WINDOWS\Fonts" />
 +
</module>
 +
</pre>
 +
 
 +
===vzOutput===
 +
<pre>
 +
<module name="vzOutput">
 +
<!--
 +
enable to use asyncronous reading of framebuffer
 +
based on 'GL_EXT_pixel_buffer_object' GL extension
 +
-->
 +
<!-- <param name="use_offscreen_buffer" value="defined" />  -->
 +
</module>
 +
</pre>
 +
 
 +
===vzMain===
 +
<pre>
 +
<module name="vzMain">
 +
<!--  define field-based rendering mode used -->
 +
<param name="fields" value="defined" />
 +
 
 +
<!-- enable -->
 +
<param name="enable_GL_SRC_ALPHA_SATURATE" value="defined"/>
 +
</module>
 +
</pre>
 +
 
 +
===tvspec===
 +
<pre>
 +
<module name="tvspec">
 +
<!-- long TV_FRAME_DUR_MS;// frame length (time period) (ms)  -->
 +
<param name="TV_FRAME_DUR_MS" value="40"/>
 +
 
 +
<!-- long TV_FRAME_HEIGHT; // frame height (px) -->
 +
<param name="TV_FRAME_HEIGHT" value="576"/>
 +
 
 +
<!-- long TV_FRAME_WIDTH;// frame width (px) -->
 +
<param name="TV_FRAME_WIDTH" value="720"/>
 +
 
 +
<!-- long TV_FRAME_1ST; // first field in frame -->
 +
<param name="TV_FRAME_1ST" value="0"/>
 +
 
 +
<!-- long TV_FRAME_PS; // frames per seconds -->
 +
<param name="TV_FRAME_PS" value="25"/>
 +
</module>
 +
</pre>
 +
 
 +
===tcpserver===
 +
<pre>
 +
<module name="tcpserver">
 +
<param name="enable" value="defined"/>
 +
<param name="port" value="8001"/>
 +
<param name="bufsize" value="8192"/>
 +
</module>
 +
</pre>
 +
 
 +
===serserver===
 +
<pre>
 +
<!-- <module name="serserver">
 +
<param name="enable" value="defined"/>
 +
<param name="serial_port_name" value="COM1:"/>
 +
<param name="bufsize" value="8192"/>
 +
</module> -->
 +
</pre>
 +
 
 +
===streamalpha===
 +
<pre>
 +
<module name="streamalpha">
 +
<!--
 +
<param name="ColorSubcarrierPhase" value="1"/>
 +
<param name="SDEL" value="1"/>
 +
<param name="ADEL" value="1"/>
 +
 
 +
<param name="PROGRAM_GRAPHICSONLY" value="defined"/>
 +
<param name="PREVIEW_GRAPHICSONLY" value="defined"/> -->
 +
<param name="PROGRAM_OVERLAY" value="defined"/>
 +
<param name="PREVIEW_OVERLAY" value="defined"/>
 +
<param name="DMUX_OFF" value="defined"/>
 +
-->
 +
 
 +
<param name="MODE_BYPASS_OFF" value="defined"/>
 +
<param name="MEM_4444" value="defined"/>
 +
<param name="CHROMAKEY_OFF" value="defined"/>
 +
<param name="MODE_PAL" value="defined"/>
 +
<param name="MULTIPLY_ALPHA_OFF" value="defined"/>
 +
<param name="SWITCH_OUPUT_ON_PREVIEW_OFF" value="defined"/>
 +
</module>
 +
</pre>
 +
 
 +
===nullvideo===
 +
<pre>
 +
<!-- test output module for cpu/bus load -->
 +
<module name="nullvideo">
 +
<!-- <param name="YUV_CONVERT" value="defined"/> -->
 +
<!-- <param name="OUTPUT_BUF_TRANSFER" value="defined"/>-->
 +
<param name="INPUTS_COUNT" value="1"/>
 +
<!-- <param name="FIELD_MODE" value="defined"/> -->
 +
<!-- <param name="TWICE_FIELDS" value="defined"/> -->
 +
                <!-- patterns: 0-bars, 1-grid, 2-lines -->
 +
<param name="INPUT_1_PATTERN" value="2"/>
 +
<param name="INPUT_2_PATTERN" value="0"/>
 +
<param name="INPUT_3_PATTERN" value="0"/>
 +
<param name="INPUT_4_PATTERN" value="0"/>
 +
 
 +
</module>
 +
</pre>
 +
 
 +
===bluefish===
 +
<pre>
 +
<module name="bluefish">
 +
<!-- video -->
 +
<!-- <param name="KEY_INVERT" value="defined"/> -->
 +
<!-- <param name="KEY_WHITE" value="defined"/> -->
 +
<!-- <param name="SINGLE_INPUT" value="defined"/> -->
 +
<param name="DUAL_INPUT" value="defined"/>
 +
<!-- <param name="VIDEO_MODE" value="defined"/> -->
 +
<!-- <param name="PAL" value="defined"/> -->
 +
<!-- <param name="ONBOARD_KEYER" value="defined"/> -->
 +
<!-- <param name="H_PHASE_OFFSET" value="0"/> -->
 +
<!-- <param name="V_PHAZE_OFFSET" value="0"/> -->
 +
<!-- <param name="VERTICAL_FLIP" value="defined"/> -->
 +
<param name="SCALED_RGB" value="defined"/>
 +
<!-- <param name="SWAP_INPUT_CONNECTORS" value="defined"/> -->
 +
 
 +
<!-- <param name="SOFT_FIELD_MODE" value="defined"/>
 +
<param name="SOFT_TWICE_FIELDS" value="defined"/> -->
 +
 
 +
<!-- ANALOG_INPUT:
 +
0 - Composite,
 +
1 - S-Video,
 +
2 - Component -->
 +
<!-- <param name="ANALOG_INPUT" value="0"/> -->
 +
 
 +
<!-- PROGRAM_ANALOG_OUTPUT:
 +
1: Composite + s-video
 +
2: Component
 +
3: RGB
 +
4: Composite + s-video + Component
 +
5: Composite + s-video + RGB -->
 +
<!-- <param name="PROGRAM_ANALOG_OUTPUT" value="0"/> -->
 +
<!-- <param name="PROGRAM_SDI_DUPLICATE" value="defined"/> -->
 +
<!-- <param name="PROGRAM_OUTPUT_SWAP" value="defined"/> -->
 +
 
 +
<!-- audio -->
 +
<param name="AUDIO_OUTPUT_ENABLE" value="defined"/>
 +
<param name="AUDIO_OUTPUT_EMBED" value="defined"/>
 +
<param name="AUDIO_INPUT_ENABLE" value="defined"/>
 +
<param name="AUDIO_INPUT_EMBED" value="defined"/>
 +
<!-- AUDIO_INPUT_SIGNAL
 +
0: AES
 +
1: Analouge
 +
2: SDI A
 +
3: SDI B -->
 +
<!-- <param name="AUDIO_INPUT_SIGNAL" value="0"/> -->
 +
</module>
 +
</pre>

Revision as of 18:49, 24 March 2007

Configuration file supplied with VZ is used for hardware dependent configuration.

Configuration file has XML format and consists of some section that describes some module behaviour, main sections described bellow.

Contents

main

	<module name="main">
		<!-- output module name -->
<!--		<param name="output" value="bluefish" /> -->
		<param name="output" value="nullvideo" />
<!--		<param name="output" value="streamalpha" />    --> 

		<!-- font (.ttf) files path -->
		<param name="font_path" value="C:\WINDOWS\Fonts" />
	</module>

vzOutput

	<module name="vzOutput">
		<!--
			enable to use asyncronous reading of framebuffer
			based on 'GL_EXT_pixel_buffer_object' GL extension
		-->
<!--		<param name="use_offscreen_buffer" value="defined" />  -->
	</module>

vzMain

	<module name="vzMain">
		<!--  define field-based rendering mode used -->
		<param name="fields" value="defined" /> 

		<!-- enable -->
		<param name="enable_GL_SRC_ALPHA_SATURATE" value="defined"/>
	</module>

tvspec

	<module name="tvspec">
		<!-- long TV_FRAME_DUR_MS;// frame length (time period) (ms)  -->
		<param name="TV_FRAME_DUR_MS" value="40"/>

		<!-- long TV_FRAME_HEIGHT;	// frame height (px) -->
		<param name="TV_FRAME_HEIGHT" value="576"/>

		<!-- long TV_FRAME_WIDTH;// frame width (px) -->
		<param name="TV_FRAME_WIDTH" value="720"/>

		<!-- long TV_FRAME_1ST;	// first field in frame -->
		<param name="TV_FRAME_1ST" value="0"/>

		<!-- long TV_FRAME_PS;	// frames per seconds -->
		<param name="TV_FRAME_PS" value="25"/>
	</module>

tcpserver

	<module name="tcpserver">
		<param name="enable" value="defined"/>
		<param name="port" value="8001"/>
		<param name="bufsize" value="8192"/>
	</module>

serserver

<!--	<module name="serserver">
		<param name="enable" value="defined"/>
		<param name="serial_port_name" value="COM1:"/>
		<param name="bufsize" value="8192"/>
	</module> -->

streamalpha

	<module name="streamalpha">
<!--
		<param name="ColorSubcarrierPhase" value="1"/>
		<param name="SDEL" value="1"/>
		<param name="ADEL" value="1"/>

		<param name="PROGRAM_GRAPHICSONLY" value="defined"/>
		<param name="PREVIEW_GRAPHICSONLY" value="defined"/> -->
		<param name="PROGRAM_OVERLAY" value="defined"/>
		<param name="PREVIEW_OVERLAY" value="defined"/>
		<param name="DMUX_OFF" value="defined"/>
-->

		<param name="MODE_BYPASS_OFF" value="defined"/>
		<param name="MEM_4444" value="defined"/>
		<param name="CHROMAKEY_OFF" value="defined"/>
		<param name="MODE_PAL" value="defined"/>
		<param name="MULTIPLY_ALPHA_OFF" value="defined"/>
		<param name="SWITCH_OUPUT_ON_PREVIEW_OFF" value="defined"/>
	</module>

nullvideo

	<!-- test output module for cpu/bus load -->
	<module name="nullvideo">
<!--		<param name="YUV_CONVERT" value="defined"/> -->
<!--		<param name="OUTPUT_BUF_TRANSFER" value="defined"/>-->
		<param name="INPUTS_COUNT" value="1"/>
<!--		<param name="FIELD_MODE" value="defined"/> -->
<!--		<param name="TWICE_FIELDS" value="defined"/> -->
                <!-- patterns: 0-bars, 1-grid, 2-lines -->
		<param name="INPUT_1_PATTERN" value="2"/>
		<param name="INPUT_2_PATTERN" value="0"/>
		<param name="INPUT_3_PATTERN" value="0"/>
		<param name="INPUT_4_PATTERN" value="0"/>

	</module>

bluefish

	<module name="bluefish">
		<!-- video -->
<!--		<param name="KEY_INVERT" value="defined"/> -->
<!--		<param name="KEY_WHITE" value="defined"/> -->
<!--		<param name="SINGLE_INPUT" value="defined"/> -->
		<param name="DUAL_INPUT" value="defined"/>
<!--		<param name="VIDEO_MODE" value="defined"/> -->
<!--		<param name="PAL" value="defined"/> -->
<!--		<param name="ONBOARD_KEYER" value="defined"/> -->
<!--		<param name="H_PHASE_OFFSET" value="0"/> -->
<!--		<param name="V_PHAZE_OFFSET" value="0"/> -->
<!--		<param name="VERTICAL_FLIP" value="defined"/> -->
		<param name="SCALED_RGB" value="defined"/>
<!--		<param name="SWAP_INPUT_CONNECTORS" value="defined"/> -->

<!--		<param name="SOFT_FIELD_MODE" value="defined"/>
		<param name="SOFT_TWICE_FIELDS" value="defined"/> -->

		<!-- ANALOG_INPUT: 
			0 - Composite, 
			1 - S-Video, 
			2 - Component -->
<!--		<param name="ANALOG_INPUT" value="0"/> -->

		<!-- PROGRAM_ANALOG_OUTPUT:
			1: Composite + s-video
			2: Component
			3: RGB
			4: Composite + s-video + Component
			5: Composite + s-video + RGB -->
<!--		<param name="PROGRAM_ANALOG_OUTPUT" value="0"/> -->
<!--		<param name="PROGRAM_SDI_DUPLICATE" value="defined"/> -->
<!--		<param name="PROGRAM_OUTPUT_SWAP" value="defined"/> -->

		<!-- audio -->
		<param name="AUDIO_OUTPUT_ENABLE" value="defined"/>
		<param name="AUDIO_OUTPUT_EMBED" value="defined"/>
		<param name="AUDIO_INPUT_ENABLE" value="defined"/>
		<param name="AUDIO_INPUT_EMBED" value="defined"/>
		<!-- AUDIO_INPUT_SIGNAL
			0: AES
			1: Analouge
			2: SDI A
			3: SDI B -->
<!--		<param name="AUDIO_INPUT_SIGNAL" value="0"/> -->
	</module>
Personal tools