rlm@0: /*
rlm@0:  * OpenAL Info Utility
rlm@0:  *
rlm@0:  * Copyright (c) 2010 by Chris Robinson <chris.kcat@gmail.com>
rlm@0:  *
rlm@0:  * Permission is hereby granted, free of charge, to any person obtaining a copy
rlm@0:  * of this software and associated documentation files (the "Software"), to deal
rlm@0:  * in the Software without restriction, including without limitation the rights
rlm@0:  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
rlm@0:  * copies of the Software, and to permit persons to whom the Software is
rlm@0:  * furnished to do so, subject to the following conditions:
rlm@0:  *
rlm@0:  * The above copyright notice and this permission notice shall be included in
rlm@0:  * all copies or substantial portions of the Software.
rlm@0:  *
rlm@0:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
rlm@0:  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
rlm@0:  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
rlm@0:  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
rlm@0:  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
rlm@0:  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
rlm@0:  * THE SOFTWARE.
rlm@0:  */
rlm@0: 
rlm@0: #include <stdio.h>
rlm@0: #include <string.h>
rlm@0: 
rlm@0: #include "AL/alc.h"
rlm@0: #include "AL/al.h"
rlm@0: #include "AL/alext.h"
rlm@0: 
rlm@0: #ifndef ALC_ENUMERATE_ALL_EXT
rlm@0: #define ALC_DEFAULT_ALL_DEVICES_SPECIFIER        0x1012
rlm@0: #define ALC_ALL_DEVICES_SPECIFIER                0x1013
rlm@0: #endif
rlm@0: 
rlm@0: #ifndef ALC_EXT_EFX
rlm@0: #define ALC_EFX_MAJOR_VERSION                    0x20001
rlm@0: #define ALC_EFX_MINOR_VERSION                    0x20002
rlm@0: #define ALC_MAX_AUXILIARY_SENDS                  0x20003
rlm@0: #define AL_FILTER_TYPE                           0x8001
rlm@0: #define AL_FILTER_NULL                           0x0000
rlm@0: #define AL_FILTER_LOWPASS                        0x0001
rlm@0: #define AL_FILTER_HIGHPASS                       0x0002
rlm@0: #define AL_FILTER_BANDPASS                       0x0003
rlm@0: #define AL_EFFECT_TYPE                           0x8001
rlm@0: #define AL_EFFECT_NULL                           0x0000
rlm@0: #define AL_EFFECT_EAXREVERB                      0x8000
rlm@0: #define AL_EFFECT_REVERB                         0x0001
rlm@0: #define AL_EFFECT_CHORUS                         0x0002
rlm@0: #define AL_EFFECT_DISTORTION                     0x0003
rlm@0: #define AL_EFFECT_ECHO                           0x0004
rlm@0: #define AL_EFFECT_FLANGER                        0x0005
rlm@0: #define AL_EFFECT_FREQUENCY_SHIFTER              0x0006
rlm@0: #define AL_EFFECT_VOCAL_MORPHER                  0x0007
rlm@0: #define AL_EFFECT_PITCH_SHIFTER                  0x0008
rlm@0: #define AL_EFFECT_RING_MODULATOR                 0x0009
rlm@0: #define AL_EFFECT_AUTOWAH                        0x000A
rlm@0: #define AL_EFFECT_COMPRESSOR                     0x000B
rlm@0: #define AL_EFFECT_EQUALIZER                      0x000C
rlm@0: typedef void (AL_APIENTRY *LPALGENFILTERS)(ALsizei, ALuint*);
rlm@0: typedef void (AL_APIENTRY *LPALDELETEFILTERS)(ALsizei, ALuint*);
rlm@0: typedef void (AL_APIENTRY *LPALFILTERI)(ALuint, ALenum, ALint);
rlm@0: typedef void (AL_APIENTRY *LPALGENEFFECTS)(ALsizei, ALuint*);
rlm@0: typedef void (AL_APIENTRY *LPALDELETEEFFECTS)(ALsizei, ALuint*);
rlm@0: typedef void (AL_APIENTRY *LPALEFFECTI)(ALuint, ALenum, ALint);
rlm@0: #endif
rlm@0: static LPALGENFILTERS    palGenFilters;
rlm@0: static LPALDELETEFILTERS palDeleteFilters;
rlm@0: static LPALFILTERI       palFilteri;
rlm@0: static LPALGENEFFECTS    palGenEffects;
rlm@0: static LPALDELETEEFFECTS palDeleteEffects;
rlm@0: static LPALEFFECTI       palEffecti;
rlm@0: 
rlm@0: #ifndef ALC_EXT_DEDICATED
rlm@0: #define AL_EFFECT_DEDICATED_DIALOGUE             0x9001
rlm@0: #define AL_EFFECT_DEDICATED_LOW_FREQUENCY_EFFECT 0x9000
rlm@0: #endif
rlm@0: 
rlm@0: 
rlm@0: #define MAX_WIDTH  80
rlm@0: 
rlm@0: static void printList(const char *list, char separator)
rlm@0: {
rlm@0:     size_t col = MAX_WIDTH, len;
rlm@0:     const char *indent = "    ";
rlm@0:     const char *next;
rlm@0: 
rlm@0:     if(!list || *list == '\0')
rlm@0:     {
rlm@0:         fprintf(stdout, "\n%s!!! none !!!\n", indent);
rlm@0:         return;
rlm@0:     }
rlm@0: 
rlm@0:     do {
rlm@0:         next = strchr(list, separator);
rlm@0:         if(next)
rlm@0:         {
rlm@0:             len = next-list;
rlm@0:             do {
rlm@0:                 next++;
rlm@0:             } while(*next == separator);
rlm@0:         }
rlm@0:         else
rlm@0:             len = strlen(list);
rlm@0: 
rlm@0:         if(len + col + 2 >= MAX_WIDTH)
rlm@0:         {
rlm@0:             fprintf(stdout, "\n%s", indent);
rlm@0:             col = strlen(indent);
rlm@0:         }
rlm@0:         else
rlm@0:         {
rlm@0:             fputc(' ', stdout);
rlm@0:             col++;
rlm@0:         }
rlm@0: 
rlm@0:         len = fwrite(list, 1, len, stdout);
rlm@0:         col += len;
rlm@0: 
rlm@0:         if(!next || *next == '\0')
rlm@0:             break;
rlm@0:         fputc(',', stdout);
rlm@0:         col++;
rlm@0: 
rlm@0:         list = next;
rlm@0:     } while(1);
rlm@0:     fputc('\n', stdout);
rlm@0: }
rlm@0: 
rlm@0: static void printDeviceList(const char *list)
rlm@0: {
rlm@0:     if(!list || *list == '\0')
rlm@0:         printf("    !!! none !!!\n");
rlm@0:     else do {
rlm@0:         printf("    %s\n", list);
rlm@0:         list += strlen(list) + 1;
rlm@0:     } while(*list != '\0');
rlm@0: }
rlm@0: 
rlm@0: 
rlm@0: static ALenum checkALErrors(int linenum)
rlm@0: {
rlm@0:     ALenum err = alGetError();
rlm@0:     if(err != AL_NO_ERROR)
rlm@0:         printf("OpenAL Error: %s (0x%x), @ %d\n", alGetString(err), err, linenum);
rlm@0:     return err;
rlm@0: }
rlm@0: #define checkALErrors() checkALErrors(__LINE__)
rlm@0: 
rlm@0: static ALCenum checkALCErrors(ALCdevice *device, int linenum)
rlm@0: {
rlm@0:     ALCenum err = alcGetError(device);
rlm@0:     if(err != ALC_NO_ERROR)
rlm@0:         printf("ALC Error: %s (0x%x), @ %d\n", alcGetString(device, err), err, linenum);
rlm@0:     return err;
rlm@0: }
rlm@0: #define checkALCErrors(x) checkALCErrors((x),__LINE__)
rlm@0: 
rlm@0: 
rlm@0: static void printALCInfo(ALCdevice *device)
rlm@0: {
rlm@0:     ALCint major, minor;
rlm@0: 
rlm@0:     alcGetIntegerv(device, ALC_MAJOR_VERSION, 1, &major);
rlm@0:     alcGetIntegerv(device, ALC_MINOR_VERSION, 1, &minor);
rlm@0:     if(checkALCErrors(device) == ALC_NO_ERROR)
rlm@0:         printf("ALC version: %d.%d\n", major, minor);
rlm@0:     if(device)
rlm@0:     {
rlm@0:         printf("ALC extensions:");
rlm@0:         printList(alcGetString(device, ALC_EXTENSIONS), ' ');
rlm@0:         checkALCErrors(device);
rlm@0:     }
rlm@0: }
rlm@0: 
rlm@0: static void printALInfo(void)
rlm@0: {
rlm@0:     printf("OpenAL vendor string: %s\n", alGetString(AL_VENDOR));
rlm@0:     printf("OpenAL renderer string: %s\n", alGetString(AL_RENDERER));
rlm@0:     printf("OpenAL version string: %s\n", alGetString(AL_VERSION));
rlm@0:     printf("OpenAL extensions:");
rlm@0:     printList(alGetString(AL_EXTENSIONS), ' ');
rlm@0:     checkALErrors();
rlm@0: }
rlm@0: 
rlm@0: static void printEFXInfo(ALCdevice *device)
rlm@0: {
rlm@0:     ALCint major, minor, sends;
rlm@0:     ALuint obj;
rlm@0:     int i;
rlm@0:     const ALenum filters[] = {
rlm@0:         AL_FILTER_LOWPASS, AL_FILTER_HIGHPASS, AL_FILTER_BANDPASS,
rlm@0:         AL_FILTER_NULL
rlm@0:     };
rlm@0:     char filterNames[] = "Low-pass,High-pass,Band-pass,";
rlm@0:     const ALenum effects[] = {
rlm@0:         AL_EFFECT_EAXREVERB, AL_EFFECT_REVERB, AL_EFFECT_CHORUS,
rlm@0:         AL_EFFECT_DISTORTION, AL_EFFECT_ECHO, AL_EFFECT_FLANGER,
rlm@0:         AL_EFFECT_FREQUENCY_SHIFTER, AL_EFFECT_VOCAL_MORPHER,
rlm@0:         AL_EFFECT_PITCH_SHIFTER, AL_EFFECT_RING_MODULATOR, AL_EFFECT_AUTOWAH,
rlm@0:         AL_EFFECT_COMPRESSOR, AL_EFFECT_EQUALIZER, AL_EFFECT_NULL
rlm@0:     };
rlm@0:     const ALenum dedeffects[] = {
rlm@0:         AL_EFFECT_DEDICATED_DIALOGUE,
rlm@0:         AL_EFFECT_DEDICATED_LOW_FREQUENCY_EFFECT, AL_EFFECT_NULL
rlm@0:     };
rlm@0:     char effectNames[] = "EAX Reverb,Reverb,Chorus,Distortion,Echo,Flanger,"
rlm@0:                          "Frequency Shifter,Vocal Morpher,Pitch Shifter,"
rlm@0:                          "Ring Modulator,Autowah,Compressor,Equalizer,"
rlm@0:                          "Dedicated Dialog,Dedicated LFE,";
rlm@0:     char *current;
rlm@0: 
rlm@0:     if(alcIsExtensionPresent(device, "ALC_EXT_EFX") == AL_FALSE)
rlm@0:     {
rlm@0:         printf("EFX not available\n");
rlm@0:         return;
rlm@0:     }
rlm@0: 
rlm@0:     alcGetIntegerv(device, ALC_EFX_MAJOR_VERSION, 1, &major);
rlm@0:     alcGetIntegerv(device, ALC_EFX_MINOR_VERSION, 1, &minor);
rlm@0:     if(checkALCErrors(device) == ALC_NO_ERROR)
rlm@0:         printf("EFX version: %d.%d\n", major, minor);
rlm@0:     alcGetIntegerv(device, ALC_MAX_AUXILIARY_SENDS, 1, &sends);
rlm@0:     if(checkALCErrors(device) == ALC_NO_ERROR)
rlm@0:         printf("Max auxiliary sends: %d\n", sends);
rlm@0: 
rlm@0:     palGenFilters = alGetProcAddress("alGenFilters");
rlm@0:     palDeleteFilters = alGetProcAddress("alDeleteFilters");
rlm@0:     palFilteri = alGetProcAddress("alFilteri");
rlm@0:     palGenEffects = alGetProcAddress("alGenEffects");
rlm@0:     palDeleteEffects = alGetProcAddress("alDeleteEffects");
rlm@0:     palEffecti = alGetProcAddress("alEffecti");
rlm@0:     if(checkALErrors() != AL_NO_ERROR ||
rlm@0:        !palGenFilters || !palDeleteFilters || !palFilteri ||
rlm@0:        !palGenEffects || !palDeleteEffects || !palEffecti)
rlm@0:     {
rlm@0:         printf("!!! Missing EFX functions !!!\n");
rlm@0:         return;
rlm@0:     }
rlm@0: 
rlm@0:     palGenFilters(1, &obj);
rlm@0:     if(checkALErrors() == AL_NO_ERROR)
rlm@0:     {
rlm@0:         current = filterNames;
rlm@0:         for(i = 0;filters[i] != AL_FILTER_NULL;i++)
rlm@0:         {
rlm@0:             char *next = strchr(current, ',');
rlm@0: 
rlm@0:             palFilteri(obj, AL_FILTER_TYPE, filters[i]);
rlm@0:             if(alGetError() == AL_NO_ERROR)
rlm@0:                 current = next+1;
rlm@0:             else
rlm@0:                 memmove(current, next+1, strlen(next));
rlm@0:         }
rlm@0:         palDeleteFilters(1, &obj);
rlm@0:         checkALErrors();
rlm@0: 
rlm@0:         printf("Supported filters:");
rlm@0:         printList(filterNames, ',');
rlm@0:     }
rlm@0: 
rlm@0:     palGenEffects(1, &obj);
rlm@0:     if(checkALErrors() == AL_NO_ERROR)
rlm@0:     {
rlm@0:         current = effectNames;
rlm@0:         for(i = 0;effects[i] != AL_EFFECT_NULL;i++)
rlm@0:         {
rlm@0:             char *next = strchr(current, ',');
rlm@0: 
rlm@0:             palEffecti(obj, AL_EFFECT_TYPE, effects[i]);
rlm@0:             if(alGetError() == AL_NO_ERROR)
rlm@0:                 current = next+1;
rlm@0:             else
rlm@0:                 memmove(current, next+1, strlen(next));
rlm@0:         }
rlm@0:         if(alcIsExtensionPresent(device, "ALC_EXT_DEDICATED"))
rlm@0:         {
rlm@0:             for(i = 0;dedeffects[i] != AL_EFFECT_NULL;i++)
rlm@0:             {
rlm@0:                 char *next = strchr(current, ',');
rlm@0: 
rlm@0:                 palEffecti(obj, AL_EFFECT_TYPE, dedeffects[i]);
rlm@0:                 if(alGetError() == AL_NO_ERROR)
rlm@0:                     current = next+1;
rlm@0:                 else
rlm@0:                     memmove(current, next+1, strlen(next));
rlm@0:             }
rlm@0:         }
rlm@0:         else
rlm@0:         {
rlm@0:             for(i = 0;dedeffects[i] != AL_EFFECT_NULL;i++)
rlm@0:             {
rlm@0:                 char *next = strchr(current, ',');
rlm@0:                 memmove(current, next+1, strlen(next));
rlm@0:             }
rlm@0:         }
rlm@0:         palDeleteEffects(1, &obj);
rlm@0:         checkALErrors();
rlm@0: 
rlm@0:         printf("Supported effects:");
rlm@0:         printList(effectNames, ',');
rlm@0:     }
rlm@0: }
rlm@0: 
rlm@0: int main(int argc, char *argv[])
rlm@0: {
rlm@0:     ALCdevice *device;
rlm@0:     ALCcontext *context;
rlm@0: 
rlm@0:     if(argc > 1 && (strcmp(argv[1], "--help") == 0 ||
rlm@0:                     strcmp(argv[1], "-h") == 0))
rlm@0:     {
rlm@0:         printf("Usage: %s [playback device]\n", argv[0]);
rlm@0:         return 0;
rlm@0:     }
rlm@0: 
rlm@0:     printf("Available playback devices:\n");
rlm@0:     if(alcIsExtensionPresent(NULL, "ALC_ENUMERATE_ALL_EXT") != AL_FALSE)
rlm@0:         printDeviceList(alcGetString(NULL, ALC_ALL_DEVICES_SPECIFIER));
rlm@0:     else
rlm@0:         printDeviceList(alcGetString(NULL, ALC_DEVICE_SPECIFIER));
rlm@0:     printf("Available capture devices:\n");
rlm@0:     printDeviceList(alcGetString(NULL, ALC_CAPTURE_DEVICE_SPECIFIER));
rlm@0: 
rlm@0:     if(alcIsExtensionPresent(NULL, "ALC_ENUMERATE_ALL_EXT") != AL_FALSE)
rlm@0:         printf("Default playback device: %s\n",
rlm@0:                alcGetString(NULL, ALC_DEFAULT_ALL_DEVICES_SPECIFIER));
rlm@0:     else
rlm@0:         printf("Default playback device: %s\n",
rlm@0:                alcGetString(NULL, ALC_DEFAULT_DEVICE_SPECIFIER));
rlm@0:     printf("Default capture device: %s\n",
rlm@0:            alcGetString(NULL, ALC_CAPTURE_DEFAULT_DEVICE_SPECIFIER));
rlm@0: 
rlm@0:     printALCInfo(NULL);
rlm@0: 
rlm@0:     device = alcOpenDevice((argc>1) ? argv[1] : NULL);
rlm@0:     if(!device)
rlm@0:     {
rlm@0:         printf("\n!!! Failed to open %s !!!\n\n", ((argc>1) ? argv[1] : "default device"));
rlm@0:         return 1;
rlm@0:     }
rlm@0: 
rlm@0:     printf("\n** Info for device \"%s\" **\n", alcGetString(device, ALC_DEVICE_SPECIFIER));
rlm@0:     printALCInfo(device);
rlm@0: 
rlm@0:     context = alcCreateContext(device, NULL);
rlm@0:     if(!context || alcMakeContextCurrent(context) == ALC_FALSE)
rlm@0:     {
rlm@0:         if(context)
rlm@0:             alcDestroyContext(context);
rlm@0:         alcCloseDevice(device);
rlm@0:         printf("\n!!! Failed to set a context !!!\n\n");
rlm@0:         return 1;
rlm@0:     }
rlm@0: 
rlm@0:     printALInfo();
rlm@0:     printEFXInfo(device);
rlm@0: 
rlm@0:     alcMakeContextCurrent(NULL);
rlm@0:     alcDestroyContext(context);
rlm@0:     alcCloseDevice(device);
rlm@0: 
rlm@0:     return 0;
rlm@0: }