rfc5215.txt 53 KB

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