Flavius LEDPortal

This is a fork of the excellent LX Studio by Heronarts, Please read the copyright and licensing notices at the bottom of this readme.

LEDPortal is an interactive LED art project started by the Flavius theme camp for Burning Seed in 2020.

Some videos of development progress:

• https://www.instagram.com/p/CI5hzQbnzGE
• https://www.instagram.com/p/CC-x_NOnNkP
• https://www.instagram.com/p/CBuyp0GHbRQ

Running LedPortal

There are two ways to do this, you can bring your own Java JDK or use the JDK bundled with Processing. You should try with Processing Java first. You will also need to ensure you are using the correct Java JDK by setting the JAVA_HOME environment variable.

Prerequisites

• Maven (if not using IntelliJ / Eclipse)
• Java JDK 1.8.0_202 (or whatever your version of Processing uses)

note: on linux, install Java with:

sudo tar zxvf ~/Downloads/jdk-8u202-linux-x64.tar.gz -C /usr/lib/jvm

Set Java Home

If you have multiple versions of Java installed, you will need to explicitly set the JAVA_HOME environment variable for any shell you use to build / run this project.

on MacOS

You can list possible Java homes with

/usr/libexec/java_home -V

Matching Java Virtual Machines (4):
    14.0.1, x86_64: "AdoptOpenJDK 14" /Library/Java/JavaVirtualMachines/adoptopenjdk-14.jdk/Contents/Home
    12.0.1, x86_64: "OpenJDK 12.0.1" /Library/Java/JavaVirtualMachines/openjdk-12.0.1.jdk/Contents/Home
    11.0.2, x86_64: "Java SE 11.0.2" /Library/Java/JavaVirtualMachines/jdk-11.0.2.jdk/Contents/Home
    1.8.0_222, x86_64: "AdoptOpenJDK 8" /Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home
    1.8.0_202, x86_64: "Java SE 8" /Library/Java/JavaVirtualMachines/jdk1.8.0_202.jdk/Contents/Home

on Linux

sudo update-alternatives --install "/usr/bin/java" "java" "/usr/lib/jvm/jdk1.8.0_202/bin/java" 1
sudo update-alternatives --set "java" "/usr/lib/jvm/jdk1.8.0_202/bin/java"

Validating

You can ensure your shell has the correct version set by running

java -version

you should see

java version "1.8.0_202"
Java(TM) SE Runtime Environment (build 1.8.0_202-b08)
Java HotSpot(TM) 64-Bit Server VM (build 25.202-b08, mixed mode)

Running With Processing Java

Processing Prerequisites

• Processing 3.5.4
• Processing Video library: Sketch → Import Library → Add Library
• Processing Gif-Animation Library

Determine Processing Java Library locations

If you are not on macOS and Processing 3.5.4, you may need to adjust the locations of the following library paths in the shell used by your build commands:

export PROCESSING_CORE="/Applications/Processing.app/Contents/Java"
export PROCESSING_LIB="$HOME/Documents/Processing/libraries"

export PROCESSING_CORE="$HOME/Downloads/processing-3.5.4/core/library"
export PROCESSING_LIB="$HOME/sketchbook/libraries",

export PROCESSING_CORE="$HOME/code/processing/core/library"
export PROCESSING_LIB="$HOME/sketchbook/libraries",

Installing Processing libraries

These jars need to be installed into your local maven repository (e.g. ~/.m2/repository) manually. The groupId, artifactId and version fields should match the output of unzip -q -c <jar path> META-INF/MANIFEST.MF

You can do this with the following commands (exact jar locations could change):

mvn install:install-file -Dfile=${PROCESSING_CORE}/core.jar -DgroupId=org.processing -DartifactId=core -Dversion=3.5.4 -Dpackaging=jar
# mvn install:install-file -Dfile=${PROCESSING_CORE}/core/library/gluegen-rt.jar -DgroupId=com.jogamp -DartifactId=gluegen-rt -Dversion=2.3.2 -Dpackaging=jar
mvn install:install-file -Dfile=${PROCESSING_CORE}/gluegen-rt-natives-linux-amd64.jar -DgroupId=com.jogamp -DartifactId=gluegen-rt -Dversion=2.3.2 -Dpackaging=jar
# mvn install:install-file -Dfile=${PROCESSING_CORE}/core/library/jogl-all.jar -DgroupId=com.jogamp -DartifactId=jogl-all -Dversion=2.3.2 -Dpackaging=jar
mvn install:install-file -Dfile=${PROCESSING_CORE}/jogl-all-natives-linux-amd64.jar -DgroupId=com.jogamp -DartifactId=jogl-all -Dversion=2.3.2 -Dpackaging=jar
# mvn install:install-file -Dfile=${PROCESSING_LIB}/video/library/video.jar -DgroupId=org.processing -DartifactId=video -Dversion=2.0 -Dpackaging=jar
# mvn install:install-file -Dfile=${PROCESSING_LIB}/video/library/gst1-java-core-1.2.0.jar -DgroupId=org.gstreamer -DartifactId=gst1-java-core -Dversion=1.2.0 -Dpackaging=jar
# mvn install:install-file -Dfile=${PROCESSING_LIB}/video/library/jna.jar -DgroupId=com.sun -DartifactId=jna -Dversion=5.4.0 -Dpackaging=jar

