Genesis-Plus-GX/source/sound/SRC/samplerate.c

/*
** Copyright (C) 2002-2008 Erik de Castro Lopo <erikd@mega-nerd.com>
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
*/

/*
** This code is part of Secret Rabibt Code aka libsamplerate. A commercial
** use license for this code is available, please see:
**    http://www.mega-nerd.com/SRC/procedure.html
*/

#include  <stdio.h>
#include  <stdlib.h>
#include  <string.h>

#include  "config.h"

#include  "samplerate.h"
#include  "float_cast.h"
#include  "common.h"

static int psrc_set_converter (SRC_PRIVATE  *psrc, int converter_type) ;


static inline int
is_bad_src_ratio (double ratio)
{  return (ratio < (1.0 / SRC_MAX_RATIO) || ratio > (1.0 * SRC_MAX_RATIO)) ;
} /* is_bad_src_ratio */

SRC_STATE *
src_new (int converter_type, int channels, int *error)
{  SRC_PRIVATE  *psrc ;

  if (error)
    *error = SRC_ERR_NO_ERROR ;

  if (channels < 1)
  {  if (error)
      *error = SRC_ERR_BAD_CHANNEL_COUNT ;
    return NULL ;
    } ;

  if ((psrc = calloc (1, sizeof (*psrc))) == NULL)
  {  if (error)
      *error = SRC_ERR_MALLOC_FAILED ;
    return NULL ;
    } ;

  psrc->channels = channels ;
  psrc->mode = SRC_MODE_PROCESS ;

  if (psrc_set_converter (psrc, converter_type) != SRC_ERR_NO_ERROR)
  {  if (error)
      *error = SRC_ERR_BAD_CONVERTER ;
    free (psrc) ;
    psrc = NULL ;
    } ;

  src_reset ((SRC_STATE*) psrc) ;

  return (SRC_STATE*) psrc ;
} /* src_new */

SRC_STATE*
src_callback_new (src_callback_t func, int converter_type, int channels, int *error, void* cb_data)
{  SRC_STATE  *src_state ;

  if (func == NULL)
  {  if (error)
      *error = SRC_ERR_BAD_CALLBACK ;
    return NULL ;
    } ;

  if (error != NULL)
    *error = 0 ;

  src_state = src_new (converter_type, channels, error) ;

  src_reset (src_state) ;

  ((SRC_PRIVATE*) src_state)->mode = SRC_MODE_CALLBACK ;
  ((SRC_PRIVATE*) src_state)->callback_func = func ;
  ((SRC_PRIVATE*) src_state)->user_callback_data = cb_data ;

  return src_state ;
} /* src_callback_new */

SRC_STATE *
src_delete (SRC_STATE *state)
{  SRC_PRIVATE *psrc ;

  psrc = (SRC_PRIVATE*) state ;
  if (psrc)
  {  if (psrc->private_data)
      free (psrc->private_data) ;
    memset (psrc, 0, sizeof (SRC_PRIVATE)) ;
    free (psrc) ;
    } ;

  return NULL ;
} /* src_state */

