home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / audiofile / afInitFormatParams.z / afInitFormatParams
Encoding:
Text File  |  1998-10-20  |  9.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4. aaaaffffIIIInnnniiiittttFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))                                aaaaffffIIIInnnniiiittttFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      afInitFormatParams - initialize the audio data format in an AAAAFFFFffffiiiilllleeeesssseeeettttuuuupppp
  10.      for a specified audio track via ddddmmmmPPPPaaaarrrraaaammmmssss
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ddddmmmm____aaaauuuuddddiiiioooo....hhhh>>>>
  14.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiiooooffffiiiilllleeee....hhhh>>>>
  15.  
  16.      DDDDMMMMssssttttaaaattttuuuussss aaaaffffIIIInnnniiiittttFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((AAAAFFFFffffiiiilllleeeesssseeeettttuuuupppp sssseeeettttuuuupppp,,,, iiiinnnntttt ttttrrrraaaacccckkkk,,,,
  17.                                  DDDDMMMMppppaaaarrrraaaammmmssss ****ppppaaaarrrraaaammmmssss))))
  18.  
  19. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  20.      _s_e_t_u_p    is an AAAAFFFFffffiiiilllleeeesssseeeettttuuuupppp structure, previously created by a call to
  21.               aaaaffffNNNNeeeewwwwFFFFiiiilllleeeeSSSSeeeettttuuuupppp(3dm).
  22.  
  23.      _t_r_a_c_k    is an integer which identifies an audio track in _s_e_t_u_p.
  24.  
  25.               Since all currently supported file formats contain only one
  26.               audio track, the value AAAAFFFF____DDDDEEEEFFFFAAAAUUUULLLLTTTT____TTTTRRRRAAAACCCCKKKK should be used here for
  27.               now.
  28.  
  29.      _p_a_r_a_m_s   a DDDDMMMMppppaaaarrrraaaammmmssss list, previously created by a call to
  30.               ddddmmmmPPPPaaaarrrraaaammmmssssCCCCrrrreeeeaaaatttteeee(3dm).
  31.  
  32. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  33.      aaaaffffIIIInnnniiiittttFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss(((()))) returns DM_SUCCESS on success, otherwise it returns
  34.      DM_FAILURE.
  35.  
  36. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  37.      aaaaffffIIIInnnniiiittttFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss(((()))) initializes all parameters associated with the audio
  38.      data in an AAAAFFFFffffiiiilllleeeesssseeeettttuuuupppp structure for an audio track.  It obsoletes the
  39.      individual routines aaaaffffIIIInnnniiiittttSSSSaaaammmmpppplllleeeeFFFFoooorrrrmmmmaaaatttt(3dm), aaaaffffIIIInnnniiiittttCCCChhhhaaaannnnnnnneeeellllssss(3dm),
  40.      aaaaffffIIIInnnniiiittttRRRRaaaatttteeee(3dm) and aaaaffffIIIInnnniiiittttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnn(3dm), and
  41.      aaaaffffIIIInnnniiiittttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnnPPPPaaaarrrraaaammmmssss(3dm).
  42.  
  43.      The following parameters are defined in _d_m_e_d_i_a/_d_m__a_u_d_i_o._h and may be set
  44.      via _p_a_r_a_m_s:
  45.  
  46.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____FFFFOOOORRRRMMMMAAAATTTT       Sample format.  Must be DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____TTTTWWWWOOOOSSSS____CCCCOOOOMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTT,
  47.                            DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD, DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____FFFFLLLLOOOOAAAATTTT, or
  48.                            DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____DDDDOOOOUUUUBBBBLLLLEEEE.
  49.  
  50.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____WWWWIIIIDDDDTTTTHHHH        Sample width in bits.  For integer sample formats,
  51.                            it must be an integer value between 1 and 32,
  52.                            inclusive.  For formats DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____FFFFLLLLOOOOAAAATTTT and
  53.                            DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____DDDDOOOOUUUUBBBBLLLLEEEE, this parameter is ignored.
  54.  
  55.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____CCCCHHHHAAAANNNNNNNNEEEELLLLSSSS     Channel count.  Integer value greater than or equal
  56.                            to 1.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. aaaaffffIIIInnnniiiittttFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))                                aaaaffffIIIInnnniiiittttFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____RRRRAAAATTTTEEEE         Sampling rate.  Must be a positive, double
  75.                            precision floating point value.
  76.  
  77.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____CCCCOOOOMMMMPPPPRRRREEEESSSSSSSSIIIIOOOONNNN  Compression type.  Will be DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____UUUUNNNNCCCCOOOOMMMMPPPPRRRREEEESSSSSSSSEEEEDDDD or
  78.                            one of the supported compression parameter values.
  79.                            In addition, any parameters associated with the
  80.                            compression, such as DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____BBBBIIIITTTTRRRRAAAATTTTEEEE, should be
  81.                            set here (see aaaaffffIIIInnnniiiittttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnn(3dm) and
  82.                            aaaaffffIIIInnnniiiittttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnnPPPPaaaarrrraaaammmmssss(3dm)).
  83.  
  84.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____PPPPCCCCMMMM____MMMMAAAAPPPP____SSSSLLLLOOOOPPPPEEEE
  85.  
  86.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____PPPPCCCCMMMM____MMMMAAAAPPPP____IIIINNNNTTTTEEEERRRRCCCCEEEEPPPPTTTT
  87.  
  88.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____PPPPCCCCMMMM____MMMMAAAAPPPP____MMMMAAAAXXXXCCCCLLLLIIIIPPPP
  89.  
  90.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____PPPPCCCCMMMM____MMMMAAAAPPPP____MMMMIIIINNNNCCCCLLLLIIIIPPPP
  91.                            Slope, intercept, minimum and maximum clipping
  92.                            values for PCM mapping (see
  93.                            aaaaffffGGGGeeeettttVVVViiiirrrrttttuuuuaaaallllPPPPCCCCMMMMMMMMaaaappppppppiiiinnnngggg(3dm) for a detailed
  94.                            explanation).
  95.  
  96.      When a file is opened for writing by passing _s_e_t_u_p to aaaaffffOOOOppppeeeennnnFFFFiiiilllleeee(3dm),
  97.      the track will be configured to store data according to the data format,
  98.      width, number of channels, or sample rate specified.
  99.  
  100. CCCCAAAAVVVVEEEEAAAATTTTSSSS
  101.      The Audio File Library will continue to support additional file formats.
  102.      The ability of these file formats to store data of various sample formats
  103.      will vary.  If you are choosing a file format other than the default
  104.      format, you should make sure that you either explicitly specify format
  105.      params for this file's tracks which are compatible with that file format,
  106.      or do not set them at all (in which case they will be set to default
  107.      values for the format).
  108.  
  109.      In the case where the audio track in a file is configured for
  110.      compression, the parameter values for DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____FFFFOOOORRRRMMMMAAAATTTT and DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____WWWWIIIIDDDDTTTTHHHH
  111.      should match the data format specified by the compression algorithm.  For
  112.      example, the software G.722 compressor expects to encode 16-bit two's
  113.      complement linear PCM input data.  In addition, many compression formats
  114.      have restrictions on sample rate and/or channel count as well.
  115.  
  116. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  117.      afNewFileSetup(3dm), afOpenFile(3dm), afWriteFrames(3dm),
  118.      afSetVirtualSampleFormat(3dm), afGetVirtualSampleFormat(3dm),
  119.      afInitCompression(3dm)
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.