Some error reporting in the mode generation code. More cleanup
[opus.git] / libcelt / celt.h
1 /* (C) 2007 Jean-Marc Valin, CSIRO
2 */
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    - Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10    
11    - Redistributions in binary form must reproduce the above copyright
12    notice, this list of conditions and the following disclaimer in the
13    documentation and/or other materials provided with the distribution.
14    
15    - Neither the name of the Xiph.org Foundation nor the names of its
16    contributors may be used to endorse or promote products derived from
17    this software without specific prior written permission.
18    
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef CELT_H
33 #define CELT_H
34
35 #include "celt_types.h"
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 #define CELT_OK                0
42 #define CELT_BAD_ARG          -1
43 #define CELT_INVALID_MODE     -2
44 #define CELT_INTERNAL_ERROR   -3
45 #define CELT_CORRUPTED_DATA   -4
46
47 #define CELT_GET_FRAME_SIZE   1000
48 #define CELT_GET_LOOKAHEAD    1001
49 #define CELT_GET_NB_CHANNELS  1002
50    
51 typedef struct CELTEncoder CELTEncoder;
52 typedef struct CELTDecoder CELTDecoder;
53
54 typedef struct CELTMode CELTMode;
55
56 /*extern const CELTMode *celt_mono;
57 extern const CELTMode *celt_stereo;
58 extern const CELTMode *celt_ld51;*/
59
60 #define celt_mono celt_mode_create(44100, 1, 256, 128, NULL)
61 #define celt_stereo celt_mode_create(44100, 2, 256, 128, NULL)
62       
63 /* Encoder stuff */
64 CELTMode *celt_mode_create(int Fs, int channels, int frame_size, int lookahead, int *error);
65 void celt_mode_destroy(CELTMode *mode);
66
67 CELTEncoder *celt_encoder_new(const CELTMode *mode);
68
69 void celt_encoder_destroy(CELTEncoder *st);
70
71 int celt_encode(CELTEncoder *st, celt_int16_t *pcm, unsigned char *compressed, int nbCompressedBytes);
72
73 /* Decoder stuff */
74
75 CELTDecoder *celt_decoder_new(const CELTMode *mode);
76
77 void celt_decoder_destroy(CELTDecoder *st);
78
79 int celt_decode(CELTDecoder *st, unsigned char *data, int len, celt_int16_t *pcm);
80
81
82 /* Mode calls */
83
84 int celt_mode_info(const CELTMode *mode, int request, celt_int32_t *value);
85
86 #ifdef __cplusplus
87 }
88 #endif
89
90 #endif /*CELT_H */