8c7ec9852037e94f251e3a33234f72e3dc15a28f
[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 /**
29  * @file opus.h
30  * @brief Opus reference implementation API
31  */
32
33 #ifndef OPUS_H
34 #define OPUS_H
35
36 #include "opus_types.h"
37 #include "opus_defines.h"
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43
44
45
46
47 typedef struct OpusEncoder OpusEncoder;
48 typedef struct OpusDecoder OpusDecoder;
49
50 OPUS_EXPORT int opus_encoder_get_size(int channels);
51
52 /**
53  * There are two coding modes:
54  * OPUS_APPLICATION_VOIP gives best quality at a given bitrate for voice
55  *    signals. It enhances the  input signal by high-pass filtering and
56  *    emphasizing formants and harmonics. Optionally  it includes in-band
57  *    forward error correction to protect against packet loss. Use this
58  *    mode for typical VoIP applications. Because of the enhancement,
59  *    even at high bitrates the output may sound different from the input.
60  * OPUS_APPLICATION_AUDIO gives best quality at a given bitrate for most
61  *    non-voice signals like music. Use this mode for music and mixed
62  *    (music/voice) content, broadcast, and applications requiring less
63  *    than 15 ms of coding delay.
64  */
65
66 /** Returns initialized encoder state */
67 OPUS_EXPORT OpusEncoder *opus_encoder_create(
68     opus_int32 Fs,              /**< Sampling rate of input signal (Hz) */
69     int channels,               /**< Number of channels (1/2) in input signal */
70     int application,            /**< Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO) */
71     int *error                  /**< Error code */
72 );
73
74 OPUS_EXPORT int opus_encoder_init(
75     OpusEncoder *st,            /**< Encoder state */
76     opus_int32 Fs,              /**< Sampling rate of input signal (Hz) */
77     int channels,               /**< Number of channels (1/2) in input signal */
78     int application             /**< Coding mode (OPUS_APPLICATION_VOIP/OPUS_APPLICATION_AUDIO) */
79 );
80
81 /** Returns length of the data payload (in bytes) */
82 OPUS_EXPORT int opus_encode(
83     OpusEncoder *st,            /**< Encoder state */
84     const opus_int16 *pcm,      /**< Input signal (interleaved if 2 channels). length is frame_size*channels */
85     int frame_size,             /**< Number of samples per frame of input signal */
86     unsigned char *data,        /**< Output payload (no more than max_data_bytes long) */
87     int max_data_bytes          /**< Allocated memory for payload; don't use for controlling bitrate */
88 );
89
90 /** Returns length of the data payload (in bytes) */
91 OPUS_EXPORT int opus_encode_float(
92     OpusEncoder *st,            /**< Encoder state */
93     const float *pcm,           /**< Input signal (interleaved if 2 channels). length is frame_size*channels 0dbFS range of +/-1.0*/
94     int frame_size,             /**< Number of samples per frame of input signal */
95     unsigned char *data,        /**< Output payload (no more than max_data_bytes long) */
96     int max_data_bytes          /**< Allocated memory for payload; don't use for controlling bitrate */
97 );
98
99 OPUS_EXPORT void opus_encoder_destroy(OpusEncoder *st);
100
101 OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...);
102
103
104
105 OPUS_EXPORT int opus_decoder_get_size(int channels);
106
107 OPUS_EXPORT OpusDecoder *opus_decoder_create(
108     opus_int32 Fs,              /**< Sampling rate of output signal (Hz) */
109     int channels,               /**< Number of channels (1/2) in output signal */
110     int *error                  /**< Error code*/
111 );
112
113 OPUS_EXPORT int opus_decoder_init(OpusDecoder *st,
114     opus_int32 Fs,              /**< Sampling rate of output signal (Hz) */
115     int channels                /**< Number of channels (1/2) in output signal */
116 );
117
118 /** Returns the number of samples decoded or a negative error code */
119 OPUS_EXPORT int opus_decode(
120     OpusDecoder *st,            /**< Decoder state */
121     const unsigned char *data,  /**< Input payload. Use a NULL pointer to indicate packet loss */
122     int len,                    /**< Number of bytes in payload */
123     opus_int16 *pcm,            /**< Output signal (interleaved if 2 channels). length is frame_size*channels */
124     int frame_size,             /**< Number of samples per frame of input signal */
125     int decode_fec              /**< Flag (0/1) to request that any in-band forward error correction data be */
126                                 /**< decoded. If no such data is available the frame is decoded as if it were lost. */
127 );
128
129 /** Returns the number of samples decoded or a negative error code */
130 OPUS_EXPORT int opus_decode_float(
131     OpusDecoder *st,            /**< Decoder state */
132     const unsigned char *data,  /**< Input payload. Use a NULL pointer to indicate packet loss */
133     int len,                    /**< Number of bytes in payload */
134     float *pcm,                 /**< Output signal (interleaved if 2 channels). length is frame_size*channels 0dbFS range of -/+1.0*/
135     int frame_size,             /**< Number of samples per frame of input signal */
136     int decode_fec              /**< Flag (0/1) to request that any in-band forward error correction data be */
137                                 /**< decoded. If no such data is available the frame is decoded as if it were lost. */
138 );
139
140 OPUS_EXPORT int opus_decoder_ctl(OpusDecoder *st, int request, ...);
141
142 OPUS_EXPORT void opus_decoder_destroy(OpusDecoder *st);
143
144 OPUS_EXPORT int opus_packet_parse(const unsigned char *data, int len,
145       unsigned char *out_toc, const unsigned char *frames[48],
146       short size[48], int *payload_offset);
147
148 OPUS_EXPORT int opus_packet_get_bandwidth(const unsigned char *data);
149 OPUS_EXPORT int opus_packet_get_samples_per_frame(const unsigned char *data, opus_int32 Fs);
150 OPUS_EXPORT int opus_packet_get_nb_channels(const unsigned char *data);
151 OPUS_EXPORT int opus_packet_get_nb_frames(const unsigned char packet[], int len);
152 OPUS_EXPORT int opus_decoder_get_nb_samples(const OpusDecoder *dec, const unsigned char packet[], int len);
153
154
155 /** Repacketizer */
156 typedef struct OpusRepacketizer OpusRepacketizer;
157
158 OPUS_EXPORT int opus_repacketizer_get_size(void);
159
160 OPUS_EXPORT OpusRepacketizer *opus_repacketizer_init(OpusRepacketizer *rp);
161
162 OPUS_EXPORT OpusRepacketizer *opus_repacketizer_create(void);
163
164 OPUS_EXPORT void opus_repacketizer_destroy(OpusRepacketizer *rp);
165
166 OPUS_EXPORT int opus_repacketizer_cat(OpusRepacketizer *rp, const unsigned char *data, int len);
167
168 OPUS_EXPORT int opus_repacketizer_out_range(OpusRepacketizer *rp, int begin, int end, unsigned char *data, int maxlen);
169
170 OPUS_EXPORT int opus_repacketizer_get_nb_frames(OpusRepacketizer *rp);
171
172 OPUS_EXPORT int opus_repacketizer_out(OpusRepacketizer *rp, unsigned char *data, int maxlen);
173
174 #ifdef __cplusplus
175 }
176 #endif
177
178 #endif /* OPUS_H */