draft-ietf-avt-rtp-vorbis-06.txt 54 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402
  1. AVT Working Group L. Barbato
  2. Internet-Draft Xiph.Org
  3. Expires: December 27, 2007 Jun 25, 2007
  4. draft-ietf-avt-rtp-vorbis-06
  5. RTP Payload Format for Vorbis Encoded Audio
  6. Status of this Memo
  7. By submitting this Internet-Draft, each author represents that any
  8. applicable patent or other IPR claims of which he or she is aware
  9. have been or will be disclosed, and any of which he or she becomes
  10. aware will be disclosed, in accordance with Section 6 of BCP 79.
  11. Internet-Drafts are working documents of the Internet Engineering
  12. Task Force (IETF), its areas, and its working groups. Note that
  13. other groups may also distribute working documents as Internet-
  14. Drafts.
  15. Internet-Drafts are draft documents valid for a maximum of six months
  16. and may be updated, replaced, or obsoleted by other documents at any
  17. time. It is inappropriate to use Internet-Drafts as reference
  18. material or to cite them other than as "work in progress."
  19. The list of current Internet-Drafts can be accessed at
  20. http://www.ietf.org/ietf/1id-abstracts.txt.
  21. The list of Internet-Draft Shadow Directories can be accessed at
  22. http://www.ietf.org/shadow.html.
  23. This Internet-Draft will expire on December 27, 2007.
  24. Copyright Notice
  25. Copyright (C) The IETF Trust (2007).
  26. Abstract
  27. This document describes an RTP payload format for transporting Vorbis
  28. encoded audio. It details the RTP encapsulation mechanism for raw
  29. Vorbis data and details the delivery mechanisms for the decoder
  30. probability model, referred to as a codebook and other setup
  31. information.
  32. Also included within this memo are media type registrations, and the
  33. details necessary for the use of Vorbis with the Session Description
  34. Protocol (SDP).
  35. Barbato Expires December 27, 2007 [Page 1]
  36. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  37. Editors Note
  38. All references to RFC XXXX are to be replaced by references to the
  39. RFC number of this memo, when published.
  40. Table of Contents
  41. 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
  42. 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
  43. 2. Payload Format . . . . . . . . . . . . . . . . . . . . . . . . 3
  44. 2.1. RTP Header . . . . . . . . . . . . . . . . . . . . . . . . 3
  45. 2.2. Payload Header . . . . . . . . . . . . . . . . . . . . . . 5
  46. 2.3. Payload Data . . . . . . . . . . . . . . . . . . . . . . . 6
  47. 2.4. Example RTP Packet . . . . . . . . . . . . . . . . . . . . 7
  48. 3. Configuration Headers . . . . . . . . . . . . . . . . . . . . 8
  49. 3.1. In-band Header Transmission . . . . . . . . . . . . . . . 9
  50. 3.1.1. Packed Configuration . . . . . . . . . . . . . . . . . 9
  51. 3.2. Out of Band Transmission . . . . . . . . . . . . . . . . . 11
  52. 3.2.1. Packed Headers . . . . . . . . . . . . . . . . . . . . 11
  53. 3.3. Loss of Configuration Headers . . . . . . . . . . . . . . 12
  54. 4. Comment Headers . . . . . . . . . . . . . . . . . . . . . . . 12
  55. 5. Frame Packetization . . . . . . . . . . . . . . . . . . . . . 13
  56. 5.1. Example Fragmented Vorbis Packet . . . . . . . . . . . . . 14
  57. 5.2. Packet Loss . . . . . . . . . . . . . . . . . . . . . . . 16
  58. 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 17
  59. 6.1. Packed Headers IANA Considerations . . . . . . . . . . . . 19
  60. 7. SDP related considerations . . . . . . . . . . . . . . . . . . 20
  61. 7.1. Mapping Media Type Parameters into SDP . . . . . . . . . . 20
  62. 7.1.1. SDP Example . . . . . . . . . . . . . . . . . . . . . 21
  63. 7.2. Usage with the SDP Offer/Answer Model . . . . . . . . . . 21
  64. 8. Congestion Control . . . . . . . . . . . . . . . . . . . . . . 22
  65. 9. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
  66. 9.1. Stream Radio . . . . . . . . . . . . . . . . . . . . . . . 22
  67. 10. Security Considerations . . . . . . . . . . . . . . . . . . . 23
  68. 11. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 23
  69. 12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 23
  70. 12.1. Normative References . . . . . . . . . . . . . . . . . . . 23
  71. 12.2. Informative References . . . . . . . . . . . . . . . . . . 24
  72. Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 24
  73. Intellectual Property and Copyright Statements . . . . . . . . . . 25
  74. Barbato Expires December 27, 2007 [Page 2]
  75. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  76. 1. Introduction
  77. Vorbis is a general purpose perceptual audio codec intended to allow
  78. maximum encoder flexibility, thus allowing it to scale competitively
  79. over an exceptionally wide range of bitrates. At the high quality/
  80. bitrate end of the scale (CD or DAT rate stereo, 16/24 bits), it is
  81. in the same league as AAC. Vorbis is also intended for lower and
  82. higher sample rates (from 8kHz telephony to 192kHz digital masters)
  83. and a range of channel representations (monaural, polyphonic, stereo,
  84. quadraphonic, 5.1, ambisonic, or up to 255 discrete channels).
  85. Vorbis encoded audio is generally encapsulated within an Ogg format
  86. bitstream [11], which provides framing and synchronization. For the
  87. purposes of RTP transport, this layer is unnecessary, and so raw
  88. Vorbis packets are used in the payload.
  89. 1.1. Terminology
  90. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
  91. "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
  92. document are to be interpreted as described in RFC 2119 [1].
  93. 2. Payload Format
  94. For RTP based transport of Vorbis encoded audio the standard RTP
  95. header is followed by a 4 octets payload header, then the payload
  96. data. The payload headers are used to associate the Vorbis data with
  97. its associated decoding codebooks as well as indicating if the
  98. following packet contains fragmented Vorbis data and/or the number of
  99. whole Vorbis data frames. The payload data contains the raw Vorbis
  100. bitstream information. There are 3 types of Vorbis payload data, an
  101. RTP packet MUST contain just one of them at a time.
  102. 2.1. RTP Header
  103. The format of the RTP header is specified in [2] and shown in Figure
  104. Figure 1. This payload format uses the fields of the header in a
  105. manner consistent with that specification.
  106. Barbato Expires December 27, 2007 [Page 3]
  107. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  108. 0 1 2 3
  109. 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  110. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  111. |V=2|P|X| CC |M| PT | sequence number |
  112. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  113. | timestamp |
  114. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  115. | synchronization source (SSRC) identifier |
  116. +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
  117. | contributing source (CSRC) identifiers |
  118. | ... |
  119. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  120. Figure 1: RTP Header
  121. The RTP header begins with an octet of fields (V, P, X, and CC) to
  122. support specialized RTP uses (see [2] and [3] for details). For
  123. Vorbis RTP, the following values are used.
  124. Version (V): 2 bits
  125. This field identifies the version of RTP. The version used by this
  126. specification is two (2).
  127. Padding (P): 1 bit
  128. Padding MAY be used with this payload format according to section 5.1
  129. of [2].
  130. Extension (X): 1 bit
  131. The Extension bit is used in accordance with [2].
  132. CSRC count (CC): 4 bits
  133. The CSRC count is used in accordance with [2].
  134. Marker (M): 1 bit
  135. Set to zero. Audio silence suppression not used. This conforms to
  136. section 4.1 of [13].
  137. Payload Type (PT): 7 bits
  138. An RTP profile for a class of applications is expected to assign a
  139. payload type for this format, or a dynamically allocated payload type
  140. SHOULD be chosen which designates the payload as Vorbis.
  141. Barbato Expires December 27, 2007 [Page 4]
  142. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  143. Sequence number: 16 bits
  144. The sequence number increments by one for each RTP data packet sent,
  145. and may be used by the receiver to detect packet loss and to restore
  146. packet sequence. This field is detailed further in [2].
  147. Timestamp: 32 bits
  148. A timestamp representing the sampling time of the first sample of the
  149. first Vorbis packet in the RTP packet. The clock frequency MUST be
  150. set to the sample rate of the encoded audio data and is conveyed out-
  151. of-band (e.g. as a SDP parameter).
  152. SSRC/CSRC identifiers:
  153. These two fields, 32 bits each with one SSRC field and a maximum of
  154. 16 CSRC fields, are as defined in [2].
  155. 2.2. Payload Header
  156. The 4 octets following the RTP Header section are the Payload Header.
  157. This header is split into a number of bitfields detailing the format
  158. of the following payload data packets.
  159. 0 1 2 3
  160. 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  161. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  162. | Ident | F |VDT|# pkts.|
  163. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  164. Figure 2: Payload Header
  165. Ident: 24 bits
  166. This 24 bit field is used to associate the Vorbis data to a decoding
  167. Configuration. It is stored as network byte order integer.
  168. Fragment type (F): 2 bits
  169. This field is set according to the following list
  170. 0 = Not Fragmented
  171. 1 = Start Fragment
  172. 2 = Continuation Fragment
  173. 3 = End Fragment
  174. Vorbis Data Type (VDT): 2 bits
  175. Barbato Expires December 27, 2007 [Page 5]
  176. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  177. This field specifies the kind of Vorbis data stored in this RTP
  178. packet. There are currently three different types of Vorbis
  179. payloads. Each packet MUST contain only a single type of Vorbis
  180. payload (e.g. you MUST not aggregate configuration and comment
  181. payload in the same packet)
  182. 0 = Raw Vorbis payload
  183. 1 = Vorbis Packed Configuration payload
  184. 2 = Legacy Vorbis Comment payload
  185. 3 = Reserved
  186. The packets with a VDT of value 3 MUST be ignored
  187. The last 4 bits represent the number of complete packets in this
  188. payload. This provides for a maximum number of 15 Vorbis packets in
  189. the payload. If the packet contains fragmented data the number of
  190. packets MUST be set to 0.
  191. 2.3. Payload Data
  192. Raw Vorbis packets are currently unbounded in length, application
  193. profiles will likely define a practical limit. Typical Vorbis packet
  194. sizes range from very small (2-3 bytes) to quite large (8-12
  195. kilobytes). The reference implementation [12] typically produces
  196. packets less than ~800 bytes, except for the setup header packets
  197. which are ~4-12 kilobytes. Within an RTP context, to avoid
  198. fragmentation, the Vorbis data packet size SHOULD be kept
  199. sufficiently small so that after adding the RTP and payload headers,
  200. the complete RTP packet is smaller than the path MTU.
  201. 0 1 2 3
  202. 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  203. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  204. | length | vorbis packet data ..
  205. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  206. Figure 3: Payload Data Header
  207. Each Vorbis payload packet starts with a two octet length header,
  208. which is used to represent the size in bytes of the following data
  209. payload, followed by the raw Vorbis data padded to the nearest byte
  210. boundary, as explained by the vorbis specification [13]. The length
  211. value is stored as network byte order integer.
  212. For payloads which consist of multiple Vorbis packets the payload
  213. data consists of the packet length followed by the packet data for
  214. each of the Vorbis packets in the payload.
  215. Barbato Expires December 27, 2007 [Page 6]
  216. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  217. The Vorbis packet length header is the length of the Vorbis data
  218. block only and does not count the length field.
  219. The payload packing of the Vorbis data packets MUST follow the
  220. guidelines set-out in [3] where the oldest packet occurs immediately
  221. after the RTP packet header. Subsequent packets, if any, MUST follow
  222. in temporal order.
  223. Channel mapping of the audio is in accordance with the Vorbis I
  224. Specification [13].
  225. 2.4. Example RTP Packet
  226. Here is an example RTP packet containing two Vorbis packets.
  227. RTP Packet Header:
  228. 0 1 2 3
  229. 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  230. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  231. | 2 |0|0| 0 |0| PT | sequence number |
  232. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  233. | timestamp (in sample rate units) |
  234. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  235. | synchronisation source (SSRC) identifier |
  236. +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
  237. | contributing source (CSRC) identifiers |
  238. | ... |
  239. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  240. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  241. | Ident | 0 | 0 | 2 pks |
  242. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  243. | length | vorbis data ..
  244. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  245. .. vorbis data |
  246. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  247. | length | next vorbis packet data ..
  248. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  249. .. vorbis data ..
  250. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  251. .. vorbis data |
  252. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  253. Figure 4: Example Raw Vorbis Packet
  254. The payload data section of the RTP packet begins with the 24 bit
  255. Ident field followed by the one octet bitfield header, which has the
  256. number of Vorbis frames set to 2. Each of the Vorbis data frames is
  257. Barbato Expires December 27, 2007 [Page 7]
  258. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  259. prefixed by the two octets length field. The Packet Type and
  260. Fragment Type are set to 0. The Configuration that will be used to
  261. decode the packets is the one indexed by the ident value.
  262. 3. Configuration Headers
  263. Unlike other mainstream audio codecs Vorbis has no statically
  264. configured probability model. Instead, it packs all entropy decoding
  265. configuration, Vector Quantization and Huffman models into a data
  266. block that must be transmitted to the decoder along with the
  267. compressed data. A decoder also requires information detailing the
  268. number of audio channels, bitrates and similar information to
  269. configure itself for a particular compressed data stream. These two
  270. blocks of information are often referred to collectively as the
  271. "codebooks" for a Vorbis stream, and are nominally included as
  272. special "header" packets at the start of the compressed data. In
  273. addition, the Vorbis I specification [13] requires the presence of a
  274. comment header packet which gives simple metadata about the stream,
  275. but this information is not required for decoding the frame sequence.
  276. Thus these two codebook header packets must be received by the
  277. decoder before any audio data can be interpreted. These requirements
  278. pose problems in RTP, which is often used over unreliable transports.
  279. Since this information must be transmitted reliably and, as the RTP
  280. stream may change certain configuration data mid-session, there are
  281. different methods for delivering this configuration data to a client,
  282. both in-band and out-of-band which is detailed below. SDP delivery
  283. is typically used to set up an initial state for the client
  284. application. The changes may be due to different codebooks as well
  285. as different bitrates of the stream.
  286. The delivery vectors in use can be specified by an SDP attribute to
  287. indicate the method and the optional URI where the Vorbis Packed
  288. Configuration (Section 3.1.1) Packets could be fetched. Different
  289. delivery methods MAY be advertised for the same session. The in-band
  290. Configuration delivery SHOULD be considered as baseline, out-of-band
  291. delivery methods that don't use RTP will not be described in this
  292. document. For non chained streams, the Configuration recommended
  293. delivery method is inline the Packed Configuration (Section 3.1.1) in
  294. the SDP as explained in the IANA considerations (Section 7.1).
  295. The 24 bit Ident field is used to map which Configuration will be
  296. used to decode a packet. When the Ident field changes, it indicates
  297. that a change in the stream has taken place. The client application
  298. MUST have in advance the correct configuration and if the client
  299. detects a change in the Ident value and does not have this
  300. Barbato Expires December 27, 2007 [Page 8]
  301. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  302. information it MUST NOT decode the raw Vorbis data associated until
  303. it fetches the correct Configuration.
  304. 3.1. In-band Header Transmission
  305. The Packed Configuration (Section 3.1.1) Payload is sent in-band with
  306. the packet type bits set to match the Vorbis Data Type. Clients MUST
  307. be capable of dealing with fragmentation and periodic re-transmission
  308. of the configuration headers.
  309. 3.1.1. Packed Configuration
  310. A Vorbis Packed Configuration is indicated with the Vorbis Data Type
  311. field set to 1. Of the three headers defined in the Vorbis I
  312. specification [13], the identification and the setup MUST be packed
  313. as they are, while the comment header MAY be replaced with a dummy
  314. one. The packed configuration follows a generic way to store xiph
  315. codec configurations: The first field stores the number of the
  316. following packets minus one (count field), the next ones represent
  317. the size of the headers (length fields), the headers immediately
  318. follow the list of length fields. The size of the last header is
  319. implicit. The count and the length fields are encoded using the
  320. following logic: the data is in network order, every byte has the
  321. most significant bit used as flag and the following 7 used to store
  322. the value. The first N bit are to be taken, where N is number of
  323. bits representing the value modulo 7, and stored in the first byte.
  324. If there are more bits, the flag bit is set to 1 and the subsequent
  325. 7bit are stored in the following byte, if there are remaining bits
  326. set the flag to 1 and the same procedure is repeated. The ending
  327. byte has the flag bit set to 0. In order to decode it is enough to
  328. iterate over the bytes until the flag bit set to 0, for every byte
  329. the data is added to the accumulated value multiplied by 128. The
  330. headers are packed in the same order they are present in ogg:
  331. identification, comment, setup.
  332. Barbato Expires December 27, 2007 [Page 9]
  333. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  334. 0 1 2 3
  335. 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  336. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  337. |V=2|P|X| CC |M| PT | xxxx |
  338. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  339. | xxxxx |
  340. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  341. | synchronization source (SSRC) identifier |
  342. +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
  343. | contributing source (CSRC) identifiers |
  344. | ... |
  345. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  346. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  347. | Ident | 1 | 0 | 0|
  348. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  349. | length | n. of headers | length1 |
  350. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  351. | length2 | Identification ..
  352. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  353. .. Identification ..
  354. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  355. .. Identification ..
  356. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  357. .. Identification ..
  358. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  359. .. Identification | Comment ..
  360. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  361. .. Comment ..
  362. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  363. .. Comment ..
  364. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  365. .. Comment ..
  366. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  367. .. Comment | Setup ..
  368. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  369. .. Setup ..
  370. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  371. .. Setup ..
  372. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  373. Figure 5: Packed Configuration Figure
  374. The Ident field is set with the value that will be used by the Raw
  375. Payload Packets to address this Configuration. The Fragment type is
  376. set to 0 since the packet bears the full Packed configuration, the
  377. number of packet is set to 1.
  378. Barbato Expires December 27, 2007 [Page 10]
  379. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  380. 3.2. Out of Band Transmission
  381. This section, as stated above, does not cover all the possible out-
  382. of-band delivery methods since they rely on different protocols and
  383. are linked to specific applications. The following packet definition
  384. SHOULD be used in out-of-band delivery and MUST be used when
  385. Configuration is inlined in the SDP.
  386. 3.2.1. Packed Headers
  387. As mentioned above the RECOMMENDED delivery vector for Vorbis
  388. configuration data is via a retrieval method that can be performed
  389. using a reliable transport protocol. As the RTP headers are not
  390. required for this method of delivery the structure of the
  391. configuration data is slightly different. The packed header starts
  392. with a 32 bit (network ordered) count field which details the number
  393. of packed headers that are contained in the bundle. Next is the
  394. Packed header payload for each chained Vorbis stream.
  395. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  396. | Number of packed headers |
  397. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  398. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  399. | Packed header |
  400. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  401. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  402. | Packed header |
  403. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  404. Figure 6: Packed Headers Overview
  405. Since the Configuration Ident and the Identification Header are fixed
  406. length there is only a 2 byte length tag to define the length of the
  407. packed headers.
  408. Barbato Expires December 27, 2007 [Page 11]
  409. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  410. 0 1 2 3
  411. 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  412. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  413. | Ident | length ..
  414. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  415. .. | n. of headers | length1 | length2 ..
  416. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  417. .. | Identification Header ..
  418. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  419. .................................................................
  420. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  421. .. | Comment Header ..
  422. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  423. .................................................................
  424. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  425. .. Comment Header |
  426. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  427. | Setup Header ..
  428. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  429. .................................................................
  430. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  431. .. Setup Header |
  432. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  433. Figure 7: Packed Headers Detail
  434. The key difference between the in-band format and this one, is that
  435. there is no need for the payload header octet. In this figure the
  436. comment has a size bigger than 127 bytes.
  437. 3.3. Loss of Configuration Headers
  438. Unlike the loss of raw Vorbis payload data, loss of a configuration
  439. header can lead to a situation where it will not be possible to
  440. successfully decode the stream.
  441. Loss of Configuration Packet results in the halting of stream
  442. decoding.
  443. 4. Comment Headers
  444. With the Vorbis Data Type flag set to 2, this indicates that the
  445. packet contain the comment metadata, such as artist name, track title
  446. and so on. These metadata messages are not intended to be fully
  447. descriptive but to offer basic track/song information. Clients MAY
  448. ignore it completely. The details on the format of the comments can
  449. be found in the Vorbis documentation [13].
  450. Barbato Expires December 27, 2007 [Page 12]
  451. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  452. 0 1 2 3
  453. 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  454. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  455. |V=2|P|X| CC |M| PT | xxxx |
  456. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  457. | xxxxx |
  458. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  459. | synchronization source (SSRC) identifier |
  460. +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
  461. | contributing source (CSRC) identifiers |
  462. | ... |
  463. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  464. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  465. | Ident | 0 | 2 | 1|
  466. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  467. | length | Comment ..
  468. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  469. .. Comment ..
  470. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  471. .. Comment |
  472. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  473. Figure 8: Comment Packet
  474. The 2 bytes length field is necessary since this packet could be
  475. fragmented.
  476. 5. Frame Packetization
  477. Each RTP packet contains either one Vorbis packet fragment, or an
  478. integer number of complete Vorbis packets (up to a maximum of 15
  479. packets, since the number of packets is defined by a 4 bit value).
  480. Any Vorbis data packet that is less than path MTU SHOULD be bundled
  481. in the RTP packet with as many Vorbis packets as will fit, up to a
  482. maximum of 15, except when such bundling would exceed an
  483. application's desired transmission latency. Path MTU is detailed in
  484. [6] and [7].
  485. A fragmented packet has a zero in the last four bits of the payload
  486. header. The first fragment will set the Fragment type to 1. Each
  487. fragment after the first will set the Fragment type to 2 in the
  488. payload header. The RTP packet containing the last fragment of the
  489. Vorbis packet will have the Fragment type set to 3. To maintain the
  490. correct sequence for fragmented packet reception the timestamp field
  491. of fragmented packets MUST be the same as the first packet sent, with
  492. the sequence number incremented as normal for the subsequent RTP
  493. Barbato Expires December 27, 2007 [Page 13]
  494. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  495. packets. The length field shows the fragment length.
  496. 5.1. Example Fragmented Vorbis Packet
  497. Here is an example fragmented Vorbis packet split over three RTP
  498. packets. Each packet contains the standard RTP headers as well as
  499. the 4 octets Vorbis headers.
  500. Packet 1:
  501. 0 1 2 3
  502. 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  503. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  504. |V=2|P|X| CC |M| PT | 1000 |
  505. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  506. | 12345 |
  507. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  508. | synchronization source (SSRC) identifier |
  509. +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
  510. | contributing source (CSRC) identifiers |
  511. | ... |
  512. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  513. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  514. | Ident | 1 | 0 | 0|
  515. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  516. | length | vorbis data ..
  517. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  518. .. vorbis data |
  519. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  520. Figure 9: Example Fragmented Packet (Packet 1)
  521. In this packet the initial sequence number is 1000 and the timestamp
  522. is 12345. The Fragment type is set to 1, the number of packets field
  523. is set to 0, and as the payload is raw Vorbis data the VDT field is
  524. set to 0.
  525. Barbato Expires December 27, 2007 [Page 14]
  526. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  527. Packet 2:
  528. 0 1 2 3
  529. 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  530. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  531. |V=2|P|X| CC |M| PT | 1001 |
  532. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  533. | 12345 |
  534. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  535. | synchronization source (SSRC) identifier |
  536. +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
  537. | contributing source (CSRC) identifiers |
  538. | ... |
  539. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  540. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  541. | Ident | 2 | 0 | 0|
  542. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  543. | length | vorbis data ..
  544. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  545. .. vorbis data |
  546. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  547. Figure 10: Example Fragmented Packet (Packet 2)
  548. The Fragment type field is set to 2 and the number of packets field
  549. is set to 0. For large Vorbis fragments there can be several of
  550. these type of payload packets. The maximum packet size SHOULD be no
  551. greater than the path MTU, including all RTP and payload headers.
  552. The sequence number has been incremented by one but the timestamp
  553. field remains the same as the initial packet.
  554. Barbato Expires December 27, 2007 [Page 15]
  555. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  556. Packet 3:
  557. 0 1 2 3
  558. 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  559. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  560. |V=2|P|X| CC |M| PT | 1002 |
  561. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  562. | 12345 |
  563. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  564. | synchronization source (SSRC) identifier |
  565. +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
  566. | contributing source (CSRC) identifiers |
  567. | ... |
  568. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  569. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  570. | Ident | 3 | 0 | 0|
  571. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  572. | length | vorbis data ..
  573. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  574. .. vorbis data |
  575. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  576. Figure 11: Example Fragmented Packet (Packet 3)
  577. This is the last Vorbis fragment packet. The Fragment type is set to
  578. 3 and the packet count remains set to 0. As in the previous packets
  579. the timestamp remains set to the first packet in the sequence and the
  580. sequence number has been incremented.
  581. 5.2. Packet Loss
  582. As there is no error correction within the Vorbis stream, packet loss
  583. will result in a loss of signal. Packet loss is more of an issue for
  584. fragmented Vorbis packets as the client will have to cope with the
  585. handling of the Fragment Type. In case of loss of fragments the
  586. client MUST discard all the remaining fragments and decode the
  587. incomplete packet. If we use the fragmented Vorbis packet example
  588. above and the first packet is lost the client MUST detect that the
  589. next packet has the packet count field set to 0 and the Fragment type
  590. 2 and MUST drop it. The next packet, which is the final fragmented
  591. packet, MUST be dropped in the same manner. If the missing packet is
  592. the last, the received two fragments will be kept and the incomplete
  593. vorbis packet decoded.
  594. Loss of any of the Configuration fragment will result in the loss of
  595. the full Configuration packet with the result detailed in the Loss of
  596. Configuration Headers (Section 3.3) section.
  597. Barbato Expires December 27, 2007 [Page 16]
  598. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  599. 6. IANA Considerations
  600. Type name: audio
  601. Subtype name: vorbis
  602. Required parameters:
  603. rate: indicates the RTP timestamp clock rate as described in RTP
  604. Profile for Audio and Video Conferences with Minimal Control.
  605. [3]
  606. channels: indicates the number of audio channels as described in
  607. RTP Profile for Audio and Video Conferences with Minimal
  608. Control. [3]
  609. delivery-method: indicates the delivery methods in use, the
  610. possible values are: inline, in_band, out_band, MAY be included
  611. multiple times
  612. configuration: the base64 [9] representation of the Packed
  613. Headers (Section 3.2.1). It MUST follow the associated
  614. delivery-method parameter ("inline").
  615. Optional parameters:
  616. configuration-uri: the URI [4] of the configuration headers in
  617. case of out of band transmission. In the form of
  618. "protocol://path/to/resource/", depending on the specific
  619. method, a single configuration packet could be retrived by its
  620. Ident number, or multiple packets could be aggregated in a
  621. single stream. Such aggregates MAY be compressed using either
  622. bzip2 [16] or gzip [14]. A sha1 [10] checksum MAY be provided
  623. for aggregates. In this latter case the URI will end with the
  624. aggregate name, followed by its compressed extension if
  625. applies, a "!" and the base64 [9] representation of the
  626. sha1hash of the above mentioned compressed aggregated as in:
  627. "protocol://path/to/resource/aggregated.bz2!sha1hash". The
  628. trailing '/' discriminates which of two methods are in use.
  629. The configuration-uri MUST follow the associated delivery
  630. method parameter ("out_band"). Non hierarchical protocols and
  631. protocols using for special purposes the '!' separator MAY
  632. point just to a resource aggregate using their specific syntax.
  633. Barbato Expires December 27, 2007 [Page 17]
  634. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  635. Encoding considerations:
  636. This media type is framed and contains binary data.
  637. Security considerations:
  638. See Section 10 of RFC XXXX.
  639. Interoperability considerations:
  640. None
  641. Published specification:
  642. RFC XXXX [RFC Editor: please replace by the RFC number of this
  643. memo, when published]
  644. Ogg Vorbis I specification: Codec setup and packet decode.
  645. Available from the Xiph website, http://www.xiph.org
  646. Applications which use this media type:
  647. Audio streaming and conferencing tools
  648. Additional information:
  649. None
  650. Person & email address to contact for further information:
  651. Luca Barbato: <lu_zero@gentoo.org> IETF Audio/Video Transport
  652. Working Group
  653. Intended usage:
  654. COMMON
  655. Restriction on usage:
  656. This media type depends on RTP framing, and hence is only defined
  657. for transfer via RTP [2]
  658. Author:
  659. Luca Barbato
  660. Barbato Expires December 27, 2007 [Page 18]
  661. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  662. Change controller:
  663. IETF AVT Working Group delegated from the IESG
  664. 6.1. Packed Headers IANA Considerations
  665. The following IANA considerations MUST only be applied to the packed
  666. headers.
  667. Type name: audio
  668. Subtype name: vorbis-config
  669. Required parameters:
  670. None
  671. Optional parameters:
  672. None
  673. Encoding considerations:
  674. This media type contains binary data.
  675. Security considerations:
  676. See Section 10 of RFC XXXX.
  677. Interoperability considerations:
  678. None
  679. Published specification:
  680. RFC XXXX [RFC Editor: please replace by the RFC number of this
  681. memo, when published]
  682. Applications which use this media type:
  683. Vorbis encoded audio, configuration data.
  684. Additional information:
  685. None
  686. Barbato Expires December 27, 2007 [Page 19]
  687. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  688. Person & email address to contact for further information:
  689. Luca Barbato: <lu_zero@gentoo.org>
  690. IETF Audio/Video Transport Working Group
  691. Intended usage: COMMON
  692. Restriction on usage:
  693. This media type doesn't depend on the transport.
  694. Author:
  695. Luca Barbato
  696. Change controller:
  697. IETF AVT Working Group delegated from the IESG
  698. 7. SDP related considerations
  699. The following paragraphs defines the mapping of the parameters
  700. described in the IANA considerations section and their usage in the
  701. Offer/Answer Model [8].
  702. 7.1. Mapping Media Type Parameters into SDP
  703. The information carried in the Media Type media type specification
  704. has a specific mapping to fields in the Session Description Protocol
  705. (SDP) [5], which is commonly used to describe RTP sessions. When SDP
  706. is used to specify sessions the mapping are as follows:
  707. o The type name ("audio") goes in SDP "m=" as the media name.
  708. o The subtype name ("vorbis") goes in SDP "a=rtpmap" as the encoding
  709. name.
  710. o The parameter "rate" also goes in "a=rtpmap" as clock rate.
  711. o The parameter "channels" also goes in "a=rtpmap" as channel count.
  712. o The mandated parameters "delivery-method" and "configuration" MUST
  713. be included in the SDP "a=fmtp" attribute.
  714. o The optional parameter "configuration-uri", when present, MUST be
  715. included in the SDP "a=fmtp" attribute and MUST follow the
  716. delivery-method that applies.
  717. Barbato Expires December 27, 2007 [Page 20]
  718. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  719. If the stream comprises chained Vorbis files and all of them are
  720. known in advance, the Configuration Packet for each file SHOULD be
  721. passed to the client using the configuration attribute.
  722. The URI specified in the configuration-uri attribute MUST point to a
  723. location where all of the Configuration Packets needed for the life
  724. of the session reside.
  725. The port value is specified by the server application bound to the
  726. address specified in the c= line. The bitrate value and channels
  727. specified in the rtpmap attribute MUST match the Vorbis sample rate
  728. value. An example is found below.
  729. 7.1.1. SDP Example
  730. The following example shows a basic SDP single stream. The first
  731. configuration packet is inlined in the sdp, other configurations
  732. could be fetched at any time from the first provided uri using or all
  733. the known configuration could be downloaded using the second uri.
  734. The inline base64 [9] configuration string is omitted because of the
  735. length.
  736. c=IN IP4 192.0.2.1
  737. m=audio RTP/AVP 98
  738. a=rtpmap:98 vorbis/44100/2
  739. a=fmtp:98 delivery-method=inline; configuration=base64string;
  740. delivery-method=out_band;
  741. configuration-uri=rtsp://path/to/the/resource; delivery-
  742. method=out_band; configuration-uri=http://another/path/to/
  743. resource/aggregate.bz2!8b6237eb5154a0ea12811a94e8e2697b3312bc6c;
  744. Note that the payload format (encoding) names are commonly shown in
  745. upper case. Media Type subtypes are commonly shown in lower case.
  746. These names are case-insensitive in both places. Similarly,
  747. parameter names are case-insensitive both in Media Type types and in
  748. the default mapping to the SDP a=fmtp attribute. The exception
  749. regarding case sensitivity is the configuration-uri URI which MUST be
  750. regarded as being case sensitive. The a=fmtp line is a single line
  751. even if it is presented broken because of clarity.
  752. 7.2. Usage with the SDP Offer/Answer Model
  753. The only paramenter negotiable is the delivery method. All the
  754. others are declarative: the offer, as described in An Offer/Answer
  755. Model Session Description Protocol [8], may contain a large number of
  756. delivery methods per single fmtp attribute, the answerer MUST remove
  757. every delivery-method and configuration-uri not supported. All the
  758. parameters MUST not be altered on answer otherwise.
  759. Barbato Expires December 27, 2007 [Page 21]
  760. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  761. 8. Congestion Control
  762. Vorbis clients SHOULD send regular receiver reports detailing
  763. congestion. A mechanism for dynamically downgrading the stream,
  764. known as bitrate peeling, will allow for a graceful backing off of
  765. the stream bitrate. This feature is not available at present so an
  766. alternative would be to redirect the client to a lower bitrate stream
  767. if one is available.
  768. 9. Examples
  769. The following examples are common usage patterns that MAY be applied
  770. in such situations, the main scope of this section is to explain
  771. better usage of the transmission vectors.
  772. 9.1. Stream Radio
  773. This is one of the most common situation: one single server streaming
  774. content in multicast, the clients may start a session at random time.
  775. The content itself could be a mix of live stream, as the wj's voice,
  776. and stored streams as the music she plays.
  777. In this situation we don't know in advance how many codebooks we will
  778. use. The clients can join anytime and users expect to start
  779. listening to the content in a short time.
  780. On join the client will receive the current Configuration necessary
  781. to decode the current stream inlined in the SDP so that the decoding
  782. will start immediately after.
  783. When the streamed content changes the new Configuration is sent in-
  784. band before the actual stream, and the Configuration that has to be
  785. sent inline in the SDP updated. Since the in-band method is
  786. unreliable, an out of band fallback is provided.
  787. The client could choose to fetch the Configuration from the alternate
  788. source as soon as it discovers a Configuration packet got lost in-
  789. band or use selective retransmission [15], if the server supports the
  790. feature.
  791. A serverside optimization would be to keep an hash list of the
  792. Configurations per session to avoid packing all of them and send the
  793. same Configuration with different Ident tags
  794. A clientside optimization would be to keep a tag list of the
  795. Configurations per session and don't process configuration packets
  796. already known.
  797. Barbato Expires December 27, 2007 [Page 22]
  798. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  799. 10. Security Considerations
  800. RTP packets using this payload format are subject to the security
  801. considerations discussed in the RTP specification [2]. This implies
  802. that the confidentiality of the media stream is achieved by using
  803. encryption. Because the data compression used with this payload
  804. format is applied end-to-end, encryption may be performed on the
  805. compressed data. Additional care MAY be needed for delivery methods
  806. that point to external resources, using secure protocols to fetch the
  807. configuration payloads. Where the size of a data block is set, care
  808. MUST be taken to prevent buffer overflows in the client applications.
  809. 11. Acknowledgments
  810. This document is a continuation of draft-moffitt-vorbis-rtp-00.txt
  811. and draft-kerr-avt-vorbis-rtp-04.txt. The Media Type type section is
  812. a continuation of draft-short-avt-rtp-vorbis-mime-00.txt.
  813. Thanks to the AVT, Ogg Vorbis Communities / Xiph.org including Steve
  814. Casner, Aaron Colwell, Ross Finlayson, Fluendo, Ramon Garcia, Pascal
  815. Hennequin, Ralph Giles, Tor-Einar Jarnbjo, Colin Law, John Lazzaro,
  816. Jack Moffitt, Christopher Montgomery, Colin Perkins, Barry Short,
  817. Mike Smith, Phil Kerr, Michael Sparks, Magnus Westerlund, David
  818. Barrett, Silvia Pfeiffer, Stefan Ehmann, Alessandro Salvatori.
  819. Politecnico di Torino (LS)^3/IMG Group in particular Federico
  820. Ridolfo, Francesco Varano, Giampaolo Mancini, Dario Gallucci, Juan
  821. Carlos De Martin.
  822. 12. References
  823. 12.1. Normative References
  824. [1] Bradner, S., "Key words for use in RFCs to Indicate Requirement
  825. Levels", RFC 2119.
  826. [2] Schulzrinne, H., Casner, S., Frederick, R., and V. Jacobson,
  827. "RTP: A Transport Protocol for real-time applications",
  828. RFC 3550.
  829. [3] Schulzrinne, H. and S. Casner, "RTP Profile for Audio and Video
  830. Conferences with Minimal Control.", RFC 3551.
  831. [4] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
  832. Resource Identifier (URI): Generic Syntax", RFC 3986.
  833. [5] Handley, M., Jacobson, V., and C. Perkins, "SDP: Session
  834. Barbato Expires December 27, 2007 [Page 23]
  835. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  836. Description Protocol", RFC 4566, July 2006.
  837. [6] Mogul, J. and S. Deering, "Path MTU discovery", RFC 1191,
  838. November 1990.
  839. [7] McCann et al., J., "Path MTU Discovery for IP version 6",
  840. RFC 1981.
  841. [8] Rosenberg, J. and H. Schulzrinne, "An Offer/Answer Model with
  842. Session Description Protocol (SDP)", RFC 3264.
  843. [9] Josefsson, S., "The Base16, Base32, and Base64 Data Encodings",
  844. RFC 3548.
  845. [10] National Institute of Standards and Technology, "Secure Hash
  846. Standard", May 1993.
  847. 12.2. Informative References
  848. [11] Pfeiffer, S., "The Ogg Encapsulation Format Version 0",
  849. RFC 3533.
  850. [12] "libvorbis: Available from the Xiph website,
  851. http://www.xiph.org".
  852. [13] "Ogg Vorbis I specification: Codec setup and packet decode.
  853. Available from the Xiph website, http://www.xiph.org".
  854. [14] Deutsch, P., "GZIP file format specification version 4.3",
  855. RFC 1952.
  856. [15] Friedman, T., Caceres, R., and A. Clark, "RTP Control Protocol
  857. Extended Reports (RTCP XR)", RFC 3611, November 2003.
  858. [16] Seward, J., "libbz2 and bzip2".
  859. Author's Address
  860. Luca Barbato
  861. Xiph.Org
  862. Email: lu_zero@gentoo.org
  863. URI: http://www.xiph.org/
  864. Barbato Expires December 27, 2007 [Page 24]
  865. Internet-Draft draft-ietf-avt-rtp-vorbis-06 Jun 2007
  866. Full Copyright Statement
  867. Copyright (C) The IETF Trust (2007).
  868. This document is subject to the rights, licenses and restrictions
  869. contained in BCP 78, and except as set forth therein, the authors
  870. retain all their rights.
  871. This document and the information contained herein are provided on an
  872. "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
  873. OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
  874. THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
  875. OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
  876. THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
  877. WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  878. Intellectual Property
  879. The IETF takes no position regarding the validity or scope of any
  880. Intellectual Property Rights or other rights that might be claimed to
  881. pertain to the implementation or use of the technology described in
  882. this document or the extent to which any license under such rights
  883. might or might not be available; nor does it represent that it has
  884. made any independent effort to identify any such rights. Information
  885. on the procedures with respect to rights in RFC documents can be
  886. found in BCP 78 and BCP 79.
  887. Copies of IPR disclosures made to the IETF Secretariat and any
  888. assurances of licenses to be made available, or the result of an
  889. attempt made to obtain a general license or permission for the use of
  890. such proprietary rights by implementers or users of this
  891. specification can be obtained from the IETF on-line IPR repository at
  892. http://www.ietf.org/ipr.
  893. The IETF invites any interested party to bring to its attention any
  894. copyrights, patents or patent applications, or other proprietary
  895. rights that may cover technology that may be required to implement
  896. this standard. Please address the information to the IETF at
  897. ietf-ipr@ietf.org.
  898. Acknowledgment
  899. Funding for the RFC Editor function is provided by the IETF
  900. Administrative Support Activity (IASA).
  901. Barbato Expires December 27, 2007 [Page 25]