dmDVAudioHeaderGetParams(3dm)                    dmDVAudioHeaderGetParams(3dm)



NAME
     dmDVAudioHeaderGetParams - get DV audio decoder parameter values


SYNOPSIS
     #include <dmedia/dmaudioutil.h>
     #include <dmedia/dmparams.h>

     DMstatus dmDVAudioHeaderGetParams(void *dif,
                                   DMparams *params,
                                   int *numSampFrames)


PARAMETER
     dif      Points to a valid frame of DIF data which contains embedded
              audio. See dm_dv(3dm) for more info about DIF, DV, and DVCPRO.


     params   This params list is filled out by the function and returns
              extensive information about the audio in the DIF frame.


     numSampFrames
              If this paramater is non-NULL, the number of 16 bit samples
              embedded inside the DIF frame is returned in this parameter.


RETURNED VALUE
     Returns DMSUCCESS or DMFAILURE.


DESCRIPTION
     dmDVAudioHeaderGetParams(3dm) returns information about a single DIF
     frame with many audio samples embedded in it.


     The set of parameters that are returned in params are defined in
     dmedia/dm_audioutil.h and are listed below:

     DMDVAUDIOFORMAT - either DM_DVAUDIO_NTSC or DM_DVAUDIO_PAL
     DMDVAUDIOTYPE - either DM_DVAUDIO_DV or DM_DVAUDIO_DVCPRO
     DMAUDIOCODECMAXBYTESPERBLOCK - either 120000 for NTSC or 144000 for
     PAL
     DMAUDIOCHANNELS - number of channels of audio (1 or 2 or 4)
     DMAUDIOWIDTH - will always be 16
     DMDVAUDIOCHANNELMODE - either DM_DVAUDIO_SD_2CH or DM_DVAUDIO_SD_4CH
     DMDVAUDIOCHANNELPOLICY - integer 1-19, described in dm_audioutil.h,
     which specify exactly how the audio is layed out inside the DIF frame.
     DMMEDIUM - will always be DM_AUDIO
     DMAUDIOBYTEORDER - will always be DM_AUDIO_BIG_ENDIAN
     DMAUDIOFORMAT - will always be DM_AUDIO_TWOS_COMPLEMENT
     DMAUDIORATE - the sample rate in floating point (ex: 48000.0)



                                                                        Page 1

dmDVAudioHeaderGetParams(3dm)                    dmDVAudioHeaderGetParams(3dm)



     DMAUDIOCODECFRAMESPERBLOCK - the maximum number of samples this DIF
     frame could possibly contain
     DMDVAUDIOMINFRAMESPERBLOCK - the miniumum number of frames this DIF
     frame could possibly contain
     DMAUDIOCODECFILTERDELAY - always zero
     DMDVAUDIOLOCKMODE - non-zero if audio is locked according to the DV
     audio specification.  Zero if it is not locked.


SEE ALSO
     dmDVAudioDecoderCreate(3dm), dmDVAudioDecoderSetParams(3dm),
     dmDVAudioDecode(3dm).











































                                                                        Page 2