Docker script (#9)

* Docker script to convert audio to video

* Defaults, readme

* rm idea

* demo video link

Author: revmischa

.gitignore

@@ -7,3 +7,4 @@ docs/TODO.md
 test/output
 cmake-build-*
 out/
+.cache/

Dockerfile

@@ -0,0 +1,85 @@
+# Start from the official Ubuntu 24.04 image
+FROM ubuntu:24.04
+
+# Install required packages
+RUN apt-get update && \
+    DEBIAN_FRONTEND=noninteractive apt-get install -y \
+        build-essential \
+        llvm \
+        git \
+        cmake \
+        ca-certificates \
+        libssl-dev \
+        curl \
+        xvfb \
+        libgstreamer-plugins-base1.0-dev \
+        libgstreamer-plugins-bad1.0-dev \
+        gstreamer1.0-plugins-base \
+        gstreamer1.0-plugins-good \
+        gstreamer1.0-plugins-bad \
+        gstreamer1.0-plugins-ugly \
+        gstreamer1.0-x \
+        gstreamer1.0-tools \
+        libgles2-mesa-dev \
+        mesa-utils \
+        sudo
+
+# Clone the projectM repository and build it
+RUN git clone --depth 1 https://github.com/projectM-visualizer/projectm.git /tmp/projectm
+WORKDIR /tmp/projectm
+RUN git submodule update --init --depth 1
+RUN mkdir build
+WORKDIR /tmp/projectm/build
+RUN cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local ..
+RUN make -j$(nproc)
+RUN make install
+WORKDIR /tmp
+RUN rm -rf /tmp/projectm
+
+# Get the projectM preset pack
+RUN git clone --depth 1 https://github.com/projectM-visualizer/presets-cream-of-the-crop.git /usr/local/share/projectM/presets
+
+# Get the projectM texture pack
+RUN git clone --depth 1 https://github.com/projectM-visualizer/presets-milkdrop-texture-pack.git /usr/local/share/projectM/textures
+
+# Clone the gst-projectm repository and build the GStreamer plugin
+RUN git clone https://github.com/projectM-visualizer/gst-projectm.git /tmp/gst-projectm
+WORKDIR /tmp/gst-projectm
+RUN ./setup.sh --auto
+RUN mkdir build && \
+    cd build && \
+    cmake -DCMAKE_BUILD_TYPE=Release .. && \
+    make
+RUN mkdir -p /usr/lib/x86_64-linux-gnu/gstreamer-1.0/ && \
+    cp build/libgstprojectm.so /usr/lib/x86_64-linux-gnu/gstreamer-1.0/ && \
+    rm -rf /tmp/gst-projectm
+
+# Clean up unnecessary packages to reduce image size
+RUN apt-get remove -y \
+        build-essential \
+        git \
+        cmake && \
+    apt-get autoremove -y && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+
+# Create a working directory for conversion tasks
+WORKDIR /app
+
+# Copy the conversion script
+COPY convert.sh /app/
+RUN chmod +x /app/convert.sh
+
+# Set environment variables
+ENV GST_DEBUG=3
+ENV PRESETS_DIR=/usr/local/share/projectM/presets
+ENV TEXTURES_DIR=/usr/local/share/projectM/textures
+ENV XDG_RUNTIME_DIR=/tmp
+
+# Setup for GPU access
+ENV LIBGL_ALWAYS_INDIRECT=0
+ENV NVIDIA_DRIVER_CAPABILITIES=all
+ENV NVIDIA_VISIBLE_DEVICES=all
+
+# Default command
+ENTRYPOINT ["/app/convert.sh"]

README.md

@@ -29,6 +29,15 @@
   <summary>Table of Contents</summary>
   <ol>
     <li><a href="#getting-started">Getting Started</a></li>
+    <li>
+      <a href="#easy-audio-to-video-conversion">Easy Audio to Video Conversion</a>
+      <ul>
+        <li><a href="#docker-container">Using Docker Container</a></li>
+        <li><a href="#conversion-examples">Conversion Examples</a></li>
+        <li><a href="#customizing-visualizations">Customizing Visualizations</a></li>
+      </ul>
+    </li>
+    <li><a href="#manual-usage">Manual Usage</a></li>
     <li><a href="#contributing">Contributing</a></li>
     <li><a href="#license">License</a></li>
     <li><a href="#support">Support</a></li>
@@ -75,6 +84,142 @@ gst-inspect projectm
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
+## [Demo Videos (4K)](https://www.youtube.com/watch?v=fI3BMiVDQgU&list=PLFLkbObX4o6TK1jGL6pm1wMwvq2FXnpYJ&index=7)
+
+https://www.youtube.com/watch?v=fI3BMiVDQgU&list=PLFLkbObX4o6TK1jGL6pm1wMwvq2FXnpYJ&index=7
+
+<!-- EASY AUDIO TO VIDEO CONVERSION -->
+
+## Easy Audio to Video Conversion
+
+We provide a simple way to convert audio files to video with ProjectM visualizations using Docker. This method requires no manual installation of dependencies, as everything is packaged in a Docker container.
+
+### Docker Container
+
+The included Docker container has:
+
+- ProjectM library and presets
+- GStreamer with all necessary plugins
+- The gst-projectm plugin compiled and ready to use
+- GPU acceleration support (NVIDIA, AMD, or Intel)
+
+#### Prerequisites
+
+- [Docker](https://docs.docker.com/get-docker/) installed on your system
+- For GPU acceleration:
+  - NVIDIA GPUs: [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html)
+  - AMD/Intel GPUs: No additional installation required
+
+#### Quick Start
+
+1. Clone this repository:
+
+   ```bash
+   git clone https://github.com/projectM-visualizer/gst-projectm.git
+   cd gst-projectm
+   ```
+
+2. Convert an audio file to video:
+   ```bash
+   ./projectm-convert -i your-audio-file.mp3 -o output-video.mp4
+   ```
+
+The first run will build the Docker container automatically. It will take a good while, so be patient. Once built, it will be cached for future runs.
+
+Note that running the conversion can take hours depending on the length of the audio file and the selected settings.
+
+### Conversion Examples
+
+#### Basic Conversion
+
+Convert an MP3 to a 1080p MP4 with default settings:
+
+```bash
+./projectm-convert -i my-song.mp3 -o my-visualization.mp4
+```
+
+#### 4K Resolution
+
+Create a 4K video with higher bitrate:
+
+```bash
+./projectm-convert -i my-song.mp3 -o my-visualization-4k.mp4 --video-size 3840x2160 -b 16000
+```
+
+#### High Quality Render
+
+For creating high quality videos (slower encoding):
+
+```bash
+./projectm-convert -i my-song.mp3 -o my-visualization-hq.mp4 --speed veryslow --mesh 2048x1152
+```
+
+#### Quick Test Run
+
+For quick testing (lower quality but faster encoding):
+
+```bash
+./projectm-convert -i my-song.mp3 -o my-visualization-test.mp4 --speed ultrafast --video-size 1280x720
+```
+
+### Customizing Visualizations
+
+The conversion script supports customizing various aspects of the visualization:
+
+| Option                | Description                                        | Default         |
+| --------------------- | -------------------------------------------------- | --------------- |
+| `-d, --duration SEC`  | Time in seconds between preset transitions         | 6               |
+| `--mesh WxH`          | Mesh size for visualization calculations           | 1024x576        |
+| `--video-size WxH`    | Output video resolution                            | 1920x1080       |
+| `-r, --framerate FPS` | Output video frame rate                            | 60              |
+| `-b, --bitrate KBPS`  | Output video bitrate in kbps                       | 8000            |
+| `--speed PRESET`      | x264 encoding speed preset (ultrafast to veryslow) | medium          |
+| `-p, --preset DIR`    | Path to custom presets directory                   | Default presets |
+
+#### Using Custom Presets
+
+If you have your own ProjectM preset files:
+
+```bash
+./projectm-convert -i my-song.mp3 -o my-visualization.mp4 -p /path/to/your/presets
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- MANUAL USAGE -->
+
+## Manual Usage
+
+Once the plugin has been installed, you can use it something like this:
+
+```shell
+gst-launch pipewiresrc ! queue ! audioconvert ! projectm preset=/usr/local/share/projectM/presets preset-duration=5 ! video/x-raw,width=2048,height=1440,framerate=60/1 ! videoconvert ! xvimagesink sync=false
+```
+
+Or to convert an audio file to video:
+
+```shell
+gst-launch-1.0 -e \
+  filesrc location=input.mp3  ! \
+    decodebin ! tee name=t \
+      t. ! queue ! audioconvert ! audioresample ! \
+            capsfilter caps="audio/x-raw, format=F32LE, channels=2, rate=44100" ! avenc_aac bitrate=320000 ! queue ! mux. \
+      t. ! queue ! audioconvert ! projectm preset=/usr/local/share/projectM/presets texture-dir=/usr/local/share/projectM/textures preset-duration=6 mesh-size=1024,576 ! \
+            identity sync=false ! videoconvert ! videorate ! video/x-raw,framerate=60/1,width=3840,height=2160 ! \
+            x264enc bitrate=50000 key-int-max=200 speed-preset=veryslow ! video/x-h264,stream-format=avc,alignment=au ! queue ! mux. \
+    mp4mux name=mux ! filesink location=output.mp4
+```
+
+You may need to adjust some elements which may or may not be present in your GStreamer installation, such as x264enc, avenc_aac, etc.
+
+Available options:
+
+```shell
+gst-inspect projectm
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 <!-- CONTRIBUTING -->
 
 ## Contributing
@@ -114,6 +259,8 @@ Distributed under the LGPL-2.1 license. See `LICENSE` for more information.
 
 Blaquewithaq (Discord: SoFloppy#1289) - [@anomievision](https://twitter.com/anomievision) - [email protected]
 
+Mischa (Discord: mish) - [@revmischa](https://github.com/revmischa)
+
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 <!----------------------------------------------------------------------->