FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
psymodel.h
Go to the documentation of this file.
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
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  float clipping[8]; ///< maximum absolute normalized intensity in the given window for clip avoidance
70  int *window_sizes; ///< sequence of window sizes inside one frame (for eg. WMA)
72 
73 /**
74  * context used by psychoacoustic model
75  */
76 typedef struct FFPsyContext {
77  AVCodecContext *avctx; ///< encoder context
78  const struct FFPsyModel *model; ///< encoder-specific model functions
79 
80  FFPsyChannel *ch; ///< single channel information
81  FFPsyChannelGroup *group; ///< channel group information
82  int num_groups; ///< number of channel groups
83 
84  uint8_t **bands; ///< scalefactor band sizes for possible frame sizes
85  int *num_bands; ///< number of scalefactor bands for possible frame sizes
86  int num_lens; ///< number of scalefactor band sets
87 
88  struct {
89  int size; ///< size of the bitresevoir in bits
90  int bits; ///< number of bits used in the bitresevoir
91  } bitres;
92 
93  void* model_priv_data; ///< psychoacoustic model implementation private data
94 } FFPsyContext;
95 
96 /**
97  * codec-specific psychoacoustic model implementation
98  */
99 typedef struct FFPsyModel {
100  const char *name;
101  int (*init) (FFPsyContext *apc);
102 
103  /**
104  * Suggest window sequence for channel.
105  *
106  * @param ctx model context
107  * @param audio samples for the current frame
108  * @param la lookahead samples (NULL when unavailable)
109  * @param channel number of channel element to analyze
110  * @param prev_type previous window type
111  *
112  * @return suggested window information in a structure
113  */
114  FFPsyWindowInfo (*window)(FFPsyContext *ctx, const float *audio, const float *la, int channel, int prev_type);
115 
116  /**
117  * Perform psychoacoustic analysis and set band info (threshold, energy) for a group of channels.
118  *
119  * @param ctx model context
120  * @param channel channel number of the first channel in the group to perform analysis on
121  * @param coeffs array of pointers to the transformed coefficients
122  * @param wi window information for the channels in the group
123  */
124  void (*analyze)(FFPsyContext *ctx, int channel, const float **coeffs, const FFPsyWindowInfo *wi);
125 
126  void (*end) (FFPsyContext *apc);
127 } FFPsyModel;
128 
129 /**
130  * Initialize psychoacoustic model.
131  *
132  * @param ctx model context
133  * @param avctx codec context
134  * @param num_lens number of possible frame lengths
135  * @param bands scalefactor band lengths for all frame lengths
136  * @param num_bands number of scalefactor bands for all frame lengths
137  * @param num_groups number of channel groups
138  * @param group_map array with # of channels in group - 1, for each group
139  *
140  * @return zero if successful, a negative value if not
141  */
142 int ff_psy_init(FFPsyContext *ctx, AVCodecContext *avctx, int num_lens,
143  const uint8_t **bands, const int *num_bands,
144  int num_groups, const uint8_t *group_map);
145 
146 /**
147  * Determine what group a channel belongs to.
148  *
149  * @param ctx psymodel context
150  * @param channel channel to locate the group for
151  *
152  * @return pointer to the FFPsyChannelGroup this channel belongs to
153  */
155 
156 /**
157  * Cleanup model context at the end.
158  *
159  * @param ctx model context
160  */
161 void ff_psy_end(FFPsyContext *ctx);
162 
163 
164 /**************************************************************************
165  * Audio preprocessing stuff. *
166  * This should be moved into some audio filter eventually. *
167  **************************************************************************/
169 
170 /**
171  * psychoacoustic model audio preprocessing initialization
172  */
174 
175 /**
176  * Preprocess several channel in audio frame in order to compress it better.
177  *
178  * @param ctx preprocessing context
179  * @param audio samples to be filtered (in place)
180  * @param channels number of channel to preprocess
181  */
182 void ff_psy_preprocess(struct FFPsyPreprocessContext *ctx, float **audio, int channels);
183 
184 /**
185  * Cleanup audio preprocessing module.
186  */
188 
189 #endif /* AVCODEC_PSYMODEL_H */
#define PSY_MAX_BANDS
maximum possible number of bands
Definition: psymodel.h:28
int num_groups
number of channel groups
Definition: psymodel.h:82
int grouping[8]
window grouping (for e.g. AAC)
Definition: psymodel.h:68
uint8_t ** bands
scalefactor band sizes for possible frame sizes
Definition: psymodel.h:84
FFPsyChannelGroup * group
channel group information
Definition: psymodel.h:81
FFPsyBand psy_bands[PSY_MAX_BANDS]
channel bands information
Definition: psymodel.h:48
psychoacoustic information for an arbitrary group of channels
Definition: psymodel.h:55
struct FFPsyContext::@78 bitres
int * num_bands
number of scalefactor bands for possible frame sizes
Definition: psymodel.h:85
int * window_sizes
sequence of window sizes inside one frame (for eg. WMA)
Definition: psymodel.h:70
uint8_t
struct FFPsyPreprocessContext * ff_psy_preprocess_init(AVCodecContext *avctx)
psychoacoustic model audio preprocessing initialization
Definition: psymodel.c:102
int size
size of the bitresevoir in bits
Definition: psymodel.h:89
context used by psychoacoustic model
Definition: psymodel.h:76
single band psychoacoustic information
Definition: psymodel.h:37
AVCodecContext * avctx
Definition: psymodel.c:93
single channel psychoacoustic information
Definition: psymodel.h:47
FFPsyChannel * ch[PSY_MAX_CHANS]
pointers to the individual channels in the group
Definition: psymodel.h:56
int bits
Definition: psymodel.h:38
int num_windows
number of windows in a frame
Definition: psymodel.h:67
float energy
Definition: psymodel.h:39
Libavcodec external API header.
codec-specific psychoacoustic model implementation
Definition: psymodel.h:99
void(* analyze)(FFPsyContext *ctx, int channel, const float **coeffs, const FFPsyWindowInfo *wi)
Perform psychoacoustic analysis and set band info (threshold, energy) for a group of channels...
Definition: psymodel.h:124
typedef void(APIENTRY *FF_PFNGLACTIVETEXTUREPROC)(GLenum texture)
uint8_t num_ch
number of channels in this group
Definition: psymodel.h:57
void ff_psy_preprocess_end(struct FFPsyPreprocessContext *ctx)
Cleanup audio preprocessing module.
Definition: psymodel.c:150
float entropy
total PE for this channel
Definition: psymodel.h:49
FFPsyWindowInfo(* window)(FFPsyContext *ctx, const float *audio, const float *la, int channel, int prev_type)
Suggest window sequence for channel.
Definition: psymodel.h:114
main external API structure.
Definition: avcodec.h:1501
void * model_priv_data
psychoacoustic model implementation private data
Definition: psymodel.h:93
int bits
number of bits used in the bitresevoir
Definition: psymodel.h:90
void(* end)(FFPsyContext *apc)
Definition: psymodel.h:126
#define PSY_MAX_CHANS
maximum number of channels
Definition: psymodel.h:30
FFPsyChannelGroup * ff_psy_find_group(FFPsyContext *ctx, int channel)
Determine what group a channel belongs to.
Definition: psymodel.c:72
int window_shape
window shape (sine/KBD/whatever)
Definition: psymodel.h:66
const struct FFPsyModel * model
encoder-specific model functions
Definition: psymodel.h:78
void ff_psy_end(FFPsyContext *ctx)
Cleanup model context at the end.
Definition: psymodel.c:82
uint8_t coupling[PSY_MAX_BANDS]
allow coupling for this band in the group
Definition: psymodel.h:58
const char * name
Definition: psymodel.h:100
windowing related information
Definition: psymodel.h:64
int num_lens
number of scalefactor band sets
Definition: psymodel.h:86
static const int16_t coeffs[]
FFPsyChannel * ch
single channel information
Definition: psymodel.h:80
int(* init)(FFPsyContext *apc)
Definition: psymodel.h:101
AVCodecContext * avctx
encoder context
Definition: psymodel.h:77
float threshold
Definition: psymodel.h:40
void ff_psy_preprocess(struct FFPsyPreprocessContext *ctx, float **audio, int channels)
Preprocess several channel in audio frame in order to compress it better.
Definition: psymodel.c:137
float spread
Definition: psymodel.h:41
int window_type[3]
window type (short/long/transitional, etc.) - current, previous and next
Definition: psymodel.h:65
float clipping[8]
maximum absolute normalized intensity in the given window for clip avoidance
Definition: psymodel.h:69
int ff_psy_init(FFPsyContext *ctx, AVCodecContext *avctx, int num_lens, const uint8_t **bands, const int *num_bands, int num_groups, const uint8_t *group_map)
Initialize psychoacoustic model.
Definition: psymodel.c:31