cat

speech signal process tools

MUX(1-ESPS)                                 ENTROPIC RESEARCH LAB



NNNNAAAAMMMMEEEE
     mux - multiplex sampled-data files into a single multichannel or complex file

SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
     mmmmuuuuxxxx [ ----{pppprrrrssss} _r_a_n_g_e ] . . . [ ----xxxx _d_e_b_u_g__l_e_v_e_l ] [ ----JJJJ ] [   ---- PPPP
     _p_a_r_a_m__f_i_l_e ] _i_n_p_u_t_1._f_s_d [ _i_n_p_u_t_2._f_s_d . . . ] _o_u_t_p_u_t._f_s_d

DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     The _m_u_x (``multiplex'') program combines its input  sampled-
     data FEA_SD(5-ESPS) files, or equal-length portions of them,
     into a single multichannel output sampled-data file,  possi-
     bly  also  combining  real channels in pairs to form complex
     channels.

     Normally the number of output channels is the  total  number
     of channels in all the input files.  Each output record con-
     tains the data from the _s_a_m_p_l_e_s field in one record of  each
     input file.  This is organized as a single vector containing
     one sample value from  each  channel  of  each  input  file.
     Within  the vector, the data from the first input file comes
     first, followed by the data from the second, and so  on,  in
     the  order of the file names on the command line.  The chan-
     nels of any one input file keep the same  relative  ordering
     in the output file that they had in the input file.

     When the ----JJJJ option is used, the number of output channels is
     only  half  the normal number; input channels of a real data
     type are combined in pairs into single  output  channels  of
     the corresponding complex type.

     The input files must be consistent in data type and sampling
     frequency; the output file has the same data type (unless ----JJJJ
     is used) and the same sampling frequency as the input files.
     Any fields other than _s_a_m_p_l_e_s in the input are ignored.

     By default, the first output record contains data  from  the
     first record in each input file, and in general the _nth out-
     put record contains data from the _nth record in  each  input
     file;  but  a later starting point in each input file can be
     chosen with the ----pppp, ----rrrr, or ----ssss option.  By  default,  records
     are  processed  until  an input file runs out of data, but a
     shorter range of data can be chosen with ----pppp, ----rrrr, or ----ssss.

     If ``-'' is written for an input file, the standard input is
     used.   At most one input file may be standard input.  Names
     of disk files, however, may be repeated  (duplicating  chan-
     nels).   Since different ----pppp, ----rrrr, and ----ssss options may apply to
     each instance of a repeated input file name, it is  possible
     to  align and juxtapose different portions of a single input
     file.  If ``-'' is written for the output, the standard out-
     put is used.




        Copyright Entropic Research Laboratory, Inc. 1G1        1






MUX(1-ESPS)                                 ENTROPIC RESEARCH LAB



OOOOPPPPTTTTIIIIOOOONNNNSSSS
     The following options are supported:

     ----pppp _r_a_n_g_e
          For this program ----pppp and ----rrrr are synonymous.  See ----rrrr  for
          the interpretation and the format of the argument.

     ----rrrr _f_i_r_s_t::::_l_a_s_t

     ----rrrr _f_i_r_s_t::::++++_i_n_c_r
          Determines the range of points (records)  to  be  taken
          from  an  input  file.   In  the  first form, a pair of
          unsigned integers gives the numbers of  the  first  and
          last records of the range.  (Counting starts with 1 for
          the first record in the file.)  If _f_i_r_s_t is omitted,  1
          is  used.   If  _l_a_s_t is omitted, the last record in the
          file is used.  The second form  is  equivalent  to  the
          first with _l_a_s_t = _f_i_r_s_t + _i_n_c_r .

          This option and the ----pppp and ----ssss options may  be  repeated
          up  to  a maximum total number, for all three kinds, of
          the number of input files.  The first ----pppp, ----rrrr,  or   ---- ssss
          option  applies  to the first input file, the second to
          the second, and so on.  If there are fewer ----pppp, ----rrrr, and
          ---- ssss  options  than  input  files,  the last such option
          applies to all the remaining input files.  In  particu-
          lar,  if  there  is  only  one ----pppp, ----rrrr, or ----ssss option, it
          applies to all the input files.

          If two options disagree as to the number of records  to
          be  processed, the smaller number applies.  In fact _m_u_x
          stops processing as soon as it  encounters  either  the
          end  of  a specified range or the actual end of file in
          any input file.  Certain inconsistencies in these vari-
          ous  stopping criteria will evoke warning messages; see
          the Diagnostics section for details.

     ----ssss _s_t_a_r_t::::_e_n_d

     ----ssss _s_t_a_r_t::::++++_i_n_c_r
          Determines the range in seconds of the data to be taken
          from  an  input  file.   In  the  first form, a pair of
          floating-point numbers give the beginning time and end-
          ing  time  of the range.  The second form is equivalent
          to the first with _l_a_s_t = _f_i_r_s_t + _i_n_c_r. Each sample  has
          a  time  given  by _s + (_r-1)/_f, where _s is the value of
          the generic header item "start_time", _r is  the  record
          number,  and  _f is the sampling frequency, given by the
          generic  header  item  "record_freq".   This  time  may
          depend  on  the  channel number, since the "start_time"
          item may be a vector with a component per channel;  for
          present  purposes  the  value  for  the  first  channel



        Copyright Entropic Research Laboratory, Inc. 2G2        2






