Changeset ca29f57


Ignore:
Timestamp:
May 17, 2006, 9:46:52 PM (19 years ago)
Author:
Paul Brossier <piem@altern.org>
Branches:
feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+
Children:
7011e8a
Parents:
6ebcb08
Message:

update resample.h docs
update resample.h docs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/resample.h

    r6ebcb08 rca29f57  
    2121#define _RESAMPLE_H
    2222
    23 /** @file
    24  * Libsamplerate resampling
    25  */
     23/** \file
     24 
     25 Resampling object
     26
     27 This object resamples an input vector into an output vector using
     28 libsamplerate. See http://www.mega-nerd.com/SRC/
     29 
     30*/
    2631
    2732#ifdef __cplusplus
     
    2934#endif
    3035
    31 /**
    32  * resampler object
    33  */
     36/** resampler object */
    3437typedef struct _aubio_resampler_t aubio_resampler_t;
    35 /** 
    36  * create resampler object
    37  * \param ratio output_sample_rate / input_sample_rate
    38  * \param type libsamplerate resampling type
    39  */
     38/** create resampler object
     39
     40  \param ratio output_sample_rate / input_sample_rate
     41  \param type libsamplerate resampling type
     42
     43*/
    4044aubio_resampler_t * new_aubio_resampler(float ratio, uint_t type);
    4145/** delete resampler object */
    4246void del_aubio_resampler(aubio_resampler_t *s);
    43 /**
    44  * resample input in output
    45  * \param s resampler object
    46  * \param input input buffer of size N
    47  * \param output output buffer of size N*ratio
    48  */
     47/** resample input in output
     48
     49  \param s resampler object
     50  \param input input buffer of size N
     51  \param output output buffer of size N*ratio
     52
     53*/
    4954uint_t aubio_resampler_process(aubio_resampler_t *s, fvec_t * input,  fvec_t * output);
    5055
Note: See TracChangeset for help on using the changeset viewer.