summaryrefslogtreecommitdiff
path: root/usb/device/audio-looprec/AUDDLoopRecDriver.h
blob: 8db30a12a778f867eac9fe4c0eccb5f92122ec23 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
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