common.h File Reference

#include "samplerate.h"

Include dependency graph for common.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	SRC_PRIVATE_tag

Macros
#define	SRC_MAX_RATIO   256
#define	SRC_MAX_RATIO_STR   "256"
#define	SRC_MIN_RATIO_DIFF   (1e-20)
#define	MAX(a, b)   (((a) > (b)) ? (a) : (b))
#define	MIN(a, b)   (((a) < (b)) ? (a) : (b))
#define	ARRAY_LEN(x)   ((int) (sizeof (x) / sizeof ((x) [0])))
#define	OFFSETOF(type, member)   ((int) (&((type*) 0)->member))
#define	MAKE_MAGIC(a, b, c, d, e, f)   ((a) + ((b) << 4) + ((c) << 8) + ((d) << 12) + ((e) << 16) + ((f) << 20))
#define	UNUSED(x)   x
#define	WARN_UNUSED

Typedefs
typedef struct SRC_PRIVATE_tag	SRC_PRIVATE

Enumerations
enum	{ SRC_FALSE = 0 , SRC_TRUE = 1 , SRC_MODE_PROCESS = 555 , SRC_MODE_CALLBACK = 556 }
enum	{   SRC_ERR_NO_ERROR = 0 , SRC_ERR_MALLOC_FAILED , SRC_ERR_BAD_STATE , SRC_ERR_BAD_DATA ,   SRC_ERR_BAD_DATA_PTR , SRC_ERR_NO_PRIVATE , SRC_ERR_BAD_SRC_RATIO , SRC_ERR_BAD_PROC_PTR ,   SRC_ERR_SHIFT_BITS , SRC_ERR_FILTER_LEN , SRC_ERR_BAD_CONVERTER , SRC_ERR_BAD_CHANNEL_COUNT ,   SRC_ERR_SINC_BAD_BUFFER_LEN , SRC_ERR_SIZE_INCOMPATIBILITY , SRC_ERR_BAD_PRIV_PTR , SRC_ERR_BAD_SINC_STATE ,   SRC_ERR_DATA_OVERLAP , SRC_ERR_BAD_CALLBACK , SRC_ERR_BAD_MODE , SRC_ERR_NULL_CALLBACK ,   SRC_ERR_NO_VARIABLE_RATIO , SRC_ERR_SINC_PREPARE_DATA_BAD_LEN , SRC_ERR_BAD_INTERNAL_STATE , SRC_ERR_MAX_ERROR }

Functions
const char *	sinc_get_name (int src_enum)
const char *	sinc_get_description (int src_enum)
int	sinc_set_converter (SRC_PRIVATE *psrc, int src_enum)
const char *	linear_get_name (int src_enum)
const char *	linear_get_description (int src_enum)
int	linear_set_converter (SRC_PRIVATE *psrc, int src_enum)
const char *	zoh_get_name (int src_enum)
const char *	zoh_get_description (int src_enum)
int	zoh_set_converter (SRC_PRIVATE *psrc, int src_enum)
static double	fmod_one (double x)
static int	is_bad_src_ratio (double ratio)

Macro Definition Documentation

ARRAY_LEN

#define ARRAY_LEN

(

x

)

((int) (sizeof (x) / sizeof ((x) [0])))

Definition at line 28 of file common.h.

MAKE_MAGIC

#define MAKE_MAGIC	(		a,
			b,
			c,
			d,
			e,
			f
	)		((a) + ((b) << 4) + ((c) << 8) + ((d) << 12) + ((e) << 16) + ((f) << 20))

Definition at line 31 of file common.h.

MAX

#define MAX	(		a,
			b
	)		(((a) > (b)) ? (a) : (b))

Definition at line 25 of file common.h.

MIN

#define MIN	(		a,
			b
	)		(((a) < (b)) ? (a) : (b))

Definition at line 26 of file common.h.

OFFSETOF

#define OFFSETOF	(		type,
			member
	)		((int) (&((type*) 0)->member))

Definition at line 29 of file common.h.

SRC_MAX_RATIO

#define SRC_MAX_RATIO   256

Definition at line 20 of file common.h.

SRC_MAX_RATIO_STR

#define SRC_MAX_RATIO_STR   "256"

Definition at line 21 of file common.h.

SRC_MIN_RATIO_DIFF

#define SRC_MIN_RATIO_DIFF   (1e-20)

Definition at line 23 of file common.h.

UNUSED

#define UNUSED

(

x

)

x

Definition at line 42 of file common.h.

WARN_UNUSED

#define WARN_UNUSED

Definition at line 48 of file common.h.

