Brandon Yee / Mbed 2 deprecated Slingshot

Slingshot Controller

Dependencies:   ADXL345 DebounceIn USBDevice mbed

USBDevice/USBAudio/USBAudio.h@1:2721dc2acc2c, 2012-10-17 (annotated)

Committer:
Brandon
Date:
Wed Oct 17 16:33:04 2012 +0000
Revision:
1:2721dc2acc2c
Parent:
0:cf17ea89fd09 
Updated comments, added names, cleaned old code.

Who changed what in which revision?

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