Seeed Studio / USBDevice

usb device library

Fork of USBDevice by mbed official

USBAudio/USBAudio.h@4:eaa07ce86d49, 2012-10-14 (annotated)

Committer:
samux
Date:
Sun Oct 14 13:39:27 2012 +0000
Revision:
4:eaa07ce86d49
Parent:
1:80ab0d068708 
fixed doxygen typo

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 1:80ab0d068708 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
samux 1:80ab0d068708 2 *
samux 1:80ab0d068708 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 1:80ab0d068708 4 * and associated documentation files (the "Software"), to deal in the Software without
samux 1:80ab0d068708 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
samux 1:80ab0d068708 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
samux 1:80ab0d068708 7 * Software is furnished to do so, subject to the following conditions:
samux 1:80ab0d068708 8 *
samux 1:80ab0d068708 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 1:80ab0d068708 10 * substantial portions of the Software.
samux 1:80ab0d068708 11 *
samux 1:80ab0d068708 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 1:80ab0d068708 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 1:80ab0d068708 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 1:80ab0d068708 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 1:80ab0d068708 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 1:80ab0d068708 17 */
samux 1:80ab0d068708 18
samux 1:80ab0d068708 19 #ifndef USBAudio_H
samux 1:80ab0d068708 20 #define USBAudio_H
samux 1:80ab0d068708 21
samux 1:80ab0d068708 22 /* These headers are included for child class. */
samux 1:80ab0d068708 23 #include "USBEndpoints.h"
samux 1:80ab0d068708 24 #include "USBDescriptor.h"
samux 1:80ab0d068708 25 #include "USBDevice_Types.h"
samux 1:80ab0d068708 26
samux 1:80ab0d068708 27 #include "USBDevice.h"
samux 1:80ab0d068708 28
samux 1:80ab0d068708 29
samux 1:80ab0d068708 30 /**
samux 1:80ab0d068708 31 * USBAudio example
samux 1:80ab0d068708 32 *
samux 4:eaa07ce86d49 33 * @code
samux 1:80ab0d068708 34 * #include "mbed.h"
samux 1:80ab0d068708 35 * #include "USBAudio.h"
samux 1:80ab0d068708 36 *
samux 1:80ab0d068708 37 * Serial pc(USBTX, USBRX);
samux 1:80ab0d068708 38 *
samux 1:80ab0d068708 39 * // frequency: 48 kHz
samux 1:80ab0d068708 40 * #define FREQ 48000
samux 1:80ab0d068708 41 *
samux 1:80ab0d068708 42 * // 1 channel: mono
samux 1:80ab0d068708 43 * #define NB_CHA 1
samux 1:80ab0d068708 44 *
samux 1:80ab0d068708 45 * // length of an audio packet: each ms, we receive 48 * 16bits ->48 * 2 bytes. as there is one channel, the length will be 48 * 2 * 1
samux 1:80ab0d068708 46 * #define AUDIO_LENGTH_PACKET 48 * 2 * 1
samux 1:80ab0d068708 47 *
samux 1:80ab0d068708 48 * // USBAudio
samux 1:80ab0d068708 49 * USBAudio audio(FREQ, NB_CHA);
samux 1:80ab0d068708 50 *
samux 1:80ab0d068708 51 * int main() {
samux 1:80ab0d068708 52 * int16_t buf[AUDIO_LENGTH_PACKET/2];
samux 1:80ab0d068708 53 *
samux 1:80ab0d068708 54 * while (1) {
samux 1:80ab0d068708 55 * // read an audio packet
samux 1:80ab0d068708 56 * audio.read((uint8_t *)buf);
samux 1:80ab0d068708 57 *
samux 1:80ab0d068708 58 *
samux 1:80ab0d068708 59 * // print packet received
samux 1:80ab0d068708 60 * pc.printf("recv: ");
samux 1:80ab0d068708 61 * for(int i = 0; i < AUDIO_LENGTH_PACKET/2; i++) {
samux 1:80ab0d068708 62 * pc.printf("%d ", buf[i]);
samux 1:80ab0d068708 63 * }
samux 1:80ab0d068708 64 * pc.printf("\r\n");
samux 1:80ab0d068708 65 * }
samux 1:80ab0d068708 66 * }
samux 1:80ab0d068708 67 * @endcode
samux 1:80ab0d068708 68 */
samux 1:80ab0d068708 69 class USBAudio: public USBDevice {
samux 1:80ab0d068708 70 public:
samux 1:80ab0d068708 71
samux 1:80ab0d068708 72 /**
samux 1:80ab0d068708 73 * Constructor
samux 1:80ab0d068708 74 *
samux 1:80ab0d068708 75 * @param frequency_in frequency in Hz (default: 48000)
samux 1:80ab0d068708 76 * @param channel_nb_in channel number (1 or 2) (default: 1)
samux 1:80ab0d068708 77 * @param frequency_out frequency in Hz (default: 8000)
samux 1:80ab0d068708 78 * @param channel_nb_out_in channel number (1 or 2) (default: 1)
samux 1:80ab0d068708 79 * @param vendor_id Your vendor_id
samux 1:80ab0d068708 80 * @param product_id Your product_id
samux 1:80ab0d068708 81 * @param product_release Your preoduct_release
samux 1:80ab0d068708 82 */
samux 1:80ab0d068708 83 USBAudio(uint32_t frequency_in = 48000, uint8_t channel_nb_in = 1, uint32_t frequency_out = 8000, uint8_t channel_nb_out = 1, uint16_t vendor_id = 0x7bb8, uint16_t product_id = 0x1111, uint16_t product_release = 0x0100);
samux 1:80ab0d068708 84
samux 1:80ab0d068708 85 /**
samux 1:80ab0d068708 86 * Get current volume between 0.0 and 1.0
samux 1:80ab0d068708 87 *
samux 1:80ab0d068708 88 * @returns volume
samux 1:80ab0d068708 89 */
samux 1:80ab0d068708 90 float getVolume();
samux 1:80ab0d068708 91
samux 1:80ab0d068708 92 /**
samux 1:80ab0d068708 93 * Read an audio packet. During a frame, only a single reading (you can't write and read an audio packet during the same frame)can be done using this method. Warning: Blocking
samux 1:80ab0d068708 94 *
samux 1:80ab0d068708 95 * @param buf pointer on a buffer which will be filled with an audio packet
samux 1:80ab0d068708 96 *
samux 1:80ab0d068708 97 * @returns true if successfull
samux 1:80ab0d068708 98 */
samux 1:80ab0d068708 99 bool read(uint8_t * buf);
samux 1:80ab0d068708 100
samux 1:80ab0d068708 101 /**
samux 1:80ab0d068708 102 * Try to read an audio packet. During a frame, only a single reading (you can't write and read an audio packet during the same frame)can be done using this method. Warning: Non Blocking
samux 1:80ab0d068708 103 *
samux 1:80ab0d068708 104 * @param buf pointer on a buffer which will be filled if an audio packet is available
samux 1:80ab0d068708 105 *
samux 1:80ab0d068708 106 * @returns true if successfull
samux 1:80ab0d068708 107 */
samux 1:80ab0d068708 108 bool readNB(uint8_t * buf);
samux 1:80ab0d068708 109
samux 1:80ab0d068708 110 /**
samux 1:80ab0d068708 111 * Write an audio packet. During a frame, only a single writing (you can't write and read an audio packet during the same frame)can be done using this method.
samux 1:80ab0d068708 112 *
samux 1:80ab0d068708 113 * @param buf pointer on the audio packet which will be sent
samux 1:80ab0d068708 114 * @returns true if successful
samux 1:80ab0d068708 115 */
samux 1:80ab0d068708 116 bool write(uint8_t * buf);
samux 1:80ab0d068708 117
samux 1:80ab0d068708 118 /**
samux 1:80ab0d068708 119 * Write and read an audio packet at the same time (on the same frame)
samux 1:80ab0d068708 120 *
samux 1:80ab0d068708 121 * @param buf_read pointer on a buffer which will be filled with an audio packet
samux 1:80ab0d068708 122 * @param buf_write pointer on the audio packet which will be sent
samux 1:80ab0d068708 123 * @returns true if successful
samux 1:80ab0d068708 124 */
samux 1:80ab0d068708 125 bool readWrite(uint8_t * buf_read, uint8_t * buf_write);
samux 1:80ab0d068708 126
samux 1:80ab0d068708 127
samux 1:80ab0d068708 128 /** attach a handler to update the volume
samux 1:80ab0d068708 129 *
samux 1:80ab0d068708 130 * @param function Function to attach
samux 1:80ab0d068708 131 *
samux 1:80ab0d068708 132 */
samux 1:80ab0d068708 133 void attach(void(*fptr)(void)) {
samux 1:80ab0d068708 134 updateVol.attach(fptr);
samux 1:80ab0d068708 135 }
samux 1:80ab0d068708 136
samux 1:80ab0d068708 137 /** Attach a nonstatic void/void member function to update the volume
samux 1:80ab0d068708 138 *
samux 1:80ab0d068708 139 * @param tptr Object pointer
samux 1:80ab0d068708 140 * @param mptr Member function pointer
samux 1:80ab0d068708 141 *
samux 1:80ab0d068708 142 */
samux 1:80ab0d068708 143 template<typename T>
samux 1:80ab0d068708 144 void attach(T *tptr, void(T::*mptr)(void)) {
samux 1:80ab0d068708 145 updateVol.attach(tptr, mptr);
samux 1:80ab0d068708 146 }
samux 1:80ab0d068708 147
samux 1:80ab0d068708 148
samux 1:80ab0d068708 149 protected:
samux 1:80ab0d068708 150
samux 1:80ab0d068708 151 /*
samux 1:80ab0d068708 152 * Called by USBDevice layer. Set configuration of the device.
samux 1:80ab0d068708 153 * For instance, you can add all endpoints that you need on this function.
samux 1:80ab0d068708 154 *
samux 1:80ab0d068708 155 * @param configuration Number of the configuration
samux 1:80ab0d068708 156 * @returns true if class handles this request
samux 1:80ab0d068708 157 */
samux 1:80ab0d068708 158 virtual bool USBCallback_setConfiguration(uint8_t configuration);
samux 1:80ab0d068708 159
samux 1:80ab0d068708 160 /*
samux 1:80ab0d068708 161 * Called by USBDevice on Endpoint0 request. Warning: Called in ISR context
samux 1:80ab0d068708 162 * This is used to handle extensions to standard requests
samux 1:80ab0d068708 163 * and class specific requests
samux 1:80ab0d068708 164 *
samux 1:80ab0d068708 165 * @returns true if class handles this request
samux 1:80ab0d068708 166 */
samux 1:80ab0d068708 167 virtual bool USBCallback_request();
samux 1:80ab0d068708 168
samux 1:80ab0d068708 169 /*
samux 1:80ab0d068708 170 * Get string product descriptor
samux 1:80ab0d068708 171 *
samux 1:80ab0d068708 172 * @returns pointer to the string product descriptor
samux 1:80ab0d068708 173 */
samux 1:80ab0d068708 174 virtual uint8_t * stringIproductDesc();
samux 1:80ab0d068708 175
samux 1:80ab0d068708 176 /*
samux 1:80ab0d068708 177 * Get string interface descriptor
samux 1:80ab0d068708 178 *
samux 1:80ab0d068708 179 * @returns pointer to the string interface descriptor
samux 1:80ab0d068708 180 */
samux 1:80ab0d068708 181 virtual uint8_t * stringIinterfaceDesc();
samux 1:80ab0d068708 182
samux 1:80ab0d068708 183 /*
samux 1:80ab0d068708 184 * Get configuration descriptor
samux 1:80ab0d068708 185 *
samux 1:80ab0d068708 186 * @returns pointer to the configuration descriptor
samux 1:80ab0d068708 187 */
samux 1:80ab0d068708 188 virtual uint8_t * configurationDesc();
samux 1:80ab0d068708 189
samux 1:80ab0d068708 190 /*
samux 1:80ab0d068708 191 * Called by USBDevice layer. Set interface/alternate of the device.
samux 1:80ab0d068708 192 *
samux 1:80ab0d068708 193 * @param interface Number of the interface to be configured
samux 1:80ab0d068708 194 * @param alternate Number of the alternate to be configured
samux 1:80ab0d068708 195 * @returns true if class handles this request
samux 1:80ab0d068708 196 */
samux 1:80ab0d068708 197 virtual bool USBCallback_setInterface(uint16_t interface, uint8_t alternate);
samux 1:80ab0d068708 198
samux 1:80ab0d068708 199 /*
samux 1:80ab0d068708 200 * Called by USBDevice on Endpoint0 request completion
samux 1:80ab0d068708 201 * if the 'notify' flag has been set to true. Warning: Called in ISR context
samux 1:80ab0d068708 202 *
samux 1:80ab0d068708 203 * In this case it is used to indicate that a HID report has
samux 1:80ab0d068708 204 * been received from the host on endpoint 0
samux 1:80ab0d068708 205 *
samux 1:80ab0d068708 206 * @param buf buffer received on endpoint 0
samux 1:80ab0d068708 207 * @param length length of this buffer
samux 1:80ab0d068708 208 */
samux 1:80ab0d068708 209 virtual void USBCallback_requestCompleted(uint8_t * buf, uint32_t length);
samux 1:80ab0d068708 210
samux 1:80ab0d068708 211 /*
samux 1:80ab0d068708 212 * Callback called on each Start of Frame event
samux 1:80ab0d068708 213 */
samux 1:80ab0d068708 214 virtual void SOF(int frameNumber);
samux 1:80ab0d068708 215
samux 1:80ab0d068708 216 /*
samux 1:80ab0d068708 217 * Callback called when a packet is received
samux 1:80ab0d068708 218 */
samux 1:80ab0d068708 219 virtual bool EP3_OUT_callback();
samux 1:80ab0d068708 220
samux 1:80ab0d068708 221 /*
samux 1:80ab0d068708 222 * Callback called when a packet has been sent
samux 1:80ab0d068708 223 */
samux 1:80ab0d068708 224 virtual bool EP3_IN_callback();
samux 1:80ab0d068708 225
samux 1:80ab0d068708 226 private:
samux 1:80ab0d068708 227
samux 1:80ab0d068708 228 // stream available ?
samux 1:80ab0d068708 229 volatile bool available;
samux 1:80ab0d068708 230
samux 1:80ab0d068708 231 // interrupt OUT has been received
samux 1:80ab0d068708 232 volatile bool interruptOUT;
samux 1:80ab0d068708 233
samux 1:80ab0d068708 234 // interrupt IN has been received
samux 1:80ab0d068708 235 volatile bool interruptIN;
samux 1:80ab0d068708 236
samux 1:80ab0d068708 237 // audio packet has been written
samux 1:80ab0d068708 238 volatile bool writeIN;
samux 1:80ab0d068708 239
samux 1:80ab0d068708 240 // FREQ
samux 1:80ab0d068708 241 uint32_t FREQ_OUT;
samux 1:80ab0d068708 242 uint32_t FREQ_IN;
samux 1:80ab0d068708 243
samux 1:80ab0d068708 244 // size of the maximum packet for the isochronous endpoint
samux 1:80ab0d068708 245 uint32_t PACKET_SIZE_ISO_IN;
samux 1:80ab0d068708 246 uint32_t PACKET_SIZE_ISO_OUT;
samux 1:80ab0d068708 247
samux 1:80ab0d068708 248 // mono, stereo,...
samux 1:80ab0d068708 249 uint8_t channel_nb_in;
samux 1:80ab0d068708 250 uint8_t channel_nb_out;
samux 1:80ab0d068708 251
samux 1:80ab0d068708 252 // channel config: master, left, right
samux 1:80ab0d068708 253 uint8_t channel_config_in;
samux 1:80ab0d068708 254 uint8_t channel_config_out;
samux 1:80ab0d068708 255
samux 1:80ab0d068708 256 // mute state
samux 1:80ab0d068708 257 uint8_t mute;
samux 1:80ab0d068708 258
samux 1:80ab0d068708 259 // Volume Current Value
samux 1:80ab0d068708 260 uint16_t volCur;
samux 1:80ab0d068708 261
samux 1:80ab0d068708 262 // Volume Minimum Value
samux 1:80ab0d068708 263 uint16_t volMin;
samux 1:80ab0d068708 264
samux 1:80ab0d068708 265 // Volume Maximum Value
samux 1:80ab0d068708 266 uint16_t volMax;
samux 1:80ab0d068708 267
samux 1:80ab0d068708 268 // Volume Resolution
samux 1:80ab0d068708 269 uint16_t volRes;
samux 1:80ab0d068708 270
samux 1:80ab0d068708 271 // Buffer containing one audio packet (to be read)
samux 1:80ab0d068708 272 volatile uint8_t * buf_stream_in;
samux 1:80ab0d068708 273
samux 1:80ab0d068708 274 // Buffer containing one audio packet (to be written)
samux 1:80ab0d068708 275 volatile uint8_t * buf_stream_out;
samux 1:80ab0d068708 276
samux 1:80ab0d068708 277 // callback to update volume
samux 1:80ab0d068708 278 FunctionPointer updateVol;
samux 1:80ab0d068708 279
samux 1:80ab0d068708 280 // boolean showing that the SOF handler has been called. Useful for readNB.
samux 1:80ab0d068708 281 volatile bool SOF_handler;
samux 1:80ab0d068708 282
samux 1:80ab0d068708 283 volatile float volume;
samux 1:80ab0d068708 284
samux 1:80ab0d068708 285 };
samux 1:80ab0d068708 286
samux 1:80ab0d068708 287 #endif