Elecard Video Quality Estimator functionality is available in console version, so you can run the tool from the command line.
Video Quality Estimator Command Line tool allows automatic analysis of video arrays. You can customize a sequence of commands to perform your specific tasks and automate your routine tasks.
Using this tool you'll be able to:
- Analyze the whole array of video files automatically;
- Address specific and complex challenges with a few lines of commands;
- Retrieve submitted results as a text file in CSV format for easy viewing in Excel;
- Customize a sequence of commands to perform your specific tasks;
- Accelerate and automate your regular tasks;
Table of contents
How to use Video Quality Estimator Command line tool
Get to the command prompt by clicking Start->Run and type 'cmd'. Then enter the command to start the application first and proceed with the command line options. In general, the syntax is as follows:
VQConsole.exe config.xml /in1:input.avc /out:output/input_avc /ref:ref_input.yuv
Note: you should not relocate the <product> console without all the other applications of the product contained in the installation pack, otherwise the console application will not start.
/in1:<path> | first input file path |
/in2:<path> | second input file path |
/ref:<path> | reference file path |
/out:<path> | output files prefix |
/sfx:<path> | suffix of all output files in the config |
/dc | use current run directory as default path for files |
/? | advanced help |
Back to table of contents
Sample Config.xml file:
<?xml version="1.0"?>
<VQ version="1">
<inputA file="…" stream="-1(default)" offset="0(default)"/>
<inputB file="…" stream="-1(default)" offset="0(default)"/>
<reference file="" type="IYUV(default)/[*Upsampler Type]" offset="0(default)" step="1(default)"/>
<output separator=".(default)/," delimiter=";(default)/," file="…"/>
<roi x="0" y="0" width="0" height="0" inverse="true\false"/>
<sync window="0(default)" source="AB/ARaw/BRaw"/>
<range span="all(default)/start - stop"/>
<info>
<stream distribution="on(default)/off" file="…"/>
<index distribution="on(default)/off" file="…"/>
<metrics data="All(default)|AB|ARaw|BRaw" nativeChroma="Yes(default)/No" component="All(default)|Y|U|V|A" type="PSNR(default)|APSNR|SSIM|… " file="…"/>
<data source="A|B" format="IYUV(default)/YV12" file="…"/>
<difference type="compare/subtraction/temperature/psnr/psnr clip" source="AB/ARaw/BRaw" format="IYUV(default)/YV12" file="…"/>
<message source="A|B" level="all(default)/message/warning/error" file="…"/>
</info>
</VQ>
Back to table of contents
List of commands:
<input1/> <input2/> | The tag is used to configure the input file |
| Note: if the VMAF and VMAF phone metrics are enabled, and if input raw file is missing, encoded reference file should be placed in the input 2(B) field. |
stream | Specifies the elementary video stream number, if number of streams exceeds one.
«-1» — first available elementary video stream. It is set by default. |
offset | Shifts the position from the first analyzed frame to the specified one in a stream |
<reference/> | The tag is used to configure the reference file |
type | Defines the format of the raw data. (YV12 (is set by default) / IYUV are used now. More formats to be supported in the next updates.) |
file | Sets the path to the reference file |
offset | Shifts the position from the first analyzed frame to the specified one in a reference stream. “0” is set by default |
step | Coefficient used for calculation of a successive frame number for further analysis. “1” is set by default |
<output/> | The tag is used to configure the output file |
separator | Allows selecting decimal comma or decimal dot to separate an integer part from a fractional one of a real number |
delimiter | Allows selecting comma or semicolon to specify boundaries in data stream |
file | Sets the output file path |
<roi/> | Region of interest selected for measurement |
normal | Measures the specified field of the frame |
inverse | Measures the whole frame field except the specified part |
<sync/> | Specifies the frames range for auto synchronization mode. “0” is set by default |
<range/> | The tag is used to define the range of analyzed frames |
span | Defines the range of frames (all(by defalult) /start - stop), 'start' - number of the first analyzed frame, 'stop' - number of the last analyzed frame |
<stream/> | The tag is used to output general information about the analyzed stream |
distribution | Contains information on data distribution by type of coding units (on (by default) / off) |
file | Sets the path for the output stream information |
<index/> | The tag is used to output information about frames (offset, frame type, frame size, average quantizer, etc.) |
distribution | Contains information on data distribution by type of coding units (on (by default) / off) |
file | Sets the output file path where information on frames will be saved |
<metrics/> | The tag is used to output information on quality metrics |
data | Specifies the type of the streams selected for metrics calculation and saving: All (by default) | AB | ARaw | BRaw |
type | Specifies the metric type: PSNR (by default)|APSNR|SSIM|DELTA|MSAD|MSE|VQM|NQI|VIF|VMAF|VMAF phone |
file | Sets the output file path where information on metrics will be saved |
<data/> | The tag is used to save output decoder information on any decoding step |
source | Defines the type of the source for metrics calculation: A | B | Raw |
format | Defines the format for saving data (IYUV (by default)) |
file | Sets the output file path where the data will be saved |
<difference/> | The tag is used to output information on difference metrics |
type | Defines the type of difference (compare/subtraction/temperature/psnr/psnr clip). This is the required parameter for this tag. Its default value should be set. If the value is not set, this tag will be skipped |
source | Specifies the source type for difference calculation: AB | ARaw | BRaw |
file | Sets the output file path where information on difference will be saved |
Back to table of contents