Audio.h 12.7 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in 
  all copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting 
  documentation, and that the name of the author not be used in 
  advertising or publicity pertaining to distribution of the 
19
20
21
22
23
24
25
26
27
28
29
30
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

31
32
/** \ingroup Group_USBClassAudio
 *  @defgroup Group_USBClassAudioDevice Audio Class Device Mode Driver
33
 *
34
35
36
37
 *  \section Sec_Dependencies Module Source Dependencies
 *  The following files must be built with any user project that uses this module:
 *    - LUFA/Drivers/USB/Class/Device/Audio.c
 *
38
 *  \section Module Description
39
 *  Device Mode USB Class driver framework interface, for the Audio USB Class driver.
40
41
42
43
 *
 *  @{
 */

44
45
#ifndef _AUDIO_CLASS_DEVICE_H_
#define _AUDIO_CLASS_DEVICE_H_
46
47
48

	/* Includes: */
		#include "../../USB.h"
49
50
		#include "../Common/Audio.h"
		
51
52
		#include <string.h>

53
54
55
56
57
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

58
	/* Public Interface - May be used in end-application: */
59
		/* Type Defines: */		
60
61
62
63
64
65
			/** Class state structure. An instance of this structure should be made for each Audio interface
			 *  within the user application, and passed to each of the Audio class driver functions as the
			 *  AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information.
			 */
			typedef struct
			{
66
67
68
				const struct
				{
					uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this
69
														*   structure controls
70
71
														*/

72
					uint8_t  DataINEndpointNumber; /**< Endpoint number of the incoming Audio Streaming data, if available
73
													*   (zero if unused)
74
													*/
75
					uint16_t DataINEndpointSize; /**< Size in bytes of the incoming Audio Streaming data endpoint, if available
76
												  *   (zero if unused)
77
78
79
												  */

					uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing Audio Streaming data, if available
80
													 *   (zero if unused)
81
82
													 */
					uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available
83
												   *   (zero if unused)
84
85
86
87
88
89
90
91
92
93
												   */			
				} Config; /**< Config data for the USB class interface within the device. All elements in this section
				           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
				           */
				struct
				{
					bool     InterfaceEnabled; /**< Set and cleared by the class driver to indicate if the host has enabled the streaming endpoints
												*   of the Audio Streaming interface.
												*/
				} State; /**< State data for the USB class interface within the device. All elements in this section
94
				          *   are reset to their defaults when the interface is enumerated.
95
				          */				
96
97
			} USB_ClassInfo_Audio_Device_t;
		
98
99
		/* Function Prototypes: */
			/** Configures the endpoints of a given Audio interface, ready for use. This should be linked to the library
100
			 *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the
101
102
			 *  given Audio interface is selected.
			 *
103
			 *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
104
			 *
105
			 *  \return Boolean true if the endpoints were successfully configured, false otherwise
106
			 */
107
			bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
108

109
			/** Processes incoming control requests from the host, that are directed to the given Audio class interface. This should be
110
			 *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
111
			 *
112
			 *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
113
			 */
114
			void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
115
			
116
117
118
			/** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
			 *  OUT endpoint ready for reading.
			 *
119
120
121
			 *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
			 *        the call will fail.
			 *
122
			 *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
123
124
125
126
127
128
129
130
			 *
			 *  \return Boolean true if the given Audio interface has a sample to be read, false otherwise
			 */
			bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);

			/** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
			 *  the streaming IN endpoint ready for writing.
			 *
131
132
133
			 *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
			 *        the call will fail.
			 *
134
			 *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
135
136
137
138
139
140
			 *
			 *  \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise
			 */
			bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);

		/* Inline Functions: */
141
142
143
144
145
146
147
148
149
150
151
			/** General management task for a given Audio class interface, required for the correct operation of the interface. This should
			 *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
			 *
			 *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
			 */
			static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);
			static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
			{
				(void)AudioInterfaceInfo;
			}

