annotate libtest/tw5reader.h @ 552:6ab066180ec2

doc: new article FR1-Rx-DTX-detail
author Mychaela Falconia <falcon@freecalypso.org>
date Mon, 07 Oct 2024 00:25:50 +0000
parents 4d2cccaeb4a7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
820d88b97924 libtest: implement binary file reader
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 /*
522
4d2cccaeb4a7 libtest: implement TW-TS-005 reader function
Mychaela Falconia <falcon@freecalypso.org>
parents: 10
diff changeset
2 * This header file defines the interface to our reader function for
4d2cccaeb4a7 libtest: implement TW-TS-005 reader function
Mychaela Falconia <falcon@freecalypso.org>
parents: 10
diff changeset
3 * hexadecimal RTP frame sequence files in TW-TS-005 format.
10
820d88b97924 libtest: implement binary file reader
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 *
522
4d2cccaeb4a7 libtest: implement TW-TS-005 reader function
Mychaela Falconia <falcon@freecalypso.org>
parents: 10
diff changeset
5 * twts005_read_frame() return values are:
10
820d88b97924 libtest: implement binary file reader
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 * 1 = successfully read valid frame
820d88b97924 libtest: implement binary file reader
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 * 0 = normal EOF
522
4d2cccaeb4a7 libtest: implement TW-TS-005 reader function
Mychaela Falconia <falcon@freecalypso.org>
parents: 10
diff changeset
8 * -1 = read line with invalid content
4d2cccaeb4a7 libtest: implement TW-TS-005 reader function
Mychaela Falconia <falcon@freecalypso.org>
parents: 10
diff changeset
9 * -2 = line too long or missing newline
4d2cccaeb4a7 libtest: implement TW-TS-005 reader function
Mychaela Falconia <falcon@freecalypso.org>
parents: 10
diff changeset
10 *
4d2cccaeb4a7 libtest: implement TW-TS-005 reader function
Mychaela Falconia <falcon@freecalypso.org>
parents: 10
diff changeset
11 * The reader function skips blank, whitespace-only and comment lines,
4d2cccaeb4a7 libtest: implement TW-TS-005 reader function
Mychaela Falconia <falcon@freecalypso.org>
parents: 10
diff changeset
12 * returning only actual frames. lineno variable must be initialized to 0
4d2cccaeb4a7 libtest: implement TW-TS-005 reader function
Mychaela Falconia <falcon@freecalypso.org>
parents: 10
diff changeset
13 * by the application program, but not touched otherwise. In case of an
4d2cccaeb4a7 libtest: implement TW-TS-005 reader function
Mychaela Falconia <falcon@freecalypso.org>
parents: 10
diff changeset
14 * error, this variable will hold the line number at which the error was
4d2cccaeb4a7 libtest: implement TW-TS-005 reader function
Mychaela Falconia <falcon@freecalypso.org>
parents: 10
diff changeset
15 * encountered.
10
820d88b97924 libtest: implement binary file reader
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 */
820d88b97924 libtest: implement binary file reader
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17
522
4d2cccaeb4a7 libtest: implement TW-TS-005 reader function
Mychaela Falconia <falcon@freecalypso.org>
parents: 10
diff changeset
18 #define TWTS005_MAX_FRAME 40
10
820d88b97924 libtest: implement binary file reader
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19
522
4d2cccaeb4a7 libtest: implement TW-TS-005 reader function
Mychaela Falconia <falcon@freecalypso.org>
parents: 10
diff changeset
20 int twts005_read_frame(FILE *hexf, unsigned *lineno, uint8_t *frame,
4d2cccaeb4a7 libtest: implement TW-TS-005 reader function
Mychaela Falconia <falcon@freecalypso.org>
parents: 10
diff changeset
21 unsigned *lenp);