A set of open source libraries for controlling AVB entities using the AVDECC (IEEE 1722.1) protocol compliant to Avnu Milan Specifications
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmake Added a new cmake configured variable Feb 4, 2019
doc
examples
externals/3rdparty Updated gtest version to fix compilation issues with latest VS Oct 5, 2018
include/la/avdecc
resources/win32
scripts
src Only accepting Milan protocol_version 1 Feb 12, 2019
tests
.clang-format ClangFormat and documentation Oct 5, 2018
.editorconfig
.gitattributes
.gitignore
.gitmodules
CHANGELOG-avdecc.md Merge branch 'dev' Feb 13, 2019
CHANGELOG-controller.md
CMakeLists.txt
CODING_STYLE_GUIDELINES.md Updated scripts and guidelines Jan 1, 2019
CONTRIBUTING.md
COPYING
COPYING.LESSER
LICENSE
README.md
clang-7.0.0-BraceWrappingBeforeLambdaBody.patch
fix_files.sh
gen_cmake.sh

README.md

LA AVDECC

Coverity Scan Build Status

Copyright (C) 2016-2019, L-Acoustics and its contributors

What is LA_avdecc

LA_avdecc is a set of open source libraries for controlling and monitoring AVB entities using the AVDECC protocol (IEEE 1722.1) compliant to Avnu Milan.

These libraries are written in pure C++17. They can be compiled on Windows, Linux and macOS, using standard development tools (procedure below). Unit tests and sample programs are also provided.

These libraries have already been used indirectly in many musical events throughout the world to control all kinds of AVB entities (list below). L-Acoustics' Network Manager 2.5 (and up) now relies on them for all its AVDECC functionalities in compliance to the Avnu Milan Specifications.

Another benefit is the support of Apple’s native API, which allows control of the input and output AVB streams of a Mac from itself (which is not possible with the libraries using PCAP).

We use GitHub issues for tracking requests and bugs.

Optional dependencies:

Tested AVB entities:

  • L-Acoustics: LA4X, LA12X, P1
  • Biamp: Tesira Forte
  • Avid: S6L
  • MOTU: 112D, 828, Traveller, StageBox16
  • MeyerSound: Galileo GALAXY, CAL
  • QSC: Q-SYS Cores
  • Apple: macOS Talker, Listener and Controller (El Capitan and later)
  • AudioScience: Hono AVB Mini

la_avdecc library

Implementation of the IEEE Std 1722.1-2013 specification.
Also implementing non-released IEEE Std 1722.1 corrigendum 1 draft 8. Also implementing AVnu Alliance Milan. Also implementing AVnu Alliance Network Redundancy.

The library exposes APIs needed to create AVDECC entities on the local computer, and to interact with other entities on the network.

la_avdecc_controller library

This is a simple library to create an AVDECC controller entity on the local computer. This controller automatically listens to and keeps track of the other entities on the network using the IEEE Std 1722.1 protocol.

The controller API has 2 interfaces:

  • An observer interface to monitor all changes on discovered entities
  • An interaction interface to send enumeration and control (AECP) or connection management (ACMP) requests to an entity

Minimum requirements for compilation

All platforms

  • CMake 3.12

Windows

  • Windows 8.1
  • Visual Studio 2017 v15.8 or greater (using platform toolset v141)
  • WinPcap 4.1.2 Developer's Pack (see this file for more details)
  • GitBash or cygwin

macOS

  • macOS 10.12
  • Xcode 10

Linux

  • C++17 compliant compiler
  • Make
  • pcap developer package
  • ncurses developer package (optional, for examples)

Compilation

All platforms

  • Clone this repository
  • Update submodules: git submodule update --init

Windows

  • Install WinPcap Developer's Pack
  • Using the provided bash script (gen_cmake.sh):
    • Run the script with whatever optional parameters required (run gen_cmake.sh -h to display the help)
    • Go into the generated output folder (_build_x86 by default)
    • Open the generated Visual Studio solution LA_avdecc.sln
    • Compile everything from Visual Studio
  • Manually issuing a CMake command:
    • Run a proper CMake command to generate a Visual Studio solution (or any other CMake generator matching your build toolchain)
    • Open the generated Visual Studio solution (or your other CMake generated files)
    • Compile everything from Visual Studio (or compile using your toolchain)

macOS

  • Using the provided bash script (gen_cmake.sh):
    • Run the script with whatever optional parameters required (run gen_cmake.sh -h to display the help)
    • Go into the generated output folder (_build_x86_64-apple-darwinX.Y.Z by default)
    • Open the generated Xcode solution LA_avdecc.xcodeproj
    • Compile everything from Xcode
  • Manually issuing a CMake command:
    • Run a proper CMake command to generate a Xcode solution (or any other CMake generator matching your build toolchain)
    • Open the generated Xcode solution (or your other CMake generated files)
    • Compile everything from Xcode (or compile using your toolchain)

Linux

  • Using the provided bash script (gen_cmake.sh):
    • Run the script with either -debug or -release and whatever optional parameters required (run gen_cmake.sh -h to display the help)
    • Go into the generated output folder (_build_x86_64-linux-gnu by default)
    • Run make to compile everything
  • Manually issuing a CMake command:
    • Run a proper CMake command to generate Unix Makefiles (or any other CMake generator matching your build toolchain)
    • Go into the folder where the Unix Makefiles have been generated
    • Run make to compile everything (or compile using your toolchain)

Known limitations

  • [Windows only] When plugging in a USB ethernet card for the first time, you either have to reboot the computer or restart the WinPCap driver (net stop npf then net start npf, from an elevated command prompt)

Upcoming features

  • Better unit testing using a virtual protocol interface and virtual entities
  • Ability to preload AEMXML files, and not enumerate AEM for devices with identical vendorEntityModelId
  • Talker and Listener state machines (low level library)
  • Creation of a DiscoveryStateMachine so it can be used by Talker/Listener entities (moving code out of ControllerStateMachine)
  • Wrapper libraries:
    • C (public APIs only)
    • Lua (public and private APIs)

Contributing code

Please read this file

Trademark legal notice

All product names, logos, brands and trademarks are property of their respective owners. All company, product and service names used in this library are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.