libcec-sys

FFI bindings for the libcec

Finding libcec

This crate works with libcec v4.x, v5.x and v6.x (latest version as time of writing). During the build we try to find libcec system library installation using pkg-config and compilation using default C compiler (cc crate).

As a fallback, static libcec (v6.0.2) is downloaded from ssalonen/libcec-static-builds. Note that the supported targets is more limited with static builds. It might also might not have the relevant libcec features enabled, e.g. Raspberry Pi native CEC module support.

There are vendored and static feature to allow more explicit control. There are also LIBCEC_VENDORED and LIBCEC_STATIC environment variables, just set them to value 1.

The crate is tested mainly with Linux and Windows but could work with other platforms as well. PRs welcome.

Linux (general)

On Linux, for most convenient build process, it is recommended to install pkg-config, libcec-dev (headers and pkg-config configuration), libcec6 (dynamic library), libp8-platform-dev and libp8-platform2 from your package distribution before installing this crate. Exact package names vary between distributions and package managers.

In addition libudev-dev might be needed.

With debian based distributions, you can simply

sudo apt-get install libudev-dev libp8-platform2 libp8-platform-dev libcec-dev pkg-config libcec6

If your environment lacks the needed depencies, most easy option might be to fallback to static build.

Raspberry Pi OS

If you are using Raspberry Pi OS and want to use the built-in HDMI port CEC, you might need to build the libcec yourself, since the libcec as packaged by debian is not providing the driver (as of 2022)

Adapted from libcec documentation:

# Become superuser
sudo su

# Remove libcec (since we are going to build it ourselves)
apt-get remove libcec6

# Install libcec build dependencies, but not libcec itself
apt-get install libp8-platform-dev libp8-platform2 cmake libudev-dev libxrandr-dev python3-dev swig git

# Build libcec 6.0.2 with RPI CEC driver enabled
rm -rf /tmp/libcec-build-tmp
mkdir /tmp/libcec-build-tmp
cd /tmp/libcec-build-tmp
git clone --recursive https://github.com/Pulse-Eight/libcec.git
cd libcec
git checkout libcec-6.0.2
mkdir build
cd build
cmake -DRPI_INCLUDE_DIR=/opt/vc/include -DRPI_LIB_DIR=/opt/vc/lib ..
make -j4
make install
ldconfig

# Leave superuser context
exit

Windows

On Windows, probably easiest is to let the libcec-sys fallback to statically pre-built library. One can request this explicitly by using LIBCEC_STATIC=1 environment variable or by using static feature.

For dynamic linking: On Windows, it is recommended to install libcec via the installer and add cec.dll to the PATH environment variable.

For a vendored build: libcec-sys will dynamically link to the compiled cec.dll. This means you must package your standalone executable with the compiled dynamic library.

Vendored Build Prerequisites:

• Visual Studio 2019 w/ Desktop Development with C++ and Universal Windows Platform development
• CMake 3.12+
• Python 3.6+ with Debug Binaries

Static build of libcec

Static build has been adapted from great work from @opeik in https://github.com/ssalonen/cec-rs/issues/52

See https://github.com/ssalonen/libcec-static-builds

License

This repo contains content distributed under three different licenses.

1. Main package, licensed under GNU General Public License version 2, (LICENSE or https://opensource.org/licenses/GPL-2.0)

2. The CI/CD setup in .github/ is based on rust-github/template, and therefore licensed under either of

   • Apache License, Version 2.0 (LICENSE-CI-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
   • MIT license (LICENSE-CI-MIT or http://opensource.org/licenses/MIT)

   at your option.

3. The CI uses sccache build cache tooling as shared in Cross repository wiki. The Cross repo itself is licensed under either of

   • Apache License, Version 2.0 (LICENSE-CI-docker-sscache-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
   • MIT license (LICENSE-CI-docker-sscache-MIT or http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

See CONTRIBUTING.md.

Releasing

cargo release --no-publish --dev-version --execute and let the github CD pipeline do the rest.