Split library API

Author: LukashonakV

.github/workflows/build-and-test.yml

@@ -24,8 +24,8 @@ jobs:
       run: ./configure
     - name: Run make
       run: make CFLAGS='-Werror'
-    - name: Run make distcheck
-      run: make distcheck
+#    - name: Run make distcheck
+#      run: make distcheck
     - name: Prepare tests
       run: |
         pulseaudio -D
@@ -39,12 +39,41 @@ jobs:
     - name: run shmem test
       run: ./cava -p example_files/test_configs/shmem_zero_test > /dev/null
     - name: build cavacore test application
-      run: gcc -c -g cavacore_test.c
+      run: gcc -I include -c -g cavacore_test.c
     - name: link cavacore test application
       run: gcc -o cavacore_test cavacore_test.o cava-cavacore.o -lm -lfftw3
     - name: run cavacore test application
       run: ./cavacore_test
-
+  build-linux-meson:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install libfftw3-dev libasound2-dev libncursesw5-dev libpulse-dev libtool automake autoconf-archive libiniparser-dev portaudio19-dev libsndio-dev libsdl2-2.0-0 libsdl2-dev squeezelite pulseaudio libpipewire-0.3-dev meson
+    - name: configure project
+      run: meson setup -Dcpp_std=c++20 -Dbuild_target=all build
+    - name: Run make
+      run: ninja -C build
+    - name: Prepare tests
+      run: |
+        pulseaudio -D
+        squeezelite -o pulse -v -m 51:fb:32:f8:e6:9f -z
+    - name: run non zero test
+      run: ./build/cava -p example_files/test_configs/non_zero_test > /dev/null
+    - name: run pulseaudio test
+      run: ./build/cava -p example_files/test_configs/pulse_zero_test > /dev/null
+    - name: run fifo test
+      run: ./build/cava -p example_files/test_configs/fifo_zero_test > /dev/null
+    - name: run shmem test
+      run: ./build/cava -p example_files/test_configs/shmem_zero_test > /dev/null
+    - name: build cavacore test application
+      run: gcc -I include -c -g cavacore_test.c
+    - name: link cavacore test application
+      run: gcc -I include -o cavacore_test cavacore_test.c build/libcava.so.p/cavacore.c.o -lm -lfftw3
+    - name: run cavacore test application
+      run: ./cavacore_test
   build-macos:
     runs-on: macos-latest
     steps:

CMakeLists.txt

@@ -17,7 +17,7 @@ if (ANDROID)
 	if (NOT EXISTS "${FFTW_DIR}/obj/local/${CMAKE_ANDROID_ARCH_ABI}/")
 		message(FATAL_ERROR "given lib dir: ${FFTW_DIR}/obj/local/${CMAKE_ANDROID_ARCH_ABI}/ does not exist, did you build it? See cavandroid/README.md")
 	endif()
-	target_include_directories(cavacore PRIVATE "${FFTW_DIR}/jni/fftw3/api/")
+	target_include_directories(cavacore PRIVATE "${FFTW_DIR}/jni/fftw3/api/" include)
 	target_link_directories(cavacore PRIVATE "${FFTW_DIR}/obj/local/${CMAKE_ANDROID_ARCH_ABI}/")
 	target_link_libraries(cavacore fftw3)
 elseif(WIN32)
@@ -32,6 +32,7 @@ elseif(WIN32)
 		config.c
 		input/common.c
 		input/winscap.c
+        output/common.c
 		output/sdl_cava.c
 		output/sdl_glsl.c
 		output/terminal_noncurses.c
@@ -41,7 +42,7 @@ elseif(WIN32)
 	)
 
 	target_compile_definitions(cava PRIVATE SDL SDL_GSL NDEBUG)
-	target_include_directories(cava PRIVATE ${GLEW_INCLUDE_DIRS} ${SDL2_INCLUDE_DIRS})
+	target_include_directories(cava PRIVATE ${GLEW_INCLUDE_DIRS} ${SDL2_INCLUDE_DIRS} include)
 	target_link_libraries(cava PRIVATE pthread shlwapi fftw3 GLEW::GLEW SDL2::SDL2)
 else()
 	add_library(cavacore STATIC cavacore.c)

Makefile.am

@@ -2,19 +2,66 @@ AUTOMAKE_OPTIONS = foreign
 
 ACLOCAL_AMFLAGS = -I m4
 
