examples/altonegen.c

   1 /*
   2  * OpenAL Tone Generator Test
   3  *
   4  * Copyright (c) 2015 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 a test for generating waveforms and plays them for a
  26  * given length of time. Intended to inspect the behavior of the mixer by
  27  * checking the output with a spectrum analyzer and oscilloscope.
  28  *
  29  * TODO: This would actually be nicer as a GUI app with buttons to start and
  30  * stop individual waveforms, include additional whitenoise and pinknoise
  31  * generators, and have the ability to hook up EFX filters and effects.
  32  */
  33
  34 #include <stdio.h>
  35 #include <stdlib.h>
  36 #include <string.h>
  37 #include <assert.h>
  38 #include <limits.h>
  39 #include <math.h>
  40
  41 #include "AL/al.h"
  42 #include "AL/alc.h"
  43 #include "AL/alext.h"
  44
  45 #include "common/alhelpers.h"
  46
  47 #include "win_main_utf8.h"
  48
  49 #ifndef M_PI
  50 #define M_PI    (3.14159265358979323846)
  51 #endif
  52
  53 enum WaveType {
  54     WT_Sine,
  55     WT_Square,
  56     WT_Sawtooth,
  57     WT_Triangle,
  58     WT_Impulse,
  59     WT_WhiteNoise,
  60 };
  61
  62 static const char *GetWaveTypeName(enum WaveType type)
  63 {
  64     switch(type)
  65     {
  66         case WT_Sine: return "sine";
  67         case WT_Square: return "square";
  68         case WT_Sawtooth: return "sawtooth";
  69         case WT_Triangle: return "triangle";
  70         case WT_Impulse: return "impulse";
  71         case WT_WhiteNoise: return "noise";
  72     }
  73     return "(unknown)";
  74 }
  75
  76 static inline ALuint dither_rng(ALuint *seed)
  77 {
  78     *seed = (*seed * 96314165) + 907633515;
  79     return *seed;
  80 }
  81
  82 static void ApplySin(ALfloat *data, ALdouble g, ALuint srate, ALuint freq)
  83 {
  84     ALdouble smps_per_cycle = (ALdouble)srate / freq;
  85     ALuint i;
  86     for(i = 0;i < srate;i++)
  87     {
  88         ALdouble ival;
  89         data[i] += (ALfloat)(sin(modf(i/smps_per_cycle, &ival) * 2.0*M_PI) * g);
  90     }
  91 }
  92
  93 /* Generates waveforms using additive synthesis. Each waveform is constructed
  94  * by summing one or more sine waves, up to (and excluding) nyquist.
  95  */
  96 static ALuint CreateWave(enum WaveType type, ALuint freq, ALuint srate, ALfloat gain)
  97 {
  98     ALuint seed = 22222;
  99     ALuint data_size;
 100     ALfloat *data;
 101     ALuint buffer;
 102     ALenum err;
 103     ALuint i;
 104
 105     data_size = (ALuint)(srate * sizeof(ALfloat));
 106     data = calloc(1, data_size);
 107     switch(type)
 108     {
 109         case WT_Sine:
 110             ApplySin(data, 1.0, srate, freq);
 111             break;
 112         case WT_Square:
 113             for(i = 1;freq*i < srate/2;i+=2)
 114                 ApplySin(data, 4.0/M_PI * 1.0/i, srate, freq*i);
 115             break;
 116         case WT_Sawtooth:
 117             for(i = 1;freq*i < srate/2;i++)
 118                 ApplySin(data, 2.0/M_PI * ((i&1)*2 - 1.0) / i, srate, freq*i);
 119             break;
 120         case WT_Triangle:
 121             for(i = 1;freq*i < srate/2;i+=2)
 122                 ApplySin(data, 8.0/(M_PI*M_PI) * (1.0 - (i&2)) / (i*i), srate, freq*i);
 123             break;
 124         case WT_Impulse:
 125             /* NOTE: Impulse isn't handled using additive synthesis, and is
 126              * instead just a non-0 sample at a given rate. This can still be
 127              * useful to test (other than resampling, the ALSOFT_DEFAULT_REVERB
 128              * environment variable can prove useful here to test the reverb
 129              * response).
 130              */
 131             for(i = 0;i < srate;i++)
 132                 data[i] = (i%(srate/freq)) ? 0.0f : 1.0f;
 133             break;
 134         case WT_WhiteNoise:
 135             /* NOTE: WhiteNoise is just uniform set of uncorrelated values, and
 136              * is not influenced by the waveform frequency.
 137              */
 138             for(i = 0;i < srate;i++)
 139             {
 140                 ALuint rng0 = dither_rng(&seed);
 141                 ALuint rng1 = dither_rng(&seed);
 142                 data[i] = (ALfloat)(rng0*(1.0/UINT_MAX) - rng1*(1.0/UINT_MAX));
 143             }
 144             break;
 145     }
 146
 147     if(gain != 1.0f)
 148     {
 149         for(i = 0;i < srate;i++)
 150             data[i] *= gain;
 151     }
 152
 153     /* Buffer the audio data into a new buffer object. */
 154     buffer = 0;
 155     alGenBuffers(1, &buffer);
 156     alBufferData(buffer, AL_FORMAT_MONO_FLOAT32, data, (ALsizei)data_size, (ALsizei)srate);
 157     free(data);
 158
 159     /* Check if an error occured, and clean up if so. */
 160     err = alGetError();
 161     if(err != AL_NO_ERROR)
 162     {
 163         fprintf(stderr, "OpenAL Error: %s\n", alGetString(err));
 164         if(alIsBuffer(buffer))
 165             alDeleteBuffers(1, &buffer);
 166         return 0;
 167     }
 168
 169     return buffer;
 170 }
 171
 172
 173 int main(int argc, char *argv[])
 174 {
 175     enum WaveType wavetype = WT_Sine;
 176     const char *appname = argv[0];
 177     ALuint source, buffer;
 178     ALint last_pos, num_loops;
 179     ALint max_loops = 4;
 180     ALint srate = -1;
 181     ALint tone_freq = 1000;
 182     ALCint dev_rate;
 183     ALenum state;
 184     ALfloat gain = 1.0f;
 185     int i;
 186
 187     argv++; argc--;
 188     if(InitAL(&argv, &argc) != 0)
 189         return 1;
 190
 191     if(!alIsExtensionPresent("AL_EXT_FLOAT32"))
 192     {
 193         fprintf(stderr, "Required AL_EXT_FLOAT32 extension not supported on this device!\n");
 194         CloseAL();
 195         return 1;
 196     }
 197
 198     for(i = 0;i < argc;i++)
 199     {
 200         if(strcmp(argv[i], "-h") == 0 || strcmp(argv[i], "-?") == 0
 201             || strcmp(argv[i], "--help") == 0)
 202         {
 203             fprintf(stderr, "OpenAL Tone Generator\n"
 204 "\n"
 205 "Usage: %s [-device <name>] <options>\n"
 206 "\n"
 207 "Available options:\n"
 208 "  --help/-h                 This help text\n"
 209 "  -t <seconds>              Time to play a tone (default 5 seconds)\n"
 210 "  --waveform/-w <type>      Waveform type: sine (default), square, sawtooth,\n"
 211 "                                triangle, impulse, noise\n"
 212 "  --freq/-f <hz>            Tone frequency (default 1000 hz)\n"
 213 "  --gain/-g <gain>          gain 0.0 to 1 (default 1)\n"
 214 "  --srate/-s <sample rate>  Sampling rate (default output rate)\n",
 215                 appname
 216             );
 217             CloseAL();
 218             return 1;
 219         }
 220         else if(i+1 < argc && strcmp(argv[i], "-t") == 0)
 221         {
 222             i++;
 223             max_loops = atoi(argv[i]) - 1;
 224         }
 225         else if(i+1 < argc && (strcmp(argv[i], "--waveform") == 0 || strcmp(argv[i], "-w") == 0))
 226         {
 227             i++;
 228             if(strcmp(argv[i], "sine") == 0)
 229                 wavetype = WT_Sine;
 230             else if(strcmp(argv[i], "square") == 0)
 231                 wavetype = WT_Square;
 232             else if(strcmp(argv[i], "sawtooth") == 0)
 233                 wavetype = WT_Sawtooth;
 234             else if(strcmp(argv[i], "triangle") == 0)
 235                 wavetype = WT_Triangle;
 236             else if(strcmp(argv[i], "impulse") == 0)
 237                 wavetype = WT_Impulse;
 238             else if(strcmp(argv[i], "noise") == 0)
 239                 wavetype = WT_WhiteNoise;
 240             else
 241                 fprintf(stderr, "Unhandled waveform: %s\n", argv[i]);
 242         }
 243         else if(i+1 < argc && (strcmp(argv[i], "--freq") == 0 || strcmp(argv[i], "-f") == 0))
 244         {
 245             i++;
 246             tone_freq = atoi(argv[i]);
 247             if(tone_freq < 1)
 248             {
 249                 fprintf(stderr, "Invalid tone frequency: %s (min: 1hz)\n", argv[i]);
 250                 tone_freq = 1;
 251             }
 252         }
 253         else if(i+1 < argc && (strcmp(argv[i], "--gain") == 0 || strcmp(argv[i], "-g") == 0))
 254         {
 255             i++;
 256             gain = (ALfloat)atof(argv[i]);
 257             if(gain < 0.0f || gain > 1.0f)
 258             {
 259                 fprintf(stderr, "Invalid gain: %s (min: 0.0, max 1.0)\n", argv[i]);
 260                 gain = 1.0f;
 261             }
 262         }
 263         else if(i+1 < argc && (strcmp(argv[i], "--srate") == 0 || strcmp(argv[i], "-s") == 0))
 264         {
 265             i++;
 266             srate = atoi(argv[i]);
 267             if(srate < 40)
 268             {
 269                 fprintf(stderr, "Invalid sample rate: %s (min: 40hz)\n", argv[i]);
 270                 srate = 40;
 271             }
 272         }
 273     }
 274
 275     {
 276         ALCdevice *device = alcGetContextsDevice(alcGetCurrentContext());
 277         alcGetIntegerv(device, ALC_FREQUENCY, 1, &dev_rate);
 278         assert(alcGetError(device)==ALC_NO_ERROR && "Failed to get device sample rate");
 279     }
 280     if(srate < 0)
 281         srate = dev_rate;
 282
 283     /* Load the sound into a buffer. */
 284     buffer = CreateWave(wavetype, (ALuint)tone_freq, (ALuint)srate, gain);
 285     if(!buffer)
 286     {
 287         CloseAL();
 288         return 1;
 289     }
 290
 291     printf("Playing %dhz %s-wave tone with %dhz sample rate and %dhz output, for %d second%s...\n",
 292            tone_freq, GetWaveTypeName(wavetype), srate, dev_rate, max_loops+1, max_loops?"s":"");
 293     fflush(stdout);
 294
 295     /* Create the source to play the sound with. */
 296     source = 0;
 297     alGenSources(1, &source);
 298     alSourcei(source, AL_BUFFER, (ALint)buffer);
 299     assert(alGetError()==AL_NO_ERROR && "Failed to setup sound source");
 300
 301     /* Play the sound for a while. */
 302     num_loops = 0;
 303     last_pos = 0;
 304     alSourcei(source, AL_LOOPING, (max_loops > 0) ? AL_TRUE : AL_FALSE);
 305     alSourcePlay(source);
 306     do {
 307         ALint pos;
 308         al_nssleep(10000000);
 309         alGetSourcei(source, AL_SAMPLE_OFFSET, &pos);
 310         alGetSourcei(source, AL_SOURCE_STATE, &state);
 311         if(pos < last_pos && state == AL_PLAYING)
 312         {
 313             ++num_loops;
 314             if(num_loops >= max_loops)
 315                 alSourcei(source, AL_LOOPING, AL_FALSE);
 316             printf("%d...\n", max_loops - num_loops + 1);
 317             fflush(stdout);
 318         }
 319         last_pos = pos;
 320     } while(alGetError() == AL_NO_ERROR && state == AL_PLAYING);
 321
 322     /* All done. Delete resources, and close OpenAL. */
 323     alDeleteSources(1, &source);
 324     alDeleteBuffers(1, &buffer);
 325
 326     /* Close up OpenAL. */
 327     CloseAL();
 328
 329     return 0;
 330 }