MUX(1-ESPS)                                 ENTROPIC RESEARCH LAB



          (number 0) is used.  The range  selected  by  the   ---- ssss
          option  consists  of  the records for which the time is
          less than _e_n_d but not less than _s_t_a_r_t.

          This option and the ----pppp and ----rrrr options may  be  repeated
          to  supply  different ranges for different input files.
          See the ----rrrr option for details.

     ----xxxx _d_e_b_u_g__l_e_v_e_l
          If _d_e_b_u_g__l_e_v_e_l is positive, the program  prints  debug-
          ging messages as it progresses---the higher the number,
          the more messages.  The default  level  is  0,  for  no
          debugging output.

     ----JJJJ    Join pairs of input channels to  form  single  complex
          output  channels.   The total number of channels in the
          input files must be even, and the output file has  half
          that  number of channels.  The input channels are taken
          in the usual order and grouped in  pairs  to  form  the
          real  and  imaginary parts of the output channels.  The
          pairing is without regard to whether two input channels
          come  from  the  same  input file or consecutive files.
          The last channel of a file, if not paired with the pre-
          vious  input  channel, is paired with the first channel
          of the next input file.

          The input files must all have the same real data  type:
          DOUBLE,  FLOAT, LONG, SHORT, or BYTE.  (See _F_E_A(5-ESPS)
          for an explanation of these type  codes.)   The  output
          file   has   the   corresponding   complex  data  type:
          DOUBLE_CPLX,  FLOAT_CPLX,  LONG_CPLX,  SHORT_CPLX,   or
          BYTE_CPLX.

          If two channels with with different time alignments are
          combined   into  one  complex  channel,  time-alignment
          information may be lost.  A warning message is  printed
          in  that  case.  See the discussion of the "start_time"
          generic header item in the section on ESPS Headers.

     ----PPPP _p_a_r_a_m__f_i_l_e
          The name of the parameter file.  The  default  name  is
          ``params''.

EEEESSSSPPPPSSSS PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
     The parameter file is not required to be present,  as  there
     are  default values for all parameters.  If the file exists,
     the following parameters may be read if they are not  deter-
     mined by command-line options.

     _s_t_a_r_t - _i_n_t_e_g_e_r _a_r_r_a_y
          The starting record number in  each  input  file.   The
          array  elements  are matched with input files in order.



        Copyright Entropic Research Laboratory, Inc. 3G3        3






MUX(1-ESPS)                                 ENTROPIC RESEARCH LAB



          If there are more input files, the last  array  element
          applies to the unmatched file.  If there are more array
          elements, the unmatched ones are ignored.  This parame-
          ter  is  not read if the ----pppp, ----rrrr, or ----ssss option is speci-
          fied.  The default is all 1's, meaning the beginning of
          each input file.

     _n_a_n - _i_n_t_e_g_e_r
          The number of records to process in each input file.  A
          value  of  0  (the  default)  means continue processing
          until the end of an input file is reached.  This param-
          eter  is not read if the ----pppp, ----rrrr, or ----ssss option is speci-
          fied.

     _m_a_k_e__c_o_m_p_l_e_x - _s_t_r_i_n_g
          A value of "YES" or "yes"  means  join  pairs  of  real
          channels  to  form complex channels as if the ----JJJJ option
          is in force.  A value of "NO"  or  "no"  means  make  a
          separate  output  channel  for  each  input  channel as
          usual.  No other values are allowed.  This parameter is
          not  read  if  the ----JJJJ option is specified.  The default
          value is "NO".

EEEESSSSPPPPSSSS CCCCOOOOMMMMMMMMOOOONNNN
     The ESPS Common file is not read.

     If Common processing is enabled, and the output file is  not