Typedef Documentation

SRC_PRIVATE

typedef struct SRC_PRIVATE_tag SRC_PRIVATE

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
SRC_FALSE
SRC_TRUE
SRC_MODE_PROCESS
SRC_MODE_CALLBACK

Definition at line 54 of file common.h.

{   SRC_FALSE   = 0,
    SRC_TRUE    = 1,
 
    SRC_MODE_PROCESS    = 555,
    SRC_MODE_CALLBACK   = 556
} ;

anonymous enum

anonymous enum

Enumerator
SRC_ERR_NO_ERROR
SRC_ERR_MALLOC_FAILED
SRC_ERR_BAD_STATE
SRC_ERR_BAD_DATA
SRC_ERR_BAD_DATA_PTR
SRC_ERR_NO_PRIVATE
SRC_ERR_BAD_SRC_RATIO
SRC_ERR_BAD_PROC_PTR
SRC_ERR_SHIFT_BITS
SRC_ERR_FILTER_LEN
SRC_ERR_BAD_CONVERTER
SRC_ERR_BAD_CHANNEL_COUNT
SRC_ERR_SINC_BAD_BUFFER_LEN
SRC_ERR_SIZE_INCOMPATIBILITY
SRC_ERR_BAD_PRIV_PTR
SRC_ERR_BAD_SINC_STATE
SRC_ERR_DATA_OVERLAP
SRC_ERR_BAD_CALLBACK
SRC_ERR_BAD_MODE
SRC_ERR_NULL_CALLBACK
SRC_ERR_NO_VARIABLE_RATIO
SRC_ERR_SINC_PREPARE_DATA_BAD_LEN
SRC_ERR_BAD_INTERNAL_STATE
SRC_ERR_MAX_ERROR

Definition at line 62 of file common.h.

{   SRC_ERR_NO_ERROR = 0,
 
    SRC_ERR_MALLOC_FAILED,
    SRC_ERR_BAD_STATE,
    SRC_ERR_BAD_DATA,
    SRC_ERR_BAD_DATA_PTR,
    SRC_ERR_NO_PRIVATE,
    SRC_ERR_BAD_SRC_RATIO,
    SRC_ERR_BAD_PROC_PTR,
    SRC_ERR_SHIFT_BITS,
    SRC_ERR_FILTER_LEN,
    SRC_ERR_BAD_CONVERTER,
    SRC_ERR_BAD_CHANNEL_COUNT,
    SRC_ERR_SINC_BAD_BUFFER_LEN,
    SRC_ERR_SIZE_INCOMPATIBILITY,
    SRC_ERR_BAD_PRIV_PTR,
    SRC_ERR_BAD_SINC_STATE,
    SRC_ERR_DATA_OVERLAP,
    SRC_ERR_BAD_CALLBACK,
    SRC_ERR_BAD_MODE,
    SRC_ERR_NULL_CALLBACK,
    SRC_ERR_NO_VARIABLE_RATIO,
    SRC_ERR_SINC_PREPARE_DATA_BAD_LEN,
    SRC_ERR_BAD_INTERNAL_STATE,
 
    /* This must be the last error number. */
    SRC_ERR_MAX_ERROR
} ;

Function Documentation

fmod_one()

static double fmod_one ( double  x )

inlinestatic

Definition at line 143 of file common.h.

{   double res ;
 
    res = x - lrint (x) ;
    if (res < 0.0)
        return res + 1.0 ;
 
    return res ;
} /* fmod_one */

Referenced by linear_vari_process(), sinc_hex_vari_process(), sinc_mono_vari_process(), sinc_multichan_vari_process(), sinc_quad_vari_process(), sinc_stereo_vari_process(), and zoh_vari_process().

is_bad_src_ratio()

static int is_bad_src_ratio ( double  ratio )

inlinestatic

Definition at line 154 of file common.h.

{   return (ratio < (1.0 / SRC_MAX_RATIO) || ratio > (1.0 * SRC_MAX_RATIO)) ;
} /* is_bad_src_ratio */

Referenced by linear_vari_process(), sinc_hex_vari_process(), sinc_mono_vari_process(), sinc_multichan_vari_process(), sinc_quad_vari_process(), sinc_stereo_vari_process(), src_callback_read(), src_is_valid_ratio(), src_process(), src_set_ratio(), and zoh_vari_process().

linear_get_description()

const char * linear_get_description

(

int

src_enum

)

Definition at line 146 of file src_linear.c.

{
    if (src_enum == SRC_LINEAR)
        return "Linear interpolator, very fast, poor quality." ;
 
    return NULL ;
} /* linear_get_descrition */