int
src_process (SRC_STATE *state, SRC_DATA *data)
{  SRC_PRIVATE *psrc ;
  int error ;

  psrc = (SRC_PRIVATE*) state ;

  if (psrc == NULL)
    return SRC_ERR_BAD_STATE ;
  if (psrc->vari_process == NULL || psrc->const_process == NULL)
    return SRC_ERR_BAD_PROC_PTR ;

  if (psrc->mode != SRC_MODE_PROCESS)
    return SRC_ERR_BAD_MODE ;

  /* Check for valid SRC_DATA first. */
  if (data == NULL)
    return SRC_ERR_BAD_DATA ;

  /* Check src_ratio is in range. */
  if (is_bad_src_ratio (data->src_ratio))
    return SRC_ERR_BAD_SRC_RATIO ;

  /* And that data_in and data_out are valid. */
  if (data->data_in == NULL || data->data_out == NULL)
    return SRC_ERR_BAD_DATA_PTR ;

  if (data->data_in == NULL)
    data->input_frames = 0 ;

  if (data->input_frames < 0)
    data->input_frames = 0 ;
  if (data->output_frames < 0)
    data->output_frames = 0 ;

  if (data->data_in < data->data_out)
  {  if (data->data_in + data->input_frames * psrc->channels > data->data_out)
    {  /*-printf ("\n\ndata_in: %p    data_out: %p\n",
        (void*) (data->data_in + data->input_frames * psrc->channels), (void*) data->data_out) ;-*/
      return SRC_ERR_DATA_OVERLAP ;
      } ;
    }
  else if (data->data_out + data->output_frames * psrc->channels > data->data_in)
  {  /*-printf ("\n\ndata_in : %p   ouput frames: %ld    data_out: %p\n", (void*) data->data_in, data->output_frames, (void*) data->data_out) ;

    printf ("data_out: %p (%p)    data_in: %p\n", (void*) data->data_out,
      (void*) (data->data_out + data->input_frames * psrc->channels), (void*) data->data_in) ;-*/
    return SRC_ERR_DATA_OVERLAP ;
    } ;

  /* Set the input and output counts to zero. */
  data->input_frames_used = 0 ;
  data->output_frames_gen = 0 ;

  /* Special case for when last_ratio has not been set. */
  if (psrc->last_ratio < (1.0 / SRC_MAX_RATIO))
    psrc->last_ratio = data->src_ratio ;

  /* Now process. */
  if (fabs (psrc->last_ratio - data->src_ratio) < 1e-15)
    error = psrc->const_process (psrc, data) ;
  else
    error = psrc->vari_process (psrc, data) ;

  return error ;
} /* src_process */

long
src_callback_read (SRC_STATE *state, double src_ratio, long frames, float *data)
{  SRC_PRIVATE  *psrc ;
  SRC_DATA  src_data ;

  long  output_frames_gen ;
  int    error = 0 ;

  if (state == NULL)
    return 0 ;

  if (frames <= 0)
    return 0 ;

  psrc = (SRC_PRIVATE*) state ;

  if (psrc->mode != SRC_MODE_CALLBACK)
  {  psrc->error = SRC_ERR_BAD_MODE ;
    return 0 ;
    } ;

  if (psrc->callback_func == NULL)
  {  psrc->error = SRC_ERR_NULL_CALLBACK ;
    return 0 ;
    } ;

  memset (&src_data, 0, sizeof (src_data)) ;

  /* Check src_ratio is in range. */
  if (is_bad_src_ratio (src_ratio))
  {  psrc->error = SRC_ERR_BAD_SRC_RATIO ;
    return 0 ;
    } ;

  /* Switch modes temporarily. */
  src_data.src_ratio = src_ratio ;
  src_data.data_out = data ;
  src_data.output_frames = frames ;

  src_data.data_in = psrc->saved_data ;
  src_data.input_frames = psrc->saved_frames ;

  output_frames_gen = 0 ;
  while (output_frames_gen < frames)
  {
    if (src_data.input_frames == 0)
    {  float *ptr ;

      src_data.input_frames = psrc->callback_func (psrc->user_callback_data, &ptr) ;
      src_data.data_in = ptr ;

      if (src_data.input_frames == 0)
        src_data.end_of_input = 1 ;
      } ;

    /*
    ** Now call process function. However, we need to set the mode
    ** to SRC_MODE_PROCESS first and when we return set it back to
    ** SRC_MODE_CALLBACK.
    */
    psrc->mode = SRC_MODE_PROCESS ;
    error = src_process (state, &src_data) ;
    psrc->mode = SRC_MODE_CALLBACK ;

    if (error != 0)
      break ;

    src_data.data_in += src_data.input_frames_used * psrc->channels ;
    src_data.input_frames -= src_data.input_frames_used ;

    src_data.data_out += src_data.output_frames_gen * psrc->channels ;
    src_data.output_frames -= src_data.output_frames_gen ;

    output_frames_gen += src_data.output_frames_gen ;

    if (src_data.end_of_input == SRC_TRUE && src_data.output_frames_gen == 0)
      break ;
    } ;

  psrc->saved_data = src_data.data_in ;
  psrc->saved_frames = src_data.input_frames ;

  if (error != 0)
  {  psrc->error = error ;
     return 0 ;
    } ;

  return output_frames_gen ;
} /* src_callback_read */

