6917f5d4899a382ea2dab192d2db53616c2060c5
[flac.git] / src / libFLAC / include / protected / stream_encoder.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2001-2009  Josh Coalson
3  * Copyright (C) 2011-2014  Xiph.Org Foundation
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * - Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * - Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * - Neither the name of the Xiph.org Foundation nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 #ifndef FLAC__PROTECTED__STREAM_ENCODER_H
34 #define FLAC__PROTECTED__STREAM_ENCODER_H
35
36 #include "FLAC/stream_encoder.h"
37 #if FLAC__HAS_OGG
38 #include "private/ogg_encoder_aspect.h"
39 #endif
40
41 #ifndef FLAC__INTEGER_ONLY_LIBRARY
42
43 #include "private/float.h"
44
45 #define FLAC__MAX_APODIZATION_FUNCTIONS 32
46
47 typedef enum {
48         FLAC__APODIZATION_BARTLETT,
49         FLAC__APODIZATION_BARTLETT_HANN,
50         FLAC__APODIZATION_BLACKMAN,
51         FLAC__APODIZATION_BLACKMAN_HARRIS_4TERM_92DB_SIDELOBE,
52         FLAC__APODIZATION_CONNES,
53         FLAC__APODIZATION_FLATTOP,
54         FLAC__APODIZATION_GAUSS,
55         FLAC__APODIZATION_HAMMING,
56         FLAC__APODIZATION_HANN,
57         FLAC__APODIZATION_KAISER_BESSEL,
58         FLAC__APODIZATION_NUTTALL,
59         FLAC__APODIZATION_RECTANGLE,
60         FLAC__APODIZATION_TRIANGLE,
61         FLAC__APODIZATION_TUKEY,
62         FLAC__APODIZATION_PARTIAL_TUKEY,
63         FLAC__APODIZATION_PUNCHOUT_TUKEY,
64         FLAC__APODIZATION_WELCH
65 } FLAC__ApodizationFunction;
66
67 typedef struct {
68         FLAC__ApodizationFunction type;
69         union {
70                 struct {
71                         FLAC__real stddev;
72                 } gauss;
73                 struct {
74                         FLAC__real p;
75                 } tukey;
76                 struct {
77                         FLAC__real p;
78                         FLAC__real start;
79                         FLAC__real end;
80                 } multiple_tukey;
81         } parameters;
82 } FLAC__ApodizationSpecification;
83
84 #endif // #ifndef FLAC__INTEGER_ONLY_LIBRARY
85
86 typedef struct FLAC__StreamEncoderProtected {
87         FLAC__StreamEncoderState state;
88         FLAC__bool verify;
89         FLAC__bool streamable_subset;
90         FLAC__bool do_md5;
91         FLAC__bool do_mid_side_stereo;
92         FLAC__bool loose_mid_side_stereo;
93         unsigned channels;
94         unsigned bits_per_sample;
95         unsigned sample_rate;
96         unsigned blocksize;
97 #ifndef FLAC__INTEGER_ONLY_LIBRARY
98         unsigned num_apodizations;
99         FLAC__ApodizationSpecification apodizations[FLAC__MAX_APODIZATION_FUNCTIONS];
100 #endif
101         unsigned max_lpc_order;
102         unsigned qlp_coeff_precision;
103         FLAC__bool do_qlp_coeff_prec_search;
104         FLAC__bool do_exhaustive_model_search;
105         FLAC__bool do_escape_coding;
106         unsigned min_residual_partition_order;
107         unsigned max_residual_partition_order;
108         unsigned rice_parameter_search_dist;
109         FLAC__uint64 total_samples_estimate;
110         FLAC__StreamMetadata **metadata;
111         unsigned num_metadata_blocks;
112         FLAC__uint64 streaminfo_offset, seektable_offset, audio_offset;
113 #if FLAC__HAS_OGG
114         FLAC__OggEncoderAspect ogg_encoder_aspect;
115 #endif
116 } FLAC__StreamEncoderProtected;
117
118 #endif