wmaudiopaths.h

WM9713 audio codec driver for WinCE 5.0

/*-----------------------------------------------------------------------------
 * Function:    WMAudioClearMicRecPaths
 *
 * Turns off the given microphone record paths.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *      micSignalL      left channel microphone input to clear.
 *      micSignalR      right channel microphone input to clear.
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WMAudioClearMicRecPaths( WM_DEVICE_HANDLE hDevice,
								  WM_AUDIO_SIGNAL micSignalL,
								  WM_AUDIO_SIGNAL micSignalR
							    );

/*-----------------------------------------------------------------------------
 * Function:    WMAudioEnableHeadphoneMixerToHPPath
 *
 * Enable/Disable the headphone mixer to output to the headphone left and right
 * outputs.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *      enable          TRUE enables the path, FALSE disables the path.
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WMAudioEnableHeadphoneMixerToHPPath( WM_DEVICE_HANDLE hDevice,
                                              WM_BOOL enable
                                            );

/*-----------------------------------------------------------------------------
 * Function:    WMAudioEnableSpeakerMixerToSPKPath
 *
 * Enable/Disable the speaker mixer to output to the speaker left and right
 * outputs.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *      enable          TRUE enables the path, FALSE disables the path.
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WMAudioEnableSpeakerMixerToSPKPath( WM_DEVICE_HANDLE hDevice,
                                             WM_BOOL enable
                                           );

/*-----------------------------------------------------------------------------
 * Function:    WMAudioEnableMonoMixerToMONOPath
 *
 * Enable/Disable the mono mixer to output to the mono output.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *      enable          TRUE enables the path, FALSE disables the path.
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WMAudioEnableMonoMixerToMONOPath( WM_DEVICE_HANDLE hDevice,
                                           WM_BOOL enable
                                         );
/*-----------------------------------------------------------------------------
 * Function:    WMAudioSetHeadphoneMixerToSPKPath
 *
 * Set up the headphone mixer to output to the speaker left and right
 * outputs (SPKL&SPKR).
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WMAudioSetHeadphoneMixerToSPKPath( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMAudioSetHeadphoneMixerToLOUTPath
 *
 * Set up the headphone mixer to output to the line out left and right
 * outputs (LOUTL&LOUTR).
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WMAudioSetHeadphoneMixerToLOUTPath( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Macro:    WMAudioSetHeadphoneMixerToHPPath
 *
 * Set up the headphone mixer to output to the headphone left and right
 * outputs (HPL&HPR).
 * This function has been depreciated and may be removed in
 * a future version of the Wolfson drivers. Please use 
 * WMAudioEnableHeadphoneMixerToHPPath instead.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
#define WMAudioSetHeadphoneMixerToHPPath( _hDevice )						\
			WMAudioEnableHeadphoneMixerToHPPath( _hDevice,					\
								                 TRUE						\
								               )

/*-----------------------------------------------------------------------------
 * Macro:    WMAudioSetSpeakerMixerToSPKPath
 *
 * Set up the speaker mixer to output to the speaker left and right
 * outputs (SPKL&SPKR).
 * This function has been depreciated and may be removed in
 * a future version of the Wolfson drivers. Please use 
 * WMAudioEnableSpeakerMixerToSPKPath instead.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
#define WMAudioSetSpeakerMixerToSPKPath( _hDevice )						    \
			WMAudioEnableSpeakerMixerToSPKPath(  _hDevice,                  \
								                 TRUE                       \
								               )

/*-----------------------------------------------------------------------------
 * Function:    WMAudioSetSpeakerMixerToLOUTPath
 *
 * Set up the speaker mixer to output to the line out left and right
 * outputs (LOUTL&LOUTR).
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WMAudioSetSpeakerMixerToLOUTPath( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Macro:    WMAudioSetMonoMixerToMONOPath
 *
 * Set up the mono mixer to output to the mono output (MONO).
 * This function has been depreciated and may be removed in
 * a future version of the Wolfson drivers. Please use 
 * WMAudioEnableMonoMixerToMONOPath instead.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
#define WMAudioSetMonoMixerToMONOPath( _hDevice )						    \
			WMAudioEnableMonoMixerToMONOPath(  _hDevice,                    \
								               TRUE                         \
								            )

/*-----------------------------------------------------------------------------
 * Function:    WMAudioEnableOutputPaths
 *
 * Enables/disables the path from the given streams DAC to all outputs.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *      ifStream        the stream to enable/disable
 *      enable          TRUE enables the path, FALSE disables the path.
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WMAudioEnableOutputPaths( WM_DEVICE_HANDLE hDevice,
                                  WM_STREAM_ID     ifStream,
                                  WM_BOOL          enable
                                );

/*-----------------------------------------------------------------------------
 * Function:    WMAudioEnableHiFiOutputPaths
 *
 * Enables the path from the HiFi DAC to all outputs.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WMAudioEnableHiFiOutputPaths( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMAudioEnableVoiceOutputPaths
 *
 * Enables the path from the Voice DAC to all outputs.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WMAudioEnableVoiceOutputPaths( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMAudioEnableMonoOutputPaths
 *
 * Enables the path from the Voice DAC to all outputs.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WMAudioEnableMonoOutputPaths( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMAudioEnableInputPaths
 *
 * Enables/disables the path from the inputs to the given streams ADC.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *      ifStream        the stream to enable/disable
 *      enable          TRUE enables the path, FALSE disables the path.
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WMAudioEnableInputPaths( WM_DEVICE_HANDLE hDevice,
                                  WM_STREAM_ID     ifStream,
                                  WM_BOOL          enable
                                );

#ifdef __cplusplus
}   /* extern "C" */
#endif

#endif  /* WM_AUDIO */

#endif	/* __WMAUDIOPATHS_H__ */
/*------------------------------ END OF FILE ---------------------------------*/