Integrating OpenAL-Soft Library with CMake on Windows & Ubuntu Интеграция C++-библиотеки OpenAL-Soft с CMake под Windows и Ubuntu

A step-by-step guide to configuring and integrating the OpenAL-Soft library in your CMake projects on Windows and Ubuntu. Пошаговое руководство по настройке и интеграции библиотеки OpenAL-Soft в проекты CMake под Windows и Ubuntu.

Before proceeding, make sure you have built and installed the static libraries on your system using the appropriate guides: Перед продолжением убедитесь, что вы собрали и установили статические библиотеки в вашей системе, следуя соответствующим инструкциям:

Step 1: Create Project Directory Шаг 1: Создание директории проекта

Create a workspace folder and a new directory for your OpenAL-Soft test project: Создайте рабочую папку для проектов и новую директорию для вашего тестового проекта OpenAL-Soft:

Windows (Command Prompt / PowerShell)

mkdir C:\projects\openal-test
cd C:\projects\openal-test

Ubuntu (Terminal)

mkdir -p ~/projects/openal-test
cd ~/projects/openal-test

Step 2: Create Source Files (main.cpp & CMakeLists.txt) Шаг 2: Создание исходных файлов (main.cpp и CMakeLists.txt)

You can create these files using Notepad / Sublime Text on Windows, or nano in Ubuntu terminal: Вы можете создать эти файлы через Блокнот / Sublime Text в Windows или с помощью nano в терминале Ubuntu:

Windows (Terminal / Notepad)

notepad main.cpp
notepad CMakeLists.txt

Ubuntu (Terminal / Nano)

nano main.cpp
nano CMakeLists.txt
Quick Nano Commands (Ubuntu):Быстрые команды Nano (Ubuntu): Paste code with Right Mouse Button (RMB) → Press Ctrl + O and Enter to save → Press Ctrl + X to exit. Вставьте код правой кнопкой мыши (ПКМ) → Нажмите Ctrl + O и Enter для сохранения → Нажмите Ctrl + X для выхода.

1. File Contents for main.cpp 1. Содержимое файла main.cpp

#include <AL/al.h>
#include <AL/alc.h>
#include <cstdlib>
#include <iostream>

int main()
{
#ifndef _WIN32
    // Force OpenAL-Soft to use PulseAudio or ALSA directly to prevent PipeWire connection warnings
    setenv("ALSOFT_DRIVERS", "pulse,alsa", 1);
#endif

    ALCdevice *device = alcOpenDevice(nullptr);
    if (!device)
    {
        std::cerr << "Failed to open default audio device!" << std::endl;
        return 1;
    }

    ALCcontext *context = alcCreateContext(device, nullptr);
    if (!context || !alcMakeContextCurrent(context))
    {
        std::cerr << "Failed to create or set OpenAL context!" << std::endl;
        if (context)
            alcDestroyContext(context);
        alcCloseDevice(device);
        return 1;
    }

    const ALCchar *deviceName = alcGetString(device, ALC_DEVICE_SPECIFIER);
    std::cout << "OpenAL Device: " << (deviceName ? deviceName : "Unknown") << std::endl;

    alcMakeContextCurrent(nullptr);
    alcDestroyContext(context);
    alcCloseDevice(device);

    return 0;
}

2. File Contents for CMakeLists.txt 2. Содержимое файла CMakeLists.txt

set(CMAKE_BUILD_TYPE "Debug")

cmake_minimum_required(VERSION 3.21)
project(openal_test CXX)

set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# -----------------------------------------------------------------------------
# Define Project Source Files
# -----------------------------------------------------------------------------
set(PROJECT_SOURCES
    main.cpp
)

# -----------------------------------------------------------------------------
# Declare Target Type based on OS
# -----------------------------------------------------------------------------
add_executable(app)

# Attach sources to the target dynamically
target_sources(app PRIVATE ${PROJECT_SOURCES})

# -----------------------------------------------------------------------------
# Platform Linking & Dependencies
# -----------------------------------------------------------------------------
if(WIN32)
    set(OPENAL_PATH "C:/libs/openal-soft-1.25.2-mingw")

    # OpenAL-Soft Static Library
    add_library(OpenAL STATIC IMPORTED)
    set_target_properties(OpenAL PROPERTIES
        IMPORTED_LOCATION "${OPENAL_PATH}/lib/libOpenAL32.a"
        INTERFACE_INCLUDE_DIRECTORIES "${OPENAL_PATH}/include"
        INTERFACE_COMPILE_DEFINITIONS "AL_LIBTYPE_STATIC"
    )

    target_link_libraries(app PRIVATE
        OpenAL
        winmm
        ole32
        avrt
    )

    target_compile_options(app PRIVATE -Os)
    target_link_options(app PRIVATE -static -s -static-libgcc)

    if(CMAKE_BUILD_TYPE STREQUAL "Debug")
        target_link_options(app PRIVATE -mconsole)
    else()
        target_link_options(app PRIVATE -mwindows)
    endif()

else()
    set(OPENAL_PATH "$ENV{HOME}/libs/openal-soft-1.25.2-ubuntu")

    # OpenAL-Soft Static Library
    add_library(OpenAL STATIC IMPORTED)
    set_target_properties(OpenAL PROPERTIES
        IMPORTED_LOCATION "${OPENAL_PATH}/lib/libopenal.a"
        INTERFACE_INCLUDE_DIRECTORIES "${OPENAL_PATH}/include"
        INTERFACE_COMPILE_DEFINITIONS "AL_LIBTYPE_STATIC"
        INTERFACE_LINK_LIBRARIES "pthread;dl"
    )

    target_link_libraries(app PRIVATE
        OpenAL
    )
endif()

Step 3: Create Build & Execution Scripts Шаг 3: Создание скриптов сборки и запуска

Windows (MinGW / Batch Scripts)

config-exe.bat

cmake -G Ninja -S . -B dist/win

build-exe.bat

cmake --build dist/win

run-exe.bat

@echo off
.\dist\win\app.exe

Run the scripts sequentially in Command Prompt or PowerShell: Последовательно запустите скрипты в командной строке или PowerShell:

config-exe.bat
build-exe.bat
run-exe.bat

Ubuntu (Bash Scripts)

config-bin.sh

#!/usr/bin/env bash
set -e
cmake -G Ninja -S . -B dist/linux

build-bin.sh

#!/usr/bin/env bash
set -e
cmake --build dist/linux

run-bin.sh

#!/usr/bin/env bash
set -e
./dist/linux/app

Grant execute permissions on Ubuntu before running: Предоставьте права на выполнение в Ubuntu перед запуском:

chmod +x config-bin.sh build-bin.sh run-bin.sh
./config-bin.sh
./build-bin.sh
./run-bin.sh

Step 4: Expected Output Шаг 4: Ожидаемый результат

After running the build and execution scripts, you should see output similar to this: После запуска скриптов сборки и выполнения вы должны увидеть результат, похожий на следующий:

OpenAL Device: OpenAL Soft

Support My Work Поддержать проект

If these tutorials helped you, consider buying me a coffee! Если эти туториалы вам помогли, вы можете поддержать автора.

Sberbank (Russia only) Сбербанк (только для РФ)

Sberbank SBP QR Code

Direct transfer via phone number (Russia only) Перевод по номеру телефона (только для РФ)

+7 (917) 212-29-59

USDT TRC20

USDT TRC20 QR Code

Support via Cryptocurrency Поддержка криптовалютой

TMtY1YifNf6FKvgeFmqKGQR4NStKr3csGp