README 2.12 KB
Newer Older
1 2 3
This is Linphone, a free (GPL) video softphone based on the SIP protocol.


4
******************Building linphone ***********************************
aymeric's avatar
aymeric committed
5 6 7
- you need at least:
		- libosip2>=3.0.3
		- libeXosip2>=3.0.3
Simon Morlat's avatar
Simon Morlat committed
8 9
		- speex>=1.2.0 (including libspeexdsp part)
		- libreadline (optional: for convenient command line in linphonec)
aymeric's avatar
aymeric committed
10
	+ gsm codec (gsm source package or libgsm-dev or gsm-devel) (optional)
11 12
	+ if you want to gtk/glade interface:
		- gtk>=2.16.0
aymeric's avatar
aymeric committed
13 14
	+ if you want video support:
		- SDL>=1.2.10
Simon Morlat's avatar
Simon Morlat committed
15
		- libavcodec (ffmpeg) 
16
		- libswscale (part of ffmpeg too) for better scaling performance
Simon Morlat's avatar
Simon Morlat committed
17
		- theora (optional)
18 19
	+ if you want uPnP support:
		- libupnp
aymeric's avatar
aymeric committed
20 21 22

with their corresponding -dev or -devel package if you don't use source packages.

23 24
For windows compilation see README.mingw.
For macOS X, see README.macos
aymeric's avatar
aymeric committed
25 26


27
******************************** notes for developers: *****************************
aymeric's avatar
aymeric committed
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42

Here is a short description of the content of the source tree.

- oRTP/ is a poweful implementation of the RTP protocol. See the oRTP/README for more details. 
	It is used by the mediastreamer to send and receive streams to the network.

- mediastreamer2/ is one of the important part of linphone. It is a framework library for audio 
	and video processing. It contains several objects for grabing audio and video and outputing
	it (through rtp, to file).
	It contains also codec objects to compress audio and video streams.
  The mediastream.h files contain routines to easyly setup audio streams.

- coreapi/ is the central point of linphone, which handles relationship between sip signalisation and media
  streaming. It contains an easy to use api to create a sip phone.

Simon Morlat's avatar
Simon Morlat committed
43
- gtk/	is the directory that contains the gui frontend of linphone. It uses all libraries descibed above.
aymeric's avatar
aymeric committed
44 45 46

- console/
	* linphonec.c is the main file for the console version of linphone.
47 48
	* sipomatic.c / sipomatic.h contains the code for sipomatic, the test program that auto-answer to linphone calls.
	* shell.c (program name: linphonecsh) is a small utilities to send interactive commands to a running linphonec daemon.
aymeric's avatar
aymeric committed
49 50 51
		
- share/ contains translation, documentation, rings and hello sound files.