wiki:0.9/ReleaseNotes

Version 1 (modified by bennylp, 16 years ago) (diff)

--

Release 0.9

New Features and Enhancements

Many new features have been implemented on this release.

Audio quality improvements

This release contains many improvements to stability, latency, and in general quality of audio:

  • Implementation of Waveform Similarity Based Overlap-Add (WSOLA) algorithm (ticket #497) which provides the base algorithm for buffer expansion/compression and packet loss concealment.
  • Ticket #438 fixed many problems related to audio impairments:
    • fixed the click noise produced by splitcomb or conference bridge upon underflow/overflow situation (which normally happens when there is drift in audio device)
    • much better buffering in splitcomb and conference bridge, with the ability to learn the optimal buffer length and shrinking/extending the buffer as necessary without degrading audio quality too much.
  • New conference mixing algorithm which does not weaken the signal unlike to old algorithm (ticket #449)
  • New packet loss concealment for G.711 and GSM codec (ticket #502)
  • Boost the priority of master port/splitcomb to avoid audio disruption because of CPU usage (ticket #501)
  • Optimize the delay in the jitter buffer (ticket #505)
  • Much better stereo support all the way, including support for mixing ports with different channel number in the conference bridge (ticket #504)

Secure RTP (SRTP)

SRTP have been implemented and it is available for all platforms including Symbian and Windows Mobile. The implementation uses libsrtp, and SDES is used for the key exchange.

G.722 codec

The G.722 codec is now included in the standard source distribution and it is available for all platforms.

TURN Relay support

TURN has been implemented. The implementation is based on draft-ietf-behave-turn-07 draft and with the default settings should be compatible with the newly released draft-ietf-behave-turn-08 draft.

In addition to integration with ICE all the way up to PJSUA-LIB and pjsua sample application, simple command line TURN client and server implementation samples are provided.

ICE enhancements

The SDP offer/answer procedures related to ICE have been enhanced and should now comply to the latest draft-ietf-mmusic-ice-19 draft.

IPv6 Support

Support for IPv6 has been added in PJLIB, PJSIP, and PJMEDIA libraries. However some features are still missing, such as asynchronous DNS AAAA resolution and IPv6 support in pjsua sample application.

RTCP XR support

Support for subset of RTCP XR (RFC 3611) has been implemented (see ticket #513)

Improved Windows Mobile sample application

A new and more usable sample application !PocketPJ has been provided for !PocketPC/Windows Mobile based platforms.

Improved Symbian support

Carbide C++ is now supported, and a tutorial on developing PJSIP application with Carbide C++ is provided. More codecs have been ported to Symbian, including GSM and Speex.

ActiveSocket Framework

The new ActiveSocket framework in PJLIB provides higher and easier to use abstraction to create asynchronous sockets, utilizing PJLIB's ioqueue.

More Thorough Tests

Last but not least, in addition to existing tests for each library, 100+ automated test scripts have been added to test PJSUA-LIB to test functionality, conformance, and quality of various parts of the library.



(In)Compatibility Info

PJLIB

Config (config.h):
  • New settings:
    • PJ_HAS_IPV6 (default 0)
    • PJ_IOQUEUE_DEFAULT_ALLOW_CONCURRENCY
    • PJ_FD_SETSIZE_SETABLE
Math and statistic functions (math.h):
  • New file
Socket (sock.h):
  • The struct pj_in6_addr has been changed to union pj_in6_addr.
  • Member names changes in struct pj_sockaddr_in6.
  • New functions:
    • pj_sockaddr_init()
    • pj_inet_pton()
    • pj_inet_ntop()
    • pj_inet_ntop2()
    • pj_sockaddr_print()
    • pj_sockaddr_cmp()
    • pj_sockaddr_get_addr()
    • pj_sockaddr_has_addr()
    • pj_sockaddr_get_addr_len()
    • pj_sockaddr_get_len()
    • pj_sockaddr_copy_addr()
    • pj_sockaddr_cp()
    • pj_sockaddr_set_str_addr()
    • and pj_sockaddr_get_port()
  • New constants:
    • PJ_INET_ADDRSTRLEN
    • PJ_INET6_ADDRSTRLEN.
ActiveSocket (activesock.h.h):
  • New file
Address resolution (addr_resolv.h):
  • pj_gethostip() now takes additional address family parameter
  • New functions:
    • pj_getdefaultipinterface()
    • pj_getaddrinfo()
String (string.h):
  • New functions:
    • pj_strstr()
    • pj_stristr()
Thread (os.h):
  • New functions:
    • pj_thread_get_prio()
    • pj_thread_set_prio()
    • pj_thread_get_prio_min()
    • pj_thread_get_prio_max()
    • pj_thread_get_os_handle()
IP Helper (ip_helper.h):
  • The pj_enum_ip_interface() now takes additional address family parameter
IOqueue (ioqueue.h):
  • New functions:
    • pj_ioqueue_set_default_concurrency()
    • pj_ioqueue_set_concurrency()
    • pj_ioqueue_lock_key()
    • pj_ioqueue_unlock_key()

PJLIB-UTIL

DNS Server (dns_server.h):
  • New file
PCAP File Format Support (pcap.h):
  • New file
DNS (dns.h):
  • New helper functions:
    • pj_dns_init_srv_rr()
    • pj_dns_init_cname_rr()
    • pj_dns_init_a_rr()

PJNATH

Transport Independent TURN Session (turn_session.h):
  • New file
TURN Client Socket/Transport (turn_sock.h):
  • New file
STUN Client Socket/Transport (stun_sock.h):
  • New file
ICE Stream Transport (ice_strans.h):
  • Initialization sequence has changed. Now all required parameters (STUN and TURN settings) are wrapped in struct pj_ice_strans_cfg and passed to pj_ice_strans_create(). The pj_ice_strans_set_stun_domain() and pj_ice_strans_set_stun_srv() functions have been removed.
  • The struct pj_ice_strans is no longer visible in the API, and various accessor functions have been added
STUN Authentication (stun_auth.h):
  • API change
Transport Independent STUN Session (stun_session.h):
  • Changes to all API's
STUN Messaging (stun_msg.h):
  • Addition and removal of STUN methods and attributes to support latest STUN, TURN, and ICE drafts.
  • Minor changes to parameter types in pj_stun_msg_encode()
  • Minor changes to parameter types in pj_stun_msg_check()
  • Minor changes to parameter types in pj_stun_msg_decode()
  • New functions:
    • pj_stun_msg_init()
    • pj_stun_msg_clone()
    • pj_stun_attr_clone()
    • pj_stun_sockaddr_attr_init()
    • pj_stun_string_attr_init()
    • pj_stun_binary_attr_init()
Transport Independent ICE Session (ice_sess.h):
  • The addition of transport_id parameter in:
    • pj_ice_sess_add_cand()
    • pj_ice_sess_on_rx_pkt()
    • on_tx_pkt() callback
    • on_rx_data() callback
Configuration (config.h):
  • New settings:
    • PJ_STUN_SOCK_PKT_LEN
    • PJ_STUN_KEEP_ALIVE_SEC
    • PJ_TURN_MAX_DNS_SRV_CNT
    • PJ_TURN_MAX_PKT_LEN
    • PJ_TURN_PERM_TIMEOUT
    • PJ_TURN_CHANNEL_TIMEOUT
    • PJ_TURN_REFRESH_SEC_BEFORE
    • PJ_TURN_KEEP_ALIVE_SEC
    • PJ_ICE_COMP_BITS
    • PJ_ICE_CAND_TYPE_PREF_BITS
    • PJ_ICE_LOCAL_PREF_BITS
  • New settings to control pool size:
    • PJNATH_POOL_LEN_ICE_SESS
    • PJNATH_POOL_INC_ICE_SESS
    • PJNATH_POOL_LEN_ICE_STRANS
    • PJNATH_POOL_INC_ICE_STRANS
    • PJNATH_POOL_LEN_NATCK
    • PJNATH_POOL_INC_NATCK
    • PJNATH_POOL_LEN_STUN_SESS
    • PJNATH_POOL_INC_STUN_SESS
    • PJNATH_POOL_LEN_STUN_TDATA
    • PJNATH_POOL_INC_STUN_TDATA



Known Issues

Apart from general known issues documented in Known-Issues, there is a specific issue related to ICE on Symbian, as it raises E32USER CBase 46 exception.


List of Enhancements

common

#434
Fixed configurations to build Symbian for device target
#435
Fixed and tested audio on Symbian device
#465
New utility to read RTP packets/payload from PCAP file

pjlib

#412
Increase the randomness of guid_simple
#414
Implement IP interface enumeration on Linux/Unix
#415
IPv6 support in PJLIB
#417
Expose the native thread handle for applications
#474
Option in the ioqueue to control concurrency (allow/disallow multiple/simultaneous callback calls)
#500
Added function to set thread priority in PJLIB

pjlib-util

#419
IPv6 support in DNS resolvers
#537
Simple DNS Server class (for testing)

pjnath

#485
Support for new TURN draft (TURN-07) and latest ICE draft (ICE-19)

pjmedia

#61
Support for SRTP
#420
IPv6 support in PJMEDIA
#438
Workaround for frame bursts and drifts from audio devices
#445
Added codec encoding/decoding sample
#446
Added sample application to mix WAV files using conference bridge
#449
New conference mixing algorithm
#468
Support for non-looping playback in memory player
#475
GSM codec on Symbian
#479
Allow transport framework to return transport specific info
#494
Configuration option to use high quality tone generation
#497
Waveform Similarity Based Overlap-Add (WSOLA) implementation
#501
Set master port worker thread priority to highest by default
#502
New packet lost concealment (PLC) implementation
#505
Optimize delay of current jitter buffer
#507
G.722 codec implementation and support
#511
Add --disable-oss option to disable OSS in configure script
#513
Support for RTCP XR
#523
Handle imprecise audio frame from sound device (e.g. OSS)
#524
Change base audio frame time from 10ms to 20ms for better stability
#527
More lenient SDP negotiator
#528
Customizable destination address of RTCP delivery in pjmedia transport
#535
Add mathematics & statistics module.
#546
Send RTCP SDES and RTCP BYE

pjsip

#7
Move PJSIP compile time configurations/settings (such as T1, T2 timers) to run-time (thanks Philippe Leuba)
#416
Allow application to handle sending ACK manually
#421
IPv6 support in PJSIP
#424
Added API to retrieve number of transactions and dialogs (thanks Sergey Bakulin)
#498
Option in client registration to ignore Contact address in REGISTER response
#534
Client register/registration support for various registrar brokenness

pjsua-lib

#455
Allocate call id in round robin fashion
#489
New PJSUA callbacks to notify application when media stream is created and destroyed
#495
Ability to specify different clock rate when opening sound device in PJSUA-LIB
#515
Update Contact header in REGISTER for TCP/TLS transport (thanks Klaus Darilion)

applications

#462
Playback of PCAP file
#493
PocketPJ: a new and better sample application for PocketPC
#543
Test framework for pjsua

List of Bugs

common

#458
PJ_ERESOLVE error in Windows Mobile
#549
Modification in media transport API to support more offer/answer scenarios

pjlib

#436
IPv6 support in host resolver caused failure in pjlib initialization on Symbian
#440
pj_timer_entry_init() doesn't initialize timer ID
#470
Compile error when <semaphore.h> is not present
#471
Compilation error if pthread_mutexattr_set_type() is not present
#472
Problem with setting up FD_SETSIZE
#512
Bug in select ioqueue causing unnecessary sleep() to be invoked (thanks Sergey Bakulin)
#520
Race condition may cause ioqueue corruption (thanks Philippe Leuba)
#531
Active socket abstraction to make ioqueue programming easier

pjlib-util

#425
pjstun_get_mapped_addr() failed when receiving incoming SIP request (thanks Lafras Henning)

pjnath

#437
Stack overflow in ICE on Symbian phone target
#519
STUN request is not freed when transaction times out (thanks Amit Sharma)

pjmedia

#427
Conference bridge doesn't handle NONE frame (thanks Daniel Braun)
#428
Conference bridge does not update transmitter_cnt when port is removed
#433
Failure in media negotiation when SDP contains two audio media lines (thanks Arie Velthoen)
#439
Encoder is called for FRAME_TYPE_NONE
#441
Fix endianess detection for PortAudio
#444
Bug in tone generator: can't play more digits (thanks Marian Dragomir)
#447
WAV player cuts last data from the WAV file
#448
PJSIP rejects incoming call with 415/Unsupported Media Type for INVITE containing video (thanks Alain Totouom)
#451
Updated PortAudio to the latest revision
#459
pjmedia_clock_create() should not create thread when PJMEDIA_CLOCK_NO_ASYNC is given (thanks Alberto Takeshi Mayama)
#460
Concurrency problem when destroying stream (thanks Michael Broughton)
#464
Jitter buffer should return length information
#467
RTP/AVP vs RTP/SAVP negotiation
#469
Loop forever than UDP media transport is destroyed while callback is running
#473
Speex version upgrade and handling multiple speex audio frames
#478
Handle duplicated/misordered incoming DTMF packets
#480
PJSIP rejects incoming call with m=image in the offer (thanks Thiago)
#483
Problems with using multiple sound devices (with splitcomb) with PJSUA-LIB
#486
Handle G.722 wong clock rate bug and other codec with inconsistent clock rate
#487
Crash occured when stream port has no transmitter on call using ILBC with different ptime
#496
Crash on sound port when only player is opened and delaybuf enabled
#499
NULL frame transmission in conference bridge is not clocked at the right interval
#504
Fixed support for stereo audio all the way in pjmedia
#516
Assertion in sound device when headset is plugged/unplugged in MacOS X (thanks Alexei Kuznetsov)
#517
Invalid argument error when binding media transport on MacOS X (thanks Daniel Mikusa)
#526
Pjsua crash after wav player destroyed inside the eof callback (thanks Tanguy Floc'h)
#536
Resample may overwrite past destination buffer (thanks Paweł Kierski)
#542
Enable setting sound device latency at runtime.

pjsip

#418
Protect client registration session (regc) with mutex
#423
Client registration (pjsip_regc) doesn't obey explicit transport selection (thanks Hitesh)
#426
Respond incoming CANCEL with no matching INVITE with 481 (thanks Sergey Bakulin)
#431
Empty Authorization header is not removed when the actual header is sent
#481
Default TLS version should be TLSv1 (thanks Klaus Darilion)
#482
TCP keep-alive packets are corrupting SIP message (thanks Helmut Wolf)
#488
When outgoing request within dialog is responded with 481 or 408, should send BYE after terminating dialog (thanks Philippe Leuba)
#491
Crash in TCP/TLS transport when the listener is destroyed (thanks Christian Grigis)
#492
Bug in strict route processing when challenged with 401/407 response (thanks Klaus Darilion)
#514
Bug with handling simultaneous re-INVITE (thanks Philippe Leuba)
#521
Duplicate Authorization header when PJSIP is configured to send empty Authorization header (thanks Roland Klabunde)
#533
Support for parsing Retry-After header
#550
PRACK is not re-sent on 401/407 challenge (thanks Josh Benson)

pjsua-lib

#429
Failed to create RTP/RTCP sockets when explicit bind address is specified (thanks Arie Velthoen)
#443
Overflow in dump_media_session() (thanks Simon Farmer)
#453
Log level is not set in PJSUA-LIB (thanks Simon Farmer)
#522
Enable keep-alive for UDP transport even when STUN is not configured
#525
Crash on call update or re-invite (Thanks Alexey)
#540
Shutdown the sound device when the media flow is idle
#544
RTP/AVP/SAVP negotiation on UPDATE/re-INVITE

applications

#430
Added --auto-update-nat, --use-compact-form, and --dis-codec options in pjsua (thanks Lafras Henning)
#477
DTMF digit callback error in Python