README 1.43 KB
Newer Older
1 2

Nice: GLib ICE library
3
======================
4

Dafydd Harries's avatar
Dafydd Harries committed
5 6
Copyright
---------
7

Olivier Crête's avatar
Olivier Crête committed
8
 (C) 2006-2020 Collabora Ltd.
Youness Alaoui's avatar
Youness Alaoui committed
9
 (C) 2006-2011 Nokia Corporation
10

Dafydd Harries's avatar
Dafydd Harries committed
11 12
License
-------
13

Dafydd Harries's avatar
Dafydd Harries committed
14
See the file COPYING.
15

16 17
Requirements
------------
18

19
 glib >= 2.54
20
 pkg-config
21
 gnutls >= 2.12.0 or OpenSSL
Youness Alaoui's avatar
Youness Alaoui committed
22 23
 gupnp-igd >= 0.1.2 (optional)
 gstreamer-0.10 >= 0.10.0 (optional)
Olivier Crête's avatar
Olivier Crête committed
24
 gstreamer-1.0 (optional)
25

26 27 28
Build instructions
------------------

Olivier Crête's avatar
Olivier Crête committed
29 30
To build, you need Python 3 and Meson. Then need to do:
  meson build && ninja -C build && sudo ninja -C build install
31

32 33 34
Structure
---------

Youness Alaoui's avatar
Youness Alaoui committed
35 36 37 38
 agent/   - ICE agent
 docs/    - Design and API documentation
 gst/     - Gstreamer elements
 nice/    - libnice library
39
 random/  - random number generation
Youness Alaoui's avatar
Youness Alaoui committed
40
 socket/  - Socket abstraction layer
41
 stun/    - STUN implementation
Youness Alaoui's avatar
Youness Alaoui committed
42
 tests/   - Unit tests
43

44 45 46 47 48
Relevant standards
------------------

These standards are relevant to nice's current implementation.

Olivier Crête's avatar
Olivier Crête committed
49 50 51
ICE
  http://tools.ietf.org/html/rfc5245 (old)
  http://tools.ietf.org/html/rfc8445
52
STUN
Olivier Crête's avatar
Olivier Crête committed
53
  http://tools.ietf.org/html/rfc3489 (old)
54
  http://tools.ietf.org/html/rfc5389
55
TURN 
Marcus Lundblad's avatar
Marcus Lundblad committed
56
  http://tools.ietf.org/html/rfc5766
57 58
RTP
  http://tools.ietf.org/html/rfc3550
Olivier Crête's avatar
Olivier Crête committed
59 60 61 62
ICE-TCP RFC
  http://tools.ietf.org/html/rfc6544
Trickle ICE
   https://tools.ietf.org/html/draft-ietf-ice-trickle-21
63 64 65 66 67 68 69
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
Marcus Lundblad's avatar
Marcus Lundblad committed
70

71