FFmpeg
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Functions | Variables
apedec.c File Reference

Monkey's Audio lossless audio decoder. More...

#include "libavutil/avassert.h"
#include "libavutil/channel_layout.h"
#include "libavutil/opt.h"
#include "avcodec.h"
#include "dsputil.h"
#include "bytestream.h"
#include "internal.h"

Go to the source code of this file.

Data Structures

struct  APEFilter
 Filters applied to the decoded data. More...
 
struct  APERice
 
struct  APERangecoder
 
struct  APEPredictor
 Filter histories. More...
 
struct  APEContext
 Decoder context. More...
 

Macros

#define MAX_CHANNELS   2
 
#define MAX_BYTESPERSAMPLE   3
 
#define APE_FRAMECODE_MONO_SILENCE   1
 
#define APE_FRAMECODE_STEREO_SILENCE   3
 
#define APE_FRAMECODE_PSEUDO_STEREO   4
 
#define HISTORY_SIZE   512
 
#define PREDICTOR_ORDER   8
 
#define PREDICTOR_SIZE   50
 Total size of all predictor histories.
 
#define YDELAYA   (18 + PREDICTOR_ORDER*4)
 
#define YDELAYB   (18 + PREDICTOR_ORDER*3)
 
#define XDELAYA   (18 + PREDICTOR_ORDER*2)
 
#define XDELAYB   (18 + PREDICTOR_ORDER)
 
#define YADAPTCOEFFSA   18
 
#define XADAPTCOEFFSA   14
 
#define YADAPTCOEFFSB   10
 
#define XADAPTCOEFFSB   5
 
#define APE_FILTER_LEVELS   3
 
#define OFFSET(x)   offsetof(APEContext, x)
 
#define PAR   (AV_OPT_FLAG_DECODING_PARAM | AV_OPT_FLAG_AUDIO_PARAM)
 

Enumerations

enum  APECompressionLevel {
  COMPRESSION_LEVEL_FAST = 1000, COMPRESSION_LEVEL_NORMAL = 2000, COMPRESSION_LEVEL_HIGH = 3000, COMPRESSION_LEVEL_EXTRA_HIGH = 4000,
  COMPRESSION_LEVEL_INSANE = 5000
}
 Possible compression levels. More...
 

Functions

static av_cold int ape_decode_close (AVCodecContext *avctx)
 
static av_cold int ape_decode_init (AVCodecContext *avctx)
 
static void update_rice (APERice *rice, unsigned int x)
 
static int ape_decode_value (APEContext *ctx, APERice *rice)
 
static void entropy_decode (APEContext *ctx, int blockstodecode, int stereo)
 
static int init_entropy_decoder (APEContext *ctx)
 
static void init_predictor_decoder (APEContext *ctx)
 
static int APESIGN (int32_t x)
 Get inverse sign of integer (-1 for positive, 1 for negative and 0 for zero)
 
static av_always_inline int predictor_update_filter (APEPredictor *p, const int decoded, const int filter, const int delayA, const int delayB, const int adaptA, const int adaptB)
 
static void predictor_decode_stereo (APEContext *ctx, int count)
 
static void predictor_decode_mono (APEContext *ctx, int count)
 
static void do_init_filter (APEFilter *f, int16_t *buf, int order)
 
static void init_filter (APEContext *ctx, APEFilter *f, int16_t *buf, int order)
 
static void do_apply_filter (APEContext *ctx, int version, APEFilter *f, int32_t *data, int count, int order, int fracbits)
 
static void apply_filter (APEContext *ctx, APEFilter *f, int32_t *data0, int32_t *data1, int count, int order, int fracbits)
 
static void ape_apply_filters (APEContext *ctx, int32_t *decoded0, int32_t *decoded1, int count)
 
static int init_frame_decoder (APEContext *ctx)
 
static void ape_unpack_mono (APEContext *ctx, int count)
 