export VIDEO_LIB="$HOME/code/processing-video/"

mvn install:install-file -Dfile=${VIDEO_LIB}/library/video.jar -DgroupId=org.processing -DartifactId=video -Dversion=2.0 -Dpackaging=jar
mvn install:install-file -Dfile=${VIDEO_LIB}/library/gst1-java-core-1.4.0.jar -DgroupId=org.gstreamer -DartifactId=gst1-java-core -Dversion=1.4.0 -Dpackaging=jar
mvn install:install-file -Dfile=${VIDEO_LIB}/library/jna.jar -DgroupId=com.sun -DartifactId=jna -Dversion=5.4.0 -Dpackaging=jar
mvn install:install-file -Dfile=${PROCESSING_CORE}/gluegen-rt.jar -DgroupId=com.jogamp -DartifactId=gluegen-rt -Dversion=2.3.2 -Dpackaging=jar
mvn install:install-file -Dfile=${PROCESSING_CORE}/jogl-all.jar -DgroupId=com.jogamp -DartifactId=jogl-all -Dversion=2.3.2 -Dpackaging=jar

or, on some systems with gstreamer-java 1.2.0

mvn install:install-file -Dfile=${VIDEO_LIB}/library/video.jar -DgroupId=org.processing -DartifactId=video -Dversion=2.0 -Dpackaging=jar
mvn install:install-file -Dfile=${VIDEO_LIB}/library/gst1-java-core-1.2.0.jar -DgroupId=org.gstreamer -DartifactId=gst1-java-core -Dversion=1.2.0 -Dpackaging=jar
mvn install:install-file -Dfile=${VIDEO_LIB}/library/jna.jar -DgroupId=com.sun -DartifactId=jna -Dversion=5.4.0 -Dpackaging=jar

for gifs:

mvn install:install-file "-Dfile=${PROCESSING_LIB}/gifAnimation/library/gifAnimation.jar" "-DgroupId=extrapixel" "-DartifactId=gifAnimation" "-Dversion=3.0.0" "-Dpackaging=jar" 

Running with BYO Java

BYO Java Prerequisites

This has only been tested on MacOS, if you're a Java wizard, you may be able to get it working on other platforms

• Java JDK 1.8.0_202
• Maven (if not using IntelliJ / Eclipse)

on Windows with choco:

choco install adoptopenjdk8 -y
choco install maven Processing -y

• Install vscjava.vscode-java-pack VSCode extension
• Configure Java Runtime

Installing Provided libraries

With IntelliJ / Eclipse: build config files provided, your IDE will handle this for you.

With VScode / Maven

To build pom.xml with Maven, you will need to install the following 3rd party (not available on mvnrepository) libraries, whose jars are provided in lib/:

• heronarts.lx
• heronarts.p3lx
• heronarts.lxstudio (private)

These jars need to be installed into your local maven repository (e.g. ~/.m2/repository) manually. The groupId, artifactId and version fields should match what's in pom.xml You can do this with the following commands (exact jar locations could change):

export PROJ_VERSION="0.2.1"
mvn install:install-file "-Dfile=lib/lxstudio-${PROJ_VERSION}.jar" -DgroupId=heronarts -DartifactId=lxstudio "-Dversion=${PROJ_VERSION}" -Dpackaging=jar
mvn install:install-file "-Dfile=lib/lx-${PROJ_VERSION}-jar-with-dependencies.jar" -DgroupId=heronarts -DartifactId=lx "-Dversion=${PROJ_VERSION}" -Dpackaging=jar
mvn install:install-file "-Dfile=lib/p3lx-${PROJ_VERSION}.jar" -DgroupId=heronarts -DartifactId=p3lx "-Dversion=${PROJ_VERSION}" -Dpackaging=jar
# mvn install:install-file -Dfile=lib/video-1.0.1/video.jar -DgroupId=org.processing -DartifactId=video -Dversion=1.0.1 -Dpackaging=jar
# mvn install:install-file -Dfile=lib/video-1.0.1/gstreamer-java.jar -DgroupId=org.gstreamer -DartifactId=gstreamer-java -Dversion=1.6.2 -Dpackaging=jar
# mvn install:install-file -Dfile=lib/video-1.0.1/jna.jar -DgroupId=com.sun -DartifactId=jna -Dversion=4.2.0 -Dpackaging=jar

