WikiStart

Version 153 (Adrian Georgescu, 09/10/2008 07:19 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 141 Adrian Georgescu
PyPjUA is Python software library for [http://pjsip.org PJSIP] C SIP stack that together with an elegant middleware allows for easy development of real-time communications end-points based on [http://tools.ietf.org/html/rfc3261 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 152 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 open-source 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 using MSRP protocol. 
10 47 Adrian Georgescu
11 146 Adrian Georgescu
The software library is tested against the most popular SIP server software available today: [http://opensips.org OpenSER], [http://openxcap.org OpenXCAP], [http://msrprelay.org MSRPRelay] and [http://mediaproxy-ng.org MediaProxy]. 
12 138 Adrian Georgescu
13 153 Adrian Georgescu
To test the software, you can register a SIP account on [http://SIP2SIP.info http://sip2sip.info] that provides all server side features available in the client. 
14 125 Adrian Georgescu
15 123 Adrian Georgescu
== Download  == 
16 123 Adrian Georgescu
17 140 Adrian Georgescu
The software library and command line tools will be available for download on 2008 Q4 from: 
18 123 Adrian Georgescu
19 140 Adrian Georgescu
[http://download.ag-projects.com/PyPjUA http://download.ag-projects.com/PyPjUA]
20 123 Adrian Georgescu
21 111 Adrian Georgescu
== End-user experiences ==
22 1
23 123 Adrian Georgescu
Using this software you are able to create elegant real-time communications applications without having to read or understand [http://www.rfc3261.net the +1200 RFC documents] behind it. 
24 1
25 123 Adrian Georgescu
''If you read them all some antidepressant and desintoxication is recommended after this effort.'' 
26 123 Adrian Georgescu
27 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:
28 123 Adrian Georgescu
29 147 Adrian Georgescu
  * VoIP calls using Internet codecs (wide-band Speex, iLBC) and G.711
30 142 Adrian Georgescu
  * Zero configuration server-less communication over LAN (Bonjour)
31 1
  * Presence using SIP SIMPLE (PUBLISH, SUBSCRIBE, NOTIFY and XCAP policy)
32 1
  * Interactive Messaging (IM) and File transfer using MSRP protocol
33 1
  * Multiparty chat using MSRP chat server
34 111 Adrian Georgescu
  * Support for NAT traversal using ICE and MediaProxy for RTP media and MSRP relay for IM and file transfer
35 147 Adrian Georgescu
  * Sharing desktop screen using VNC protocol (under construction)
36 147 Adrian Georgescu
  * Video calls (under construction)
37 1
38 147 Adrian Georgescu
== Testing the library ==
39 34 Adrian Georgescu
40 150 Adrian Georgescu
Besides the Python software library itself, the repository contains ready to use command-line examples scripts for Linux and MacOSX that can be used to:
41 87 Adrian Georgescu
42 147 Adrian Georgescu
  * Setup IM or file-transfer ([http://tools.ietf.org/html/rfc4975 MSRP sessions]) with or without support from a [http://tools.ietf.org/html/rfc4976 MSRP relay]
43 147 Adrian Georgescu
  * Setup up VoIP sessions using speex wide-band codec
44 148 Adrian Georgescu
  * [http://tools.ietf.org/html/rfc3903 PUBLISH], SUBSCRIBE and handle incoming NOTIFY for [http://tools.ietf.org/html/rfc3265 SIP events] [http://tools.ietf.org/html/rfc3856 presence], [http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-09.txt xcap-diff], [http://tools.ietf.org/html/rfc3857 watcher-info], [http://tools.ietf.org/html/rfc4575 conference], [http://tools.ietf.org/html/rfc3842 message-summary]
45 147 Adrian Georgescu
  * Manage [http://www.tools.ietf.org/html/rfc4825 XCAP] documents [http://www.tools.ietf.org/html/rfc5025 pres-rules], [http://www.tools.ietf.org/html/rfc4826 resource-lists, rls-services] and [http://www.tools.ietf.org/html/rfc4827 pidf-manipulation]
46 148 Adrian Georgescu
  * Lookup of SIP buddies using [http://www.tech-invite.com/SIPWGs/01-WG-SIP/Idrafts/draft-lee-sip-dns-sd-uri-02.txt Bonjour] (LAN broadcast), [http://tools.ietf.org/html/rfc3263 RFC 3263] (Locating SIP Services)
47 151 Adrian Georgescu
  * Setup up [http://tools.ietf.org/html/draft-ietf-simple-chat-02 ad-hoc multi-party chat sessions] with an MSRP chat server (under construction)
48 103 Adrian Georgescu
49 33 Adrian Georgescu
Using these scripts is easy to prototype [wiki:RichPresence Rich Presence], IM and VoIP services based on the SIP protocol. 
50 103 Adrian Georgescu
To use these tools you can use your own infrastructure or register a free SIP SIMPLE account on [http://sip2sip.info http://SIP2SIP.info]
51 103 Adrian Georgescu
52 93 Adrian Georgescu
== License == 
53 82 Adrian Georgescu
54 62 Adrian Georgescu
The software is provided under the [source:LICENSE GPL LICENSE]
55 62 Adrian Georgescu
56 62 Adrian Georgescu
57 1
== Developer program ==
58 1
59 17 Adrian Georgescu
To become an active developer to this program please send your request by email to [mailto:pypjua-devel@ag-projects.com pypjua-devel@ag-projects.com]
60 103 Adrian Georgescu
61 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 [http://www.ietf.org/rfc/rfc4103.txt ToIP (RFC 4103)] and MSRP).