- Setup
- Getting Started
- Documentation
- Examples
HephAudio is a cross-platform audio library that provides:
- Playing and recording audio in Windows, Linux, Android, iOS, and macOS.
- Audio device enumeration and selection.
- Encoding, decoding, and transcoding audio files via FFmpeg.
- FFT for frequency analysis of the audio signals.
- Spatialization via HRTF.
- Easy to use sound effects and filters.
- Install CMake 3.28.0 or higher.
- Install ALSA development library for Linux.
- build FFmpeg and libmysofa for macOS and iOS.
- Clone the repo.
- Run one of the following commands:
- to create shared library:
cmake -DENABLE_SHARED=On -DCMAKE_CXX_FLAGS='-DHEPHAUDIO_INFO_LOGGING' . - to create static library:
cmake -DENABLE_STATIC=On -DCMAKE_CXX_FLAGS='-DHEPHAUDIO_INFO_LOGGING' .
- to create shared library:
- Run
cmake --build .thencmake --install . - Create a folder at your project's root and name it
HephAudio(/project_root/HephAudio). - Copy the contents of the
buildfolder to/project_root/HephAudio. - Create a
CMakeLists.txtfile at your project's root folder and build it.
An example cmake file:
cmake_minimum_required(VERSION 3.28)
# your project name
project("my_application")
set(HEPHAUDIO_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/HephAudio)
if ((NOT DEFINED CMAKE_RUNTIME_OUTPUT_DIRECTORY) OR (CMAKE_RUNTIME_OUTPUT_DIRECTORY STREQUAL ""))
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/build)
endif()
add_definitions(-DHEPH_SHARED_LIB)
include_directories(
${HEPHAUDIO_DIRECTORY}/include/ffmpeg/
${HEPHAUDIO_DIRECTORY}/include/libmysofa/
${HEPHAUDIO_DIRECTORY}/include/HephCommon/
${HEPHAUDIO_DIRECTORY}/include/HephAudio/
)
add_executable(
${CMAKE_PROJECT_NAME}
main.cpp
)
if (CMAKE_SYSTEM_NAME STREQUAL "Windows")
target_link_libraries(
${CMAKE_PROJECT_NAME}
${HEPHAUDIO_DIRECTORY}/lib/ffmpeg/avcodec.lib
${HEPHAUDIO_DIRECTORY}/lib/ffmpeg/avdevice.lib
${HEPHAUDIO_DIRECTORY}/lib/ffmpeg/avfilter.lib
${HEPHAUDIO_DIRECTORY}/lib/ffmpeg/avformat.lib
${HEPHAUDIO_DIRECTORY}/lib/ffmpeg/avutil.lib
${HEPHAUDIO_DIRECTORY}/lib/ffmpeg/swresample.lib
${HEPHAUDIO_DIRECTORY}/lib/ffmpeg/swscale.lib
${HEPHAUDIO_DIRECTORY}/lib/libmysofa/zlib.lib
${HEPHAUDIO_DIRECTORY}/lib/libmysofa/mysofa.lib
${HEPHAUDIO_DIRECTORY}/lib/HephAudio.lib
)
# copy the DLL files so they will be in the same folder with the executable.
install(
DIRECTORY ${HEPHAUDIO_DIRECTORY}/
DESTINATION ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
FILES_MATCHING
PATTERN "*.dll"
PATTERN "include" EXCLUDE
PATTERN "lib" EXCLUDE
)
else ()
target_link_libraries(
${CMAKE_PROJECT_NAME}
${HEPHAUDIO_DIRECTORY}/lib/ffmpeg/libavcodec.so
${HEPHAUDIO_DIRECTORY}/lib/ffmpeg/libavdevice.so
${HEPHAUDIO_DIRECTORY}/lib/ffmpeg/libavfilter.so
${HEPHAUDIO_DIRECTORY}/lib/ffmpeg/libavformat.so
${HEPHAUDIO_DIRECTORY}/lib/ffmpeg/libavutil.so
${HEPHAUDIO_DIRECTORY}/lib/ffmpeg/libswresample.so
${HEPHAUDIO_DIRECTORY}/lib/ffmpeg/libswscale.so
${HEPHAUDIO_DIRECTORY}/lib/libmysofa/libmysofa.so
${HEPHAUDIO_DIRECTORY}/lib/libHephAudio.so
)
endif()
- Create a folder at your project's root and name it
HephAudio(/project_root/HephAudio). - Copy the repo to the folder you created.
- (WINDOWS ONLY) Copy the required dll files from the dependencies to the build output folder.
- Create a
CMakeLists.txtfile at your project's root folder and build it.
An example cmake file:
cmake_minimum_required(VERSION 3.28)
# your project name
project("my_application")
# execute the HephAudio/CMakeLists.txt file
include(${CMAKE_CURRENT_SOURCE_DIR}/HephAudio/CMakeLists.txt)
add_executable(
${CMAKE_PROJECT_NAME}
${HEPHAUDIO_SRC}
# your files
main.cpp
)
target_link_libraries(
${CMAKE_PROJECT_NAME}
${HEPHAUDIO_LINK_LIBS}
# your libs
)
# extra definitions
add_definitions(-DHEPHAUDIO_INFO_LOGGING)
- Create a folder at your project's root and name it
HephAudio(/project_root/HephAudio). - Copy the repo to the folder you created.
- Right click to your project, go to
Configuration Properties -> C/C++ -> General -> Additional Including Directoriesand add the locations of theHephCommon/HeaderFiles,HephAudio/HeaderFiles,dependencies/ffmpeg/include, anddependencies/libmysofa/include. - Now right click the solution and go to
Add -> Existing Project, under the HephCommon folder selectHephCommon.vcxitemsto add to your project. Repeat the same process for HephAudio. - Right click to your project,
Add -> Reference -> Shared Projectsand check both HephAudio and HephCommon. - Right click to your project, go to
Configuration Properties -> Linker -> General -> Additional Library Directoriesand addpath_to_hephaudio/dependencies. - Copy the required dll files from the dependencies to the build output folder.
- Visual studio marks some of the standard C functions as unsafe and prevents from compiling by throwing errors. To fix this, right click to your project and go to
Configuration Properties -> C/C++ -> Preprocessor -> Preprocessor Definitionsand add_CRT_SECURE_NO_WARNINGS. - If you are creating a DLL, add
HEPH_EXPORTSandHEPH_SHARED_LIBpreprocessor definitions.
Note
Don't define HEPH_EXPORTS when using the DLL.