aacpsy: Add energy spread for each band
[ffmpeg.git] / libavcodec / psymodel.h
1 /*
2  * audio encoder psychoacoustic model
3  * Copyright (C) 2008 Konstantin Shishkov
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #ifndef AVCODEC_PSYMODEL_H
23 #define AVCODEC_PSYMODEL_H
24
25 #include "avcodec.h"
26
27 /** maximum possible number of bands */
28 #define PSY_MAX_BANDS 128
29 /** maximum number of channels */
30 #define PSY_MAX_CHANS 20
31
32 #define AAC_CUTOFF(s) ((s)->bit_rate ? FFMIN3(4000 + (s)->bit_rate/8, 12000 + (s)->bit_rate/32, (s)->sample_rate / 2) : ((s)->sample_rate / 2))
33
34 /**
35  * single band psychoacoustic information
36  */
37 typedef struct FFPsyBand {
38     int   bits;
39     float energy;
40     float threshold;
41     float spread;    /* Energy spread over the band */
42 } FFPsyBand;
43
44 /**
45  * single channel psychoacoustic information
46  */
47 typedef struct FFPsyChannel {
48     FFPsyBand psy_bands[PSY_MAX_BANDS]; ///< channel bands information
49     float     entropy;                  ///< total PE for this channel
50 } FFPsyChannel;
51
52 /**
53  * psychoacoustic information for an arbitrary group of channels
54  */
55 typedef struct FFPsyChannelGroup {
56     FFPsyChannel *ch[PSY_MAX_CHANS];  ///< pointers to the individual channels in the group
57     uint8_t num_ch;                   ///< number of channels in this group
58     uint8_t coupling[PSY_MAX_BANDS];  ///< allow coupling for this band in the group
59 } FFPsyChannelGroup;
60
61 /**
62  * windowing related information
63  */
64 typedef struct FFPsyWindowInfo {
65     int window_type[3];               ///< window type (short/long/transitional, etc.) - current, previous and next
66     int window_shape;                 ///< window shape (sine/KBD/whatever)
67     int num_windows;                  ///< number of windows in a frame
68     int grouping[8];                  ///< window grouping (for e.g. AAC)
69     int *window_sizes;                ///< sequence of window sizes inside one frame (for eg. WMA)
70 } FFPsyWindowInfo;
71
72 /**
73  * context used by psychoacoustic model
74  */
75 typedef struct FFPsyContext {
76     AVCodecContext *avctx;            ///< encoder context
77     const struct FFPsyModel *model;   ///< encoder-specific model functions
78
79     FFPsyChannel      *ch;            ///< single channel information
80     FFPsyChannelGroup *group;         ///< channel group information
81     int num_groups;                   ///< number of channel groups
82
83     uint8_t **bands;                  ///< scalefactor band sizes for possible frame sizes
84     int     *num_bands;               ///< number of scalefactor bands for possible frame sizes
85     int num_lens;                     ///< number of scalefactor band sets
86
87     struct {
88         int size;                     ///< size of the bitresevoir in bits
89         int bits;                     ///< number of bits used in the bitresevoir
90     } bitres;
91
92     void* model_priv_data;            ///< psychoacoustic model implementation private data
93 } FFPsyContext;
94
95 /**
96  * codec-specific psychoacoustic model implementation
97  */
98 typedef struct FFPsyModel {
99     const char *name;
100     int  (*init)   (FFPsyContext *apc);
101
102     /**
103      * Suggest window sequence for channel.
104      *
105      * @param ctx       model context
106      * @param audio     samples for the current frame
107      * @param la        lookahead samples (NULL when unavailable)
108      * @param channel   number of channel element to analyze
109      * @param prev_type previous window type
110      *
111      * @return suggested window information in a structure
112      */
113     FFPsyWindowInfo (*window)(FFPsyContext *ctx, const float *audio, const float *la, int channel, int prev_type);
114
115     /**
116      * Perform psychoacoustic analysis and set band info (threshold, energy) for a group of channels.
117      *
118      * @param ctx      model context
119      * @param channel  channel number of the first channel in the group to perform analysis on
120      * @param coeffs   array of pointers to the transformed coefficients
121      * @param wi       window information for the channels in the group
122      */
123     void (*analyze)(FFPsyContext *ctx, int channel, const float **coeffs, const FFPsyWindowInfo *wi);
124
125     void (*end)    (FFPsyContext *apc);
126 } FFPsyModel;
127
128 /**
129  * Initialize psychoacoustic model.
130  *
131  * @param ctx        model context
132  * @param avctx      codec context
133  * @param num_lens   number of possible frame lengths
134  * @param bands      scalefactor band lengths for all frame lengths
135  * @param num_bands  number of scalefactor bands for all frame lengths
136  * @param num_groups number of channel groups
137  * @param group_map  array with # of channels in group - 1, for each group
138  *
139  * @return zero if successful, a negative value if not
140  */
141 int ff_psy_init(FFPsyContext *ctx, AVCodecContext *avctx, int num_lens,
142                 const uint8_t **bands, const int *num_bands,
143                 int num_groups, const uint8_t *group_map);
144
145 /**
146  * Determine what group a channel belongs to.
147  *
148  * @param ctx     psymodel context
149  * @param channel channel to locate the group for
150  *
151  * @return pointer to the FFPsyChannelGroup this channel belongs to
152  */
153 FFPsyChannelGroup *ff_psy_find_group(FFPsyContext *ctx, int channel);
154
155 /**
156  * Cleanup model context at the end.
157  *
158  * @param ctx model context
159  */
160 void ff_psy_end(FFPsyContext *ctx);
161
162
163 /**************************************************************************
164  *                       Audio preprocessing stuff.                       *
165  *       This should be moved into some audio filter eventually.          *
166  **************************************************************************/
167 struct FFPsyPreprocessContext;
168
169 /**
170  * psychoacoustic model audio preprocessing initialization
171  */
172 struct FFPsyPreprocessContext *ff_psy_preprocess_init(AVCodecContext *avctx);
173
174 /**
175  * Preprocess several channel in audio frame in order to compress it better.
176  *
177  * @param ctx      preprocessing context
178  * @param audio    samples to be filtered (in place)
179  * @param channels number of channel to preprocess
180  */
181 void ff_psy_preprocess(struct FFPsyPreprocessContext *ctx, float **audio, int channels);
182
183 /**
184  * Cleanup audio preprocessing module.
185  */
186 void ff_psy_preprocess_end(struct FFPsyPreprocessContext *ctx);
187
188 #endif /* AVCODEC_PSYMODEL_H */