X11 Animated Background

Warning

THIS PROJECT NOT FULLY BAKED YET AND MANY OF THE FEATURES ARE NOT IMPLEMENTED YET

---

Run

xab <path/to/file.mp4> [options] <path/to/another_file.gif> [options]

example: xab bg.mp4 --monitor=0 pixel_bg.gif --monitor=1 --pixelated=1

options:

• -M, --monitor=n | which monitor to use (requires xrandr and cglm dependencies) (default: 0)
• -v, --vsync=0|1 | synchronize framerate to monitor framerate (default: 1)
• --max_framerate=0|n | limit framerate to n fps (overrides vsync) (default: 0)

per video/monitor options:

• -p, --pixelated=0|1 | use bilinear instead of point filtering for rendering the background (default: bilnear)
• --hw_accel=0|1 | use hardware acceleration for video decoding (hardware needs to support it) (default: 1)

Note

hardware accelerated video decoding and max framerate are not implemented yet

Hardware requirements

Anything that supports OpenGL 3.3.

Supported file formats

Anything that ffmpeg (libav) supports

Build

Dependencies

Assuming you already have the building tools installed (e.g. gcc, make, etc.), you still need:

• xcb
• xcb-util
• xproto
• libepoxy
• xcb-randr (optional but required for multi monitor support) version >= 1.5 recommended
• cglm (optional but required for multi monitor support)
• libGL
• libEGL
• libavutil
• libavcodec
• libavformat
• libavfilter
• libswscale

On Debian distributions (e.g. Ubuntu), the needed packages are

sudo apt-get install \
    libepoxy-dev \
    libxcb1-dev libxcb-util0-dev \
    libavcodec-dev libavformat-dev libavfilter-dev libavutil-dev libswresample-dev libswscale-dev

Optional dependencies on Debian distributions

# xcb-randr
sudo apt-get install libxcb-randr-dev

# cglm
# they are on apt but outdated as hell, i would reccomend compiling from source
git clone --depth 1 https://github.com/recp/cglm.git /tmp/cglm
pushd /tmp/cglm
sh autogen.sh
./configure
make
make check
sudo make install
popd

# or if you want an outdated version (version 0.8.4 instead of 0.9.5)
sudo apt-get install libcglm-dev

TODO: fedora and arch

To build

make compile RELEASE=1

# multi monitor support:
#make compile xrandr=1 cglm=1 RELEASE=1

Built binary can be found in bin/Release/xab

---

To install

make compile RELEASE=1
sudo make install RELEASE=1

# multi monitor support:
#make compile xrandr=1 cglm=1 RELEASE=1
#sudo make install RELEASE=1 xrandr=1 cglm=1

this will install xab at /usr/local/bin

---

Compilation databases

requires compiledb

make compile_commands.json

---

make options and variables

make # currently defaults to 'compile'
make all # creates compile_commands.json and compiles xab
make run
make compile
make clean
make compile_commands.json
sudo make install

### VARIABLES:

make ARGV=TODO

make xrandr=1

# If on release mode, verbose won't do a thing
make RELEASE=1
make VERBOSE=1

make V=1 # Verbose Makefile

# defaults:
# VERBOSE=0
# RELEASE=0
# xrandr=0
# V=undefined