summaryrefslogtreecommitdiff
path: root/usb/device/audio-looprec/AUDDLoopRecDriver.h
diff options
context:
space:
mode:
Diffstat (limited to 'usb/device/audio-looprec/AUDDLoopRecDriver.h')
-rw-r--r--usb/device/audio-looprec/AUDDLoopRecDriver.h163
1 files changed, 163 insertions, 0 deletions
diff --git a/usb/device/audio-looprec/AUDDLoopRecDriver.h b/usb/device/audio-looprec/AUDDLoopRecDriver.h
new file mode 100644
index 0000000..8db30a1
--- /dev/null
+++ b/usb/device/audio-looprec/AUDDLoopRecDriver.h
@@ -0,0 +1,163 @@
+/* ----------------------------------------------------------------------------
+ * ATMEL Microcontroller Software Support
+ * ----------------------------------------------------------------------------
+ * Copyright (c) 2008, Atmel Corporation
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * - Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the disclaimer below.
+ *
+ * Atmel's name may not be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
+ * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+ * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+ * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * ----------------------------------------------------------------------------
+ */
+
+/**
+ \unit
+
+ !Purpose
+
+ Definition of a USB Audio Loop Record Driver with two playback channels
+ and one record channel.
+
+ !Usage
+
+ -# Enable and setup USB related pins (see pio & board.h).
+ -# Configure the USB Audio Loop Record driver using
+ AUDDLoopRecDriver_Initialize
+ -# To get %audio stream frames from host, use
+ AUDDLoopRecDriver_Read
+ -# To send %audio sampling stream to host, use
+ AUDDLoopRecDriver_Write
+
+*/
+
+#ifndef AUDDLoopRecDriver_H
+#define AUDDLoopRecDriver_H
+
+//------------------------------------------------------------------------------
+// Headers
+//------------------------------------------------------------------------------
+
+#include <board.h>
+#include <usb/common/core/USBGenericRequest.h>
+#include <usb/device/core/USBD.h>
+
+//------------------------------------------------------------------------------
+// Definitions
+//------------------------------------------------------------------------------
+
+//------------------------------------------------------------------------------
+/// \page "Audio Loop Record stream information"
+///
+/// This page lists codes for USB Audio Loop Record stream information.
+///
+/// !Code
+/// - AUDDLoopRecDriver_SAMPLERATE
+/// - AUDDLoopRecDriver_NUMCHANNELS
+/// - AUDDLoopRecDriver_BYTESPERSAMPLE
+/// - AUDDLoopRecDriver_BITSPERSAMPLE
+/// - AUDDLoopRecDriver_SAMPLESPERFRAME
+/// - AUDDLoopRecDriver_BYTESPERFRAME
+
+#if defined(at91sam7s) || defined(at91sam9xe)
+ /// Sample rate in Hz.
+ #define AUDDLoopRecDriver_SAMPLERATE 32000
+ /// Number of channels in audio stream.
+ #define AUDDLoopRecDriver_NUMCHANNELS 1
+ /// Number of bytes in one sample.
+ #define AUDDLoopRecDriver_BYTESPERSAMPLE 2
+#else
+ /// Sample rate in Hz.
+ #define AUDDLoopRecDriver_SAMPLERATE 48000
+ /// Number of channels in audio stream.
+ #define AUDDLoopRecDriver_NUMCHANNELS 2
+ /// Number of bytes in one sample.
+ #define AUDDLoopRecDriver_BYTESPERSAMPLE 2
+#endif
+/// Number of bits in one sample.
+#define AUDDLoopRecDriver_BITSPERSAMPLE (AUDDLoopRecDriver_BYTESPERSAMPLE * 8)
+/// Number of bytes in one USB subframe.
+#define AUDDLoopRecDriver_BYTESPERSUBFRAME (AUDDLoopRecDriver_NUMCHANNELS * \
+ AUDDLoopRecDriver_BYTESPERSAMPLE)
+/// Number of samples in one USB frame.
+#define AUDDLoopRecDriver_SAMPLESPERFRAME (AUDDLoopRecDriver_SAMPLERATE / 1000 \
+ * AUDDLoopRecDriver_NUMCHANNELS)
+/// Number of bytes in one USB frame.
+#define AUDDLoopRecDriver_BYTESPERFRAME (AUDDLoopRecDriver_SAMPLESPERFRAME * \
+ AUDDLoopRecDriver_BYTESPERSAMPLE)
+//------------------------------------------------------------------------------
+
+//------------------------------------------------------------------------------
+/// \page "Audio Loop Record Channel Numbers"
+///
+/// This page lists codes for USB Audio Loop Record channel numbers.
+///
+/// !Playback channel numbers
+/// - AUDDLoopRecDriver_MASTERCHANNEL
+/// - AUDDLoopRecDriver_LEFTCHANNEL
+/// - AUDDLoopRecDriver_RIGHTCHANNEL
+///
+/// !Record channel number
+/// - AUDDLoopRecDriver_RECCHANNEL
+
+/// Master channel of playback.
+#define AUDDLoopRecDriver_MASTERCHANNEL 0
+/// Front left channel of playback.
+#define AUDDLoopRecDriver_LEFTCHANNEL 1
+/// Front right channel of playback.
+#define AUDDLoopRecDriver_RIGHTCHANNEL 2
+/// Channel of record.
+#define AUDDLoopRecDriver_RECCHANNEL 0
+//------------------------------------------------------------------------------
+
+//------------------------------------------------------------------------------
+/// Callback function for audio frames.
+/// \param pArg Pointer to transfer arguments.
+/// \param status Frame transfer status.
+/// \return 1 to continue, 0 to stop frames.
+//------------------------------------------------------------------------------
+typedef char (*AUDDFrameTransferCallback)(void* pArg, char status);
+
+//------------------------------------------------------------------------------
+// Exported functions
+//------------------------------------------------------------------------------
+
+extern void AUDDLoopRecDriver_Initialize();
+
+extern void AUDDLoopRecDriver_RequestHandler(const USBGenericRequest *request);
+
+extern unsigned char AUDDLoopRecDriver_Read(void *buffer,
+ unsigned int length,
+ TransferCallback callback,
+ void *argument);
+
+extern void AUDDLoopRecDriver_SetupWriteMbl(void * pMultiBufferList,
+ unsigned char **pBufferList,
+ unsigned short listSize,
+ unsigned short frameSize);
+
+extern unsigned char AUDDLoopRecDriver_Write(void * pMbl,
+ unsigned short listSize,
+ AUDDFrameTransferCallback callback,
+ void *argument);
+
+extern void AUDDLoopRecDriver_RemoteWakeUp(void);
+
+#endif //#ifndef AUDDLoopRecDriver_H
+
personal git repositories of Harald Welte. Your mileage may vary