Defining OPUS_BITRATE_MAX and moving some defines to opus_defines.h
[opus.git] / src / opus.h
1 /* Copyright (c) 2010-2011 Xiph.Org Foundation, Skype Limited
2    Written by Jean-Marc Valin and Koen Vos */
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    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
19    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 #ifndef OPUS_H
29 #define OPUS_H
30
31 #include "opus_types.h"
32 #include "opus_defines.h"
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38
39
40
41
42 typedef struct OpusEncoder OpusEncoder;
43 typedef struct OpusDecoder OpusDecoder;
44
45 OPUS_EXPORT int opus_encoder_get_size(int channels);
46
47 /*
48  * There are two coding modes:
49  * OPUS_APPLICATION_VOIP gives best quality at a given bitrate for voice
50  *    signals. It enhances the  input signal by high-pass filtering and
51  *    emphasizing formants and harmonics. Optionally  it includes in-band
52  *    forward error correction to protect against packet loss. Use this
53  *    mode for typical VoIP applications. Because of the enhancement,
54  *    even at high bitrates the output may sound different from the input.
55  * OPUS_APPLICATION_AUDIO gives best quality at a given bitrate for most
56  *    non-voice signals like music. Use this mode for music and mixed
57  *    (music/voice) content, broadcast, and applications requiring less
58  *    than 15 ms of coding delay.
59  */
60
61 /* Returns initialized encoder state */
62 OPUS_EXPORT OpusEncoder *opus_encoder_create(
63     opus_int32 Fs,              /* Sampling rate of input signal (Hz) */
64     int channels,               /* Number of channels (1/2) in input signal */
65     int application,            /* Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO) */
66     int *error                  /* Error code */
67 );
68
69 OPUS_EXPORT int opus_encoder_init(
70     OpusEncoder *st,            /* Encoder state */
71     opus_int32 Fs,              /* Sampling rate of input signal (Hz) */
72     int channels,               /* Number of channels (1/2) in input signal */
73     int application             /* Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO) */
74 );
75
76 /* Returns length of the data payload (in bytes) */
77 OPUS_EXPORT int opus_encode(
78     OpusEncoder *st,            /* Encoder state */
79     const opus_int16 *pcm,      /* Input signal (interleaved if 2 channels). length is frame_size*channels */
80     int frame_size,             /* Number of samples per frame of input signal */
81     unsigned char *data,        /* Output payload (no more than max_data_bytes long) */
82     int max_data_bytes          /* Allocated memory for payload; don't use for controlling bitrate */
83 );
84
85 /* Returns length of the data payload (in bytes) */
86 OPUS_EXPORT int opus_encode_float(
87     OpusEncoder *st,            /* Encoder state */
88     const float *pcm,           /* Input signal (interleaved if 2 channels). length is frame_size*channels 0dbFS range of +/-1.0*/
89     int frame_size,             /* Number of samples per frame of input signal */
90     unsigned char *data,        /* Output payload (no more than max_data_bytes long) */
91     int max_data_bytes          /* Allocated memory for payload; don't use for controlling bitrate */
92 );
93
94 OPUS_EXPORT void opus_encoder_destroy(OpusEncoder *st);
95
96 OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...);
97
98
99
100 OPUS_EXPORT int opus_decoder_get_size(int channels);
101
102 OPUS_EXPORT OpusDecoder *opus_decoder_create(
103     opus_int32 Fs,              /* Sampling rate of output signal (Hz) */
104     int channels,               /* Number of channels (1/2) in output signal */
105     int *error                  /* Error code*/
106 );
107
108 OPUS_EXPORT int opus_decoder_init(OpusDecoder *st,
109     opus_int32 Fs,              /* Sampling rate of output signal (Hz) */
110     int channels                /* Number of channels (1/2) in output signal */
111 );
112
113 /* Returns the number of samples decoded or a negative error code */
114 OPUS_EXPORT int opus_decode(
115     OpusDecoder *st,            /* Decoder state */
116     const unsigned char *data,  /* Input payload. Use a NULL pointer to indicate packet loss */
117     int len,                    /* Number of bytes in payload */
118     opus_int16 *pcm,            /* Output signal (interleaved if 2 channels). length is frame_size*channels */
119     int frame_size,             /* Number of samples per frame of input signal */
120     int decode_fec              /* Flag (0/1) to request that any in-band forward error correction data be */
121                                 /* decoded. If no such data is available the frame is decoded as if it were lost. */
122 );
123
124 /* Returns the number of samples decoded or a negative error code */
125 OPUS_EXPORT int opus_decode_float(
126     OpusDecoder *st,            /* Decoder state */
127     const unsigned char *data,  /* Input payload. Use a NULL pointer to indicate packet loss */
128     int len,                    /* Number of bytes in payload */
129     float *pcm,                 /* Output signal (interleaved if 2 channels). length is frame_size*channels 0dbFS range of -/+1.0*/
130     int frame_size,             /* Number of samples per frame of input signal */
131     int decode_fec              /* Flag (0/1) to request that any in-band forward error correction data be */
132                                 /* decoded. If no such data is available the frame is decoded as if it were lost. */
133 );
134
135 OPUS_EXPORT int opus_decoder_ctl(OpusDecoder *st, int request, ...);
136
137 OPUS_EXPORT void opus_decoder_destroy(OpusDecoder *st);
138
139 OPUS_EXPORT int opus_packet_parse(const unsigned char *data, int len,
140       unsigned char *out_toc, const unsigned char *frames[48],
141       short size[48], int *payload_offset);
142
143 OPUS_EXPORT int opus_packet_get_bandwidth(const unsigned char *data);
144 OPUS_EXPORT int opus_packet_get_samples_per_frame(const unsigned char *data, opus_int32 Fs);
145 OPUS_EXPORT int opus_packet_get_nb_channels(const unsigned char *data);
146 OPUS_EXPORT int opus_packet_get_nb_frames(const unsigned char packet[], int len);
147 OPUS_EXPORT int opus_decoder_get_nb_samples(const OpusDecoder *dec, const unsigned char packet[], int len);
148
149
150 /* Repacketizer */
151 typedef struct OpusRepacketizer OpusRepacketizer;
152
153 OPUS_EXPORT int opus_repacketizer_get_size(void);
154
155 OPUS_EXPORT OpusRepacketizer *opus_repacketizer_init(OpusRepacketizer *rp);
156
157 OPUS_EXPORT OpusRepacketizer *opus_repacketizer_create(void);
158
159 OPUS_EXPORT void opus_repacketizer_destroy(OpusRepacketizer *rp);
160
161 OPUS_EXPORT int opus_repacketizer_cat(OpusRepacketizer *rp, const unsigned char *data, int len);
162
163 OPUS_EXPORT int opus_repacketizer_out_range(OpusRepacketizer *rp, int begin, int end, unsigned char *data, int maxlen);
164
165 OPUS_EXPORT int opus_repacketizer_get_nb_frames(OpusRepacketizer *rp);
166
167 OPUS_EXPORT int opus_repacketizer_out(OpusRepacketizer *rp, unsigned char *data, int maxlen);
168
169 #ifdef __cplusplus
170 }
171 #endif
172
173 #endif /* OPUS_H */