Changeset 680137a


Ignore:
Timestamp:
May 17, 2006, 9:49:03 PM (15 years ago)
Author:
Paul Brossier <piem@altern.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, pitchshift, sampler, timestretch, yinfft+
Children:
2a04c2c
Parents:
0dc5fe3
Message:

update scale.[ch] docs
update scale.[ch] docs

Location:
src
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • src/scale.c

    r0dc5fe3 r680137a  
    1515         along with this program; if not, write to the Free Software
    1616         Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
    17          */
     17*/
    1818
    1919#include "aubio_priv.h"
     
    3636};
    3737
    38 
    39 /********************************************************
    40  * Object Memory Allocation
    41  */
    42 
    4338static aubio_scale_t * aubio_scale_malloc(void);
    4439static void aubio_scale_free(aubio_scale_t * s);
     
    5348}
    5449
    55 /***
    56  * Object creation/deletion calls
    57  */
    5850aubio_scale_t * new_aubio_scale (smpl_t ilow, smpl_t ihig, smpl_t olow, smpl_t ohig     ){
    5951        aubio_scale_t * s = aubio_scale_malloc();
     
    6658}
    6759
    68 /***
    69  * set parmams
    70  */
    7160void aubio_scale_set (aubio_scale_t *s, smpl_t ilow, smpl_t ihig, smpl_t olow, smpl_t ohig)
    7261{
     
    8675}
    8776
    88 /***
    89  * do it
    90  */
    9177void aubio_scale_do (aubio_scale_t *s, fvec_t *input)
    9278{
  • src/scale.h

    r0dc5fe3 r680137a  
    1515         along with this program; if not, write to the Free Software
    1616         Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
    17          */
     17*/
    1818
     19/** \file
     20
     21 Vector scaling function
     22 
     23 This object, inspired from the scale object in FTS, the jMax engine, scales
     24 the values of a vector according to an affine function defined as follow:
     25 
     26 \f$ y = (x - ilow)*(ohig-olow)/(ihig-ilow) + olow \f$
     27 
     28*/
    1929#ifndef SCALE_H
    2030#define SCALE_H
     
    2434#endif
    2535
    26 /* inspired from the scale object in fts (jmax) */
    27 
     36/** scale object */
    2837typedef struct _aubio_scale_t aubio_scale_t;
    2938
    30 /* buffer function */
     39/** create a scale object
     40 
     41  \param flow lower value of output function
     42  \param fhig higher value of output function
     43  \param ilow lower value of input function
     44  \param ihig higher value of output function
     45
     46*/
    3147aubio_scale_t * new_aubio_scale(smpl_t flow, smpl_t fhig, smpl_t ilow, smpl_t ihig      );
     48/** delete a scale object
     49
     50  \param s scale object as returned by new_aubio_scale
     51
     52*/
    3253void del_aubio_scale(aubio_scale_t *s);
    33 void aubio_scale_do(aubio_scale_t *s,
    34                 fvec_t * input);
     54/** scale input vector
     55
     56  \param s scale object as returned by new_aubio_scale
     57  \param input vector to scale
     58
     59*/
     60void aubio_scale_do(aubio_scale_t *s, fvec_t * input);
     61/** modify scale parameters after object creation
     62
     63  \param s scale object as returned by new_aubio_scale
     64  \param olow lower value of output function
     65  \param ohig higher value of output function
     66  \param ilow lower value of input function
     67  \param ihig higher value of output function
     68
     69*/
    3570void aubio_scale_set (aubio_scale_t *s, smpl_t ilow, smpl_t ihig, smpl_t olow, smpl_t ohig);
    3671
Note: See TracChangeset for help on using the changeset viewer.