g727demo.c

Reference Implementation of G.711 standard and other voice codecs

/*                                                          21.Mar.2000  V1.10
  ============================================================================

  G727DEMO.C
  ~~~~~~~~~~

  Description:
  ~~~~~~~~~~~~

  Demonstration program for UGST/ITU-T G.727 module. Takes the input
  file and processes by the G.727 codec, depending on user's option: 
  for encoding, input must be in either A or mu law (G711), for 
  decoding, in (embedded) ADPCM format.

  Input data is supposed to be aligned at word boundaries, i.e.,
  organized in 16-bit words, following the operating system normal
  organization (low-byte first for VMS and DOS; high byte first for
  most Unix systems). G711 compressed data is supposed to be in the 8
  LEAST significant bits of the word and the ADPCM data is in the
  LEAST 5 bits. Both are without sign extension.

  Output data will be generated in the same format as decribed
  above for the input data.

  Usage:
  ~~~~~~
  $ G727demo [-options] InpFile OutFile 
             [BlockSize [1stBlock [NoOfBlocks [Law [Nc [Ne]]]]]]
  where:
  InpFile     file to be processed;
  OutFile     output file with the processed data;
  BlockSize   block size, in number of samples [default: 256]
  1stBlock    first block of the input file to be processed [dft: 1]
  NoOfBlocks  number of blocks to process starting at "1stBlock" [dft: all]
  Law         is the law desired: A, u or l(linear) [default: A]
  Nc          number of core bits to be used [default: 4]
  Ne          number of enhancement bits to be used [default: 0]

  Options:
  -enc ...... Encode-only operation [default: encode & decode]
  -dec ...... Decode-only operation [default: encode & decode]
  -e_d ...... Encode and decode operation [the default]
  -law l .... Law to use: A, u, l(inear) [default: A-law]
  -core # ... Number of core bits in sample (2, 3, 4, 5) [dft: 4]
  -enh # .... Number of enhancement bits (0, 1, 2, 3) [dft: 0]
  -blk # .... Number of samples per processing block [def: 256]
  -frame # .. same as block size
  -start # ..  starting block to measure [default: first]
  -n # ......  number of blocks to be measured [default: all]
  -end # ....  last block to be measured [default: last]
  -q ........ Quiet operation (don't print progress flag)
  -?/-help .. Display program usage
        
  Original authors:
  ~~~~~~~~~~~~~~~~~
  Nikolai L. Birioukov
  Maxim A. Lagerev
  Ukrainian Research Institut of Telecommunications
  P.O. 252650                          Phone : [phone]
  13, Solomenskaya St.                 FAX   : [phone]
  Kiev, Ukraine                        EMail : [e-mail]

  Adapted to UGST style:
  ~~~~~~~~~~~~~~~~~~~~~~
  Simao Ferraz de Campos Neto
  Comsat Laboratories                  Tel:    [phone]
  22300 Comsat Drive                   Fax:    [phone]
  Clarksburg MD 20871 - USA            E-mail: [e-mail]

  History:
  ~~~~~~~~
  10.Jul.1996  0.99  C code version released to UGST <[e-mail]>
  10.Mar.1997  1.00  Conversion to UGST format <[e-mail]>
  04.Aug.1997  1.01  Eliminated compilation warning about unused variables
                     as per revision from <[e-mail]>
  21.Mar.2000  1.10  changed memory allocation of short buffers
                     inp_buf[], out_buf[] and tmp_buf[] from static to
                     dynamic, to prevent memory invasion when block
                     sizes larger than 256 are specified. 
		     <[e-mail]>

  ============================================================================
*/

/* ..... General definitions for UGST demo programs ..... */
#include "ugstdemo.h"

/* ..... General include ..... */
#include <stdio.h>
#include <stdlib.h>
#include <string.h> /* For strcmp(), strstr() */
#include <ctype.h>
#include <assert.h>

#if defined(VMS)
#include <stat.h>
#else				/* Unix/DOS */
#include <sys/stat.h>
#endif


/* ..... G.727 module as include functions ..... */
#include "g727.h"
#include "../g711/g711.h"


/* Global variables */
FILE *in, *out;

/* Local function prototypes */
#ifdef ORIGINAL_IO
int getWord(int wordLen);
void putWord(unsigned char word, int wordLen);
#endif


