wm8753audiopaths.h

WM9713 audio codec driver for WinCE 5.0

/*-----------------------------------------------------------------------------
 * Copyright (c) Wolfson Microelectronics plc.  All rights reserved.
 *
 * This software as well as any related documentation is furnished under 
 * license and may only be used or copied in accordance with the terms of the 
 * license. The information in this file is furnished for informational use 
 * only, is subject to change without notice, and should not be construed as 
 * a commitment by Wolfson Microelectronics plc. Wolfson Microelectronics plc
 * assumes no responsibility or liability for any errors or inaccuracies that
 * may appear in this document or any software that may be provided in
 * association with this document. 
 *
 * Except as permitted by such license, no part of this document may be 
 * reproduced, stored in a retrieval system, or transmitted in any form or by 
 * any means without the express written consent of Wolfson Microelectronics plc. 
 *
 * $Id: WM8753AudioPaths.h 1639 2005-05-05 02:56:19Z ian $
 *
 * This file contains definitions and routines for controlling audio paths.
 *
 * NOTE: This code is here as an example. Each application is different
 * and the input paths require will vary. You should optimise these functions
 * for your particular application.
 *
 * Warning:
 *  This driver is specifically written for Wolfson Codecs. It is not a 
 *  general CODEC device driver.
 *
 *---------------------------------------------------------------------------*/
#ifndef __WM8753AUDIOPATHS_H__
#define __WM8753AUDIOPATHS_H__

/*
 * Include files
 */
#include "WMStatus.h"
#include "WMTypes.h"
#include "WMAudioPaths.h"
/*
 * Definitions
 */

/*
 * Only build this if we are asked to.
 */
#if WM_AUDIO

/*
 * Function prototypes
 */
#ifdef __cplusplus
extern "C" {
#endif

/*-----------------------------------------------------------------------------
 * Function:    WM8753SetLineInRecPaths
 *
 * Set up Line In as the record path.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *      lineInL     signal to record on left ADC channel.
 *      lineInR     signal to record on right ADC channel.
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WM8753SetLineInRecPaths( WM_DEVICE_HANDLE  hDevice, 
								  WM_AUDIO_SIGNAL   lineInL,
								  WM_AUDIO_SIGNAL   lineInR
                                );

/*-----------------------------------------------------------------------------
 * Function:    WM8753ClearLineInRecPaths
 *
 * Turns off Line In as the record path.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *      lineInL     signal to record on left ADC channel.
 *      lineInR     signal to record on right ADC channel.
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WM8753ClearLineInRecPaths( WM_DEVICE_HANDLE  hDevice,
									WM_AUDIO_SIGNAL   lineInL,
									WM_AUDIO_SIGNAL   lineInR
								  );

/*-----------------------------------------------------------------------------
 * Function:    WM8753SetMicRecPaths
 *
 * Set up MIC1 path to the ADC left as the record path.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *      micSignalL      left channel microphone input to use.
 *      micSignalR      right channel microphone input to use.
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WM8753SetMicRecPaths( WM_DEVICE_HANDLE  hDevice, 
							   WM_AUDIO_SIGNAL   micSignalL,
							   WM_AUDIO_SIGNAL   micSignalR
							 );

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

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

#endif  /* WM_AUDIO */

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