Version 135 (Adrian Georgescu, 09/01/2008 05:07 pm)

1 133 Adrian Georgescu
[[Image(htdocs:SIPUA-design-70.png, align=right, link=wiki:SIPUADesign)]]
2 96 Ruud Klaver
3 96 Ruud Klaver
== Project description == 
4 95 Ruud Klaver
5 121 Adrian Georgescu
PyPjUA is Python software library for [ PJSIP] C SIP stack that together with a clever middleware allows for easy development of real-time communications end-points based on [ SIP protocol] with rich presence and IM capability that run on desktop computers running Mac OS X, Linux and Windows operating systems, portable devices like Nokia Internet tablet, Apple iPhone or Android mobile phone.
6 1
7 14 Adrian Georgescu
== Deliverables ==
8 1
9 135 Adrian Georgescu
The goal of this project is to deliver the best Open Source development kit for rich featured SIP User Agents while hiding the complex underlying functionality behind an easy to use high-level application programming interface. Compared to other available SIP libraries, this project adds both to the client and to the corresponding servers multiple media streams support, 'the missing' SIP-SIMPLE features for rich presence (presence rules, resource lists, rls services, rich PIDF, XCAP full and partial document manipulation) and session based interactive messaging based on MSRP protocol including relay support. 
10 47 Adrian Georgescu
11 130 Adrian Georgescu
The software library is tested against the most popular SIP server software available today: [ OpenSIPS], [ OpenXCAP] and [ MSRPRelay] servers. To test the software you can register a free SIP SIMPLE account on []. PyPjUA is part of a [wiki:SIPUADesign greater design] design to provide a fully fledged SIP UA. 
12 125 Adrian Georgescu
13 123 Adrian Georgescu
== Download  == 
14 123 Adrian Georgescu
15 123 Adrian Georgescu
The software library and command line tools will be available for download on 2008 Q4. 
16 123 Adrian Georgescu
17 123 Adrian Georgescu
The software will be available from: []
18 123 Adrian Georgescu
19 111 Adrian Georgescu
== End-user experiences ==
20 1
21 123 Adrian Georgescu
Using this software you are able to create elegant real-time communications applications without having to read or understand [ the +1200 RFC documents] behind it. 
22 1
23 123 Adrian Georgescu
''If you read them all some antidepressant and desintoxication is recommended after this effort.'' 
24 123 Adrian Georgescu
25 123 Adrian Georgescu
As a library with a high-level API, the toolkit can also be used to add SIP and Presence functionality to network devices without a display (like TV set-up boxes), as long as Python environment is supported by such platform. You may collapse the whole telecom industry into a simple ''Call me'' button or expand the presence buddy list to display the mood or blood pressure of your buddies (if they want to share this information with you). Some of the things possible with this library are listed here:
26 123 Adrian Georgescu
27 116 Adrian Georgescu
  * VoIP calls using Internet codecs (wide-band Speex, iLBC) and G.711 for compatibility with PSTN
28 116 Adrian Georgescu
  * Multiple RTP streams per session (for live broadcasting applications)
29 116 Adrian Georgescu
  * Session based IM with voice/video for rich end-to-end communications
30 120 Adrian Georgescu
  * Zero configuration when communicating over LAN (Bonjour)
31 1
  * Presence using SIP SIMPLE (PUBLISH, SUBSCRIBE, NOTIFY and XCAP policy)
32 111 Adrian Georgescu
  * Interactive Messaging (IM) and File transfer using MSRP protocol
33 111 Adrian Georgescu
  * Multiparty chat using MSRP chat server
34 116 Adrian Georgescu
  * Support for NAT traversal using ICE for RTP media and MSRP relay for IM and file transfer
35 111 Adrian Georgescu
  * Sharing desktop screen using VNC protocol
36 92 Ruud Klaver
  * Video calls
37 92 Ruud Klaver
38 34 Adrian Georgescu
== Software repository ==
39 34 Adrian Georgescu
40 88 Adrian Georgescu
Besides the Python software library itself, the repository contains the ready to use sip-simple-test-tools package that can be used to:
41 1
42 87 Adrian Georgescu
  * Setup SIP [ MSRP sessions] between end-points with public IP or behind NAT by using [ MSRP relay]
43 117 Adrian Georgescu
  * Setup up VoIP sessions between end-points with public IP adresses or behind NAT by using ICE or MediaProxy
44 34 Adrian Georgescu
  * [ PUBLISH] and [ SUBSCRIBE/NOTIFY to SIP events] like [ presence], [ xcap-diff], [ watcher-info], [ conference], [ message-summary]
45 112 Adrian Georgescu
  * Manage presence policy the form of full or partial [ XCAP] documents like [ pres-rules], [ resource-lists, rls-services] and [ pidf-manipulation]
46 112 Adrian Georgescu
  * Lookup of SIP buddies using [ Bonjour] (LAN broadcast), [ RFC 3263] (Locating SIP Services) and P2P overlays
47 71 Adrian Georgescu
  * Setup up [ ad-hoc multi-party chat sessions] with an MSRP chat server (under construction)
48 33 Adrian Georgescu
  * Alarms systems for SIP calls (VoIP sessions with RTP)
49 103 Adrian Georgescu
50 33 Adrian Georgescu
Using these scripts is easy to prototype [wiki:RichPresence Rich Presence], IM and VoIP services based on the SIP protocol. 
51 103 Adrian Georgescu
To use these tools you can use your own infrastructure or register a free SIP SIMPLE account on []
52 103 Adrian Georgescu
53 93 Adrian Georgescu
== License == 
54 82 Adrian Georgescu
55 62 Adrian Georgescu
The software is provided under the [source:LICENSE GPL LICENSE]
56 62 Adrian Georgescu
57 62 Adrian Georgescu
== Integration with third-party projects ==
58 62 Adrian Georgescu
59 80 Adrian Georgescu
PyPjUA will be first integrated into [ Tribler]. Tribler is an application that enables its users to find, enjoy and share content. With content we mean video, audio, pictures, and much more. PyPjUA will provides real-time communications features that will allow users that have downloaded Tribler to:
60 62 Adrian Georgescu
61 80 Adrian Georgescu
 * Interact in real time with each other using rich Presence, Interactive messaging and audio
62 70 Adrian Georgescu
 * Communicate with other people that have access to SIP services from various SIP operators across the world
63 12 Adrian Georgescu
64 1
== Developer program ==
65 1
66 17 Adrian Georgescu
To become an active developer to this program please send your request by email to []
67 103 Adrian Georgescu
68 105 Adrian Georgescu
We are looking for developers that can contribute with the following features: VNC desktop sharing, implementation for video sessions and real time text sessions (real time text using RTP [ ToIP (RFC 4103)] and MSRP).
69 17 Adrian Georgescu
70 12 Adrian Georgescu
== Support == 
71 11 Adrian Georgescu
72 11 Adrian Georgescu
The software is developed and supported by [ AG Projects].