Referenced by src_get_description().

linear_get_name()

const char * linear_get_name

(

int

src_enum

)

Definition at line 137 of file src_linear.c.

{
    if (src_enum == SRC_LINEAR)
        return "Linear Interpolator" ;
 
    return NULL ;
} /* linear_get_name */

Referenced by src_get_name().

linear_set_converter()

int linear_set_converter	(	SRC_PRIVATE *	psrc,
		int	src_enum
	)

Definition at line 155 of file src_linear.c.

{   LINEAR_DATA *priv = NULL ;
 
    if (src_enum != SRC_LINEAR)
        return SRC_ERR_BAD_CONVERTER ;
 
    if (psrc->private_data != NULL)
    {   free (psrc->private_data) ;
        psrc->private_data = NULL ;
        } ;
 
    if (psrc->private_data == NULL)
    {   priv = calloc (1, sizeof (*priv) + psrc->channels * sizeof (float)) ;
        psrc->private_data = priv ;
        } ;
 
    if (priv == NULL)
        return SRC_ERR_MALLOC_FAILED ;
 
    priv->linear_magic_marker = LINEAR_MAGIC_MARKER ;
    priv->channels = psrc->channels ;
 
    psrc->const_process = linear_vari_process ;
    psrc->vari_process = linear_vari_process ;
    psrc->reset = linear_reset ;
 
    linear_reset (psrc) ;
 
    return SRC_ERR_NO_ERROR ;
} /* linear_set_converter */

Referenced by psrc_set_converter().

sinc_get_description()

const char * sinc_get_description

(

int

src_enum

)

Definition at line 113 of file src_sinc.c.

{
    switch (src_enum)
    {   case SRC_SINC_FASTEST :
            return "Band limited sinc interpolation, fastest, 97dB SNR, 80% BW." ;
 
        case SRC_SINC_MEDIUM_QUALITY :
            return "Band limited sinc interpolation, medium quality, 121dB SNR, 90% BW." ;
 
        case SRC_SINC_BEST_QUALITY :
            return "Band limited sinc interpolation, best quality, 144dB SNR, 96% BW." ;
 
        default :
            break ;
        } ;
 
    return NULL ;
} /* sinc_get_descrition */

Referenced by src_get_description().

sinc_get_name()

const char * sinc_get_name

(

int

src_enum

)

Definition at line 94 of file src_sinc.c.

{
    switch (src_enum)
    {   case SRC_SINC_BEST_QUALITY :
            return "Best Sinc Interpolator" ;
 
        case SRC_SINC_MEDIUM_QUALITY :
            return "Medium Sinc Interpolator" ;
 
        case SRC_SINC_FASTEST :
            return "Fastest Sinc Interpolator" ;
 
        default: break ;
        } ;
 
    return NULL ;
} /* sinc_get_descrition */

Referenced by src_get_name().

sinc_set_converter()

int sinc_set_converter	(	SRC_PRIVATE *	psrc,
		int	src_enum
	)

Definition at line 133 of file src_sinc.c.

