summaryrefslogtreecommitdiff
path: root/lib/libavtp/README.md
blob: 4aa025b00d466bca34709b745c2d2f0f7daa5676 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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.