You can also clone into the source code repositories (where available) and mvn install if you want to modify them.

On Windows:

You'll also need to install the processing core libraries.

mvn install:install-file "-Dfile=C:\ProgramData\chocolatey\lib\Processing\tools\processing-3.5.4\core\library\core.jar" "-DgroupId=org.processing" "-DartifactId=core" "-Dversion=3.5.4" "-Dpackaging=jar"

Compiling

With IntelliJ / Eclipse: build config files provided, your IDE will handle this for you.

With VScode / Maven:

You can compile this repository with the following commands, you may need to adjust your java home

export JAVA_HOME="/Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home"
mvn compiler:compile assembly:single

This is provided as a VSCode build task in .vscode/tasks.json

Usage

With IntelliJ / Eclipse: Open this repo in your IDE and hit run.

With VScode / Maven:

export JAVA_HOME="/Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home"
java -cp "target/lxstudio-ide-0.2.1-jar-with-dependencies.jar:lib/processing-3.5.4/core.jar:lib/processing-3.5.4/gluegen-rt.jar:lib/processing-3.5.4/jogl-all.jar:lib/video-1.0.1/video.jar:lib/video-1.0.1/gstreamer-java.jar:lib/video-1.0.1/jna.jar" heronarts.lx.app.LXStudioApp

This is provided as a VSCode build task in .vscode/tasks.json

Debugging

Serial ports not working on Ubuntu

Try adding the user to the tty and dialout groups

sudo usermod -a -G tty $USER
sudo usermod -a -G dialout $USER
sudo reboot now

Create a new Processing 3 sketch and test your serial port is detected

import processing.serial.*;

void setup()  {
  // print a list of the serial ports:
  printArray(Serial.list());
}

Video not working on Ubuntu

Open the Processing 3 IDE, and go file -> examples -> video -> movile -> loop. Run the sketch to test your gstreamer install

If that doesn't work, ensure you have gstreamer libaries installed

sudo apt install gstreamer1.0-x libgstreamer-plugins-base1.0-dev libgstreamer-plugins-good1.0-dev

do not install plugins-bad!!

you may also need some codecs to play certain videos

sudo apt-get install ubuntu-restricted-extras ffmpeg vlc

install processing from source

git clone 
cd processing

LX Studio Notices

BY DOWNLOADING OR USING THE LX STUDIO SOFTWARE OR ANY PART THEREOF, YOU AGREE TO THE TERMS AND CONDITIONS OF THE LX STUDIO SOFTWARE LICENSE AND DISTRIBUTION AGREEMENT.

Please note that LX Studio is not open-source software. The license grants permission to use this software freely in non-commercial applications. Commercial use is subject to a total annual revenue limit of $25K on any and all projects associated with the software. If this licensing is obstructive to your needs or you are unclear as to whether your desired use case is compliant, contact me to discuss proprietary licensing: mark@heronarts.com

---

LX Studio is a digital lighting workstation, bringing concepts from digital audio workstations and modular synthesis into the realm of LED lighting control. Generative patterns, interactive inputs, and flexible parameter-driven modulation — a rich environment for lighting composition and performance.

Getting Started

LX Studio runs using the Processing 3 framework. This version of the project directly embeds those dependencies and may be run from within a Java IDE, for larger projects in which the Processing IDE is insufficient. The example project here can be run either using the full Processing-based UI, or alternatively in a headless CLI-only mode.

To get started, clone this repository and import the project into an IDE like Eclipse or IntelliJ. Configuration files for both are readily available in the repository.

Documentation is available on the LX Studio Wiki →

Consult the LX Studio API reference →

Contact and Collaboration

Building a big cool project? I'm probably interested in hearing about it! Want to solicit some help, request new framework features, or just ask a random question? Open an issue on the project or drop me a line: mark@heronarts.com

---

HERON ARTS MAKES NO WARRANTY, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, AND SPECIFICALLY DISCLAIMS ANY WARRANTY OF MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR A PARTICULAR PURPOSE, WITH RESPECT TO THE SOFTWARE.