examples/allatency.c

   1 /*
   2  * OpenAL Source Latency Example
   3  *
   4  * Copyright (c) 2012 by Chris Robinson <chris.kcat@gmail.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 /* This file contains an example for checking the latency of a sound. */
  26
  27 #include <assert.h>
  28 #include <inttypes.h>
  29 #include <limits.h>
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32
  33 #include "sndfile.h"
  34
  35 #include "AL/al.h"
  36 #include "AL/alext.h"
  37
  38 #include "common/alhelpers.h"
  39
  40 #include "win_main_utf8.h"
  41
  42
  43 static LPALSOURCEDSOFT alSourcedSOFT;
  44 static LPALSOURCE3DSOFT alSource3dSOFT;
  45 static LPALSOURCEDVSOFT alSourcedvSOFT;
  46 static LPALGETSOURCEDSOFT alGetSourcedSOFT;
  47 static LPALGETSOURCE3DSOFT alGetSource3dSOFT;
  48 static LPALGETSOURCEDVSOFT alGetSourcedvSOFT;
  49 static LPALSOURCEI64SOFT alSourcei64SOFT;
  50 static LPALSOURCE3I64SOFT alSource3i64SOFT;
  51 static LPALSOURCEI64VSOFT alSourcei64vSOFT;
  52 static LPALGETSOURCEI64SOFT alGetSourcei64SOFT;
  53 static LPALGETSOURCE3I64SOFT alGetSource3i64SOFT;
  54 static LPALGETSOURCEI64VSOFT alGetSourcei64vSOFT;
  55
  56 /* LoadBuffer loads the named audio file into an OpenAL buffer object, and
  57  * returns the new buffer ID.
  58  */
  59 static ALuint LoadSound(const char *filename)
  60 {
  61     ALenum err, format;
  62     ALuint buffer;
  63     SNDFILE *sndfile;
  64     SF_INFO sfinfo;
  65     short *membuf;
  66     sf_count_t num_frames;
  67     ALsizei num_bytes;
  68
  69     /* Open the audio file and check that it's usable. */
  70     sndfile = sf_open(filename, SFM_READ, &sfinfo);
  71     if(!sndfile)
  72     {
  73         fprintf(stderr, "Could not open audio in %s: %s\n", filename, sf_strerror(sndfile));
  74         return 0;
  75     }
  76     if(sfinfo.frames < 1 || sfinfo.frames > (sf_count_t)(INT_MAX/sizeof(short))/sfinfo.channels)
  77     {
  78         fprintf(stderr, "Bad sample count in %s (%" PRId64 ")\n", filename, sfinfo.frames);
  79         sf_close(sndfile);
  80         return 0;
  81     }
  82
  83     /* Get the sound format, and figure out the OpenAL format */
  84     format = AL_NONE;
  85     if(sfinfo.channels == 1)
  86         format = AL_FORMAT_MONO16;
  87     else if(sfinfo.channels == 2)
  88         format = AL_FORMAT_STEREO16;
  89     else if(sfinfo.channels == 3)
  90     {
  91         if(sf_command(sndfile, SFC_WAVEX_GET_AMBISONIC, NULL, 0) == SF_AMBISONIC_B_FORMAT)
  92             format = AL_FORMAT_BFORMAT2D_16;
  93     }
  94     else if(sfinfo.channels == 4)
  95     {
  96         if(sf_command(sndfile, SFC_WAVEX_GET_AMBISONIC, NULL, 0) == SF_AMBISONIC_B_FORMAT)
  97             format = AL_FORMAT_BFORMAT3D_16;
  98     }
  99     if(!format)
 100     {
 101         fprintf(stderr, "Unsupported channel count: %d\n", sfinfo.channels);
 102         sf_close(sndfile);
 103         return 0;
 104     }
 105
 106     /* Decode the whole audio file to a buffer. */
 107     membuf = malloc((size_t)(sfinfo.frames * sfinfo.channels) * sizeof(short));
 108
 109     num_frames = sf_readf_short(sndfile, membuf, sfinfo.frames);
 110     if(num_frames < 1)
 111     {
 112         free(membuf);
 113         sf_close(sndfile);
 114         fprintf(stderr, "Failed to read samples in %s (%" PRId64 ")\n", filename, num_frames);
 115         return 0;
 116     }
 117     num_bytes = (ALsizei)(num_frames * sfinfo.channels) * (ALsizei)sizeof(short);
 118
 119     /* Buffer the audio data into a new buffer object, then free the data and
 120      * close the file.
 121      */
 122     buffer = 0;
 123     alGenBuffers(1, &buffer);
 124     alBufferData(buffer, format, membuf, num_bytes, sfinfo.samplerate);
 125
 126     free(membuf);
 127     sf_close(sndfile);
 128
 129     /* Check if an error occurred, and clean up if so. */
 130     err = alGetError();
 131     if(err != AL_NO_ERROR)
 132     {
 133         fprintf(stderr, "OpenAL Error: %s\n", alGetString(err));
 134         if(buffer && alIsBuffer(buffer))
 135             alDeleteBuffers(1, &buffer);
 136         return 0;
 137     }
 138
 139     return buffer;
 140 }
 141
 142
 143 int main(int argc, char **argv)
 144 {
 145     ALuint source, buffer;
 146     ALdouble offsets[2];
 147     ALenum state;
 148
 149     /* Print out usage if no arguments were specified */
 150     if(argc < 2)
 151     {
 152         fprintf(stderr, "Usage: %s [-device <name>] <filename>\n", argv[0]);
 153         return 1;
 154     }
 155
 156     /* Initialize OpenAL, and check for source_latency support. */
 157     argv++; argc--;
 158     if(InitAL(&argv, &argc) != 0)
 159         return 1;
 160
 161     if(!alIsExtensionPresent("AL_SOFT_source_latency"))
 162     {
 163         fprintf(stderr, "Error: AL_SOFT_source_latency not supported\n");
 164         CloseAL();
 165         return 1;
 166     }
 167
 168     /* Define a macro to help load the function pointers. */
 169 #define LOAD_PROC(T, x)  ((x) = FUNCTION_CAST(T, alGetProcAddress(#x)))
 170     LOAD_PROC(LPALSOURCEDSOFT, alSourcedSOFT);
 171     LOAD_PROC(LPALSOURCE3DSOFT, alSource3dSOFT);
 172     LOAD_PROC(LPALSOURCEDVSOFT, alSourcedvSOFT);
 173     LOAD_PROC(LPALGETSOURCEDSOFT, alGetSourcedSOFT);
 174     LOAD_PROC(LPALGETSOURCE3DSOFT, alGetSource3dSOFT);
 175     LOAD_PROC(LPALGETSOURCEDVSOFT, alGetSourcedvSOFT);
 176     LOAD_PROC(LPALSOURCEI64SOFT, alSourcei64SOFT);
 177     LOAD_PROC(LPALSOURCE3I64SOFT, alSource3i64SOFT);
 178     LOAD_PROC(LPALSOURCEI64VSOFT, alSourcei64vSOFT);
 179     LOAD_PROC(LPALGETSOURCEI64SOFT, alGetSourcei64SOFT);
 180     LOAD_PROC(LPALGETSOURCE3I64SOFT, alGetSource3i64SOFT);
 181     LOAD_PROC(LPALGETSOURCEI64VSOFT, alGetSourcei64vSOFT);
 182 #undef LOAD_PROC
 183
 184     /* Load the sound into a buffer. */
 185     buffer = LoadSound(argv[0]);
 186     if(!buffer)
 187     {
 188         CloseAL();
 189         return 1;
 190     }
 191
 192     /* Create the source to play the sound with. */
 193     source = 0;
 194     alGenSources(1, &source);
 195     alSourcei(source, AL_BUFFER, (ALint)buffer);
 196     assert(alGetError()==AL_NO_ERROR && "Failed to setup sound source");
 197
 198     /* Play the sound until it finishes. */
 199     alSourcePlay(source);
 200     do {
 201         al_nssleep(10000000);
 202         alGetSourcei(source, AL_SOURCE_STATE, &state);
 203
 204         /* Get the source offset and latency. AL_SEC_OFFSET_LATENCY_SOFT will
 205          * place the offset (in seconds) in offsets[0], and the time until that
 206          * offset will be heard (in seconds) in offsets[1]. */
 207         alGetSourcedvSOFT(source, AL_SEC_OFFSET_LATENCY_SOFT, offsets);
 208         printf("\rOffset: %f - Latency:%3u ms  ", offsets[0], (ALuint)(offsets[1]*1000));
 209         fflush(stdout);
 210     } while(alGetError() == AL_NO_ERROR && state == AL_PLAYING);
 211     printf("\n");
 212
 213     /* All done. Delete resources, and close down OpenAL. */
 214     alDeleteSources(1, &source);
 215     alDeleteBuffers(1, &buffer);
 216     CloseAL();
 217
 218     return 0;
 219 }