static void ape_unpack_stereo (APEContext *ctx, int count)
 
static int ape_decode_frame (AVCodecContext *avctx, void *data, int *got_frame_ptr, AVPacket *avpkt)
 
static void ape_flush (AVCodecContext *avctx)
 

Variables

static const uint16_t ape_filter_orders [5][APE_FILTER_LEVELS]
 Filter orders depending on compression level.
 
static const uint8_t ape_filter_fracbits [5][APE_FILTER_LEVELS]
 Filter fraction bits depending on compression level.
 
static const int32_t initial_coeffs [4]
 
static const AVOption options []
 
static const AVClass ape_decoder_class
 
AVCodec ff_ape_decoder
 

APE range decoding functions

#define CODE_BITS   32
 
#define TOP_VALUE   ((unsigned int)1 << (CODE_BITS-1))
 
#define SHIFT_BITS   (CODE_BITS - 9)
 
#define EXTRA_BITS   ((CODE_BITS-2) % 8 + 1)
 
#define BOTTOM_VALUE   (TOP_VALUE >> 8)
 
#define MODEL_ELEMENTS   64
 
static const uint16_t counts_3970 [22]
 Fixed probabilities for symbols in Monkey Audio version 3.97.
 
static const uint16_t counts_diff_3970 [21]
 Probability ranges for symbols in Monkey Audio version 3.97.
 
static const uint16_t counts_3980 [22]
 Fixed probabilities for symbols in Monkey Audio version 3.98.
 
static const uint16_t counts_diff_3980 [21]
 Probability ranges for symbols in Monkey Audio version 3.98.
 
static void range_start_decoding (APEContext *ctx)
 Start the decoder.
 
static void range_dec_normalize (APEContext *ctx)
 Perform normalization.
 
static int range_decode_culfreq (APEContext *ctx, int tot_f)
 Calculate culmulative frequency for next symbol.
 
static int range_decode_culshift (APEContext *ctx, int shift)
 Decode value with given size in bits.
 
static void range_decode_update (APEContext *ctx, int sy_f, int lt_f)
 Update decoding state.
 
static int range_decode_bits (APEContext *ctx, int n)
 Decode n bits (n <= 16) without modelling.
 
static int range_get_symbol (APEContext *ctx, const uint16_t counts[], const uint16_t counts_diff[])
 Decode symbol.
 

Detailed Description

Monkey's Audio lossless audio decoder.

Definition in file apedec.c.

Macro Definition Documentation

#define MAX_CHANNELS   2

Definition at line 36 of file apedec.c.

#define MAX_BYTESPERSAMPLE   3

Definition at line 37 of file apedec.c.

#define APE_FRAMECODE_MONO_SILENCE   1

Definition at line 39 of file apedec.c.

#define APE_FRAMECODE_STEREO_SILENCE   3

Definition at line 40 of file apedec.c.

Referenced by ape_unpack_mono(), and ape_unpack_stereo().

#define APE_FRAMECODE_PSEUDO_STEREO   4

Definition at line 41 of file apedec.c.

Referenced by ape_decode_frame().

#define HISTORY_SIZE   512
#define PREDICTOR_ORDER   8

Definition at line 44 of file apedec.c.

#define PREDICTOR_SIZE   50

Total size of all predictor histories.

Definition at line 46 of file apedec.c.

Referenced by init_predictor_decoder(), predictor_decode_mono(), and predictor_decode_stereo().

#define YDELAYA   (18 + PREDICTOR_ORDER*4)

Definition at line 48 of file apedec.c.

Referenced by predictor_decode_mono(), and predictor_decode_stereo().

#define YDELAYB   (18 + PREDICTOR_ORDER*3)

Definition at line 49 of file apedec.c.

Referenced by predictor_decode_stereo().

#define XDELAYA   (18 + PREDICTOR_ORDER*2)

Definition at line 50 of file apedec.c.

Referenced by predictor_decode_stereo().

