source: src/io/source_avcodec.h @ 918b764

Last change on this file since 918b764 was b60f297, checked in by Paul Brossier <piem@piem.org>, 9 years ago

src/io/source_avcodec.h: add documentation
  • Property mode set to 100644
File size: 4.0 KB
Line 
1/*
2  Copyright (C) 2013 Paul Brossier <piem@aubio.org>
3
4  This file is part of aubio.
5
6  aubio is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10
11  aubio is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  GNU General Public License for more details.
15
16  You should have received a copy of the GNU General Public License
17  along with aubio.  If not, see <http://www.gnu.org/licenses/>.
18
19*/
20
21#ifndef AUBIO_SOURCE_AVCODEC_H
22#define AUBIO_SOURCE_AVCODEC_H
23
24/** \file
25
26  Read from file using [libavcodec](http://libav.org/)
27
28  Avoid including this file directly! Prefer using ::aubio_source_t instead to
29  make your code portable.
30
31  To write to file, use ::aubio_sink_t.
32
33  \example io/test-source_avcodec.c
34
35*/
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41/** avcodec media source object */
42typedef struct _aubio_source_avcodec_t aubio_source_avcodec_t;
43
44/**
45
46  create new ::aubio_source_avcodec_t
47
48  \param uri the file path or uri to read from
49  \param samplerate sampling rate to view the fie at
50  \param hop_size the size of the blocks to read from
51
52  Creates a new source object. If `0` is passed as `samplerate`, the sample
53  rate of the original file is used.
54
55  The samplerate of newly created source can be obtained using
56  ::aubio_source_avcodec_get_samplerate.
57
58*/
59aubio_source_avcodec_t * new_aubio_source_avcodec(const char_t * uri, uint_t samplerate, uint_t hop_size);
60
61/**
62
63  read monophonic vector of length hop_size from source object
64
65  \param s source object, created with ::new_aubio_source_avcodec
66  \param read_to ::fvec_t of data to read to
67  \param[out] read upon returns, equals to number of frames actually read
68
69  Upon returns, `read` contains the number of frames actually read from the
70  source. `hop_size` if enough frames could be read, less otherwise.
71
72*/
73void aubio_source_avcodec_do(aubio_source_avcodec_t * s, fvec_t * read_to, uint_t * read);
74
75/**
76
77  read polyphonic vector of length hop_size from source object
78
79  \param s source object, created with ::new_aubio_source_avcodec
80  \param read_to ::fmat_t of data to read to
81  \param read upon returns, equals to number of frames actually read
82
83  Upon returns, `read` contains the number of frames actually read from the
84  source. `hop_size` if enough frames could be read, less otherwise.
85
86*/
87void aubio_source_avcodec_do_multi(aubio_source_avcodec_t * s, fmat_t * read_to, uint_t * read);
88
89/**
90
91  get samplerate of source object
92
93  \param s source object, created with ::new_aubio_source_avcodec
94  \return samplerate, in Hz
95
96*/
97uint_t aubio_source_avcodec_get_samplerate(const aubio_source_avcodec_t * s);
98
99/**
100
101  get number of channels of source object
102
103  \param s source object, created with ::new_aubio_source_avcodec
104  \return number of channels
105
106*/
107uint_t aubio_source_avcodec_get_channels (const aubio_source_avcodec_t * s);
108
109/**
110
111  seek source object
112
113  \param s source object, created with ::new_aubio_source_avcodec
114  \param pos position to seek to, in frames
115
116  \return 0 if sucessful, non-zero on failure
117
118*/
119uint_t aubio_source_avcodec_seek (aubio_source_avcodec_t *s, uint_t pos);
120
121/**
122
123  get the duration of source object, in frames
124
125  \param s source object, created with ::new_aubio_source_avcodec
126  \return number of frames in file
127
128*/
129uint_t aubio_source_avcodec_get_duration (aubio_source_avcodec_t * s);
130
131/**
132
133  close source
134
135  \param s source object, created with ::new_aubio_source_avcodec
136
137  \return 0 if sucessful, non-zero on failure
138
139*/
140uint_t aubio_source_avcodec_close (aubio_source_avcodec_t *s);
141
142/**
143
144  close source and cleanup memory
145
146  \param s source object, created with ::new_aubio_source_avcodec
147
148*/
149void del_aubio_source_avcodec(aubio_source_avcodec_t * s);
150
151#ifdef __cplusplus
152}
153#endif
154
155#endif /* AUBIO_SOURCE_AVCODEC_H */
Note: See TracBrowser for help on using the repository browser.