annotate trau-ul-prep/binreader.h @ 35:0979407719f0

doc/TFO-xform/HRv1: article written
author Mychaela Falconia <falcon@freecalypso.org>
date Mon, 02 Sep 2024 07:32:09 +0000
parents 4ab8762be333
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
4ab8762be333 trau-ul-prep: starting with gsmx2tsrc program
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 /*
4ab8762be333 trau-ul-prep: starting with gsmx2tsrc program
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 * This header file defines the interface to our reader function for binary
4ab8762be333 trau-ul-prep: starting with gsmx2tsrc program
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 * files recording GSM FR or EFR streams, see ../doc/Binary-file-format.
4ab8762be333 trau-ul-prep: starting with gsmx2tsrc program
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 *
4ab8762be333 trau-ul-prep: starting with gsmx2tsrc program
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 * binfile_read_frame() return values are:
4ab8762be333 trau-ul-prep: starting with gsmx2tsrc program
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 * 1 = successfully read valid frame
4ab8762be333 trau-ul-prep: starting with gsmx2tsrc program
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 * 0 = normal EOF
4ab8762be333 trau-ul-prep: starting with gsmx2tsrc program
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 * -1 = unrecognized header byte
4ab8762be333 trau-ul-prep: starting with gsmx2tsrc program
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 * -2 = EOF in the middle of a frame
4ab8762be333 trau-ul-prep: starting with gsmx2tsrc program
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 */
4ab8762be333 trau-ul-prep: starting with gsmx2tsrc program
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11
4ab8762be333 trau-ul-prep: starting with gsmx2tsrc program
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 #define BINFILE_MAX_FRAME 33
4ab8762be333 trau-ul-prep: starting with gsmx2tsrc program
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13
4ab8762be333 trau-ul-prep: starting with gsmx2tsrc program
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 extern int binfile_read_frame(FILE *binf, uint8_t *frame);