Installation
The Surfmeter Media Toolkit is distributed as a self-contained archive for Linux and as a Docker image. AVEQ provides you with the download link or registry access, together with a registration key.
Requirements
- Native Execution
- Docker
- Linux on x86_64 or arm64 with glibc 2.28 or later, for example RHEL, AlmaLinux or Rocky Linux 8, Debian 10, Ubuntu 20.04, or newer
- The system libraries glibc, zlib and bzip2 (installed on practically every Linux system). All other libraries are included in the archive.
- Linux (amd64 or arm64), or macOS and Windows with Docker Desktop
- Docker Engine or Docker Desktop
In both cases, the toolkit needs to reach the Surfmeter server over HTTPS for the registration and a license check about once a day. If the server cannot be reached, the toolkit keeps working for 7 days after the last successful check.
Hardware
The toolkit runs on any x86_64 or arm64 CPU. The installation needs less than 100 MB of disk space.
The analysis is CPU-bound and scales with the number of cores. We recommend 8 cores or more for pixel metrics and full-reference metrics on HD or UHD content. As an indication, the default pixel metrics run at about 150 frames per second for 1080p content on 8 threads, and VMAF at about 200 frames per second.
Installing the archive
The archive is named surfmeter-media-<version>-linux-<arch>.tar.gz, where <arch> is x86_64 or arm64. Unpack it anywhere and run bin/surfmeter-media:
tar -xzf surfmeter-media-0.9.2-linux-x86_64.tar.gz
cd surfmeter-media-0.9.2-linux-x86_64
bin/surfmeter-media --version
To install it system-wide and put it on your PATH:
sudo mv surfmeter-media-0.9.2-linux-x86_64 /opt/surfmeter-media
sudo ln -s /opt/surfmeter-media/bin/surfmeter-media /usr/local/bin/surfmeter-media
The program finds its components relative to its own location. Only move the entire installation at once.
Updating
To update, unpack the new archive and replace the old directory. The registration is stored outside of the installation directory (see Registration) and is kept.
tar -xzf surfmeter-media-<new-version>-linux-x86_64.tar.gz
sudo rm -rf /opt/surfmeter-media
sudo mv surfmeter-media-<new-version>-linux-x86_64 /opt/surfmeter-media
Using the Docker image
The image is available for linux/amd64 and linux/arm64 at:
europe-west3-docker.pkg.dev/aveq-storage/surfmeter/surfmeter-media:<version>
Log in to the registry with the docker login command from the Software Downloads page of your Surfmeter Dashboard (Clients > Software Downloads, see Managing Clients). It contains your organization's pull key. Run it once on each machine; Docker keeps the login in ~/.docker/config.json, and it does not expire. Then pull the image:
docker pull europe-west3-docker.pkg.dev/aveq-storage/surfmeter/surfmeter-media:latest
To get your video files into the container, mount two directories:
/data: the working directory. Mount the directory with your video files here./config: a persistent volume that stores the registration profile (/config/media-toolkit.json).
By default, the container runs as user 1000. On Linux, run the container as your own user with --user "$(id -u):$(id -g)". The output files then belong to you. On Windows and macOS with Docker Desktop, this is not needed.
For example, to show the stream information of a file in the current directory:
- Linux and macOS
- Windows (PowerShell)
docker run --rm --user "$(id -u):$(id -g)" -v "$PWD:/data" \
europe-west3-docker.pkg.dev/aveq-storage/surfmeter/surfmeter-media:latest \
probe input.ts
docker run --rm -v "${PWD}:/data" `
europe-west3-docker.pkg.dev/aveq-storage/surfmeter/surfmeter-media:latest `
probe input.ts
In PowerShell, write ${PWD} with braces, and use a backtick (`) instead of a backslash to continue a command on the next line.
When you use the terminal view (--tui), add -it to docker run. This gives the container a terminal and your key presses. See Registration for how to keep a registration across container runs, and Basic Usage for an example with the terminal view.
Next steps
Next, register the installation.