+CLEANFILES = $(NULL)
+
+# Install the pkgconfig file for the library
+pkgconfigdir = $(libdir)/pkgconfig
+pkgconfig_DATA = libcava.pc
+
+# Generate the pkgconfig file
+libcava.pc: Makefile.am
+	@echo "Generating $@..."
+	@mkdir -p $(@D)
+	@echo "prefix=$(prefix)" > $@
+	@echo "exec_prefix=$(exec_prefix)" >> $@
+	@echo "libdir=$(libdir)" >> $@
+	@echo "includedir=$(includedir)" >> $@
+	@echo "Name: $(PKG_CONFIG_NAME)" >> $@
+	@echo "Description: $(PKG_CONFIG_DESC)" >> $@
+	@echo "Version: $(PKG_CONFIG_VERSION)" >> $@
+	@echo "Libs: -L\$(libdir) -lcava" >> $@ # Link against libcava library
+	@echo "Cflags: -I\$(includedir)/cava -I\$(includedir)/cava/input -I\$(includedir)/cava/output" >> $@
+
+# Clean up the generated pkgconfig file
+CLEANFILES += libcava.pc
+
+# Define the library to be built
+# 'lib' directory implies shared library by default with Automake.
+# Use 'noinst_LTLIBRARIES' if you don't want to install it but build it for internal use.
+lib_LTLIBRARIES = libcava.la
+
+AM_LIBTOOL_VERSION = $(AM_LIBTOOL_CURRENT):$(AM_LIBTOOL_REVISION):$(AM_LIBTOOL_RELEASE)
+AM_LIBTOOL_REL = $(AM_LIBTOOL_RELEASE):$(AM_LIBTOOL_REVISION):$(AM_LIBTOOL_CURRENT)
+
+libcava_la_LDFLAGS = -version-info $(AM_LIBTOOL_REL)
+
 bin_PROGRAMS = cava
+
 cavadir = $(top_srcdir)
-cava_SOURCES = cava.c cavacore.c config.c input/common.c input/fifo.c input/shmem.c \
-               output/terminal_noncurses.c output/raw.c output/noritake.c \
-               cavacore.h config.h input/common.h input/fifo.h input/shmem.h \
-               output/terminal_noncurses.h output/raw.h output/noritake.h \
-               util.h third_party/incbin.h
-cava_CPPFLAGS = -DPACKAGE=\"$(PACKAGE)\" -DVERSION=\"$(VERSION)\" \
-           -D_POSIX_SOURCE -D_POSIX_C_SOURCE=200809L -D_XOPEN_SOURCE_EXTENDED \
-	   -DFONTDIR=\"@FONT_DIR@\" -DFONTFILE=\"@FONT_FILE@\"
+cava_SOURCES = cava.c
+libcava_la_SOURCES = cavacore.c config.c input/common.c input/fifo.c input/shmem.c \
+               output/common.c output/terminal_noncurses.c output/raw.c output/noritake.c
+
+cava_CPPFLAGS = \
+	-DPACKAGE=\"$(PACKAGE)\" \
+	-DVERSION=\"$(VERSION)\" \
+	-DLIB_VERSION=\"$(VERSION)\" \
+	-D_POSIX_SOURCE \
+	-D_POSIX_C_SOURCE=200809L \
+	-D_XOPEN_SOURCE_EXTENDED \
+	-DFONTDIR=\"@FONT_DIR@\" \
+	-DFONTFILE=\"@FONT_FILE@\" \
+	-I$(srcdir) \
+	-I$(srcfir)/input \
+	-I$(srcfir)/output \
+	-I$(srcdir)/include
+
+AM_CFLAGS = $(cava_CPPFLAGS)
+
 cava_CFLAGS = -std=c99 -Wall -Wextra -Wno-unused-result -Wno-unknown-warning-option -Wno-maybe-uninitialized -Wno-vla-parameter
 
 EXTRA_DIST = \
+	include \
     output/shaders/pass_through.vert \
     output/shaders/bar_spectrum.frag \
     output/shaders/northern_lights.frag \
@@ -31,6 +78,19 @@ EXTRA_DIST = \
     .clang-format \
     CMakeLists.txt
 