/*
  --------------------------------------------------------------------------
  display_usage()

  Shows program usage.

  History:
  ~~~~~~~~
  10/Mar/1997  v1.0 Created <simao>
  --------------------------------------------------------------------------
*/
#define P(x) printf x
void display_usage()
{
  P(("G727DEMO.C Version %.2f of 10/Mar/1997 \n\n", G727_H/100.0));
 
  P(("  Demonstration program for UGST/ITU-T G.727 embedded ADPCM codec.\n"));
  P(("  Files must be in linear, A- or mu-law (G711), or in ADPCM format.\n"));
  P(("  Input data is supposed to be aligned at word boundaries, i.e.,\n"));
  P(("  organized in 16-bit words. G711 data is supposed to be in the\n"));
  P(("  8 LEAST significant bits of the word and the ADPCM data is in the\n"));
  P(("  LEAST 5 bits. Both are without sign extension. Linear is 16-bit\n"));
  P(("  linear PCM. Output data format will be as decribed above\n"));
  P(("\n"));
  P(("  Usage:\n"));
  P(("  $ G727demo [-options] InpFile OutFile \n"));
  P(("             [BlockSize [1stBlock [NoOfBlocks [Law [Nc [Ne]]]]]]\n"));
  P(("  where:\n"));
  P(("  InpFile     file to be processed;\n"));
  P(("  OutFile     output file with the processed data;\n"));
  P(("  BlockSize   block size, in number of samples [default: 256]\n"));
  P(("  1stBlock    first block of the input file to be processed [dft: 1]\n"));
  P(("  NoOfBlocks  number of blocks to process starting at \"1stBlock\" [dft: all]\n"));
  P(("  Law         is the law desired: A, u or l(linear) [default: A]\n"));
  P(("  Nc          number of core bits to be used [default: 4]\n"));
  P(("  Ne          number of enhancement bits to be used [default: 0]\n"));
  P(("\n"));
  P(("  Options:\n"));
  P(("  -enc ...... Encode-only operation [default: encode & decode]\n"));
  P(("  -dec ...... Decode-only operation [default: encode & decode]\n"));
  P(("  -e_d ...... Encode and decode operation [the default]\n"));
  P(("  -law l .... Law to use: A, u, l(inear) [default: A-law]\n"));
  P(("  -core # ... Number of core bits in sample (2, 3, 4, 5) [dft: 4]\n"));
  P(("  -enh # .... Number of enhancement bits (0, 1, 2, 3) [dft: 0]\n"));
  P(("  -blk # .... Number of samples per processing block [def: 256]\n"));
  P(("  -frame # .. same as block size\n"));
  P(("  -start # ..  starting block to measure [default: first]\n"));
  P(("  -n # ......  number of blocks to be measured [default: all]\n"));
  P(("  -end # ....  last block to be measured [default: last]\n"));
  P(("  -q ........ Quiet operation (don't print progress flag)\n"));
  P(("  -?/-help .. Display program usage\n"));

  /* Quit program */
  exit(-128);
}
#undef P
/* .................... End of display_usage() ........................... */


/*
   **************************************************************************
   ***                                                                    ***
   ***        Demo-Program for testing the correct implementation         ***
   ***               and to show how to use the programs                  ***
   ***                                                                    ***
   **************************************************************************
*/
int main(int argc, char **argv)
{
  short nc = 4, ne = 0; /* Core and enhancement bits, default to 32 kbit/s */
  int wordLen;
  char law = 'A';
#ifdef STATIC_ALLOCATION
  short           tmp_buf[256], inp_buf[256], out_buf[256];
#else
  short           *tmp_buf, *inp_buf, *out_buf;
#endif
  short           inp_type, out_type;
  g727_state      enc_state, dec_state;
  long            N = 256, N1 = 1, N2 = 0, cur_blk, smpno;

  /* General-purpose, progress indication */
  static char     quiet=0, funny[9] = "|/-\\|/-\\";
  char            encode=1, decode=1; /* Default: encode+decode operation */

  /* File variables */
  char            FileIn[80], FileOut[80];
  FILE           *Fi, *Fo;
  int             inp, out;
  long            start_byte;
#ifdef VMS
  char            mrs[15];
#endif

  /*
   * ......... PARAMETERS FOR PROCESSING .........
   */

#ifdef ORIGINAL_CODE
  if (argc < 7)
    display_usage();

  nc = atoi(argv[1]);
  ne = atoi(argv[2]);

  if (!(2 <= nc && nc <= 4 && ne >= 0 && nc + ne <= 5))
    error(badParamMsg);

  wordLen = nc + ne;
  sh += 2;
  mode = *argv[1 + sh];
  l = *argv[2 + sh];


  if ((mode != 'e' && mode != 'd' && mode != 'c') ||
      (l != 'a' && l != 'u' && l != 'A' && l != 'U'))
  {
    error(badParamMsg);
  }

  if ((in = fopen(argv[3 + sh], "rb")) == NULL ||
      (out = fopen(argv[4 + sh], "wb")) == NULL)
  {
    error("Can't open file");
  }

#endif
  /* GETTING OPTIONS */
  if (argc < 2)
    display_usage();
  else
  {
    while (argc > 1 && argv[1][0] == '-')
      if (strcmp(argv[1], "-frame") == 0 ||
	  strcmp(argv[1], "-blk") == 0)
      {
	/* Get skip length */
	N = atol (argv[2]);

	/* Move arg{c,v} over the option to the next argument */
	argc -= 2;
	argv += 2;
      }
      else if (strcmp (argv[1], "-start") == 0)
      {
	/* Define starting block */
	N1 = atol (argv[2]);

	/* Move arg{c,v} over the option to the next argument */
	argc -= 2;
	argv += 2;
      }
      else if (strcmp (argv[1], "-end") == 0)
      {
	/* Define last block */
	N2 = atol (argv[2]) - N1 + 1;

	/* Move arg{c,v} over the option to the next argument */
	argc -= 2;
	argv += 2;
      }
      else if (strcmp (argv[1], "-n") == 0)
      {
	/* Define number of samples to extract */
	N2 = atol (argv[2]);

	/* Move arg{c,v} over the option to the next argument */