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
  41 static LPALSOURCEDSOFT alSourcedSOFT;
  42 static LPALSOURCE3DSOFT alSource3dSOFT;
  43 static LPALSOURCEDVSOFT alSourcedvSOFT;
  44 static LPALGETSOURCEDSOFT alGetSourcedSOFT;
  45 static LPALGETSOURCE3DSOFT alGetSource3dSOFT;
  46 static LPALGETSOURCEDVSOFT alGetSourcedvSOFT;
  47 static LPALSOURCEI64SOFT alSourcei64SOFT;
  48 static LPALSOURCE3I64SOFT alSource3i64SOFT;
  49 static LPALSOURCEI64VSOFT alSourcei64vSOFT;
  50 static LPALGETSOURCEI64SOFT alGetSourcei64SOFT;
  51 static LPALGETSOURCE3I64SOFT alGetSource3i64SOFT;
  52 static LPALGETSOURCEI64VSOFT alGetSourcei64vSOFT;
  53
  54 /* LoadBuffer loads the named audio file into an OpenAL buffer object, and
  55  * returns the new buffer ID.
  56  */
  57 static ALuint LoadSound(const char *filename)
  58 {
  59     ALenum err, format;
  60     ALuint buffer;
  61     SNDFILE *sndfile;
  62     SF_INFO sfinfo;
  63     short *membuf;
  64     sf_count_t num_frames;
  65     ALsizei num_bytes;
  66
  67     /* Open the audio file and check that it's usable. */
  68     sndfile = sf_open(filename, SFM_READ, &sfinfo);
  69     if(!sndfile)
  70     {
  71         fprintf(stderr, "Could not open audio in %s: %s\n", filename, sf_strerror(sndfile));
  72         return 0;
  73     }
  74     if(sfinfo.frames < 1 || sfinfo.frames > (sf_count_t)(INT_MAX/sizeof(short))/sfinfo.channels)
  75     {
  76         fprintf(stderr, "Bad sample count in %s (%" PRId64 ")\n", filename, sfinfo.frames);
  77         sf_close(sndfile);
  78         return 0;
  79     }
  80
  81     /* Get the sound format, and figure out the OpenAL format */
  82     format = AL_NONE;
  83     if(sfinfo.channels == 1)
  84         format = AL_FORMAT_MONO16;
  85     else if(sfinfo.channels == 2)
  86         format = AL_FORMAT_STEREO16;
  87     else if(sfinfo.channels == 3)
  88     {
  89         if(sf_command(sndfile, SFC_WAVEX_GET_AMBISONIC, NULL, 0) == SF_AMBISONIC_B_FORMAT)
  90             format = AL_FORMAT_BFORMAT2D_16;
  91     }
  92     else if(sfinfo.channels == 4)
  93     {
  94         if(sf_command(sndfile, SFC_WAVEX_GET_AMBISONIC, NULL, 0) == SF_AMBISONIC_B_FORMAT)
  95             format = AL_FORMAT_BFORMAT3D_16;
  96     }
  97     if(!format)
  98     {
  99         fprintf(stderr, "Unsupported channel count: %d\n", sfinfo.channels);
 100         sf_close(sndfile);
 101         return 0;
 102     }
 103
 104     /* Decode the whole audio file to a buffer. */
 105     membuf = malloc((size_t)(sfinfo.frames * sfinfo.channels) * sizeof(short));
 106
 107     num_frames = sf_readf_short(sndfile, membuf, sfinfo.frames);
 108     if(num_frames < 1)
 109     {
 110         free(membuf);
 111         sf_close(sndfile);
 112         fprintf(stderr, "Failed to read samples in %s (%" PRId64 ")\n", filename, num_frames);
 113         return 0;
 114     }
 115     num_bytes = (ALsizei)(num_frames * sfinfo.channels) * (ALsizei)sizeof(short);
 116
 117     /* Buffer the audio data into a new buffer object, then free the data and
 118      * close the file.
 119      */
 120     buffer = 0;
 121     alGenBuffers(1, &buffer);
 122     alBufferData(buffer, format, membuf, num_bytes, sfinfo.samplerate);
 123
 124     free(membuf);
 125     sf_close(sndfile);
 126
 127     /* Check if an error occured, and clean up if so. */
 128     err = alGetError();
 129     if(err != AL_NO_ERROR)
 130     {
 131         fprintf(stderr, "OpenAL Error: %s\n", alGetString(err));
 132         if(buffer && alIsBuffer(buffer))
 133             alDeleteBuffers(1, &buffer);
 134         return 0;
 135     }
 136
 137     return buffer;
 138 }
 139
 140
 141 int main(int argc, char **argv)
 142 {
 143     ALuint source, buffer;
 144     ALdouble offsets[2];
 145     ALenum state;
 146
 147     /* Print out usage if no arguments were specified */
 148     if(argc < 2)
 149     {
 150         fprintf(stderr, "Usage: %s [-device <name>] <filename>\n", argv[0]);
 151         return 1;
 152     }
 153
 154     /* Initialize OpenAL, and check for source_latency support. */
 155     argv++; argc--;
 156     if(InitAL(&argv, &argc) != 0)
 157         return 1;
 158
 159     if(!alIsExtensionPresent("AL_SOFT_source_latency"))
 160     {
 161         fprintf(stderr, "Error: AL_SOFT_source_latency not supported\n");
 162         CloseAL();
 163         return 1;
 164     }
 165
 166     /* Define a macro to help load the function pointers. */
 167 #define LOAD_PROC(T, x)  ((x) = FUNCTION_CAST(T, alGetProcAddress(#x)))
 168     LOAD_PROC(LPALSOURCEDSOFT, alSourcedSOFT);
 169     LOAD_PROC(LPALSOURCE3DSOFT, alSource3dSOFT);
 170     LOAD_PROC(LPALSOURCEDVSOFT, alSourcedvSOFT);
 171     LOAD_PROC(LPALGETSOURCEDSOFT, alGetSourcedSOFT);
 172     LOAD_PROC(LPALGETSOURCE3DSOFT, alGetSource3dSOFT);
 173     LOAD_PROC(LPALGETSOURCEDVSOFT, alGetSourcedvSOFT);
 174     LOAD_PROC(LPALSOURCEI64SOFT, alSourcei64SOFT);
 175     LOAD_PROC(LPALSOURCE3I64SOFT, alSource3i64SOFT);
 176     LOAD_PROC(LPALSOURCEI64VSOFT, alSourcei64vSOFT);
 177     LOAD_PROC(LPALGETSOURCEI64SOFT, alGetSourcei64SOFT);
 178     LOAD_PROC(LPALGETSOURCE3I64SOFT, alGetSource3i64SOFT);
 179     LOAD_PROC(LPALGETSOURCEI64VSOFT, alGetSourcei64vSOFT);
 180 #undef LOAD_PROC
 181
 182     /* Load the sound into a buffer. */
 183     buffer = LoadSound(argv[0]);
 184     if(!buffer)
 185     {
 186         CloseAL();
 187         return 1;
 188     }
 189
 190     /* Create the source to play the sound with. */
 191     source = 0;
 192     alGenSources(1, &source);
 193     alSourcei(source, AL_BUFFER, (ALint)buffer);
 194     assert(alGetError()==AL_NO_ERROR && "Failed to setup sound source");
 195
 196     /* Play the sound until it finishes. */
 197     alSourcePlay(source);
 198     do {
 199         al_nssleep(10000000);
 200         alGetSourcei(source, AL_SOURCE_STATE, &state);
 201
 202         /* Get the source offset and latency. AL_SEC_OFFSET_LATENCY_SOFT will
 203          * place the offset (in seconds) in offsets[0], and the time until that
 204          * offset will be heard (in seconds) in offsets[1]. */
 205         alGetSourcedvSOFT(source, AL_SEC_OFFSET_LATENCY_SOFT, offsets);
 206         printf("\rOffset: %f - Latency:%3u ms  ", offsets[0], (ALuint)(offsets[1]*1000));
 207         fflush(stdout);
 208     } while(alGetError() == AL_NO_ERROR && state == AL_PLAYING);
 209     printf("\n");
 210
 211     /* All done. Delete resources, and close down OpenAL. */
 212     alDeleteSources(1, &source);
 213     alDeleteBuffers(1, &buffer);
 214     CloseAL();
 215
 216     return 0;
 217 }