add support for specifying which apodization functions to use to window data before...
[platform/upstream/flac.git] / src / libFLAC / include / protected / stream_encoder.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2001,2002,2003,2004,2005  Josh Coalson
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 FLAC__PROTECTED__STREAM_ENCODER_H
33 #define FLAC__PROTECTED__STREAM_ENCODER_H
34
35 #include "FLAC/stream_encoder.h"
36
37 #ifndef FLAC__INTEGER_ONLY_LIBRARY
38
39 #include "private/float.h"
40
41 #define FLAC__MAX_APODIZATION_FUNCTIONS 32
42
43 typedef enum {
44         FLAC__APODIZATION_BARTLETT,
45         FLAC__APODIZATION_BARTLETT_HANN,
46         FLAC__APODIZATION_BLACKMAN,
47         FLAC__APODIZATION_BLACKMAN_HARRIS_4TERM_92DB_SIDELOBE,
48         FLAC__APODIZATION_CONNES,
49         FLAC__APODIZATION_FLATTOP,
50         FLAC__APODIZATION_GAUSS,
51         FLAC__APODIZATION_HAMMING,
52         FLAC__APODIZATION_HANN,
53         FLAC__APODIZATION_KAISER_BESSEL,
54         FLAC__APODIZATION_NUTTALL,
55         FLAC__APODIZATION_RECTANGLE,
56         FLAC__APODIZATION_TRIANGLE,
57         FLAC__APODIZATION_TUKEY,
58         FLAC__APODIZATION_WELCH
59 } FLAC__ApodizationFunction;
60
61 typedef struct {
62         FLAC__ApodizationFunction type;
63         union {
64                 struct {
65                         FLAC__real stddev;
66                 } gauss;
67                 struct {
68                         FLAC__real p;
69                 } tukey;
70         } parameters;
71 } FLAC__ApodizationSpecification;
72
73 #endif // #ifndef FLAC__INTEGER_ONLY_LIBRARY
74
75 typedef struct FLAC__StreamEncoderProtected {
76         FLAC__StreamEncoderState state;
77         FLAC__bool verify;
78         FLAC__bool streamable_subset;
79         FLAC__bool do_mid_side_stereo;
80         FLAC__bool loose_mid_side_stereo;
81         unsigned channels;
82         unsigned bits_per_sample;
83         unsigned sample_rate;
84         unsigned blocksize;
85 #ifndef FLAC__INTEGER_ONLY_LIBRARY
86         unsigned num_apodizations;
87         FLAC__ApodizationSpecification apodizations[FLAC__MAX_APODIZATION_FUNCTIONS];
88 #endif
89         unsigned max_lpc_order;
90         unsigned qlp_coeff_precision;
91         FLAC__bool do_qlp_coeff_prec_search;
92         FLAC__bool do_exhaustive_model_search;
93         FLAC__bool do_escape_coding;
94         unsigned min_residual_partition_order;
95         unsigned max_residual_partition_order;
96         unsigned rice_parameter_search_dist;
97         FLAC__uint64 total_samples_estimate;
98         FLAC__StreamMetadata **metadata;
99         unsigned num_metadata_blocks;
100 } FLAC__StreamEncoderProtected;
101
102 #endif