#define XDELAYB   (18 + PREDICTOR_ORDER)

Definition at line 51 of file apedec.c.

Referenced by predictor_decode_stereo().

#define YADAPTCOEFFSA   18

Definition at line 53 of file apedec.c.

Referenced by predictor_decode_mono(), and predictor_decode_stereo().

#define XADAPTCOEFFSA   14

Definition at line 54 of file apedec.c.

Referenced by predictor_decode_stereo().

#define YADAPTCOEFFSB   10

Definition at line 55 of file apedec.c.

Referenced by predictor_decode_stereo().

#define XADAPTCOEFFSB   5

Definition at line 56 of file apedec.c.

Referenced by predictor_decode_stereo().

#define APE_FILTER_LEVELS   3

Definition at line 71 of file apedec.c.

Referenced by ape_apply_filters(), ape_decode_close(), ape_decode_init(), and init_frame_decoder().

#define CODE_BITS   32

Definition at line 248 of file apedec.c.

#define TOP_VALUE   ((unsigned int)1 << (CODE_BITS-1))

Definition at line 249 of file apedec.c.

#define SHIFT_BITS   (CODE_BITS - 9)

Definition at line 250 of file apedec.c.

#define EXTRA_BITS   ((CODE_BITS-2) % 8 + 1)

Definition at line 251 of file apedec.c.

Referenced by range_start_decoding().

#define BOTTOM_VALUE   (TOP_VALUE >> 8)

Definition at line 252 of file apedec.c.

Referenced by range_dec_normalize().

#define MODEL_ELEMENTS   64

Definition at line 325 of file apedec.c.

Referenced by ape_decode_value().

#define OFFSET (   x)    offsetof(APEContext, x)

Definition at line 963 of file apedec.c.

Definition at line 964 of file apedec.c.

Enumeration Type Documentation

Possible compression levels.

Enumerator:
COMPRESSION_LEVEL_FAST 
COMPRESSION_LEVEL_NORMAL 
COMPRESSION_LEVEL_HIGH 
COMPRESSION_LEVEL_EXTRA_HIGH 
COMPRESSION_LEVEL_INSANE 

Definition at line 62 of file apedec.c.

Function Documentation

static av_cold int ape_decode_close ( AVCodecContext avctx)
static

Definition at line 168 of file apedec.c.

Referenced by ape_decode_init().

static av_cold int ape_decode_init ( AVCodecContext avctx)
static

Definition at line 183 of file apedec.c.

static void range_start_decoding ( APEContext ctx)
inlinestatic

Start the decoder.

Definition at line 255 of file apedec.c.

Referenced by init_entropy_decoder().

static void range_dec_normalize ( APEContext ctx)
inlinestatic

Perform normalization.

Definition at line 263 of file apedec.c.

Referenced by range_decode_culfreq(), and range_decode_culshift().

static int range_decode_culfreq ( APEContext ctx,
int  tot_f 
)
inlinestatic

Calculate culmulative frequency for next symbol.

Does NO update!

Parameters
ctxdecoder context
tot_fis the total frequency or (code_value)1<<shift
Returns
the culmulative frequency

Definition at line 284 of file apedec.c.

Referenced by ape_decode_value().

static int range_decode_culshift ( APEContext ctx,
int  shift 
)
inlinestatic

Decode value with given size in bits.

Parameters
ctxdecoder context
shiftnumber of bits to decode

Definition at line 296 of file apedec.c.

Referenced by range_decode_bits(), and range_get_symbol().

static void range_decode_update ( APEContext ctx,
int  sy_f,
int  lt_f 
)
inlinestatic

Update decoding state.

Parameters
ctxdecoder context
sy_fthe interval length (frequency of the symbol)
lt_fthe lower end (frequency sum of < symbols)

Definition at line 310 of file apedec.c.

Referenced by ape_decode_value(), range_decode_bits(), and range_get_symbol().

static int range_decode_bits ( APEContext ctx,
int  n 
)
inlinestatic

