From f7d67a91e04630efdff641e5e9aae1d11e5bd999 Mon Sep 17 00:00:00 2001 From: Maxim Poliakovski Date: Fri, 8 May 2020 22:32:29 +0200 Subject: [PATCH] New AWAC and sound server implementation. --- CMakeLists.txt | 20 +- devices/awacs.cpp | 191 +- devices/awacs.h | 18 +- devices/dbdma.cpp | 3 - devices/dbdma.h | 4 +- devices/hwcomponent.h | 23 +- devices/soundserver.cpp | 81 + devices/soundserver.h | 73 + machines/machinegossamer.cpp | 3 + main.cpp | 6 + thirdparty/libsoundio/.gitignore | 3 + thirdparty/libsoundio/CHANGELOG.md | 78 + thirdparty/libsoundio/CMakeLists.txt | 388 +++ thirdparty/libsoundio/LICENSE | 21 + thirdparty/libsoundio/README.md | 266 ++ .../libsoundio/cmake/FindCoreAudio.cmake | 16 + thirdparty/libsoundio/cmake/FindJACK.cmake | 19 + .../libsoundio/cmake/FindPulseAudio.cmake | 16 + thirdparty/libsoundio/cmake/FindWASAPI.cmake | 14 + thirdparty/libsoundio/doc/FindSoundIo.cmake | 16 + thirdparty/libsoundio/doc/doxygen.conf.in | 2036 ++++++++++++++ thirdparty/libsoundio/doc/footer.html | 2 + .../libsoundio/example/sio_list_devices.c | 181 ++ .../libsoundio/example/sio_microphone.c | 390 +++ thirdparty/libsoundio/example/sio_record.c | 300 +++ thirdparty/libsoundio/example/sio_sine.c | 289 ++ thirdparty/libsoundio/soundio/endian.h | 97 + thirdparty/libsoundio/soundio/soundio.h | 1207 +++++++++ thirdparty/libsoundio/src/alsa.c | 1958 ++++++++++++++ thirdparty/libsoundio/src/alsa.h | 89 + thirdparty/libsoundio/src/atomics.h | 80 + thirdparty/libsoundio/src/channel_layout.c | 465 ++++ thirdparty/libsoundio/src/config.h.in | 22 + thirdparty/libsoundio/src/coreaudio.c | 1487 +++++++++++ thirdparty/libsoundio/src/coreaudio.h | 67 + thirdparty/libsoundio/src/dummy.c | 570 ++++ thirdparty/libsoundio/src/dummy.h | 55 + thirdparty/libsoundio/src/jack.c | 964 +++++++ thirdparty/libsoundio/src/jack.h | 79 + thirdparty/libsoundio/src/list.h | 145 + thirdparty/libsoundio/src/os.c | 747 ++++++ thirdparty/libsoundio/src/os.h | 67 + thirdparty/libsoundio/src/pulseaudio.c | 1148 ++++++++ thirdparty/libsoundio/src/pulseaudio.h | 65 + thirdparty/libsoundio/src/ring_buffer.c | 98 + thirdparty/libsoundio/src/ring_buffer.h | 24 + thirdparty/libsoundio/src/soundio.c | 833 ++++++ thirdparty/libsoundio/src/soundio_internal.h | 16 + thirdparty/libsoundio/src/soundio_private.h | 186 ++ thirdparty/libsoundio/src/util.c | 45 + thirdparty/libsoundio/src/util.h | 98 + thirdparty/libsoundio/src/wasapi.c | 2332 +++++++++++++++++ thirdparty/libsoundio/src/wasapi.h | 117 + .../test/backend_disconnect_recover.c | 122 + thirdparty/libsoundio/test/latency.c | 251 ++ thirdparty/libsoundio/test/overflow.c | 230 ++ thirdparty/libsoundio/test/underflow.c | 251 ++ thirdparty/libsoundio/test/unit_tests.c | 250 ++ thirdparty/libsoundio/test/valgrind.supp | 124 + 59 files changed, 18632 insertions(+), 114 deletions(-) create mode 100644 devices/soundserver.cpp create mode 100644 devices/soundserver.h create mode 100644 thirdparty/libsoundio/.gitignore create mode 100644 thirdparty/libsoundio/CHANGELOG.md create mode 100644 thirdparty/libsoundio/CMakeLists.txt create mode 100644 thirdparty/libsoundio/LICENSE create mode 100644 thirdparty/libsoundio/README.md create mode 100644 thirdparty/libsoundio/cmake/FindCoreAudio.cmake create mode 100644 thirdparty/libsoundio/cmake/FindJACK.cmake create mode 100644 thirdparty/libsoundio/cmake/FindPulseAudio.cmake create mode 100644 thirdparty/libsoundio/cmake/FindWASAPI.cmake create mode 100644 thirdparty/libsoundio/doc/FindSoundIo.cmake create mode 100644 thirdparty/libsoundio/doc/doxygen.conf.in create mode 100644 thirdparty/libsoundio/doc/footer.html create mode 100644 thirdparty/libsoundio/example/sio_list_devices.c create mode 100644 thirdparty/libsoundio/example/sio_microphone.c create mode 100644 thirdparty/libsoundio/example/sio_record.c create mode 100644 thirdparty/libsoundio/example/sio_sine.c create mode 100644 thirdparty/libsoundio/soundio/endian.h create mode 100644 thirdparty/libsoundio/soundio/soundio.h create mode 100644 thirdparty/libsoundio/src/alsa.c create mode 100644 thirdparty/libsoundio/src/alsa.h create mode 100644 thirdparty/libsoundio/src/atomics.h create mode 100644 thirdparty/libsoundio/src/channel_layout.c create mode 100644 thirdparty/libsoundio/src/config.h.in create mode 100644 thirdparty/libsoundio/src/coreaudio.c create mode 100644 thirdparty/libsoundio/src/coreaudio.h create mode 100644 thirdparty/libsoundio/src/dummy.c create mode 100644 thirdparty/libsoundio/src/dummy.h create mode 100644 thirdparty/libsoundio/src/jack.c create mode 100644 thirdparty/libsoundio/src/jack.h create mode 100644 thirdparty/libsoundio/src/list.h create mode 100644 thirdparty/libsoundio/src/os.c create mode 100644 thirdparty/libsoundio/src/os.h create mode 100644 thirdparty/libsoundio/src/pulseaudio.c create mode 100644 thirdparty/libsoundio/src/pulseaudio.h create mode 100644 thirdparty/libsoundio/src/ring_buffer.c create mode 100644 thirdparty/libsoundio/src/ring_buffer.h create mode 100644 thirdparty/libsoundio/src/soundio.c create mode 100644 thirdparty/libsoundio/src/soundio_internal.h create mode 100644 thirdparty/libsoundio/src/soundio_private.h create mode 100644 thirdparty/libsoundio/src/util.c create mode 100644 thirdparty/libsoundio/src/util.h create mode 100644 thirdparty/libsoundio/src/wasapi.c create mode 100644 thirdparty/libsoundio/src/wasapi.h create mode 100644 thirdparty/libsoundio/test/backend_disconnect_recover.c create mode 100644 thirdparty/libsoundio/test/latency.c create mode 100644 thirdparty/libsoundio/test/overflow.c create mode 100644 thirdparty/libsoundio/test/underflow.c create mode 100644 thirdparty/libsoundio/test/unit_tests.c create mode 100644 thirdparty/libsoundio/test/valgrind.supp diff --git a/CMakeLists.txt b/CMakeLists.txt index a257504..cb9a7cd 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -6,7 +6,7 @@ set(CMAKE_CXX_STANDARD 11) set(CMAKE_INCLUDE_CURRENT_DIR ON) set(EXECUTABLE_OUTPUT_PATH ${CMAKE_BINARY_DIR}/bin) set(LIBRARY_OUTPUT_PATH ${CMAKE_BINARY_DIR}/lib) - + if (NOT WIN32) find_package(SDL2 REQUIRED) include_directories(${SDL2_INCLUDE_DIRS}) @@ -18,11 +18,17 @@ add_subdirectory("${PROJECT_SOURCE_DIR}/devices/") add_subdirectory("${PROJECT_SOURCE_DIR}/machines/") add_subdirectory("${PROJECT_SOURCE_DIR}/thirdparty/loguru/") +#option(BUILD_DYNAMIC_LIBS "Build libsoundio dynamic libraries" OFF) +option(BUILD_EXAMPLE_PROGRAMS "Build libsoundio example programs" OFF) +option(BUILD_TESTS "Build libsoundio tests" OFF) +add_subdirectory("${PROJECT_SOURCE_DIR}/thirdparty/libsoundio") + include_directories("${PROJECT_SOURCE_DIR}" "${PROJECT_SOURCE_DIR}/devices" "${PROJECT_SOURCE_DIR}/cpu/ppc" "${PROJECT_SOURCE_DIR}/debugger" "${PROJECT_SOURCE_DIR}/thirdparty/loguru/" - "${PROJECT_SOURCE_DIR}/thirdparty/SDL2/") + "${PROJECT_SOURCE_DIR}/thirdparty/SDL2/" + ${LIBSOUNDIO_HEADERS}) file(GLOB SOURCES "${PROJECT_SOURCE_DIR}/*.cpp" "${PROJECT_SOURCE_DIR}/*.c" @@ -36,12 +42,12 @@ add_executable(dingusppc ${SOURCES} $ $ $ $) - + if (WIN32) target_link_libraries(dingusppc "${PROJECT_SOURCE_DIR}/thirdparty/SDL2/lib/x64/SDL2.lib" "${PROJECT_SOURCE_DIR}/thirdparty/SDL2/lib/x64/SDL2main.lib") else() -target_link_libraries(dingusppc ${SDL2_LIBRARIES}) +target_link_libraries(dingusppc libsoundio_shared ${LIBSOUNDIO_LIBS} ${SDL2_LIBRARIES}) endif() @@ -50,12 +56,12 @@ add_executable(testppc ${TEST_SOURCES} $ $ $ $) - + if (WIN32) target_link_libraries(testppc "${PROJECT_SOURCE_DIR}/thirdparty/SDL2/lib/x64/SDL2.lib" "${PROJECT_SOURCE_DIR}/thirdparty/SDL2/lib/x64/SDL2main.lib") else() -target_link_libraries(testppc ${SDL2_LIBRARIES}) +target_link_libraries(testppc libsoundio_shared ${LIBSOUNDIO_LIBS} ${SDL2_LIBRARIES}) endif() add_custom_command( @@ -65,4 +71,4 @@ add_custom_command( "${PROJECT_SOURCE_DIR}/cpu/ppc/test/ppcdisasmtest.csv" $) -install (TARGETS dingusppc DESTINATION ${EXECUTABLE_OUTPUT_PATH}) \ No newline at end of file +install (TARGETS dingusppc DESTINATION ${EXECUTABLE_OUTPUT_PATH}) diff --git a/devices/awacs.cpp b/devices/awacs.cpp index 1034284..8c8bda4 100644 --- a/devices/awacs.cpp +++ b/devices/awacs.cpp @@ -29,10 +29,12 @@ along with this program. If not, see . #include "awacs.h" #include "dbdma.h" #include "machines/machinebase.h" -#include +#include "soundserver.h" +#include static int awac_freqs[8] = {44100, 29400, 22050, 17640, 14700, 11025, 8820, 7350}; + AWACDevice::AWACDevice() { this->audio_proc = new AudioProcessor(); @@ -40,6 +42,11 @@ AWACDevice::AWACDevice() /* register audio processor chip with the I2C bus */ I2CBus *i2c_bus = dynamic_cast(gMachineObj->get_comp_by_type(HWCompType::I2C_HOST)); i2c_bus->register_device(0x45, this->audio_proc); + + SoundServer *snd_server = dynamic_cast + (gMachineObj->get_comp_by_name("SoundServer")); + this->out_device = snd_server->get_out_device(); + this->out_stream_ready = false; } AWACDevice::~AWACDevice() @@ -48,9 +55,6 @@ AWACDevice::~AWACDevice() if (this->snd_buf) delete[] this->snd_buf; - - if (this->snd_out_dev) - SDL_CloseAudioDevice(snd_out_dev); } void AWACDevice::set_dma_out(DMAChannel *dma_out_ch) @@ -99,120 +103,135 @@ void AWACDevice::snd_ctrl_write(uint32_t offset, uint32_t value, int size) } } -static void convert_data(const uint8_t *in, uint8_t *out, uint32_t len) +static void convert_data(const uint8_t *in, SoundIoChannelArea *out_buf, uint32_t frame_count) { - uint16_t *p_in, *p_out; + uint16_t *p_in = (uint16_t *)in; - if (len & 7) { - LOG_F(WARNING, "AWAC sound buffer len not a multiply of 8, %d", len); - } + for (int i = 0; i < frame_count; i += 2, p_in += 4) { + *(uint16_t *)(out_buf[0].ptr) = BYTESWAP_16(p_in[0]); + out_buf[0].ptr += out_buf[0].step; + *(uint16_t *)(out_buf[0].ptr) = BYTESWAP_16(p_in[1]); + out_buf[0].ptr += out_buf[0].step; - p_in = (uint16_t *)in; - p_out = (uint16_t *)out; - len >>= 1; - - /* AWAC data comes as LLRR -> convert it to LRLR */ - for (int i = 0; i < len; i += 8) { - p_out[i] = p_in[i]; - p_out[i+1] = p_in[i+2]; - p_out[i+2] = p_in[i+1]; - p_out[i+3] = p_in[i+3]; + *(uint16_t *)(out_buf[1].ptr) = BYTESWAP_16(p_in[2]); + out_buf[1].ptr += out_buf[1].step; + *(uint16_t *)(out_buf[1].ptr) = BYTESWAP_16(p_in[3]); + out_buf[1].ptr += out_buf[1].step; } } -static void audio_out_callback(void *user_data, uint8_t *buf, int buf_len) +static void insert_silence(SoundIoChannelArea *out_buf, uint32_t frame_count) { + for (int i = 0; i < frame_count; i += 2) { + *(uint16_t *)(out_buf[0].ptr) = 0; + out_buf[0].ptr += out_buf[0].step; + *(uint16_t *)(out_buf[0].ptr) = 0; + out_buf[0].ptr += out_buf[0].step; + + *(uint16_t *)(out_buf[1].ptr) = 0; + out_buf[1].ptr += out_buf[1].step; + *(uint16_t *)(out_buf[1].ptr) = 0; + out_buf[1].ptr += out_buf[1].step; + } +} + +static void sound_out_callback(struct SoundIoOutStream *outstream, + int frame_count_min, int frame_count_max) +{ + int err, frame_count; uint8_t *p_in; - uint32_t rem_len, got_len; + uint32_t buf_len, rem_len, got_len; + struct SoundIoChannelArea *areas; + DMAChannel *dma_ch = (DMAChannel *)outstream->userdata; /* C API baby! */ + int n_channels = outstream->layout.channel_count; + bool stop = false; - DMAChannel *dma_ch = (DMAChannel *)user_data; /* C API baby! */ + buf_len = (frame_count_max * n_channels) << 1; + frame_count = frame_count_max; - for (rem_len = buf_len; rem_len > 0; rem_len -= got_len, buf += got_len) { + //LOG_F(INFO, "frame_count_min=%d", frame_count_min); + //LOG_F(INFO, "frame_count_max=%d", frame_count_max); + //LOG_F(INFO, "channel count: %d", n_channels); + //LOG_F(INFO, "buf_len: %d", buf_len); + + if ((err = soundio_outstream_begin_write(outstream, &areas, &frame_count))) { + LOG_F(ERROR, "unrecoverable stream error: %s\n", soundio_strerror(err)); + return; + } + + for (rem_len = buf_len; rem_len > 0; rem_len -= got_len) { if (!dma_ch->get_data(rem_len, &got_len, &p_in)) { - convert_data(p_in, buf, got_len); + //LOG_F(INFO, "SndCallback: got_len = %d", got_len); + convert_data(p_in, areas, got_len >> 2); //LOG_F(9, "Converted sound data, len = %d", got_len); } else { /* no more data */ - memset(buf, 0, rem_len); /* fill the buffer with silence */ + //memset(buf, 0, rem_len); /* fill the buffer with silence */ //LOG_F(9, "Inserted silence, len = %d", rem_len); + + /* fill the buffer with silence */ + //LOG_F(ERROR, "rem_len=%d", rem_len); + insert_silence(areas, rem_len >> 2); + stop = true; break; } } + + if ((err = soundio_outstream_end_write(outstream))) { + LOG_F(ERROR, "unrecoverable stream error: %s\n", soundio_strerror(err)); + return; + } + + if (stop) { + LOG_F(INFO, "pausing result: %s", + soundio_strerror(soundio_outstream_pause(outstream, true))); + } } -uint32_t AWACDevice::convert_data(const uint8_t *data, int len) +void AWACDevice::open_stream(int sample_rate) { - int i; - uint16_t *p_in, *p_out; + int err; - if (len > this->buf_len) { - if (this->snd_buf) - delete this->snd_buf; - this->snd_buf = new uint8_t[len]; - this->buf_len = len; + this->out_stream = soundio_outstream_create(this->out_device); + this->out_stream->write_callback = sound_out_callback; + this->out_stream->format = SoundIoFormatS16LE; + this->out_stream->sample_rate = sample_rate; + this->out_stream->userdata = (void *)this->dma_out_ch; + + if ((err = soundio_outstream_open(this->out_stream))) { + LOG_F(ERROR, "AWAC: unable to open sound output stream: %s", + soundio_strerror(err)); + } else { + this->out_sample_rate = sample_rate; + this->out_stream_ready = true; } - - p_in = (uint16_t *)data; - p_out = (uint16_t *)this->snd_buf; - - for (i = 0; i < len; i += 8) { - p_out[i] = p_in[i]; - p_out[i+1] = p_in[i+2]; - p_out[i+2] = p_in[i+1]; - p_out[i+3] = p_in[i+3]; - } - - return i; } void AWACDevice::dma_start() { - SDL_AudioSpec snd_spec, snd_settings; + int err; - SDL_zero(snd_spec); - snd_spec.freq = awac_freqs[(this->snd_ctrl_reg >> 8) & 7]; - snd_spec.format = AUDIO_S16MSB; /* yes, AWAC accepts big-endian data */ - snd_spec.channels = 2; - snd_spec.samples = 4096; /* buffer size, chosen empirically */ - snd_spec.callback = audio_out_callback; - snd_spec.userdata = (void *)this->dma_out_ch; - - - this->snd_out_dev = SDL_OpenAudioDevice(NULL, 0, &snd_spec, &snd_settings, 0); - if (!this->snd_out_dev) { - LOG_F(ERROR, "Could not open sound output device, error %s", SDL_GetError()); + if (!this->out_stream_ready) { + this->open_stream(awac_freqs[(this->snd_ctrl_reg >> 8) & 7]); + } else if (this->out_sample_rate != awac_freqs[(this->snd_ctrl_reg >> 8) & 7]) { + soundio_outstream_destroy(this->out_stream); + this->open_stream(awac_freqs[(this->snd_ctrl_reg >> 8) & 7]); } else { - LOG_F(INFO, "Created audio output channel, sample rate = %d", snd_spec.freq); - this->wake_up = true; + //soundio_outstream_clear_buffer(this->out_stream); + LOG_F(INFO, "AWAC: unpausing result: %s", + soundio_strerror(soundio_outstream_pause(this->out_stream, false))); + return; } - SDL_PauseAudioDevice(this->snd_out_dev, 0); /* start audio playing */ + if (!this->out_stream_ready) { + return; + } + + if ((err = soundio_outstream_start(this->out_stream))) { + LOG_F(ERROR, "AWAC: unable to start stream: %s\n", soundio_strerror(err)); + return; + } } void AWACDevice::dma_end() -{ - if (this->snd_out_dev) { - SDL_CloseAudioDevice(this->snd_out_dev); - this->snd_out_dev = 0; - } -} - -void AWACDevice::dma_push(uint8_t *buf, int size) -{ - uint32_t dst_len; - - dst_len = this->convert_data(buf, size); - if (dst_len) { - if (SDL_QueueAudio(this->snd_out_dev, this->snd_buf, dst_len)) { - LOG_F(ERROR, "SDL_QueueAudio error: %s", SDL_GetError()); - } - } - - if (this->wake_up) { - SDL_PauseAudioDevice(this->snd_out_dev, 0); /* start audio playing */ - this->wake_up = false; - } -} - -void AWACDevice::dma_pull(uint8_t *buf, int size) { } diff --git a/devices/awacs.h b/devices/awacs.h index 9c0e5bd..9e90321 100644 --- a/devices/awacs.h +++ b/devices/awacs.h @@ -28,10 +28,18 @@ along with this program. If not, see . #ifndef AWAC_H #define AWAC_H +//#define SDL + #include #include "i2c.h" #include "dbdma.h" +#ifdef SDL #include +//#else +//#include "thirdparty/portaudio/include/portaudio.h" +#endif +//#include "libsoundio/soundio/soundio.h" +#include /** AWAC registers offsets. */ enum { @@ -113,11 +121,9 @@ public: /* DMACallback methods */ void dma_start(); void dma_end(); - void dma_push(uint8_t *buf, int size); - void dma_pull(uint8_t *buf, int size); protected: - uint32_t convert_data(const uint8_t *data, int len); + void open_stream(int sample_rate); private: uint32_t snd_ctrl_reg = {0}; @@ -125,8 +131,10 @@ private: uint8_t is_busy = 0; AudioProcessor *audio_proc; - SDL_AudioDeviceID snd_out_dev = 0; - bool wake_up = false; + SoundIoDevice *out_device; + SoundIoOutStream *out_stream; + bool out_stream_ready; + int out_sample_rate; DMAChannel *dma_out_ch; diff --git a/devices/dbdma.cpp b/devices/dbdma.cpp index 5fe7162..79026aa 100644 --- a/devices/dbdma.cpp +++ b/devices/dbdma.cpp @@ -232,9 +232,6 @@ void DMAChannel::start() this->queue_len = 0; this->dma_cb->dma_start(); - - //while (this->interpret_cmd() != 7) { - //} } void DMAChannel::resume() diff --git a/devices/dbdma.h b/devices/dbdma.h index 249e4c4..79023d6 100644 --- a/devices/dbdma.h +++ b/devices/dbdma.h @@ -63,8 +63,8 @@ class DMACallback { public: virtual void dma_start(void) = 0; virtual void dma_end(void) = 0; - virtual void dma_push(uint8_t *buf, int size) = 0; - virtual void dma_pull(uint8_t *buf, int size) = 0; + //virtual void dma_push(uint8_t *buf, int size) = 0; + //virtual void dma_pull(uint8_t *buf, int size) = 0; }; class DMAChannel { diff --git a/devices/hwcomponent.h b/devices/hwcomponent.h index 5ee0312..f44d0ba 100644 --- a/devices/hwcomponent.h +++ b/devices/hwcomponent.h @@ -26,17 +26,18 @@ along with this program. If not, see . /** types of different HW components */ enum HWCompType : int { - UNKNOWN = 0, /* unknown component type */ - MEM_CTRL = 10, /* memory controller */ - ROM = 20, /* read-only memory */ - RAM = 30, /* random access memory */ - MMIO_DEV = 40, /* memory mapped I/O device */ - PCI_HOST = 50, /* PCI host */ - PCI_DEV = 51, /* PCI device */ - I2C_HOST = 60, /* I2C host */ - I2C_DEV = 61, /* I2C device */ - ADB_HOST = 70, /* ADB host */ - ADB_DEV = 71, /* ADB device */ + UNKNOWN = 0, /* unknown component type */ + MEM_CTRL = 10, /* memory controller */ + ROM = 20, /* read-only memory */ + RAM = 30, /* random access memory */ + MMIO_DEV = 40, /* memory mapped I/O device */ + PCI_HOST = 50, /* PCI host */ + PCI_DEV = 51, /* PCI device */ + I2C_HOST = 60, /* I2C host */ + I2C_DEV = 61, /* I2C device */ + ADB_HOST = 70, /* ADB host */ + ADB_DEV = 71, /* ADB device */ + SND_SERVER = 100, /* host sound server */ }; diff --git a/devices/soundserver.cpp b/devices/soundserver.cpp new file mode 100644 index 0000000..bd17568 --- /dev/null +++ b/devices/soundserver.cpp @@ -0,0 +1,81 @@ +/* +DingusPPC - The Experimental PowerPC Macintosh emulator +Copyright (C) 2018-20 divingkatae and maximum + (theweirdo) spatium + +(Contact divingkatae#1017 or powermax#2286 on Discord for more info) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +#include "soundserver.h" +#include +#include + +int SoundServer::start() +{ + int err; + + this->status = SND_SERVER_DOWN; + + this->soundio = soundio_create(); + if (!this->soundio) { + LOG_F(ERROR, "Sound Server: out of memory"); + return -1; + } + + if ((err = soundio_connect(this->soundio))) { + LOG_F(ERROR, "Unable to connect to backend: %s", soundio_strerror(err)); + return -1; + } + + LOG_F(INFO, "Connected to backend: %s", soundio_backend_name(soundio->current_backend)); + + soundio_flush_events(this->soundio); + + this->status = SND_API_READY; + + this->out_dev_index = soundio_default_output_device_index(this->soundio); + if (this->out_dev_index < 0) { + LOG_F(ERROR, "Sound Server: no output device found"); + return -1; + } + + this->out_device = soundio_get_output_device(this->soundio, this->out_dev_index); + if (!this->out_device) { + LOG_F(ERROR, "Sound Server: out of memory"); + return -1; + } + + LOG_F(INFO, "Sound Server output device: %s", this->out_device->name); + + this->status = SND_SERVER_UP; + + return 0; +} + +void SoundServer::shutdown() +{ + switch (this->status) { + case SND_SERVER_UP: + soundio_device_unref(this->out_device); + /* fall through */ + case SND_API_READY: + soundio_destroy(this->soundio); + } + + this->status = SND_SERVER_DOWN; + + LOG_F(INFO, "Sound Server shut down."); +} diff --git a/devices/soundserver.h b/devices/soundserver.h new file mode 100644 index 0000000..ede64d3 --- /dev/null +++ b/devices/soundserver.h @@ -0,0 +1,73 @@ +/* +DingusPPC - The Experimental PowerPC Macintosh emulator +Copyright (C) 2018-20 divingkatae and maximum + (theweirdo) spatium + +(Contact divingkatae#1017 or powermax#2286 on Discord for more info) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +/** @file Sound server definitions. + + This class manages host audio HW. It's directly connected + to a sound abstraction API (libsoundio in our case). + + Sound server provides a way to select between various + host input and output devices independendly of emulated + sound HW. + + Emulated sound HW only need to process sound streams. + */ + +#ifndef SOUND_SERVER_H +#define SOUND_SERVER_H + +#include "hwcomponent.h" +#include + +enum { + SND_SERVER_DOWN = 0, + SND_API_READY, + SND_SERVER_UP, +}; + + +class SoundServer : public HWComponent { +public: + SoundServer() { this->start(); }; + ~SoundServer() { this->shutdown(); }; + + int start(); + void shutdown(); + + bool supports_type(HWCompType type) { return type == HWCompType::SND_SERVER; }; + + SoundIoDevice *get_out_device() { + if (this->status == SND_SERVER_UP) { + return this->out_device; + } else { + return NULL; + } + }; + +private: + int status; /* server status */ + SoundIo *soundio; + int out_dev_index; /* current output device index */ + SoundIoDevice *out_device; /* current output device instance */ + //SoundIoOutStream *outstream; +}; + +#endif /* SOUND_SERVER_H */ diff --git a/machines/machinegossamer.cpp b/machines/machinegossamer.cpp index 6065e18..998e143 100644 --- a/machines/machinegossamer.cpp +++ b/machines/machinegossamer.cpp @@ -29,6 +29,7 @@ along with this program. If not, see . #include "cpu/ppc/ppcemu.h" #include "devices/mpc106.h" #include "devices/machineid.h" +#include "devices/soundserver.h" #include "devices/macio.h" #include "devices/viacuda.h" #include "devices/spdram.h" @@ -73,6 +74,8 @@ int create_gossamer() grackle_obj->add_mmio_region(0xFF000004, 4096, dynamic_cast(gMachineObj->get_comp_by_name("MachineID"))); + gMachineObj->add_component("SoundServer", new SoundServer()); + /* add the Heathrow I/O controller */ gMachineObj->add_component("Heathrow", new HeathrowIC); grackle_obj->pci_register_device(16, diff --git a/main.cpp b/main.cpp index 8ca8cad..b8b898b 100644 --- a/main.cpp +++ b/main.cpp @@ -22,6 +22,8 @@ along with this program. If not, see . //The main runfile - main.cpp //This is where the magic begins +//#define SDL + #include #include #include @@ -32,7 +34,9 @@ along with this program. If not, see . #include "ppcemu.h" #include "debugger/debugger.h" #include "machines/machinefactory.h" +#ifdef SDL #include +#endif using namespace std; @@ -117,10 +121,12 @@ int main(int argc, char **argv) goto bail; } +#ifdef SDL if (SDL_Init(SDL_INIT_AUDIO)){ LOG_F(ERROR, "SDL_Init error: %s", SDL_GetError()); goto bail; } +#endif if ((checker == "1") || (checker == "realtime") || \ (checker == "-realtime") || (checker == "/realtime")) { diff --git a/thirdparty/libsoundio/.gitignore b/thirdparty/libsoundio/.gitignore new file mode 100644 index 0000000..a2bcaac --- /dev/null +++ b/thirdparty/libsoundio/.gitignore @@ -0,0 +1,3 @@ +build/ +build-win32/ +build-win64/ diff --git a/thirdparty/libsoundio/CHANGELOG.md b/thirdparty/libsoundio/CHANGELOG.md new file mode 100644 index 0000000..cc56320 --- /dev/null +++ b/thirdparty/libsoundio/CHANGELOG.md @@ -0,0 +1,78 @@ +### Version 1.1.0 (2016-01-31) + + * JACK: delete broken pause implementation. Previously, calling + `soundio_outstream_pause` or `soundio_instream_pause` during the + `write_callback` or `read_callback` would cause a deadlock. Now, attempting + to pause always results in `SoundIoErrorBackendIncompatible`. + * PulseAudio: improve latency handling code. It now passes the latency test + along with all the other backends. + * PulseAudio: fix incorrect outstream `software_latency`. + * libsoundio source code is now pure C, no C++ mixed in. + * ALSA: better device detection. + - No longer suppress sysdefault. + - If default and sysdefault are missing, use the first device as the default + device. + * Workaround for Raspberry Pi driver that incorrectly reports itself as Output + when it is actually Input. + * ALSA: let alsa lib choose period settings. Fixes behavior with many ALSA + devices. + * ALSA: fix potential cleanup deadlock. + * ALSA: fix crash for devices with null description, thanks to Charles Lehner. + * CoreAudio: drop support for MacOS 10.9. There was a bug for this system that + was never resolved, so it didn't work in the first place. + * Record example handles device not found and probe errors gracefully. + * Fix typo in microphone example, thanks to James Dyson. + * Improve documentation. + * New functions available: `soundio_version_string`, `soundio_version_major`, + `soundio_version_minor`, `soundio_version_patch`. + * libsoundio source code now builds with MSVC, thanks to Raphaël Londeix. + +### Version 1.0.3 (2015-10-20) + + * Architecture independent header files. + * Add --latency and --sample-rate to sine example. + * ALSA: fix deadlock under some circumstances. + * dummy: fix deadlock when pause called from `write_callback`. + * Fix double clean-up corruption when opening stream fails. + * Add --device and --raw to underflow test. + * ALSA: use period size to calculate buffer size, fixes opening output stream + sometimes resulting in an error. + +### Version 1.0.2 (2015-09-24) + + * build: fix GNUInstallDirs not working. + * docs: fix incorrect docs for `soundio_instream_pause`. + * PulseAudio: fix `soundio_outstream_pause` triggering assertion when called + from within `write_callback`. + * fix mirrored memory not working on Linux (fixes corrupted data in ring + buffer). + * os: fix crash when creating non high priority thread fails. + * docs: fix typos and cleanup. + * fix and add test for `soundio_device_nearest_sample_rate`. + +### Version 1.0.1 (2015-09-11) + + * libsoundio no longer depends on or links against libm. + * ALSA: treat ALSA as unavailable when /dev/snd does not exist. + * ALSA: remove duplicate assert. + * ALSA: remove stray print statement. + * ALSA: pausing returns error code when state is invalid instead of reaching + assertion failure in pcm.c. + * JACK: fix infinite loop when refreshing devices. + * PulseAudio: better clear buffer implementation. + * dummy backend: fix sometimes calling `write_callback` with + `frame_count_max` equal to 0. + * os: fix some variables accidentally not declared static. + * macos: fix not cleaning up condition variables. + * macos: avoid allocation when getting time. + * docs: note that `read_callback` and `write_callback` must be real time safe. + * docs: record example demonstrates proper real time safety by not calling + fwrite in `read_callback`. + * docs: add note to record example about shutting down. + * docs: make microphone example latency a command line argument. + * build: fix build on linux with clang. + * build: static libs, examples, and tests are optional. + +### Version 1.0.0 (2015-09-03) + + * Initial public release. diff --git a/thirdparty/libsoundio/CMakeLists.txt b/thirdparty/libsoundio/CMakeLists.txt new file mode 100644 index 0000000..6541f1b --- /dev/null +++ b/thirdparty/libsoundio/CMakeLists.txt @@ -0,0 +1,388 @@ +cmake_minimum_required(VERSION 2.8.5) +project(libsoundio C) +set(CMAKE_MODULE_PATH ${libsoundio_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH}) + +if(CMAKE_VERSION VERSION_LESS 3.0.0) + set(CMAKE_INSTALL_LIBDIR "lib" CACHE PATH "library install dir (lib)") + set(CMAKE_INSTALL_INCLUDEDIR "include" CACHE PATH "header base install dir (include)") + set(CMAKE_INSTALL_BINDIR "bin" CACHE PATH "user executables (bin)") +else() + cmake_policy(SET CMP0042 NEW) + cmake_policy(SET CMP0046 NEW) + include(GNUInstallDirs) +endif() + +if(NOT CMAKE_BUILD_TYPE) + set(CMAKE_BUILD_TYPE "Debug" CACHE STRING + "Choose the type of build, options are: Debug Release RelWithDebInfo MinSizeRel." FORCE) +endif() + +set(LIBSOUNDIO_VERSION_MAJOR 2) +set(LIBSOUNDIO_VERSION_MINOR 0) +set(LIBSOUNDIO_VERSION_PATCH 0) +set(LIBSOUNDIO_VERSION "${LIBSOUNDIO_VERSION_MAJOR}.${LIBSOUNDIO_VERSION_MINOR}.${LIBSOUNDIO_VERSION_PATCH}") +message("Configuring libsoundio version ${LIBSOUNDIO_VERSION}") + +if(NOT SOUNDIO_STATIC_LIBNAME) + set(SOUNDIO_STATIC_LIBNAME soundio) +endif() + +option(BUILD_STATIC_LIBS "Build static libraries" ON) +option(BUILD_DYNAMIC_LIBS "Build dynamic libraries" ON) +option(BUILD_EXAMPLE_PROGRAMS "Build example programs" ON) +option(BUILD_TESTS "Build tests" ON) +option(ENABLE_JACK "Enable JACK backend" ON) +option(ENABLE_PULSEAUDIO "Enable PulseAudio backend" ON) +option(ENABLE_ALSA "Enable ALSA backend" ON) +option(ENABLE_COREAUDIO "Enable CoreAudio backend" ON) +option(ENABLE_WASAPI "Enable WASAPI backend" ON) + +find_package(Threads) +if(Threads_FOUND) + set(STATUS_THREADS "OK") +else(Threads_FOUND) + set(STATUS_THREADS "not found") +endif(Threads_FOUND) + +if(ENABLE_JACK) + find_package(JACK) + if(JACK_FOUND) + set(STATUS_JACK "OK") + set(SOUNDIO_HAVE_JACK true) + include_directories(${JACK_INCLUDE_DIR}) + else() + set(STATUS_JACK "not found") + set(SOUNDIO_HAVE_JACK false) + set(JACK_LIBRARY "") + endif() +else() + set(STATUS_JACK "disabled") + set(SOUNDIO_HAVE_JACK false) + set(JACK_LIBRARY "") +endif() + +if(ENABLE_PULSEAUDIO) + find_package(PulseAudio) + if(PULSEAUDIO_FOUND) + set(STATUS_PULSEAUDIO "OK") + set(SOUNDIO_HAVE_PULSEAUDIO true) + include_directories(${PULSEAUDIO_INCLUDE_DIR}) + else() + set(STATUS_PULSEAUDIO "not found") + set(SOUNDIO_HAVE_PULSEAUDIO false) + set(PULSEAUDIO_LIBRARY "") + endif() +else() + set(STATUS_PULSEAUDIO "disabled") + set(SOUNDIO_HAVE_PULSEAUDIO false) + set(PULSEAUDIO_LIBRARY "") +endif() + +if(ENABLE_ALSA) + find_package(ALSA) + if(ALSA_FOUND) + set(STATUS_ALSA "OK") + set(SOUNDIO_HAVE_ALSA true) + include_directories(${ALSA_INCLUDE_DIRS}) + else() + set(STATUS_ALSA "not found") + set(SOUNDIO_HAVE_ALSA false) + set(ALSA_LIBRARIES "") + endif() +else() + set(STATUS_ALSA "disabled") + set(SOUNDIO_HAVE_ALSA false) + set(ALSA_LIBRARIES "") +endif() + +if(ENABLE_COREAUDIO) + find_package(CoreAudio) + if(COREAUDIO_FOUND) + set(STATUS_COREAUDIO "OK") + set(SOUNDIO_HAVE_COREAUDIO true) + include_directories(${COREAUDIO_INCLUDE_DIR}) + + find_path(COREFOUNDATION_INCLUDE_DIR NAMES CoreFoundation.h) + find_library(COREFOUNDATION_LIBRARY NAMES CoreFoundation) + include_directories(${COREFOUNDATION_INCLUDE_DIR}) + + find_path(AUDIOUNIT_INCLUDE_DIR NAMES AudioUnit.h) + find_library(AUDIOUNIT_LIBRARY NAMES AudioUnit) + include_directories(${AUDIOUNIT_INCLUDE_DIR}) + else() + set(STATUS_COREAUDIO "not found") + set(SOUNDIO_HAVE_COREAUDIO false) + set(COREAUDIO_LIBRARY "") + set(COREFOUNDATION_LIBRARY "") + set(AUDIOUNIT_LIBRARY "") + endif() +else() + set(STATUS_COREAUDIO "disabled") + set(SOUNDIO_HAVE_COREAUDIO false) + set(COREAUDIO_LIBRARY "") + set(COREFOUNDATION_LIBRARY "") + set(AUDIOUNIT_LIBRARY "") +endif() + +if(ENABLE_WASAPI) + find_package(WASAPI) + if(WASAPI_FOUND) + set(STATUS_WASAPI "OK") + set(SOUNDIO_HAVE_WASAPI true) + else() + set(STATUS_WASAPI "not found") + set(SOUNDIO_HAVE_WASAPI false) + endif() +else() + set(STATUS_WASAPI "disabled") + set(SOUNDIO_HAVE_WASAPI false) +endif() + + +set(LIBSOUNDIO_SOURCES + "${libsoundio_SOURCE_DIR}/src/soundio.c" + "${libsoundio_SOURCE_DIR}/src/util.c" + "${libsoundio_SOURCE_DIR}/src/os.c" + "${libsoundio_SOURCE_DIR}/src/dummy.c" + "${libsoundio_SOURCE_DIR}/src/channel_layout.c" + "${libsoundio_SOURCE_DIR}/src/ring_buffer.c" +) + +set(CONFIGURE_OUT_FILE "${libsoundio_BINARY_DIR}/config.h") +set(LIBSOUNDIO_HEADERS + "${libsoundio_SOURCE_DIR}/soundio/soundio.h" + "${libsoundio_SOURCE_DIR}/soundio/endian.h" +) + +if(SOUNDIO_HAVE_JACK) + set(LIBSOUNDIO_SOURCES ${LIBSOUNDIO_SOURCES} + "${libsoundio_SOURCE_DIR}/src/jack.c" + ) +endif() +if(SOUNDIO_HAVE_PULSEAUDIO) + set(LIBSOUNDIO_SOURCES ${LIBSOUNDIO_SOURCES} + "${libsoundio_SOURCE_DIR}/src/pulseaudio.c" + ) +endif() +if(SOUNDIO_HAVE_ALSA) + set(LIBSOUNDIO_SOURCES ${LIBSOUNDIO_SOURCES} + "${libsoundio_SOURCE_DIR}/src/alsa.c" + ) +endif() +if(SOUNDIO_HAVE_COREAUDIO) + set(LIBSOUNDIO_SOURCES ${LIBSOUNDIO_SOURCES} + "${libsoundio_SOURCE_DIR}/src/coreaudio.c" + ) +endif() +if(SOUNDIO_HAVE_WASAPI) + set(LIBSOUNDIO_SOURCES ${LIBSOUNDIO_SOURCES} + "${libsoundio_SOURCE_DIR}/src/wasapi.c" + ) +endif() + +include_directories( + ${libsoundio_SOURCE_DIR} + ${libsoundio_BINARY_DIR} + "${libsoundio_SOURCE_DIR}/test" + "${libsoundio_SOURCE_DIR}/src" +) + +set(LIBSOUNDIO_LIBS + ${JACK_LIBRARY} + ${PULSEAUDIO_LIBRARY} + ${ALSA_LIBRARIES} + ${COREAUDIO_LIBRARY} + ${COREFOUNDATION_LIBRARY} + ${AUDIOUNIT_LIBRARY} + ${CMAKE_THREAD_LIBS_INIT} +) + +if(MSVC) + set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} /Wall") + set(LIB_CFLAGS "/TP /W4") + set(EXAMPLE_CFLAGS "/W4") + set(TEST_CFLAGS "${LIB_CFLAGS}") + set(TEST_LDFLAGS " ") + set(LIBM " ") +else() + set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -Werror -pedantic") + set(LIB_CFLAGS "-std=c11 -fvisibility=hidden -Wall -Werror=strict-prototypes -Werror=old-style-definition -Werror=missing-prototypes -D_REENTRANT -D_POSIX_C_SOURCE=200809L -Wno-missing-braces") + set(EXAMPLE_CFLAGS "-std=c99 -Wall") + set(TEST_CFLAGS "${LIB_CFLAGS} -fprofile-arcs -ftest-coverage") + set(TEST_LDFLAGS "-fprofile-arcs -ftest-coverage") + set(LIBM "m") +endif() + +configure_file( + "${libsoundio_SOURCE_DIR}/src/config.h.in" + ${CONFIGURE_OUT_FILE} +) +set(DOXYGEN_CONF_FILE "${libsoundio_BINARY_DIR}/doxygen.conf") +configure_file( + "${libsoundio_SOURCE_DIR}/doc/doxygen.conf.in" + ${DOXYGEN_CONF_FILE} +) + +if(BUILD_DYNAMIC_LIBS) + add_library(libsoundio_shared SHARED ${LIBSOUNDIO_SOURCES}) + set_target_properties(libsoundio_shared PROPERTIES + OUTPUT_NAME soundio + SOVERSION ${LIBSOUNDIO_VERSION_MAJOR} + VERSION ${LIBSOUNDIO_VERSION} + COMPILE_FLAGS ${LIB_CFLAGS} + LINKER_LANGUAGE C + ) + target_link_libraries(libsoundio_shared LINK_PUBLIC ${LIBSOUNDIO_LIBS}) + install(TARGETS libsoundio_shared DESTINATION ${CMAKE_INSTALL_LIBDIR}) +endif() + +if(BUILD_STATIC_LIBS) + add_library(libsoundio_static STATIC ${LIBSOUNDIO_SOURCES}) + set_target_properties(libsoundio_static PROPERTIES + OUTPUT_NAME ${SOUNDIO_STATIC_LIBNAME} + COMPILE_FLAGS ${LIB_CFLAGS} + LINKER_LANGUAGE C + ) + install(TARGETS libsoundio_static DESTINATION ${CMAKE_INSTALL_LIBDIR}) +endif() + +install(FILES + ${LIBSOUNDIO_HEADERS} + DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/soundio") + +# Example Programs + +if(BUILD_EXAMPLE_PROGRAMS) + add_executable(sio_sine example/sio_sine.c) + set_target_properties(sio_sine PROPERTIES + LINKER_LANGUAGE C + COMPILE_FLAGS ${EXAMPLE_CFLAGS}) + if(BUILD_DYNAMIC_LIBS) + target_link_libraries(sio_sine libsoundio_shared ${LIBM}) + else() + target_link_libraries(sio_sine libsoundio_static ${LIBSOUNDIO_LIBS} ${LIBM}) + endif() + install(TARGETS sio_sine DESTINATION ${CMAKE_INSTALL_BINDIR}) + + add_executable(sio_list_devices example/sio_list_devices.c) + set_target_properties(sio_list_devices PROPERTIES + LINKER_LANGUAGE C + COMPILE_FLAGS ${EXAMPLE_CFLAGS}) + if(BUILD_DYNAMIC_LIBS) + target_link_libraries(sio_list_devices libsoundio_shared) + else() + target_link_libraries(sio_list_devices libsoundio_static ${LIBSOUNDIO_LIBS}) + endif() + install(TARGETS sio_list_devices DESTINATION ${CMAKE_INSTALL_BINDIR}) + + add_executable(sio_microphone example/sio_microphone.c) + set_target_properties(sio_microphone PROPERTIES + LINKER_LANGUAGE C + COMPILE_FLAGS ${EXAMPLE_CFLAGS}) + if(BUILD_DYNAMIC_LIBS) + target_link_libraries(sio_microphone libsoundio_shared) + else() + target_link_libraries(sio_microphone libsoundio_static ${LIBSOUNDIO_LIBS}) + endif() + install(TARGETS sio_microphone DESTINATION ${CMAKE_INSTALL_BINDIR}) + + add_executable(sio_record example/sio_record.c) + set_target_properties(sio_record PROPERTIES + LINKER_LANGUAGE C + COMPILE_FLAGS ${EXAMPLE_CFLAGS}) + if(BUILD_DYNAMIC_LIBS) + target_link_libraries(sio_record libsoundio_shared) + else() + target_link_libraries(sio_record libsoundio_static ${LIBSOUNDIO_LIBS}) + endif() + install(TARGETS sio_record DESTINATION ${CMAKE_INSTALL_BINDIR}) +endif() + +if(BUILD_TESTS) + add_executable(unit_tests "${libsoundio_SOURCE_DIR}/test/unit_tests.c" ${LIBSOUNDIO_SOURCES}) + target_link_libraries(unit_tests LINK_PUBLIC ${LIBSOUNDIO_LIBS}) + set_target_properties(unit_tests PROPERTIES + LINKER_LANGUAGE C + COMPILE_FLAGS ${TEST_CFLAGS} + LINK_FLAGS ${TEST_LDFLAGS} + ) + + add_executable(latency "${libsoundio_SOURCE_DIR}/test/latency.c" ${LIBSOUNDIO_SOURCES}) + target_link_libraries(latency LINK_PUBLIC ${LIBSOUNDIO_LIBS} ${LIBM}) + set_target_properties(latency PROPERTIES + LINKER_LANGUAGE C + COMPILE_FLAGS ${LIB_CFLAGS} + ) + + add_executable(underflow test/underflow.c) + set_target_properties(underflow PROPERTIES + LINKER_LANGUAGE C + COMPILE_FLAGS ${EXAMPLE_CFLAGS}) + if(BUILD_DYNAMIC_LIBS) + target_link_libraries(underflow libsoundio_shared ${LIBM}) + else() + target_link_libraries(underflow libsoundio_static ${LIBSOUNDIO_LIBS} ${LIBM}) + endif() + + add_executable(backend_disconnect_recover test/backend_disconnect_recover.c) + set_target_properties(backend_disconnect_recover PROPERTIES + LINKER_LANGUAGE C + COMPILE_FLAGS ${EXAMPLE_CFLAGS}) + if(BUILD_DYNAMIC_LIBS) + target_link_libraries(backend_disconnect_recover libsoundio_shared) + else() + target_link_libraries(backend_disconnect_recover libsoundio_static ${LIBSOUNDIO_LIBS}) + endif() + + add_executable(overflow test/overflow.c) + set_target_properties(overflow PROPERTIES + LINKER_LANGUAGE C + COMPILE_FLAGS ${EXAMPLE_CFLAGS}) + if(BUILD_DYNAMIC_LIBS) + target_link_libraries(overflow libsoundio_shared) + else() + target_link_libraries(overflow libsoundio_static ${LIBSOUNDIO_LIBS}) + endif() + + + + add_custom_target(coverage + DEPENDS unit_tests + WORKING_DIRECTORY ${libsoundio_BINARY_DIR} + COMMAND lcov --directory . --zerocounters --rc lcov_branch_coverage=1 + COMMAND ./unit_tests + COMMAND lcov --directory . --capture --output-file coverage.info --rc lcov_branch_coverage=1 + COMMAND lcov --remove coverage.info '/usr/*' --output-file coverage.info.cleaned --rc lcov_branch_coverage=1 + COMMAND genhtml -o coverage coverage.info.cleaned --rc lcov_branch_coverage=1 + COMMAND rm coverage.info coverage.info.cleaned + ) +endif() + + +add_custom_target(doc + WORKING_DIRECTORY ${libsoundio_BINARY_DIR} + COMMAND doxygen ${DOXYGEN_CONF_FILE} +) + + + +message("\n" + "Installation Summary\n" + "--------------------\n" + "* Install Directory : ${CMAKE_INSTALL_PREFIX}\n" + "* Build Type : ${CMAKE_BUILD_TYPE}\n" + "* Build static libs : ${BUILD_STATIC_LIBS}\n" + "* Build examples : ${BUILD_EXAMPLE_PROGRAMS}\n" + "* Build tests : ${BUILD_TESTS}\n" +) + +message( + "System Dependencies\n" + "-------------------\n" + "* threads : ${STATUS_THREADS}\n" + "* JACK (optional) : ${STATUS_JACK}\n" + "* PulseAudio (optional) : ${STATUS_PULSEAUDIO}\n" + "* ALSA (optional) : ${STATUS_ALSA}\n" + "* CoreAudio (optional) : ${STATUS_COREAUDIO}\n" + "* WASAPI (optional) : ${STATUS_WASAPI}\n" +) diff --git a/thirdparty/libsoundio/LICENSE b/thirdparty/libsoundio/LICENSE new file mode 100644 index 0000000..4683780 --- /dev/null +++ b/thirdparty/libsoundio/LICENSE @@ -0,0 +1,21 @@ +The MIT License (Expat) + +Copyright (c) 2015 Andrew Kelley + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/thirdparty/libsoundio/README.md b/thirdparty/libsoundio/README.md new file mode 100644 index 0000000..e08f3cc --- /dev/null +++ b/thirdparty/libsoundio/README.md @@ -0,0 +1,266 @@ +# libsoundio + +C library providing cross-platform audio input and output. The API is +suitable for real-time software such as digital audio workstations as well +as consumer software such as music players. + +This library is an abstraction; however in the delicate balance between +performance and power, and API convenience, the scale is tipped closer to +the former. Features that only exist in some sound backends are exposed. + +## Features and Limitations + + * Supported operating systems: + - Windows 7+ + - MacOS 10.10+ + - Linux 3.7+ + * Supported backends: + - [JACK](http://jackaudio.org/) + - [PulseAudio](http://www.freedesktop.org/wiki/Software/PulseAudio/) + - [ALSA](http://www.alsa-project.org/) + - [CoreAudio](https://developer.apple.com/library/mac/documentation/MusicAudio/Conceptual/CoreAudioOverview/Introduction/Introduction.html) + - [WASAPI](https://msdn.microsoft.com/en-us/library/windows/desktop/dd371455%28v=vs.85%29.aspx) + - Dummy (silence) + * Exposes both raw devices and shared devices. Raw devices give you the best + performance but prevent other applications from using them. Shared devices + are default and usually provide sample rate conversion and format + conversion. + * Exposes both device id and friendly name. id you could save in a config file + because it persists between devices becoming plugged and unplugged, while + friendly name is suitable for exposing to users. + * Supports optimal usage of each supported backend. The same API does the + right thing whether the backend has a fixed buffer size, such as on JACK and + CoreAudio, or whether it allows directly managing the buffer, such as on + ALSA, PulseAudio, and WASAPI. + * C library. Depends only on the respective backend API libraries and libc. + Does *not* depend on libstdc++, and does *not* have exceptions, run-time type + information, or [setjmp](http://latentcontent.net/2007/12/05/libpng-worst-api-ever/). + * Errors are communicated via return codes, not logging to stdio. + * Supports channel layouts (also known as channel maps), important for + surround sound applications. + * Ability to monitor devices and get an event when available devices change. + * Ability to get an event when the backend is disconnected, for example when + the JACK server or PulseAudio server shuts down. + * Detects which input device is default and which output device is default. + * Ability to connect to multiple backends at once. For example you could have + an ALSA device open and a JACK device open at the same time. + * Meticulously checks all return codes and memory allocations and uses + meaningful error codes. + * Exposes extra API that is only available on some backends. For example you + can provide application name and stream names which is used by JACK and + PulseAudio. + +## Synopsis + +Complete program to emit a sine wave over the default device using the best +backend: + +```c +#include + +#include +#include +#include +#include + +static const float PI = 3.1415926535f; +static float seconds_offset = 0.0f; +static void write_callback(struct SoundIoOutStream *outstream, + int frame_count_min, int frame_count_max) +{ + const struct SoundIoChannelLayout *layout = &outstream->layout; + float float_sample_rate = outstream->sample_rate; + float seconds_per_frame = 1.0f / float_sample_rate; + struct SoundIoChannelArea *areas; + int frames_left = frame_count_max; + int err; + + while (frames_left > 0) { + int frame_count = frames_left; + + if ((err = soundio_outstream_begin_write(outstream, &areas, &frame_count))) { + fprintf(stderr, "%s\n", soundio_strerror(err)); + exit(1); + } + + if (!frame_count) + break; + + float pitch = 440.0f; + float radians_per_second = pitch * 2.0f * PI; + for (int frame = 0; frame < frame_count; frame += 1) { + float sample = sinf((seconds_offset + frame * seconds_per_frame) * radians_per_second); + for (int channel = 0; channel < layout->channel_count; channel += 1) { + float *ptr = (float*)(areas[channel].ptr + areas[channel].step * frame); + *ptr = sample; + } + } + seconds_offset = fmodf(seconds_offset + + seconds_per_frame * frame_count, 1.0f); + + if ((err = soundio_outstream_end_write(outstream))) { + fprintf(stderr, "%s\n", soundio_strerror(err)); + exit(1); + } + + frames_left -= frame_count; + } +} + +int main(int argc, char **argv) { + int err; + struct SoundIo *soundio = soundio_create(); + if (!soundio) { + fprintf(stderr, "out of memory\n"); + return 1; + } + + if ((err = soundio_connect(soundio))) { + fprintf(stderr, "error connecting: %s", soundio_strerror(err)); + return 1; + } + + soundio_flush_events(soundio); + + int default_out_device_index = soundio_default_output_device_index(soundio); + if (default_out_device_index < 0) { + fprintf(stderr, "no output device found"); + return 1; + } + + struct SoundIoDevice *device = soundio_get_output_device(soundio, default_out_device_index); + if (!device) { + fprintf(stderr, "out of memory"); + return 1; + } + + fprintf(stderr, "Output device: %s\n", device->name); + + struct SoundIoOutStream *outstream = soundio_outstream_create(device); + outstream->format = SoundIoFormatFloat32NE; + outstream->write_callback = write_callback; + + if ((err = soundio_outstream_open(outstream))) { + fprintf(stderr, "unable to open device: %s", soundio_strerror(err)); + return 1; + } + + if (outstream->layout_error) + fprintf(stderr, "unable to set channel layout: %s\n", soundio_strerror(outstream->layout_error)); + + if ((err = soundio_outstream_start(outstream))) { + fprintf(stderr, "unable to start device: %s", soundio_strerror(err)); + return 1; + } + + for (;;) + soundio_wait_events(soundio); + + soundio_outstream_destroy(outstream); + soundio_device_unref(device); + soundio_destroy(soundio); + return 0; +} +``` + +### Backend Priority + +When you use `soundio_connect`, libsoundio tries these backends in order. +If unable to connect to that backend, due to the backend not being installed, +or the server not running, or the platform is wrong, the next backend is tried. + + 0. JACK + 0. PulseAudio + 0. ALSA (Linux) + 0. CoreAudio (OSX) + 0. WASAPI (Windows) + 0. Dummy + +If you don't like this order, you can use `soundio_connect_backend` to +explicitly choose a backend to connect to. You can use `soundio_backend_count` +and `soundio_get_backend` to get the list of available backends. + +[API Documentation](http://libsound.io/doc) + +### Building + +Install the dependencies: + + * cmake + * ALSA library (optional) + * libjack2 (optional) + * libpulseaudio (optional) + +``` +mkdir build +cd build +cmake .. +make +sudo make install +``` + +### Building for Windows + +You can build libsoundio with [mxe](http://mxe.cc/). Follow the +[requirements](http://mxe.cc/#requirements) section to install the +packages necessary on your system. Then somewhere on your file system: + +``` +git clone https://github.com/mxe/mxe +cd mxe +make MXE_TARGETS='x86_64-w64-mingw32.static i686-w64-mingw32.static' gcc +``` + +Then in the libsoundio source directory (replace "/path/to/mxe" with the +appropriate path): + +``` +mkdir build-win32 +cd build-win32 +cmake .. -DCMAKE_TOOLCHAIN_FILE=/path/to/mxe/usr/i686-w64-mingw32.static/share/cmake/mxe-conf.cmake +make +``` + +``` +mkdir build-win64 +cd build-win64 +cmake .. -DCMAKE_TOOLCHAIN_FILE=/path/to/mxe/usr/x86_64-w64-mingw32.static/share/cmake/mxe-conf.cmake +make +``` + +### Testing + +For each backend, do the following: + + 0. Run the unit tests: `./unit_tests`. To see test coverage, install lcov, run + `make coverage`, and then view `coverage/index.html` in a browser. + 0. Run the example `./sio_list_devices` and make sure it does not crash, and + the output looks good. If valgrind is available, use it. + 0. Run `./sio_list_devices --watch` and make sure it detects when you plug and + unplug a USB microphone. + 0. Run `./sio_sine` and make sure you hear a sine wave. For backends with raw + devices, run `./sio_sine --device id --raw` (where 'id' is a device id you + got from `sio_list_devices` and make sure you hear a sine wave. + - Use 'p' to test pausing, 'u' to test unpausing, 'q' to test cleanup. + - 'c' for clear buffer. Clear buffer should not pause the stream and it + should also not cause an underflow. + - Use 'P' to test pausing from the callback, and then 'u' to unpause. + 0. Run `./underflow` and read the testing instructions that it prints. + 0. Run `./sio_microphone` and ensure that it is both recording and playing + back correctly. If possible use the `--in-device` and `--out-device` + parameters to test a USB microphone in raw mode. + 0. Run `./backend_disconnect_recover` and read the testing instructions that + it prints. + 0. Run `./latency` and make sure the printed beeps line up with the beeps that + you hear. + +### Building the Documentation + +Ensure that [doxygen](http://www.stack.nl/~dimitri/doxygen/) is installed, +then: + +``` +make doc +``` + +Then look at `html/index.html` in a browser. diff --git a/thirdparty/libsoundio/cmake/FindCoreAudio.cmake b/thirdparty/libsoundio/cmake/FindCoreAudio.cmake new file mode 100644 index 0000000..85b1d34 --- /dev/null +++ b/thirdparty/libsoundio/cmake/FindCoreAudio.cmake @@ -0,0 +1,16 @@ +# Copyright (c) 2015 Andrew Kelley +# This file is MIT licensed. +# See http://opensource.org/licenses/MIT + +# COREAUDIO_FOUND +# COREAUDIO_INCLUDE_DIR +# COREAUDIO_LIBRARY + +find_path(COREAUDIO_INCLUDE_DIR NAMES CoreAudio/CoreAudio.h) + +find_library(COREAUDIO_LIBRARY NAMES CoreAudio) + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(COREAUDIO DEFAULT_MSG COREAUDIO_LIBRARY COREAUDIO_INCLUDE_DIR) + +mark_as_advanced(COREAUDIO_INCLUDE_DIR COREAUDIO_LIBRARY) diff --git a/thirdparty/libsoundio/cmake/FindJACK.cmake b/thirdparty/libsoundio/cmake/FindJACK.cmake new file mode 100644 index 0000000..9043bd6 --- /dev/null +++ b/thirdparty/libsoundio/cmake/FindJACK.cmake @@ -0,0 +1,19 @@ +# Copyright (c) 2015 Andrew Kelley +# This file is MIT licensed. +# See http://opensource.org/licenses/MIT + +# JACK_FOUND +# JACK_INCLUDE_DIR +# JACK_LIBRARY + +find_path(JACK_INCLUDE_DIR NAMES jack/jack.h) + +find_library(JACK_LIBRARY NAMES jack) + +include(CheckLibraryExists) +check_library_exists(jack "jack_set_port_rename_callback" "${JACK_LIBRARY}" HAVE_jack_set_port_rename_callback) + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(JACK DEFAULT_MSG JACK_LIBRARY JACK_INCLUDE_DIR HAVE_jack_set_port_rename_callback) + +mark_as_advanced(JACK_INCLUDE_DIR JACK_LIBRARY) diff --git a/thirdparty/libsoundio/cmake/FindPulseAudio.cmake b/thirdparty/libsoundio/cmake/FindPulseAudio.cmake new file mode 100644 index 0000000..14bcadd --- /dev/null +++ b/thirdparty/libsoundio/cmake/FindPulseAudio.cmake @@ -0,0 +1,16 @@ +# Copyright (c) 2015 Andrew Kelley +# This file is MIT licensed. +# See http://opensource.org/licenses/MIT + +# PULSEAUDIO_FOUND +# PULSEAUDIO_INCLUDE_DIR +# PULSEAUDIO_LIBRARY + +find_path(PULSEAUDIO_INCLUDE_DIR NAMES pulse/pulseaudio.h) + +find_library(PULSEAUDIO_LIBRARY NAMES pulse) + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(PULSEAUDIO DEFAULT_MSG PULSEAUDIO_LIBRARY PULSEAUDIO_INCLUDE_DIR) + +mark_as_advanced(PULSEAUDIO_INCLUDE_DIR PULSEAUDIO_LIBRARY) diff --git a/thirdparty/libsoundio/cmake/FindWASAPI.cmake b/thirdparty/libsoundio/cmake/FindWASAPI.cmake new file mode 100644 index 0000000..2207589 --- /dev/null +++ b/thirdparty/libsoundio/cmake/FindWASAPI.cmake @@ -0,0 +1,14 @@ +# Copyright (c) 2015 Andrew Kelley +# This file is MIT licensed. +# See http://opensource.org/licenses/MIT + +# WASAPI_FOUND +# AUDIOCLIENT_H + +if(WIN32) + include(CheckIncludeFile) + check_include_file(audioclient.h AUDIOCLIENT_H) +endif() + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(WASAPI DEFAULT_MSG AUDIOCLIENT_H) diff --git a/thirdparty/libsoundio/doc/FindSoundIo.cmake b/thirdparty/libsoundio/doc/FindSoundIo.cmake new file mode 100644 index 0000000..0d905ec --- /dev/null +++ b/thirdparty/libsoundio/doc/FindSoundIo.cmake @@ -0,0 +1,16 @@ +# Copyright (c) 2015 Andrew Kelley +# This file is MIT licensed. +# See http://opensource.org/licenses/MIT + +# SOUNDIO_FOUND +# SOUNDIO_INCLUDE_DIR +# SOUNDIO_LIBRARY + +find_path(SOUNDIO_INCLUDE_DIR NAMES soundio/soundio.h) + +find_library(SOUNDIO_LIBRARY NAMES soundio) + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(SOUNDIO DEFAULT_MSG SOUNDIO_LIBRARY SOUNDIO_INCLUDE_DIR) + +mark_as_advanced(SOUNDIO_INCLUDE_DIR SOUNDIO_LIBRARY) diff --git a/thirdparty/libsoundio/doc/doxygen.conf.in b/thirdparty/libsoundio/doc/doxygen.conf.in new file mode 100644 index 0000000..f7a542c --- /dev/null +++ b/thirdparty/libsoundio/doc/doxygen.conf.in @@ -0,0 +1,2036 @@ +# Doxyfile 1.8.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = libsoundio + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = "@LIBSOUNDIO_VERSION@" + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = YES + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = NO + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = NO + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = NO + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = NO + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = @CMAKE_SOURCE_DIR@/soundio/soundio.h \ + @CONFIGURE_OUT_FILE@ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = "@CMAKE_SOURCE_DIR@/example" \ + "@CMAKE_SOURCE_DIR@/test" + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = "@CMAKE_SOURCE_DIR@/doc/footer.html" + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /