libguac  0.8.4
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
audio.h
Go to the documentation of this file.
1 
2 /* ***** BEGIN LICENSE BLOCK *****
3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4  *
5  * The contents of this file are subject to the Mozilla Public License Version
6  * 1.1 (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  * http://www.mozilla.org/MPL/
9  *
10  * Software distributed under the License is distributed on an "AS IS" basis,
11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12  * for the specific language governing rights and limitations under the
13  * License.
14  *
15  * The Original Code is libguac.
16  *
17  * The Initial Developer of the Original Code is
18  * Michael Jumper.
19  * Portions created by the Initial Developer are Copyright (C) 2010
20  * the Initial Developer. All Rights Reserved.
21  *
22  * Contributor(s):
23  *
24  * Alternatively, the contents of this file may be used under the terms of
25  * either the GNU General Public License Version 2 or later (the "GPL"), or
26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27  * in which case the provisions of the GPL or the LGPL are applicable instead
28  * of those above. If you wish to allow use of your version of this file only
29  * under the terms of either the GPL or the LGPL, and not to allow others to
30  * use your version of this file under the terms of the MPL, indicate your
31  * decision by deleting the provisions above and replace them with the notice
32  * and other provisions required by the GPL or the LGPL. If you do not delete
33  * the provisions above, a recipient may use your version of this file under
34  * the terms of any one of the MPL, the GPL or the LGPL.
35  *
36  * ***** END LICENSE BLOCK ***** */
37 
38 #ifndef __GUAC_AUDIO_H
39 #define __GUAC_AUDIO_H
40 
41 #include <guacamole/client.h>
42 #include <guacamole/stream.h>
43 
51 
56 
61 
66  const unsigned char* pcm_data, int length);
67 
71 typedef struct guac_audio_encoder {
72 
77  const char* mimetype;
78 
83 
88 
93 
95 
102 
106  unsigned char* pcm_data;
107 
111  int used;
112 
116  int length;
117 
121  unsigned char* encoded_data;
122 
127 
132 
138 
143 
148 
152  int rate;
153 
158  int channels;
159 
164  int bps;
165 
170 
174  void* data;
175 
176 };
177 
193  guac_audio_encoder* encoder);
194 
201 
212 void guac_audio_stream_begin(guac_audio_stream* stream, int rate, int channels, int bps);
213 
222 
234  const unsigned char* data, int length);
235 
242 
254  const unsigned char* data, int length);
255 
256 #endif
257 
void guac_audio_stream_write_encoded(guac_audio_stream *audio, const unsigned char *data, int length)
Appends arbitrarily-encoded data to the encoded_data buffer within the given audio stream...
int bps
The number of bits per sample per channel for PCM data.
Definition: audio.h:164
void guac_audio_encoder_write_handler(guac_audio_stream *audio, const unsigned char *pcm_data, int length)
Handler which is called when the audio stream is flushed.
Definition: audio.h:65
int encoded_data_used
Number of bytes in the encoded data buffer.
Definition: audio.h:126
guac_audio_encoder * encoder
Arbitrary codec encoder.
Definition: audio.h:137
guac_audio_encoder_begin_handler * begin_handler
Handler which will be called when the audio stream is opened.
Definition: audio.h:82
void guac_audio_stream_write_pcm(guac_audio_stream *stream, const unsigned char *data, int length)
Writes PCM data to the given audio stream.
int used
Number of bytes in buffer.
Definition: audio.h:111
Provides functions and structures required for allocating and using nested streams.
guac_client * client
The client associated with this audio stream.
Definition: audio.h:142
guac_audio_encoder_write_handler * write_handler
Handler which will be called when the audio stream is flushed.
Definition: audio.h:87
void guac_audio_stream_flush(guac_audio_stream *stream)
Flushes the given audio stream.
guac_stream * stream
The actual stream associated with this audio stream.
Definition: audio.h:147
void guac_audio_stream_end(guac_audio_stream *stream)
Ends the current audio packet, writing the finished packet as an audio instruction.
void guac_audio_stream_free(guac_audio_stream *stream)
Frees the given audio stream.
void * data
Encoder-specific state data.
Definition: audio.h:174
Guacamole proxy client.
Definition: client.h:215
const char * mimetype
The mimetype of the audio data encoded by this audio encoder.
Definition: audio.h:77
Basic audio stream.
Definition: audio.h:101
unsigned char * encoded_data
Encoded audio data buffer, as written by the encoder.
Definition: audio.h:121
int rate
The number of samples per second of PCM data sent to this stream.
Definition: audio.h:152
int encoded_data_length
Maximum number of bytes in the encoded data buffer.
Definition: audio.h:131
Arbitrary audio codec encoder.
Definition: audio.h:71
guac_audio_encoder_end_handler * end_handler
Handler which will be called when the audio stream is closed.
Definition: audio.h:92
Represents a single nested stream within the Guacamole protocol.
Definition: stream.h:53
int length
Maximum number of bytes in buffer.
Definition: audio.h:116
void guac_audio_stream_begin(guac_audio_stream *stream, int rate, int channels, int bps)
Begins a new audio packet within the given audio stream.
Provides functions and structures required for defining (and handling) a proxy client.
void guac_audio_encoder_begin_handler(guac_audio_stream *audio)
Handler which is called when the audio stream is opened.
Definition: audio.h:55
unsigned char * pcm_data
PCM data buffer, 16-bit samples, 2-channel, 44100 Hz.
Definition: audio.h:106
guac_audio_stream * guac_audio_stream_alloc(guac_client *client, guac_audio_encoder *encoder)
Allocates a new audio stream which encodes audio data using the given encoder.
void guac_audio_encoder_end_handler(guac_audio_stream *audio)
Handler which is called when the audio stream is closed.
Definition: audio.h:60
int channels
The number of audio channels per sample of PCM data.
Definition: audio.h:158
int pcm_bytes_written
The number of PCM bytes written since the audio chunk began.
Definition: audio.h:169