vsp-lib: Fix typo in comment
[renesas/vsp-tests.git] / README
1 vsp-tests
2 ---------
3
4 Test suite for the Renesas R-Car VSP1 and VSP2 video processing engines.
5
6 You can find the latest version of vsp-tests in the project's git tree at
7
8         git://git.ideasonboard.com/renesas/vsp-tests.git
9         http://git.ideasonboard.com/renesas/vsp-tests.git
10
11
12 --------
13 Building
14 --------
15
16 The vsp-tests suite requires the following tools to be installed on the host
17 to generate the test scripts, applications and data.
18
19 * gcc
20 * make
21 * python
22
23 After installing the needed packages, you can build the test suite by running
24
25         make
26
27 in the vsp-tests root directory. Then, to install the test suite, run
28
29         make install INSTALL_DIR=/path/to/target/directory
30
31 This will copy the test scripts and applications to the target directory to be
32 copied or exported to the host.
33
34
35 --------------------
36 Runtime Dependencies
37 --------------------
38
39 The tests scripts require the following tools to be installed on the target
40 system in a directory included in $PATH.
41
42 * compare (part of ImageMagick)
43 * media-ctl (part of v4l-utils, available at git://linuxtv.org/v4l-utils.git)
44 * raw2rgbpnm (available at git://git.retiisi.org.uk/~sailus/raw2rgbpnm.git)
45 * yavta (available at git://git.ideasonboard.org/yavta.git)
46
47 All but the HGO and CLU/LUT tests can be run with the latest version of these
48 tools. To test the HGO and CLU/LUT, the 'vsp' branch of 'yavta' is currently
49 needed.
50
51 The following tool is additionally required to run some of the tests. If the
52 tool is not available the corresponding tests will be skipped.
53
54 * stress (available at http://people.seas.harvard.edu/~apw/stress/)
55
56
57 -----------------
58 Running the Tests
59 -----------------
60
61 The test scripts are named vsp-unit-test-[0-9]*.sh. They can be run directly
62 from the test suite root directory.
63
64 Test options:
65
66 - VSP_KEEP_FRAMES: When the VSP_KEEP_FRAMES environment variable is set to 1,
67   all frame files will be preserved regardless of the tests results. Otherwise
68   frame files for successful tests are removed.
69