README 2.22 KB
Newer Older
aymeric's avatar
aymeric committed
1 2 3
What is it ?
************

4
oRTP is a GPLv2 licensed C library implementing the RTP protocol (rfc3550). It is available
aymeric's avatar
aymeric committed
5 6
for most unix clones (primilarly Linux and HP-UX), and Microsoft Windows.

7 8 9 10 11
Prior to version 1.0.0, oRTP was licensed under LGPLv2. Due to inclusion of new code licensed under GPLv2, oRTP has become GPLv2.
For the sake of clarity, all source files headers were updated to mention the GPLv2 only.
oRTP versions prior to 1.0.0 of course remain LGPLv2.


aymeric's avatar
aymeric committed
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
What are the build prequisites ?
********************************
libc library and header files.

How do you I test ?
*******************

There are shorts and easy to understand programs given with the library. There are good example
to understand how to use oRTP api.
- rtpsend : sends a stream from a file on disk.
- rtprecv : receives a stream and writes it to disk.
- mrtpsend: sends multiple streams from a file on disk to a range of remote port.
- mrtprecv:	receives mutiple streams on a range of local ports and writes them on disk.


Is there some documentation ?
*****************************

See the doxygen generated API documentation in docs/html. Program examples are a very good
starting point.


What are the current features ?
******************************
	- works with ipv6
	- packet scheduler
	- adaptive jitter compensation
	- automatic sending of RTCP SR or RR coumpounded with a SDES
	- RTCP parser API


What are the planned features ?
*******************************
	- multi-endpoint rtp sessions.


In which application oRTP is being used ?
*****************************************
	- linphone (http://www.linphone.org) was the first.
	- the OCMP platform (a Hewlett Packard product).

How to compile my program using ortp ?
**************************************
jehan's avatar
jehan committed
55 56 57 58

with cmake, use find_package(ORTP)

with pkgconfig:
aymeric's avatar
aymeric committed
59 60 61 62 63 64 65 66
gcc -o myprogram  `pkg-config --cflags ortp` myprogram.c  \
			`pkg-config --libs ortp`


What about Windows port ?
*************************
There are instructions and Microsoft Visual C++ project files in build/win32native/oRTP.

jehan's avatar
jehan committed
67 68 69 70 71 72 73 74
Rpm packaging
************************
ortp rpm can be generated with cmake3 using the following command:
mkdir WORK
cd WORK
cmake3 ../
make package_source
rpmbuild -ta --clean --rmsource --rmspec ortp-<version>-<release>.tar.gz