summaryrefslogtreecommitdiff
path: root/README
blob: b42d73066ed0de5ae5ee11a803aefb7c8f0f2b3e (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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

Nice: GLib ICE library
======================

Copyright
---------

 (C) 2006-2020 Collabora Ltd.
 (C) 2006-2011 Nokia Corporation

License
-------

See the file COPYING.

Requirements
------------

 glib >= 2.54
 pkg-config
 gnutls >= 2.12.0 or OpenSSL
 gupnp-igd >= 0.1.2 (optional)
 gstreamer-0.10 >= 0.10.0 (optional)
 gstreamer-1.0 (optional)

Build instructions
------------------

To build, you need Python 3 and Meson. Then need to do:
  meson build && ninja -C build && sudo ninja -C build install

Structure
---------

 agent/   - ICE agent
 docs/    - Design and API documentation
 gst/     - Gstreamer elements
 nice/    - libnice library
 random/  - random number generation
 socket/  - Socket abstraction layer
 stun/    - STUN implementation
 tests/   - Unit tests

Relevant standards
------------------

These standards are relevant to nice's current implementation.

ICE
  http://tools.ietf.org/html/rfc5245 (old)
  http://tools.ietf.org/html/rfc8445
STUN
  http://tools.ietf.org/html/rfc3489 (old)
  http://tools.ietf.org/html/rfc5389
TURN 
  http://tools.ietf.org/html/rfc5766
RTP
  http://tools.ietf.org/html/rfc3550
ICE-TCP RFC
  http://tools.ietf.org/html/rfc6544
Trickle ICE
   https://tools.ietf.org/html/draft-ietf-ice-trickle-21
XMPP Jingle ICE transport
  http://www.xmpp.org/extensions/xep-0176.html

In future, nice may additionally support the following standards.

NAT-PMP
  http://files.dns-sd.org/draft-cheshire-nat-pmp.txt