[source_apple_audio] get_duration returns 0 on failure
[aubio.git] / src / io / source_apple_audio.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_SOURCE_APPLE_AUDIO
24
25 #include "fvec.h"
26 #include "fmat.h"
27 #include "ioutils.h"
28 #include "io/source_apple_audio.h"
29
30 // ExtAudioFileRef, AudioStreamBasicDescription, AudioBufferList, ...
31 #include <AudioToolbox/AudioToolbox.h>
32
33 #define RT_BYTE1( a )      ( (a) & 0xff )
34 #define RT_BYTE2( a )      ( ((a) >> 8) & 0xff )
35 #define RT_BYTE3( a )      ( ((a) >> 16) & 0xff )
36 #define RT_BYTE4( a )      ( ((a) >> 24) & 0xff )
37
38 struct _aubio_source_apple_audio_t {
39   uint_t channels;
40   uint_t samplerate;          //< requested samplerate
41   uint_t source_samplerate;   //< actual source samplerate
42   uint_t block_size;
43
44   char_t *path;
45
46   ExtAudioFileRef audioFile;
47   AudioBufferList bufferList;
48 };
49
50 extern int createAudioBufferList(AudioBufferList *bufferList, int channels, int max_source_samples);
51 extern void freeAudioBufferList(AudioBufferList *bufferList);
52 extern CFURLRef createURLFromPath(const char * path);
53 char_t *getPrintableOSStatusError(char_t *str, OSStatus error);
54
55 uint_t aubio_source_apple_audio_open (aubio_source_apple_audio_t *s, const char_t * path);
56
57 aubio_source_apple_audio_t * new_aubio_source_apple_audio(const char_t * path, uint_t samplerate, uint_t block_size)
58 {
59   aubio_source_apple_audio_t * s = AUBIO_NEW(aubio_source_apple_audio_t);
60
61   if (path == NULL || strnlen(path, PATH_MAX) < 1) {
62     AUBIO_ERROR("source_apple_audio: Aborted opening null path\n");
63     goto beach;
64   }
65
66   if ( (sint_t)block_size <= 0 ) {
67     AUBIO_ERROR("source_apple_audio: Can not open %s with null or negative block_size %d\n",
68         path, block_size);
69     goto beach;
70   }
71
72   if ( (sint_t)samplerate < 0 ) {
73     AUBIO_ERROR("source_apple_audio: Can not open %s with negative samplerate %d\n",
74         path, samplerate);
75     goto beach;
76   }
77
78   s->block_size = block_size;
79   s->samplerate = samplerate;
80
81   if ( aubio_source_apple_audio_open ( s, path ) ) {
82     goto beach;
83   }
84   return s;
85
86 beach:
87   del_aubio_source_apple_audio(s);
88   return NULL;
89 }
90
91 uint_t aubio_source_apple_audio_open (aubio_source_apple_audio_t *s, const char_t * path)
92 {
93   OSStatus err = noErr;
94   UInt32 propSize;
95
96   s->path = AUBIO_ARRAY(char_t, strnlen(path, PATH_MAX) + 1);
97   strncpy(s->path, path, strnlen(path, PATH_MAX) + 1);
98
99   // open the resource url
100   CFURLRef fileURL = createURLFromPath(s->path);
101   err = ExtAudioFileOpenURL(fileURL, &s->audioFile);
102   CFRelease(fileURL);
103   if (err == -43) {
104     AUBIO_ERR("source_apple_audio: Failed opening %s, "
105         "file not found, or no read access\n", s->path);
106     goto beach;
107   } else if (err) {
108     char_t errorstr[20];
109     AUBIO_ERR("source_apple_audio: Failed opening %s, "
110         "error in ExtAudioFileOpenURL (%s)\n", s->path,
111         getPrintableOSStatusError(errorstr, err));
112     goto beach;
113   }
114
115   // create an empty AudioStreamBasicDescription
116   AudioStreamBasicDescription fileFormat;
117   propSize = sizeof(fileFormat);
118   memset(&fileFormat, 0, sizeof(AudioStreamBasicDescription));
119
120   // fill it with the file description
121   err = ExtAudioFileGetProperty(s->audioFile,
122       kExtAudioFileProperty_FileDataFormat, &propSize, &fileFormat);
123   if (err) {
124     char_t errorstr[20];
125     AUBIO_ERROR("source_apple_audio: Failed opening %s, "
126         "error in ExtAudioFileGetProperty (%s)\n", s->path,
127         getPrintableOSStatusError(errorstr, err));
128     goto beach;
129   }
130
131   if (s->samplerate == 0) {
132     s->samplerate = fileFormat.mSampleRate;
133     //AUBIO_DBG("sampling rate set to 0, automagically adjusting to %d\n", samplerate);
134   }
135
136   s->source_samplerate = fileFormat.mSampleRate;
137   s->channels = fileFormat.mChannelsPerFrame;
138
139   AudioStreamBasicDescription clientFormat;
140   propSize = sizeof(AudioStreamBasicDescription);
141   memset(&clientFormat, 0, sizeof(AudioStreamBasicDescription));
142   clientFormat.mFormatID         = kAudioFormatLinearPCM;
143   clientFormat.mSampleRate       = (Float64)(s->samplerate);
144   clientFormat.mFormatFlags      = kAudioFormatFlagIsFloat;
145   clientFormat.mChannelsPerFrame = s->channels;
146   clientFormat.mBitsPerChannel   = sizeof(smpl_t) * 8;
147   clientFormat.mFramesPerPacket  = 1;
148   clientFormat.mBytesPerFrame    = clientFormat.mBitsPerChannel * clientFormat.mChannelsPerFrame / 8;
149   clientFormat.mBytesPerPacket   = clientFormat.mFramesPerPacket * clientFormat.mBytesPerFrame;
150
151   // set the client format description
152   err = ExtAudioFileSetProperty(s->audioFile, kExtAudioFileProperty_ClientDataFormat,
153       propSize, &clientFormat);
154   if (err) {
155     char_t errorstr[20];
156     AUBIO_ERROR("source_apple_audio: Failed opening %s, "
157         "error in ExtAudioFileSetProperty (%s)\n", s->path,
158         getPrintableOSStatusError(errorstr, err));
159 #if 0
160   // print client and format descriptions
161   AUBIO_DBG("Opened %s\n", s->path);
162   AUBIO_DBG("file/client Format.mFormatID:        : %3c%c%c%c / %c%c%c%c\n",
163       (int)RT_BYTE4(fileFormat.mFormatID),   (int)RT_BYTE3(fileFormat.mFormatID),   (int)RT_BYTE2(fileFormat.mFormatID),   (int)RT_BYTE1(fileFormat.mFormatID),
164       (int)RT_BYTE4(clientFormat.mFormatID), (int)RT_BYTE3(clientFormat.mFormatID), (int)RT_BYTE2(clientFormat.mFormatID), (int)RT_BYTE1(clientFormat.mFormatID)
165       );
166
167   AUBIO_DBG("file/client Format.mSampleRate       : %6.0f / %.0f\n",     fileFormat.mSampleRate      ,      clientFormat.mSampleRate);
168   AUBIO_DBG("file/client Format.mFormatFlags      : %6d / %d\n",    (int)fileFormat.mFormatFlags     , (int)clientFormat.mFormatFlags);
169   AUBIO_DBG("file/client Format.mChannelsPerFrame : %6d / %d\n",    (int)fileFormat.mChannelsPerFrame, (int)clientFormat.mChannelsPerFrame);
170   AUBIO_DBG("file/client Format.mBitsPerChannel   : %6d / %d\n",    (int)fileFormat.mBitsPerChannel  , (int)clientFormat.mBitsPerChannel);
171   AUBIO_DBG("file/client Format.mFramesPerPacket  : %6d / %d\n",    (int)fileFormat.mFramesPerPacket , (int)clientFormat.mFramesPerPacket);
172   AUBIO_DBG("file/client Format.mBytesPerFrame    : %6d / %d\n",    (int)fileFormat.mBytesPerFrame   , (int)clientFormat.mBytesPerFrame);
173   AUBIO_DBG("file/client Format.mBytesPerPacket   : %6d / %d\n",    (int)fileFormat.mBytesPerPacket  , (int)clientFormat.mBytesPerPacket);
174   AUBIO_DBG("file/client Format.mReserved         : %6d / %d\n",    (int)fileFormat.mReserved        , (int)clientFormat.mReserved);
175 #endif
176       goto beach;
177   }
178
179   smpl_t ratio = s->source_samplerate * 1. / s->samplerate;
180   if (ratio < 1.) {
181     AUBIO_WRN("source_apple_audio: up-sampling %s from %0dHz to %0dHz\n",
182         s->path, s->source_samplerate, s->samplerate);
183   }
184
185   // allocate the AudioBufferList
186   freeAudioBufferList(&s->bufferList);
187   if (createAudioBufferList(&s->bufferList, s->channels, s->block_size * s->channels)) {
188     AUBIO_ERR("source_apple_audio: failed creating bufferList\n");
189     goto beach;
190   }
191
192 beach:
193   return err;
194 }
195
196 static UInt32 aubio_source_apple_audio_read_frame(aubio_source_apple_audio_t *s)
197 {
198   UInt32 loadedPackets = s->block_size;
199   OSStatus err = ExtAudioFileRead(s->audioFile, &loadedPackets, &s->bufferList);
200   if (err) {
201     char_t errorstr[20];
202     AUBIO_ERROR("source_apple_audio: error while reading %s "
203         "with ExtAudioFileRead (%s)\n", s->path,
204         getPrintableOSStatusError(errorstr, err));
205   }
206   return loadedPackets;
207 }
208
209 void aubio_source_apple_audio_do(aubio_source_apple_audio_t *s, fvec_t * read_to,
210     uint_t * read) {
211   uint_t c, v;
212   UInt32 loadedPackets = aubio_source_apple_audio_read_frame(s);
213   uint_t length = aubio_source_validate_input_length("source_apple_audio",
214       s->path, s->block_size, read_to->length);
215   smpl_t *data = (smpl_t*)s->bufferList.mBuffers[0].mData;
216
217   length = MIN(loadedPackets, length);
218
219   for (v = 0; v < length; v++) {
220     read_to->data[v] = 0.;
221     for (c = 0; c < s->channels; c++) {
222       read_to->data[v] += data[ v * s->channels + c];
223     }
224     read_to->data[v] /= (smpl_t)s->channels;
225   }
226   // short read, fill with zeros
227   aubio_source_pad_output(read_to, length);
228
229   *read = (uint_t)length;
230 }
231
232 void aubio_source_apple_audio_do_multi(aubio_source_apple_audio_t *s, fmat_t * read_to, uint_t * read) {
233   uint_t c, v;
234   uint_t length = aubio_source_validate_input_length("source_apple_audio",
235       s->path, s->block_size, read_to->length);
236   uint_t channels = aubio_source_validate_input_channels("source_apple_audio",
237       s->path, s->channels, read_to->height);
238   UInt32 loadedPackets = aubio_source_apple_audio_read_frame(s);
239   smpl_t *data = (smpl_t*)s->bufferList.mBuffers[0].mData;
240
241   length = MIN(loadedPackets, length);
242
243   for (v = 0; v < length; v++) {
244     for (c = 0; c < channels; c++) {
245       read_to->data[c][v] = data[ v * s->channels + c];
246     }
247   }
248
249   aubio_source_pad_multi_output(read_to, s->channels, (uint_t)length);
250
251   *read = (uint_t)length;
252 }
253
254 uint_t aubio_source_apple_audio_close (aubio_source_apple_audio_t *s)
255 {
256   OSStatus err = noErr;
257   if (!s->audioFile) { return AUBIO_OK; }
258   err = ExtAudioFileDispose(s->audioFile);
259   s->audioFile = NULL;
260   if (err) {
261     char_t errorstr[20];
262     AUBIO_ERROR("source_apple_audio: error while closing %s "
263         "in ExtAudioFileDispose (%s)\n", s->path,
264         getPrintableOSStatusError(errorstr, err));
265     return err;
266   }
267   return AUBIO_OK;
268 }
269
270 void del_aubio_source_apple_audio(aubio_source_apple_audio_t * s){
271   AUBIO_ASSERT(s);
272   aubio_source_apple_audio_close (s);
273   if (s->path) AUBIO_FREE(s->path);
274   freeAudioBufferList(&s->bufferList);
275   AUBIO_FREE(s);
276 }
277
278 uint_t aubio_source_apple_audio_seek (aubio_source_apple_audio_t * s, uint_t pos) {
279   OSStatus err = noErr;
280   if ((sint_t)pos < 0) {
281     AUBIO_ERROR("source_apple_audio: error while seeking in %s "
282         "(can not seek at negative position %d)\n",
283         s->path, pos);
284     err = -1;
285     goto beach;
286   }
287   // check if we are not seeking out of the file
288   uint_t fileLengthFrames = aubio_source_apple_audio_get_duration(s);
289   // compute position in the source file, before resampling
290   smpl_t ratio = s->source_samplerate * 1. / s->samplerate;
291   SInt64 resampled_pos = (SInt64)ROUND( pos * ratio );
292   if (resampled_pos > fileLengthFrames) {
293     AUBIO_ERR("source_apple_audio: trying to seek in %s at pos %d, "
294         "but file has only %d frames\n",
295         s->path, pos, (uint_t)(fileLengthFrames / ratio));
296     err = -1;
297     goto beach;
298   }
299   // after a short read, the bufferList size needs to resetted to prepare for a full read
300   AudioBufferList *bufferList = &s->bufferList;
301   bufferList->mBuffers[0].mDataByteSize = s->block_size * s->channels * sizeof (smpl_t);
302   // do the actual seek
303   err = ExtAudioFileSeek(s->audioFile, resampled_pos);
304   if (err) {
305     char_t errorstr[20];
306     AUBIO_ERROR("source_apple_audio: error while seeking %s at %d "
307         "in ExtAudioFileSeek (%s)\n", s->path, pos,
308         getPrintableOSStatusError(errorstr, err));
309   }
310 #if 0
311   // check position after seek
312   {
313     SInt64 outFrameOffset = 0;
314     err = ExtAudioFileTell(s->audioFile, &outFrameOffset);
315     if (err) {
316       char_t errorstr[20];
317       AUBIO_ERROR("source_apple_audio: error while seeking %s at %d "
318           "in ExtAudioFileTell (%s)\n", s->path, pos,
319           getPrintableOSStatusError(errorstr, err));
320     }
321     AUBIO_DBG("source_apple_audio: asked seek at %d, tell got %d\n",
322         pos, (uint_t)(outFrameOffset / ratio + .5));
323   }
324 #endif
325 beach:
326   return err;
327 }
328
329 uint_t aubio_source_apple_audio_get_samplerate(const aubio_source_apple_audio_t * s) {
330   return s->samplerate;
331 }
332
333 uint_t aubio_source_apple_audio_get_channels(const aubio_source_apple_audio_t * s) {
334   return s->channels;
335 }
336
337 uint_t aubio_source_apple_audio_get_duration(const aubio_source_apple_audio_t * s) {
338   SInt64 fileLengthFrames = 0;
339   UInt32 propSize = sizeof(fileLengthFrames);
340   OSStatus err = ExtAudioFileGetProperty(s->audioFile,
341       kExtAudioFileProperty_FileLengthFrames, &propSize, &fileLengthFrames);
342   if (err) {
343     char_t errorstr[20];
344     AUBIO_ERROR("source_apple_audio: Failed getting %s duration, "
345         "error in ExtAudioFileGetProperty (%s)\n", s->path,
346         getPrintableOSStatusError(errorstr, err));
347     return 0;
348   }
349   return (uint_t)fileLengthFrames;
350 }
351
352 #endif /* HAVE_SOURCE_APPLE_AUDIO */