Changeset de5d3f1 for src/io


Ignore:
Timestamp:
Mar 16, 2013, 4:09:18 PM (12 years ago)
Author:
Paul Brossier <piem@piem.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:
8da0033, ac20c85
Parents:
8c43bf7
Message:

src/io/source.h: start adding some documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/io/source.h

    r8c43bf7 rde5d3f1  
    2424/** \file
    2525
    26   Media source
     26  Media source object
    2727
    2828  \example io/test-source.c
     
    3434#endif
    3535
     36/** source object structure */
    3637typedef struct _aubio_source_t aubio_source_t;
     38
     39/**
     40
     41  create new ::aubio_source_t
     42
     43  \param uri the file path or uri to read from
     44  \param samplerate the sample rate to read the file at
     45  \param hop_size the size of the blocks to read from
     46
     47  Creates a new source object. If `0` is passed as `samplerate`, the sample
     48  rate of the original file is used.
     49
     50  The samplerate of the current source can be obtained with
     51  ::aubio_source_get_samplerate.
     52
     53*/
    3754aubio_source_t * new_aubio_source(char_t * uri, uint_t samplerate, uint_t hop_size);
     55
     56/**
     57
     58  read monophonic vector of length hop_size from source object
     59
     60  \param s source object, created with ::new_aubio_source
     61  \param read_data ::fvec_t of data to read to
     62  \param read number of frames actually read
     63
     64  Upon returns, `read` contains the number of frames actually read from the
     65  source. `hop_size` if enough frames could be read, less otherwise.
     66
     67*/
    3868void aubio_source_do(aubio_source_t * s, fvec_t * read_data, uint_t * read);
     69
     70/**
     71
     72  get samplerate of source object
     73
     74  \param s source object, created with ::new_aubio_source
     75  \return samplerate, in Hz
     76
     77*/
    3978uint_t aubio_source_get_samplerate(aubio_source_t * s);
     79
     80/**
     81
     82  destroy source object
     83
     84  \param s source object, created with ::new_aubio_source
     85
     86*/
    4087void del_aubio_source(aubio_source_t * s);
    4188
Note: See TracChangeset for help on using the changeset viewer.