packaging: bumped version, updated changelog.
[profile/ivi/speech-recognition.git] / src / daemon / audiobuf.h
1 /*
2  * Copyright (c) 2012, Intel Corporation
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *   * Redistributions of source code must retain the above copyright notice,
9  *     this list of conditions and the following disclaimer.
10  *   * Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *   * Neither the name of Intel Corporation nor the names of its contributors
14  *     may be used to endorse or promote products derived from this software
15  *     without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef __SRS_DAEMON_AUDIOBUF_H__
31 #define __SRS_DAEMON_AUDIOBUF_H__
32
33 #include <murphy/common/refcnt.h>
34 #include <pulse/sample.h>
35
36 /*
37  * audio formats
38  */
39
40 typedef enum {
41 #define MAP(type) SRS_AUDIO_##type = PA_SAMPLE_##type
42     MAP(INVALID),
43     MAP(U8),
44     MAP(ALAW),
45     MAP(ULAW),
46     MAP(S16LE),
47     MAP(S16BE),
48     MAP(FLOAT32LE),
49     MAP(FLOAT32BE),
50     MAP(S32LE),
51     MAP(S32BE),
52     MAP(S24LE),
53     MAP(S24BE),
54     MAP(S24_32LE),
55     MAP(S24_32BE),
56     MAP(MAX),
57 #undef MAP
58 } srs_audioformat_t;
59
60
61 /*
62  * a reference-counted audio buffer
63  */
64
65 typedef struct {
66     mrp_refcnt_t       refcnt;           /* reference count */
67     srs_audioformat_t  format;           /* audio format */
68     uint32_t           rate;             /* sample rate */
69     uint8_t            channels;         /* number of channels */
70     size_t             samples;          /* amount of sample data */
71     void              *data;             /* actual sample data */
72 } srs_audiobuf_t;
73
74 /** Create a new audio buffer. */
75 srs_audiobuf_t *srs_create_audiobuf(srs_audioformat_t format, uint32_t rate,
76                                     uint8_t channels, size_t samples,
77                                     void *data);
78
79 /** Add a reference to the given audio buffer. */
80 srs_audiobuf_t *srs_ref_audiobuf(srs_audiobuf_t *buf);
81
82 /** Remove a reference from the given audio buffer, potentially freeing it. */
83 void srs_unref_audiobuf(srs_audiobuf_t *buf);
84
85 #endif /* __SRS_DAEMON_AUDIOBUF_H__ */