| 1 |
|
| 2 |
Nice: GLib ICE library |
| 3 |
====================== |
| 4 |
|
| 5 |
Copyright |
| 6 |
--------- |
| 7 |
|
| 8 |
(C) 2006-2020 Collabora Ltd. |
| 9 |
(C) 2006-2011 Nokia Corporation |
| 10 |
|
| 11 |
License |
| 12 |
------- |
| 13 |
|
| 14 |
See the file COPYING |
| 15 |
|
| 16 |
SPDX-License-Identifier: LGPL-2.1-or-later OR MPL-1.1 |
| 17 |
|
| 18 |
Requirements |
| 19 |
------------ |
| 20 |
|
| 21 |
glib >= 2.56 |
| 22 |
pkg-config |
| 23 |
gnutls >= 3.6.0 or OpenSSL |
| 24 |
gupnp-igd >= 0.2.5 (optional) |
| 25 |
gstreamer-1.14 (optional) |
| 26 |
|
| 27 |
Build instructions |
| 28 |
------------------ |
| 29 |
|
| 30 |
libnice uses the Meson Build System: https://mesonbuild.com |
| 31 |
|
| 32 |
To build on Linux and Mac, you only need to type the usual commands : |
| 33 |
|
| 34 |
meson builddir |
| 35 |
ninja -C builddir |
| 36 |
ninja -C builddir test (or "meson test -C builddir" for more control) |
| 37 |
sudo ninja -C builddir install |
| 38 |
|
| 39 |
See https://mesonbuild.com/Quick-guide.html#compiling-a-meson-project |
| 40 |
for more details and how to install the Meson build system. |
| 41 |
|
| 42 |
Structure |
| 43 |
--------- |
| 44 |
|
| 45 |
agent/ - ICE agent |
| 46 |
docs/ - Design and API documentation |
| 47 |
gst/ - Gstreamer elements |
| 48 |
nice/ - libnice library |
| 49 |
random/ - random number generation |
| 50 |
socket/ - Socket abstraction layer |
| 51 |
stun/ - STUN implementation |
| 52 |
tests/ - Unit tests |
| 53 |
|
| 54 |
Relevant standards |
| 55 |
------------------ |
| 56 |
|
| 57 |
These standards are relevant to nice's current implementation. |
| 58 |
|
| 59 |
ICE |
| 60 |
https://tools.ietf.org/html/rfc5245 (old) |
| 61 |
https://tools.ietf.org/html/rfc8445 |
| 62 |
STUN |
| 63 |
https://tools.ietf.org/html/rfc3489 (old) |
| 64 |
https://tools.ietf.org/html/rfc5389 |
| 65 |
STUN Consent Freshness RFC |
| 66 |
https://tools.ietf.org/html/rfc7675 |
| 67 |
TURN |
| 68 |
https://tools.ietf.org/html/rfc5766 |
| 69 |
RTP |
| 70 |
https://tools.ietf.org/html/rfc3550 |
| 71 |
ICE-TCP RFC |
| 72 |
https://tools.ietf.org/html/rfc6544 |
| 73 |
Trickle ICE |
| 74 |
https://tools.ietf.org/html/draft-ietf-ice-trickle-21 |
| 75 |
XMPP Jingle ICE transport |
| 76 |
https://www.xmpp.org/extensions/xep-0176.html |
| 77 |
|
| 78 |
In future, nice may additionally support the following standards. |
| 79 |
|
| 80 |
NAT-PMP |
| 81 |
http://files.dns-sd.org/draft-cheshire-nat-pmp.txt |
| 82 |
|
| 83 |
|