Merge pull request #26 from projectM-visualizer/glsl

Re-enable shaders on modern platforms by transpiling HLSL to GLSL on the fly.
Better GLES support.
Running successfully on embedded systems with GLES and shaders. Compiles and almost runs with emscripten now (#92).
Mega props 👏 => @deltaoscarmike <= 👏

Author: revmischa

.gitignore

@@ -4,7 +4,7 @@ src/libprojectM/config.inp
 src/libprojectM/config.inp.b
 src/libprojectM/config.inp.in
 src/projectM-emscripten/build/presets
-src/libprojectM/libprojectM.xcodeproj
+src/libprojectM/libprojectM.xcodeproj/xcshareddata
 presets/custom
 project.xcworkspace
 *.o
@@ -36,3 +36,5 @@ m4/ltoptions.m4
 m4/ltsugar.m4
 m4/ltversion.m4
 m4/lt~obsolete.m4
+/t
+/src/libprojectM/libprojectM.pc

.travis.yml

@@ -13,7 +13,6 @@ script:
   - test -e src/projectM-sdl/projectMSDL
   - test -e src/libprojectM/libprojectM.la
   - test -e dist_install/share/projectM/fonts/Vera.ttf
-  - test -e dist_install/share/projectM/shaders/blur.cg
   - test -d dist_install/share/projectM/presets
   - test -e dist_install/lib/libprojectM.la
   - test -e dist_install/include/libprojectM/projectM.hpp
@@ -34,9 +33,8 @@ matrix:
             - libsdl2-dev
             - libglew-dev
             - libftgl-dev
-            - libsdl2-dev
-            - libdevil-dev
             - libglm-dev
+            - libc++-dev
       env:
         - MATRIX_EVAL="CC=clang-5.0 && CXX=clang++-5.0"
     # linux/gcc
@@ -50,9 +48,8 @@ matrix:
             - libsdl2-dev
             - libglew-dev
             - libftgl-dev
-            - libsdl2-dev
-            - libdevil-dev
             - libglm-dev
+            - libc++-dev
       env:
         - MATRIX_EVAL="CC=gcc-7 && CXX=g++-7"
 

BUILDING.md

@@ -0,0 +1,33 @@
+# How to build projectM from scratch
+
+There are autoconf and automake files for projectM. It is suggested to read configure.ac and the assorted Makefile.am files.
+
+
+## libprojectM
+
+libprojectM is the core library. It is made up of three sub-libraries:
+
+#### Renderer
+Made up of everything in src/libprojectM/Renderer. It should project libRenderer
+
+#### MilkdropPresetFactory / NativePresetFactory
+From their respective folders. Native presets are visualizations that are implemented in C++ instead of .milk preset files. They are completely optional. Milkdrop presets are technically optional but the whole thing is basically useless without them.
+
+If you don't want native presets, and you probably don't, don't bother with them. Ideally there should be a configure option to disable them, probably on by default (at this time this is needed for autoconf: https://github.com/projectM-visualizer/projectm/issues/99).
+
+
+
+### Dependencies
+
+* libglm for matrix math is required, just the headers though. We are considering "vendoring" them.
+* A modified version of hlslparser is included in Renderer and used to transpile HLSL shaders to GLSL
+* OpenGL 3+ or OpenGLES is required
+* libftgl was used for drawing text. It is optional and may or may not be dropped
+* libglew was used. not sure if it's still used.
+* libsdl >= 2.0.5 is required for the SDL and emscripten apps. src/projectM-sdl is the current reference application implementation. maybe try getting that to build and run as your testbench.
+
+
+#### Assets
+libprojectM can either have a configuration hard-coded or load from a configuration file. It's up to each application to decide how to load the config file. The config file can have paths defined specifying where to load fonts and presets from.
+
+You will want to install the config file and presets somewhere, and then define that path for the application you're trying to build.

FAQ.txt

@@ -2,20 +2,17 @@ ACLOCAL_AMFLAGS = -I m4
 AM_CPPFLAGS=-DDATADIR_PATH='"${pkgdatadir}"'
 SUBDIRS=src
 PRESETSDIR = presets
-EXTRA_DIST=README.md AUTHORS.txt presets fonts src/libprojectM/Renderer/blur.cg src/libprojectM/Renderer/projectM.cg $(PRESETSDIR)
+EXTRA_DIST=README.md AUTHORS.txt presets fonts $(PRESETSDIR)
 CLEANFILES=
 
 # aka /usr/local/share/projectM
 pm_data_dir = $(pkgdatadir)
 pm_font_dir = $(pm_data_dir)/fonts
 pm_presets_dir = $(pm_data_dir)/presets
-pm_shaders_dir = $(pm_data_dir)/shaders
 
 # files to install
 pm_data__DATA = src/libprojectM/config.inp
 pm_font__DATA = fonts/Vera.ttf fonts/VeraMono.ttf
-pm_shaders__DATA = src/libprojectM/Renderer/blur.cg \
-                   src/libprojectM/Renderer/projectM.cg
 
 # find and install all preset files
 install-data-local:

Makefile.am

@@ -8,12 +8,13 @@ projectM is an open-source project that reimplements the esteemed [Winamp Milkdr
 Its purpose in life is to read in audio input and produce mesmerizing visuals, detecting tempo, and rendering advanced equations into a limitless array of user-contributed visualizations.
 
 ### Available For
-* [Mac OS X, Linux (binary)](https://github.com/projectM-visualizer/projectm/releases/tag/v0.9.2-beta)
-* [Mac OS X iTunes (plugin)](https://github.com/projectM-visualizer/projectm/releases/tag/v0.9.1-beta)
+* [macOS, Linux (binary)](https://github.com/projectM-visualizer/projectm/releases/tag/v0.9.2-beta)
 * [Android](https://play.google.com/store/apps/details?id=com.psperl.projectM)
 * [iOS](https://itunes.apple.com/us/app/projectm-music-visualizer/id530922227?mt=8&ign-mpt=uo%3D4)
 * Qt5 + Pulseaudio
 * [ALSA, xmms, winamp, jack](https://sourceforge.net/projects/projectm/files/) (source, unmaintained)
+* [iTunes plugin (macOS)](https://github.com/projectM-visualizer/projectm/releases/tag/v0.9.1-beta)
+* Windows (in progress)
 
 ### Project Status
 You can read more about how it works and the current state of development [here](https://lwn.net/Articles/750152/).
@@ -74,19 +75,19 @@ Silverjuke (FOSS Jukebox)
 # Using the library
 At its core projectM is a library, [libprojectM](src/libprojectM). This library is responsible for parsing presets, analyzing audio PCM data with beat detection and FFT, applying the preset to the audio feature data and rendering the resulting output with openGL. It can render to an openGL context or a texture.
 
-For an example of a very simple example use of the library see the [libSDL2 sample code](src/projectM-sdl/projectM_SDL_main.cpp).
+For an example of a simple example use of the library see the [libSDL2 sample code](src/projectM-sdl/projectM_SDL_main.cpp).
 
 There are many other applications that make use of libprojectM that can be found in the [src](src/) directory.
 
 ***
 
 # Todo
-* Top priority has for a long time been to [port the calls from OpenGL immediate-mode (old-school) to be compatible with OpenGL ES](https://github.com/projectM-visualizer/projectm/issues/11), using [vertex buffer objects](http://duriansoftware.com/joe/An-intro-to-modern-OpenGL.-Chapter-2.1:-Buffers-and-Textures.html). There's a [todo list of function calls to replace](https://github.com/projectM-visualizer/projectm/blob/gles/glES-porting.txt).
-* [macOS Sierra broke the iTunes plugin somehow](https://github.com/projectM-visualizer/projectm/issues/7) (this is semi-fixed)
-* Currently shader support is done via nVidia's Cg shader toolkit. This is ancient and no longer supported and very lame. [Use standard OpenGL facilities for compiling and executing the shader-based presets.](https://github.com/projectM-visualizer/projectm/pull/26)
+* Make it build on windows again. There is support, it just needs updating.
 * Support for the missing Milkdrop waveforms to get full compatibility with Milkdrop presets.
 * Steal cool stuff from the recently-released Milkdrop source.
-* Update the [various applications using libprojectM](src).
+* Finish emscripten support for building to wasm/webGL for the web.
+* Update the [various implementations using libprojectM](src).
+* Update downstream projects with new versions.
 
 ***