Decode n bits (n <= 16) without modelling.

Definition at line 317 of file apedec.c.

Referenced by ape_decode_value().

static int range_get_symbol ( APEContext ctx,
const uint16_t  counts[],
const uint16_t  counts_diff[] 
)
inlinestatic

Decode symbol.

Parameters
ctxdecoder context
countsprobability range start position
counts_diffprobability range widths

Definition at line 369 of file apedec.c.

Referenced by ape_decode_value().

static void update_rice ( APERice rice,
unsigned int  x 
)
inlinestatic

Definition at line 393 of file apedec.c.

Referenced by ape_decode_value().

static int ape_decode_value ( APEContext ctx,
APERice rice 
)
inlinestatic

Definition at line 404 of file apedec.c.

Referenced by entropy_decode().

static void entropy_decode ( APEContext ctx,
int  blockstodecode,
int  stereo 
)
static

Definition at line 474 of file apedec.c.

Referenced by ape_unpack_mono(), and ape_unpack_stereo().

static int init_entropy_decoder ( APEContext ctx)
static

Definition at line 486 of file apedec.c.

Referenced by init_frame_decoder().

static void init_predictor_decoder ( APEContext ctx)
static

Definition at line 521 of file apedec.c.

Referenced by init_frame_decoder().

static int APESIGN ( int32_t  x)
inlinestatic

Get inverse sign of integer (-1 for positive, 1 for negative and 0 for zero)

Definition at line 540 of file apedec.c.

Referenced by do_apply_filter(), predictor_decode_mono(), and predictor_update_filter().

static av_always_inline int predictor_update_filter ( APEPredictor p,
const int  decoded,
const int  filter,
const int  delayA,
const int  delayB,
const int  adaptA,
const int  adaptB 
)
static

Definition at line 544 of file apedec.c.

Referenced by predictor_decode_stereo().

static void predictor_decode_stereo ( APEContext ctx,
int  count 
)
static

Definition at line 591 of file apedec.c.

Referenced by ape_unpack_stereo().

static void predictor_decode_mono ( APEContext ctx,
int  count 
)
static

Definition at line 618 of file apedec.c.

Referenced by ape_unpack_mono().

static void do_init_filter ( APEFilter f,
int16_t *  buf,
int  order 
)
static

Definition at line 664 of file apedec.c.

Referenced by init_filter().

static void init_filter ( APEContext ctx,
APEFilter f,
int16_t *  buf,
int  order 
)
static

Definition at line 676 of file apedec.c.

Referenced by init_frame_decoder().

static void do_apply_filter ( APEContext ctx,
int  version,
APEFilter f,
int32_t data,
int  count,
int  order,
int  fracbits 
)
static

Definition at line 682 of file apedec.c.

Referenced by apply_filter().

static void apply_filter ( APEContext ctx,
APEFilter f,
int32_t data0,
int32_t data1,
int  count,
int  order,
int  fracbits 
)
static

Definition at line 735 of file apedec.c.

Referenced by ape_apply_filters().

static void ape_apply_filters ( APEContext ctx,
int32_t decoded0,
int32_t decoded1,
int  count 
)
static

Definition at line 744 of file apedec.c.

Referenced by ape_unpack_mono(), and ape_unpack_stereo().

static int init_frame_decoder ( APEContext ctx)
static

Definition at line 758 of file apedec.c.

Referenced by ape_decode_frame().

static void ape_unpack_mono ( APEContext ctx,
int  count 
)
static

Definition at line 774 of file apedec.c.

Referenced by ape_decode_frame().

static void ape_unpack_stereo ( APEContext ctx,
int  count 
)
static

Definition at line 794 of file apedec.c.

Referenced by ape_decode_frame().

static int ape_decode_frame ( AVCodecContext avctx,
void data,
int *  got_frame_ptr,
AVPacket avpkt 
)
static

Definition at line 822 of file apedec.c.

