source: trunk/ETSI-Testsuites/ETSI_auto_IOT/codec/README

Last change on this file was 22, checked in by rings, 14 years ago
  • Property svn:executable set to *
File size: 3.2 KB
RevLine 
[22]1***************************
2** SIP/SDP TTCN-3 codecs **
3***************************
4
5
6This directory contains the sources of the codec and the validation test
7suites.
8
9
10CoDec
11-----
12
13The CoDec itself is located in the c++ directory. The following files are
14required to build it:
15        c++/codec.h
16        c++/init.cpp
17        c++/Regex.h
18        c++/sdp_codets.cpp
19        c++/sdp_codets.h
20        c++/sip_codets.cpp
21        c++/sip_codets.h
22        c++/libcommon_codets.h
23        c++/isup_codets.cpp
24        c++/isup_codets.h
25
26c++/EchoPort.cpp and c++/EchoPort.h contain an implementation of the EchoPort
27(System Adapter) which is needed only to execute the loopback tests in the
28validation test suite.
29
30
31This CoDec is based on the T3DevKit toolkit. It can be build in two ways as it
32is documented in the user manual (Sections "Usage" & "Low level usage")
33        http://t3devkit.gforge.inria.fr/doc/userref/userrefch2.html#x3-220002.3
34        http://t3devkit.gforge.inria.fr/doc/userref/userrefch2.html#x3-230002.4
35        http://t3devkit.gforge.inria.fr/doc/userref/userrefap1.html#x9-75000A
36
37The easiest way is to use the generic makefile from T3DevKit and configure the
38T3DK_XXXXXX variables accordingly. This is the method used in the tests
39containing in this directory (simple tests, torture tests & loopback tests).
40        c++/Makefile
41        validation/TortureTests/Makefile
42        validation/LoopbackTests/Makefile
43
44In order to build another test suite, it is possible to copy one of these
45makefiles and modify the variables T3DK_TTCN_SOURCES, T3DK_CXX_SOURCES and
46T3DK_C_SOURCES to include the wanted files (TTCN-3 source files and/or
47additional C/C++ to implement the adapters for example).
48
49If the implementation of a runtime module (for example the System Adapter) is
50not based on the base implementation provided by T3DevKit, then it will be
51necessary to disable it in the makefile so that the TRI-SA functions are not
52defined twice. This can be done by assigning the value none to the T3DK_SA
53variable:
54        T3DK_SA = none
55
56
57In the case the generic makefile is not suitable to build the executable test
58suite. It is still possible to do the work manually or with an other build
59system. The complete procedure to run the codec generator, compile the test
60suite and link the right modules accordingly is described in the user manual
61from T3DevKit (Section "Low level usage").
62        http://t3devkit.gforge.inria.fr/doc/userref/userrefch2.html#x3-230002.4
63
64
65
66Validation
67----------
68
69This directory contains three validation suites. To build and launch them, it
70is necessary to use the following makefiles:
71
72        c++/Makefile            -> simple tests located in validation/
73        validation/TortureTests/Makefile
74                                -> torture test suite for validating the
75                                decoder (RFC 5118)
76        validation/LoopbackTests/Makefile
77                                -> loopback test suite for validating the
78                                encoder and the decoder
79
80The procedure to run the tests is the following:
811. chdir to the directory containing the makefile
82        cd validation/TortureTests
832. build the test suite
84        make
853. execute the test suite
86        make exec
87
88It is possible to increase the verbosity of the codec by setting some
89environment variables. This may be useful for debugging the test suite.
90
91eg:     make exec DEBUG_CODEC=1
92
93The full list of debugging switches is given in T3DevKit's user manual:
94        http://t3devkit.gforge.inria.fr/doc/userref/userrefch5.html#x7-680005.2
95
96
Note: See TracBrowser for help on using the repository browser.