No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

xep-0294.xml 11KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326
  1. <?xml version='1.0' encoding='UTF-8'?>
  2. <!DOCTYPE xep SYSTEM 'xep.dtd' [
  3. <!ENTITY % ents SYSTEM 'xep.ent'>
  4. %ents;
  5. ]>
  6. <?xml-stylesheet type='text/xsl' href='xep.xsl'?>
  7. <xep>
  8. <header>
  9. <title>Jingle RTP Header Extensions Negotiation</title>
  10. <abstract>This specification defines an XMPP extension to negotiate
  11. the use of the use of RTP Header Extension as defined by RFC 5285
  12. with Jingle RTP sessions</abstract>
  13. &LEGALNOTICE;
  14. <number>0294</number>
  15. <status>Draft</status>
  16. <type>Standards Track</type>
  17. <sig>Standards</sig>
  18. <approver>Council</approver>
  19. <dependencies>
  20. <spec>XEP-0167</spec>
  21. <spec>RFC 5285</spec>
  22. </dependencies>
  23. <supersedes/>
  24. <supersededby/>
  25. <shortname>NOT_YET_ASSIGNED</shortname>
  26. <schemaloc>
  27. <url>http://xmpp.org/schemas/jingle-apps-rtp-rtp-hdrext.xsd</url>
  28. </schemaloc>
  29. <discuss>jingle</discuss>
  30. <author>
  31. <firstname>Olivier</firstname>
  32. <surname>Crête</surname>
  33. <email>olivier.crete@collabora.co.uk</email>
  34. <jid>olivier.crete@collabora.co.uk</jid>
  35. </author>
  36. <revision>
  37. <version>1.0</version>
  38. <date>2015-08-11</date>
  39. <initials>XEP Editor (mam)</initials>
  40. <remark><p>Advanced to Draft per a vote of the XMPP Council.</p></remark>
  41. </revision>
  42. <revision>
  43. <version>0.2</version>
  44. <date>2015-03-25</date>
  45. <initials>ph</initials>
  46. <remark><p>Added XML Schema; Updated based on last call feedback.</p></remark>
  47. </revision>
  48. <revision>
  49. <version>0.1</version>
  50. <date>2011-03-24</date>
  51. <initials>psa</initials>
  52. <remark><p>Initial published version.</p></remark>
  53. </revision>
  54. <revision>
  55. <version>0.0.1</version>
  56. <date>2011-01-10</date>
  57. <initials>oc</initials>
  58. <remark><p>First draft.</p></remark>
  59. </revision>
  60. </header>
  61. <section1 topic='Introduction' anchor='introduction'>
  62. <p>This documents specifies how to negotiate the use of the RTP
  63. Header Extensions as defined by &rfc5285; with Jingle RTP
  64. sessions.</p>
  65. </section1>
  66. <section1 topic='Requirements' anchor='requirements'>
  67. <p>The Jingle extension defined herein is designed to meet the following requirements:</p>
  68. <ol>
  69. <li>Enable negotiations of the RTP Header extensions as defined in
  70. <cite>RFC 5285</cite>.</li>
  71. <li>Map these parameters to Session Description Protocol (SDP; see
  72. &rfc4566;) to enable interoperability.</li>
  73. </ol>
  74. </section1>
  75. <section1 topic='New element' anchor='element'>
  76. <p>This specification defines a new element, &lt;rtp-hdrext/&gt;,
  77. that can be inserted in the &lt;description/&gt; element of a
  78. XEP-0167 RTP session.</p>
  79. <p>The attributes of the &lt;rtp-hdrext/&gt; element are:</p>
  80. <table caption='rtp-hdrext attributes'>
  81. <tr>
  82. <th>Attribute</th>
  83. <th>Description</th>
  84. <th>Inclusion</th>
  85. <th>Possible values</th>
  86. </tr>
  87. <tr>
  88. <td>id</td>
  89. <td>The ID of the extensions</td>
  90. <td>REQUIRED</td>
  91. <td>1-256, 4096-4351</td>
  92. </tr>
  93. <tr>
  94. <td>uri</td>
  95. <td>The URI that defines the extension</td>
  96. <td>REQUIRED</td>
  97. <td>Any valid URI</td>
  98. </tr>
  99. <tr>
  100. <td>senders</td>
  101. <td>Which party is allowed to send the negotiated RTP Header Extensions</td>
  102. <td>OPTIONAL (defaults to "both")</td>
  103. <td>"initiator", "responder", and "both"</td>
  104. </tr>
  105. </table>
  106. <p>Any type of RTP Header Extension that requires extra
  107. parameters in the a=b form can embed &lt;parameter/&gt; elements to
  108. describe it. Any other form of parameter can be stored as the 'key' attribute in a parameter element with an empty value.</p>
  109. </section1>
  110. <section1 topic='Negotiation' anchor='negotiation'>
  111. <p>RTP header extensions are negotiated along the codecs. They
  112. follow the same Offer/Answer mechanism based on SDP
  113. Offer/Answer. The initiator signals which RTP header extensions it
  114. wants to send or receive in the the &lt;session-initiate/&gt; iq
  115. stanza. If the responder does not understand the type of header
  116. extensions, it MUST remove the element from the reply. If the
  117. responder does not wish to provide or receive some kind of RTP
  118. header extension, it MUST remove the relevant element from the
  119. reply. It MUST then send the remaining elements it wants to keep
  120. as-is without modifying them in the &lt;session-accept/&gt; iq
  121. stanza.</p>
  122. <p> It MUST NOT add any &lt;rtp-hdrext/&gt; element that was not
  123. offered by the initiator. The responder MAY downgrade the senders
  124. field from "both" to "initator" or "responder", but MUST NOT modify it
  125. if it is "initator" or "responder".</p>
  126. <p>Example negotiation where the initiator offers to use the
  127. timestamp offset header extension as defined in &rfc5450; and also
  128. the requests synchronisation metadata header extension (&rfc6051;)
  129. with either the 56-bit or the 64-bit format.</p>
  130. <example caption='Initiator sends description inside session-initiate'>
  131. <![CDATA[
  132. <description xmlns='urn:xmpp:jingle:apps:rtp:1' media='video'>
  133. <rtp-hdrext xmlns='urn:xmpp:jingle:apps:rtp:rtp-hdrext:0'
  134. uri='urn:ietf:params:rtp-hdrext:toffset'
  135. id='1'/>
  136. <rtp-hdrext xmlns='urn:xmpp:jingle:apps:rtp:rtp-hdrext:0'
  137. uri='urn:ietf:params:rtp-hdrext:ntp-64'
  138. id='4907'/>
  139. <rtp-hdrext xmlns='urn:xmpp:jingle:apps:rtp:rtp-hdrext:0'
  140. uri='urn:ietf:params:rtp-hdrext:ntp-56'
  141. id='4907'/>
  142. <payload-type id='96' name='THEORA' clockrate='90000'/>
  143. </description>
  144. ]]></example>
  145. <p>Example reply where the responder accepts the timestamp offset
  146. and the 56-bit synchronisation metadata header extensions.</p>
  147. <example caption='Reponder sends description inside session-accept'><![CDATA[
  148. <description xmlns='urn:xmpp:jingle:apps:rtp:1' media='video'>
  149. <rtp-hdrext xmlns='urn:xmpp:jingle:apps:rtp:rtp-hdrext:0'
  150. uri='urn:ietf:params:rtp-hdrext:toffset'
  151. id='1'/>
  152. <rtp-hdrext xmlns='urn:xmpp:jingle:apps:rtp:rtp-hdrext:0'
  153. uri='urn:ietf:params:rtp-hdrext:ntp-56'
  154. id='2'/>
  155. <payload-type id='96' name='THEORA' clockrate='90000'/>
  156. </description>
  157. ]]></example>
  158. <p>Another reply to the same request where the responder accepts only the synchronisation data header extension with the 64-bit format.</p>
  159. <example caption='Responder sends description inside session-accept with only the synchronisation data accepted'><![CDATA[
  160. <description xmlns='urn:xmpp:jingle:apps:rtp:1' media='video'>
  161. <rtp-hdrext xmlns='urn:xmpp:jingle:apps:rtp:rtp-hdrext:0'
  162. uri='urn:ietf:params:rtp-hdrext:ntp-64'
  163. id='2'/>
  164. <payload-type id='96' name='THEORA' clockrate='90000'/>
  165. </description>
  166. ]]></example>
  167. </section1>
  168. <section1 topic='Mapping to Session Description Protocol' anchor='sdp-mapping'>
  169. <p>The &lt;rtp-hdrext/&gt; element maps to the "a:extmap=" SDP line
  170. defined in <cite>RFC 5285</cite>. The ID is mapped to the 'id' attribute, the
  171. direction to the 'senders' attribute and the URI to the 'uri'
  172. attribute.</p>
  173. <p>Example conversion of a incomplete sample fragment of a SDP taken from <cite>RFC 5285</cite> section 6 into equivalent XMPP:</p>
  174. <example caption='SDP fragment'><![CDATA[
  175. m=video
  176. a=sendrecv
  177. a=extmap:1 URI-toffset
  178. a=extmap:2/recvonly URI-gps-string
  179. a=extmap:3 URI-frametype
  180. ]]></example>
  181. <example caption='The same description in XMPP format'><![CDATA[
  182. <description xmlns='urn:xmpp:jingle:apps:rtp:1' media='video'>
  183. <rtp-hdrext xmlns='urn:xmpp:jingle:apps:rtp:rtp-hdrext:0'
  184. id='1'
  185. uri='URI-toffset'/>
  186. <rtp-hdrext xmlns='urn:xmpp:jingle:apps:rtp:rtp-hdrext:0'
  187. id='2'
  188. uri='URI-gps-string'
  189. senders='initiator'/>
  190. <rtp-hdrext xmlns='urn:xmpp:jingle:apps:rtp:rtp-hdrext:0'
  191. id='3'
  192. uri='URI-frametype'/>
  193. </description>
  194. ]]></example>
  195. </section1>
  196. <section1 topic='Determining support' anchor='determining-support'>
  197. <p>To advertise its support for Generic Header extensions in Jingle
  198. RTP Sessions, when replying to &xep0030; information requests an
  199. entity MUST return the following features:</p>
  200. <ol>
  201. <li>URNs for any version of this protocol that the entity
  202. supports -- e.g., "urn:xmpp:jingle:apps:rtp:rtp-hdrext:0" for the
  203. current version</li>
  204. </ol>
  205. <p>An example follows:</p>
  206. <example caption="Service discovery information request"><![CDATA[
  207. <iq from='romeo@montague.lit/orchard'
  208. id='bh3vd715'
  209. to='juliet@capulet.lit/balcony'
  210. type='get'>
  211. <query xmlns='http://jabber.org/protocol/disco#info'/>
  212. </iq>
  213. ]]></example>
  214. <example caption="Service discovery information response"><![CDATA[
  215. <iq from='juliet@capulet.lit/balcony'
  216. id='bh3vd715'
  217. to='romeo@montague.lit/orchard'
  218. type='result'>
  219. <query xmlns='http://jabber.org/protocol/disco#info'>
  220. <feature var='urn:xmpp:jingle:1'/>
  221. <feature var='urn:xmpp:jingle:apps:rtp:1'/>
  222. <feature var='urn:xmpp:jingle:apps:rtp:video'/>
  223. <feature var='urn:xmpp:jingle:apps:rtp:rtp-hdrext:0'/>
  224. </query>
  225. </iq>
  226. ]]></example>
  227. </section1>
  228. <section1 topic='IANA Considerations' anchor='iana-considerations'>
  229. <p>This document requires no interaction with the Internet Assigned
  230. Numbers Authority (IANA).</p>
  231. </section1>
  232. <section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  233. <section2 topic='Protocol Namespaces' anchor='registrar-ns'>
  234. <p>This specification defines the following XML namespaces:</p>
  235. <ul>
  236. <li>urn:xmpp:jingle:apps:rtp:rtp-hdrext:0</li>
  237. </ul>
  238. <p>The &REGISTRAR; includes the foregoing namespaces in its
  239. registry at &NAMESPACES;, as governed by &xep0053;.</p>
  240. </section2>
  241. <section2 topic='Namespace Versioning' anchor='registrar-versioning'>
  242. &NSVER;
  243. </section2>
  244. </section1>
  245. <section1 topic='XML Schemas'>
  246. <code><![CDATA[
  247. <?xml version='1.0' encoding='UTF-8'?>
  248. <xs:schema
  249. xmlns:xs='http://www.w3.org/2001/XMLSchema'
  250. targetNamespace='urn:xmpp:jingle:apps:rtp:rtp-hdrext:0'
  251. xmlns='urn:xmpp:jingle:apps:rtp:rtp-hdrext:0'
  252. elementFormDefault='qualified'>
  253. <xs:annotation>
  254. <xs:documentation>
  255. The protocol documented by this schema is defined in
  256. XEP-0294: http://www.xmpp.org/extensions/xep-0294.html
  257. </xs:documentation>
  258. </xs:annotation>
  259. <xs:element name='rtp-hdrext'>
  260. <xs:complexType>
  261. <xs:sequence>
  262. <xs:element name='parameter'
  263. type='parameterElementType'
  264. minOccurs='0'
  265. maxOccurs='unbounded'/>
  266. </xs:sequence>
  267. <xs:attribute name='id' type='xs:unsignedInt' use='required'/>
  268. <xs:attribute name='uri' type='xs:string' use='required'/>
  269. <xs:attribute name='senders'
  270. use='optional'
  271. default='both'>
  272. <xs:simpleType>
  273. <xs:restriction base='xs:NCName'>
  274. <xs:enumeration value='both'/>
  275. <xs:enumeration value='initiator'/>
  276. <xs:enumeration value='none'/>
  277. <xs:enumeration value='responder'/>
  278. </xs:restriction>
  279. </xs:simpleType>
  280. </xs:attribute>
  281. </xs:complexType>
  282. </xs:element>
  283. <xs:complexType name='parameterElementType'>
  284. <xs:simpleContent>
  285. <xs:extension base='empty'>
  286. <xs:attribute name='name' type='xs:string' use='required'/>
  287. <xs:attribute name='value' type='xs:string' use='optional'/>
  288. </xs:extension>
  289. </xs:simpleContent>
  290. </xs:complexType>
  291. </xs:schema>
  292. ]]></code>
  293. </section1>
  294. <section1 topic='Acknowledgements' anchor='ack'>
  295. <p>Thanks to Youness Alaoui for his feedback.</p>
  296. </section1>
  297. </xep>