xref: /aosp_15_r20/external/liblc3/tools/wave.h (revision 49fe348c0058011ee60b6957cdd9d52742df84bc)
1*49fe348cSAndroid Build Coastguard Worker /******************************************************************************
2*49fe348cSAndroid Build Coastguard Worker  *
3*49fe348cSAndroid Build Coastguard Worker  *  Copyright 2022 Google LLC
4*49fe348cSAndroid Build Coastguard Worker  *
5*49fe348cSAndroid Build Coastguard Worker  *  Licensed under the Apache License, Version 2.0 (the "License");
6*49fe348cSAndroid Build Coastguard Worker  *  you may not use this file except in compliance with the License.
7*49fe348cSAndroid Build Coastguard Worker  *  You may obtain a copy of the License at:
8*49fe348cSAndroid Build Coastguard Worker  *
9*49fe348cSAndroid Build Coastguard Worker  *  http://www.apache.org/licenses/LICENSE-2.0
10*49fe348cSAndroid Build Coastguard Worker  *
11*49fe348cSAndroid Build Coastguard Worker  *  Unless required by applicable law or agreed to in writing, software
12*49fe348cSAndroid Build Coastguard Worker  *  distributed under the License is distributed on an "AS IS" BASIS,
13*49fe348cSAndroid Build Coastguard Worker  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14*49fe348cSAndroid Build Coastguard Worker  *  See the License for the specific language governing permissions and
15*49fe348cSAndroid Build Coastguard Worker  *  limitations under the License.
16*49fe348cSAndroid Build Coastguard Worker  *
17*49fe348cSAndroid Build Coastguard Worker  ******************************************************************************/
18*49fe348cSAndroid Build Coastguard Worker 
19*49fe348cSAndroid Build Coastguard Worker #ifndef __WAVE_H
20*49fe348cSAndroid Build Coastguard Worker #define __WAVE_H
21*49fe348cSAndroid Build Coastguard Worker 
22*49fe348cSAndroid Build Coastguard Worker #include <stdio.h>
23*49fe348cSAndroid Build Coastguard Worker #include <stdint.h>
24*49fe348cSAndroid Build Coastguard Worker 
25*49fe348cSAndroid Build Coastguard Worker 
26*49fe348cSAndroid Build Coastguard Worker /**
27*49fe348cSAndroid Build Coastguard Worker  * Read WAVE file header
28*49fe348cSAndroid Build Coastguard Worker  * fp              Opened file, moved after header on return
29*49fe348cSAndroid Build Coastguard Worker  * bitdepth        Return bitdepth
30*49fe348cSAndroid Build Coastguard Worker  * samplesize      Return size of samples, in bytes
31*49fe348cSAndroid Build Coastguard Worker  * samplerate      Return samplerate, in Hz
32*49fe348cSAndroid Build Coastguard Worker  * nchannels       Return number of channels
33*49fe348cSAndroid Build Coastguard Worker  * nframes         Return count of frames
34*49fe348cSAndroid Build Coastguard Worker  * return          0: Ok  -1: Bad or unsupported WAVE File
35*49fe348cSAndroid Build Coastguard Worker  */
36*49fe348cSAndroid Build Coastguard Worker int wave_read_header(FILE *fp, int *bitdepth, int *samplesize,
37*49fe348cSAndroid Build Coastguard Worker     int *samplerate, int *nchannels, int *nframes);
38*49fe348cSAndroid Build Coastguard Worker 
39*49fe348cSAndroid Build Coastguard Worker /**
40*49fe348cSAndroid Build Coastguard Worker  * Read PCM samples from wave file
41*49fe348cSAndroid Build Coastguard Worker  * fp              Opened file
42*49fe348cSAndroid Build Coastguard Worker  * samplesize      Size of samples, in bytes
43*49fe348cSAndroid Build Coastguard Worker  * nch, count      Number of channels and count of frames to read
44*49fe348cSAndroid Build Coastguard Worker  * buffer          Output buffer of `nchannels * count` interleaved samples
45*49fe348cSAndroid Build Coastguard Worker  * return          Number of frames read
46*49fe348cSAndroid Build Coastguard Worker  */
47*49fe348cSAndroid Build Coastguard Worker int wave_read_pcm(FILE *fp, int samplesize,
48*49fe348cSAndroid Build Coastguard Worker     int nch, int count, void *_buffer);
49*49fe348cSAndroid Build Coastguard Worker 
50*49fe348cSAndroid Build Coastguard Worker /**
51*49fe348cSAndroid Build Coastguard Worker  * Write WAVE file header
52*49fe348cSAndroid Build Coastguard Worker  * fp              Opened file, moved after header on return
53*49fe348cSAndroid Build Coastguard Worker  * bitdepth        Bitdepth
54*49fe348cSAndroid Build Coastguard Worker  * samplesize      Size of samples
55*49fe348cSAndroid Build Coastguard Worker  * samplerate      Samplerate, in Hz
56*49fe348cSAndroid Build Coastguard Worker  * nchannels       Number of channels
57*49fe348cSAndroid Build Coastguard Worker  * nframes         Count of frames
58*49fe348cSAndroid Build Coastguard Worker  */
59*49fe348cSAndroid Build Coastguard Worker void wave_write_header(FILE *fp, int bitdepth, int samplesize,
60*49fe348cSAndroid Build Coastguard Worker     int samplerate, int nchannels, int nframes);
61*49fe348cSAndroid Build Coastguard Worker 
62*49fe348cSAndroid Build Coastguard Worker /**
63*49fe348cSAndroid Build Coastguard Worker  * Write PCM samples to wave file
64*49fe348cSAndroid Build Coastguard Worker  * fp              Opened file
65*49fe348cSAndroid Build Coastguard Worker  * samplesize      Size of samples, in bytes
66*49fe348cSAndroid Build Coastguard Worker  * pcm, nch        PCM frames, as 'nch' interleaved samples
67*49fe348cSAndroid Build Coastguard Worker  * off, count      Offset and count of frames
68*49fe348cSAndroid Build Coastguard Worker  */
69*49fe348cSAndroid Build Coastguard Worker void wave_write_pcm(FILE *fp, int samplesize,
70*49fe348cSAndroid Build Coastguard Worker     const void *pcm, int nch, int off, int count);
71*49fe348cSAndroid Build Coastguard Worker 
72*49fe348cSAndroid Build Coastguard Worker 
73*49fe348cSAndroid Build Coastguard Worker #endif /* __WAVE_H */
74