static void ape_flush ( AVCodecContext avctx)
static

Definition at line 957 of file apedec.c.

Variable Documentation

const uint16_t ape_filter_orders[5][APE_FILTER_LEVELS]
static
Initial value:
= {
{ 0, 0, 0 },
{ 16, 0, 0 },
{ 64, 0, 0 },
{ 32, 256, 0 },
{ 16, 256, 1280 }
}

Filter orders depending on compression level.

Definition at line 74 of file apedec.c.

Referenced by ape_apply_filters(), ape_decode_init(), and init_frame_decoder().

const uint8_t ape_filter_fracbits[5][APE_FILTER_LEVELS]
static
Initial value:
= {
{ 0, 0, 0 },
{ 11, 0, 0 },
{ 11, 0, 0 },
{ 10, 13, 0 },
{ 11, 13, 15 }
}

Filter fraction bits depending on compression level.

Definition at line 83 of file apedec.c.

Referenced by ape_apply_filters().

const uint16_t counts_3970[22]
static
Initial value:
= {
0, 14824, 28224, 39348, 47855, 53994, 58171, 60926,
62682, 63786, 64463, 64878, 65126, 65276, 65365, 65419,
65450, 65469, 65480, 65487, 65491, 65493,
}

Fixed probabilities for symbols in Monkey Audio version 3.97.

Definition at line 330 of file apedec.c.

Referenced by ape_decode_value().

const uint16_t counts_diff_3970[21]
static
Initial value:
= {
14824, 13400, 11124, 8507, 6139, 4177, 2755, 1756,
1104, 677, 415, 248, 150, 89, 54, 31,
19, 11, 7, 4, 2,
}

Probability ranges for symbols in Monkey Audio version 3.97.

Definition at line 339 of file apedec.c.

Referenced by ape_decode_value().

const uint16_t counts_3980[22]
static
Initial value:
= {
0, 19578, 36160, 48417, 56323, 60899, 63265, 64435,
64971, 65232, 65351, 65416, 65447, 65466, 65476, 65482,
65485, 65488, 65490, 65491, 65492, 65493,
}

Fixed probabilities for symbols in Monkey Audio version 3.98.

Definition at line 348 of file apedec.c.

Referenced by ape_decode_value().

const uint16_t counts_diff_3980[21]
static
Initial value:
= {
19578, 16582, 12257, 7906, 4576, 2366, 1170, 536,
261, 119, 65, 31, 19, 10, 6, 3,
3, 2, 1, 1, 1,
}

Probability ranges for symbols in Monkey Audio version 3.98.

Definition at line 357 of file apedec.c.

Referenced by ape_decode_value().

const int32_t initial_coeffs[4]
static
Initial value:
= {
360, 317, -109, 98
}

Definition at line 517 of file apedec.c.

Referenced by init_predictor_decoder().

const AVOption options[]
static
Initial value:
= {
{ "max_samples", "maximum number of samples decoded per call", OFFSET(blocks_per_loop), AV_OPT_TYPE_INT, { .i64 = 4608 }, 1, INT_MAX, PAR, "max_samples" },
{ "all", "no maximum. decode all samples for each packet at once", 0, AV_OPT_TYPE_CONST, { .i64 = INT_MAX }, INT_MIN, INT_MAX, PAR, "max_samples" },
{ NULL},
}

Definition at line 965 of file apedec.c.

const AVClass ape_decoder_class
static
Initial value:
= {
.class_name = "APE decoder",
.item_name = av_default_item_name,
.option = options,
}

Definition at line 971 of file apedec.c.

AVCodec ff_ape_decoder
Initial value:
= {
.name = "ape",
.priv_data_size = sizeof(APEContext),
.long_name = NULL_IF_CONFIG_SMALL("Monkey's Audio"),
.sample_fmts = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_U8P,
.priv_class = &ape_decoder_class,
}

Definition at line 978 of file apedec.c.