home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / dmedia / dmMPEG1AudioEncoderSetParams.z / dmMPEG1AudioEncoderSetParams
Encoding:
Text File  |  2002-10-03  |  20.0 KB  |  265 lines

  1.  
  2.  
  3.  
  4. ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))            ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      dmMPEG1AudioEncoderSetParams, dmMPEG1AudioDecoderSetParams,
  10.      dmMPEG1AudioEncoderGetParams, dmMPEG1AudioDecoderGetParams - set and
  11.      query MPEG1 audio encoder/decoder parameter values.
  12.  
  13.  
  14. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  15.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ddddmmmm____ppppaaaarrrraaaammmmssss....hhhh>>>>
  16.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ddddmmmmeeeeddddiiiiaaaa....hhhh>>>>
  17.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ddddmmmm____aaaauuuuddddiiiioooouuuuttttiiiillll....hhhh>>>>
  18.  
  19.  
  20.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((DDDDMMMMMMMMPPPPEEEEGGGG1111aaaauuuuddddiiiiooooeeeennnnccccooooddddeeeerrrr eeeennnnccccooooddddeeeerrrr,,,,
  21.                                    DDDDMMMMppppaaaarrrraaaammmmssss ****ppppaaaarrrraaaammmmssss))))
  22.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooDDDDeeeeccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((DDDDMMMMMMMMPPPPEEEEGGGG1111aaaauuuuddddiiiiooooddddeeeeccccooooddddeeeerrrr ddddeeeeccccooooddddeeeerrrr,,,,
  23.                                    DDDDMMMMppppaaaarrrraaaammmmssss ****ppppaaaarrrraaaammmmssss))))
  24.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrGGGGeeeettttPPPPaaaarrrraaaammmmssss((((DDDDMMMMMMMMPPPPEEEEGGGG1111aaaauuuuddddiiiiooooeeeennnnccccooooddddeeeerrrr eeeennnnccccooooddddeeeerrrr,,,,
  25.                                    DDDDMMMMppppaaaarrrraaaammmmssss ****ppppaaaarrrraaaammmmssss))))
  26.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooDDDDeeeeccccooooddddeeeerrrrGGGGeeeettttPPPPaaaarrrraaaammmmssss((((DDDDMMMMMMMMPPPPEEEEGGGG1111aaaauuuuddddiiiiooooddddeeeeccccooooddddeeeerrrr ddddeeeeccccooooddddeeeerrrr,,,,
  27.                                    DDDDMMMMppppaaaarrrraaaammmmssss ****ppppaaaarrrraaaammmmssss))))
  28.  
  29.  
  30. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  31.      _e_n_c_o_d_e_r  DDDDMMMMMMMMPPPPEEEEGGGG1111aaaauuuuddddiiiiooooeeeennnnccccooooddddeeeerrrr structure, created by
  32.               ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrCCCCrrrreeeeaaaatttteeee((((3333ddddmmmm)))).
  33.  
  34.  
  35.      _d_e_c_o_d_e_r  DDDDMMMMMMMMPPPPEEEEGGGG1111aaaauuuuddddiiiiooooddddeeeeccccooooddddeeeerrrr structure, created by
  36.               ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooDDDDeeeeccccooooddddeeeerrrrCCCCrrrreeeeaaaatttteeee((((3333ddddmmmm)))).
  37.  
  38.  
  39.      _p_a_r_a_m_s   List of parameters for specification.
  40.  
  41.  
  42. RRRREEEETTTTUUUURRRRNNNNEEEEDDDD VVVVAAAALLLLUUUUEEEE
  43.      Returns DDDDMMMM____SSSSUUUUCCCCCCCCEEEESSSSSSSS or DDDDMMMM____FFFFAAAAIIIILLLLUUUURRRREEEE.
  44.  
  45.  
  46. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  47.      ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))) or ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooDDDDeeeeccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))
  48.      sets MPEG1 audio encoder or decoder parameters to user defined values
  49.      with _p_a_r_a_m_s.  These values will overwrite the default values set by
  50.      ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrCCCCrrrreeeeaaaatttteeee((((3333ddddmmmm)))) or ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooDDDDeeeeccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))).
  51.      *params can be NULL, then default values will be used.  Unrecognized
  52.      parameters are ignored.  ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))) or
  53.      ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooDDDDeeeeccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))) also initializes necessary filter
  54.      coefficients for encoder/decoder so it has to be used before calling
  55.      ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeee((((3333ddddmmmm)))) or ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooDDDDeeeeccccooooddddeeee((((3333ddddmmmm)))). For decoder, user
  56.      defined parameters usually should be obtained first by using
  57.      ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooHHHHeeeeaaaaddddeeeerrrrGGGGeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))) from compressed data header.
  58.      ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrGGGGeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))) or ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooDDDDeeeeccccooooddddeeeerrrrGGGGeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))
  59.      obtains MPEG1 audio encoder or decoder parameters.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))            ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      The set of parameters for _p_a_r_a_m_s are, defined in _d_m_e_d_i_a/_d_m__a_u_d_i_o_u_t_i_l._h
  75.      and _d_m_e_d_i_a/_d_m__p_a_r_a_m_s._h are as follows
  76.  
  77.  
  78.      Parameters for MPEG1 audio encoder and decoder:
  79.  
  80.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____RRRRAAAATTTTEEEE
  81.      input/output sampling rate parameter (rate given in Hz).  The
  82.      corresponding values for the rates are doubles. 32000, 44100 (default),
  83.      and 48000 Hz are supported.
  84.  
  85.  
  86.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____FFFFOOOORRRRMMMMAAAATTTT
  87.           DM_AUDIO_TWOS_COMPLEMENT
  88.      indicates the format of each input/ouput audio sample.
  89.      DM_AUDIO_TWOS_COMPLEMENT is the only value supported.
  90.  
  91.  
  92.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____WWWWIIIIDDDDTTTTHHHH
  93.           DM_AUDIO_WIDTH_16
  94.      indicates the width of each input/ouput audio sample.  DM_AUDIO_WIDTH_16
  95.      is the only value supported.
  96.  
  97.  
  98.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____CCCCHHHHAAAANNNNNNNNEEEELLLLSSSS
  99.      passes the number of channels in the input/output audio data. Integer 1
  100.      or 2 (default) are the only values supported.
  101.  
  102.  
  103.      DDDDMMMM____MMMMPPPPEEEEGGGG1111____AAAAUUUUDDDDIIIIOOOO____LLLLAAAAYYYYEEEERRRR
  104.           DM_MPEG1_AUDIO_LAYER1
  105.           DM_MPEG1_AUDIO_LAYER2  (default)
  106.      a flag specifying the basic algorithm to be used.
  107.  
  108.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____CCCCHHHHAAAANNNNNNNNEEEELLLL____PPPPOOOOLLLLIIIICCCCYYYY
  109.           DM_AUDIO_STEREO
  110.           DM_AUDIO_JOINT_STEREO  (default)
  111.           DM_AUDIO_INDEPENDENT
  112.      chooses how multiple channels should be treaed.
  113.      DM_AUDIO_STEREO indicates that the channels are part of a single
  114.      multichannel signal. This includes quadrophonic, etc.;
  115.      DM_AUDIO_JOINT_STEREO indicates that the algorithm may attempt to exploit
  116.      redundancy between channels for greater coding gain;
  117.      DM_AUDIO_INDEPENDENT indicates that the separate channels are unrelated
  118.      and should be processed separately, such as multilingual sound tracks.
  119.  
  120.  
  121.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____BBBBIIIITTTTRRRRAAAATTTTEEEE
  122.      specifies the desired bitrate for the compressed data, in bits per
  123.      second. Note that for some schemes such as MPEG's maxrate this is treated
  124.      as an upper limit, whereas for MPEG's fixrate, this is strictly achieved
  125.      as a constant rate. The following is a list of valid bitrates for MPEG1
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))            ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))
  137.  
  138.  
  139.  
  140.      audio:
  141.      Layer 1: 32000, 64000, 96000, 128000, 160000, 192000, 224000, 256000
  142.      (default), 288000, 320000, 352000, 384000, 416000, and 448000.
  143.      Layer 2: 32000, 48000, 56000, 64000, 80000, 96000, 112000, 128000,
  144.      160000, 192000, 224000, 256000 (default), 320000, and 384000.
  145.  
  146.  
  147.      Parameters for MPEG1 audio encoder only:
  148.  
  149.  
  150.      DDDDMMMM____MMMMPPPPEEEEGGGG1111____AAAAUUUUDDDDIIIIOOOO____PPPPSSSSYYYYCCCCHHHHOOOOMMMMOOOODDDDEEEELLLL
  151.           DM_MPEG1_AUDIO_PSYCHOMODEL1
  152.           DM_MPEG1_AUDIO_PSYCHOMODEL2
  153.      selects which psychoacoustic model is used to calculate the safe masking
  154.      thresholds for quantizing noise (the basis of the compression).  The
  155.      psychoacoustic model determines when quantization noise may be safely
  156.      hidden below signal components.  The
  157.  
  158.  
  159.      DDDDMMMM____MMMMPPPPEEEEGGGG1111____AAAAUUUUDDDDIIIIOOOO____PPPPSSSSYYYYCCCCHHHHOOOOMMMMOOOODDDDEEEELLLL1111____AAAALLLLPPPPHHHHAAAA
  160.      specifies possible float value for MPEG1 audio psychoacoustic model's
  161.      alpha parameter (only for model 1).  Valid value is within (0.0, 2.0].
  162.      Default is 2.0.
  163.  
  164.  
  165.      DDDDMMMM____MMMMPPPPEEEEGGGG1111____AAAAUUUUDDDDIIIIOOOO____BBBBIIIITTTTRRRRAAAATTTTEEEE____PPPPOOOOLLLLIIIICCCCYYYY
  166.           DM_MPEG1_AUDIO_FIXRATE        (default)
  167.           DM_MPEG1_AUDIO_CONSTANT_QUALITY
  168.      is a flag to select variants for interpreting DM_AUDIO_BIT_RATE.
  169.  
  170.  
  171.      DDDDMMMM____MMMMPPPPEEEEGGGG1111____AAAAUUUUDDDDIIIIOOOO____CCCCOOOONNNNSSSSTTTT____QQQQUUUUAAAALLLL____NNNNMMMMRRRR
  172.      The argument is the desired mask to noise ratio in dB. Possible float
  173.      value for this parameter is within (-13.0, 13.0]. Default is 0.0.
  174.      Positive (negative) values will make quantization noise more (less)
  175.      audible and result in smaller (larger) compressed files.
  176.  
  177.  
  178.      Parameters for MPEG1 audio decoder only:
  179.  
  180.      DDDDMMMM____MMMMPPPPEEEEGGGG1111____AAAAUUUUDDDDIIIIOOOO____DDDDEEEECCCCIIIIMMMMAAAATTTTIIIIOOOONNNN____SSSSCCCCAAAALLLLEEEE
  181.           DM_MPEG1_AUDIO_BANDWIDTH_FULL (default)
  182.           DM_MPEG1_AUDIO_BANDWIDTH_HALF
  183.           DM_MPEG1_AUDIO_BANDWIDTH_QUARTER
  184.      specifies the decimation factor applied to reduced complexity of
  185.      decoding. A value of fraction of DM_MPEG1_AUDIO_BANDWIDTH_HALF or
  186.      DM_MPEG1_AUDIO_BANDWIDTH_QUARTER indicates that the resynthesized stream
  187.      should be at one-half or one- quaner of the nominal sampling rate.  A
  188.      value of DM_MPEG1_AUDIO_BANDWIDTH_FULL results in normal behavior.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))            ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrSSSSeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))
  203.  
  204.  
  205.  
  206.      DDDDMMMM____MMMMPPPPEEEEGGGG1111____AAAAUUUUDDDDIIIIOOOO____SSSSCCCCAAAALLLLEEEE____FFFFIIIILLLLTTTTEEEERRRRSSSSHHHHAAAAPPPPEEEE
  207.           DM_MPEG1_AUDIO_DEFAULT_FILTER (default)
  208.           DM_MPEG1_AUDIO_FILTER_SHAPE1
  209.           DM_MPEG1_AUDIO_FILTER_SHAPE2
  210.      specifies the filter shape applied to reduced complexity of decoding.   A
  211.      value of DM_MPEG1_AUDIO_BANDWIDTH_FULL results in normal behavior.
  212.  
  213.  
  214.  
  215.      DDDDMMMM____MMMMPPPPEEEEGGGG1111____AAAAUUUUDDDDIIIIOOOO____CCCCOOOOMMMMBBBBIIIINNNNEEEE____CCCCHHHHAAAANNNNSSSS____FFFFLLLLAAAAGGGG
  216.      integer, default value is 0; if set to 1, it overwrites the JOINT_STEREO
  217.      mode and force decoder to produce single channel output.
  218.  
  219.  
  220.      Parameters for MPEG1 audio query only, using
  221.      ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeeerrrrGGGGeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))) or ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooDDDDeeeeccccooooddddeeeerrrrGGGGeeeettttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm)))):
  222.  
  223.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____CCCCOOOODDDDEEEECCCC____FFFFRRRRAAAAMMMMEEEESSSS____PPPPEEEERRRR____BBBBLLLLOOOOCCCCKKKK
  224.      specifies how many sample frames (integer) are put into each compressed
  225.      data block.  For each call to ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeee((((3333ddddmmmm)))), this many new
  226.      sample frames must be provided; each call to ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooDDDDeeeeccccooooddddeeee((((3333ddddmmmm)))),
  227.      will return this many new sample frames.
  228.  
  229.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____CCCCOOOODDDDEEEECCCC____MMMMAAAAXXXX____BBBBYYYYTTTTEEEESSSS____PPPPEEEERRRR____BBBBLLLLOOOOCCCCKKKK
  230.      indicates the maximum number of bytes (integer) that will comprise a
  231.      compressed data block (representing frames per block sample frames). For
  232.      compression, this is the size of the output buffer that must be provided
  233.      to ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeee((((3333ddddmmmm)))); for decompression, this is the number of
  234.      compressed bytes that must be queued up for ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooDDDDeeeeccccooooddddeeee((((3333ddddmmmm)))) to
  235.      look at. Note that any particular block can be smaller than this; both
  236.      ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooEEEEnnnnccccooooddddeeee((((3333ddddmmmm)))) and ddddmmmmMMMMPPPPEEEEGGGG1111AAAAuuuuddddiiiiooooDDDDeeeeccccooooddddeeee((((3333ddddmmmm)))) return the actual
  237.      byte-size of the given block.
  238.  
  239.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____CCCCOOOODDDDEEEECCCC____FFFFIIIILLLLTTTTEEEERRRR____DDDDEEEELLLLAAAAYYYY
  240.      This is the number of sample fames (integer) of delay introduced in
  241.      compression and decompression processing.  These numbers are usually
  242.      different for compression versus decompression.  This is caused by filter
  243.      operations that convolve a N past input samples with a filter M-
  244.      coefficient array to create N+M-1 output samples.  The filtered signal
  245.      contains more samples than the unfiltered signal. the output signal is
  246.      offset by DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____CCCCOOOODDDDEEEECCCC____FFFFIIIILLLLTTTTEEEERRRR____DDDDEEEELLLLAAAAYYYY samples from the first sample thus
  247.      omits the last DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____CCCCOOOODDDDEEEECCCC____FFFFIIIILLLLTTTTEEEERRRR____DDDDEEEELLLLAAAAYYYY samples from the output file.
  248.  
  249.  
  250. NNNNOOOOTTTTEEEE
  251. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  252.      dmMPEG1AudioEncoderCreate(3dm), dmMPEG1AudioEncode(3dm),
  253.      dmMPEG1AudioDecoderCreate(3dm), dmMPEG1AudioDecode(3dm).
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.