/*==========================================================================
*/

int
src_set_ratio (SRC_STATE *state, double new_ratio)
{  SRC_PRIVATE *psrc ;

  psrc = (SRC_PRIVATE*) state ;

  if (psrc == NULL)
    return SRC_ERR_BAD_STATE ;
  if (psrc->vari_process == NULL || psrc->const_process == NULL)
    return SRC_ERR_BAD_PROC_PTR ;

  if (is_bad_src_ratio (new_ratio))
    return SRC_ERR_BAD_SRC_RATIO ;

  psrc->last_ratio = new_ratio ;

  return SRC_ERR_NO_ERROR ;
} /* src_set_ratio */

int
src_reset (SRC_STATE *state)
{  SRC_PRIVATE *psrc ;

  if ((psrc = (SRC_PRIVATE*) state) == NULL)
    return SRC_ERR_BAD_STATE ;

  if (psrc->reset != NULL)
    psrc->reset (psrc) ;

  psrc->last_position = 0.0 ;
  psrc->last_ratio = 0.0 ;

  psrc->saved_data = NULL ;
  psrc->saved_frames = 0 ;

  psrc->error = SRC_ERR_NO_ERROR ;

  return SRC_ERR_NO_ERROR ;
} /* src_reset */

/*==============================================================================
**  Control functions.
*/

const char *
src_get_name (int converter_type)
{  const char *desc ;

  if ((desc = sinc_get_name (converter_type)) != NULL)
    return desc ;

  if ((desc = zoh_get_name (converter_type)) != NULL)
    return desc ;

  if ((desc = linear_get_name (converter_type)) != NULL)
    return desc ;

  return NULL ;
} /* src_get_name */

const char *
src_get_description (int converter_type)
{  const char *desc ;

  if ((desc = sinc_get_description (converter_type)) != NULL)
    return desc ;

  if ((desc = zoh_get_description (converter_type)) != NULL)
    return desc ;

  if ((desc = linear_get_description (converter_type)) != NULL)
    return desc ;

  return NULL ;
} /* src_get_description */

const char *
src_get_version (void)
{  return PACKAGE "-" VERSION " (c) 2002-2008 Erik de Castro Lopo" ;
} /* src_get_version */

int
src_is_valid_ratio (double ratio)
{
  if (is_bad_src_ratio (ratio))
    return SRC_FALSE ;

  return SRC_TRUE ;
} /* src_is_valid_ratio */

/*==============================================================================
**  Error reporting functions.
*/

int
src_error (SRC_STATE *state)
{  if (state)
    return ((SRC_PRIVATE*) state)->error ;
  return SRC_ERR_NO_ERROR ;
} /* src_error */

const char*
src_strerror (int error)
{
  switch (error)
  {  case SRC_ERR_NO_ERROR :
        return "No error." ;
    case SRC_ERR_MALLOC_FAILED :
        return "Malloc failed." ;
    case SRC_ERR_BAD_STATE :
        return "SRC_STATE pointer is NULL." ;
    case SRC_ERR_BAD_DATA :
        return "SRC_DATA pointer is NULL." ;
    case SRC_ERR_BAD_DATA_PTR :
        return "SRC_DATA->data_out is NULL." ;
    case SRC_ERR_NO_PRIVATE :
        return "Internal error. No private data." ;
    case SRC_ERR_BAD_SRC_RATIO :
        return "SRC ratio outside [1/12, 12] range." ;
    case SRC_ERR_BAD_SINC_STATE :
        return "src_process() called without reset after end_of_input." ;
    case SRC_ERR_BAD_PROC_PTR :
        return "Internal error. No process pointer." ;
    case SRC_ERR_SHIFT_BITS :
        return "Internal error. SHIFT_BITS too large." ;
    case SRC_ERR_FILTER_LEN :
        return "Internal error. Filter length too large." ;
    case SRC_ERR_BAD_CONVERTER :
        return "Bad converter number." ;
    case SRC_ERR_BAD_CHANNEL_COUNT :
        return "Channel count must be >= 1." ;
    case SRC_ERR_SINC_BAD_BUFFER_LEN :
        return "Internal error. Bad buffer length. Please report this." ;
    case SRC_ERR_SIZE_INCOMPATIBILITY :
        return "Internal error. Input data / internal buffer size difference. Please report this." ;
    case SRC_ERR_BAD_PRIV_PTR :
        return "Internal error. Private pointer is NULL. Please report this." ;
    case SRC_ERR_DATA_OVERLAP :
        return "Input and output data arrays overlap." ;
    case SRC_ERR_BAD_CALLBACK :
        return "Supplied callback function pointer is NULL." ;
    case SRC_ERR_BAD_MODE :
        return "Calling mode differs from initialisation mode (ie process v callback)." ;
    case SRC_ERR_NULL_CALLBACK :
        return "Callback function pointer is NULL in src_callback_read ()." ;
    case SRC_ERR_NO_VARIABLE_RATIO :
        return "This converter only allows constant conversion ratios." ;

    case SRC_ERR_MAX_ERROR :
        return "Placeholder. No error defined for this error number." ;

    default :             break ;
    }

  return NULL ;
} /* src_strerror */

