Add GSM full rate codec to LCR's source repository
[lcr.git] / libgsmfr / man / gsm_explode.3
1 .\"
2 .\" Copyright 1992 by Jutta Degener and Carsten Bormann, Technische
3 .\" Universitaet Berlin.  See the accompanying file "COPYRIGHT" for
4 .\" details.  THERE IS ABSOLUTELY NO WARRANTY FOR THIS SOFTWARE.
5 .\"
6 .PU
7 .TH GSM_EXPLODE 3 
8 .SH NAME
9 gsm_explode, gsm_implode \(em GSM\ 06.10 supplementary
10 functions for testing
11 .SH SYNOPSIS
12 #include "gsm.h"
13 .PP
14 void gsm_explode(g, frame, xframe)
15 .br
16 gsm        g;
17 .br
18 gsm_frame  frame;
19 .br
20 gsm_signal xframe[ 76 ];
21 .PP
22 void gsm_implode(g, xframe, frame)
23 .br
24 gsm        g;
25 .br
26 gsm_signal xframe[ 76 ];
27 .br
28 gsm_frame  frame;
29 .SH "DESCRIPTION"
30 Gsm is an implementation of the final draft GSM 06.10
31 standard for full-rate speech transcoding.
32 Test data for implementations of this particular document
33 can be bought and used to verify an implementation.
34 .PP
35 The encoded test data uses a format different from what
36 one would use to transmit frames with the least number
37 of bits.
38 Gsm_explode() and gsm_implode() convert between the
39 internal, small, 33-byte format and the 76-word format
40 used by the test data.
41 .PP
42 .SH "RETURN VALUE"
43 gsm_explode() returns -1 if the passed frame is invalid, else 0.
44 .SH BUGS
45 Please direct bug reports to jutta@cs.tu-berlin.de and cabo@cs.tu-berlin.de.
46 .SH "SEE ALSO"
47 gsm(3)