]> sjero.net Git - linphone/blob - README
update ms2
[linphone] / README
1 This is Linphone, a free (GPL) video softphone based on the SIP protocol.
2
3
4 ******************Building linphone ***********************************
5
6 - Install build time dependencies
7         - libtool
8         - intltool
9
10 - you need at least:
11         - libosip2>=3.5.0
12         - libeXosip2>=3.5.0
13         - speex>=1.2.0 (including libspeexdsp part)
14         
15         + if you want the gtk/glade interface:
16                 - libgtk >=2.16.0
17         + if you want video support:
18                 - libvpx (VP8 codec)
19                 - libavcodec (ffmpeg) 
20                 - libswscale (part of ffmpeg too) for better scaling performance
21                 - libxv (x11 video extension)
22                 - ligl1-mesa (OpenGL API -- GLX development files)
23                 - libglew (OpenGL Extension Wrangler library)
24                 - libv4l (Video for linux)
25                 - libx11 (x11)
26                 - theora (optional)
27         + gsm codec (gsm source package or libgsm-dev or gsm-devel) (optional)
28         + libreadline (optional: for convenient command line in linphonec)
29         + libsoup (optional: for wizard - account creation assistant)
30         + libsqlite3 (optional : for a local history of chat messages)
31         + if you want uPnP support (optional):
32                 - libupnp (version 1.6 branch (not patched with 18-url-upnpstrings.patch))
33
34         Here is the command line to get these dependencies installed for Ubuntu && Debian 
35
36         $ sudo apt-get install libtool intltool libgtk2.0-dev libosip2-dev libexosip2-dev libspeexdsp-dev libavcodec-dev libswscale-dev libx11-dev libvx-dev ligl1-mesa-dev libglew-dev libv4l-dev
37
38         + for optional library
39         $ sudo apt-get install libreadline-dev liggsm1-dev libtheora-dev libsoup2.4-dev libsqlit3-dev libupnp6-dev 
40         
41         + Install srtp (optional) for call encryption :
42                 $ git clone git://git.linphone.org/srtp.git
43                 $ cd srtp && autoconf && ./configure && make
44                 $ sudo make install
45
46         + Install zrtpcpp (optional), for unbreakable call encryption
47                 $ sudo apt-get install cmake libssl-dev
48                 $ git clone git://git.linphone.org/zrtpcpp.git
49                 $ cd zrtpcpp && cmake -Denable-ccrtp=false . && make
50                 $ sudo make install
51
52
53 - Compile linphone
54
55  $ ./autogen.sh
56  $ ./configure 
57  $ make && sudo make install 
58  $ sudo ldconfig
59
60
61
62 For windows compilation see README.mingw.
63 For macOS X, see README.macos
64
65
66 ******************************** notes for developers: *****************************
67
68 Here is a short description of the content of the source tree.
69
70 - oRTP/ is a poweful implementation of the RTP protocol. See the oRTP/README for more details. 
71         It is used by the mediastreamer to send and receive streams to the network.
72
73 - mediastreamer2/ is one of the important part of linphone. It is a framework library for audio 
74         and video processing. It contains several objects for grabing audio and video and outputing
75         it (through rtp, to file).
76         It contains also codec objects to compress audio and video streams.
77   The mediastream.h files contain routines to easyly setup audio streams.
78
79 - coreapi/ is the central point of linphone, which handles relationship between sip signalisation and media
80   streaming. It contains an easy to use api to create a sip phone.
81
82 - gtk/  is the directory that contains the gui frontend of linphone. It uses all libraries descibed above.
83
84 - console/
85         * linphonec.c is the main file for the console version of linphone.
86         * sipomatic.c / sipomatic.h contains the code for sipomatic, the test program that auto-answer to linphone calls.
87         * shell.c (program name: linphonecsh) is a small utilities to send interactive commands to a running linphonec daemon.
88                 
89 - share/ contains translation, documentation, rings and hello sound files.
90