summaryrefslogtreecommitdiff
path: root/usblib/host/usbhaudio.h
blob: a12e97e3bee40a150eef9a90ae76f601709738a0 (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
//*****************************************************************************
//
// usbhaudio.h - USB host audio class driver.
//
// Copyright (c) 2010-2012 Texas Instruments Incorporated.  All rights reserved.
// Software License Agreement
// 
// Texas Instruments (TI) is supplying this software for use solely and
// exclusively on TI's microcontroller products. The software is owned by
// TI and/or its suppliers, and is protected under applicable copyright
// laws. You may not combine this software with "viral" open-source
// software in order to form a larger program.
// 
// THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
// NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
// NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
// CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
// DAMAGES, FOR ANY REASON WHATSOEVER.
// 
// This is part of revision 9453 of the Stellaris USB Library.
//
//*****************************************************************************

#ifndef __USBHAUDIO_H__
#define __USBHAUDIO_H__

//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif

//*****************************************************************************
//
//! \addtogroup usblib_host_class
//! @{
//
//*****************************************************************************

typedef void (* tUSBHostAudioCallback)(void *pvBuffer,
                                       unsigned long ulParam,
                                       unsigned long ulEvent);

//*****************************************************************************
//
//! This is the size in bytes of the private data for the host audio class.
//
//*****************************************************************************
#define USB_HOST_AUDIO_INSTANCE_SIZE sizeof(tHostAudioInstance);

//*****************************************************************************
//
// USB host audio specific events
//
//*****************************************************************************

//*****************************************************************************
//
//! This USB host audio event indicates that the device is connected and
//! ready to send or receive buffers.  The \e pvBuffer and \e ulParam
//! values are not used in this event.
//
//*****************************************************************************
#define USBH_AUDIO_EVENT_OPEN   (USBH_AUDIO_EVENT_BASE + 0)

//*****************************************************************************
//
//! This USB host audio event indicates that the previously connected device
//! has been disconnected. The \e pvBuffer and \e ulParam values are not used
//! in this event.
//
//*****************************************************************************
#define USBH_AUDIO_EVENT_CLOSE  (USBH_AUDIO_EVENT_BASE + 1)

//*****************************************************************************
//
// This definition is used with the USBHostAudioFormatGet() and
// USBHostAudioFormatSet() API's to determine if the audio input is being
// accesses(USBH_AUDIO_FORMAT_IN set) or audio output(USBH_AUDIO_FORMAT clear).
//
//*****************************************************************************
#define USBH_AUDIO_FORMAT_IN    0x00000001
#define USBH_AUDIO_FORMAT_OUT   0x00000000

typedef struct
{
    unsigned char ucChannels;
    unsigned char ucBits;
    unsigned long ulSampleRate;
} tUSBAudioFormat;

//*****************************************************************************
//
// API Function Prototypes
//
//*****************************************************************************
extern unsigned long USBHostAudioOpen(unsigned long ulIndex,
                                      tUSBHostAudioCallback pfnCallback);
extern void USBHostAudioClose(unsigned long ulInstance);
extern long USBHostAudioPlay(unsigned long ulInstance, void *pvBuffer,
                             unsigned long ulSize,
                             tUSBHostAudioCallback pfnCallback);

extern unsigned long USBHostAudioFormatGet(unsigned long ulInstance,
                                           unsigned long ulSampleRate,
                                           unsigned long ulBits,
                                           unsigned long ulChannels,
                                           unsigned long ulFlags);
extern unsigned long USBHostAudioFormatSet(unsigned long ulInstance,
                                           unsigned long ulSampleRate,
                                           unsigned long ulBits,
                                           unsigned long ulChannels,
                                           unsigned long ulFlags);

extern long USBHostAudioRecord(unsigned long ulInstance, void *pvBuffer,
                               unsigned long ulSize,
                               tUSBHostAudioCallback);

extern unsigned long USBHostAudioVolumeGet(unsigned long ulInstance,
                                           unsigned long ulInterface,
                                           unsigned long ulChannel);

extern void USBHostAudioVolumeSet(unsigned long ulInstance,
                                  unsigned ulInterface,
                                  unsigned long ulChannel,
                                  unsigned long ulValue);

extern unsigned long USBHostAudioVolumeMaxGet(unsigned long ulInstance,
                                              unsigned long ulInterface,
                                              unsigned long ulChannel);

extern unsigned long USBHostAudioVolumeMinGet(unsigned long ulInstance,
                                              unsigned long ulInterface,
                                              unsigned long ulChannel);

extern unsigned long USBHostAudioVolumeResGet(unsigned long ulInstance,
                                              unsigned long ulInterface,
                                              unsigned long ulChannel);

//*****************************************************************************
//
//! @}
//
//*****************************************************************************

//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif

#endif