Merge branch 'master' into feature/pytest
[aubio.git] / src / io / source_sndfile.c
1 /*
2   Copyright (C) 2012 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 #include "aubio_priv.h"
22
23 #ifdef HAVE_SNDFILE
24
25 #include <sndfile.h>
26
27 #include "fvec.h"
28 #include "fmat.h"
29 #include "source_sndfile.h"
30
31 #include "temporal/resampler.h"
32
33 #define MAX_SIZE 4096
34 #define MAX_SAMPLES AUBIO_MAX_CHANNELS * MAX_SIZE
35
36 #if !HAVE_AUBIO_DOUBLE
37 #define aubio_sf_read_smpl sf_read_float
38 #else /* HAVE_AUBIO_DOUBLE */
39 #define aubio_sf_read_smpl sf_read_double
40 #endif /* HAVE_AUBIO_DOUBLE */
41
42 struct _aubio_source_sndfile_t {
43   uint_t hop_size;
44   uint_t samplerate;
45   uint_t channels;
46
47   // some data about the file
48   char_t *path;
49   SNDFILE *handle;
50   int input_samplerate;
51   int input_channels;
52   int input_format;
53   int duration;
54
55   // resampling stuff
56   smpl_t ratio;
57   uint_t input_hop_size;
58 #ifdef HAVE_SAMPLERATE
59   aubio_resampler_t **resamplers;
60   fvec_t *input_data;
61   fmat_t *input_mat;
62 #endif /* HAVE_SAMPLERATE */
63
64   // some temporary memory for sndfile to write at
65   uint_t scratch_size;
66   smpl_t *scratch_data;
67 };
68
69 aubio_source_sndfile_t * new_aubio_source_sndfile(const char_t * path, uint_t samplerate, uint_t hop_size) {
70   aubio_source_sndfile_t * s = AUBIO_NEW(aubio_source_sndfile_t);
71   SF_INFO sfinfo;
72
73   if (path == NULL) {
74     AUBIO_ERR("source_sndfile: Aborted opening null path\n");
75     goto beach;
76   }
77   if ((sint_t)samplerate < 0) {
78     AUBIO_ERR("source_sndfile: Can not open %s with samplerate %d\n", path, samplerate);
79     goto beach;
80   }
81   if ((sint_t)hop_size <= 0) {
82     AUBIO_ERR("source_sndfile: Can not open %s with hop_size %d\n", path, hop_size);
83     goto beach;
84   }
85
86   s->hop_size = hop_size;
87   s->channels = 1;
88
89   if (s->path) AUBIO_FREE(s->path);
90   s->path = AUBIO_ARRAY(char_t, strnlen(path, PATH_MAX) + 1);
91   strncpy(s->path, path, strnlen(path, PATH_MAX) + 1);
92
93   // try opening the file, getting the info in sfinfo
94   AUBIO_MEMSET(&sfinfo, 0, sizeof (sfinfo));
95   s->handle = sf_open (s->path, SFM_READ, &sfinfo);
96
97   if (s->handle == NULL) {
98     /* show libsndfile err msg */
99     AUBIO_ERR("source_sndfile: Failed opening %s (%s)\n", s->path,
100         sf_strerror (NULL));
101     goto beach;
102   }
103
104   /* get input specs */
105   s->input_samplerate = sfinfo.samplerate;
106   s->input_channels   = sfinfo.channels;
107   s->input_format     = sfinfo.format;
108   s->duration         = sfinfo.frames;
109
110   if (samplerate == 0) {
111     s->samplerate = s->input_samplerate;
112     //AUBIO_DBG("sampling rate set to 0, automagically adjusting to %d\n", samplerate);
113   } else {
114     s->samplerate = samplerate;
115   }
116   /* compute input block size required before resampling */
117   s->ratio = s->samplerate/(smpl_t)s->input_samplerate;
118   s->input_hop_size = (uint_t)FLOOR(s->hop_size / s->ratio + .5);
119
120   if (s->input_hop_size * s->input_channels > MAX_SAMPLES) {
121     AUBIO_ERR("source_sndfile: Not able to process more than %d frames of %d channels\n",
122         MAX_SAMPLES / s->input_channels, s->input_channels);
123     goto beach;
124   }
125
126 #ifdef HAVE_SAMPLERATE
127   s->input_data = NULL;
128   s->input_mat = NULL;
129   s->resamplers = NULL;
130   if (s->ratio != 1) {
131     uint_t i;
132     s->resamplers = AUBIO_ARRAY(aubio_resampler_t*, s->input_channels);
133     s->input_data = new_fvec(s->input_hop_size);
134     s->input_mat = new_fmat(s->input_channels, s->input_hop_size);
135     for (i = 0; i < (uint_t)s->input_channels; i++) {
136       s->resamplers[i] = new_aubio_resampler(s->ratio, 4);
137     }
138     if (s->ratio > 1) {
139       // we would need to add a ring buffer for these
140       if ( (uint_t)FLOOR(s->input_hop_size * s->ratio + .5)  != s->hop_size ) {
141         AUBIO_ERR("source_sndfile: can not upsample %s from %d to %d\n", s->path,
142             s->input_samplerate, s->samplerate);
143         goto beach;
144       }
145       AUBIO_WRN("source_sndfile: upsampling %s from %d to %d\n", s->path,
146           s->input_samplerate, s->samplerate);
147     }
148     s->duration = (uint_t)FLOOR(s->duration * s->ratio);
149   }
150 #else
151   if (s->ratio != 1) {
152     AUBIO_ERR("source_sndfile: aubio was compiled without aubio_resampler\n");
153     goto beach;
154   }
155 #endif /* HAVE_SAMPLERATE */
156
157   /* allocate data for de/interleaving reallocated when needed. */
158   s->scratch_size = s->input_hop_size * s->input_channels;
159   s->scratch_data = AUBIO_ARRAY(smpl_t, s->scratch_size);
160
161   return s;
162
163 beach:
164   //AUBIO_ERR("can not read %s at samplerate %dHz with a hop_size of %d\n",
165   //    s->path, s->samplerate, s->hop_size);
166   del_aubio_source_sndfile(s);
167   return NULL;
168 }
169
170 void aubio_source_sndfile_do(aubio_source_sndfile_t * s, fvec_t * read_data, uint_t * read){
171   uint_t i,j, input_channels = s->input_channels;
172   /* read from file into scratch_data */
173   sf_count_t read_samples = aubio_sf_read_smpl (s->handle, s->scratch_data, s->scratch_size);
174
175   /* where to store de-interleaved data */
176   smpl_t *ptr_data;
177 #ifdef HAVE_SAMPLERATE
178   if (s->ratio != 1) {
179     ptr_data = s->input_data->data;
180   } else
181 #endif /* HAVE_SAMPLERATE */
182   {
183     ptr_data = read_data->data;
184   }
185
186   /* de-interleaving and down-mixing data  */
187   for (j = 0; j < read_samples / input_channels; j++) {
188     ptr_data[j] = 0;
189     for (i = 0; i < input_channels; i++) {
190       ptr_data[j] += s->scratch_data[input_channels*j+i];
191     }
192     ptr_data[j] /= (smpl_t)input_channels;
193   }
194
195 #ifdef HAVE_SAMPLERATE
196   if (s->resamplers) {
197     aubio_resampler_do(s->resamplers[0], s->input_data, read_data);
198   }
199 #endif /* HAVE_SAMPLERATE */
200
201   *read = (int)FLOOR(s->ratio * read_samples / input_channels + .5);
202
203   if (*read < s->hop_size) {
204     for (j = *read; j < s->hop_size; j++) {
205       read_data->data[j] = 0;
206     }
207   }
208
209 }
210
211 void aubio_source_sndfile_do_multi(aubio_source_sndfile_t * s, fmat_t * read_data, uint_t * read){
212   uint_t i,j, input_channels = s->input_channels;
213   /* do actual reading */
214   sf_count_t read_samples = aubio_sf_read_smpl (s->handle, s->scratch_data, s->scratch_size);
215
216   /* where to store de-interleaved data */
217   smpl_t **ptr_data;
218 #ifdef HAVE_SAMPLERATE
219   if (s->ratio != 1) {
220     ptr_data = s->input_mat->data;
221   } else
222 #endif /* HAVE_SAMPLERATE */
223   {
224     ptr_data = read_data->data;
225   }
226
227   if (read_data->height < input_channels) {
228     // destination matrix has less channels than the file; copy only first
229     // channels of the file, de-interleaving data
230     for (j = 0; j < read_samples / input_channels; j++) {
231       for (i = 0; i < read_data->height; i++) {
232         ptr_data[i][j] = s->scratch_data[j * input_channels + i];
233       }
234     }
235   } else {
236     // destination matrix has as many or more channels than the file; copy each
237     // channel from the file to the destination matrix, de-interleaving data
238     for (j = 0; j < read_samples / input_channels; j++) {
239       for (i = 0; i < input_channels; i++) {
240         ptr_data[i][j] = s->scratch_data[j * input_channels + i];
241       }
242     }
243   }
244
245   if (read_data->height > input_channels) {
246     // destination matrix has more channels than the file; copy last channel
247     // of the file to each additional channels, de-interleaving data
248     for (j = 0; j < read_samples / input_channels; j++) {
249       for (i = input_channels; i < read_data->height; i++) {
250         ptr_data[i][j] = s->scratch_data[j * input_channels + (input_channels - 1)];
251       }
252     }
253   }
254
255 #ifdef HAVE_SAMPLERATE
256   if (s->resamplers) {
257     for (i = 0; i < input_channels; i++) {
258       fvec_t input_chan, read_chan;
259       input_chan.data = s->input_mat->data[i];
260       input_chan.length = s->input_mat->length;
261       read_chan.data = read_data->data[i];
262       read_chan.length = read_data->length;
263       aubio_resampler_do(s->resamplers[i], &input_chan, &read_chan);
264     }
265   }
266 #endif /* HAVE_SAMPLERATE */
267
268   *read = (int)FLOOR(s->ratio * read_samples / input_channels + .5);
269
270   if (*read < s->hop_size) {
271     for (i = 0; i < read_data->height; i++) {
272       for (j = *read; j < s->hop_size; j++) {
273         read_data->data[i][j] = 0.;
274       }
275     }
276   }
277
278 }
279
280 uint_t aubio_source_sndfile_get_samplerate(aubio_source_sndfile_t * s) {
281   return s->samplerate;
282 }
283
284 uint_t aubio_source_sndfile_get_channels(aubio_source_sndfile_t * s) {
285   return s->input_channels;
286 }
287
288 uint_t aubio_source_sndfile_get_duration (const aubio_source_sndfile_t * s) {
289   if (s && s->duration) {
290     return s->duration;
291   }
292   return 0;
293 }
294
295 uint_t aubio_source_sndfile_seek (aubio_source_sndfile_t * s, uint_t pos) {
296   uint_t resampled_pos = (uint_t)ROUND(pos / s->ratio);
297   sf_count_t sf_ret;
298   if (s->handle == NULL) {
299     AUBIO_ERR("source_sndfile: failed seeking in %s (file not opened?)\n",
300         s->path);
301     return AUBIO_FAIL;
302   }
303   if ((sint_t)pos < 0) {
304     AUBIO_ERR("source_sndfile: could not seek %s at %d (seeking position"
305        " should be >= 0)\n", s->path, pos);
306     return AUBIO_FAIL;
307   }
308   sf_ret = sf_seek (s->handle, resampled_pos, SEEK_SET);
309   if (sf_ret == -1) {
310     AUBIO_ERR("source_sndfile: Failed seeking %s at %d: %s\n", s->path, pos, sf_strerror (NULL));
311     return AUBIO_FAIL;
312   }
313   if (sf_ret != resampled_pos) {
314     AUBIO_ERR("source_sndfile: Tried seeking %s at %d, but got %d: %s\n",
315         s->path, resampled_pos, (uint_t)sf_ret, sf_strerror (NULL));
316     return AUBIO_FAIL;
317   }
318   return AUBIO_OK;
319 }
320
321 uint_t aubio_source_sndfile_close (aubio_source_sndfile_t *s) {
322   if (!s->handle) {
323     return AUBIO_OK;
324   }
325   if(sf_close(s->handle)) {
326     AUBIO_ERR("source_sndfile: Error closing file %s: %s\n", s->path, sf_strerror (NULL));
327     return AUBIO_FAIL;
328   }
329   s->handle = NULL;
330   return AUBIO_OK;
331 }
332
333 void del_aubio_source_sndfile(aubio_source_sndfile_t * s){
334   if (!s) return;
335   aubio_source_sndfile_close(s);
336 #ifdef HAVE_SAMPLERATE
337   if (s->resamplers != NULL) {
338     uint_t i = 0, input_channels = s->input_channels;
339     for (i = 0; i < input_channels; i ++) {
340       if (s->resamplers[i] != NULL) {
341         del_aubio_resampler(s->resamplers[i]);
342       }
343     }
344     AUBIO_FREE(s->resamplers);
345   }
346   if (s->input_data) {
347     del_fvec(s->input_data);
348   }
349   if (s->input_mat) {
350     del_fmat(s->input_mat);
351   }
352 #endif /* HAVE_SAMPLERATE */
353   if (s->path) AUBIO_FREE(s->path);
354   AUBIO_FREE(s->scratch_data);
355   AUBIO_FREE(s);
356 }
357
358 #endif /* HAVE_SNDFILE */