/*==============================================================================
**  Simple interface for performing a single conversion from input buffer to
**  output buffer at a fixed conversion ratio.
*/

int
src_simple (SRC_DATA *src_data, int converter, int channels)
{  SRC_STATE  *src_state ;
  int     error ;

  if ((src_state = src_new (converter, channels, &error)) == NULL)
    return error ;

  src_data->end_of_input = 1 ; /* Only one buffer worth of input. */

  error = src_process (src_state, src_data) ;

  src_state = src_delete (src_state) ;

  return error ;
} /* src_simple */

void
src_short_to_float_array (const short *in, float *out, int len)
{
  while (len)
  {  len -- ;
    out [len] = (float) (in [len] / (1.0 * 0x8000)) ;
    } ;

  return ;
} /* src_short_to_float_array */

void
src_float_to_short_array (const float *in, short *out, int len)
{  double scaled_value ;

  while (len)
  {  len -- ;

    scaled_value = in [len] * (8.0 * 0x10000000) ;
    if (CPU_CLIPS_POSITIVE == 0 && scaled_value >= (1.0 * 0x7FFFFFFF))
    {  out [len] = 32767 ;
      continue ;
      } ;
    if (CPU_CLIPS_NEGATIVE == 0 && scaled_value <= (-8.0 * 0x10000000))
    {  out [len] = -32768 ;
      continue ;
      } ;

    out [len] = (short) (lrint (scaled_value) >> 16) ;
    } ;

} /* src_float_to_short_array */

void
src_int_to_float_array (const int *in, float *out, int len)
{
  while (len)
  {  len -- ;
    out [len] = (float) (in [len] / (8.0 * 0x10000000)) ;
    } ;

  return ;
} /* src_int_to_float_array */

void
src_float_to_int_array (const float *in, int *out, int len)
{  double scaled_value ;

  while (len)
  {  len -- ;

    scaled_value = in [len] * (8.0 * 0x10000000) ;
    if (CPU_CLIPS_POSITIVE == 0 && scaled_value >= (1.0 * 0x7FFFFFFF))
    {  out [len] = 0x7fffffff ;
      continue ;
      } ;
    if (CPU_CLIPS_NEGATIVE == 0 && scaled_value <= (-8.0 * 0x10000000))
    {  out [len] = -1 - 0x7fffffff ;
      continue ;
      } ;

    out [len] = lrint (scaled_value) ;
    } ;

} /* src_float_to_int_array */

/*==============================================================================
**  Private functions.
*/

static int
psrc_set_converter (SRC_PRIVATE  *psrc, int converter_type)
{
  if (sinc_set_converter (psrc, converter_type) == SRC_ERR_NO_ERROR)
    return SRC_ERR_NO_ERROR ;

  if (zoh_set_converter (psrc, converter_type) == SRC_ERR_NO_ERROR)
    return SRC_ERR_NO_ERROR ;

  if (linear_set_converter (psrc, converter_type) == SRC_ERR_NO_ERROR)
    return SRC_ERR_NO_ERROR ;

  return SRC_ERR_BAD_CONVERTER ;
} /* psrc_set_converter */