+# Install entire directories preserving structure
+dist-hook:
+	cp -r include/cava $(DESTDIR)$(includedir)
+# Define the target to install the headers
+install-exec-hook:
+	@$(MKDIR_P) $(DESTDIR)$(includedir)/cava
+# Install entire directories preserving structure
+install-data-hook:
+	cp -r include/cava/* $(DESTDIR)$(includedir)/cava/
+# Define uninstall hook to remove the directory
+uninstall-hook:
+	$(AM_V_GEN) rm -rf "$(DESTDIR)$(includedir)/cava"
+
 if OSX
     cava_CFLAGS += -DNORT
     cava_LDADD =
@@ -42,7 +102,7 @@ endif
 
 if FREEBSD
 if CAVAFONT
-    CLEANFILES = cava.bdf cava.fnt
+    CLEANFILES += cava.bdf cava.fnt
 
 cava.fnt: ${srcdir}/cava.psf
 	${PSF2BDF} --fontname="-gnu-cava-medium-r-normal--16-160-75-75-c-80-iso10646-1" ${srcdir}/cava.psf cava.bdf
@@ -51,43 +111,45 @@ endif
 endif
 
 if ALSA
-    cava_SOURCES += input/alsa.c input/alsa.h
+    libcava_la_SOURCES += input/alsa.c input/alsa.h
 endif
 
 if PORTAUDIO
-    cava_SOURCES += input/portaudio.c input/portaudio.h
+    libcava_la_SOURCES += input/portaudio.c input/portaudio.h
 endif
 
 if PIPEWIRE
-    cava_SOURCES += input/pipewire.c input/pipewire.h
+    libcava_la_SOURCES += input/pipewire.c input/pipewire.h
 endif
 
 if PULSE
-    cava_SOURCES += input/pulse.c input/pulse.h
+    libcava_la_SOURCES += input/pulse.c input/pulse.h
 endif
 
 if SNDIO
-    cava_SOURCES += input/sndio.c input/sndio.h
+    libcava_la_SOURCES += input/sndio.c input/sndio.h
 endif
 
 if OSS
-    cava_SOURCES += input/oss.c input/oss.h
+    libcava_la_SOURCES += input/oss.c input/oss.h
 endif
 
 if JACK
-    cava_SOURCES += input/jack.c input/jack.h
+    libcava_la_SOURCES += input/jack.c input/jack.h
 endif
 
 if NCURSES
-    cava_SOURCES += output/terminal_ncurses.c output/terminal_bcircle.c \
+    libcava_la_SOURCES += output/terminal_ncurses.c output/terminal_bcircle.c \
                     output/terminal_ncurses.h output/terminal_bcircle.h
 
 endif
 
 if SDL
-    cava_SOURCES += output/sdl_cava.c output/sdl_cava.h
+    libcava_la_SOURCES += output/sdl_cava.c output/sdl_cava.h
 endif
 
 if SDL_GLSL
-    cava_SOURCES += output/sdl_glsl.c output/sdl_glsl.h
+    libcava_la_SOURCES += output/sdl_glsl.c output/sdl_glsl.h
 endif
+
+cava_SOURCES += $(libcava_la_SOURCES)

README.md

@@ -1,3 +1,6 @@
+This is a CAVA fork the main purpose of is to build cava as a shared library.
+In the same time cava application is provided as well
+====================
 CAVA [![Build Status](https://github.com/karlstav/cava/workflows/build-and-test/badge.svg)](https://github.com/karlstav/cava/actions)
 ====================
 
@@ -697,7 +700,14 @@ Using cava in other applications
 
 ### cavacore library
 
-The core processing engine in cava has been split into a separate library `cavacore`. See CAVACORE.md for details.
+* The core processing engine in cava has been split into a separate library `cavacore`. See CAVACORE.md for details.
+* cava can be built as a standalone libcava library. Practice example can be found [waybar cava module](https://github.com/Alexays/Waybar/blob/master/src/modules/cava.cpp) :
+
+    ```
+    meson setup build
+    meson compile -C build
+    meson install -C build
+    ```
 
 ### Raw Output
 

autogen.sh

@@ -5,7 +5,7 @@ set -e
 if [ -d .git ]; then
   git describe --always --tags --dirty > version # get version from git
 else
-  echo 0.10.6 > version # hard coded versions
+  echo 0.10.7 > version # hard coded versions
 fi
 
 libtoolize