Skip to content

Licensing

What you have to do to ship AetherEngine and its dependencies in an app, App Store included.

PartLicenseHow it reaches your appWhat you do
AetherEngineLGPL-3.0 with an App Store / DRM exceptionStatically linked (SPM default)Point to the exact tag you built against; publish your changes to the engine under LGPL
FFmpegLGPL-2.1-or-laterDynamic frameworks from FFmpegBuildEmbed them dynamically, ship the license texts, link the build’s source
libdoviMIT (dual MIT OR Apache-2.0, used as MIT)Static library from LibDoviShow quietvoid’s copyright notice
LibTrueHDMIT, plus Apache-2.0 partsStatic library, only with the TrueHDObjectAudio traitShip the Apache-2.0 text and LibTrueHD’s NOTICE
DTS:X decodingPart of FFmpegNothing extraNothing beyond FFmpeg
SMBClientMITOnly if you link AetherEngineSMBShow its notice
Anime4KMITCompiled in (the line-art scaler’s kernels)Show bloc97’s notice

LGPL-3.0 with Apple Store / DRM Exception. The exception explicitly allows distribution through app stores (Apple App Store, TestFlight, and so on). Without it, their terms would conflict with LGPL sections 4 to 6. Changes to the engine itself must still be released under the LGPL.

The exception covers AetherEngine’s own code. It does not extend to its dependencies.

This is what lets any app, closed source included, ship AetherEngine through the App Store while the engine stays open. (Sodalite itself is open source under GPL-3.0 with the same store exception.)

FFmpeg reaches your app through FFmpegBuild as dynamically linked frameworks under plain LGPL-2.1-or-later, with no GPL components. The LGPL requires that users can relink the app against their own build of the library. Dynamic linking keeps that possible for closed-source App Store apps.

The components and their licenses:

ComponentLicense
FFmpeg (libavcodec, libavformat, libavutil, libswresample, libswscale, libavfilter)LGPL-2.1+
dav1dBSD-2-Clause
zimgWTFPL
libzvbiLGPL-2.0+ (its ure.c MIT)

FFmpegBuild’s README lists them in detail, with the concrete steps for adopters (embed dynamically, ship the license texts, link the build’s source). Its LICENSES/ folder is the set to reproduce, one file per component.

libdovi reaches your app through LibDovi as a static library. It is the compiled dolby_vision crate from dovi_tool, Copyright (c) quietvoid and contributors, dual-licensed MIT OR Apache-2.0 and used here under the MIT option.

MIT requires the copyright notice to travel with the binary, and it is quietvoid’s notice that belongs on your acknowledgements screen. The MIT text in LibDovi’s own LICENSE covers only the packaging and build scripts; both parts are in that one file.

LibTrueHD reaches your app as a static library and decodes TrueHD for objectAudioRendering.

  • Its C API, framer and packaging are MIT (Copyright Quick104, who wrote it for Silo as SiloObjectAudio, and Vincent Herbst).
  • It compiles in the truehd and oamd crates from truehdd, Copyright Rainbaby and the truehdd contributors, under the Apache License 2.0. That license requires its text and LibTrueHD’s NOTICE to travel with the binary. Apache-2.0 combines with the engine’s LGPL-3.0.
  • It comes in only through the TrueHDObjectAudio trait, which is off by default (Optional components). With the trait on, it is linked whether or not a host turns the option on.

DTS:X is decoded by FFmpeg’s own dca decoder in the FFmpeg frameworks above. FFmpegBuild carries a patch that decodes the height channels of DTS:X’s standard presentation, so the DTSXObjectAudio trait adds no library and no license of its own.

Earlier releases linked LibDTSX instead. The engine no longer does, because its dca crate is a port of FFmpeg’s decoder combined with Apache-2.0 code. That makes it LGPL-3.0-or-later, which an App Store app cannot meet without an exception.

SMBClient (MIT) reaches your app only if you link the AetherEngineSMB product. Linking AetherEngine alone pulls in none of its symbols. SwiftPM still lists the package in Package.resolved, because that file describes the resolved graph, not what the linker kept.

The line-art scaler (LoadOptions.upscaleScaler = .lineArt) runs Anime4K’s Upscale CNN x2 (S), Copyright (c) 2019-2021 bloc97, MIT. Its weights are compiled into the engine as Metal source, whether or not a host uses the option. That file (Sources/AetherEngine/Video/Metal/LineArtShaderSource.swift) carries the full notice. MIT requires the copyright notice to travel with the binary, so bloc97’s notice belongs on your acknowledgements screen.

An SPM library product links statically by default, and for the engine that is the intended setup on the App Store path.

  • Object code: without the exception, LGPL-3.0 section 4(d)(0) would ask for your app’s object code in a relinkable form. The exception’s fourth bullet explicitly names end-user re-linking, so that part does not apply.
  • Source: the exception does not waive the source side. Point at the exact tag you built against, not the repository root. If you patched the engine, publish the patched source under the LGPL. No separate written offer is needed while that pointer works.
  • Dependencies keep their own terms either way. That is why the FFmpeg frameworks must stay dynamically embedded in YourApp.app/Frameworks/ instead of being merged into the app binary.

Make sure the engine’s FFmpeg is the one that answers

Section titled “Make sure the engine’s FFmpeg is the one that answers”

Being dynamic does not guarantee being used. The engine calls avcodec_* as ordinary external symbols, so a second FFmpeg elsewhere in the app can serve them instead:

  • a static archive pulled in with -force_load becomes a definition inside your executable and beats every dylib;
  • a dependency that exports the same symbols wins on link order alone (libVLC does, and CocoaPods sorts a pod ahead of a vendored framework).

Link AetherEngine’s frameworks first. nm -m <executable> | grep _avcodec_find_encoder shows who currently wins. The engine’s own startup line says the same from the inside (guide.md › Which FFmpeg answered).