Adds a _ctl() control API to the encoder and decoder
[opus.git] / src / hybrid.h
1 /* Copyright (c) 2010 Xiph.Org Foundation
2    Written by Jean-Marc Valin */
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 HYBRID_H
33 #define HYBRID_H
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 #if defined(__GNUC__) && defined(CELT_BUILD)
40 #define EXPORT __attribute__ ((visibility ("default")))
41 #elif defined(WIN32)
42 #define EXPORT __declspec(dllexport)
43 #else
44 #define EXPORT
45 #endif
46
47 #define __check_int(x) (((void)((x) == (int)0)), (int)(x))
48 #define __check_int_ptr(ptr) ((ptr) + ((ptr) - (int*)(ptr)))
49
50 #define MODE_SILK_ONLY 1000
51 #define MODE_HYBRID    1001
52 #define MODE_CELT_ONLY 1002
53
54 #define BANDWIDTH_NARROWBAND    1100
55 #define BANDWIDTH_WIDEBAND      1101
56 #define BANDWIDTH_SUPERWIDEBAND 1102
57 #define BANDWIDTH_FULLBAND      1103
58
59
60
61 #define HYBRID_SET_MODE_REQUEST 0
62 #define HYBRID_SET_MODE(x) HYBRID_SET_MODE_REQUEST, __check_int(x)
63 #define HYBRID_GET_MODE_REQUEST 1
64 #define HYBRID_GET_MODE(x) HYBRID_GET_MODE_REQUEST, __check_int_ptr(x)
65
66 #define HYBRID_SET_BANDWIDTH_REQUEST 2
67 #define HYBRID_SET_BANDWIDTH(x) HYBRID_SET_BANDWIDTH_REQUEST, __check_int(x)
68 #define HYBRID_GET_BANDWIDTH_REQUEST 3
69 #define HYBRID_GET_BANDWIDTH(x) HYBRID_GET_BANDWIDTH_REQUEST, __check_int_ptr(x)
70
71 #define HYBRID_SET_VBR_RATE_REQUEST 4
72 #define HYBRID_SET_VBR_RATE(x) HYBRID_SET_VBR_RATE_REQUEST, __check_int(x)
73 #define HYBRID_GET_VBR_RATE_REQUEST 5
74 #define HYBRID_GET_VBR_RATE(x) HYBRID_GET_VBR_RATE_REQUEST, __check_int_ptr(x)
75
76 typedef struct HybridEncoder HybridEncoder;
77 typedef struct HybridDecoder HybridDecoder;
78
79 HybridEncoder *hybrid_encoder_create();
80
81 int hybrid_encode(HybridEncoder *st, const short *pcm, int frame_size,
82                 unsigned char *data, int bytes_per_packet);
83
84 void hybrid_encoder_destroy(HybridEncoder *st);
85
86 void hybrid_encoder_ctl(HybridEncoder *st, int request, ...);
87
88 HybridDecoder *hybrid_decoder_create();
89
90 int hybrid_decode(HybridDecoder *st, const unsigned char *data, int len,
91                 short *pcm, int frame_size);
92
93 void hybrid_decoder_ctl(HybridDecoder *st, int request, ...);
94
95 void hybrid_decoder_destroy(HybridDecoder *st);
96
97 #ifdef __cplusplus
98 }
99 #endif
100
101 #endif /* HYBRID_H */