xref: /btstack/platform/posix/wav_util.h (revision 86d6811aca843473b9a93ecebb7d71bc45fb6146)
1 /*
2  * Copyright (C) 2016 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. 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  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
24  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 #ifndef WAV_UIL_H
39 #define WAV_UIL_H
40 
41 #include <stdint.h>
42 
43 #if defined __cplusplus
44 extern "C" {
45 #endif
46 
47 // return 0 if ok
48 
49 /**
50  * Open singleton wav writer
51  * @return 0 if ok
52  */
53 int wav_writer_open(const char * filepath, int num_channels, int sampling_frequency);
54 /**
55  * Write Int8 samples
56  * @return 0 if ok
57  */
58 int wav_writer_write_int8(int num_samples, int8_t * data);
59 /**
60  * Write Int16 samples (host endianess)
61  * @return 0 if ok
62  */
63 int wav_writer_write_int16(int num_samples, int16_t * data);
64 /**
65  * Write Little Endian Int16 samples
66  * @return 0 if ok
67  */
68 int wav_writer_write_le_int16(int num_samples, int16_t * data);
69 /**
70  * Close wav writer and update wav file header
71  * @return 0 if ok
72  */
73 int wav_writer_close(void);
74 
75 
76 /**
77  * Open singleton wav reader
78  * @return 0 if ok
79  */
80 int wav_reader_open(const char * filepath);
81 
82 /**
83  * Get number of channels
84  */
85 uint8_t wav_reader_get_num_channels(void);
86 
87 /**
88  * Get sampling rate
89  */
90 uint32_t wav_reader_get_sampling_rate(void);
91 
92 /**
93  * Read Int8 samples
94  * @return 0 if ok
95  */
96 int wav_reader_read_int8(int num_samples, int8_t * data);
97 /**
98  * Read Int16 samples (host endianess)
99  * @return 0 if ok
100  */
101 int wav_reader_read_int16(int num_samples, int16_t * data);
102 /**
103  * Close war reader
104  * @return 0 if ok
105  */
106 int wav_reader_close(void);
107 
108 #if defined __cplusplus
109 }
110 #endif
111 
112 #endif // WAV_UTIL_H
113