{   SINC_FILTER *filter, temp_filter ;
    increment_t count ;
    int bits ;
 
    /* Quick sanity check. */
    if (SHIFT_BITS >= sizeof (increment_t) * 8 - 1)
        return SRC_ERR_SHIFT_BITS ;
 
    if (psrc->private_data != NULL)
    {   free (psrc->private_data) ;
        psrc->private_data = NULL ;
        } ;
 
    memset (&temp_filter, 0, sizeof (temp_filter)) ;
 
    temp_filter.sinc_magic_marker = SINC_MAGIC_MARKER ;
    temp_filter.channels = psrc->channels ;
 
    if (psrc->channels > ARRAY_LEN (temp_filter.left_calc))
        return SRC_ERR_BAD_CHANNEL_COUNT ;
    else if (psrc->channels == 1)
    {   psrc->const_process = sinc_mono_vari_process ;
        psrc->vari_process = sinc_mono_vari_process ;
        }
    else
    if (psrc->channels == 2)
    {   psrc->const_process = sinc_stereo_vari_process ;
        psrc->vari_process = sinc_stereo_vari_process ;
        }
    else
    if (psrc->channels == 4)
    {   psrc->const_process = sinc_quad_vari_process ;
        psrc->vari_process = sinc_quad_vari_process ;
        }
    else
    if (psrc->channels == 6)
    {   psrc->const_process = sinc_hex_vari_process ;
        psrc->vari_process = sinc_hex_vari_process ;
        }
    else
    {   psrc->const_process = sinc_multichan_vari_process ;
        psrc->vari_process = sinc_multichan_vari_process ;
        } ;
    psrc->reset = sinc_reset ;
 
    switch (src_enum)
    {   case SRC_SINC_FASTEST :
                temp_filter.coeffs = fastest_coeffs.coeffs ;
                temp_filter.coeff_half_len = ARRAY_LEN (fastest_coeffs.coeffs) - 2 ;
                temp_filter.index_inc = fastest_coeffs.increment ;
                break ;
 
        case SRC_SINC_MEDIUM_QUALITY :
                temp_filter.coeffs = slow_mid_qual_coeffs.coeffs ;
                temp_filter.coeff_half_len = ARRAY_LEN (slow_mid_qual_coeffs.coeffs) - 2 ;
                temp_filter.index_inc = slow_mid_qual_coeffs.increment ;
                break ;
 
        case SRC_SINC_BEST_QUALITY :
                temp_filter.coeffs = slow_high_qual_coeffs.coeffs ;
                temp_filter.coeff_half_len = ARRAY_LEN (slow_high_qual_coeffs.coeffs) - 2 ;
                temp_filter.index_inc = slow_high_qual_coeffs.increment ;
                break ;
 
        default :
                return SRC_ERR_BAD_CONVERTER ;
        } ;
 
    /*
    ** FIXME : This needs to be looked at more closely to see if there is
    ** a better way. Need to look at prepare_data () at the same time.
    */
 
    temp_filter.b_len = lrint (2.5 * temp_filter.coeff_half_len / (temp_filter.index_inc * 1.0) * SRC_MAX_RATIO) ;
    temp_filter.b_len = MAX (temp_filter.b_len, 4096) ;
    temp_filter.b_len *= temp_filter.channels ;
 
    if ((filter = calloc (1, sizeof (SINC_FILTER) + sizeof (filter->buffer [0]) * (temp_filter.b_len + temp_filter.channels))) == NULL)
        return SRC_ERR_MALLOC_FAILED ;
 
    *filter = temp_filter ;
    memset (&temp_filter, 0xEE, sizeof (temp_filter)) ;
 
    psrc->private_data = filter ;
 
    sinc_reset (psrc) ;
 
    count = filter->coeff_half_len ;
    for (bits = 0 ; (MAKE_INCREMENT_T (1) << bits) < count ; bits++)
        count |= (MAKE_INCREMENT_T (1) << bits) ;
 
    if (bits + SHIFT_BITS - 1 >= (int) (sizeof (increment_t) * 8))
        return SRC_ERR_FILTER_LEN ;
 
    return SRC_ERR_NO_ERROR ;
} /* sinc_set_converter */

Referenced by psrc_set_converter().

zoh_get_description()

const char * zoh_get_description

(

int

src_enum

)

Definition at line 137 of file src_zoh.c.

{
    if (src_enum == SRC_ZERO_ORDER_HOLD)
        return "Zero order hold interpolator, very fast, poor quality." ;
 
    return NULL ;
} /* zoh_get_descrition */

Referenced by src_get_description().

zoh_get_name()

const char * zoh_get_name

(

int

src_enum

)

Definition at line 128 of file src_zoh.c.

{
    if (src_enum == SRC_ZERO_ORDER_HOLD)
        return "ZOH Interpolator" ;
 
    return NULL ;
} /* zoh_get_name */

Referenced by src_get_name().

zoh_set_converter()

int zoh_set_converter	(	SRC_PRIVATE *	psrc,
		int	src_enum
	)

Definition at line 146 of file src_zoh.c.

{   ZOH_DATA *priv = NULL ;
 
    if (src_enum != SRC_ZERO_ORDER_HOLD)
        return SRC_ERR_BAD_CONVERTER ;
 
    if (psrc->private_data != NULL)
    {   free (psrc->private_data) ;
        psrc->private_data = NULL ;
        } ;
 
    if (psrc->private_data == NULL)
    {   priv = calloc (1, sizeof (*priv) + psrc->channels * sizeof (float)) ;
        psrc->private_data = priv ;
        } ;
 
    if (priv == NULL)
        return SRC_ERR_MALLOC_FAILED ;
 
    priv->zoh_magic_marker = ZOH_MAGIC_MARKER ;
    priv->channels = psrc->channels ;
 
    psrc->const_process = zoh_vari_process ;
    psrc->vari_process = zoh_vari_process ;
    psrc->reset = zoh_reset ;
 
    zoh_reset (psrc) ;
 
    return SRC_ERR_NO_ERROR ;
} /* zoh_set_converter */

Referenced by psrc_set_converter().