Don't overrun buffer on oom if assertions disabled
[libopusenc.git] / src / opus_header.h
1 /* Copyright (C)2012 Xiph.Org Foundation
2    File: opus_header.h
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_HEADER_H
29 #define OPUS_HEADER_H
30
31 #include <stdlib.h>
32 #include <opus.h>
33
34 #include <opus_multistream.h>
35 #ifdef OPUS_HAVE_OPUS_PROJECTION_H
36 #include <opus_projection.h>
37 #endif
38
39 typedef struct OpusGenericEncoder OpusGenericEncoder;
40 struct OpusGenericEncoder {
41   OpusMSEncoder *ms;
42 #ifdef OPUS_HAVE_OPUS_PROJECTION_H
43   OpusProjectionEncoder *pr;
44 #endif
45 };
46
47 int opeint_use_projection(int channel_mapping);
48
49 int opeint_encoder_surround_init(OpusGenericEncoder *st, int Fs, int channels, int channel_mapping, int *nb_streams, int *nb_coupled, unsigned char *stream_map, int application);
50
51 void opeint_encoder_cleanup(OpusGenericEncoder *st);
52
53 int opeint_encoder_init(OpusGenericEncoder *st, opus_int32 Fs, int channels, int streams, int coupled_streams, const unsigned char *mapping, int application);
54
55 int opeint_encode_float(OpusGenericEncoder *st, const float *pcm, int frame_size, unsigned char *data, opus_int32 max_data_bytes);
56
57 #ifdef OPUS_HAVE_OPUS_PROJECTION_H
58 # define opeint_encoder_ctl(st, request) \
59     ((st)->pr!=NULL ? \
60     opus_projection_encoder_ctl((st)->pr, request) : \
61     opus_multistream_encoder_ctl((st)->ms, request))
62 # define opeint_encoder_ctl2(st, request, value) \
63     ((st)->pr!=NULL ? \
64     opus_projection_encoder_ctl((st)->pr, request, value) : \
65     opus_multistream_encoder_ctl((st)->ms, request, value))
66 #else
67 # define opeint_encoder_ctl(st, request) \
68     opus_multistream_encoder_ctl((st)->ms, request)
69 # define opeint_encoder_ctl2(st, request, value) \
70     opus_multistream_encoder_ctl((st)->ms, request, value)
71 #endif
72
73 typedef struct {
74    int version;
75    int channels; /* Number of channels: 1..255 */
76    int preskip;
77    opus_uint32 input_sample_rate;
78    opus_int32 gain; /* in dB S7.8 should be zero whenever possible */
79    int channel_mapping;
80    /* The rest is only used if channel_mapping != 0 */
81    int nb_streams;
82    int nb_coupled;
83    unsigned char stream_map[255];
84 } OpusHeader;
85
86 int opeint_opus_header_get_size(const OpusHeader *h);
87
88 int opeint_opus_header_to_packet(const OpusHeader *h, unsigned char *packet, int len, const OpusGenericEncoder *st);
89
90 void opeint_comment_init(char **comments, int* length, const char *vendor_string);
91
92 int opeint_comment_add(char **comments, int* length, const char *tag, const char *val);
93
94 void opeint_comment_pad(char **comments, int* length, int amount);
95
96 #endif