FFmpeg
ac3enc_float.c
Go to the documentation of this file.
1 /*
2  * The simplest AC-3 encoder
3  * Copyright (c) 2000 Fabrice Bellard
4  * Copyright (c) 2006-2010 Justin Ruggles <justin.ruggles@gmail.com>
5  * Copyright (c) 2006-2010 Prakash Punnoor <prakash@punnoor.de>
6  *
7  * This file is part of FFmpeg.
8  *
9  * FFmpeg is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * FFmpeg is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with FFmpeg; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  */
23 
24 /**
25  * @file
26  * floating-point AC-3 encoder.
27  */
28 
29 #define AC3ENC_FLOAT 1
30 #include "internal.h"
31 #include "audiodsp.h"
32 #include "ac3enc.h"
33 #include "eac3enc.h"
34 #include "kbdwin.h"
35 
36 
37 #define AC3ENC_TYPE AC3ENC_TYPE_AC3
38 #include "ac3enc_opts_template.c"
39 static const AVClass ac3enc_class = {
40  .class_name = "AC-3 Encoder",
41  .item_name = av_default_item_name,
42  .option = ac3_options,
43  .version = LIBAVUTIL_VERSION_INT,
44 };
45 
46 
47 /*
48  * Scale MDCT coefficients from float to 24-bit fixed-point.
49  */
51 {
52  int chan_size = AC3_MAX_COEFS * s->num_blocks;
53  int cpl = s->cpl_on;
54  s->ac3dsp.float_to_fixed24(s->fixed_coef_buffer + (chan_size * !cpl),
55  s->mdct_coef_buffer + (chan_size * !cpl),
56  chan_size * (s->channels + cpl));
57 }
58 
59 
60 /*
61  * Clip MDCT coefficients to allowable range.
62  */
63 static void clip_coefficients(AudioDSPContext *adsp, float *coef,
64  unsigned int len)
65 {
66  adsp->vector_clipf(coef, coef, len, COEF_MIN, COEF_MAX);
67 }
68 
69 
70 /*
71  * Calculate a single coupling coordinate.
72  */
73 static CoefType calc_cpl_coord(CoefSumType energy_ch, CoefSumType energy_cpl)
74 {
75  float coord = 0.125;
76  if (energy_cpl > 0)
77  coord *= sqrtf(energy_ch / energy_cpl);
78  return FFMIN(coord, COEF_MAX);
79 }
80 
81 static void sum_square_butterfly(AC3EncodeContext *s, float sum[4],
82  const float *coef0, const float *coef1,
83  int len)
84 {
85  s->ac3dsp.sum_square_butterfly_float(sum, coef0, coef1, len);
86 }
87 
88 
89 #include "ac3enc_template.c"
90 
91 
92 /**
93  * Finalize MDCT and free allocated memory.
94  *
95  * @param s AC-3 encoder private context
96  */
98 {
99  ff_mdct_end(&s->mdct);
100 }
101 
102 
103 /**
104  * Initialize MDCT tables.
105  *
106  * @param s AC-3 encoder private context
107  * @return 0 on success, negative error code on failure
108  */
110 {
111  float *window = av_malloc_array(AC3_BLOCK_SIZE, sizeof(*window));
112  if (!window) {
113  av_log(s->avctx, AV_LOG_ERROR, "Cannot allocate memory.\n");
114  return AVERROR(ENOMEM);
115  }
116 
117  ff_kbd_window_init(window, 5.0, AC3_BLOCK_SIZE);
118  s->mdct_window = window;
119 
120  return ff_mdct_init(&s->mdct, 9, 0, -2.0 / AC3_WINDOW_SIZE);
121 }
122 
123 
125 {
126  AC3EncodeContext *s = avctx->priv_data;
131  if (!s->fdsp)
132  return AVERROR(ENOMEM);
133  return ff_ac3_encode_init(avctx);
134 }
135 
137  .name = "ac3",
138  .long_name = NULL_IF_CONFIG_SMALL("ATSC A/52A (AC-3)"),
139  .type = AVMEDIA_TYPE_AUDIO,
140  .id = AV_CODEC_ID_AC3,
141  .priv_data_size = sizeof(AC3EncodeContext),
143  .encode2 = ff_ac3_float_encode_frame,
144  .close = ff_ac3_encode_close,
145  .sample_fmts = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_FLTP,
147  .priv_class = &ac3enc_class,
148  .supported_samplerates = ff_ac3_sample_rate_tab,
149  .channel_layouts = ff_ac3_channel_layouts,
150  .defaults = ac3_defaults,
152 };
#define FF_CODEC_CAP_INIT_CLEANUP
The codec allows calling the close function for deallocation even if the init function returned a fai...
Definition: internal.h:48
float, planar
Definition: samplefmt.h:69
void(* mdct_end)(struct AC3EncodeContext *s)
Definition: ac3enc.h:264
av_cold void ff_kbd_window_init(float *window, float alpha, int n)
Generate a Kaiser-Bessel Derived Window.
Definition: kbdwin.c:26
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
static int allocate_sample_buffers(AC3EncodeContext *s)
#define AC3_MAX_COEFS
Definition: ac3.h:35
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
#define AC3_WINDOW_SIZE
Definition: ac3.h:39
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:235
#define COEF_MIN
Definition: ac3enc.h:67
static CoefType calc_cpl_coord(CoefSumType energy_ch, CoefSumType energy_cpl)
Definition: ac3enc_float.c:73
int(* mdct_init)(struct AC3EncodeContext *s)
Definition: ac3enc.h:265
AVCodec.
Definition: codec.h:190
int ff_ac3_float_encode_frame(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
static void sum_square_butterfly(AC3EncodeContext *s, float sum[4], const float *coef0, const float *coef1, int len)
Definition: ac3enc_float.c:81
#define FF_CODEC_CAP_INIT_THREADSAFE
The codec does not modify any global variables in the init function, allowing to call the init functi...
Definition: internal.h:40
#define av_cold
Definition: attributes.h:88
av_cold int ff_ac3_encode_close(AVCodecContext *avctx)
Finalize encoding and free any memory allocated by the encoder.
Definition: ac3enc.c:2045
void(* vector_clipf)(float *dst, const float *src, int len, float min, float max)
Definition: audiodsp.h:49
AVFixedDSPContext * fdsp
Definition: ac3enc.h:170
AC3DSPContext ac3dsp
AC-3 optimized functions.
Definition: ac3enc.h:173
#define av_log(a,...)
av_cold int ff_ac3_float_encode_init(AVCodecContext *avctx)
Definition: ac3enc_float.c:124
int64_t CoefSumType
Definition: ac3enc.h:72
static const AVClass ac3enc_class
Definition: ac3enc_float.c:39
const uint64_t ff_ac3_channel_layouts[19]
List of supported channel layouts.
Definition: ac3enc.c:83
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:194
av_cold AVFloatDSPContext * avpriv_float_dsp_alloc(int bit_exact)
Allocate a float DSP context.
Definition: float_dsp.c:135
static av_cold void ac3_float_mdct_end(AC3EncodeContext *s)
Finalize MDCT and free allocated memory.
Definition: ac3enc_float.c:97
int channels
total number of channels (nchans)
Definition: ac3enc.h:197
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:115
int flags
AV_CODEC_FLAG_*.
Definition: avcodec.h:611
int cpl_on
coupling turned on for this frame
Definition: ac3enc.h:217
const char * name
Name of the codec implementation.
Definition: codec.h:197
#define ff_mdct_init
Definition: fft.h:161
AVCodec ff_ac3_encoder
Definition: ac3enc_float.c:136
#define AC3_BLOCK_SIZE
Definition: ac3.h:36
static SDL_Window * window
Definition: ffplay.c:368
#define AV_CODEC_FLAG_BITEXACT
Use only bitexact stuff (except (I)DCT).
Definition: avcodec.h:333
#define FFMIN(a, b)
Definition: common.h:96
AudioDSPContext adsp
Definition: ac3enc.h:166
static void scale_coefficients(AC3EncodeContext *s)
Definition: ac3enc_float.c:50
#define s(width, name)
Definition: cbs_vp9.c:257
FFTContext mdct
FFT context for MDCT calculation.
Definition: ac3enc.h:174
const SampleType * mdct_window
MDCT window function array.
Definition: ac3enc.h:175
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
main external API structure.
Definition: avcodec.h:531
CoefType * mdct_coef_buffer
Definition: ac3enc.h:243
int(* allocate_sample_buffers)(struct AC3EncodeContext *s)
Definition: ac3enc.h:268
Describe the class of an AVClass context structure.
Definition: log.h:67
static const AVCodecDefault ac3_defaults[]
AC-3 encoder private context.
Definition: ac3enc.h:161
int num_blocks
number of blocks per frame
Definition: ac3enc.h:188
#define COEF_MAX
Definition: ac3enc.h:68
static void clip_coefficients(AudioDSPContext *adsp, float *coef, unsigned int len)
Definition: ac3enc_float.c:63
AC-3 encoder float/fixed template.
common internal api header.
#define ff_mdct_end
Definition: fft.h:162
static const AVOption ac3_options[]
AVCodecContext * avctx
parent AVCodecContext
Definition: ac3enc.h:164
void * priv_data
Definition: avcodec.h:558
int len
static av_cold int ac3_float_mdct_init(AC3EncodeContext *s)
Initialize MDCT tables.
Definition: ac3enc_float.c:109
AC-3 encoder & E-AC-3 encoder common header.
void(* sum_square_butterfly_float)(float sum[4], const float *coef0, const float *coef1, int len)
Definition: ac3dsp.h:99
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:940
const int ff_ac3_sample_rate_tab[]
Definition: ac3tab.c:129
#define av_malloc_array(a, b)
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later.That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another.Frame references ownership and permissions
int32_t CoefType
Definition: ac3enc.h:71
E-AC-3 encoder.
int32_t * fixed_coef_buffer
Definition: ac3enc.h:244
void(* float_to_fixed24)(int32_t *dst, const float *src, unsigned int len)
Convert an array of float in range [-1.0,1.0] to int32_t with range [-(1<<24),(1<<24)].
Definition: ac3dsp.h:56
av_cold int ff_ac3_encode_init(AVCodecContext *avctx)
Definition: ac3enc.c:2438