projectm/README.md

projectM - The most advanced open-source music visualizer

projectM is an open-source project that reimplements the esteemed Winamp Milkdrop by Geiss in a more modern, cross-platform reusable library.

Its purpose in life is to read an audio input and to produce mesmerizing visuals, detecting tempo, and rendering advanced equations into a limitless array of user-contributed visualizations.

Available For

• macOS, Linux (binary)
• Windows Store (PC, XBOX, Phone)
• Windows (standalone binary) (Requires the latest Visual C++ redistributable)
• Android
• iOS
• iTunes plugin (macOS)
• Qt5 + Pulseaudio
• ALSA, xmms, winamp, jack (source, unmaintained)

Download

Get it from the Releases tab or Download from the Windows Store (PC, XBOX, Phone)

Discord chat

Chat with us on Discord.

Demo Video

Presets

The preset files define the visualizations via pixel shaders and Milkdrop-style equations and parameters. Included with projectM are the bltc201, Milkdrop 1 and 2, projectM, tryptonaut and yin collections. You can grab these presets here.

You can also download an enormous 41,000 preset pack of presets here (123MB zipped).

Also Featured In

Kodi (formerly XBMC)

Helix

Silverjuke (FOSS Jukebox)

Silent Radiance Distance Disco

---

Screenshots

---

Architecture

• Article

Building from source

See BUILDING.md

Keyboard Controls:

• Up: increase beat sensitivity (max 5)

• Down: decrease beat sensitivity (min 0)

• Y: toggle shuffle enabled

• R: jump to random preset

• N: next preset

• P: previous preset

• Shift-N: next preset with hard cut

• Shift-P: previous preset with hard cut

• L: lock current preset

• H or F1: show help (if supported)

• F3: show preset (if supported)

• F4: show stats (if supported)

• F5: show FPS (if supported)

Only ProjectM SDL:

• Cmd/Ctrl-Q: quit
• Cmd/Ctrl-I: select next audio input device (as of v3.1.3)
• Cmd/Ctrl-S: stretch monitors
• Cmd/Ctrl-M: change monitor
• Cmd/Ctrl-F: toggle full screen
• Space: lock current preset

Using the library

At its core projectM is a library, 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.

To look at a simple example way of using the library see the libSDL2 sample code.

There are many other applications that make use of libprojectM and that can be found in the src directory.

---

Todo

• Support for the missing Milkdrop waveforms to get full compatibility with Milkdrop presets.
• Steal cool stuff from the recently-released Milkdrop source.
• Finish emscripten support for building to wasm/webGL for the web.
• Update the various implementations using libprojectM.
• Update downstream projects with new versions.

---

Help

Report issues on GitHub

Chat with us on Discord. or on IRC at irc.freenode.net #projectM.

If you would like to help improve this project, either with documentation, code, porting, hardware or anything else please let us know! We gladly accept pull requests and issues.

Maintainers

If you maintain packages of libprojectM, we are happy to work with you! Please note well:

• The main focus of this project is libprojectM. It's a library that only really depends on OpenGL. The other applications are more like examples and demos.
• Most of the applications (e.g. src/projectM-*) are likely outdated and of less utility than the core library. If you desire to use them or depend on them, please file an issue so we can help update them.
• The "canonical" application for actually viewing the visualizations is now projectM-sdl, based on libSDL2 because it supports audio input and is completely cross-platform.
• This is an open source project! If you don't like something, feel free to contribute improvements!
• Yes, you are looking at the official version. This is not a fork.

Authors

Authors

License

LGPL