Adding documentation on the T.140 support in Asterisk. This is a function that we're
[asterisk/asterisk.git] / doc / realtimetext.txt
1 Real-time text in Asterisk 
2 --------------------------
3 The SIP channel has support for real-time text conversation calls in Asterisk (T.140).
4 This is a way to perform text based conversations in combination with other media,
5 most often video. The text is sent character by character as a media stream.
6
7 During a call sometimes there are losses of T.140 packets and a solution to that is to 
8 use redundancy in the media stream (RTP).
9 See  "http://en.wikipedia.org/wiki/Text_over_IP"http://en.wikipedia.org/wiki/Text_over_IP
10 and RFC 5194 for more information.
11
12 The supported real-time text codec is t.140.
13 Real-time text redundancy support is now available in Asterisk.
14
15 ITU-T T.140 
16 -----------
17 You can find more information about T.140 at www.itu.int. RTP is used for the transport T.140,
18 as specified in RFC 4103.
19
20 How to enable T.140
21 -------------------
22 In order to enable real-time text with redundancy in Asterisk, modify sip.conf to add: 
23
24         [general]
25         disallow=all
26         allow=ulaw
27         allow = alaw
28         allow=t140
29         allow=t140red
30         textsupport=yes
31         videosupport=yes ; needed for proper SDP handling even if only text and voice calls are handled
32         allow=h263 ; at least one video codec as H.261, H.263 or H.263+ is needed. 
33
34 The codec settings may change, depending on your phones. The important settings here are to allow
35 t140 and 140red and enable text support.
36
37 General information about real-time text support in Asterisk 
38 ------------------------------------------------------------
39 With the configuration above, calls will be supported with any combination of real-time text, 
40 audio and video. 
41
42 Text for both t140 and t140red is handled on channel and application level in Asterisk conveyed in
43 Text frames, with the subtype "t140". Text is conveyed in such frames usually only containing one or
44 a few characters from the real-time text flow. The packetization interval is 300 ms, handled on lower
45 RTP level, and transmission redundancy level is 2, causing one original and two redundant transmissions
46 of all text so that it is reliable even in high packet loss situations. Transmitting applications do not
47 need to bother about the transmission interval. The t140red support handles any buffering needed during
48 the packetization intervals.
49
50 Clients known to support text, audio/text or audio/video/text calls with Asterisk: 
51 ----------------------------------------------------------------------------------
52
53 - Omnitor Allan eC - SIP audio/video/text softphone 
54 - AuPix APS-50 - audio/video/text softphone.
55 - France Telecom eConf –audio/video/text softphone.
56 - SIPcon1 - open source SIP audio/text softphone available in Sourceforge. 
57
58
59 Limitations
60 -----------
61
62 A known general problem with Asterisk is that when a client which uses audio/video/T.140 calls to 
63 an Asterisk with T.140 media offered but video support not specified. In this case Asterisk handles
64 the sdp media description (m=) incorrectly, and the sdp response is not created correctly. 
65 To solve this problem, turn on video support in Asterisk. 
66
67 Modify sip.conf to add
68         [general] 
69         videosupport=yes 
70         allow=h263 ; at least one video codec as H.261, H.263 or H.263+ is needed.
71
72 The problem with sdp is a bug and is reported to Asterisk bugtracker, it has id 0012434. 
73
74 Credits
75 -------
76  - Asterisk real-time text support is developed by AuPix
77  - Asterisk real-time text redundancy support is developed by Omnitor
78
79 The work with Asterisk real-time text redundancy was supported with funding from the National Institute
80 on Disability and Rehabilitation Research (NIDRR), U.S. Department of Education, under grant number 
81 H133E040013 as part of a co-operation between the Telecommunication Access Rehabilitation Engineering
82 Research Center of the University of Wisconsin – Trace Center joint with Gallaudet University, and Omnitor.
83 Olle E. Johansson, Edvina AB, has been a liason between the Asterisk project and this project.
84