diff options
Diffstat (limited to 'lib/libavtp/README.md')
| -rw-r--r-- | lib/libavtp/README.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/lib/libavtp/README.md b/lib/libavtp/README.md new file mode 100644 index 00000000..4aa025b0 --- /dev/null +++ b/lib/libavtp/README.md @@ -0,0 +1,48 @@ +# About + +Open source implementation of Audio Video Transport Protocol (AVTP) specified +in IEEE 1722-2016 spec. + +Libavtp is under BSD License. For more information see LICENSE file. + +# Build + +Before building libavtp make sure you have all the required software installed +in your system. Below are the requirements and their tested versions: + +* Meson >= 0.43 +* Ninja >= 1.8.2 + +The first step to build libavtp is to generate the build system files. + +``` +$ meson build +``` + +Then build libavtp by running the following command. The building artifacts +will be created under the build/ in the top-level directory. + +``` +$ ninja -C build +``` + +To install libavtp on your system run: +``` +$ sudo ninja -C build install +``` + +# AVTP Formats Support + +AVTP protocol defines several AVTPDU type formats (see Table 6 from IEEE +1722-2016 spec). Libavtp doesn't support all of them yet. The list of supported +formarts is: +* AAF (PCM encapsulation only) + +# Examples + +The `examples/` directory in the top-level directory provides example +applications which demonstrate the libavtp functionalities. To build an +example application run `$ ninja -C build <example name>`. + +Information about what exactly each example application does and how it works +is provided in the beginning of the .c file from each application. |