libgsmfr/man/gsm_print.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_PRINT 3
   8 .SH NAME
   9 gsm_print \(em GSM\ 06.10 supplementary function for debugging
  10 .SH SYNOPSIS
  11 #include "gsm.h"
  12 #include <stdio.h>
  13
  14 int gsm_print(f, g, frame);
  15 .br
  16 FILE * f;
  17 .br
  18 gsm    g;
  19 .br
  20 gsm_frame frame;
  21 .SH "DESCRIPTION"
  22 Gsm is an implementation of the final draft GSM 06.10
  23 standard for full-rate speech transcoding, a lossy
  24 speech compression algorithm.
  25 The compressed form involves 76 variables with different numbers
  26 of significant bits packed into 33 bytes.
  27 .PP
  28 If you are interested in investigating the details of this
  29 coding scheme, gsm_print() can be used to dump the contents
  30 of individual gsm_frames to a file pointer provided by
  31 the application.
  32 .PP
  33 .SH "RETURN VALUE"
  34 gsm_print() returns -1 if the frame is invalid, else 0.
  35 .SH EXAMPLE
  36 A single frame looks like this:
  37 .br
  38 .nf
  39 LARc:   29  32  20  11  08  05  06  07
  40 #1:     Nc 0040    bc 0    Mc 1    xmaxc 60
  41         06 04 00 03 03 06 04 02 02 04 05 04 01
  42 #2:     Nc 0045    bc 1    Mc 1    xmaxc 48
  43         03 07 01 03 04 04 07 01 03 02 04 05 03
  44 #3:     Nc 0091    bc 1    Mc 1    xmaxc 46
  45         00 03 03 07 01 06 02 04 05 03 03 02 04
  46 #4:     Nc 0120    bc 0    Mc 1    xmaxc 47
  47         07 03 06 00 03 03 06 05 00 03 02 07 04
  48 .nf
  49 .SH BUGS
  50 Please direct bug reports to jutta@cs.tu-berlin.de and cabo@cs.tu-berlin.de.
  51 .SH "SEE ALSO"
  52 gsm(3), gsm_explode(3)