152
153
			/** Reads the next 8-bit audio sample from the current audio interface.
			 *
154
			 *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
155
156
			 *        the correct endpoint is selected and ready for data.
			 *
157
			 *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
158
			 *
159
160
			 *  \return  Signed 8-bit audio sample from the audio interface
			 */
161
162
163
164
			static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
			static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
			{
				int8_t Sample;
165
166
				
				(void)AudioInterfaceInfo;
167
168
169
170
171
172
173
174

				Sample = Endpoint_Read_Byte();

				if (!(Endpoint_BytesInEndpoint()))
				  Endpoint_ClearOUT();
				
				return Sample;
			}
175
176
177

			/** Reads the next 16-bit audio sample from the current audio interface.
			 *
178
			 *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
179
180
			 *        the correct endpoint is selected and ready for data.
			 *
181
			 *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
182
			 *
183
184
			 *  \return  Signed 16-bit audio sample from the audio interface
			 */
185
186
187
188
189
			static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
			static inline int16_t Audio_Device_ReadSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
			{
				int16_t Sample;

190
191
				(void)AudioInterfaceInfo;

192
193
194
195
196
197
198
				Sample = (int16_t)Endpoint_Read_Word_LE();
					  
				if (!(Endpoint_BytesInEndpoint()))
				  Endpoint_ClearOUT();

				return Sample;
			}
199
200
201

			/** Reads the next 24-bit audio sample from the current audio interface.
			 *
202
			 *  \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that
203
204
			 *        the correct endpoint is selected and ready for data.
			 *
205
			 *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
206
207
			 *  \return  Signed 24-bit audio sample from the audio interface
			 */
208
209
210
211
212
			static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;
			static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
			{
				int32_t Sample;

213
214
				(void)AudioInterfaceInfo;

215
216
217
218
219
220
221
				Sample = (((uint32_t)Endpoint_Read_Byte() << 16) | Endpoint_Read_Word_LE());
					  
				if (!(Endpoint_BytesInEndpoint()))
				  Endpoint_ClearOUT();

				return Sample;
			}
222
223
224

			/** Writes the next 8-bit audio sample to the current audio interface.
			 *
225
			 *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
226
227
			 *        the correct endpoint is selected and ready for data.
			 *
228
			 *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
229
			 *  \param[in] Sample  Signed 8-bit audio sample
230
			 */
231
232
233
234
235
236
237
238
239
240
			static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
			                                             const int8_t Sample) ATTR_ALWAYS_INLINE;
			static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
			                                             const int8_t Sample)
			{
				Endpoint_Write_Byte(Sample);

				if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
				  Endpoint_ClearIN();
			}
241
242
243

			/** Writes the next 16-bit audio sample to the current audio interface.
			 *
244
			 *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
245
246
			 *        the correct endpoint is selected and ready for data.
			 *
247
			 *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
248
			 *  \param[in] Sample  Signed 16-bit audio sample
249
			 */
250
251
252
253
254
255
256
257
258
259
			static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
			                                              const int16_t Sample) ATTR_ALWAYS_INLINE;
			static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
			                                              const int16_t Sample)
			{
				Endpoint_Write_Word_LE(Sample);

				if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
				  Endpoint_ClearIN();
			}
260
261
262

			/** Writes the next 24-bit audio sample to the current audio interface.
			 *
263
			 *  \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that
264
265
			 *        the correct endpoint is selected and ready for data.
			 *
266
			 *  \param[in,out] AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state
267
			 *  \param[in] Sample  Signed 24-bit audio sample
268
			 */
269
270
271
272
273
274
275
			static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
			                                              const int32_t Sample) ATTR_ALWAYS_INLINE;
			static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
			                                              const int32_t Sample)
			{
				Endpoint_Write_Byte(Sample >> 16);
				Endpoint_Write_Word_LE(Sample);
276

277
278
279
				if (Endpoint_BytesInEndpoint() == AudioInterfaceInfo->Config.DataINEndpointSize)
				  Endpoint_ClearIN();
			}
280
281
282
283
284
285

	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
		
286
#endif
287
288

/** @} */