gosu 0.7.16 → 0.7.17

Sign up to get free protection for your applications and to get access to all the features.
Files changed (938) hide show
  1. data/Gosu/Version.hpp +2 -2
  2. data/GosuImpl/AudioFmod.cpp +7 -1
  3. data/GosuImpl/RubyGosuStub.mm +4 -1
  4. data/GosuImpl/RubyGosu_wrap.cxx +2 -2
  5. data/GosuImpl/TimingUnix.cpp +4 -1
  6. data/GosuImpl/TimingWin.cpp +31 -28
  7. data/GosuImpl/WindowWin.cpp +4 -0
  8. data/Rakefile +12 -18
  9. data/examples/ChipmunkIntegration.rb +1 -1
  10. data/examples/OpenGLIntegration.rb +1 -1
  11. data/examples/RMagickIntegration.rb +1 -1
  12. data/examples/Tutorial.cpp +2 -2
  13. data/examples/Tutorial.rb +1 -1
  14. data/lib/gosu/patches.rb +2 -2
  15. data/reference/cpp/_version_8hpp.html +4 -4
  16. data/reference/cpp/_version_8hpp_source.html +2 -2
  17. data/reference/rdoc/classes/Gosu.html +10 -10
  18. data/reference/rdoc/classes/Gosu/Color.html +3 -3
  19. data/reference/rdoc/classes/Gosu/Font.html +5 -5
  20. data/reference/rdoc/classes/Gosu/Image.html +9 -9
  21. data/reference/rdoc/classes/Gosu/Sample.html +3 -3
  22. data/reference/rdoc/classes/Gosu/SampleInstance.html +5 -5
  23. data/reference/rdoc/classes/Gosu/Song.html +7 -7
  24. data/reference/rdoc/classes/Gosu/TextInput.html +1 -1
  25. data/reference/rdoc/classes/Gosu/Window.html +17 -17
  26. data/reference/rdoc/classes/Numeric.html +2 -2
  27. data/reference/rdoc/created.rid +1 -1
  28. metadata +2 -912
  29. data/dependencies/libogg/AUTHORS +0 -4
  30. data/dependencies/libogg/CHANGES +0 -33
  31. data/dependencies/libogg/COPYING +0 -28
  32. data/dependencies/libogg/Makefile.am +0 -32
  33. data/dependencies/libogg/Makefile.in +0 -713
  34. data/dependencies/libogg/README +0 -103
  35. data/dependencies/libogg/aclocal.m4 +0 -6807
  36. data/dependencies/libogg/compile +0 -142
  37. data/dependencies/libogg/config.guess +0 -1465
  38. data/dependencies/libogg/config.h.in +0 -70
  39. data/dependencies/libogg/config.sub +0 -1569
  40. data/dependencies/libogg/configure +0 -23018
  41. data/dependencies/libogg/configure.in +0 -301
  42. data/dependencies/libogg/debian/changelog +0 -68
  43. data/dependencies/libogg/debian/control +0 -22
  44. data/dependencies/libogg/debian/copyright +0 -37
  45. data/dependencies/libogg/debian/libogg-dev.docs +0 -1
  46. data/dependencies/libogg/debian/libogg-dev.install +0 -8
  47. data/dependencies/libogg/debian/libogg0.README.Debian +0 -6
  48. data/dependencies/libogg/debian/libogg0.install +0 -1
  49. data/dependencies/libogg/debian/rules +0 -154
  50. data/dependencies/libogg/debian/watch +0 -3
  51. data/dependencies/libogg/depcomp +0 -529
  52. data/dependencies/libogg/doc/Makefile.am +0 -11
  53. data/dependencies/libogg/doc/Makefile.in +0 -518
  54. data/dependencies/libogg/doc/framing.html +0 -431
  55. data/dependencies/libogg/doc/index.html +0 -104
  56. data/dependencies/libogg/doc/libogg/Makefile.am +0 -28
  57. data/dependencies/libogg/doc/libogg/Makefile.in +0 -378
  58. data/dependencies/libogg/doc/libogg/bitpacking.html +0 -99
  59. data/dependencies/libogg/doc/libogg/datastructures.html +0 -59
  60. data/dependencies/libogg/doc/libogg/decoding.html +0 -100
  61. data/dependencies/libogg/doc/libogg/encoding.html +0 -64
  62. data/dependencies/libogg/doc/libogg/general.html +0 -105
  63. data/dependencies/libogg/doc/libogg/index.html +0 -39
  64. data/dependencies/libogg/doc/libogg/ogg_packet.html +0 -75
  65. data/dependencies/libogg/doc/libogg/ogg_packet_clear.html +0 -62
  66. data/dependencies/libogg/doc/libogg/ogg_page.html +0 -74
  67. data/dependencies/libogg/doc/libogg/ogg_page_bos.html +0 -65
  68. data/dependencies/libogg/doc/libogg/ogg_page_checksum_set.html +0 -62
  69. data/dependencies/libogg/doc/libogg/ogg_page_continued.html +0 -64
  70. data/dependencies/libogg/doc/libogg/ogg_page_eos.html +0 -65
  71. data/dependencies/libogg/doc/libogg/ogg_page_granulepos.html +0 -65
  72. data/dependencies/libogg/doc/libogg/ogg_page_packets.html +0 -75
  73. data/dependencies/libogg/doc/libogg/ogg_page_pageno.html +0 -63
  74. data/dependencies/libogg/doc/libogg/ogg_page_serialno.html +0 -63
  75. data/dependencies/libogg/doc/libogg/ogg_page_version.html +0 -63
  76. data/dependencies/libogg/doc/libogg/ogg_stream_clear.html +0 -61
  77. data/dependencies/libogg/doc/libogg/ogg_stream_destroy.html +0 -62
  78. data/dependencies/libogg/doc/libogg/ogg_stream_eos.html +0 -62
  79. data/dependencies/libogg/doc/libogg/ogg_stream_flush.html +0 -67
  80. data/dependencies/libogg/doc/libogg/ogg_stream_init.html +0 -66
  81. data/dependencies/libogg/doc/libogg/ogg_stream_packetin.html +0 -65
  82. data/dependencies/libogg/doc/libogg/ogg_stream_packetout.html +0 -71
  83. data/dependencies/libogg/doc/libogg/ogg_stream_packetpeek.html +0 -85
  84. data/dependencies/libogg/doc/libogg/ogg_stream_pagein.html +0 -67
  85. data/dependencies/libogg/doc/libogg/ogg_stream_pageout.html +0 -66
  86. data/dependencies/libogg/doc/libogg/ogg_stream_reset.html +0 -61
  87. data/dependencies/libogg/doc/libogg/ogg_stream_reset_serialno.html +0 -67
  88. data/dependencies/libogg/doc/libogg/ogg_stream_state.html +0 -121
  89. data/dependencies/libogg/doc/libogg/ogg_sync_buffer.html +0 -67
  90. data/dependencies/libogg/doc/libogg/ogg_sync_clear.html +0 -62
  91. data/dependencies/libogg/doc/libogg/ogg_sync_destroy.html +0 -62
  92. data/dependencies/libogg/doc/libogg/ogg_sync_init.html +0 -63
  93. data/dependencies/libogg/doc/libogg/ogg_sync_pageout.html +0 -79
  94. data/dependencies/libogg/doc/libogg/ogg_sync_pageseek.html +0 -68
  95. data/dependencies/libogg/doc/libogg/ogg_sync_reset.html +0 -63
  96. data/dependencies/libogg/doc/libogg/ogg_sync_state.html +0 -67
  97. data/dependencies/libogg/doc/libogg/ogg_sync_wrote.html +0 -73
  98. data/dependencies/libogg/doc/libogg/oggpack_adv.html +0 -64
  99. data/dependencies/libogg/doc/libogg/oggpack_adv1.html +0 -62
  100. data/dependencies/libogg/doc/libogg/oggpack_bits.html +0 -62
  101. data/dependencies/libogg/doc/libogg/oggpack_buffer.html +0 -66
  102. data/dependencies/libogg/doc/libogg/oggpack_bytes.html +0 -62
  103. data/dependencies/libogg/doc/libogg/oggpack_get_buffer.html +0 -62
  104. data/dependencies/libogg/doc/libogg/oggpack_look.html +0 -66
  105. data/dependencies/libogg/doc/libogg/oggpack_look1.html +0 -63
  106. data/dependencies/libogg/doc/libogg/oggpack_read.html +0 -65
  107. data/dependencies/libogg/doc/libogg/oggpack_read1.html +0 -63
  108. data/dependencies/libogg/doc/libogg/oggpack_readinit.html +0 -64
  109. data/dependencies/libogg/doc/libogg/oggpack_reset.html +0 -62
  110. data/dependencies/libogg/doc/libogg/oggpack_write.html +0 -68
  111. data/dependencies/libogg/doc/libogg/oggpack_writealign.html +0 -65
  112. data/dependencies/libogg/doc/libogg/oggpack_writeclear.html +0 -62
  113. data/dependencies/libogg/doc/libogg/oggpack_writecopy.html +0 -69
  114. data/dependencies/libogg/doc/libogg/oggpack_writeinit.html +0 -62
  115. data/dependencies/libogg/doc/libogg/oggpack_writetrunc.html +0 -65
  116. data/dependencies/libogg/doc/libogg/overview.html +0 -44
  117. data/dependencies/libogg/doc/libogg/reference.html +0 -93
  118. data/dependencies/libogg/doc/libogg/style.css +0 -7
  119. data/dependencies/libogg/doc/libogg/vorbis_comment.html +0 -70
  120. data/dependencies/libogg/doc/libogg/vorbis_info.html +0 -80
  121. data/dependencies/libogg/doc/ogg-multiplex.html +0 -445
  122. data/dependencies/libogg/doc/oggstream.html +0 -234
  123. data/dependencies/libogg/doc/rfc3533.txt +0 -843
  124. data/dependencies/libogg/doc/rfc3534.txt +0 -339
  125. data/dependencies/libogg/doc/stream.png +0 -0
  126. data/dependencies/libogg/doc/vorbisword2.png +0 -0
  127. data/dependencies/libogg/doc/white-ogg.png +0 -0
  128. data/dependencies/libogg/doc/white-xifish.png +0 -0
  129. data/dependencies/libogg/include/Makefile.am +0 -3
  130. data/dependencies/libogg/include/Makefile.in +0 -481
  131. data/dependencies/libogg/include/ogg/Makefile.am +0 -6
  132. data/dependencies/libogg/include/ogg/Makefile.in +0 -428
  133. data/dependencies/libogg/include/ogg/config_types.h.in +0 -11
  134. data/dependencies/libogg/include/ogg/ogg.h +0 -202
  135. data/dependencies/libogg/include/ogg/os_types.h +0 -127
  136. data/dependencies/libogg/install-sh +0 -323
  137. data/dependencies/libogg/libogg.spec +0 -106
  138. data/dependencies/libogg/libogg.spec.in +0 -106
  139. data/dependencies/libogg/ltmain.sh +0 -6426
  140. data/dependencies/libogg/macos/compat/strdup.c +0 -21
  141. data/dependencies/libogg/macos/compat/sys/types.h +0 -1
  142. data/dependencies/libogg/macos/libogg.mcp +0 -0
  143. data/dependencies/libogg/macos/libogg.mcp.exp +0 -64
  144. data/dependencies/libogg/macosx/English.lproj/InfoPlist.strings +0 -0
  145. data/dependencies/libogg/macosx/Info.plist +0 -30
  146. data/dependencies/libogg/macosx/Ogg.xcodeproj/project.pbxproj +0 -303
  147. data/dependencies/libogg/macosx/Ogg_Prefix.pch +0 -5
  148. data/dependencies/libogg/missing +0 -357
  149. data/dependencies/libogg/ogg-uninstalled.pc.in +0 -14
  150. data/dependencies/libogg/ogg.m4 +0 -102
  151. data/dependencies/libogg/ogg.pc.in +0 -14
  152. data/dependencies/libogg/src/Makefile.am +0 -28
  153. data/dependencies/libogg/src/Makefile.in +0 -536
  154. data/dependencies/libogg/src/bitwise.c +0 -784
  155. data/dependencies/libogg/src/framing.c +0 -1800
  156. data/dependencies/libogg/win32/Makefile.am +0 -5
  157. data/dependencies/libogg/win32/Makefile.in +0 -327
  158. data/dependencies/libogg/win32/build_ogg_dynamic.bat +0 -18
  159. data/dependencies/libogg/win32/build_ogg_dynamic_debug.bat +0 -18
  160. data/dependencies/libogg/win32/build_ogg_static.bat +0 -18
  161. data/dependencies/libogg/win32/build_ogg_static_debug.bat +0 -18
  162. data/dependencies/libogg/win32/ogg.def +0 -78
  163. data/dependencies/libogg/win32/ogg.dsw +0 -41
  164. data/dependencies/libogg/win32/ogg_dynamic.dsp +0 -128
  165. data/dependencies/libogg/win32/ogg_static.dsp +0 -108
  166. data/dependencies/libpng/ANNOUNCE +0 -61
  167. data/dependencies/libpng/CHANGES +0 -2173
  168. data/dependencies/libpng/INSTALL +0 -199
  169. data/dependencies/libpng/KNOWNBUG +0 -22
  170. data/dependencies/libpng/LICENSE +0 -109
  171. data/dependencies/libpng/README +0 -264
  172. data/dependencies/libpng/TODO +0 -24
  173. data/dependencies/libpng/Y2KINFO +0 -55
  174. data/dependencies/libpng/configure +0 -13
  175. data/dependencies/libpng/contrib/gregbook/COPYING +0 -340
  176. data/dependencies/libpng/contrib/gregbook/LICENSE +0 -50
  177. data/dependencies/libpng/contrib/gregbook/Makefile.mingw32 +0 -130
  178. data/dependencies/libpng/contrib/gregbook/Makefile.sgi +0 -104
  179. data/dependencies/libpng/contrib/gregbook/Makefile.unx +0 -132
  180. data/dependencies/libpng/contrib/gregbook/Makefile.w32 +0 -113
  181. data/dependencies/libpng/contrib/gregbook/README +0 -186
  182. data/dependencies/libpng/contrib/gregbook/makevms.com +0 -132
  183. data/dependencies/libpng/contrib/gregbook/readpng.c +0 -304
  184. data/dependencies/libpng/contrib/gregbook/readpng.h +0 -88
  185. data/dependencies/libpng/contrib/gregbook/readpng2.c +0 -645
  186. data/dependencies/libpng/contrib/gregbook/readpng2.h +0 -121
  187. data/dependencies/libpng/contrib/gregbook/readppm.c +0 -179
  188. data/dependencies/libpng/contrib/gregbook/rpng-win.c +0 -684
  189. data/dependencies/libpng/contrib/gregbook/rpng-x.c +0 -904
  190. data/dependencies/libpng/contrib/gregbook/rpng2-win.c +0 -1225
  191. data/dependencies/libpng/contrib/gregbook/rpng2-x.c +0 -2127
  192. data/dependencies/libpng/contrib/gregbook/toucan.png +0 -0
  193. data/dependencies/libpng/contrib/gregbook/wpng.c +0 -853
  194. data/dependencies/libpng/contrib/gregbook/writepng.c +0 -392
  195. data/dependencies/libpng/contrib/gregbook/writepng.h +0 -133
  196. data/dependencies/libpng/contrib/pngminim/decoder/README +0 -6
  197. data/dependencies/libpng/contrib/pngminim/decoder/gather.sh +0 -8
  198. data/dependencies/libpng/contrib/pngminim/decoder/makefile.std +0 -44
  199. data/dependencies/libpng/contrib/pngminim/decoder/pngusr.h +0 -67
  200. data/dependencies/libpng/contrib/pngminim/encoder/README +0 -6
  201. data/dependencies/libpng/contrib/pngminim/encoder/dummy_inflate.c +0 -27
  202. data/dependencies/libpng/contrib/pngminim/encoder/gather.sh +0 -9
  203. data/dependencies/libpng/contrib/pngminim/encoder/makefile.std +0 -43
  204. data/dependencies/libpng/contrib/pngminim/encoder/pngusr.h +0 -66
  205. data/dependencies/libpng/contrib/pngminus/README +0 -153
  206. data/dependencies/libpng/contrib/pngminus/makefile.std +0 -65
  207. data/dependencies/libpng/contrib/pngminus/makefile.tc3 +0 -38
  208. data/dependencies/libpng/contrib/pngminus/makevms.com +0 -92
  209. data/dependencies/libpng/contrib/pngminus/png2pnm.bat +0 -41
  210. data/dependencies/libpng/contrib/pngminus/png2pnm.c +0 -430
  211. data/dependencies/libpng/contrib/pngminus/png2pnm.sh +0 -42
  212. data/dependencies/libpng/contrib/pngminus/pngminus.bat +0 -4
  213. data/dependencies/libpng/contrib/pngminus/pngminus.sh +0 -5
  214. data/dependencies/libpng/contrib/pngminus/pnm2png.bat +0 -41
  215. data/dependencies/libpng/contrib/pngminus/pnm2png.c +0 -533
  216. data/dependencies/libpng/contrib/pngminus/pnm2png.sh +0 -42
  217. data/dependencies/libpng/contrib/pngsuite/basn0g01.png +0 -0
  218. data/dependencies/libpng/contrib/pngsuite/basn0g02.png +0 -0
  219. data/dependencies/libpng/contrib/pngsuite/basn0g04.png +0 -0
  220. data/dependencies/libpng/contrib/pngsuite/basn0g08.png +0 -0
  221. data/dependencies/libpng/contrib/pngsuite/basn0g16.png +0 -0
  222. data/dependencies/libpng/contrib/pngsuite/basn2c08.png +0 -0
  223. data/dependencies/libpng/contrib/pngsuite/basn2c16.png +0 -0
  224. data/dependencies/libpng/contrib/pngsuite/basn3p01.png +0 -0
  225. data/dependencies/libpng/contrib/pngsuite/basn3p02.png +0 -0
  226. data/dependencies/libpng/contrib/pngsuite/basn3p04.png +0 -0
  227. data/dependencies/libpng/contrib/pngsuite/basn3p08.png +0 -0
  228. data/dependencies/libpng/contrib/pngsuite/basn4a08.png +0 -0
  229. data/dependencies/libpng/contrib/pngsuite/basn4a16.png +0 -0
  230. data/dependencies/libpng/contrib/pngsuite/basn6a08.png +0 -0
  231. data/dependencies/libpng/contrib/pngsuite/basn6a16.png +0 -0
  232. data/dependencies/libpng/contrib/visupng/PngFile.c +0 -439
  233. data/dependencies/libpng/contrib/visupng/PngFile.h +0 -27
  234. data/dependencies/libpng/contrib/visupng/README.txt +0 -58
  235. data/dependencies/libpng/contrib/visupng/VisualPng.c +0 -961
  236. data/dependencies/libpng/contrib/visupng/VisualPng.dsp +0 -147
  237. data/dependencies/libpng/contrib/visupng/VisualPng.dsw +0 -29
  238. data/dependencies/libpng/contrib/visupng/VisualPng.ico +0 -0
  239. data/dependencies/libpng/contrib/visupng/VisualPng.png +0 -0
  240. data/dependencies/libpng/contrib/visupng/VisualPng.rc +0 -152
  241. data/dependencies/libpng/contrib/visupng/cexcept.h +0 -243
  242. data/dependencies/libpng/contrib/visupng/resource.h +0 -23
  243. data/dependencies/libpng/example.c +0 -814
  244. data/dependencies/libpng/libpng-1.2.29.txt +0 -2906
  245. data/dependencies/libpng/libpng.3 +0 -3680
  246. data/dependencies/libpng/libpngpf.3 +0 -274
  247. data/dependencies/libpng/png.5 +0 -74
  248. data/dependencies/libpng/png.c +0 -798
  249. data/dependencies/libpng/png.h +0 -3569
  250. data/dependencies/libpng/pngbar.jpg +0 -0
  251. data/dependencies/libpng/pngbar.png +0 -0
  252. data/dependencies/libpng/pngconf.h +0 -1481
  253. data/dependencies/libpng/pngerror.c +0 -343
  254. data/dependencies/libpng/pnggccrd.c +0 -103
  255. data/dependencies/libpng/pngget.c +0 -901
  256. data/dependencies/libpng/pngmem.c +0 -608
  257. data/dependencies/libpng/pngnow.png +0 -0
  258. data/dependencies/libpng/pngpread.c +0 -1598
  259. data/dependencies/libpng/pngread.c +0 -1479
  260. data/dependencies/libpng/pngrio.c +0 -167
  261. data/dependencies/libpng/pngrtran.c +0 -4292
  262. data/dependencies/libpng/pngrutil.c +0 -3183
  263. data/dependencies/libpng/pngset.c +0 -1268
  264. data/dependencies/libpng/pngtest.c +0 -1563
  265. data/dependencies/libpng/pngtest.png +0 -0
  266. data/dependencies/libpng/pngtrans.c +0 -662
  267. data/dependencies/libpng/pngvcrd.c +0 -1
  268. data/dependencies/libpng/pngwio.c +0 -234
  269. data/dependencies/libpng/pngwrite.c +0 -1532
  270. data/dependencies/libpng/pngwtran.c +0 -572
  271. data/dependencies/libpng/pngwutil.c +0 -2802
  272. data/dependencies/libpng/projects/beos/x86-shared.proj +0 -0
  273. data/dependencies/libpng/projects/beos/x86-shared.txt +0 -22
  274. data/dependencies/libpng/projects/beos/x86-static.proj +0 -0
  275. data/dependencies/libpng/projects/beos/x86-static.txt +0 -22
  276. data/dependencies/libpng/projects/cbuilder5/libpng.bpf +0 -22
  277. data/dependencies/libpng/projects/cbuilder5/libpng.bpg +0 -25
  278. data/dependencies/libpng/projects/cbuilder5/libpng.bpr +0 -157
  279. data/dependencies/libpng/projects/cbuilder5/libpng.cpp +0 -29
  280. data/dependencies/libpng/projects/cbuilder5/libpng.readme.txt +0 -25
  281. data/dependencies/libpng/projects/cbuilder5/libpngstat.bpf +0 -22
  282. data/dependencies/libpng/projects/cbuilder5/libpngstat.bpr +0 -109
  283. data/dependencies/libpng/projects/cbuilder5/zlib.readme.txt +0 -14
  284. data/dependencies/libpng/projects/netware.txt +0 -6
  285. data/dependencies/libpng/projects/visualc6/README.txt +0 -57
  286. data/dependencies/libpng/projects/visualc6/libpng.dsp +0 -472
  287. data/dependencies/libpng/projects/visualc6/libpng.dsw +0 -59
  288. data/dependencies/libpng/projects/visualc6/pngtest.dsp +0 -314
  289. data/dependencies/libpng/projects/visualc71/PRJ0041.mak +0 -21
  290. data/dependencies/libpng/projects/visualc71/README.txt +0 -57
  291. data/dependencies/libpng/projects/visualc71/README_zlib.txt +0 -44
  292. data/dependencies/libpng/projects/visualc71/libpng.sln +0 -88
  293. data/dependencies/libpng/projects/visualc71/libpng.vcproj +0 -702
  294. data/dependencies/libpng/projects/visualc71/pngtest.vcproj +0 -459
  295. data/dependencies/libpng/projects/visualc71/zlib.vcproj +0 -670
  296. data/dependencies/libpng/projects/wince.txt +0 -6
  297. data/dependencies/libpng/scripts/CMakeLists.txt +0 -210
  298. data/dependencies/libpng/scripts/SCOPTIONS.ppc +0 -7
  299. data/dependencies/libpng/scripts/descrip.mms +0 -52
  300. data/dependencies/libpng/scripts/libpng-config-body.in +0 -96
  301. data/dependencies/libpng/scripts/libpng-config-head.in +0 -21
  302. data/dependencies/libpng/scripts/libpng-config.in +0 -124
  303. data/dependencies/libpng/scripts/libpng.icc +0 -44
  304. data/dependencies/libpng/scripts/libpng.pc-configure.in +0 -10
  305. data/dependencies/libpng/scripts/libpng.pc.in +0 -10
  306. data/dependencies/libpng/scripts/makefile.32sunu +0 -254
  307. data/dependencies/libpng/scripts/makefile.64sunu +0 -254
  308. data/dependencies/libpng/scripts/makefile.acorn +0 -51
  309. data/dependencies/libpng/scripts/makefile.aix +0 -113
  310. data/dependencies/libpng/scripts/makefile.amiga +0 -48
  311. data/dependencies/libpng/scripts/makefile.atari +0 -51
  312. data/dependencies/libpng/scripts/makefile.bc32 +0 -152
  313. data/dependencies/libpng/scripts/makefile.beos +0 -226
  314. data/dependencies/libpng/scripts/makefile.bor +0 -162
  315. data/dependencies/libpng/scripts/makefile.cygwin +0 -299
  316. data/dependencies/libpng/scripts/makefile.darwin +0 -234
  317. data/dependencies/libpng/scripts/makefile.dec +0 -214
  318. data/dependencies/libpng/scripts/makefile.dj2 +0 -55
  319. data/dependencies/libpng/scripts/makefile.elf +0 -275
  320. data/dependencies/libpng/scripts/makefile.freebsd +0 -48
  321. data/dependencies/libpng/scripts/makefile.gcc +0 -79
  322. data/dependencies/libpng/scripts/makefile.gcmmx +0 -271
  323. data/dependencies/libpng/scripts/makefile.hp64 +0 -235
  324. data/dependencies/libpng/scripts/makefile.hpgcc +0 -245
  325. data/dependencies/libpng/scripts/makefile.hpux +0 -232
  326. data/dependencies/libpng/scripts/makefile.ibmc +0 -71
  327. data/dependencies/libpng/scripts/makefile.intel +0 -102
  328. data/dependencies/libpng/scripts/makefile.knr +0 -99
  329. data/dependencies/libpng/scripts/makefile.linux +0 -249
  330. data/dependencies/libpng/scripts/makefile.mingw +0 -289
  331. data/dependencies/libpng/scripts/makefile.mips +0 -83
  332. data/dependencies/libpng/scripts/makefile.msc +0 -86
  333. data/dependencies/libpng/scripts/makefile.ne12bsd +0 -45
  334. data/dependencies/libpng/scripts/makefile.netbsd +0 -45
  335. data/dependencies/libpng/scripts/makefile.nommx +0 -252
  336. data/dependencies/libpng/scripts/makefile.openbsd +0 -73
  337. data/dependencies/libpng/scripts/makefile.os2 +0 -69
  338. data/dependencies/libpng/scripts/makefile.sco +0 -229
  339. data/dependencies/libpng/scripts/makefile.sggcc +0 -242
  340. data/dependencies/libpng/scripts/makefile.sgi +0 -245
  341. data/dependencies/libpng/scripts/makefile.so9 +0 -251
  342. data/dependencies/libpng/scripts/makefile.solaris +0 -249
  343. data/dependencies/libpng/scripts/makefile.solaris-x86 +0 -248
  344. data/dependencies/libpng/scripts/makefile.std +0 -92
  345. data/dependencies/libpng/scripts/makefile.sunos +0 -97
  346. data/dependencies/libpng/scripts/makefile.tc3 +0 -89
  347. data/dependencies/libpng/scripts/makefile.vcawin32 +0 -99
  348. data/dependencies/libpng/scripts/makefile.vcwin32 +0 -99
  349. data/dependencies/libpng/scripts/makefile.watcom +0 -109
  350. data/dependencies/libpng/scripts/makevms.com +0 -144
  351. data/dependencies/libpng/scripts/pngos2.def +0 -257
  352. data/dependencies/libpng/scripts/pngw32.def +0 -238
  353. data/dependencies/libpng/scripts/pngw32.rc +0 -112
  354. data/dependencies/libpng/scripts/smakefile.ppc +0 -30
  355. data/dependencies/libvorbis/AUTHORS +0 -3
  356. data/dependencies/libvorbis/CHANGES +0 -48
  357. data/dependencies/libvorbis/COPYING +0 -28
  358. data/dependencies/libvorbis/Makefile.am +0 -41
  359. data/dependencies/libvorbis/Makefile.in +0 -759
  360. data/dependencies/libvorbis/README +0 -132
  361. data/dependencies/libvorbis/acinclude.m4 +0 -161
  362. data/dependencies/libvorbis/aclocal.m4 +0 -7273
  363. data/dependencies/libvorbis/autogen.sh +0 -127
  364. data/dependencies/libvorbis/config.guess +0 -1500
  365. data/dependencies/libvorbis/config.h.in +0 -78
  366. data/dependencies/libvorbis/config.sub +0 -1616
  367. data/dependencies/libvorbis/configure +0 -22114
  368. data/dependencies/libvorbis/configure.in +0 -246
  369. data/dependencies/libvorbis/depcomp +0 -584
  370. data/dependencies/libvorbis/doc/Makefile +0 -665
  371. data/dependencies/libvorbis/doc/Makefile.am +0 -137
  372. data/dependencies/libvorbis/doc/Makefile.in +0 -665
  373. data/dependencies/libvorbis/doc/Vorbis_I_spec.html +0 -2292
  374. data/dependencies/libvorbis/doc/Vorbis_I_spec.pdf +0 -0
  375. data/dependencies/libvorbis/doc/components.png +0 -0
  376. data/dependencies/libvorbis/doc/draft-ietf-avt-rtp-vorbis-06.txt +0 -1401
  377. data/dependencies/libvorbis/doc/draft-ietf-avt-rtp-vorbis-06.xml +0 -1388
  378. data/dependencies/libvorbis/doc/eightphase.png +0 -0
  379. data/dependencies/libvorbis/doc/evenlsp.png +0 -0
  380. data/dependencies/libvorbis/doc/fish_xiph_org.png +0 -0
  381. data/dependencies/libvorbis/doc/floor1-1.png +0 -0
  382. data/dependencies/libvorbis/doc/floor1-2.png +0 -0
  383. data/dependencies/libvorbis/doc/floor1-3.png +0 -0
  384. data/dependencies/libvorbis/doc/floor1-4.png +0 -0
  385. data/dependencies/libvorbis/doc/floor1_inverse_dB_table.html +0 -154
  386. data/dependencies/libvorbis/doc/floorval.png +0 -0
  387. data/dependencies/libvorbis/doc/fourphase.png +0 -0
  388. data/dependencies/libvorbis/doc/framing.html +0 -431
  389. data/dependencies/libvorbis/doc/helper.html +0 -239
  390. data/dependencies/libvorbis/doc/hufftree-under.png +0 -0
  391. data/dependencies/libvorbis/doc/hufftree.png +0 -0
  392. data/dependencies/libvorbis/doc/index.html +0 -114
  393. data/dependencies/libvorbis/doc/lspmap.png +0 -0
  394. data/dependencies/libvorbis/doc/oddlsp.png +0 -0
  395. data/dependencies/libvorbis/doc/oggstream.html +0 -234
  396. data/dependencies/libvorbis/doc/programming.html +0 -554
  397. data/dependencies/libvorbis/doc/residue-pack.png +0 -0
  398. data/dependencies/libvorbis/doc/residue2.png +0 -0
  399. data/dependencies/libvorbis/doc/squarepolar.png +0 -0
  400. data/dependencies/libvorbis/doc/stereo.html +0 -418
  401. data/dependencies/libvorbis/doc/stream.png +0 -0
  402. data/dependencies/libvorbis/doc/v-comment.html +0 -285
  403. data/dependencies/libvorbis/doc/vorbis-clip.txt +0 -139
  404. data/dependencies/libvorbis/doc/vorbis-errors.txt +0 -103
  405. data/dependencies/libvorbis/doc/vorbis-fidelity.html +0 -180
  406. data/dependencies/libvorbis/doc/vorbis.html +0 -234
  407. data/dependencies/libvorbis/doc/vorbisenc/Makefile +0 -382
  408. data/dependencies/libvorbis/doc/vorbisenc/Makefile.am +0 -9
  409. data/dependencies/libvorbis/doc/vorbisenc/Makefile.in +0 -382
  410. data/dependencies/libvorbis/doc/vorbisenc/changes.html +0 -104
  411. data/dependencies/libvorbis/doc/vorbisenc/examples.html +0 -133
  412. data/dependencies/libvorbis/doc/vorbisenc/index.html +0 -40
  413. data/dependencies/libvorbis/doc/vorbisenc/ov_ectl_ratemanage2_arg.html +0 -92
  414. data/dependencies/libvorbis/doc/vorbisenc/ov_ectl_ratemanage_arg.html +0 -92
  415. data/dependencies/libvorbis/doc/vorbisenc/overview.html +0 -382
  416. data/dependencies/libvorbis/doc/vorbisenc/reference.html +0 -48
  417. data/dependencies/libvorbis/doc/vorbisenc/style.css +0 -7
  418. data/dependencies/libvorbis/doc/vorbisenc/vorbis_encode_ctl.html +0 -169
  419. data/dependencies/libvorbis/doc/vorbisenc/vorbis_encode_init.html +0 -88
  420. data/dependencies/libvorbis/doc/vorbisenc/vorbis_encode_init_vbr.html +0 -81
  421. data/dependencies/libvorbis/doc/vorbisenc/vorbis_encode_setup_init.html +0 -88
  422. data/dependencies/libvorbis/doc/vorbisenc/vorbis_encode_setup_managed.html +0 -102
  423. data/dependencies/libvorbis/doc/vorbisenc/vorbis_encode_setup_vbr.html +0 -90
  424. data/dependencies/libvorbis/doc/vorbisenc/vorbis_info.html +0 -81
  425. data/dependencies/libvorbis/doc/vorbisfile/Makefile +0 -396
  426. data/dependencies/libvorbis/doc/vorbisfile/Makefile.am +0 -23
  427. data/dependencies/libvorbis/doc/vorbisfile/Makefile.in +0 -396
  428. data/dependencies/libvorbis/doc/vorbisfile/OggVorbis_File.html +0 -137
  429. data/dependencies/libvorbis/doc/vorbisfile/callbacks.html +0 -121
  430. data/dependencies/libvorbis/doc/vorbisfile/chaining_example_c.html +0 -90
  431. data/dependencies/libvorbis/doc/vorbisfile/chainingexample.html +0 -175
  432. data/dependencies/libvorbis/doc/vorbisfile/crosslap.html +0 -121
  433. data/dependencies/libvorbis/doc/vorbisfile/datastructures.html +0 -61
  434. data/dependencies/libvorbis/doc/vorbisfile/decoding.html +0 -87
  435. data/dependencies/libvorbis/doc/vorbisfile/example.html +0 -208
  436. data/dependencies/libvorbis/doc/vorbisfile/exampleindex.html +0 -39
  437. data/dependencies/libvorbis/doc/vorbisfile/fileinfo.html +0 -95
  438. data/dependencies/libvorbis/doc/vorbisfile/index.html +0 -49
  439. data/dependencies/libvorbis/doc/vorbisfile/initialization.html +0 -118
  440. data/dependencies/libvorbis/doc/vorbisfile/ov_bitrate.html +0 -72
  441. data/dependencies/libvorbis/doc/vorbisfile/ov_bitrate_instant.html +0 -65
  442. data/dependencies/libvorbis/doc/vorbisfile/ov_callbacks.html +0 -117
  443. data/dependencies/libvorbis/doc/vorbisfile/ov_clear.html +0 -64
  444. data/dependencies/libvorbis/doc/vorbisfile/ov_comment.html +0 -66
  445. data/dependencies/libvorbis/doc/vorbisfile/ov_crosslap.html +0 -100
  446. data/dependencies/libvorbis/doc/vorbisfile/ov_fopen.html +0 -124
  447. data/dependencies/libvorbis/doc/vorbisfile/ov_info.html +0 -64
  448. data/dependencies/libvorbis/doc/vorbisfile/ov_open.html +0 -183
  449. data/dependencies/libvorbis/doc/vorbisfile/ov_open_callbacks.html +0 -147
  450. data/dependencies/libvorbis/doc/vorbisfile/ov_pcm_seek.html +0 -83
  451. data/dependencies/libvorbis/doc/vorbisfile/ov_pcm_seek_lap.html +0 -103
  452. data/dependencies/libvorbis/doc/vorbisfile/ov_pcm_seek_page.html +0 -84
  453. data/dependencies/libvorbis/doc/vorbisfile/ov_pcm_seek_page_lap.html +0 -112
  454. data/dependencies/libvorbis/doc/vorbisfile/ov_pcm_tell.html +0 -63
  455. data/dependencies/libvorbis/doc/vorbisfile/ov_pcm_total.html +0 -67
  456. data/dependencies/libvorbis/doc/vorbisfile/ov_raw_seek.html +0 -83
  457. data/dependencies/libvorbis/doc/vorbisfile/ov_raw_seek_lap.html +0 -110
  458. data/dependencies/libvorbis/doc/vorbisfile/ov_raw_tell.html +0 -65
  459. data/dependencies/libvorbis/doc/vorbisfile/ov_raw_total.html +0 -68
  460. data/dependencies/libvorbis/doc/vorbisfile/ov_read.html +0 -123
  461. data/dependencies/libvorbis/doc/vorbisfile/ov_read_float.html +0 -101
  462. data/dependencies/libvorbis/doc/vorbisfile/ov_seekable.html +0 -63
  463. data/dependencies/libvorbis/doc/vorbisfile/ov_serialnumber.html +0 -67
  464. data/dependencies/libvorbis/doc/vorbisfile/ov_streams.html +0 -64
  465. data/dependencies/libvorbis/doc/vorbisfile/ov_test.html +0 -101
  466. data/dependencies/libvorbis/doc/vorbisfile/ov_test_callbacks.html +0 -111
  467. data/dependencies/libvorbis/doc/vorbisfile/ov_test_open.html +0 -82
  468. data/dependencies/libvorbis/doc/vorbisfile/ov_time_seek.html +0 -82
  469. data/dependencies/libvorbis/doc/vorbisfile/ov_time_seek_lap.html +0 -105
  470. data/dependencies/libvorbis/doc/vorbisfile/ov_time_seek_page.html +0 -83
  471. data/dependencies/libvorbis/doc/vorbisfile/ov_time_seek_page_lap.html +0 -112
  472. data/dependencies/libvorbis/doc/vorbisfile/ov_time_tell.html +0 -63
  473. data/dependencies/libvorbis/doc/vorbisfile/ov_time_total.html +0 -67
  474. data/dependencies/libvorbis/doc/vorbisfile/overview.html +0 -61
  475. data/dependencies/libvorbis/doc/vorbisfile/reference.html +0 -83
  476. data/dependencies/libvorbis/doc/vorbisfile/return.html +0 -77
  477. data/dependencies/libvorbis/doc/vorbisfile/seekexample.html +0 -152
  478. data/dependencies/libvorbis/doc/vorbisfile/seeking.html +0 -107
  479. data/dependencies/libvorbis/doc/vorbisfile/seeking_example_c.html +0 -86
  480. data/dependencies/libvorbis/doc/vorbisfile/seeking_test_c.html +0 -86
  481. data/dependencies/libvorbis/doc/vorbisfile/seekingexample.html +0 -203
  482. data/dependencies/libvorbis/doc/vorbisfile/style.css +0 -7
  483. data/dependencies/libvorbis/doc/vorbisfile/threads.html +0 -50
  484. data/dependencies/libvorbis/doc/vorbisfile/vorbis_comment.html +0 -70
  485. data/dependencies/libvorbis/doc/vorbisfile/vorbis_info.html +0 -80
  486. data/dependencies/libvorbis/doc/vorbisfile/vorbisfile_example_c.html +0 -106
  487. data/dependencies/libvorbis/doc/vorbisword2.png +0 -0
  488. data/dependencies/libvorbis/doc/wait.png +0 -0
  489. data/dependencies/libvorbis/doc/white-ogg.png +0 -0
  490. data/dependencies/libvorbis/doc/white-xifish.png +0 -0
  491. data/dependencies/libvorbis/doc/window1.png +0 -0
  492. data/dependencies/libvorbis/doc/window2.png +0 -0
  493. data/dependencies/libvorbis/doc/xifish.pdf +0 -0
  494. data/dependencies/libvorbis/doc/xml/01-introduction.xml +0 -665
  495. data/dependencies/libvorbis/doc/xml/02-bitpacking.xml +0 -280
  496. data/dependencies/libvorbis/doc/xml/03-codebook.xml +0 -458
  497. data/dependencies/libvorbis/doc/xml/04-codec.xml +0 -711
  498. data/dependencies/libvorbis/doc/xml/05-comment.xml +0 -284
  499. data/dependencies/libvorbis/doc/xml/06-floor0.xml +0 -257
  500. data/dependencies/libvorbis/doc/xml/07-floor1.xml +0 -450
  501. data/dependencies/libvorbis/doc/xml/08-residue.xml +0 -492
  502. data/dependencies/libvorbis/doc/xml/09-helper.xml +0 -211
  503. data/dependencies/libvorbis/doc/xml/10-tables.xml +0 -94
  504. data/dependencies/libvorbis/doc/xml/TODO +0 -28
  505. data/dependencies/libvorbis/doc/xml/Vorbis_I_spec.xml +0 -30
  506. data/dependencies/libvorbis/doc/xml/a1-encapsulation_ogg.xml +0 -201
  507. data/dependencies/libvorbis/doc/xml/a2-encapsulation_rtp.xml +0 -31
  508. data/dependencies/libvorbis/doc/xml/footer.xml +0 -60
  509. data/dependencies/libvorbis/doc/xml/spec-common.xsl +0 -24
  510. data/dependencies/libvorbis/doc/xml/spec-fo.xsl +0 -16
  511. data/dependencies/libvorbis/doc/xml/spec-html.xsl +0 -5
  512. data/dependencies/libvorbis/examples/Makefile +0 -515
  513. data/dependencies/libvorbis/examples/Makefile.am +0 -28
  514. data/dependencies/libvorbis/examples/Makefile.in +0 -515
  515. data/dependencies/libvorbis/examples/chaining_example.c +0 -72
  516. data/dependencies/libvorbis/examples/decoder_example.c +0 -307
  517. data/dependencies/libvorbis/examples/encoder_example.c +0 -253
  518. data/dependencies/libvorbis/examples/frameview.pl +0 -630
  519. data/dependencies/libvorbis/examples/seeking_example.c +0 -256
  520. data/dependencies/libvorbis/examples/vorbisfile_example.c +0 -87
  521. data/dependencies/libvorbis/include/Makefile.am +0 -3
  522. data/dependencies/libvorbis/include/Makefile.in +0 -506
  523. data/dependencies/libvorbis/include/vorbis/Makefile.am +0 -7
  524. data/dependencies/libvorbis/include/vorbis/Makefile.in +0 -426
  525. data/dependencies/libvorbis/include/vorbis/codec.h +0 -241
  526. data/dependencies/libvorbis/include/vorbis/vorbisenc.h +0 -112
  527. data/dependencies/libvorbis/include/vorbis/vorbisfile.h +0 -183
  528. data/dependencies/libvorbis/install-sh +0 -507
  529. data/dependencies/libvorbis/lib/Makefile.am +0 -44
  530. data/dependencies/libvorbis/lib/Makefile.in +0 -706
  531. data/dependencies/libvorbis/lib/analysis.c +0 -121
  532. data/dependencies/libvorbis/lib/backends.h +0 -146
  533. data/dependencies/libvorbis/lib/barkmel.c +0 -64
  534. data/dependencies/libvorbis/lib/bitrate.c +0 -253
  535. data/dependencies/libvorbis/lib/bitrate.h +0 -59
  536. data/dependencies/libvorbis/lib/block.c +0 -993
  537. data/dependencies/libvorbis/lib/books/Makefile.am +0 -3
  538. data/dependencies/libvorbis/lib/books/Makefile.in +0 -506
  539. data/dependencies/libvorbis/lib/books/coupled/Makefile.am +0 -3
  540. data/dependencies/libvorbis/lib/books/coupled/Makefile.in +0 -347
  541. data/dependencies/libvorbis/lib/books/coupled/res_books_stereo.h +0 -20681
  542. data/dependencies/libvorbis/lib/books/floor/Makefile.am +0 -3
  543. data/dependencies/libvorbis/lib/books/floor/Makefile.in +0 -347
  544. data/dependencies/libvorbis/lib/books/floor/floor_books.h +0 -1838
  545. data/dependencies/libvorbis/lib/books/uncoupled/Makefile.am +0 -3
  546. data/dependencies/libvorbis/lib/books/uncoupled/Makefile.in +0 -347
  547. data/dependencies/libvorbis/lib/books/uncoupled/res_books_uncoupled.h +0 -11517
  548. data/dependencies/libvorbis/lib/codebook.c +0 -634
  549. data/dependencies/libvorbis/lib/codebook.h +0 -160
  550. data/dependencies/libvorbis/lib/codec_internal.h +0 -137
  551. data/dependencies/libvorbis/lib/envelope.c +0 -382
  552. data/dependencies/libvorbis/lib/envelope.h +0 -81
  553. data/dependencies/libvorbis/lib/floor0.c +0 -223
  554. data/dependencies/libvorbis/lib/floor1.c +0 -1094
  555. data/dependencies/libvorbis/lib/highlevel.h +0 -57
  556. data/dependencies/libvorbis/lib/info.c +0 -644
  557. data/dependencies/libvorbis/lib/lookup.c +0 -94
  558. data/dependencies/libvorbis/lib/lookup.h +0 -32
  559. data/dependencies/libvorbis/lib/lookup_data.h +0 -189
  560. data/dependencies/libvorbis/lib/lookups.pl +0 -142
  561. data/dependencies/libvorbis/lib/lpc.c +0 -149
  562. data/dependencies/libvorbis/lib/lpc.h +0 -29
  563. data/dependencies/libvorbis/lib/lsp.c +0 -455
  564. data/dependencies/libvorbis/lib/lsp.h +0 -28
  565. data/dependencies/libvorbis/lib/mapping0.c +0 -844
  566. data/dependencies/libvorbis/lib/masking.h +0 -785
  567. data/dependencies/libvorbis/lib/mdct.c +0 -564
  568. data/dependencies/libvorbis/lib/mdct.h +0 -83
  569. data/dependencies/libvorbis/lib/misc.h +0 -52
  570. data/dependencies/libvorbis/lib/modes/Makefile.am +0 -6
  571. data/dependencies/libvorbis/lib/modes/Makefile.in +0 -351
  572. data/dependencies/libvorbis/lib/modes/floor_all.h +0 -248
  573. data/dependencies/libvorbis/lib/modes/psych_11.h +0 -51
  574. data/dependencies/libvorbis/lib/modes/psych_16.h +0 -136
  575. data/dependencies/libvorbis/lib/modes/psych_44.h +0 -666
  576. data/dependencies/libvorbis/lib/modes/psych_8.h +0 -102
  577. data/dependencies/libvorbis/lib/modes/residue_16.h +0 -163
  578. data/dependencies/libvorbis/lib/modes/residue_44.h +0 -294
  579. data/dependencies/libvorbis/lib/modes/residue_44u.h +0 -318
  580. data/dependencies/libvorbis/lib/modes/residue_8.h +0 -109
  581. data/dependencies/libvorbis/lib/modes/setup_11.h +0 -141
  582. data/dependencies/libvorbis/lib/modes/setup_16.h +0 -149
  583. data/dependencies/libvorbis/lib/modes/setup_22.h +0 -128
  584. data/dependencies/libvorbis/lib/modes/setup_32.h +0 -132
  585. data/dependencies/libvorbis/lib/modes/setup_44.h +0 -107
  586. data/dependencies/libvorbis/lib/modes/setup_44u.h +0 -74
  587. data/dependencies/libvorbis/lib/modes/setup_8.h +0 -146
  588. data/dependencies/libvorbis/lib/modes/setup_X.h +0 -226
  589. data/dependencies/libvorbis/lib/os.h +0 -156
  590. data/dependencies/libvorbis/lib/psy.c +0 -1227
  591. data/dependencies/libvorbis/lib/psy.h +0 -186
  592. data/dependencies/libvorbis/lib/psytune.c +0 -524
  593. data/dependencies/libvorbis/lib/registry.c +0 -46
  594. data/dependencies/libvorbis/lib/registry.h +0 -32
  595. data/dependencies/libvorbis/lib/res0.c +0 -919
  596. data/dependencies/libvorbis/lib/scales.h +0 -86
  597. data/dependencies/libvorbis/lib/sharedbook.c +0 -735
  598. data/dependencies/libvorbis/lib/smallft.c +0 -1255
  599. data/dependencies/libvorbis/lib/smallft.h +0 -34
  600. data/dependencies/libvorbis/lib/synthesis.c +0 -170
  601. data/dependencies/libvorbis/lib/tone.c +0 -54
  602. data/dependencies/libvorbis/lib/vorbisenc.c +0 -1184
  603. data/dependencies/libvorbis/lib/vorbisfile.c +0 -2194
  604. data/dependencies/libvorbis/lib/window.c +0 -2136
  605. data/dependencies/libvorbis/lib/window.h +0 -26
  606. data/dependencies/libvorbis/libvorbis.spec +0 -118
  607. data/dependencies/libvorbis/libvorbis.spec.in +0 -118
  608. data/dependencies/libvorbis/ltmain.sh +0 -6871
  609. data/dependencies/libvorbis/macos/compat/strdup.c +0 -21
  610. data/dependencies/libvorbis/macos/compat/sys/types.h +0 -1
  611. data/dependencies/libvorbis/macos/decoder_example.mcp +0 -0
  612. data/dependencies/libvorbis/macos/encoder_example.mcp +0 -0
  613. data/dependencies/libvorbis/macos/libvorbis.mcp +0 -0
  614. data/dependencies/libvorbis/macos/libvorbis.mcp.exp +0 -45
  615. data/dependencies/libvorbis/macos/libvorbisenc.mcp +0 -0
  616. data/dependencies/libvorbis/macos/libvorbisenc.mcp.exp +0 -8
  617. data/dependencies/libvorbis/macos/libvorbisfile.mcp +0 -0
  618. data/dependencies/libvorbis/macos/libvorbisfile.mcp.exp +0 -45
  619. data/dependencies/libvorbis/macos/vorbis.mcp +0 -0
  620. data/dependencies/libvorbis/macosx/English.lproj/InfoPlist.strings +0 -0
  621. data/dependencies/libvorbis/macosx/Info.plist +0 -30
  622. data/dependencies/libvorbis/macosx/Vorbis.xcodeproj/project.pbxproj +0 -893
  623. data/dependencies/libvorbis/missing +0 -367
  624. data/dependencies/libvorbis/symbian/bld.inf +0 -35
  625. data/dependencies/libvorbis/symbian/config.h +0 -54
  626. data/dependencies/libvorbis/symbian/vorbis.mmp +0 -43
  627. data/dependencies/libvorbis/todo.txt +0 -22
  628. data/dependencies/libvorbis/vorbis-uninstalled.pc.in +0 -14
  629. data/dependencies/libvorbis/vorbis.m4 +0 -122
  630. data/dependencies/libvorbis/vorbis.pc.in +0 -14
  631. data/dependencies/libvorbis/vorbisenc-uninstalled.pc.in +0 -14
  632. data/dependencies/libvorbis/vorbisenc.pc.in +0 -14
  633. data/dependencies/libvorbis/vorbisfile-uninstalled.pc.in +0 -14
  634. data/dependencies/libvorbis/vorbisfile.pc.in +0 -14
  635. data/dependencies/libvorbis/vq/16.vqs +0 -77
  636. data/dependencies/libvorbis/vq/16u.vqs +0 -71
  637. data/dependencies/libvorbis/vq/44c-1.vqs +0 -63
  638. data/dependencies/libvorbis/vq/44c0.vqs +0 -65
  639. data/dependencies/libvorbis/vq/44c1.vqs +0 -66
  640. data/dependencies/libvorbis/vq/44c2.vqs +0 -37
  641. data/dependencies/libvorbis/vq/44c3.vqs +0 -36
  642. data/dependencies/libvorbis/vq/44c4.vqs +0 -36
  643. data/dependencies/libvorbis/vq/44c5.vqs +0 -37
  644. data/dependencies/libvorbis/vq/44c6.vqs +0 -37
  645. data/dependencies/libvorbis/vq/44c7.vqs +0 -38
  646. data/dependencies/libvorbis/vq/44c8.vqs +0 -39
  647. data/dependencies/libvorbis/vq/44c9.vqs +0 -37
  648. data/dependencies/libvorbis/vq/44u0.vqs +0 -33
  649. data/dependencies/libvorbis/vq/44u1.vqs +0 -33
  650. data/dependencies/libvorbis/vq/44u2.vqs +0 -32
  651. data/dependencies/libvorbis/vq/44u3.vqs +0 -33
  652. data/dependencies/libvorbis/vq/44u4.vqs +0 -33
  653. data/dependencies/libvorbis/vq/44u5.vqs +0 -35
  654. data/dependencies/libvorbis/vq/44u6.vqs +0 -35
  655. data/dependencies/libvorbis/vq/44u7.vqs +0 -34
  656. data/dependencies/libvorbis/vq/44u8.vqs +0 -35
  657. data/dependencies/libvorbis/vq/44u9.vqs +0 -36
  658. data/dependencies/libvorbis/vq/8.vqs +0 -43
  659. data/dependencies/libvorbis/vq/8u.vqs +0 -41
  660. data/dependencies/libvorbis/vq/Makefile +0 -532
  661. data/dependencies/libvorbis/vq/Makefile.am +0 -34
  662. data/dependencies/libvorbis/vq/Makefile.in +0 -532
  663. data/dependencies/libvorbis/vq/auxpartition.pl +0 -71
  664. data/dependencies/libvorbis/vq/bookutil.c +0 -717
  665. data/dependencies/libvorbis/vq/bookutil.h +0 -43
  666. data/dependencies/libvorbis/vq/build.c +0 -195
  667. data/dependencies/libvorbis/vq/cascade.c +0 -91
  668. data/dependencies/libvorbis/vq/distribution.c +0 -248
  669. data/dependencies/libvorbis/vq/floor_11.vqs +0 -10
  670. data/dependencies/libvorbis/vq/floor_22.vqs +0 -27
  671. data/dependencies/libvorbis/vq/floor_44.vqs +0 -83
  672. data/dependencies/libvorbis/vq/genericdata.c +0 -61
  673. data/dependencies/libvorbis/vq/huffbuild.c +0 -201
  674. data/dependencies/libvorbis/vq/latticebuild.c +0 -177
  675. data/dependencies/libvorbis/vq/latticehint.c +0 -430
  676. data/dependencies/libvorbis/vq/latticepare.c +0 -595
  677. data/dependencies/libvorbis/vq/latticetune.c +0 -164
  678. data/dependencies/libvorbis/vq/localcodebook.h +0 -160
  679. data/dependencies/libvorbis/vq/lspdata.c +0 -157
  680. data/dependencies/libvorbis/vq/make_floor_books.pl +0 -108
  681. data/dependencies/libvorbis/vq/make_residue_books.pl +0 -187
  682. data/dependencies/libvorbis/vq/metrics.c +0 -295
  683. data/dependencies/libvorbis/vq/residue_entropy +0 -58
  684. data/dependencies/libvorbis/vq/residuedata.c +0 -160
  685. data/dependencies/libvorbis/vq/residuesplit.c +0 -282
  686. data/dependencies/libvorbis/vq/run.c +0 -216
  687. data/dependencies/libvorbis/vq/train.c +0 -364
  688. data/dependencies/libvorbis/vq/vqext.h +0 -34
  689. data/dependencies/libvorbis/vq/vqgen.c +0 -567
  690. data/dependencies/libvorbis/vq/vqgen.h +0 -85
  691. data/dependencies/libvorbis/vq/vqsplit.c +0 -612
  692. data/dependencies/libvorbis/vq/vqsplit.h +0 -37
  693. data/dependencies/libvorbis/win32/VS2003/libvorbis/libvorbis.vcproj +0 -467
  694. data/dependencies/libvorbis/win32/VS2003/libvorbisfile/libvorbisfile.def +0 -47
  695. data/dependencies/libvorbis/win32/VS2003/libvorbisfile/libvorbisfile.vcproj +0 -147
  696. data/dependencies/libvorbis/win32/VS2003/vorbisdec/vorbisdec.vcproj +0 -268
  697. data/dependencies/libvorbis/win32/VS2003/vorbisenc/vorbisenc.vcproj +0 -268
  698. data/dependencies/libvorbis/win32/VS2005/libvorbis/libvorbis.vcproj +0 -653
  699. data/dependencies/libvorbis/win32/VS2005/libvorbisfile/libvorbisfile.def +0 -47
  700. data/dependencies/libvorbis/win32/VS2005/libvorbisfile/libvorbisfile.vcproj +0 -219
  701. data/dependencies/libvorbis/win32/VS2005/vorbisdec/vorbisdec.vcproj +0 -389
  702. data/dependencies/libvorbis/win32/VS2005/vorbisenc/vorbisenc.vcproj +0 -390
  703. data/dependencies/libvorbis/win32/build_vorbis_dynamic.bat +0 -19
  704. data/dependencies/libvorbis/win32/build_vorbis_dynamic_debug.bat +0 -19
  705. data/dependencies/libvorbis/win32/build_vorbis_static.bat +0 -19
  706. data/dependencies/libvorbis/win32/build_vorbis_static_debug.bat +0 -19
  707. data/dependencies/libvorbis/win32/build_vorbisenc_dynamic.bat +0 -19
  708. data/dependencies/libvorbis/win32/build_vorbisenc_dynamic_debug.bat +0 -19
  709. data/dependencies/libvorbis/win32/build_vorbisenc_static.bat +0 -19
  710. data/dependencies/libvorbis/win32/build_vorbisenc_static_debug.bat +0 -19
  711. data/dependencies/libvorbis/win32/build_vorbisfile_dynamic.bat +0 -19
  712. data/dependencies/libvorbis/win32/build_vorbisfile_dynamic_debug.bat +0 -19
  713. data/dependencies/libvorbis/win32/build_vorbisfile_static.bat +0 -19
  714. data/dependencies/libvorbis/win32/build_vorbisfile_static_debug.bat +0 -19
  715. data/dependencies/libvorbis/win32/vorbis.def +0 -57
  716. data/dependencies/libvorbis/win32/vorbis.dsw +0 -101
  717. data/dependencies/libvorbis/win32/vorbis_dynamic.dsp +0 -281
  718. data/dependencies/libvorbis/win32/vorbis_static.dsp +0 -257
  719. data/dependencies/libvorbis/win32/vorbisenc.def +0 -13
  720. data/dependencies/libvorbis/win32/vorbisenc_dynamic.dsp +0 -121
  721. data/dependencies/libvorbis/win32/vorbisenc_static.dsp +0 -100
  722. data/dependencies/libvorbis/win32/vorbisfile.def +0 -41
  723. data/dependencies/libvorbis/win32/vorbisfile_dynamic.dsp +0 -119
  724. data/dependencies/libvorbis/win32/vorbisfile_static.dsp +0 -100
  725. data/dependencies/zlib/ChangeLog +0 -855
  726. data/dependencies/zlib/FAQ +0 -339
  727. data/dependencies/zlib/INDEX +0 -51
  728. data/dependencies/zlib/Makefile +0 -154
  729. data/dependencies/zlib/Makefile.in +0 -154
  730. data/dependencies/zlib/README +0 -125
  731. data/dependencies/zlib/adler32.c +0 -149
  732. data/dependencies/zlib/algorithm.txt +0 -209
  733. data/dependencies/zlib/amiga/Makefile.pup +0 -66
  734. data/dependencies/zlib/amiga/Makefile.sas +0 -65
  735. data/dependencies/zlib/as400/bndsrc +0 -132
  736. data/dependencies/zlib/as400/compile.clp +0 -123
  737. data/dependencies/zlib/as400/readme.txt +0 -111
  738. data/dependencies/zlib/as400/zlib.inc +0 -331
  739. data/dependencies/zlib/compress.c +0 -79
  740. data/dependencies/zlib/configure +0 -459
  741. data/dependencies/zlib/contrib/README.contrib +0 -71
  742. data/dependencies/zlib/contrib/ada/buffer_demo.adb +0 -106
  743. data/dependencies/zlib/contrib/ada/mtest.adb +0 -156
  744. data/dependencies/zlib/contrib/ada/read.adb +0 -156
  745. data/dependencies/zlib/contrib/ada/readme.txt +0 -65
  746. data/dependencies/zlib/contrib/ada/test.adb +0 -463
  747. data/dependencies/zlib/contrib/ada/zlib-streams.adb +0 -225
  748. data/dependencies/zlib/contrib/ada/zlib-streams.ads +0 -114
  749. data/dependencies/zlib/contrib/ada/zlib-thin.adb +0 -141
  750. data/dependencies/zlib/contrib/ada/zlib-thin.ads +0 -450
  751. data/dependencies/zlib/contrib/ada/zlib.adb +0 -701
  752. data/dependencies/zlib/contrib/ada/zlib.ads +0 -328
  753. data/dependencies/zlib/contrib/ada/zlib.gpr +0 -20
  754. data/dependencies/zlib/contrib/asm586/README.586 +0 -43
  755. data/dependencies/zlib/contrib/asm586/match.S +0 -364
  756. data/dependencies/zlib/contrib/asm686/README.686 +0 -34
  757. data/dependencies/zlib/contrib/asm686/match.S +0 -329
  758. data/dependencies/zlib/contrib/blast/Makefile +0 -8
  759. data/dependencies/zlib/contrib/blast/README +0 -4
  760. data/dependencies/zlib/contrib/blast/blast.c +0 -444
  761. data/dependencies/zlib/contrib/blast/blast.h +0 -71
  762. data/dependencies/zlib/contrib/blast/test.pk +0 -0
  763. data/dependencies/zlib/contrib/blast/test.txt +0 -1
  764. data/dependencies/zlib/contrib/delphi/ZLib.pas +0 -557
  765. data/dependencies/zlib/contrib/delphi/ZLibConst.pas +0 -11
  766. data/dependencies/zlib/contrib/delphi/readme.txt +0 -76
  767. data/dependencies/zlib/contrib/delphi/zlibd32.mak +0 -93
  768. data/dependencies/zlib/contrib/dotzlib/DotZLib.build +0 -33
  769. data/dependencies/zlib/contrib/dotzlib/DotZLib.chm +0 -0
  770. data/dependencies/zlib/contrib/dotzlib/DotZLib.sln +0 -21
  771. data/dependencies/zlib/contrib/dotzlib/DotZLib/AssemblyInfo.cs +0 -58
  772. data/dependencies/zlib/contrib/dotzlib/DotZLib/ChecksumImpl.cs +0 -202
  773. data/dependencies/zlib/contrib/dotzlib/DotZLib/CircularBuffer.cs +0 -83
  774. data/dependencies/zlib/contrib/dotzlib/DotZLib/CodecBase.cs +0 -198
  775. data/dependencies/zlib/contrib/dotzlib/DotZLib/Deflater.cs +0 -106
  776. data/dependencies/zlib/contrib/dotzlib/DotZLib/DotZLib.cs +0 -288
  777. data/dependencies/zlib/contrib/dotzlib/DotZLib/DotZLib.csproj +0 -141
  778. data/dependencies/zlib/contrib/dotzlib/DotZLib/GZipStream.cs +0 -301
  779. data/dependencies/zlib/contrib/dotzlib/DotZLib/Inflater.cs +0 -105
  780. data/dependencies/zlib/contrib/dotzlib/DotZLib/UnitTests.cs +0 -274
  781. data/dependencies/zlib/contrib/dotzlib/LICENSE_1_0.txt +0 -23
  782. data/dependencies/zlib/contrib/dotzlib/readme.txt +0 -58
  783. data/dependencies/zlib/contrib/infback9/README +0 -1
  784. data/dependencies/zlib/contrib/infback9/infback9.c +0 -608
  785. data/dependencies/zlib/contrib/infback9/infback9.h +0 -37
  786. data/dependencies/zlib/contrib/infback9/inffix9.h +0 -107
  787. data/dependencies/zlib/contrib/infback9/inflate9.h +0 -47
  788. data/dependencies/zlib/contrib/infback9/inftree9.c +0 -323
  789. data/dependencies/zlib/contrib/infback9/inftree9.h +0 -55
  790. data/dependencies/zlib/contrib/inflate86/inffas86.c +0 -1157
  791. data/dependencies/zlib/contrib/inflate86/inffast.S +0 -1368
  792. data/dependencies/zlib/contrib/iostream/test.cpp +0 -24
  793. data/dependencies/zlib/contrib/iostream/zfstream.cpp +0 -329
  794. data/dependencies/zlib/contrib/iostream/zfstream.h +0 -128
  795. data/dependencies/zlib/contrib/iostream2/zstream.h +0 -307
  796. data/dependencies/zlib/contrib/iostream2/zstream_test.cpp +0 -25
  797. data/dependencies/zlib/contrib/iostream3/README +0 -35
  798. data/dependencies/zlib/contrib/iostream3/TODO +0 -17
  799. data/dependencies/zlib/contrib/iostream3/test.cc +0 -50
  800. data/dependencies/zlib/contrib/iostream3/zfstream.cc +0 -479
  801. data/dependencies/zlib/contrib/iostream3/zfstream.h +0 -466
  802. data/dependencies/zlib/contrib/masm686/match.asm +0 -413
  803. data/dependencies/zlib/contrib/masmx64/bld_ml64.bat +0 -2
  804. data/dependencies/zlib/contrib/masmx64/gvmat64.asm +0 -513
  805. data/dependencies/zlib/contrib/masmx64/gvmat64.obj +0 -0
  806. data/dependencies/zlib/contrib/masmx64/inffas8664.c +0 -186
  807. data/dependencies/zlib/contrib/masmx64/inffasx64.asm +0 -392
  808. data/dependencies/zlib/contrib/masmx64/inffasx64.obj +0 -0
  809. data/dependencies/zlib/contrib/masmx64/readme.txt +0 -28
  810. data/dependencies/zlib/contrib/masmx86/bld_ml32.bat +0 -2
  811. data/dependencies/zlib/contrib/masmx86/gvmat32.asm +0 -972
  812. data/dependencies/zlib/contrib/masmx86/gvmat32.obj +0 -0
  813. data/dependencies/zlib/contrib/masmx86/gvmat32c.c +0 -62
  814. data/dependencies/zlib/contrib/masmx86/inffas32.asm +0 -1083
  815. data/dependencies/zlib/contrib/masmx86/inffas32.obj +0 -0
  816. data/dependencies/zlib/contrib/masmx86/mkasm.bat +0 -3
  817. data/dependencies/zlib/contrib/masmx86/readme.txt +0 -21
  818. data/dependencies/zlib/contrib/minizip/ChangeLogUnzip +0 -67
  819. data/dependencies/zlib/contrib/minizip/Makefile +0 -25
  820. data/dependencies/zlib/contrib/minizip/crypt.h +0 -132
  821. data/dependencies/zlib/contrib/minizip/ioapi.c +0 -177
  822. data/dependencies/zlib/contrib/minizip/ioapi.h +0 -75
  823. data/dependencies/zlib/contrib/minizip/iowin32.c +0 -270
  824. data/dependencies/zlib/contrib/minizip/iowin32.h +0 -21
  825. data/dependencies/zlib/contrib/minizip/miniunz.c +0 -585
  826. data/dependencies/zlib/contrib/minizip/minizip.c +0 -420
  827. data/dependencies/zlib/contrib/minizip/mztools.c +0 -281
  828. data/dependencies/zlib/contrib/minizip/mztools.h +0 -31
  829. data/dependencies/zlib/contrib/minizip/unzip.c +0 -1598
  830. data/dependencies/zlib/contrib/minizip/unzip.h +0 -354
  831. data/dependencies/zlib/contrib/minizip/zip.c +0 -1219
  832. data/dependencies/zlib/contrib/minizip/zip.h +0 -235
  833. data/dependencies/zlib/contrib/pascal/example.pas +0 -599
  834. data/dependencies/zlib/contrib/pascal/readme.txt +0 -76
  835. data/dependencies/zlib/contrib/pascal/zlibd32.mak +0 -93
  836. data/dependencies/zlib/contrib/pascal/zlibpas.pas +0 -236
  837. data/dependencies/zlib/contrib/puff/Makefile +0 -8
  838. data/dependencies/zlib/contrib/puff/README +0 -63
  839. data/dependencies/zlib/contrib/puff/puff.c +0 -837
  840. data/dependencies/zlib/contrib/puff/puff.h +0 -31
  841. data/dependencies/zlib/contrib/puff/zeros.raw +0 -0
  842. data/dependencies/zlib/contrib/testzlib/testzlib.c +0 -275
  843. data/dependencies/zlib/contrib/testzlib/testzlib.txt +0 -10
  844. data/dependencies/zlib/contrib/untgz/Makefile +0 -14
  845. data/dependencies/zlib/contrib/untgz/Makefile.msc +0 -17
  846. data/dependencies/zlib/contrib/untgz/untgz.c +0 -674
  847. data/dependencies/zlib/contrib/vstudio/readme.txt +0 -73
  848. data/dependencies/zlib/contrib/vstudio/vc7/miniunz.vcproj +0 -126
  849. data/dependencies/zlib/contrib/vstudio/vc7/minizip.vcproj +0 -126
  850. data/dependencies/zlib/contrib/vstudio/vc7/testzlib.vcproj +0 -126
  851. data/dependencies/zlib/contrib/vstudio/vc7/zlib.rc +0 -32
  852. data/dependencies/zlib/contrib/vstudio/vc7/zlibstat.vcproj +0 -246
  853. data/dependencies/zlib/contrib/vstudio/vc7/zlibvc.def +0 -92
  854. data/dependencies/zlib/contrib/vstudio/vc7/zlibvc.sln +0 -78
  855. data/dependencies/zlib/contrib/vstudio/vc7/zlibvc.vcproj +0 -445
  856. data/dependencies/zlib/contrib/vstudio/vc8/miniunz.vcproj +0 -566
  857. data/dependencies/zlib/contrib/vstudio/vc8/minizip.vcproj +0 -563
  858. data/dependencies/zlib/contrib/vstudio/vc8/testzlib.vcproj +0 -948
  859. data/dependencies/zlib/contrib/vstudio/vc8/testzlibdll.vcproj +0 -567
  860. data/dependencies/zlib/contrib/vstudio/vc8/zlib.rc +0 -32
  861. data/dependencies/zlib/contrib/vstudio/vc8/zlibstat.vcproj +0 -870
  862. data/dependencies/zlib/contrib/vstudio/vc8/zlibvc.def +0 -92
  863. data/dependencies/zlib/contrib/vstudio/vc8/zlibvc.sln +0 -144
  864. data/dependencies/zlib/contrib/vstudio/vc8/zlibvc.vcproj +0 -1219
  865. data/dependencies/zlib/crc32.c +0 -423
  866. data/dependencies/zlib/crc32.h +0 -441
  867. data/dependencies/zlib/deflate.c +0 -1736
  868. data/dependencies/zlib/deflate.h +0 -331
  869. data/dependencies/zlib/example.c +0 -565
  870. data/dependencies/zlib/examples/README.examples +0 -42
  871. data/dependencies/zlib/examples/fitblk.c +0 -233
  872. data/dependencies/zlib/examples/gun.c +0 -693
  873. data/dependencies/zlib/examples/gzappend.c +0 -500
  874. data/dependencies/zlib/examples/gzjoin.c +0 -448
  875. data/dependencies/zlib/examples/gzlog.c +0 -413
  876. data/dependencies/zlib/examples/gzlog.h +0 -58
  877. data/dependencies/zlib/examples/zlib_how.html +0 -523
  878. data/dependencies/zlib/examples/zpipe.c +0 -191
  879. data/dependencies/zlib/examples/zran.c +0 -404
  880. data/dependencies/zlib/gzio.c +0 -1026
  881. data/dependencies/zlib/infback.c +0 -623
  882. data/dependencies/zlib/inffast.c +0 -318
  883. data/dependencies/zlib/inffast.h +0 -11
  884. data/dependencies/zlib/inffixed.h +0 -94
  885. data/dependencies/zlib/inflate.c +0 -1368
  886. data/dependencies/zlib/inflate.h +0 -115
  887. data/dependencies/zlib/inftrees.c +0 -329
  888. data/dependencies/zlib/inftrees.h +0 -55
  889. data/dependencies/zlib/make_vms.com +0 -461
  890. data/dependencies/zlib/minigzip.c +0 -322
  891. data/dependencies/zlib/msdos/Makefile.bor +0 -109
  892. data/dependencies/zlib/msdos/Makefile.dj2 +0 -104
  893. data/dependencies/zlib/msdos/Makefile.emx +0 -69
  894. data/dependencies/zlib/msdos/Makefile.msc +0 -106
  895. data/dependencies/zlib/msdos/Makefile.tc +0 -94
  896. data/dependencies/zlib/old/Makefile.riscos +0 -151
  897. data/dependencies/zlib/old/README +0 -3
  898. data/dependencies/zlib/old/descrip.mms +0 -48
  899. data/dependencies/zlib/old/os2/Makefile.os2 +0 -136
  900. data/dependencies/zlib/old/os2/zlib.def +0 -51
  901. data/dependencies/zlib/old/visual-basic.txt +0 -160
  902. data/dependencies/zlib/old/zlib.html +0 -971
  903. data/dependencies/zlib/projects/README.projects +0 -41
  904. data/dependencies/zlib/projects/visualc6/README.txt +0 -73
  905. data/dependencies/zlib/projects/visualc6/example.dsp +0 -278
  906. data/dependencies/zlib/projects/visualc6/minigzip.dsp +0 -278
  907. data/dependencies/zlib/projects/visualc6/zlib.dsp +0 -609
  908. data/dependencies/zlib/projects/visualc6/zlib.dsw +0 -59
  909. data/dependencies/zlib/qnx/package.qpg +0 -141
  910. data/dependencies/zlib/trees.c +0 -1219
  911. data/dependencies/zlib/trees.h +0 -128
  912. data/dependencies/zlib/uncompr.c +0 -61
  913. data/dependencies/zlib/win32/DLL_FAQ.txt +0 -397
  914. data/dependencies/zlib/win32/Makefile.bor +0 -107
  915. data/dependencies/zlib/win32/Makefile.emx +0 -69
  916. data/dependencies/zlib/win32/Makefile.gcc +0 -141
  917. data/dependencies/zlib/win32/Makefile.msc +0 -126
  918. data/dependencies/zlib/win32/VisualC.txt +0 -3
  919. data/dependencies/zlib/win32/zlib.def +0 -60
  920. data/dependencies/zlib/win32/zlib1.rc +0 -39
  921. data/dependencies/zlib/zconf.h +0 -332
  922. data/dependencies/zlib/zconf.in.h +0 -332
  923. data/dependencies/zlib/zlib.3 +0 -159
  924. data/dependencies/zlib/zlib.h +0 -1357
  925. data/dependencies/zlib/zutil.c +0 -318
  926. data/dependencies/zlib/zutil.h +0 -269
  927. data/mac/English.lproj/InfoPlist.strings +0 -0
  928. data/mac/Gosu-Info.plist +0 -26
  929. data/mac/Gosu.icns +0 -0
  930. data/mac/Gosu.xcodeproj/jlnr.mode1v3 +0 -1420
  931. data/mac/Gosu.xcodeproj/jlnr.mode2v3 +0 -1464
  932. data/mac/Gosu.xcodeproj/jlnr.pbxuser +0 -1407
  933. data/mac/Gosu.xcodeproj/jlnr.perspectivev3 +0 -1573
  934. data/mac/Gosu.xcodeproj/project.pbxproj +0 -2758
  935. data/mac/RubyGosu App-Info.plist +0 -26
  936. data/windows/Gosu.sln +0 -34
  937. data/windows/Gosu.vcproj +0 -553
  938. data/windows/RubyGosu.vcproj +0 -241
@@ -1,2292 +0,0 @@
1
- <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Vorbis I specification</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id291327"></a>Vorbis I specification</h1></div><div><h3 class="corpauthor">Xiph.org Foundation</h3></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#vorbis-spec-intro">1. Introduction and Description</a></span></dt><dd><dl><dt><span class="section"><a href="#id311592">1.1. Overview</a></span></dt><dt><span class="section"><a href="#id258770">1.2. Decoder Configuration</a></span></dt><dt><span class="section"><a href="#id258461">1.3. High-level Decode Process</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-bitpacking">2. Bitpacking Convention</a></span></dt><dd><dl><dt><span class="section"><a href="#id304831">2.1. Overview</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-codebook">3. Probability Model and Codebooks</a></span></dt><dd><dl><dt><span class="section"><a href="#id310158">3.1. Overview</a></span></dt><dt><span class="section"><a href="#id310216">3.2. Packed codebook format</a></span></dt><dt><span class="section"><a href="#id316518">3.3. Use of the codebook abstraction</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-codec">4. Codec Setup and Packet Decode</a></span></dt><dd><dl><dt><span class="section"><a href="#id336024">4.1. Overview</a></span></dt><dt><span class="section"><a href="#id326710">4.2. Header decode and decode setup</a></span></dt><dt><span class="section"><a href="#id342709">4.3. Audio packet decode and synthesis</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-comment">5. comment field and header specification</a></span></dt><dd><dl><dt><span class="section"><a href="#id314030">5.1. Overview</a></span></dt><dt><span class="section"><a href="#id314058">5.2. Comment encoding</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-floor0">6. Floor type 0 setup and decode</a></span></dt><dd><dl><dt><span class="section"><a href="#id336814">6.1. Overview</a></span></dt><dt><span class="section"><a href="#id321046">6.2. Floor 0 format</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-floor1">7. Floor type 1 setup and decode</a></span></dt><dd><dl><dt><span class="section"><a href="#id336243">7.1. Overview</a></span></dt><dt><span class="section"><a href="#id334800">7.2. Floor 1 format</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-residue">8. Residue setup and decode</a></span></dt><dd><dl><dt><span class="section"><a href="#id320982">8.1. Overview</a></span></dt><dt><span class="section"><a href="#id307154">8.2. Residue format</a></span></dt><dt><span class="section"><a href="#id326310">8.3. residue 0</a></span></dt><dt><span class="section"><a href="#id326344">8.4. residue 1</a></span></dt><dt><span class="section"><a href="#id334893">8.5. residue 2</a></span></dt><dt><span class="section"><a href="#id334939">8.6. Residue decode</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-helper">9. Helper equations</a></span></dt><dd><dl><dt><span class="section"><a href="#id316603">9.1. Overview</a></span></dt><dt><span class="section"><a href="#id317505">9.2. Functions</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-tables">10. Tables</a></span></dt><dd><dl><dt><span class="section"><a href="#vorbis-spec-floor1_inverse_dB_table">10.1. floor1_inverse_dB_table</a></span></dt></dl></dd><dt><span class="appendix"><a href="#vorbis-over-ogg">1. Embedding Vorbis into an Ogg stream</a></span></dt><dd><dl><dt><span class="section"><a href="#id319760">1.1. Overview</a></span></dt><dd><dl><dt><span class="section"><a href="#id336562">1.1.1. Restrictions</a></span></dt><dt><span class="section"><a href="#id330723">1.1.2. MIME type</a></span></dt></dl></dd><dt><span class="section"><a href="#id328095">1.2. Encapsulation</a></span></dt></dl></dd><dt><span class="appendix"><a href="#vorbis-over-rtp">2. Vorbis encapsulation in RTP</a></span></dt><dt><span class="appendix"><a href="#footer">3. Colophon</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-intro"></a>1.�Introduction and Description</h2></div><div><p class="releaseinfo">
2
- $Id: 01-introduction.xml 7186 2004-07-20 07:19:25Z xiphmont $
3
- </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id311592"></a>1.1.�Overview</h3></div></div></div><p>
4
- This document provides a high level description of the Vorbis codec's
5
- construction. A bit-by-bit specification appears beginning in
6
- <a href="#vorbis-spec-codec" title="4.�Codec Setup and Packet Decode">Section�4, &#8220;Codec Setup and Packet Decode&#8221;</a>.
7
- The later sections assume a high-level
8
- understanding of the Vorbis decode process, which is
9
- provided here.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id317198"></a>1.1.1.�Application</h4></div></div></div><p>
10
- Vorbis is a general purpose perceptual audio CODEC intended to allow
11
- maximum encoder flexibility, thus allowing it to scale competitively
12
- over an exceptionally wide range of bitrates. At the high
13
- quality/bitrate end of the scale (CD or DAT rate stereo, 16/24 bits)
14
- it is in the same league as MPEG-2 and MPC. Similarly, the 1.0
15
- encoder can encode high-quality CD and DAT rate stereo at below 48kbps
16
- without resampling to a lower rate. Vorbis is also intended for
17
- lower and higher sample rates (from 8kHz telephony to 192kHz digital
18
- masters) and a range of channel representations (monaural,
19
- polyphonic, stereo, quadraphonic, 5.1, ambisonic, or up to 255
20
- discrete channels).
21
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id315630"></a>1.1.2.�Classification</h4></div></div></div><p>
22
- Vorbis I is a forward-adaptive monolithic transform CODEC based on the
23
- Modified Discrete Cosine Transform. The codec is structured to allow
24
- addition of a hybrid wavelet filterbank in Vorbis II to offer better
25
- transient response and reproduction using a transform better suited to
26
- localized time events.
27
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id323943"></a>1.1.3.�Assumptions</h4></div></div></div><p>
28
- The Vorbis CODEC design assumes a complex, psychoacoustically-aware
29
- encoder and simple, low-complexity decoder. Vorbis decode is
30
- computationally simpler than mp3, although it does require more
31
- working memory as Vorbis has no static probability model; the vector
32
- codebooks used in the first stage of decoding from the bitstream are
33
- packed in their entirety into the Vorbis bitstream headers. In
34
- packed form, these codebooks occupy only a few kilobytes; the extent
35
- to which they are pre-decoded into a cache is the dominant factor in
36
- decoder memory usage.
37
- </p><p>
38
- Vorbis provides none of its own framing, synchronization or protection
39
- against errors; it is solely a method of accepting input audio,
40
- dividing it into individual frames and compressing these frames into
41
- raw, unformatted 'packets'. The decoder then accepts these raw
42
- packets in sequence, decodes them, synthesizes audio frames from
43
- them, and reassembles the frames into a facsimile of the original
44
- audio stream. Vorbis is a free-form variable bit rate (VBR) codec and packets have no
45
- minimum size, maximum size, or fixed/expected size. Packets
46
- are designed that they may be truncated (or padded) and remain
47
- decodable; this is not to be considered an error condition and is used
48
- extensively in bitrate management in peeling. Both the transport
49
- mechanism and decoder must allow that a packet may be any size, or
50
- end before or after packet decode expects.</p><p>
51
- Vorbis packets are thus intended to be used with a transport mechanism
52
- that provides free-form framing, sync, positioning and error correction
53
- in accordance with these design assumptions, such as Ogg (for file
54
- transport) or RTP (for network multicast). For purposes of a few
55
- examples in this document, we will assume that Vorbis is to be
56
- embedded in an Ogg stream specifically, although this is by no means a
57
- requirement or fundamental assumption in the Vorbis design.</p><p>
58
- The specification for embedding Vorbis into
59
- an Ogg transport stream is in <a href="#vorbis-over-ogg" title="1.�Embedding Vorbis into an Ogg stream">Appendix�1, <i>Embedding Vorbis into an Ogg stream</i></a>.
60
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id324282"></a>1.1.4.�Codec Setup and Probability Model</h4></div></div></div><p>
61
- Vorbis' heritage is as a research CODEC and its current design
62
- reflects a desire to allow multiple decades of continuous encoder
63
- improvement before running out of room within the codec specification.
64
- For these reasons, configurable aspects of codec setup intentionally
65
- lean toward the extreme of forward adaptive.</p><p>
66
- The single most controversial design decision in Vorbis (and the most
67
- unusual for a Vorbis developer to keep in mind) is that the entire
68
- probability model of the codec, the Huffman and VQ codebooks, is
69
- packed into the bitstream header along with extensive CODEC setup
70
- parameters (often several hundred fields). This makes it impossible,
71
- as it would be with MPEG audio layers, to embed a simple frame type
72
- flag in each audio packet, or begin decode at any frame in the stream
73
- without having previously fetched the codec setup header.
74
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
75
- Vorbis <span class="emphasis"><em>can</em></span> initiate decode at any arbitrary packet within a
76
- bitstream so long as the codec has been initialized/setup with the
77
- setup headers.</p></div><p>
78
- Thus, Vorbis headers are both required for decode to begin and
79
- relatively large as bitstream headers go. The header size is
80
- unbounded, although for streaming a rule-of-thumb of 4kB or less is
81
- recommended (and Xiph.Org's Vorbis encoder follows this suggestion).</p><p>
82
- Our own design work indicates the primary liability of the
83
- required header is in mindshare; it is an unusual design and thus
84
- causes some amount of complaint among engineers as this runs against
85
- current design trends (and also points out limitations in some
86
- existing software/interface designs, such as Windows' ACM codec
87
- framework). However, we find that it does not fundamentally limit
88
- Vorbis' suitable application space.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id258744"></a>1.1.5.�Format Specification</h4></div></div></div><p>
89
- The Vorbis format is well-defined by its decode specification; any
90
- encoder that produces packets that are correctly decoded by the
91
- reference Vorbis decoder described below may be considered a proper
92
- Vorbis encoder. A decoder must faithfully and completely implement
93
- the specification defined below (except where noted) to be considered
94
- a proper Vorbis decoder.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id258756"></a>1.1.6.�Hardware Profile</h4></div></div></div><p>
95
- Although Vorbis decode is computationally simple, it may still run
96
- into specific limitations of an embedded design. For this reason,
97
- embedded designs are allowed to deviate in limited ways from the
98
- 'full' decode specification yet still be certified compliant. These
99
- optional omissions are labelled in the spec where relevant.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id258770"></a>1.2.�Decoder Configuration</h3></div></div></div><p>
100
- Decoder setup consists of configuration of multiple, self-contained
101
- component abstractions that perform specific functions in the decode
102
- pipeline. Each different component instance of a specific type is
103
- semantically interchangeable; decoder configuration consists both of
104
- internal component configuration, as well as arrangement of specific
105
- instances into a decode pipeline. Componentry arrangement is roughly
106
- as follows:</p><div class="mediaobject"><img src="components.png" alt="decoder pipeline configuration"></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id258803"></a>1.2.1.�Global Config</h4></div></div></div><p>
107
- Global codec configuration consists of a few audio related fields
108
- (sample rate, channels), Vorbis version (always '0' in Vorbis I),
109
- bitrate hints, and the lists of component instances. All other
110
- configuration is in the context of specific components.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id258815"></a>1.2.2.�Mode</h4></div></div></div><p>
111
- Each Vorbis frame is coded according to a master 'mode'. A bitstream
112
- may use one or many modes.</p><p>
113
- The mode mechanism is used to encode a frame according to one of
114
- multiple possible methods with the intention of choosing a method best
115
- suited to that frame. Different modes are, e.g. how frame size
116
- is changed from frame to frame. The mode number of a frame serves as a
117
- top level configuration switch for all other specific aspects of frame
118
- decode.</p><p>
119
- A 'mode' configuration consists of a frame size setting, window type
120
- (always 0, the Vorbis window, in Vorbis I), transform type (always
121
- type 0, the MDCT, in Vorbis I) and a mapping number. The mapping
122
- number specifies which mapping configuration instance to use for
123
- low-level packet decode and synthesis.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id258359"></a>1.2.3.�Mapping</h4></div></div></div><p>
124
- A mapping contains a channel coupling description and a list of
125
- 'submaps' that bundle sets of channel vectors together for grouped
126
- encoding and decoding. These submaps are not references to external
127
- components; the submap list is internal and specific to a mapping.</p><p>
128
- A 'submap' is a configuration/grouping that applies to a subset of
129
- floor and residue vectors within a mapping. The submap functions as a
130
- last layer of indirection such that specific special floor or residue
131
- settings can be applied not only to all the vectors in a given mode,
132
- but also specific vectors in a specific mode. Each submap specifies
133
- the proper floor and residue instance number to use for decoding that
134
- submap's spectral floor and spectral residue vectors.</p><p>
135
- As an example:</p><p>
136
- Assume a Vorbis stream that contains six channels in the standard 5.1
137
- format. The sixth channel, as is normal in 5.1, is bass only.
138
- Therefore it would be wasteful to encode a full-spectrum version of it
139
- as with the other channels. The submapping mechanism can be used to
140
- apply a full range floor and residue encoding to channels 0 through 4,
141
- and a bass-only representation to the bass channel, thus saving space.
142
- In this example, channels 0-4 belong to submap 0 (which indicates use
143
- of a full-range floor) and channel 5 belongs to submap 1, which uses a
144
- bass-only representation.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id258391"></a>1.2.4.�Floor</h4></div></div></div><p>
145
- Vorbis encodes a spectral 'floor' vector for each PCM channel. This
146
- vector is a low-resolution representation of the audio spectrum for
147
- the given channel in the current frame, generally used akin to a
148
- whitening filter. It is named a 'floor' because the Xiph.Org
149
- reference encoder has historically used it as a unit-baseline for
150
- spectral resolution.</p><p>
151
- A floor encoding may be of two types. Floor 0 uses a packed LSP
152
- representation on a dB amplitude scale and Bark frequency scale.
153
- Floor 1 represents the curve as a piecewise linear interpolated
154
- representation on a dB amplitude scale and linear frequency scale.
155
- The two floors are semantically interchangeable in
156
- encoding/decoding. However, floor type 1 provides more stable
157
- inter-frame behavior, and so is the preferred choice in all
158
- coupled-stereo and high bitrate modes. Floor 1 is also considerably
159
- less expensive to decode than floor 0.</p><p>
160
- Floor 0 is not to be considered deprecated, but it is of limited
161
- modern use. No known Vorbis encoder past Xiph.org's own beta 4 makes
162
- use of floor 0.</p><p>
163
- The values coded/decoded by a floor are both compactly formatted and
164
- make use of entropy coding to save space. For this reason, a floor
165
- configuration generally refers to multiple codebooks in the codebook
166
- component list. Entropy coding is thus provided as an abstraction,
167
- and each floor instance may choose from any and all available
168
- codebooks when coding/decoding.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id258423"></a>1.2.5.�Residue</h4></div></div></div><p>
169
- The spectral residue is the fine structure of the audio spectrum
170
- once the floor curve has been subtracted out. In simplest terms, it
171
- is coded in the bitstream using cascaded (multi-pass) vector
172
- quantization according to one of three specific packing/coding
173
- algorithms numbered 0 through 2. The packing algorithm details are
174
- configured by residue instance. As with the floor components, the
175
- final VQ/entropy encoding is provided by external codebook instances
176
- and each residue instance may choose from any and all available
177
- codebooks.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id258437"></a>1.2.6.�Codebooks</h4></div></div></div><p>
178
- Codebooks are a self-contained abstraction that perform entropy
179
- decoding and, optionally, use the entropy-decoded integer value as an
180
- offset into an index of output value vectors, returning the indicated
181
- vector of values.</p><p>
182
- The entropy coding in a Vorbis I codebook is provided by a standard
183
- Huffman binary tree representation. This tree is tightly packed using
184
- one of several methods, depending on whether codeword lengths are
185
- ordered or unordered, or the tree is sparse.</p><p>
186
- The codebook vector index is similarly packed according to index
187
- characteristic. Most commonly, the vector index is encoded as a
188
- single list of values of possible values that are then permuted into
189
- a list of n-dimensional rows (lattice VQ).</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id258461"></a>1.3.�High-level Decode Process</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id258467"></a>1.3.1.�Decode Setup</h4></div></div></div><p>
190
- Before decoding can begin, a decoder must initialize using the
191
- bitstream headers matching the stream to be decoded. Vorbis uses
192
- three header packets; all are required, in-order, by this
193
- specification. Once set up, decode may begin at any audio packet
194
- belonging to the Vorbis stream. In Vorbis I, all packets after the
195
- three initial headers are audio packets. </p><p>
196
- The header packets are, in order, the identification
197
- header, the comments header, and the setup header.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id314074"></a>1.3.1.1.�Identification Header</h5></div></div></div><p>
198
- The identification header identifies the bitstream as Vorbis, Vorbis
199
- version, and the simple audio characteristics of the stream such as
200
- sample rate and number of channels.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id314086"></a>1.3.1.2.�Comment Header</h5></div></div></div><p>
201
- The comment header includes user text comments ("tags") and a vendor
202
- string for the application/library that produced the bitstream. The
203
- encoding and proper use of the comment header is described in
204
- <a href="#vorbis-spec-comment" title="5.�comment field and header specification">Section�5, &#8220;comment field and header specification&#8221;</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id314101"></a>1.3.1.3.�Setup Header</h5></div></div></div><p>
205
- The setup header includes extensive CODEC setup information as well as
206
- the complete VQ and Huffman codebooks needed for decode.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id314113"></a>1.3.2.�Decode Procedure</h4></div></div></div><div class="highlights"><p>
207
- The decoding and synthesis procedure for all audio packets is
208
- fundamentally the same.
209
- </p><div class="orderedlist"><ol type="1"><li>decode packet type flag</li><li>decode mode number</li><li>decode window shape (long windows only)</li><li>decode floor</li><li>decode residue into residue vectors</li><li>inverse channel coupling of residue vectors</li><li>generate floor curve from decoded floor data</li><li>compute dot product of floor and residue, producing audio spectrum vector</li><li>inverse monolithic transform of audio spectrum vector, always an MDCT in Vorbis I</li><li>overlap/add left-hand output of transform with right-hand output of previous frame</li><li>store right hand-data from transform of current frame for future lapping</li><li>if not first frame, return results of overlap/add as audio result of current frame</li></ol></div><p>
210
- </p></div><p>
211
- Note that clever rearrangement of the synthesis arithmetic is
212
- possible; as an example, one can take advantage of symmetries in the
213
- MDCT to store the right-hand transform data of a partial MDCT for a
214
- 50% inter-frame buffer space savings, and then complete the transform
215
- later before overlap/add with the next frame. This optimization
216
- produces entirely equivalent output and is naturally perfectly legal.
217
- The decoder must be <span class="emphasis"><em>entirely mathematically equivalent</em></span> to the
218
- specification, it need not be a literal semantic implementation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id314203"></a>1.3.2.1.�Packet type decode</h5></div></div></div><p>
219
- Vorbis I uses four packet types. The first three packet types mark each
220
- of the three Vorbis headers described above. The fourth packet type
221
- marks an audio packet. All other packet types are reserved; packets
222
- marked with a reserved type should be ignored.</p><p>
223
- Following the three header packets, all packets in a Vorbis I stream
224
- are audio. The first step of audio packet decode is to read and
225
- verify the packet type; <span class="emphasis"><em>a non-audio packet when audio is expected
226
- indicates stream corruption or a non-compliant stream. The decoder
227
- must ignore the packet and not attempt decoding it to
228
- audio</em></span>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id314225"></a>1.3.2.2.�Mode decode</h5></div></div></div><p>
229
- Vorbis allows an encoder to set up multiple, numbered packet 'modes',
230
- as described earlier, all of which may be used in a given Vorbis
231
- stream. The mode is encoded as an integer used as a direct offset into
232
- the mode instance index. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-window"></a>1.3.2.3.�Window shape decode (long windows only)</h5></div></div></div><p>
233
- Vorbis frames may be one of two PCM sample sizes specified during
234
- codec setup. In Vorbis I, legal frame sizes are powers of two from 64
235
- to 8192 samples. Aside from coupling, Vorbis handles channels as
236
- independent vectors and these frame sizes are in samples per channel.</p><p>
237
- Vorbis uses an overlapping transform, namely the MDCT, to blend one
238
- frame into the next, avoiding most inter-frame block boundary
239
- artifacts. The MDCT output of one frame is windowed according to MDCT
240
- requirements, overlapped 50% with the output of the previous frame and
241
- added. The window shape assures seamless reconstruction. </p><p>
242
- This is easy to visualize in the case of equal sized-windows:</p><div class="mediaobject"><img src="window1.png" alt="overlap of two equal-sized windows"></div><p>
243
- And slightly more complex in the case of overlapping unequal sized
244
- windows:</p><div class="mediaobject"><img src="window2.png" alt="overlap of a long and a short window"></div><p>
245
- In the unequal-sized window case, the window shape of the long window
246
- must be modified for seamless lapping as above. It is possible to
247
- correctly infer window shape to be applied to the current window from
248
- knowing the sizes of the current, previous and next window. It is
249
- legal for a decoder to use this method. However, in the case of a long
250
- window (short windows require no modification), Vorbis also codes two
251
- flag bits to specify pre- and post- window shape. Although not
252
- strictly necessary for function, this minor redundancy allows a packet
253
- to be fully decoded to the point of lapping entirely independently of
254
- any other packet, allowing easier abstraction of decode layers as well
255
- as allowing a greater level of easy parallelism in encode and
256
- decode.</p><p>
257
- A description of valid window functions for use with an inverse MDCT
258
- can be found in the paper
259
- &#8220;<span class="citetitle">
260
- <a href="http://www.iocon.com/resource/docs/ps/eusipco_corrected.ps" target="_top">
261
- The use of multirate filter banks for coding of high quality digital
262
- audio</a></span>&#8221;, by T. Sporer, K. Brandenburg and B. Edler. Vorbis windows
263
- all use the slope function
264
- <span class="inlinemediaobject"><span>$y = \sin(.5*\pi \, \sin^2((x+.5)/n*\pi))$</span></span>.
265
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id339168"></a>1.3.2.4.�floor decode</h5></div></div></div><p>
266
- Each floor is encoded/decoded in channel order, however each floor
267
- belongs to a 'submap' that specifies which floor configuration to
268
- use. All floors are decoded before residue decode begins.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id339179"></a>1.3.2.5.�residue decode</h5></div></div></div><p>
269
- Although the number of residue vectors equals the number of channels,
270
- channel coupling may mean that the raw residue vectors extracted
271
- during decode do not map directly to specific channels. When channel
272
- coupling is in use, some vectors will correspond to coupled magnitude
273
- or angle. The coupling relationships are described in the codec setup
274
- and may differ from frame to frame, due to different mode numbers.</p><p>
275
- Vorbis codes residue vectors in groups by submap; the coding is done
276
- in submap order from submap 0 through n-1. This differs from floors
277
- which are coded using a configuration provided by submap number, but
278
- are coded individually in channel order.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id339196"></a>1.3.2.6.�inverse channel coupling</h5></div></div></div><p>
279
- A detailed discussion of stereo in the Vorbis codec can be found in
280
- the document <a href="stereo.html" target="_top"><em class="citetitle">Stereo Channel Coupling in the
281
- Vorbis CODEC</em></a>. Vorbis is not limited to only stereo coupling, but
282
- the stereo document also gives a good overview of the generic coupling
283
- mechanism.</p><p>
284
- Vorbis coupling applies to pairs of residue vectors at a time;
285
- decoupling is done in-place a pair at a time in the order and using
286
- the vectors specified in the current mapping configuration. The
287
- decoupling operation is the same for all pairs, converting square
288
- polar representation (where one vector is magnitude and the second
289
- angle) back to Cartesian representation.</p><p>
290
- After decoupling, in order, each pair of vectors on the coupling list,
291
- the resulting residue vectors represent the fine spectral detail
292
- of each output channel.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id339224"></a>1.3.2.7.�generate floor curve</h5></div></div></div><p>
293
- The decoder may choose to generate the floor curve at any appropriate
294
- time. It is reasonable to generate the output curve when the floor
295
- data is decoded from the raw packet, or it can be generated after
296
- inverse coupling and applied to the spectral residue directly,
297
- combining generation and the dot product into one step and eliminating
298
- some working space.</p><p>
299
- Both floor 0 and floor 1 generate a linear-range, linear-domain output
300
- vector to be multiplied (dot product) by the linear-range,
301
- linear-domain spectral residue.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id339240"></a>1.3.2.8.�compute floor/residue dot product</h5></div></div></div><p>
302
- This step is straightforward; for each output channel, the decoder
303
- multiplies the floor curve and residue vectors element by element,
304
- producing the finished audio spectrum of each channel.</p><p>
305
- One point is worth mentioning about this dot product; a common mistake
306
- in a fixed point implementation might be to assume that a 32 bit
307
- fixed-point representation for floor and residue and direct
308
- multiplication of the vectors is sufficient for acceptable spectral
309
- depth in all cases because it happens to mostly work with the current
310
- Xiph.Org reference encoder.</p><p>
311
- However, floor vector values can span ~140dB (~24 bits unsigned), and
312
- the audio spectrum vector should represent a minimum of 120dB (~21
313
- bits with sign), even when output is to a 16 bit PCM device. For the
314
- residue vector to represent full scale if the floor is nailed to
315
- -140dB, it must be able to span 0 to +140dB. For the residue vector
316
- to reach full scale if the floor is nailed at 0dB, it must be able to
317
- represent -140dB to +0dB. Thus, in order to handle full range
318
- dynamics, a residue vector may span -140dB to +140dB entirely within
319
- spec. A 280dB range is approximately 48 bits with sign; thus the
320
- residue vector must be able to represent a 48 bit range and the dot
321
- product must be able to handle an effective 48 bit times 24 bit
322
- multiplication. This range may be achieved using large (64 bit or
323
- larger) integers, or implementing a movable binary point
324
- representation.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id339268"></a>1.3.2.9.�inverse monolithic transform (MDCT)</h5></div></div></div><p>
325
- The audio spectrum is converted back into time domain PCM audio via an
326
- inverse Modified Discrete Cosine Transform (MDCT). A detailed
327
- description of the MDCT is available in the paper <a href="http://www.iocon.com/resource/docs/ps/eusipco_corrected.ps" target="_top">&#8220;<span class="citetitle">The use of multirate filter banks for coding of high quality digital
328
- audio</span>&#8221;</a>, by T. Sporer, K. Brandenburg and B. Edler.</p><p>
329
- Note that the PCM produced directly from the MDCT is not yet finished
330
- audio; it must be lapped with surrounding frames using an appropriate
331
- window (such as the Vorbis window) before the MDCT can be considered
332
- orthogonal.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id339292"></a>1.3.2.10.�overlap/add data</h5></div></div></div><p>
333
- Windowed MDCT output is overlapped and added with the right hand data
334
- of the previous window such that the 3/4 point of the previous window
335
- is aligned with the 1/4 point of the current window (as illustrated in
336
- the window overlap diagram). At this point, the audio data between the
337
- center of the previous frame and the center of the current frame is
338
- now finished and ready to be returned. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id339304"></a>1.3.2.11.�cache right hand data</h5></div></div></div><p>
339
- The decoder must cache the right hand portion of the current frame to
340
- be lapped with the left hand portion of the next frame.
341
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id339314"></a>1.3.2.12.�return finished audio data</h5></div></div></div><p>
342
- The overlapped portion produced from overlapping the previous and
343
- current frame data is finished data to be returned by the decoder.
344
- This data spans from the center of the previous window to the center
345
- of the current window. In the case of same-sized windows, the amount
346
- of data to return is one-half block consisting of and only of the
347
- overlapped portions. When overlapping a short and long window, much of
348
- the returned range is not actually overlap. This does not damage
349
- transform orthogonality. Pay attention however to returning the
350
- correct data range; the amount of data to be returned is:
351
-
352
- </p><pre class="programlisting">
353
- window_blocksize(previous_window)/4+window_blocksize(current_window)/4
354
- </pre><p>
355
-
356
- from the center of the previous window to the center of the current
357
- window.</p><p>
358
- Data is not returned from the first frame; it must be used to 'prime'
359
- the decode engine. The encoder accounts for this priming when
360
- calculating PCM offsets; after the first frame, the proper PCM output
361
- offset is '0' (as no data has been returned yet).</p></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-bitpacking"></a>2.�Bitpacking Convention</h2></div><div><p class="releaseinfo">
362
- $Id: 02-bitpacking.xml 7186 2004-07-20 07:19:25Z xiphmont $
363
- </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id304831"></a>2.1.�Overview</h3></div></div></div><p>
364
- The Vorbis codec uses relatively unstructured raw packets containing
365
- arbitrary-width binary integer fields. Logically, these packets are a
366
- bitstream in which bits are coded one-by-one by the encoder and then
367
- read one-by-one in the same monotonically increasing order by the
368
- decoder. Most current binary storage arrangements group bits into a
369
- native word size of eight bits (octets), sixteen bits, thirty-two bits
370
- or, less commonly other fixed word sizes. The Vorbis bitpacking
371
- convention specifies the correct mapping of the logical packet
372
- bitstream into an actual representation in fixed-width words.
373
- </p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id304890"></a>2.1.1.�octets, bytes and words</h4></div></div></div><p>
374
- In most contemporary architectures, a 'byte' is synonymous with an
375
- 'octet', that is, eight bits. This has not always been the case;
376
- seven, ten, eleven and sixteen bit 'bytes' have been used. For
377
- purposes of the bitpacking convention, a byte implies the native,
378
- smallest integer storage representation offered by a platform. On
379
- modern platforms, this is generally assumed to be eight bits (not
380
- necessarily because of the processor but because of the
381
- filesystem/memory architecture. Modern filesystems invariably offer
382
- bytes as the fundamental atom of storage). A 'word' is an integer
383
- size that is a grouped multiple of this smallest size.</p><p>
384
- The most ubiquitous architectures today consider a 'byte' to be an
385
- octet (eight bits) and a word to be a group of two, four or eight
386
- bytes (16, 32 or 64 bits). Note however that the Vorbis bitpacking
387
- convention is still well defined for any native byte size; Vorbis uses
388
- the native bit-width of a given storage system. This document assumes
389
- that a byte is one octet for purposes of example.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id304832"></a>2.1.2.�bit order</h4></div></div></div><p>
390
- A byte has a well-defined 'least significant' bit (LSb), which is the
391
- only bit set when the byte is storing the two's complement integer
392
- value +1. A byte's 'most significant' bit (MSb) is at the opposite
393
- end of the byte. Bits in a byte are numbered from zero at the LSb to
394
- <span class="emphasis"><em>n</em></span> (<span class="emphasis"><em>n</em></span>=7 in an octet) for the
395
- MSb.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id327953"></a>2.1.3.�byte order</h4></div></div></div><p>
396
- Words are native groupings of multiple bytes. Several byte orderings
397
- are possible in a word; the common ones are 3-2-1-0 ('big endian' or
398
- 'most significant byte first' in which the highest-valued byte comes
399
- first), 0-1-2-3 ('little endian' or 'least significant byte first' in
400
- which the lowest value byte comes first) and less commonly 3-1-2-0 and
401
- 0-2-1-3 ('mixed endian').</p><p>
402
- The Vorbis bitpacking convention specifies storage and bitstream
403
- manipulation at the byte, not word, level, thus host word ordering is
404
- of a concern only during optimization when writing high performance
405
- code that operates on a word of storage at a time rather than by byte.
406
- Logically, bytes are always coded and decoded in order from byte zero
407
- through byte <span class="emphasis"><em>n</em></span>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id336382"></a>2.1.4.�coding bits into byte sequences</h4></div></div></div><p>
408
- The Vorbis codec has need to code arbitrary bit-width integers, from
409
- zero to 32 bits wide, into packets. These integer fields are not
410
- aligned to the boundaries of the byte representation; the next field
411
- is written at the bit position at which the previous field ends.</p><p>
412
- The encoder logically packs integers by writing the LSb of a binary
413
- integer to the logical bitstream first, followed by next least
414
- significant bit, etc, until the requested number of bits have been
415
- coded. When packing the bits into bytes, the encoder begins by
416
- placing the LSb of the integer to be written into the least
417
- significant unused bit position of the destination byte, followed by
418
- the next-least significant bit of the source integer and so on up to
419
- the requested number of bits. When all bits of the destination byte
420
- have been filled, encoding continues by zeroing all bits of the next
421
- byte and writing the next bit into the bit position 0 of that byte.
422
- Decoding follows the same process as encoding, but by reading bits
423
- from the byte stream and reassembling them into integers.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id310906"></a>2.1.5.�signedness</h4></div></div></div><p>
424
- The signedness of a specific number resulting from decode is to be
425
- interpreted by the decoder given decode context. That is, the three
426
- bit binary pattern 'b111' can be taken to represent either 'seven' as
427
- an unsigned integer, or '-1' as a signed, two's complement integer.
428
- The encoder and decoder are responsible for knowing if fields are to
429
- be treated as signed or unsigned.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id258112"></a>2.1.6.�coding example</h4></div></div></div><p>
430
- Code the 4 bit integer value '12' [b1100] into an empty bytestream.
431
- Bytestream result:
432
-
433
- </p><pre class="screen">
434
- |
435
- V
436
-
437
- 7 6 5 4 3 2 1 0
438
- byte 0 [0 0 0 0 1 1 0 0] &lt;-
439
- byte 1 [ ]
440
- byte 2 [ ]
441
- byte 3 [ ]
442
- ...
443
- byte n [ ] bytestream length == 1 byte
444
-
445
- </pre><p>
446
- </p><p>
447
- Continue by coding the 3 bit integer value '-1' [b111]:
448
-
449
- </p><pre class="screen">
450
- |
451
- V
452
-
453
- 7 6 5 4 3 2 1 0
454
- byte 0 [0 1 1 1 1 1 0 0] &lt;-
455
- byte 1 [ ]
456
- byte 2 [ ]
457
- byte 3 [ ]
458
- ...
459
- byte n [ ] bytestream length == 1 byte
460
- </pre><p>
461
- </p><p>
462
- Continue by coding the 7 bit integer value '17' [b0010001]:
463
-
464
- </p><pre class="screen">
465
- |
466
- V
467
-
468
- 7 6 5 4 3 2 1 0
469
- byte 0 [1 1 1 1 1 1 0 0]
470
- byte 1 [0 0 0 0 1 0 0 0] &lt;-
471
- byte 2 [ ]
472
- byte 3 [ ]
473
- ...
474
- byte n [ ] bytestream length == 2 bytes
475
- bit cursor == 6
476
- </pre><p>
477
- </p><p>
478
- Continue by coding the 13 bit integer value '6969' [b110 11001110 01]:
479
-
480
- </p><pre class="screen">
481
- |
482
- V
483
-
484
- 7 6 5 4 3 2 1 0
485
- byte 0 [1 1 1 1 1 1 0 0]
486
- byte 1 [0 1 0 0 1 0 0 0]
487
- byte 2 [1 1 0 0 1 1 1 0]
488
- byte 3 [0 0 0 0 0 1 1 0] &lt;-
489
- ...
490
- byte n [ ] bytestream length == 4 bytes
491
-
492
- </pre><p>
493
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id258160"></a>2.1.7.�decoding example</h4></div></div></div><p>
494
- Reading from the beginning of the bytestream encoded in the above example:
495
-
496
- </p><pre class="screen">
497
- |
498
- V
499
-
500
- 7 6 5 4 3 2 1 0
501
- byte 0 [1 1 1 1 1 1 0 0] &lt;-
502
- byte 1 [0 1 0 0 1 0 0 0]
503
- byte 2 [1 1 0 0 1 1 1 0]
504
- byte 3 [0 0 0 0 0 1 1 0] bytestream length == 4 bytes
505
-
506
- </pre><p>
507
- </p><p>
508
- We read two, two-bit integer fields, resulting in the returned numbers
509
- 'b00' and 'b11'. Two things are worth noting here:
510
-
511
- </p><div class="itemizedlist"><ul type="disc"><li><p>Although these four bits were originally written as a single
512
- four-bit integer, reading some other combination of bit-widths from the
513
- bitstream is well defined. There are no artificial alignment
514
- boundaries maintained in the bitstream.</p></li><li><p>The second value is the
515
- two-bit-wide integer 'b11'. This value may be interpreted either as
516
- the unsigned value '3', or the signed value '-1'. Signedness is
517
- dependent on decode context.</p></li></ul></div><p>
518
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id259912"></a>2.1.8.�end-of-packet alignment</h4></div></div></div><p>
519
- The typical use of bitpacking is to produce many independent
520
- byte-aligned packets which are embedded into a larger byte-aligned
521
- container structure, such as an Ogg transport bitstream. Externally,
522
- each bytestream (encoded bitstream) must begin and end on a byte
523
- boundary. Often, the encoded bitstream is not an integer number of
524
- bytes, and so there is unused (uncoded) space in the last byte of a
525
- packet.</p><p>
526
- Unused space in the last byte of a bytestream is always zeroed during
527
- the coding process. Thus, should this unused space be read, it will
528
- return binary zeroes.</p><p>
529
- Attempting to read past the end of an encoded packet results in an
530
- 'end-of-packet' condition. End-of-packet is not to be considered an
531
- error; it is merely a state indicating that there is insufficient
532
- remaining data to fulfill the desired read size. Vorbis uses truncated
533
- packets as a normal mode of operation, and as such, decoders must
534
- handle reading past the end of a packet as a typical mode of
535
- operation. Any further read operations after an 'end-of-packet'
536
- condition shall also return 'end-of-packet'.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id259938"></a>2.1.9.� reading zero bits</h4></div></div></div><p>
537
- Reading a zero-bit-wide integer returns the value '0' and does not
538
- increment the stream cursor. Reading to the end of the packet (but
539
- not past, such that an 'end-of-packet' condition has not triggered)
540
- and then reading a zero bit integer shall succeed, returning 0, and
541
- not trigger an end-of-packet condition. Reading a zero-bit-wide
542
- integer after a previous read sets 'end-of-packet' shall also fail
543
- with 'end-of-packet'.</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-codebook"></a>3.�Probability Model and Codebooks</h2></div><div><p class="releaseinfo">
544
- $Id: 03-codebook.xml 7186 2004-07-20 07:19:25Z xiphmont $
545
- </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id310158"></a>3.1.�Overview</h3></div></div></div><p>
546
- Unlike practically every other mainstream audio codec, Vorbis has no
547
- statically configured probability model, instead packing all entropy
548
- decoding configuration, VQ and Huffman, into the bitstream itself in
549
- the third header, the codec setup header. This packed configuration
550
- consists of multiple 'codebooks', each containing a specific
551
- Huffman-equivalent representation for decoding compressed codewords as
552
- well as an optional lookup table of output vector values to which a
553
- decoded Huffman value is applied as an offset, generating the final
554
- decoded output corresponding to a given compressed codeword.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id335318"></a>3.1.1.�Bitwise operation</h4></div></div></div><p>
555
- The codebook mechanism is built on top of the vorbis bitpacker. Both
556
- the codebooks themselves and the codewords they decode are unrolled
557
- from a packet as a series of arbitrary-width values read from the
558
- stream according to <a href="#vorbis-spec-bitpacking" title="2.�Bitpacking Convention">Section�2, &#8220;Bitpacking Convention&#8221;</a>.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id310216"></a>3.2.�Packed codebook format</h3></div></div></div><p>
559
- For purposes of the examples below, we assume that the storage
560
- system's native byte width is eight bits. This is not universally
561
- true; see <a href="#vorbis-spec-bitpacking" title="2.�Bitpacking Convention">Section�2, &#8220;Bitpacking Convention&#8221;</a> for discussion
562
- relating to non-eight-bit bytes.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id324957"></a>3.2.1.�codebook decode</h4></div></div></div><p>
563
- A codebook begins with a 24 bit sync pattern, 0x564342:
564
-
565
- </p><pre class="screen">
566
- byte 0: [ 0 1 0 0 0 0 1 0 ] (0x42)
567
- byte 1: [ 0 1 0 0 0 0 1 1 ] (0x43)
568
- byte 2: [ 0 1 0 1 0 1 1 0 ] (0x56)
569
- </pre><p>
570
- 16 bit <code class="varname">[codebook_dimensions]</code> and 24 bit <code class="varname">[codebook_entries]</code> fields:
571
-
572
- </p><pre class="screen">
573
-
574
- byte 3: [ X X X X X X X X ]
575
- byte 4: [ X X X X X X X X ] [codebook_dimensions] (16 bit unsigned)
576
-
577
- byte 5: [ X X X X X X X X ]
578
- byte 6: [ X X X X X X X X ]
579
- byte 7: [ X X X X X X X X ] [codebook_entries] (24 bit unsigned)
580
-
581
- </pre><p>
582
- Next is the <code class="varname">[ordered]</code> bit flag:
583
-
584
- </p><pre class="screen">
585
-
586
- byte 8: [ X ] [ordered] (1 bit)
587
-
588
- </pre><p>
589
- Each entry, numbering a
590
- total of <code class="varname">[codebook_entries]</code>, is assigned a codeword length.
591
- We now read the list of codeword lengths and store these lengths in
592
- the array <code class="varname">[codebook_codeword_lengths]</code>. Decode of lengths is
593
- according to whether the <code class="varname">[ordered]</code> flag is set or unset.
594
-
595
- </p><div class="itemizedlist"><ul type="disc"><li><p>If the <code class="varname">[ordered]</code> flag is unset, the codeword list is not
596
- length ordered and the decoder needs to read each codeword length
597
- one-by-one.</p><p>The decoder first reads one additional bit flag, the
598
- <code class="varname">[sparse]</code> flag. This flag determines whether or not the
599
- codebook contains unused entries that are not to be included in the
600
- codeword decode tree:
601
-
602
- </p><pre class="screen">
603
- byte 8: [ X 1 ] [sparse] flag (1 bit)
604
- </pre><p>
605
- The decoder now performs for each of the <code class="varname">[codebook_entries]</code>
606
- codebook entries:
607
-
608
- </p><pre class="screen">
609
-
610
- 1) if([sparse] is set){
611
-
612
- 2) [flag] = read one bit;
613
- 3) if([flag] is set){
614
-
615
- 4) [length] = read a five bit unsigned integer;
616
- 5) codeword length for this entry is [length]+1;
617
-
618
- } else {
619
-
620
- 6) this entry is unused. mark it as such.
621
-
622
- }
623
-
624
- } else the sparse flag is not set {
625
-
626
- 7) [length] = read a five bit unsigned integer;
627
- 8) the codeword length for this entry is [length]+1;
628
-
629
- }
630
-
631
- </pre></li><li><p>If the <code class="varname">[ordered]</code> flag is set, the codeword list for this
632
- codebook is encoded in ascending length order. Rather than reading
633
- a length for every codeword, the encoder reads the number of
634
- codewords per length. That is, beginning at entry zero:
635
-
636
- </p><pre class="screen">
637
- 1) [current_entry] = 0;
638
- 2) [current_length] = read a five bit unsigned integer and add 1;
639
- 3) [number] = read <a href="#vorbis-spec-ilog" title="9.2.1.�ilog">ilog</a>([codebook_entries] - [current_entry]) bits as an unsigned integer
640
- 4) set the entries [current_entry] through [current_entry]+[number]-1, inclusive,
641
- of the [codebook_codeword_lengths] array to [current_length]
642
- 5) set [current_entry] to [number] + [current_entry]
643
- 6) increment [current_length] by 1
644
- 7) if [current_entry] is greater than [codebook_entries] ERROR CONDITION;
645
- the decoder will not be able to read this stream.
646
- 8) if [current_entry] is less than [codebook_entries], repeat process starting at 3)
647
- 9) done.
648
- </pre></li></ul></div><p>
649
-
650
- After all codeword lengths have been decoded, the decoder reads the
651
- vector lookup table. Vorbis I supports three lookup types:
652
- </p><div class="orderedlist"><ol type="1"><li>No lookup</li><li>Implicitly populated value mapping (lattice VQ)</li><li>Explicitly populated value mapping (tessellated or 'foam'
653
- VQ)</li></ol></div><p>
654
- </p><p>
655
- The lookup table type is read as a four bit unsigned integer:
656
- </p><pre class="screen">
657
- 1) [codebook_lookup_type] = read four bits as an unsigned integer
658
- </pre><p>
659
- Codebook decode precedes according to <code class="varname">[codebook_lookup_type]</code>:
660
- </p><div class="itemizedlist"><ul type="disc"><li><p>Lookup type zero indicates no lookup to be read. Proceed past
661
- lookup decode.</p></li><li><p>Lookup types one and two are similar, differing only in the
662
- number of lookup values to be read. Lookup type one reads a list of
663
- values that are permuted in a set pattern to build a list of vectors,
664
- each vector of order <code class="varname">[codebook_dimensions]</code> scalars. Lookup
665
- type two builds the same vector list, but reads each scalar for each
666
- vector explicitly, rather than building vectors from a smaller list of
667
- possible scalar values. Lookup decode proceeds as follows:
668
-
669
- </p><pre class="screen">
670
- 1) [codebook_minimum_value] = <a href="#vorbis-spec-float32_unpack" title="9.2.2.�float32_unpack">float32_unpack</a>( read 32 bits as an unsigned integer)
671
- 2) [codebook_delta_value] = <a href="#vorbis-spec-float32_unpack" title="9.2.2.�float32_unpack">float32_unpack</a>( read 32 bits as an unsigned integer)
672
- 3) [codebook_value_bits] = read 4 bits as an unsigned integer and add 1
673
- 4) [codebook_sequence_p] = read 1 bit as a boolean flag
674
-
675
- if ( [codebook_lookup_type] is 1 ) {
676
-
677
- 5) [codebook_lookup_values] = <a href="#vorbis-spec-lookup1_values" title="9.2.3.�lookup1_values">lookup1_values</a>(<code class="varname">[codebook_entries]</code>, <code class="varname">[codebook_dimensions]</code> )
678
-
679
- } else {
680
-
681
- 6) [codebook_lookup_values] = <code class="varname">[codebook_entries]</code> * <code class="varname">[codebook_dimensions]</code>
682
-
683
- }
684
-
685
- 7) read a total of [codebook_lookup_values] unsigned integers of [codebook_value_bits] each;
686
- store these in order in the array [codebook_multiplicands]
687
- </pre></li><li><p>A <code class="varname">[codebook_lookup_type]</code> of greater than two is reserved
688
- and indicates a stream that is not decodable by the specification in this
689
- document.</p></li></ul></div><p>
690
- </p><p>
691
- An 'end of packet' during any read operation in the above steps is
692
- considered an error condition rendering the stream undecodable.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id258959"></a>3.2.1.1.�Huffman decision tree representation</h5></div></div></div><p>
693
- The <code class="varname">[codebook_codeword_lengths]</code> array and
694
- <code class="varname">[codebook_entries]</code> value uniquely define the Huffman decision
695
- tree used for entropy decoding.</p><p>
696
- Briefly, each used codebook entry (recall that length-unordered
697
- codebooks support unused codeword entries) is assigned, in order, the
698
- lowest valued unused binary Huffman codeword possible. Assume the
699
- following codeword length list:
700
-
701
- </p><pre class="screen">
702
- entry 0: length 2
703
- entry 1: length 4
704
- entry 2: length 4
705
- entry 3: length 4
706
- entry 4: length 4
707
- entry 5: length 2
708
- entry 6: length 3
709
- entry 7: length 3
710
- </pre><p>
711
- Assigning codewords in order (lowest possible value of the appropriate
712
- length to highest) results in the following codeword list:
713
-
714
- </p><pre class="screen">
715
- entry 0: length 2 codeword 00
716
- entry 1: length 4 codeword 0100
717
- entry 2: length 4 codeword 0101
718
- entry 3: length 4 codeword 0110
719
- entry 4: length 4 codeword 0111
720
- entry 5: length 2 codeword 10
721
- entry 6: length 3 codeword 110
722
- entry 7: length 3 codeword 111
723
- </pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
724
- Unlike most binary numerical values in this document, we
725
- intend the above codewords to be read and used bit by bit from left to
726
- right, thus the codeword '001' is the bit string 'zero, zero, one'.
727
- When determining 'lowest possible value' in the assignment definition
728
- above, the leftmost bit is the MSb.</p></div><p>
729
- It is clear that the codeword length list represents a Huffman
730
- decision tree with the entry numbers equivalent to the leaves numbered
731
- left-to-right:
732
-
733
- </p><div class="mediaobject"><img src="hufftree.png" alt="[huffman tree illustration]"></div><p>
734
- </p><p>
735
- As we assign codewords in order, we see that each choice constructs a
736
- new leaf in the leftmost possible position.</p><p>
737
- Note that it's possible to underspecify or overspecify a Huffman tree
738
- via the length list. In the above example, if codeword seven were
739
- eliminated, it's clear that the tree is unfinished:
740
-
741
- </p><div class="mediaobject"><img src="hufftree-under.png" alt="[underspecified huffman tree illustration]"></div><p>
742
- </p><p>
743
- Similarly, in the original codebook, it's clear that the tree is fully
744
- populated and a ninth codeword is impossible. Both underspecified and
745
- overspecified trees are an error condition rendering the stream
746
- undecodable.</p><p>
747
- Codebook entries marked 'unused' are simply skipped in the assigning
748
- process. They have no codeword and do not appear in the decision
749
- tree, thus it's impossible for any bit pattern read from the stream to
750
- decode to that entry number.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id316419"></a>3.2.1.2.�VQ lookup table vector representation</h5></div></div></div><p>
751
- Unpacking the VQ lookup table vectors relies on the following values:
752
- </p><pre class="programlisting">
753
- the [codebook_multiplicands] array
754
- [codebook_minimum_value]
755
- [codebook_delta_value]
756
- [codebook_sequence_p]
757
- [codebook_lookup_type]
758
- [codebook_entries]
759
- [codebook_dimensions]
760
- [codebook_lookup_values]
761
- </pre><p>
762
- </p><p>
763
- Decoding (unpacking) a specific vector in the vector lookup table
764
- proceeds according to <code class="varname">[codebook_lookup_type]</code>. The unpacked
765
- vector values are what a codebook would return during audio packet
766
- decode in a VQ context.</p><div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title"><a name="id316444"></a>3.2.1.2.1.�Vector value decode: Lookup type 1</h6></div></div></div><p>
767
- Lookup type one specifies a lattice VQ lookup table built
768
- algorithmically from a list of scalar values. Calculate (unpack) the
769
- final values of a codebook entry vector from the entries in
770
- <code class="varname">[codebook_multiplicands]</code> as follows (<code class="varname">[value_vector]</code>
771
- is the output vector representing the vector of values for entry number
772
- <code class="varname">[lookup_offset]</code> in this codebook):
773
-
774
- </p><pre class="screen">
775
- 1) [last] = 0;
776
- 2) [index_divisor] = 1;
777
- 3) iterate [i] over the range 0 ... [codebook_dimensions]-1 (once for each scalar value in the value vector) {
778
-
779
- 4) [multiplicand_offset] = ( [lookup_offset] divided by [index_divisor] using integer
780
- division ) integer modulo [codebook_lookup_values]
781
-
782
- 5) vector [value_vector] element [i] =
783
- ( [codebook_multiplicands] array element number [multiplicand_offset] ) *
784
- [codebook_delta_value] + [codebook_minimum_value] + [last];
785
-
786
- 6) if ( [codebook_sequence_p] is set ) then set [last] = vector [value_vector] element [i]
787
-
788
- 7) [index_divisor] = [index_divisor] * [codebook_lookup_values]
789
-
790
- }
791
-
792
- 8) vector calculation completed.
793
- </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title"><a name="id316478"></a>3.2.1.2.2.�Vector value decode: Lookup type 2</h6></div></div></div><p>
794
- Lookup type two specifies a VQ lookup table in which each scalar in
795
- each vector is explicitly set by the <code class="varname">[codebook_multiplicands]</code>
796
- array in a one-to-one mapping. Calculate [unpack] the
797
- final values of a codebook entry vector from the entries in
798
- <code class="varname">[codebook_multiplicands]</code> as follows (<code class="varname">[value_vector]</code>
799
- is the output vector representing the vector of values for entry number
800
- <code class="varname">[lookup_offset]</code> in this codebook):
801
-
802
- </p><pre class="screen">
803
- 1) [last] = 0;
804
- 2) [multiplicand_offset] = [lookup_offset] * [codebook_dimensions]
805
- 3) iterate [i] over the range 0 ... [codebook_dimensions]-1 (once for each scalar value in the value vector) {
806
-
807
- 4) vector [value_vector] element [i] =
808
- ( [codebook_multiplicands] array element number [multiplicand_offset] ) *
809
- [codebook_delta_value] + [codebook_minimum_value] + [last];
810
-
811
- 5) if ( [codebook_sequence_p] is set ) then set [last] = vector [value_vector] element [i]
812
-
813
- 6) increment [multiplicand_offset]
814
-
815
- }
816
-
817
- 7) vector calculation completed.
818
- </pre></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id316518"></a>3.3.�Use of the codebook abstraction</h3></div></div></div><p>
819
- The decoder uses the codebook abstraction much as it does the
820
- bit-unpacking convention; a specific codebook reads a
821
- codeword from the bitstream, decoding it into an entry number, and then
822
- returns that entry number to the decoder (when used in a scalar
823
- entropy coding context), or uses that entry number as an offset into
824
- the VQ lookup table, returning a vector of values (when used in a context
825
- desiring a VQ value). Scalar or VQ context is always explicit; any call
826
- to the codebook mechanism requests either a scalar entry number or a
827
- lookup vector.</p><p>
828
- Note that VQ lookup type zero indicates that there is no lookup table;
829
- requesting decode using a codebook of lookup type 0 in any context
830
- expecting a vector return value (even in a case where a vector of
831
- dimension one) is forbidden. If decoder setup or decode requests such
832
- an action, that is an error condition rendering the packet
833
- undecodable.</p><p>
834
- Using a codebook to read from the packet bitstream consists first of
835
- reading and decoding the next codeword in the bitstream. The decoder
836
- reads bits until the accumulated bits match a codeword in the
837
- codebook. This process can be though of as logically walking the
838
- Huffman decode tree by reading one bit at a time from the bitstream,
839
- and using the bit as a decision boolean to take the 0 branch (left in
840
- the above examples) or the 1 branch (right in the above examples).
841
- Walking the tree finishes when the decode process hits a leaf in the
842
- decision tree; the result is the entry number corresponding to that
843
- leaf. Reading past the end of a packet propagates the 'end-of-stream'
844
- condition to the decoder.</p><p>
845
- When used in a scalar context, the resulting codeword entry is the
846
- desired return value.</p><p>
847
- When used in a VQ context, the codeword entry number is used as an
848
- offset into the VQ lookup table. The value returned to the decoder is
849
- the vector of scalars corresponding to this offset.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-codec"></a>4.�Codec Setup and Packet Decode</h2></div><div><p class="releaseinfo">
850
- $Id: 04-codec.xml 10466 2005-11-28 00:34:44Z giles $
851
- </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id336024"></a>4.1.�Overview</h3></div></div></div><p>
852
- This document serves as the top-level reference document for the
853
- bit-by-bit decode specification of Vorbis I. This document assumes a
854
- high-level understanding of the Vorbis decode process, which is
855
- provided in <a href="#vorbis-spec-intro" title="1.�Introduction and Description">Section�1, &#8220;Introduction and Description&#8221;</a>. <a href="#vorbis-spec-bitpacking" title="2.�Bitpacking Convention">Section�2, &#8220;Bitpacking Convention&#8221;</a> covers reading and writing bit fields from
856
- and to bitstream packets.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id326710"></a>4.2.�Header decode and decode setup</h3></div></div></div><p>
857
- A Vorbis bitstream begins with three header packets. The header
858
- packets are, in order, the identification header, the comments header,
859
- and the setup header. All are required for decode compliance. An
860
- end-of-packet condition during decoding the first or third header
861
- packet renders the stream undecodable. End-of-packet decoding the
862
- comment header is a non-fatal error condition.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id337747"></a>4.2.1.�Common header decode</h4></div></div></div><p>
863
- Each header packet begins with the same header fields.
864
- </p><pre class="screen">
865
- 1) [packet_type] : 8 bit value
866
- 2) 0x76, 0x6f, 0x72, 0x62, 0x69, 0x73: the characters 'v','o','r','b','i','s' as six octets
867
- </pre><p>
868
- Decode continues according to packet type; the identification header
869
- is type 1, the comment header type 3 and the setup header type 5
870
- (these types are all odd as a packet with a leading single bit of '0'
871
- is an audio packet). The packets must occur in the order of
872
- identification, comment, setup.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id317806"></a>4.2.2.�Identification header</h4></div></div></div><p>
873
- The identification header is a short header of only a few fields used
874
- to declare the stream definitively as Vorbis, and provide a few externally
875
- relevant pieces of information about the audio stream. The
876
- identification header is coded as follows:</p><pre class="screen">
877
- 1) [vorbis_version] = read 32 bits as unsigned integer
878
- 2) [audio_channels] = read 8 bit integer as unsigned
879
- 3) [audio_sample_rate] = read 32 bits as unsigned integer
880
- 4) [bitrate_maximum] = read 32 bits as signed integer
881
- 5) [bitrate_nominal] = read 32 bits as signed integer
882
- 6) [bitrate_minimum] = read 32 bits as signed integer
883
- 7) [blocksize_0] = 2 exponent (read 4 bits as unsigned integer)
884
- 8) [blocksize_1] = 2 exponent (read 4 bits as unsigned integer)
885
- 9) [framing_flag] = read one bit
886
- </pre><p>
887
- <code class="varname">[vorbis_version]</code> is to read '0' in order to be compatible
888
- with this document. Both <code class="varname">[audio_channels]</code> and
889
- <code class="varname">[audio_sample_rate]</code> must read greater than zero. Allowed final
890
- blocksize values are 64, 128, 256, 512, 1024, 2048, 4096 and 8192 in
891
- Vorbis I. <code class="varname">[blocksize_0]</code> must be less than or equal to
892
- <code class="varname">[blocksize_1]</code>. The framing bit must be nonzero. Failure to
893
- meet any of these conditions renders a stream undecodable.</p><p>
894
- The bitrate fields above are used only as hints. The nominal bitrate
895
- field especially may be considerably off in purely VBR streams. The
896
- fields are meaningful only when greater than zero.</p><p>
897
- </p><div class="itemizedlist"><ul type="disc"><li>All three fields set to the same value implies a fixed rate, or tightly bounded, nearly fixed-rate bitstream</li><li>Only nominal set implies a VBR or ABR stream that averages the nominal bitrate</li><li>Maximum and or minimum set implies a VBR bitstream that obeys the bitrate limits</li><li>None set indicates the encoder does not care to speculate.</li></ul></div><p>
898
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id320370"></a>4.2.3.�Comment header</h4></div></div></div><p>
899
- Comment header decode and data specification is covered in
900
- <a href="#vorbis-spec-comment" title="5.�comment field and header specification">Section�5, &#8220;comment field and header specification&#8221;</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id320384"></a>4.2.4.�Setup header</h4></div></div></div><p>
901
- Vorbis codec setup is configurable to an extreme degree:
902
-
903
- </p><div class="mediaobject"><img src="components.png" alt="[decoder pipeline configuration]"></div><p>
904
- </p><p>
905
- The setup header contains the bulk of the codec setup information
906
- needed for decode. The setup header contains, in order, the lists of
907
- codebook configurations, time-domain transform configurations
908
- (placeholders in Vorbis I), floor configurations, residue
909
- configurations, channel mapping configurations and mode
910
- configurations. It finishes with a framing bit of '1'. Header decode
911
- proceeds in the following order:</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id305504"></a>4.2.4.1.�Codebooks</h5></div></div></div><div class="orderedlist"><ol type="1"><li><code class="varname">[vorbis_codebook_count]</code> = read eight bits as unsigned integer and add one</li><li>Decode <code class="varname">[vorbis_codebook_count]</code> codebooks in order as defined
912
- in <a href="#vorbis-spec-codebook" title="3.�Probability Model and Codebooks">Section�3, &#8220;Probability Model and Codebooks&#8221;</a>. Save each configuration, in
913
- order, in an array of
914
- codebook configurations <code class="varname">[vorbis_codebook_configurations]</code>.</li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id305539"></a>4.2.4.2.�Time domain transforms</h5></div></div></div><p>
915
- These hooks are placeholders in Vorbis I. Nevertheless, the
916
- configuration placeholder values must be read to maintain bitstream
917
- sync.</p><div class="orderedlist"><ol type="1"><li><code class="varname">[vorbis_time_count]</code> = read 6 bits as unsigned integer and add one</li><li>read <code class="varname">[vorbis_time_count]</code> 16 bit values; each value should be zero. If any value is nonzero, this is an error condition and the stream is undecodable.</li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id328542"></a>4.2.4.3.�Floors</h5></div></div></div><p>
918
- Vorbis uses two floor types; header decode is handed to the decode
919
- abstraction of the appropriate type.</p><div class="orderedlist"><ol type="1"><li><code class="varname">[vorbis_floor_count]</code> = read 6 bits as unsigned integer and add one</li><li><p>For each <code class="varname">[i]</code> of <code class="varname">[vorbis_floor_count]</code> floor numbers:
920
- </p><div class="orderedlist"><ol type="a"><li>read the floor type: vector <code class="varname">[vorbis_floor_types]</code> element <code class="varname">[i]</code> =
921
- read 16 bits as unsigned integer</li><li>If the floor type is zero, decode the floor
922
- configuration as defined in <a href="#vorbis-spec-floor0" title="6.�Floor type 0 setup and decode">Section�6, &#8220;Floor type 0 setup and decode&#8221;</a>; save
923
- this
924
- configuration in slot <code class="varname">[i]</code> of the floor configuration array <code class="varname">[vorbis_floor_configurations]</code>.</li><li>If the floor type is one,
925
- decode the floor configuration as defined in <a href="#vorbis-spec-floor1" title="7.�Floor type 1 setup and decode">Section�7, &#8220;Floor type 1 setup and decode&#8221;</a>; save this configuration in slot <code class="varname">[i]</code> of the floor configuration array <code class="varname">[vorbis_floor_configurations]</code>.</li><li>If the the floor type is greater than one, this stream is undecodable; ERROR CONDITION</li></ol></div><p>
926
- </p></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id328635"></a>4.2.4.4.�Residues</h5></div></div></div><p>
927
- Vorbis uses three residue types; header decode of each type is identical.
928
- </p><div class="orderedlist"><ol type="1"><li><code class="varname">[vorbis_residue_count]</code> = read 6 bits as unsigned integer and add one
929
- </li><li><p>For each of <code class="varname">[vorbis_residue_count]</code> residue numbers:
930
- </p><div class="orderedlist"><ol type="a"><li>read the residue type; vector <code class="varname">[vorbis_residue_types]</code> element <code class="varname">[i]</code> = read 16 bits as unsigned integer</li><li>If the residue type is zero,
931
- one or two, decode the residue configuration as defined in <a href="#vorbis-spec-residue" title="8.�Residue setup and decode">Section�8, &#8220;Residue setup and decode&#8221;</a>; save this configuration in slot <code class="varname">[i]</code> of the residue configuration array <code class="varname">[vorbis_residue_configurations]</code>.</li><li>If the the residue type is greater than two, this stream is undecodable; ERROR CONDITION</li></ol></div><p>
932
- </p></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id275059"></a>4.2.4.5.�Mappings</h5></div></div></div><p>
933
- Mappings are used to set up specific pipelines for encoding
934
- multichannel audio with varying channel mapping applications. Vorbis I
935
- uses a single mapping type (0), with implicit PCM channel mappings.</p><div class="orderedlist"><ol type="1"><li><code class="varname">[vorbis_mapping_count]</code> = read 6 bits as unsigned integer and add one</li><li><p>For each <code class="varname">[i]</code> of <code class="varname">[vorbis_mapping_count]</code> mapping numbers:
936
- </p><div class="orderedlist"><ol type="a"><li>read the mapping type: 16 bits as unsigned integer. There's no reason to save the mapping type in Vorbis I.</li><li>If the mapping type is nonzero, the stream is undecodable</li><li><p>If the mapping type is zero:
937
- </p><div class="orderedlist"><ol type="i"><li><p>read 1 bit as a boolean flag
938
- </p><div class="orderedlist"><ol type="A"><li>if set, <code class="varname">[vorbis_mapping_submaps]</code> = read 4 bits as unsigned integer and add one</li><li>if unset, <code class="varname">[vorbis_mapping_submaps]</code> = 1</li></ol></div><p>
939
- </p></li><li><p>read 1 bit as a boolean flag
940
- </p><div class="orderedlist"><ol type="A"><li><p>if set, square polar channel mapping is in use:
941
- </p><div class="orderedlist"><ol type="I"><li><code class="varname">[vorbis_mapping_coupling_steps]</code> = read 8 bits as unsigned integer and add one</li><li><p>for <code class="varname">[j]</code> each of <code class="varname">[vorbis_mapping_coupling_steps]</code> steps:
942
- </p><div class="orderedlist"><ol type="1"><li>vector <code class="varname">[vorbis_mapping_magnitude]</code> element <code class="varname">[j]</code>= read <a href="#vorbis-spec-ilog" title="9.2.1.�ilog">ilog</a>(<code class="varname">[audio_channels]</code> - 1) bits as unsigned integer</li><li>vector <code class="varname">[vorbis_mapping_angle]</code> element <code class="varname">[j]</code>= read <a href="#vorbis-spec-ilog" title="9.2.1.�ilog">ilog</a>(<code class="varname">[audio_channels]</code> - 1) bits as unsigned integer</li><li>the numbers read in the above two steps are channel numbers representing the channel to treat as magnitude and the channel to treat as angle, respectively. If for any coupling step the angle channel number equals the magnitude channel number, the magnitude channel number is greater than <code class="varname">[audio_channels]</code>-1, or the angle channel is greater than <code class="varname">[audio_channels]</code>-1, the stream is undecodable.</li></ol></div><p>
943
- </p></li></ol></div><p>
944
- </p></li><li>if unset, <code class="varname">[vorbis_mapping_coupling_steps]</code> = 0</li></ol></div><p>
945
- </p></li><li>read 2 bits (reserved field); if the value is nonzero, the stream is undecodable</li><li><p>if <code class="varname">[vorbis_mapping_submaps]</code> is greater than one, we read channel multiplex settings. For each <code class="varname">[j]</code> of <code class="varname">[audio_channels]</code> channels:</p><div class="orderedlist"><ol type="A"><li>vector <code class="varname">[vorbis_mapping_mux]</code> element <code class="varname">[j]</code> = read 4 bits as unsigned integer</li><li>if the value is greater than the highest numbered submap (<code class="varname">[vorbis_mapping_submaps]</code> - 1), this in an error condition rendering the stream undecodable</li></ol></div></li><li><p>for each submap <code class="varname">[j]</code> of <code class="varname">[vorbis_mapping_submaps]</code> submaps, read the floor and residue numbers for use in decoding that submap:</p><div class="orderedlist"><ol type="A"><li>read and discard 8 bits (the unused time configuration placeholder)</li><li>read 8 bits as unsigned integer for the floor number; save in vector <code class="varname">[vorbis_mapping_submap_floor]</code> element <code class="varname">[j]</code></li><li>verify the floor number is not greater than the highest number floor configured for the bitstream. If it is, the bitstream is undecodable</li><li>read 8 bits as unsigned integer for the residue number; save in vector <code class="varname">[vorbis_mapping_submap_residue]</code> element <code class="varname">[j]</code></li><li>verify the residue number is not greater than the highest number residue configured for the bitstream. If it is, the bitstream is undecodable</li></ol></div></li><li>save this mapping configuration in slot <code class="varname">[i]</code> of the mapping configuration array <code class="varname">[vorbis_mapping_configurations]</code>.</li></ol></div></li></ol></div><p>
946
- </p></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id342611"></a>4.2.4.6.�Modes</h5></div></div></div><div class="orderedlist"><ol type="1"><li><code class="varname">[vorbis_mode_count]</code> = read 6 bits as unsigned integer and add one</li><li><p>For each of <code class="varname">[vorbis_mode_count]</code> mode numbers:</p><div class="orderedlist"><ol type="a"><li><code class="varname">[vorbis_mode_blockflag]</code> = read 1 bit</li><li><code class="varname">[vorbis_mode_windowtype]</code> = read 16 bits as unsigned integer</li><li><code class="varname">[vorbis_mode_transformtype]</code> = read 16 bits as unsigned integer</li><li><code class="varname">[vorbis_mode_mapping]</code> = read 8 bits as unsigned integer</li><li>verify ranges; zero is the only legal value in Vorbis I for
947
- <code class="varname">[vorbis_mode_windowtype]</code>
948
- and <code class="varname">[vorbis_mode_transformtype]</code>. <code class="varname">[vorbis_mode_mapping]</code> must not be greater than the highest number mapping in use. Any illegal values render the stream undecodable.</li><li>save this mode configuration in slot <code class="varname">[i]</code> of the mode configuration array
949
- <code class="varname">[vorbis_mode_configurations]</code>.</li></ol></div></li><li>read 1 bit as a framing flag. If unset, a framing error occurred and the stream is not
950
- decodable.</li></ol></div><p>
951
- After reading mode descriptions, setup header decode is complete.
952
- </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id342709"></a>4.3.�Audio packet decode and synthesis</h3></div></div></div><p>
953
- Following the three header packets, all packets in a Vorbis I stream
954
- are audio. The first step of audio packet decode is to read and
955
- verify the packet type. <span class="emphasis"><em>A non-audio packet when audio is expected
956
- indicates stream corruption or a non-compliant stream. The decoder
957
- must ignore the packet and not attempt decoding it to audio</em></span>.
958
- </p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id342724"></a>4.3.1.�packet type, mode and window decode</h4></div></div></div><div class="orderedlist"><ol type="1"><li>read 1 bit <code class="varname">[packet_type]</code>; check that packet type is 0 (audio)</li><li>read <a href="#vorbis-spec-ilog" title="9.2.1.�ilog">ilog</a>([vorbis_mode_count]-1) bits
959
- <code class="varname">[mode_number]</code></li><li>decode blocksize <code class="varname">[n]</code> is equal to <code class="varname">[blocksize_0]</code> if
960
- <code class="varname">[vorbis_mode_blockflag]</code> is 0, else <code class="varname">[n]</code> is equal to <code class="varname">[blocksize_1]</code>.</li><li><p>perform window selection and setup; this window is used later by the inverse MDCT:</p><div class="orderedlist"><ol type="a"><li><p>if this is a long window (the <code class="varname">[vorbis_mode_blockflag]</code> flag of this mode is
961
- set):</p><div class="orderedlist"><ol type="i"><li>read 1 bit for <code class="varname">[previous_window_flag]</code></li><li>read 1 bit for <code class="varname">[next_window_flag]</code></li><li>if <code class="varname">[previous_window_flag]</code> is not set, the left half
962
- of the window will be a hybrid window for lapping with a
963
- short block. See <a href="#vorbis-spec-window" title="1.3.2.3.�Window shape decode (long windows only)">Section�1.3.2.3, &#8220;Window shape decode (long windows only)&#8221;</a> for an illustration of overlapping
964
- dissimilar
965
- windows. Else, the left half window will have normal long
966
- shape.</li><li>if <code class="varname">[next_window_flag]</code> is not set, the right half of
967
- the window will be a hybrid window for lapping with a short
968
- block. See <a href="#vorbis-spec-window" title="1.3.2.3.�Window shape decode (long windows only)">Section�1.3.2.3, &#8220;Window shape decode (long windows only)&#8221;</a> for an
969
- illustration of overlapping dissimilar
970
- windows. Else, the left right window will have normal long
971
- shape.</li></ol></div></li><li> if this is a short window, the window is always the same
972
- short-window shape.</li></ol></div></li></ol></div><p>
973
- Vorbis windows all use the slope function y=sin(0.5 * &#960; * sin^2((x+.5)/n * &#960;)),
974
- where n is window size and x ranges 0...n-1, but dissimilar
975
- lapping requirements can affect overall shape. Window generation
976
- proceeds as follows:</p><div class="orderedlist"><ol type="1"><li> <code class="varname">[window_center]</code> = <code class="varname">[n]</code> / 2</li><li><p> if (<code class="varname">[vorbis_mode_blockflag]</code> is set and <code class="varname">[previous_window_flag]</code> is
977
- not set) then
978
- </p><div class="orderedlist"><ol type="a"><li><code class="varname">[left_window_start]</code> = <code class="varname">[n]</code>/4 -
979
- <code class="varname">[blocksize_0]</code>/4</li><li><code class="varname">[left_window_end]</code> = <code class="varname">[n]</code>/4 + <code class="varname">[blocksize_0]</code>/4</li><li><code class="varname">[left_n]</code> = <code class="varname">[blocksize_0]</code>/2</li></ol></div><p>
980
- else
981
- </p><div class="orderedlist"><ol type="a"><li><code class="varname">[left_window_start]</code> = 0</li><li><code class="varname">[left_window_end]</code> = <code class="varname">[window_center]</code></li><li><code class="varname">[left_n]</code> = <code class="varname">[n]</code>/2</li></ol></div></li><li><p> if (<code class="varname">[vorbis_mode_blockflag]</code> is set and <code class="varname">[next_window_flag]</code> is not
982
- set) then
983
- </p><div class="orderedlist"><ol type="a"><li><code class="varname">[right_window_start]</code> = <code class="varname">[n]*3</code>/4 -
984
- <code class="varname">[blocksize_0]</code>/4</li><li><code class="varname">[right_window_end]</code> = <code class="varname">[n]*3</code>/4 +
985
- <code class="varname">[blocksize_0]</code>/4</li><li><code class="varname">[right_n]</code> = <code class="varname">[blocksize_0]</code>/2</li></ol></div><p>
986
- else
987
- </p><div class="orderedlist"><ol type="a"><li><code class="varname">[right_window_start]</code> = <code class="varname">[window_center]</code></li><li><code class="varname">[right_window_end]</code> = <code class="varname">[n]</code></li><li><code class="varname">[right_n]</code> = <code class="varname">[n]</code>/2</li></ol></div></li><li> window from range 0 ... <code class="varname">[left_window_start]</code>-1 inclusive is zero</li><li> for <code class="varname">[i]</code> in range <code class="varname">[left_window_start]</code> ...
988
- <code class="varname">[left_window_end]</code>-1, window(<code class="varname">[i]</code>) = sin(.5 * &#960; * sin^2( (<code class="varname">[i]</code>-<code class="varname">[left_window_start]</code>+.5) / <code class="varname">[left_n]</code> * .5 * &#960;) )</li><li> window from range <code class="varname">[left_window_end]</code> ... <code class="varname">[right_window_start]</code>-1
989
- inclusive is one</li><li> for <code class="varname">[i]</code> in range <code class="varname">[right_window_start]</code> ... <code class="varname">[right_window_end]</code>-1, window(<code class="varname">[i]</code>) = sin(.5 * &#960; * sin^2( (<code class="varname">[i]</code>-<code class="varname">[right_window_start]</code>+.5) / <code class="varname">[right_n]</code> * .5 * &#960; + .5 * &#960;) )</li><li> window from range <code class="varname">[right_window_start]</code> ... <code class="varname">[n]</code>-1 is
990
- zero</li></ol></div><p>
991
- An end-of-packet condition up to this point should be considered an
992
- error that discards this packet from the stream. An end of packet
993
- condition past this point is to be considered a possible nominal
994
- occurrence.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id343132"></a>4.3.2.�floor curve decode</h4></div></div></div><p>
995
- From this point on, we assume out decode context is using mode number
996
- <code class="varname">[mode_number]</code> from configuration array
997
- <code class="varname">[vorbis_mode_configurations]</code> and the map number
998
- <code class="varname">[vorbis_mode_mapping]</code> (specified by the current mode) taken
999
- from the mapping configuration array
1000
- <code class="varname">[vorbis_mapping_configurations]</code>.</p><p>
1001
- Floor curves are decoded one-by-one in channel order.</p><p>
1002
- For each floor <code class="varname">[i]</code> of <code class="varname">[audio_channels]</code>
1003
- </p><div class="orderedlist"><ol type="1"><li><code class="varname">[submap_number]</code> = element <code class="varname">[i]</code> of vector [vorbis_mapping_mux]</li><li><code class="varname">[floor_number]</code> = element <code class="varname">[submap_number]</code> of vector
1004
- [vorbis_submap_floor]</li><li>if the floor type of this
1005
- floor (vector <code class="varname">[vorbis_floor_types]</code> element
1006
- <code class="varname">[floor_number]</code>) is zero then decode the floor for
1007
- channel <code class="varname">[i]</code> according to the
1008
- <a href="#vorbis-spec-floor0-decode" title="6.2.2.�packet decode">Section�6.2.2, &#8220;packet decode&#8221;</a></li><li>if the type of this floor
1009
- is one then decode the floor for channel <code class="varname">[i]</code> according
1010
- to the <a href="#vorbis-spec-floor1-decode" title="7.2.2.1.�packet decode">Section�7.2.2.1, &#8220;packet decode&#8221;</a></li><li>save the needed decoded floor information for channel for later synthesis</li><li>if the decoded floor returned 'unused', set vector <code class="varname">[no_residue]</code> element
1011
- <code class="varname">[i]</code> to true, else set vector <code class="varname">[no_residue]</code> element <code class="varname">[i]</code> to
1012
- false</li></ol></div><p>
1013
- </p><p>
1014
- An end-of-packet condition during floor decode shall result in packet
1015
- decode zeroing all channel output vectors and skipping to the
1016
- add/overlap output stage.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id343249"></a>4.3.3.�nonzero vector propagate</h4></div></div></div><p>
1017
- A possible result of floor decode is that a specific vector is marked
1018
- 'unused' which indicates that that final output vector is all-zero
1019
- values (and the floor is zero). The residue for that vector is not
1020
- coded in the stream, save for one complication. If some vectors are
1021
- used and some are not, channel coupling could result in mixing a
1022
- zeroed and nonzeroed vector to produce two nonzeroed vectors.</p><p>
1023
- for each <code class="varname">[i]</code> from 0 ... <code class="varname">[vorbis_mapping_coupling_steps]</code>-1
1024
-
1025
- </p><div class="orderedlist"><ol type="1"><li>if either <code class="varname">[no_residue]</code> entry for channel
1026
- (<code class="varname">[vorbis_mapping_magnitude]</code> element <code class="varname">[i]</code>)
1027
- or channel
1028
- (<code class="varname">[vorbis_mapping_angle]</code> element <code class="varname">[i]</code>)
1029
- are set to false, then both must be set to false. Note that an 'unused'
1030
- floor has no decoded floor information; it is important that this is
1031
- remembered at floor curve synthesis time.</li></ol></div><p>
1032
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id343299"></a>4.3.4.�residue decode</h4></div></div></div><p>
1033
- Unlike floors, which are decoded in channel order, the residue vectors
1034
- are decoded in submap order.</p><p>
1035
- for each submap <code class="varname">[i]</code> in order from 0 ... <code class="varname">[vorbis_mapping_submaps]</code>-1</p><div class="orderedlist"><ol type="1"><li><code class="varname">[ch]</code> = 0</li><li><p>for each channel <code class="varname">[j]</code> in order from 0 ... <code class="varname">[audio_channels]</code> - 1</p><div class="orderedlist"><ol type="a"><li><p>if channel <code class="varname">[j]</code> in submap <code class="varname">[i]</code> (vector <code class="varname">[vorbis_mapping_mux]</code> element <code class="varname">[j]</code> is equal to <code class="varname">[i]</code>)</p><div class="orderedlist"><ol type="i"><li><p>if vector <code class="varname">[no_residue]</code> element <code class="varname">[j]</code> is true
1036
- </p><div class="orderedlist"><ol type="A"><li>vector <code class="varname">[do_not_decode_flag]</code> element <code class="varname">[ch]</code> is set</li></ol></div><p>
1037
- else
1038
- </p><div class="orderedlist"><ol type="A"><li>vector <code class="varname">[do_not_decode_flag]</code> element <code class="varname">[ch]</code> is unset</li></ol></div></li><li>increment <code class="varname">[ch]</code></li></ol></div></li></ol></div></li><li><code class="varname">[residue_number]</code> = vector <code class="varname">[vorbis_mapping_submap_residue]</code> element <code class="varname">[i]</code></li><li><code class="varname">[residue_type]</code> = vector <code class="varname">[vorbis_residue_types]</code> element <code class="varname">[residue_number]</code></li><li>decode <code class="varname">[ch]</code> vectors using residue <code class="varname">[residue_number]</code>, according to type <code class="varname">[residue_type]</code>, also passing vector <code class="varname">[do_not_decode_flag]</code> to indicate which vectors in the bundle should not be decoded. Correct per-vector decode length is <code class="varname">[n]</code>/2.</li><li><code class="varname">[ch]</code> = 0</li><li><p>for each channel <code class="varname">[j]</code> in order from 0 ... <code class="varname">[audio_channels]</code></p><div class="orderedlist"><ol type="a"><li><p>if channel <code class="varname">[j]</code> is in submap <code class="varname">[i]</code> (vector <code class="varname">[vorbis_mapping_mux]</code> element <code class="varname">[j]</code> is equal to <code class="varname">[i]</code>)</p><div class="orderedlist"><ol type="i"><li>residue vector for channel <code class="varname">[j]</code> is set to decoded residue vector <code class="varname">[ch]</code></li><li>increment <code class="varname">[ch]</code></li></ol></div></li></ol></div></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id343545"></a>4.3.5.�inverse coupling</h4></div></div></div><p>
1039
- for each <code class="varname">[i]</code> from <code class="varname">[vorbis_mapping_coupling_steps]</code>-1 descending to 0
1040
-
1041
- </p><div class="orderedlist"><ol type="1"><li><code class="varname">[magnitude_vector]</code> = the residue vector for channel
1042
- (vector <code class="varname">[vorbis_mapping_magnitude]</code> element <code class="varname">[i]</code>)</li><li><code class="varname">[angle_vector]</code> = the residue vector for channel (vector
1043
- <code class="varname">[vorbis_mapping_angle]</code> element <code class="varname">[i]</code>)</li><li><p>for each scalar value <code class="varname">[M]</code> in vector <code class="varname">[magnitude_vector]</code> and the corresponding scalar value <code class="varname">[A]</code> in vector <code class="varname">[angle_vector]</code>:</p><div class="orderedlist"><ol type="a"><li><p>if (<code class="varname">[M]</code> is greater than zero)
1044
- </p><div class="orderedlist"><ol type="i"><li><p>if (<code class="varname">[A]</code> is greater than zero)
1045
- </p><div class="orderedlist"><ol type="A"><li><code class="varname">[new_M]</code> = <code class="varname">[M]</code></li><li><code class="varname">[new_A]</code> = <code class="varname">[M]</code>-<code class="varname">[A]</code></li></ol></div><p>
1046
- else
1047
- </p><div class="orderedlist"><ol type="A"><li><code class="varname">[new_A]</code> = <code class="varname">[M]</code></li><li><code class="varname">[new_M]</code> = <code class="varname">[M]</code>+<code class="varname">[A]</code></li></ol></div><p>
1048
- </p></li></ol></div><p>
1049
- else
1050
- </p><div class="orderedlist"><ol type="i"><li><p>if (<code class="varname">[A]</code> is greater than zero)
1051
- </p><div class="orderedlist"><ol type="A"><li><code class="varname">[new_M]</code> = <code class="varname">[M]</code></li><li><code class="varname">[new_A]</code> = <code class="varname">[M]</code>+<code class="varname">[A]</code></li></ol></div><p>
1052
- else
1053
- </p><div class="orderedlist"><ol type="A"><li><code class="varname">[new_A]</code> = <code class="varname">[M]</code></li><li><code class="varname">[new_M]</code> = <code class="varname">[M]</code>-<code class="varname">[A]</code></li></ol></div><p>
1054
- </p></li></ol></div><p>
1055
- </p></li><li>set scalar value <code class="varname">[M]</code> in vector <code class="varname">[magnitude_vector]</code> to <code class="varname">[new_M]</code></li><li>set scalar value <code class="varname">[A]</code> in vector <code class="varname">[angle_vector]</code> to <code class="varname">[new_A]</code></li></ol></div></li></ol></div><p>
1056
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id343790"></a>4.3.6.�dot product</h4></div></div></div><p>
1057
- For each channel, synthesize the floor curve from the decoded floor
1058
- information, according to packet type. Note that the vector synthesis
1059
- length for floor computation is <code class="varname">[n]</code>/2.</p><p>
1060
- For each channel, multiply each element of the floor curve by each
1061
- element of that channel's residue vector. The result is the dot
1062
- product of the floor and residue vectors for each channel; the produced
1063
- vectors are the length <code class="varname">[n]</code>/2 audio spectrum for each
1064
- channel.</p><p>
1065
- One point is worth mentioning about this dot product; a common mistake
1066
- in a fixed point implementation might be to assume that a 32 bit
1067
- fixed-point representation for floor and residue and direct
1068
- multiplication of the vectors is sufficient for acceptable spectral
1069
- depth in all cases because it happens to mostly work with the current
1070
- Xiph.Org reference encoder. </p><p>
1071
- However, floor vector values can span ~140dB (~24 bits unsigned), and
1072
- the audio spectrum vector should represent a minimum of 120dB (~21
1073
- bits with sign), even when output is to a 16 bit PCM device. For the
1074
- residue vector to represent full scale if the floor is nailed to
1075
- -140dB, it must be able to span 0 to +140dB. For the residue vector
1076
- to reach full scale if the floor is nailed at 0dB, it must be able to
1077
- represent -140dB to +0dB. Thus, in order to handle full range
1078
- dynamics, a residue vector may span -140dB to +140dB entirely within
1079
- spec. A 280dB range is approximately 48 bits with sign; thus the
1080
- residue vector must be able to represent a 48 bit range and the dot
1081
- product must be able to handle an effective 48 bit times 24 bit
1082
- multiplication. This range may be achieved using large (64 bit or
1083
- larger) integers, or implementing a movable binary point
1084
- representation.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id343829"></a>4.3.7.�inverse MDCT</h4></div></div></div><p>
1085
- Convert the audio spectrum vector of each channel back into time
1086
- domain PCM audio via an inverse Modified Discrete Cosine Transform
1087
- (MDCT). A detailed description of the MDCT is available in the paper
1088
- <a href="http://www.iocon.com/resource/docs/ps/eusipco_corrected.ps" target="_top">&#8220;<span class="citetitle">The
1089
- use of multirate filter banks for coding of high quality digital
1090
- audio</span>&#8221;</a>, by T. Sporer, K. Brandenburg and B. Edler. The window
1091
- function used for the MDCT is the function described earlier.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id343850"></a>4.3.8.�overlap_add</h4></div></div></div><p>
1092
- Windowed MDCT output is overlapped and added with the right hand data
1093
- of the previous window such that the 3/4 point of the previous window
1094
- is aligned with the 1/4 point of the current window (as illustrated in
1095
- <a href="#vorbis-spec-window" title="1.3.2.3.�Window shape decode (long windows only)">Section�1.3.2.3, &#8220;Window shape decode (long windows only)&#8221;</a>). The overlapped portion
1096
- produced from overlapping the previous and current frame data is
1097
- finished data to be returned by the decoder. This data spans from the
1098
- center of the previous window to the center of the current window. In
1099
- the case of same-sized windows, the amount of data to return is
1100
- one-half block consisting of and only of the overlapped portions. When
1101
- overlapping a short and long window, much of the returned range does not
1102
- actually overlap. This does not damage transform orthogonality. Pay
1103
- attention however to returning the correct data range; the amount of
1104
- data to be returned is:
1105
-
1106
- </p><pre class="programlisting">
1107
- window_blocksize(previous_window)/4+window_blocksize(current_window)/4
1108
- </pre><p>
1109
-
1110
- from the center (element windowsize/2) of the previous window to the
1111
- center (element windowsize/2-1, inclusive) of the current window.</p><p>
1112
- Data is not returned from the first frame; it must be used to 'prime'
1113
- the decode engine. The encoder accounts for this priming when
1114
- calculating PCM offsets; after the first frame, the proper PCM output
1115
- offset is '0' (as no data has been returned yet).</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id343883"></a>4.3.9.�output channel order</h4></div></div></div><p>
1116
- Vorbis I specifies only a channel mapping type 0. In mapping type 0,
1117
- channel mapping is implicitly defined as follows for standard audio
1118
- applications:</p><div class="variablelist"><dl><dt><span class="term">one channel</span></dt><dd>the stream is monophonic</dd><dt><span class="term">two channels</span></dt><dd>the stream is stereo. channel order: left, right</dd><dt><span class="term">three channels</span></dt><dd>the stream is a 1d-surround encoding. channel order: left,
1119
- center, right</dd><dt><span class="term">four channels</span></dt><dd>the stream is quadraphonic surround. channel order: front left,
1120
- front right, rear left, rear right</dd><dt><span class="term">five channels</span></dt><dd>the stream is five-channel surround. channel order: front left,
1121
- front center, front right, rear left, rear right</dd><dt><span class="term">six channels</span></dt><dd>the stream is 5.1 surround. channel order: front left, front
1122
- center, front right, rear left, rear right, LFE</dd><dt><span class="term">greater than six channels</span></dt><dd>channel use and order is defined by the application</dd></dl></div><p>
1123
- Applications using Vorbis for dedicated purposes may define channel
1124
- mapping as seen fit. Future channel mappings (such as three and four
1125
- channel <a href="http://www.ambisonic.net/" target="_top">Ambisonics</a>) will
1126
- make use of channel mappings other than mapping 0.</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-comment"></a>5.�comment field and header specification</h2></div><div><p class="releaseinfo">
1127
- $Id: 05-comment.xml 11703 2006-07-17 16:33:17Z giles $
1128
- </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id314030"></a>5.1.�Overview</h3></div></div></div><p>The Vorbis text comment header is the second (of three) header
1129
- packets that begin a Vorbis bitstream. It is meant for short text
1130
- comments, not arbitrary metadata; arbitrary metadata belongs in a
1131
- separate logical bitstream (usually an XML stream type) that provides
1132
- greater structure and machine parseability.</p><p>The comment field is meant to be used much like someone jotting a
1133
- quick note on the bottom of a CDR. It should be a little information to
1134
- remember the disc by and explain it to others; a short, to-the-point
1135
- text note that need not only be a couple words, but isn't going to be
1136
- more than a short paragraph. The essentials, in other words, whatever
1137
- they turn out to be, eg:
1138
-
1139
- </p><div class="blockquote"><blockquote class="blockquote"><p>Honest Bob and the Factory-to-Dealer-Incentives, <em class="citetitle">I'm Still
1140
- Around</em>, opening for Moxy Fr�vous, 1997.</p></blockquote></div><p>
1141
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id314058"></a>5.2.�Comment encoding</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id322574"></a>5.2.1.�Structure</h4></div></div></div><p>
1142
- The comment header is logically a list of eight-bit-clean vectors; the
1143
- number of vectors is bounded to 2^32-1 and the length of each vector
1144
- is limited to 2^32-1 bytes. The vector length is encoded; the vector
1145
- contents themselves are not null terminated. In addition to the vector
1146
- list, there is a single vector for vendor name (also 8 bit clean,
1147
- length encoded in 32 bits). For example, the 1.0 release of libvorbis
1148
- set the vendor string to "Xiph.Org libVorbis I 20020717".</p><p>The comment header is decoded as follows:
1149
-
1150
- </p><pre class="programlisting">
1151
- 1) [vendor_length] = read an unsigned integer of 32 bits
1152
- 2) [vendor_string] = read a UTF-8 vector as [vendor_length] octets
1153
- 3) [user_comment_list_length] = read an unsigned integer of 32 bits
1154
- 4) iterate [user_comment_list_length] times {
1155
- 5) [length] = read an unsigned integer of 32 bits
1156
- 6) this iteration's user comment = read a UTF-8 vector as [length] octets
1157
- }
1158
- 7) [framing_bit] = read a single bit as boolean
1159
- 8) if ( [framing_bit] unset or end-of-packet ) then ERROR
1160
- 9) done.
1161
- </pre><p>
1162
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id326883"></a>5.2.2.�Content vector format</h4></div></div></div><p>
1163
- The comment vectors are structured similarly to a UNIX environment variable.
1164
- That is, comment fields consist of a field name and a corresponding value and
1165
- look like:</p><div class="blockquote"><blockquote class="blockquote"><pre class="programlisting">
1166
- comment[0]="ARTIST=me";
1167
- comment[1]="TITLE=the sound of Vorbis";
1168
- </pre></blockquote></div><p>
1169
- The field name is case-insensitive and may consist of ASCII 0x20
1170
- through 0x7D, 0x3D ('=') excluded. ASCII 0x41 through 0x5A inclusive
1171
- (characters A-Z) is to be considered equivalent to ASCII 0x61 through
1172
- 0x7A inclusive (characters a-z).
1173
- </p><p>
1174
- The field name is immediately followed by ASCII 0x3D ('=');
1175
- this equals sign is used to terminate the field name.
1176
- </p><p>
1177
- 0x3D is followed by 8 bit clean UTF-8 encoded value of the
1178
- field contents to the end of the field.
1179
- </p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id322620"></a>5.2.2.1.�Field names</h5></div></div></div><p>Below is a proposed, minimal list of standard field names with a
1180
- description of intended use. No single or group of field names is
1181
- mandatory; a comment header may contain one, all or none of the names
1182
- in this list.</p><div class="variablelist"><dl><dt><span class="term">TITLE</span></dt><dd>Track/Work name</dd><dt><span class="term">VERSION</span></dt><dd>The version field may be used to
1183
- differentiate multiple
1184
- versions of the same track title in a single collection. (e.g. remix
1185
- info)
1186
- </dd><dt><span class="term">ALBUM</span></dt><dd>The collection name to which this track belongs
1187
- </dd><dt><span class="term">TRACKNUMBER</span></dt><dd>The track number of this piece if part of a specific larger collection or album
1188
- </dd><dt><span class="term">ARTIST</span></dt><dd>The artist generally considered responsible for the work. In popular music this is usually the performing band or singer. For classical music it would be the composer. For an audio book it would be the author of the original text.
1189
- </dd><dt><span class="term">PERFORMER</span></dt><dd>The artist(s) who performed the work. In classical music this would be the conductor, orchestra, soloists. In an audio book it would be the actor who did the reading. In popular music this is typically the same as the ARTIST and is omitted.
1190
- </dd><dt><span class="term">COPYRIGHT</span></dt><dd>Copyright attribution, e.g., '2001 Nobody's Band' or '1999 Jack Moffitt'
1191
- </dd><dt><span class="term">LICENSE</span></dt><dd>License information, eg, 'All Rights Reserved', 'Any
1192
- Use Permitted', a URL to a license such as a Creative Commons license
1193
- ("www.creativecommons.org/blahblah/license.html") or the EFF Open
1194
- Audio License ('distributed under the terms of the Open Audio
1195
- License. see http://www.eff.org/IP/Open_licenses/eff_oal.html for
1196
- details'), etc.
1197
- </dd><dt><span class="term">ORGANIZATION</span></dt><dd>Name of the organization producing the track (i.e.
1198
- the 'record label')
1199
- </dd><dt><span class="term">DESCRIPTION</span></dt><dd>A short text description of the contents
1200
- </dd><dt><span class="term">GENRE</span></dt><dd>A short text indication of music genre
1201
- </dd><dt><span class="term">DATE</span></dt><dd>Date the track was recorded
1202
- </dd><dt><span class="term">LOCATION</span></dt><dd>Location where track was recorded
1203
- </dd><dt><span class="term">CONTACT</span></dt><dd>Contact information for the creators or distributors of the track. This could be a URL, an email address, the physical address of the producing label.
1204
- </dd><dt><span class="term">ISRC</span></dt><dd>International Standard Recording Code for the
1205
- track; see <a href="http://www.ifpi.org/isrc/" target="_top">the ISRC
1206
- intro page</a> for more information on ISRC numbers.
1207
- </dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id306349"></a>5.2.2.2.�Implications</h5></div></div></div><p>Field names should not be 'internationalized'; this is a
1208
- concession to simplicity not an attempt to exclude the majority of
1209
- the world that doesn't speak English. Field <span class="emphasis"><em>contents</em></span>,
1210
- however, use the UTF-8 character encoding to allow easy representation
1211
- of any language.</p><p>We have the length of the entirety of the field and restrictions on
1212
- the field name so that the field name is bounded in a known way. Thus
1213
- we also have the length of the field contents.</p><p>Individual 'vendors' may use non-standard field names within
1214
- reason. The proper use of comment fields should be clear through
1215
- context at this point. Abuse will be discouraged.</p><p>There is no vendor-specific prefix to 'nonstandard' field names.
1216
- Vendors should make some effort to avoid arbitrarily polluting the
1217
- common namespace. We will generally collect the more useful tags
1218
- here to help with standardization.</p><p>Field names are not required to be unique (occur once) within a
1219
- comment header. As an example, assume a track was recorded by three
1220
- well know artists; the following is permissible, and encouraged:
1221
-
1222
- </p><div class="blockquote"><blockquote class="blockquote"><pre class="programlisting">
1223
- ARTIST=Dizzy Gillespie
1224
- ARTIST=Sonny Rollins
1225
- ARTIST=Sonny Stitt
1226
- </pre></blockquote></div><p>
1227
-
1228
- </p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id306394"></a>5.2.3.�Encoding</h4></div></div></div><p>
1229
- The comment header comprises the entirety of the second bitstream
1230
- header packet. Unlike the first bitstream header packet, it is not
1231
- generally the only packet on the second page and may not be restricted
1232
- to within the second bitstream page. The length of the comment header
1233
- packet is (practically) unbounded. The comment header packet is not
1234
- optional; it must be present in the bitstream even if it is
1235
- effectively empty.</p><p>
1236
- The comment header is encoded as follows (as per Ogg's standard
1237
- bitstream mapping which renders least-significant-bit of the word to be
1238
- coded into the least significant available bit of the current
1239
- bitstream octet first):
1240
-
1241
- </p><div class="orderedlist"><ol type="1"><li>
1242
- Vendor string length (32 bit unsigned quantity specifying number of octets)
1243
- </li><li>
1244
- Vendor string ([vendor string length] octets coded from beginning of string to end of string, not null terminated)
1245
- </li><li>
1246
- Number of comment fields (32 bit unsigned quantity specifying number of fields)
1247
- </li><li>
1248
- Comment field 0 length (if [Number of comment fields]&gt;0; 32 bit unsigned quantity specifying number of octets)
1249
- </li><li>
1250
- Comment field 0 ([Comment field 0 length] octets coded from beginning of string to end of string, not null terminated)
1251
- </li><li>
1252
- Comment field 1 length (if [Number of comment fields]&gt;1...)...
1253
- </li></ol></div><p>
1254
- </p><p>
1255
- This is actually somewhat easier to describe in code; implementation of the above can be found in <code class="filename">vorbis/lib/info.c</code>, <code class="function">_vorbis_pack_comment()</code> and <code class="function">_vorbis_unpack_comment()</code>.
1256
- </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-floor0"></a>6.�Floor type 0 setup and decode</h2></div><div><p class="releaseinfo">
1257
- $Id: 06-floor0.xml 10424 2005-11-23 08:44:18Z xiphmont $
1258
- </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id336814"></a>6.1.�Overview</h3></div></div></div><p>
1259
- Vorbis floor type zero uses Line Spectral Pair (LSP, also alternately
1260
- known as Line Spectral Frequency or LSF) representation to encode a
1261
- smooth spectral envelope curve as the frequency response of the LSP
1262
- filter. This representation is equivalent to a traditional all-pole
1263
- infinite impulse response filter as would be used in linear predictive
1264
- coding; LSP representation may be converted to LPC representation and
1265
- vice-versa.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id321046"></a>6.2.�Floor 0 format</h3></div></div></div><p>
1266
- Floor zero configuration consists of six integer fields and a list of
1267
- VQ codebooks for use in coding/decoding the LSP filter coefficient
1268
- values used by each frame. </p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id313179"></a>6.2.1.�header decode</h4></div></div></div><p>
1269
- Configuration information for instances of floor zero decodes from the
1270
- codec setup header (third packet). configuration decode proceeds as
1271
- follows:</p><pre class="screen">
1272
- 1) [floor0_order] = read an unsigned integer of 8 bits
1273
- 2) [floor0_rate] = read an unsigned integer of 16 bits
1274
- 3) [floor0_bark_map_size] = read an unsigned integer of 16 bits
1275
- 4) [floor0_amplitude_bits] = read an unsigned integer of six bits
1276
- 5) [floor0_amplitude_offset] = read an unsigned integer of eight bits
1277
- 6) [floor0_number_of_books] = read an unsigned integer of four bits and add 1
1278
- 7) if any of [floor0_order], [floor0_rate], [floor0_bark_map_size], [floor0_amplitude_bits],
1279
- [floor0_amplitude_offset] or [floor0_number_of_books] are less than zero, the stream is not decodable
1280
- 8) array [floor0_book_list] = read a list of [floor0_number_of_books] unsigned integers of eight bits each;
1281
- </pre><p>
1282
- An end-of-packet condition during any of these bitstream reads renders
1283
- this stream undecodable. In addition, any element of the array
1284
- <code class="varname">[floor0_book_list]</code> that is greater than the maximum codebook
1285
- number for this bitstream is an error condition that also renders the
1286
- stream undecodable.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-floor0-decode"></a>6.2.2.�packet decode</h4></div></div></div><p>
1287
- Extracting a floor0 curve from an audio packet consists of first
1288
- decoding the curve amplitude and <code class="varname">[floor0_order]</code> LSP
1289
- coefficient values from the bitstream, and then computing the floor
1290
- curve, which is defined as the frequency response of the decoded LSP
1291
- filter.</p><p>
1292
- Packet decode proceeds as follows:</p><pre class="screen">
1293
- 1) [amplitude] = read an unsigned integer of [floor0_amplitude_bits] bits
1294
- 2) if ( [amplitude] is greater than zero ) {
1295
- 3) [coefficients] is an empty, zero length vector
1296
- 4) [booknumber] = read an unsigned integer of <a href="#vorbis-spec-ilog" title="9.2.1.�ilog">ilog</a>( [floor0_number_of_books] ) bits
1297
- 5) if ( [booknumber] is greater than the highest number decode codebook ) then packet is undecodable
1298
- 6) [last] = zero;
1299
- 7) vector [temp_vector] = read vector from bitstream using codebook number [floor0_book_list] element [booknumber] in VQ context.
1300
- 8) add the scalar value [last] to each scalar in vector [temp_vector]
1301
- 9) [last] = the value of the last scalar in vector [temp_vector]
1302
- 10) concatenate [temp_vector] onto the end of the [coefficients] vector
1303
- 11) if (length of vector [coefficients] is less than [floor0_order], continue at step 6
1304
-
1305
- }
1306
-
1307
- 12) done.
1308
-
1309
- </pre><p>
1310
- Take note of the following properties of decode:
1311
- </p><div class="itemizedlist"><ul type="disc"><li>An <code class="varname">[amplitude]</code> value of zero must result in a return code that indicates this channel is unused in this frame (the output of the channel will be all-zeroes in synthesis). Several later stages of decode don't occur for an unused channel.</li><li>An end-of-packet condition during decode should be considered a
1312
- nominal occruence; if end-of-packet is reached during any read
1313
- operation above, floor decode is to return 'unused' status as if the
1314
- <code class="varname">[amplitude]</code> value had read zero at the beginning of decode.</li><li>The book number used for decode
1315
- can, in fact, be stored in the bitstream in <a href="#vorbis-spec-ilog" title="9.2.1.�ilog">ilog</a>( <code class="varname">[floor0_number_of_books]</code> -
1316
- 1 ) bits. Nevertheless, the above specification is correct and values
1317
- greater than the maximum possible book value are reserved.</li><li>The number of scalars read into the vector <code class="varname">[coefficients]</code>
1318
- may be greater than <code class="varname">[floor0_order]</code>, the number actually
1319
- required for curve computation. For example, if the VQ codebook used
1320
- for the floor currently being decoded has a
1321
- <code class="varname">[codebook_dimensions]</code> value of three and
1322
- <code class="varname">[floor0_order]</code> is ten, the only way to fill all the needed
1323
- scalars in <code class="varname">[coefficients]</code> is to to read a total of twelve
1324
- scalars as four vectors of three scalars each. This is not an error
1325
- condition, and care must be taken not to allow a buffer overflow in
1326
- decode. The extra values are not used and may be ignored or discarded.</li></ul></div><p>
1327
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-floor0-synth"></a>6.2.3.�curve computation</h4></div></div></div><p>
1328
- Given an <code class="varname">[amplitude]</code> integer and <code class="varname">[coefficients]</code>
1329
- vector from packet decode as well as the [floor0_order],
1330
- [floor0_rate], [floor0_bark_map_size], [floor0_amplitude_bits] and
1331
- [floor0_amplitude_offset] values from floor setup, and an output
1332
- vector size <code class="varname">[n]</code> specified by the decode process, we compute a
1333
- floor output vector.</p><p>
1334
- If the value <code class="varname">[amplitude]</code> is zero, the return value is a
1335
- length <code class="varname">[n]</code> vector with all-zero scalars. Otherwise, begin by
1336
- assuming the following definitions for the given vector to be
1337
- synthesized:</p><div class="informalequation"><div class="mediaobject"><img src="lspmap.png" alt="[lsp map equation]"></div></div><p>
1338
- The above is used to synthesize the LSP curve on a Bark-scale frequency
1339
- axis, then map the result to a linear-scale frequency axis.
1340
- Similarly, the below calculation synthesizes the output LSP curve <code class="varname">[output]</code> on a log
1341
- (dB) amplitude scale, mapping it to linear amplitude in the last step:</p><div class="orderedlist"><ol type="1"><li> <code class="varname">[i]</code> = 0 </li><li><p>if ( <code class="varname">[floor0_order]</code> is odd ) {
1342
- </p><div class="orderedlist"><ol type="a"><li><p>calculate <code class="varname">[p]</code> and <code class="varname">[q]</code> according to:
1343
- </p><div class="informalequation"><div class="mediaobject"><img src="oddlsp.png" alt="[equation for odd lsp]"></div></div><p>
1344
- </p></li></ol></div><p>
1345
- } else <code class="varname">[floor0_order]</code> is even {
1346
- </p><div class="orderedlist"><ol type="a"><li><p>calculate <code class="varname">[p]</code> and <code class="varname">[q]</code> according to:
1347
- </p><div class="informalequation"><div class="mediaobject"><img src="evenlsp.png" alt="[equation for even lsp]"></div></div><p>
1348
- </p></li></ol></div><p>
1349
- }
1350
- </p></li><li><p>calculate <code class="varname">[linear_floor_value]</code> according to:
1351
- </p><div class="informalequation"><div class="mediaobject"><img src="floorval.png" alt="[expression for floorval]"></div></div><p>
1352
- </p></li><li><code class="varname">[iteration_condition]</code> = map element <code class="varname">[i]</code></li><li><code class="varname">[output]</code> element <code class="varname">[i]</code> = <code class="varname">[linear_floor_value]</code></li><li>increment <code class="varname">[i]</code></li><li>if ( map element <code class="varname">[i]</code> is equal to <code class="varname">[iteration_condition]</code> ) continue at step 5</li><li>if ( <code class="varname">[i]</code> is less than <code class="varname">[n]</code> ) continue at step 2</li><li>done</li></ol></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-floor1"></a>7.�Floor type 1 setup and decode</h2></div><div><p class="releaseinfo">
1353
- $Id: 07-floor1.xml 10466 2005-11-28 00:34:44Z giles $
1354
- </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id336243"></a>7.1.�Overview</h3></div></div></div><p>
1355
- Vorbis floor type one uses a piecewise straight-line representation to
1356
- encode a spectral envelope curve. The representation plots this curve
1357
- mechanically on a linear frequency axis and a logarithmic (dB)
1358
- amplitude axis. The integer plotting algorithm used is similar to
1359
- Bresenham's algorithm.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id334800"></a>7.2.�Floor 1 format</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id316161"></a>7.2.1.�model</h4></div></div></div><p>
1360
- Floor type one represents a spectral curve as a series of
1361
- line segments. Synthesis constructs a floor curve using iterative
1362
- prediction in a process roughly equivalent to the following simplified
1363
- description:</p><p>
1364
- </p><div class="itemizedlist"><ul type="disc"><li> the first line segment (base case) is a logical line spanning
1365
- from x_0,y_0 to x_1,y_1 where in the base case x_0=0 and x_1=[n], the
1366
- full range of the spectral floor to be computed.</li><li>the induction step chooses a point x_new within an existing
1367
- logical line segment and produces a y_new value at that point computed
1368
- from the existing line's y value at x_new (as plotted by the line) and
1369
- a difference value decoded from the bitstream packet.</li><li>floor computation produces two new line segments, one running from
1370
- x_0,y_0 to x_new,y_new and from x_new,y_new to x_1,y_1. This step is
1371
- performed logically even if y_new represents no change to the
1372
- amplitude value at x_new so that later refinement is additionally
1373
- bounded at x_new.</li><li>the induction step repeats, using a list of x values specified in
1374
- the codec setup header at floor 1 initialization time. Computation
1375
- is completed at the end of the x value list.</li></ul></div><p>
1376
- </p><p>
1377
- Consider the following example, with values chosen for ease of
1378
- understanding rather than representing typical configuration:</p><p>
1379
- For the below example, we assume a floor setup with an [n] of 128.
1380
- The list of selected X values in increasing order is
1381
- 0,16,32,48,64,80,96,112 and 128. In list order, the values interleave
1382
- as 0, 128, 64, 32, 96, 16, 48, 80 and 112. The corresponding
1383
- list-order Y values as decoded from an example packet are 110, 20, -5,
1384
- -45, 0, -25, -10, 30 and -10. We compute the floor in the following
1385
- way, beginning with the first line:</p><div class="mediaobject"><img src="floor1-1.png" alt="[graph of example floor]"></div><p>
1386
- We now draw new logical lines to reflect the correction to new_Y, and
1387
- iterate for X positions 32 and 96:</p><div class="mediaobject"><img src="floor1-2.png" alt="[graph of example floor]"></div><p>
1388
- Although the new Y value at X position 96 is unchanged, it is still
1389
- used later as an endpoint for further refinement. From here on, the
1390
- pattern should be clear; we complete the floor computation as follows:</p><div class="mediaobject"><img src="floor1-3.png" alt="[graph of example floor]"></div><div class="mediaobject"><img src="floor1-4.png" alt="[graph of example floor]"></div><p>
1391
- A more efficient algorithm with carefully defined integer rounding
1392
- behavior is used for actual decode, as described later. The actual
1393
- algorithm splits Y value computation and line plotting into two steps
1394
- with modifications to the above algorithm to eliminate noise
1395
- accumulation through integer roundoff/truncation. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id317351"></a>7.2.2.�header decode</h4></div></div></div><p>
1396
- A list of floor X values is stored in the packet header in interleaved
1397
- format (used in list order during packet decode and synthesis). This
1398
- list is split into partitions, and each partition is assigned to a
1399
- partition class. X positions 0 and [n] are implicit and do not belong
1400
- to an explicit partition or partition class.</p><p>
1401
- A partition class consists of a representation vector width (the
1402
- number of Y values which the partition class encodes at once), a
1403
- 'subclass' value representing the number of alternate entropy books
1404
- the partition class may use in representing Y values, the list of
1405
- [subclass] books and a master book used to encode which alternate
1406
- books were chosen for representation in a given packet. The
1407
- master/subclass mechanism is meant to be used as a flexible
1408
- representation cascade while still using codebooks only in a scalar
1409
- context.</p><pre class="screen">
1410
-
1411
- 1) [floor1_partitions] = read 5 bits as unsigned integer
1412
- 2) [maximum_class] = -1
1413
- 3) iterate [i] over the range 0 ... [floor1_partitions]-1 {
1414
-
1415
- 4) vector [floor1_partition_class_list] element [i] = read 4 bits as unsigned integer
1416
-
1417
- }
1418
-
1419
- 5) [maximum_class] = largest integer scalar value in vector [floor1_partition_class_list]
1420
- 6) iterate [i] over the range 0 ... [maximum_class] {
1421
-
1422
- 7) vector [floor1_class_dimensions] element [i] = read 3 bits as unsigned integer and add 1
1423
- 8) vector [floor1_class_subclasses] element [i] = read 2 bits as unsigned integer
1424
- 9) if ( vector [floor1_class_subclasses] element [i] is nonzero ) {
1425
-
1426
- 10) vector [floor1_class_masterbooks] element [i] = read 8 bits as unsigned integer
1427
-
1428
- }
1429
-
1430
- 11) iterate [j] over the range 0 ... (2 exponent [floor1_class_subclasses] element [i]) - 1 {
1431
-
1432
- 12) array [floor1_subclass_books] element [i],[j] =
1433
- read 8 bits as unsigned integer and subtract one
1434
- }
1435
- }
1436
-
1437
- 13) [floor1_multiplier] = read 2 bits as unsigned integer and add one
1438
- 14) [rangebits] = read 4 bits as unsigned integer
1439
- 15) vector [floor1_X_list] element [0] = 0
1440
- 16) vector [floor1_X_list] element [1] = 2 exponent [rangebits];
1441
- 17) [floor1_values] = 2
1442
- 18) iterate [i] over the range 0 ... [floor1_partitions]-1 {
1443
-
1444
- 19) [current_class_number] = vector [floor1_partition_class_list] element [i]
1445
- 20) iterate [j] over the range 0 ... ([floor1_class_dimensions] element [current_class_number])-1 {
1446
- 21) vector [floor1_X_list] element ([floor1_values]) =
1447
- read [rangebits] bits as unsigned integer
1448
- 22) increment [floor1_values] by one
1449
- }
1450
- }
1451
-
1452
- 23) done
1453
- </pre><p>
1454
- An end-of-packet condition while reading any aspect of a floor 1
1455
- configuration during setup renders a stream undecodable. In
1456
- addition, a <code class="varname">[floor1_class_masterbooks]</code> or
1457
- <code class="varname">[floor1_subclass_books]</code> scalar element greater than the
1458
- highest numbered codebook configured in this stream is an error
1459
- condition that renders the stream undecodable.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-floor1-decode"></a>7.2.2.1.�packet decode</h5></div></div></div><p>
1460
- Packet decode begins by checking the <code class="varname">[nonzero]</code> flag:</p><pre class="screen">
1461
- 1) [nonzero] = read 1 bit as boolean
1462
- </pre><p>
1463
- If <code class="varname">[nonzero]</code> is unset, that indicates this channel contained
1464
- no audio energy in this frame. Decode immediately returns a status
1465
- indicating this floor curve (and thus this channel) is unused this
1466
- frame. (A return status of 'unused' is different from decoding a
1467
- floor that has all points set to minimum representation amplitude,
1468
- which happens to be approximately -140dB).
1469
- </p><p>
1470
- Assuming <code class="varname">[nonzero]</code> is set, decode proceeds as follows:</p><pre class="screen">
1471
- 1) [range] = vector { 256, 128, 86, 64 } element ([floor1_multiplier]-1)
1472
- 2) vector [floor1_Y] element [0] = read <a href="#vorbis-spec-ilog" title="9.2.1.�ilog">ilog</a>([range]-1) bits as unsigned integer
1473
- 3) vector [floor1_Y] element [1] = read <a href="#vorbis-spec-ilog" title="9.2.1.�ilog">ilog</a>([range]-1) bits as unsigned integer
1474
- 4) [offset] = 2;
1475
- 5) iterate [i] over the range 0 ... [floor1_partitions]-1 {
1476
-
1477
- 6) [class] = vector [floor1_partition_class] element [i]
1478
- 7) [cdim] = vector [floor1_class_dimensions] element [class]
1479
- 8) [cbits] = vector [floor1_class_subclasses] element [class]
1480
- 9) [csub] = (2 exponent [cbits])-1
1481
- 10) [cval] = 0
1482
- 11) if ( [cbits] is greater than zero ) {
1483
-
1484
- 12) [cval] = read from packet using codebook number
1485
- (vector [floor1_class_masterbooks] element [class]) in scalar context
1486
- }
1487
-
1488
- 13) iterate [j] over the range 0 ... [cdim]-1 {
1489
-
1490
- 14) [book] = array [floor1_subclass_books] element [class],([cval] bitwise AND [csub])
1491
- 15) [cval] = [cval] right shifted [cbits] bits
1492
- 16) if ( [book] is not less than zero ) {
1493
-
1494
- 17) vector [floor1_Y] element ([j]+[offset]) = read from packet using codebook
1495
- [book] in scalar context
1496
-
1497
- } else [book] is less than zero {
1498
-
1499
- 18) vector [floor1_Y] element ([j]+[offset]) = 0
1500
-
1501
- }
1502
- }
1503
-
1504
- 19) [offset] = [offset] + [cdim]
1505
-
1506
- }
1507
-
1508
- 20) done
1509
- </pre><p>
1510
- An end-of-packet condition during curve decode should be considered a
1511
- nominal occurrence; if end-of-packet is reached during any read
1512
- operation above, floor decode is to return 'unused' status as if the
1513
- <code class="varname">[nonzero]</code> flag had been unset at the beginning of decode.
1514
- </p><p>
1515
- Vector <code class="varname">[floor1_Y]</code> contains the values from packet decode
1516
- needed for floor 1 synthesis.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-floor1-synth"></a>7.2.2.2.�curve computation</h5></div></div></div><p>
1517
- Curve computation is split into two logical steps; the first step
1518
- derives final Y amplitude values from the encoded, wrapped difference
1519
- values taken from the bitstream. The second step plots the curve
1520
- lines. Also, although zero-difference values are used in the
1521
- iterative prediction to find final Y values, these points are
1522
- conditionally skipped during final line computation in step two.
1523
- Skipping zero-difference values allows a smoother line fit. </p><p>
1524
- Although some aspects of the below algorithm look like inconsequential
1525
- optimizations, implementors are warned to follow the details closely.
1526
- Deviation from implementing a strictly equivalent algorithm can result
1527
- in serious decoding errors.</p><div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title"><a name="id326536"></a>7.2.2.2.1.�step 1: amplitude value synthesis</h6></div></div></div><p>
1528
- Unwrap the always-positive-or-zero values read from the packet into
1529
- +/- difference values, then apply to line prediction.</p><pre class="screen">
1530
- 1) [range] = vector { 256, 128, 86, 64 } element ([floor1_multiplier]-1)
1531
- 2) vector [floor1_step2_flag] element [0] = set
1532
- 3) vector [floor1_step2_flag] element [1] = set
1533
- 4) vector [floor1_final_Y] element [0] = vector [floor1_Y] element [0]
1534
- 5) vector [floor1_final_Y] element [1] = vector [floor1_Y] element [1]
1535
- 6) iterate [i] over the range 2 ... [floor1_values]-1 {
1536
-
1537
- 7) [low_neighbor_offset] = <a href="#vorbis-spec-low_neighbor" title="9.2.4.�low_neighbor">low_neighbor</a>([floor1_X_list],[i])
1538
- 8) [high_neighbor_offset] = <a href="#vorbis-spec-high_neighbor" title="9.2.4.1.�high_neighbor">high_neighbor</a>([floor1_X_list],[i])
1539
-
1540
- 9) [predicted] = <a href="#vorbis-spec-render_point" title="9.2.4.2.�render_point">render_point</a>( vector [floor1_X_list] element [low_neighbor_offset],
1541
- vector [floor1_final_Y] element [low_neighbor_offset],
1542
- vector [floor1_X_list] element [high_neighbor_offset],
1543
- vector [floor1_final_Y] element [high_neighbor_offset],
1544
- vector [floor1_X_list] element [i] )
1545
-
1546
- 10) [val] = vector [floor1_Y] element [i]
1547
- 11) [highroom] = [range] - [predicted]
1548
- 12) [lowroom] = [predicted]
1549
- 13) if ( [highroom] is less than [lowroom] ) {
1550
-
1551
- 14) [room] = [highroom] * 2
1552
-
1553
- } else [highroom] is not less than [lowroom] {
1554
-
1555
- 15) [room] = [lowroom] * 2
1556
-
1557
- }
1558
-
1559
- 16) if ( [val] is nonzero ) {
1560
-
1561
- 17) vector [floor1_step2_flag] element [low_neighbor_offset] = set
1562
- 18) vector [floor1_step2_flag] element [high_neighbor_offset] = set
1563
- 19) vector [floor1_step2_flag] element [i] = set
1564
- 20) if ( [val] is greater than or equal to [room] ) {
1565
-
1566
- 21) if ( [highroom] is greater than [lowroom] ) {
1567
-
1568
- 22) vector [floor1_final_Y] element [i] = [val] - [lowroom] + [predicted]
1569
-
1570
- } else [highroom] is not greater than [lowroom] {
1571
-
1572
- 23) vector [floor1_final_Y] element [i] = [predicted] - [val] + [highroom] - 1
1573
-
1574
- }
1575
-
1576
- } else [val] is less than [room] {
1577
-
1578
- 24) if ([val] is odd) {
1579
-
1580
- 25) vector [floor1_final_Y] element [i] =
1581
- [predicted] - (([val] + 1) divided by 2 using integer division)
1582
-
1583
- } else [val] is even {
1584
-
1585
- 26) vector [floor1_final_Y] element [i] =
1586
- [predicted] + ([val] / 2 using integer division)
1587
-
1588
- }
1589
-
1590
- }
1591
-
1592
- } else [val] is zero {
1593
-
1594
- 27) vector [floor1_step2_flag] element [i] = unset
1595
- 28) vector [floor1_final_Y] element [i] = [predicted]
1596
-
1597
- }
1598
-
1599
- }
1600
-
1601
- 29) done
1602
-
1603
- </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title"><a name="id326571"></a>7.2.2.2.2.�step 2: curve synthesis</h6></div></div></div><p>
1604
- Curve synthesis generates a return vector <code class="varname">[floor]</code> of length
1605
- <code class="varname">[n]</code> (where <code class="varname">[n]</code> is provided by the decode process
1606
- calling to floor decode). Floor 1 curve synthesis makes use of the
1607
- <code class="varname">[floor1_X_list]</code>, <code class="varname">[floor1_final_Y]</code> and
1608
- <code class="varname">[floor1_step2_flag]</code> vectors, as well as [floor1_multiplier]
1609
- and [floor1_values] values.</p><p>
1610
- Decode begins by sorting the scalars from vectors
1611
- <code class="varname">[floor1_X_list]</code>, <code class="varname">[floor1_final_Y]</code> and
1612
- <code class="varname">[floor1_step2_flag]</code> together into new vectors
1613
- <code class="varname">[floor1_X_list]'</code>, <code class="varname">[floor1_final_Y]'</code> and
1614
- <code class="varname">[floor1_step2_flag]'</code> according to ascending sort order of the
1615
- values in <code class="varname">[floor1_X_list]</code>. That is, sort the values of
1616
- <code class="varname">[floor1_X_list]</code> and then apply the same permutation to
1617
- elements of the other two vectors so that the X, Y and step2_flag
1618
- values still match.</p><p>
1619
- Then compute the final curve in one pass:</p><pre class="screen">
1620
- 1) [hx] = 0
1621
- 2) [lx] = 0
1622
- 3) [ly] = vector [floor1_final_Y]' element [0] * [floor1_multiplier]
1623
- 4) iterate [i] over the range 1 ... [floor1_values]-1 {
1624
-
1625
- 5) if ( [floor1_step2_flag]' element [i] is set ) {
1626
-
1627
- 6) [hy] = [floor1_final_Y]' element [i] * [floor1_multiplier]
1628
- 7) [hx] = [floor1_X_list]' element [i]
1629
- 8) <a href="#vorbis-spec-render_line" title="9.2.4.3.�render_line">render_line</a>( [lx], [ly], [hx], [hy], [floor] )
1630
- 9) [lx] = [hx]
1631
- 10) [ly] = [hy]
1632
- }
1633
- }
1634
-
1635
- 11) if ( [hx] is less than [n] ) {
1636
-
1637
- 12) <a href="#vorbis-spec-render_line" title="9.2.4.3.�render_line">render_line</a>( [hx], [hy], [n], [hy], [floor] )
1638
-
1639
- }
1640
-
1641
- 13) if ( [hx] is greater than [n] ) {
1642
-
1643
- 14) truncate vector [floor] to [n] elements
1644
-
1645
- }
1646
-
1647
- 15) for each scalar in vector [floor], perform a lookup substitution using
1648
- the scalar value from [floor] as an offset into the vector <a href="#vorbis-spec-floor1_inverse_dB_table" title="10.1.�floor1_inverse_dB_table">[floor1_inverse_dB_static_table]</a>
1649
-
1650
- 16) done
1651
-
1652
- </pre></div></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-residue"></a>8.�Residue setup and decode</h2></div><div><p class="releaseinfo">
1653
- $Id: 08-residue.xml 13159 2007-06-21 05:22:35Z xiphmont $
1654
- </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id320982"></a>8.1.�Overview</h3></div></div></div><p>
1655
- A residue vector represents the fine detail of the audio spectrum of
1656
- one channel in an audio frame after the encoder subtracts the floor
1657
- curve and performs any channel coupling. A residue vector may
1658
- represent spectral lines, spectral magnitude, spectral phase or
1659
- hybrids as mixed by channel coupling. The exact semantic content of
1660
- the vector does not matter to the residue abstraction.</p><p>
1661
- Whatever the exact qualities, the Vorbis residue abstraction codes the
1662
- residue vectors into the bitstream packet, and then reconstructs the
1663
- vectors during decode. Vorbis makes use of three different encoding
1664
- variants (numbered 0, 1 and 2) of the same basic vector encoding
1665
- abstraction.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id307154"></a>8.2.�Residue format</h3></div></div></div><p>
1666
- Residue format partitions each vector in the vector bundle into chunks,
1667
- classifies each chunk, encodes the chunk classifications and finally
1668
- encodes the chunks themselves using the the specific VQ arrangement
1669
- defined for each selected classification.
1670
- The exact interleaving and partitioning vary by residue encoding number,
1671
- however the high-level process used to classify and encode the residue
1672
- vector is the same in all three variants.</p><p>
1673
- A set of coded residue vectors are all of the same length. High level
1674
- coding structure, ignoring for the moment exactly how a partition is
1675
- encoded and simply trusting that it is, is as follows:</p><p>
1676
- </p><div class="itemizedlist"><ul type="disc"><li><p>Each vector is partitioned into multiple equal sized chunks
1677
- according to configuration specified. If we have a vector size of
1678
- <span class="emphasis"><em>n</em></span>, a partition size <span class="emphasis"><em>residue_partition_size</em></span>, and a total
1679
- of <span class="emphasis"><em>ch</em></span> residue vectors, the total number of partitioned chunks
1680
- coded is <span class="emphasis"><em>n</em></span>/<span class="emphasis"><em>residue_partition_size</em></span>*<span class="emphasis"><em>ch</em></span>. It is
1681
- important to note that the integer division truncates. In the below
1682
- example, we assume an example <span class="emphasis"><em>residue_partition_size</em></span> of 8.</p></li><li><p>Each partition in each vector has a classification number that
1683
- specifies which of multiple configured VQ codebook setups are used to
1684
- decode that partition. The classification numbers of each partition
1685
- can be thought of as forming a vector in their own right, as in the
1686
- illustration below. Just as the residue vectors are coded in grouped
1687
- partitions to increase encoding efficiency, the classification vector
1688
- is also partitioned into chunks. The integer elements of each scalar
1689
- in a classification chunk are built into a single scalar that
1690
- represents the classification numbers in that chunk. In the below
1691
- example, the classification codeword encodes two classification
1692
- numbers.</p></li><li><p>The values in a residue vector may be encoded monolithically in a
1693
- single pass through the residue vector, but more often efficient
1694
- codebook design dictates that each vector is encoded as the additive
1695
- sum of several passes through the residue vector using more than one
1696
- VQ codebook. Thus, each residue value potentially accumulates values
1697
- from multiple decode passes. The classification value associated with
1698
- a partition is the same in each pass, thus the classification codeword
1699
- is coded only in the first pass.</p></li></ul></div><p>
1700
- </p><div class="mediaobject"><img src="residue-pack.png" alt="[illustration of residue vector format]"></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id326310"></a>8.3.�residue 0</h3></div></div></div><p>
1701
- Residue 0 and 1 differ only in the way the values within a residue
1702
- partition are interleaved during partition encoding (visually treated
1703
- as a black box--or cyan box or brown box--in the above figure).</p><p>
1704
- Residue encoding 0 interleaves VQ encoding according to the
1705
- dimension of the codebook used to encode a partition in a specific
1706
- pass. The dimension of the codebook need not be the same in multiple
1707
- passes, however the partition size must be an even multiple of the
1708
- codebook dimension.</p><p>
1709
- As an example, assume a partition vector of size eight, to be encoded
1710
- by residue 0 using codebook sizes of 8, 4, 2 and 1:</p><pre class="programlisting">
1711
-
1712
- original residue vector: [ 0 1 2 3 4 5 6 7 ]
1713
-
1714
- codebook dimensions = 8 encoded as: [ 0 1 2 3 4 5 6 7 ]
1715
-
1716
- codebook dimensions = 4 encoded as: [ 0 2 4 6 ], [ 1 3 5 7 ]
1717
-
1718
- codebook dimensions = 2 encoded as: [ 0 4 ], [ 1 5 ], [ 2 6 ], [ 3 7 ]
1719
-
1720
- codebook dimensions = 1 encoded as: [ 0 ], [ 1 ], [ 2 ], [ 3 ], [ 4 ], [ 5 ], [ 6 ], [ 7 ]
1721
-
1722
- </pre><p>
1723
- It is worth mentioning at this point that no configurable value in the
1724
- residue coding setup is restricted to a power of two.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id326344"></a>8.4.�residue 1</h3></div></div></div><p>
1725
- Residue 1 does not interleave VQ encoding. It represents partition
1726
- vector scalars in order. As with residue 0, however, partition length
1727
- must be an integer multiple of the codebook dimension, although
1728
- dimension may vary from pass to pass.</p><p>
1729
- As an example, assume a partition vector of size eight, to be encoded
1730
- by residue 0 using codebook sizes of 8, 4, 2 and 1:</p><pre class="programlisting">
1731
-
1732
- original residue vector: [ 0 1 2 3 4 5 6 7 ]
1733
-
1734
- codebook dimensions = 8 encoded as: [ 0 1 2 3 4 5 6 7 ]
1735
-
1736
- codebook dimensions = 4 encoded as: [ 0 1 2 3 ], [ 4 5 6 7 ]
1737
-
1738
- codebook dimensions = 2 encoded as: [ 0 1 ], [ 2 3 ], [ 4 5 ], [ 6 7 ]
1739
-
1740
- codebook dimensions = 1 encoded as: [ 0 ], [ 1 ], [ 2 ], [ 3 ], [ 4 ], [ 5 ], [ 6 ], [ 7 ]
1741
-
1742
- </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id334893"></a>8.5.�residue 2</h3></div></div></div><p>
1743
- Residue type two can be thought of as a variant of residue type 1.
1744
- Rather than encoding multiple passed-in vectors as in residue type 1,
1745
- the <span class="emphasis"><em>ch</em></span> passed in vectors of length <span class="emphasis"><em>n</em></span> are first
1746
- interleaved and flattened into a single vector of length
1747
- <span class="emphasis"><em>ch</em></span>*<span class="emphasis"><em>n</em></span>. Encoding then proceeds as in type 1. Decoding is
1748
- as in type 1 with decode interleave reversed. If operating on a single
1749
- vector to begin with, residue type 1 and type 2 are equivalent.</p><div class="mediaobject"><img src="residue2.png" alt="[illustration of residue type 2]"></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id334939"></a>8.6.�Residue decode</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id334945"></a>8.6.1.�header decode</h4></div></div></div><p>
1750
- Header decode for all three residue types is identical.</p><pre class="programlisting">
1751
- 1) [residue_begin] = read 24 bits as unsigned integer
1752
- 2) [residue_end] = read 24 bits as unsigned integer
1753
- 3) [residue_partition_size] = read 24 bits as unsigned integer and add one
1754
- 4) [residue_classifications] = read 6 bits as unsigned integer and add one
1755
- 5) [residue_classbook] = read 8 bits as unsigned integer
1756
- </pre><p>
1757
- <code class="varname">[residue_begin]</code> and <code class="varname">[residue_end]</code> select the specific
1758
- sub-portion of each vector that is actually coded; it implements akin
1759
- to a bandpass where, for coding purposes, the vector effectively
1760
- begins at element <code class="varname">[residue_begin]</code> and ends at
1761
- <code class="varname">[residue_end]</code>. Preceding and following values in the unpacked
1762
- vectors are zeroed. Note that for residue type 2, these values as
1763
- well as <code class="varname">[residue_partition_size]</code>apply to the interleaved
1764
- vector, not the individual vectors before interleave.
1765
- <code class="varname">[residue_partition_size]</code> is as explained above,
1766
- <code class="varname">[residue_classifications]</code> is the number of possible
1767
- classification to which a partition can belong and
1768
- <code class="varname">[residue_classbook]</code> is the codebook number used to code
1769
- classification codewords. The number of dimensions in book
1770
- <code class="varname">[residue_classbook]</code> determines how many classification values
1771
- are grouped into a single classification codeword.</p><p>
1772
- Next we read a bitmap pattern that specifies which partition classes
1773
- code values in which passes.</p><pre class="programlisting">
1774
- 1) iterate [i] over the range 0 ... [residue_classifications]-1 {
1775
-
1776
- 2) [high_bits] = 0
1777
- 3) [low_bits] = read 3 bits as unsigned integer
1778
- 4) [bitflag] = read one bit as boolean
1779
- 5) if ( [bitflag] is set ) then [high_bits] = read five bits as unsigned integer
1780
- 6) vector [residue_cascade] element [i] = [high_bits] * 8 + [low_bits]
1781
- }
1782
- 7) done
1783
- </pre><p>
1784
- Finally, we read in a list of book numbers, each corresponding to
1785
- specific bit set in the cascade bitmap. We loop over the possible
1786
- codebook classifications and the maximum possible number of encoding
1787
- stages (8 in Vorbis I, as constrained by the elements of the cascade
1788
- bitmap being eight bits):</p><pre class="programlisting">
1789
- 1) iterate [i] over the range 0 ... [residue_classifications]-1 {
1790
-
1791
- 2) iterate [j] over the range 0 ... 7 {
1792
-
1793
- 3) if ( vector [residue_cascade] element [i] bit [j] is set ) {
1794
-
1795
- 4) array [residue_books] element [i][j] = read 8 bits as unsigned integer
1796
-
1797
- } else {
1798
-
1799
- 5) array [residue_books] element [i][j] = unused
1800
-
1801
- }
1802
- }
1803
- }
1804
-
1805
- 6) done
1806
- </pre><p>
1807
- An end-of-packet condition at any point in header decode renders the
1808
- stream undecodable. In addition, any codebook number greater than the
1809
- maximum numbered codebook set up in this stream also renders the
1810
- stream undecodable.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id325037"></a>8.6.2.�packet decode</h4></div></div></div><p>
1811
- Format 0 and 1 packet decode is identical except for specific
1812
- partition interleave. Format 2 packet decode can be built out of the
1813
- format 1 decode process. Thus we describe first the decode
1814
- infrastructure identical to all three formats.</p><p>
1815
- In addition to configuration information, the residue decode process
1816
- is passed the number of vectors in the submap bundle and a vector of
1817
- flags indicating if any of the vectors are not to be decoded. If the
1818
- passed in number of vectors is 3 and vector number 1 is marked 'do not
1819
- decode', decode skips vector 1 during the decode loop. However, even
1820
- 'do not decode' vectors are allocated and zeroed.</p><p>
1821
- Depending on the values of <code class="varname">[residue_begin]</code> and
1822
- <code class="varname">[residue_end]</code>, it is obvious that the encoded
1823
- portion of a residue vector may be the entire possible residue vector
1824
- or some other strict subset of the actual residue vector size with
1825
- zero padding at either uncoded end. However, it is also possible to
1826
- set <code class="varname">[residue_begin]</code> and
1827
- <code class="varname">[residue_end]</code> to specify a range partially or
1828
- wholly beyond the maximum vector size. Before beginning residue
1829
- decode, limit <code class="varname">[residue_begin]</code> and
1830
- <code class="varname">[residue_end]</code> to the maximum possible vector size
1831
- as follows. We assume that the number of vectors being encoded,
1832
- <code class="varname">[ch]</code> is provided by the higher level decoding
1833
- process.</p><pre class="programlisting">
1834
- 1) [actual_size] = current blocksize/2;
1835
- 2) if residue encoding is format 2
1836
- 3) [actual_size] = [actual_size] * [ch];
1837
- 4) [limit_residue_begin] = maximum of ([residue_begin],[actual_size]);
1838
- 5) [limit_residue_end] = maximum of ([residue_end],[actual_size]);
1839
- </pre><p>
1840
- The following convenience values are conceptually useful to clarifying
1841
- the decode process:</p><pre class="programlisting">
1842
- 1) [classwords_per_codeword] = [codebook_dimensions] value of codebook [residue_classbook]
1843
- 2) [n_to_read] = [limit_residue_end] - [limit_residue_begin]
1844
- 3) [partitions_to_read] = [n_to_read] / [residue_partition_size]
1845
- </pre><p>
1846
- Packet decode proceeds as follows, matching the description offered earlier in the document. </p><pre class="programlisting">
1847
- 1) allocate and zero all vectors that will be returned.
1848
- 2) if ([n_to_read] is zero), stop; there is no residue to decode.
1849
- 3) iterate [pass] over the range 0 ... 7 {
1850
-
1851
- 4) [partition_count] = 0
1852
-
1853
- 5) while [partition_count] is less than [partitions_to_read]
1854
-
1855
- 6) if ([pass] is zero) {
1856
-
1857
- 7) iterate [j] over the range 0 .. [ch]-1 {
1858
-
1859
- 8) if vector [j] is not marked 'do not decode' {
1860
-
1861
- 9) [temp] = read from packet using codebook [residue_classbook] in scalar context
1862
- 10) iterate [i] descending over the range [classwords_per_codeword]-1 ... 0 {
1863
-
1864
- 11) array [classifications] element [j],([i]+[partition_count]) =
1865
- [temp] integer modulo [residue_classifications]
1866
- 12) [temp] = [temp] / [residue_classifications] using integer division
1867
-
1868
- }
1869
-
1870
- }
1871
-
1872
- }
1873
-
1874
- }
1875
-
1876
- 13) iterate [i] over the range 0 .. ([classwords_per_codeword] - 1) while [partition_count]
1877
- is also less than [partitions_to_read] {
1878
-
1879
- 14) iterate [j] over the range 0 .. [ch]-1 {
1880
-
1881
- 15) if vector [j] is not marked 'do not decode' {
1882
-
1883
- 16) [vqclass] = array [classifications] element [j],[partition_count]
1884
- 17) [vqbook] = array [residue_books] element [vqclass],[pass]
1885
- 18) if ([vqbook] is not 'unused') {
1886
-
1887
- 19) decode partition into output vector number [j], starting at scalar
1888
- offset [limit_residue_begin]+[partition_count]*[residue_partition_size] using
1889
- codebook number [vqbook] in VQ context
1890
- }
1891
- }
1892
-
1893
- 20) increment [partition_count] by one
1894
-
1895
- }
1896
- }
1897
- }
1898
-
1899
- 21) done
1900
-
1901
- </pre><p>
1902
- An end-of-packet condition during packet decode is to be considered a
1903
- nominal occurrence. Decode returns the result of vector decode up to
1904
- that point.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id341700"></a>8.6.3.�format 0 specifics</h4></div></div></div><p>
1905
- Format zero decodes partitions exactly as described earlier in the
1906
- 'Residue Format: residue 0' section. The following pseudocode
1907
- presents the same algorithm. Assume:</p><p>
1908
- </p><div class="itemizedlist"><ul type="disc"><li> <code class="varname">[n]</code> is the value in <code class="varname">[residue_partition_size]</code></li><li><code class="varname">[v]</code> is the residue vector</li><li><code class="varname">[offset]</code> is the beginning read offset in [v]</li></ul></div><p>
1909
- </p><pre class="programlisting">
1910
- 1) [step] = [n] / [codebook_dimensions]
1911
- 2) iterate [i] over the range 0 ... [step]-1 {
1912
-
1913
- 3) vector [entry_temp] = read vector from packet using current codebook in VQ context
1914
- 4) iterate [j] over the range 0 ... [codebook_dimensions]-1 {
1915
-
1916
- 5) vector [v] element ([offset]+[i]+[j]*[step]) =
1917
- vector [v] element ([offset]+[i]+[j]*[step]) +
1918
- vector [entry_temp] element [j]
1919
-
1920
- }
1921
-
1922
- }
1923
-
1924
- 6) done
1925
-
1926
- </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id341754"></a>8.6.4.�format 1 specifics</h4></div></div></div><p>
1927
- Format 1 decodes partitions exactly as described earlier in the
1928
- 'Residue Format: residue 1' section. The following pseudocode
1929
- presents the same algorithm. Assume:</p><p>
1930
- </p><div class="itemizedlist"><ul type="disc"><li> <code class="varname">[n]</code> is the value in
1931
- <code class="varname">[residue_partition_size]</code></li><li><code class="varname">[v]</code> is the residue vector</li><li><code class="varname">[offset]</code> is the beginning read offset in [v]</li></ul></div><p>
1932
- </p><pre class="programlisting">
1933
- 1) [i] = 0
1934
- 2) vector [entry_temp] = read vector from packet using current codebook in VQ context
1935
- 3) iterate [j] over the range 0 ... [codebook_dimensions]-1 {
1936
-
1937
- 4) vector [v] element ([offset]+[i]) =
1938
- vector [v] element ([offset]+[i]) +
1939
- vector [entry_temp] element [j]
1940
- 5) increment [i]
1941
-
1942
- }
1943
-
1944
- 6) if ( [i] is less than [n] ) continue at step 2
1945
- 7) done
1946
- </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id341807"></a>8.6.5.�format 2 specifics</h4></div></div></div><p>
1947
- Format 2 is reducible to format 1. It may be implemented as an additional step prior to and an additional post-decode step after a normal format 1 decode.
1948
- </p><p>
1949
- Format 2 handles 'do not decode' vectors differently than residue 0 or
1950
- 1; if all vectors are marked 'do not decode', no decode occurrs.
1951
- However, if at least one vector is to be decoded, all the vectors are
1952
- decoded. We then request normal format 1 to decode a single vector
1953
- representing all output channels, rather than a vector for each
1954
- channel. After decode, deinterleave the vector into independent vectors, one for each output channel. That is:</p><div class="orderedlist"><ol type="1"><li>If all vectors 0 through <span class="emphasis"><em>ch</em></span>-1 are marked 'do not decode', allocate and clear a single vector <code class="varname">[v]</code>of length <span class="emphasis"><em>ch*n</em></span> and skip step 2 below; proceed directly to the post-decode step.</li><li>Rather than performing format 1 decode to produce <span class="emphasis"><em>ch</em></span> vectors of length <span class="emphasis"><em>n</em></span> each, call format 1 decode to produce a single vector <code class="varname">[v]</code> of length <span class="emphasis"><em>ch*n</em></span>. </li><li><p>Post decode: Deinterleave the single vector <code class="varname">[v]</code> returned by format 1 decode as described above into <span class="emphasis"><em>ch</em></span> independent vectors, one for each outputchannel, according to:
1955
- </p><pre class="programlisting">
1956
- 1) iterate [i] over the range 0 ... [n]-1 {
1957
-
1958
- 2) iterate [j] over the range 0 ... [ch]-1 {
1959
-
1960
- 3) output vector number [j] element [i] = vector [v] element ([i] * [ch] + [j])
1961
-
1962
- }
1963
- }
1964
-
1965
- 4) done
1966
- </pre><p>
1967
- </p></li></ol></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-helper"></a>9.�Helper equations</h2></div><div><p class="releaseinfo">
1968
- $Id: 09-helper.xml 7186 2004-07-20 07:19:25Z xiphmont $
1969
- </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id316603"></a>9.1.�Overview</h3></div></div></div><p>
1970
- The equations below are used in multiple places by the Vorbis codec
1971
- specification. Rather than cluttering up the main specification
1972
- documents, they are defined here and referenced where appropriate.
1973
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id317505"></a>9.2.�Functions</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-ilog"></a>9.2.1.�ilog</h4></div></div></div><p>
1974
- The "ilog(x)" function returns the position number (1 through n) of the highest set bit in the two's complement integer value
1975
- <code class="varname">[x]</code>. Values of <code class="varname">[x]</code> less than zero are defined to return zero.</p><pre class="programlisting">
1976
- 1) [return_value] = 0;
1977
- 2) if ( [x] is greater than zero ){
1978
-
1979
- 3) increment [return_value];
1980
- 4) logical shift [x] one bit to the right, padding the MSb with zero
1981
- 5) repeat at step 2)
1982
-
1983
- }
1984
-
1985
- 6) done
1986
- </pre><p>
1987
- Examples:
1988
-
1989
- </p><div class="itemizedlist"><ul type="disc"><li>ilog(0) = 0;</li><li>ilog(1) = 1;</li><li>ilog(2) = 2;</li><li>ilog(3) = 2;</li><li>ilog(4) = 3;</li><li>ilog(7) = 3;</li><li>ilog(negative number) = 0;</li></ul></div><p>
1990
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-float32_unpack"></a>9.2.2.�float32_unpack</h4></div></div></div><p>
1991
- "float32_unpack(x)" is intended to translate the packed binary
1992
- representation of a Vorbis codebook float value into the
1993
- representation used by the decoder for floating point numbers. For
1994
- purposes of this example, we will unpack a Vorbis float32 into a
1995
- host-native floating point number.</p><pre class="programlisting">
1996
- 1) [mantissa] = [x] bitwise AND 0x1fffff (unsigned result)
1997
- 2) [sign] = [x] bitwise AND 0x80000000 (unsigned result)
1998
- 3) [exponent] = ( [x] bitwise AND 0x7fe00000) shifted right 21 bits (unsigned result)
1999
- 4) if ( [sign] is nonzero ) then negate [mantissa]
2000
- 5) return [mantissa] * ( 2 ^ ( [exponent] - 788 ) )
2001
- </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-lookup1_values"></a>9.2.3.�lookup1_values</h4></div></div></div><p>
2002
- "lookup1_values(codebook_entries,codebook_dimensions)" is used to
2003
- compute the correct length of the value index for a codebook VQ lookup
2004
- table of lookup type 1. The values on this list are permuted to
2005
- construct the VQ vector lookup table of size
2006
- <code class="varname">[codebook_entries]</code>.</p><p>
2007
- The return value for this function is defined to be 'the greatest
2008
- integer value for which <code class="varname">[return_value] to the power of
2009
- [codebook_dimensions] is less than or equal to
2010
- [codebook_entries]</code>'.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-low_neighbor"></a>9.2.4.�low_neighbor</h4></div></div></div><p>
2011
- "low_neighbor(v,x)" finds the position <code class="varname">n</code> in vector <code class="varname">[v]</code> of
2012
- the greatest value scalar element for which <code class="varname">n</code> is less than
2013
- <code class="varname">[x]</code> and vector <code class="varname">[v]</code> element <code class="varname">n</code> is less
2014
- than vector <code class="varname">[v]</code> element <code class="varname">[x]</code>.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-high_neighbor"></a>9.2.4.1.�high_neighbor</h5></div></div></div><p>
2015
- "high_neighbor(v,x)" finds the position <code class="varname">n</code> in vector [v] of
2016
- the lowest value scalar element for which <code class="varname">n</code> is less than
2017
- <code class="varname">[x]</code> and vector <code class="varname">[v]</code> element <code class="varname">n</code> is greater
2018
- than vector <code class="varname">[v]</code> element <code class="varname">[x]</code>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-render_point"></a>9.2.4.2.�render_point</h5></div></div></div><p>
2019
- "render_point(x0,y0,x1,y1,X)" is used to find the Y value at point X
2020
- along the line specified by x0, x1, y0 and y1. This function uses an
2021
- integer algorithm to solve for the point directly without calculating
2022
- intervening values along the line.</p><pre class="programlisting">
2023
- 1) [dy] = [y1] - [y0]
2024
- 2) [adx] = [x1] - [x0]
2025
- 3) [ady] = absolute value of [dy]
2026
- 4) [err] = [ady] * ([X] - [x0])
2027
- 5) [off] = [err] / [adx] using integer division
2028
- 6) if ( [dy] is less than zero ) {
2029
-
2030
- 7) [Y] = [y0] - [off]
2031
-
2032
- } else {
2033
-
2034
- 8) [Y] = [y0] + [off]
2035
-
2036
- }
2037
-
2038
- 9) done
2039
- </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-render_line"></a>9.2.4.3.�render_line</h5></div></div></div><p>
2040
- Floor decode type one uses the integer line drawing algorithm of
2041
- "render_line(x0, y0, x1, y1, v)" to construct an integer floor
2042
- curve for contiguous piecewise line segments. Note that it has not
2043
- been relevant elsewhere, but here we must define integer division as
2044
- rounding division of both positive and negative numbers toward zero.
2045
- </p><pre class="programlisting">
2046
- 1) [dy] = [y1] - [y0]
2047
- 2) [adx] = [x1] - [x0]
2048
- 3) [ady] = absolute value of [dy]
2049
- 4) [base] = [dy] / [adx] using integer division
2050
- 5) [x] = [x0]
2051
- 6) [y] = [y0]
2052
- 7) [err] = 0
2053
-
2054
- 8) if ( [dy] is less than 0 ) {
2055
-
2056
- 9) [sy] = [base] - 1
2057
-
2058
- } else {
2059
-
2060
- 10) [sy] = [base] + 1
2061
-
2062
- }
2063
-
2064
- 11) [ady] = [ady] - (absolute value of [base]) * [adx]
2065
- 12) vector [v] element [x] = [y]
2066
-
2067
- 13) iterate [x] over the range [x0]+1 ... [x1]-1 {
2068
-
2069
- 14) [err] = [err] + [ady];
2070
- 15) if ( [err] &gt;= [adx] ) {
2071
-
2072
- 16) [err] = [err] - [adx]
2073
- 17) [y] = [y] + [sy]
2074
-
2075
- } else {
2076
-
2077
- 18) [y] = [y] + [base]
2078
-
2079
- }
2080
-
2081
- 19) vector [v] element [x] = [y]
2082
-
2083
- }
2084
- </pre></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-tables"></a>10.�Tables</h2></div><div><p class="releaseinfo">
2085
- $Id: 10-tables.xml 7186 2004-07-20 07:19:25Z xiphmont $
2086
- </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="vorbis-spec-floor1_inverse_dB_table"></a>10.1.�floor1_inverse_dB_table</h3></div></div></div><p>
2087
- The vector <code class="varname">[floor1_inverse_dB_table]</code> is a 256 element static
2088
- lookup table consiting of the following values (read left to right
2089
- then top to bottom):</p><pre class="screen">
2090
- 1.0649863e-07, 1.1341951e-07, 1.2079015e-07, 1.2863978e-07,
2091
- 1.3699951e-07, 1.4590251e-07, 1.5538408e-07, 1.6548181e-07,
2092
- 1.7623575e-07, 1.8768855e-07, 1.9988561e-07, 2.1287530e-07,
2093
- 2.2670913e-07, 2.4144197e-07, 2.5713223e-07, 2.7384213e-07,
2094
- 2.9163793e-07, 3.1059021e-07, 3.3077411e-07, 3.5226968e-07,
2095
- 3.7516214e-07, 3.9954229e-07, 4.2550680e-07, 4.5315863e-07,
2096
- 4.8260743e-07, 5.1396998e-07, 5.4737065e-07, 5.8294187e-07,
2097
- 6.2082472e-07, 6.6116941e-07, 7.0413592e-07, 7.4989464e-07,
2098
- 7.9862701e-07, 8.5052630e-07, 9.0579828e-07, 9.6466216e-07,
2099
- 1.0273513e-06, 1.0941144e-06, 1.1652161e-06, 1.2409384e-06,
2100
- 1.3215816e-06, 1.4074654e-06, 1.4989305e-06, 1.5963394e-06,
2101
- 1.7000785e-06, 1.8105592e-06, 1.9282195e-06, 2.0535261e-06,
2102
- 2.1869758e-06, 2.3290978e-06, 2.4804557e-06, 2.6416497e-06,
2103
- 2.8133190e-06, 2.9961443e-06, 3.1908506e-06, 3.3982101e-06,
2104
- 3.6190449e-06, 3.8542308e-06, 4.1047004e-06, 4.3714470e-06,
2105
- 4.6555282e-06, 4.9580707e-06, 5.2802740e-06, 5.6234160e-06,
2106
- 5.9888572e-06, 6.3780469e-06, 6.7925283e-06, 7.2339451e-06,
2107
- 7.7040476e-06, 8.2047000e-06, 8.7378876e-06, 9.3057248e-06,
2108
- 9.9104632e-06, 1.0554501e-05, 1.1240392e-05, 1.1970856e-05,
2109
- 1.2748789e-05, 1.3577278e-05, 1.4459606e-05, 1.5399272e-05,
2110
- 1.6400004e-05, 1.7465768e-05, 1.8600792e-05, 1.9809576e-05,
2111
- 2.1096914e-05, 2.2467911e-05, 2.3928002e-05, 2.5482978e-05,
2112
- 2.7139006e-05, 2.8902651e-05, 3.0780908e-05, 3.2781225e-05,
2113
- 3.4911534e-05, 3.7180282e-05, 3.9596466e-05, 4.2169667e-05,
2114
- 4.4910090e-05, 4.7828601e-05, 5.0936773e-05, 5.4246931e-05,
2115
- 5.7772202e-05, 6.1526565e-05, 6.5524908e-05, 6.9783085e-05,
2116
- 7.4317983e-05, 7.9147585e-05, 8.4291040e-05, 8.9768747e-05,
2117
- 9.5602426e-05, 0.00010181521, 0.00010843174, 0.00011547824,
2118
- 0.00012298267, 0.00013097477, 0.00013948625, 0.00014855085,
2119
- 0.00015820453, 0.00016848555, 0.00017943469, 0.00019109536,
2120
- 0.00020351382, 0.00021673929, 0.00023082423, 0.00024582449,
2121
- 0.00026179955, 0.00027881276, 0.00029693158, 0.00031622787,
2122
- 0.00033677814, 0.00035866388, 0.00038197188, 0.00040679456,
2123
- 0.00043323036, 0.00046138411, 0.00049136745, 0.00052329927,
2124
- 0.00055730621, 0.00059352311, 0.00063209358, 0.00067317058,
2125
- 0.00071691700, 0.00076350630, 0.00081312324, 0.00086596457,
2126
- 0.00092223983, 0.00098217216, 0.0010459992, 0.0011139742,
2127
- 0.0011863665, 0.0012634633, 0.0013455702, 0.0014330129,
2128
- 0.0015261382, 0.0016253153, 0.0017309374, 0.0018434235,
2129
- 0.0019632195, 0.0020908006, 0.0022266726, 0.0023713743,
2130
- 0.0025254795, 0.0026895994, 0.0028643847, 0.0030505286,
2131
- 0.0032487691, 0.0034598925, 0.0036847358, 0.0039241906,
2132
- 0.0041792066, 0.0044507950, 0.0047400328, 0.0050480668,
2133
- 0.0053761186, 0.0057254891, 0.0060975636, 0.0064938176,
2134
- 0.0069158225, 0.0073652516, 0.0078438871, 0.0083536271,
2135
- 0.0088964928, 0.009474637, 0.010090352, 0.010746080,
2136
- 0.011444421, 0.012188144, 0.012980198, 0.013823725,
2137
- 0.014722068, 0.015678791, 0.016697687, 0.017782797,
2138
- 0.018938423, 0.020169149, 0.021479854, 0.022875735,
2139
- 0.024362330, 0.025945531, 0.027631618, 0.029427276,
2140
- 0.031339626, 0.033376252, 0.035545228, 0.037855157,
2141
- 0.040315199, 0.042935108, 0.045725273, 0.048696758,
2142
- 0.051861348, 0.055231591, 0.058820850, 0.062643361,
2143
- 0.066714279, 0.071049749, 0.075666962, 0.080584227,
2144
- 0.085821044, 0.091398179, 0.097337747, 0.10366330,
2145
- 0.11039993, 0.11757434, 0.12521498, 0.13335215,
2146
- 0.14201813, 0.15124727, 0.16107617, 0.17154380,
2147
- 0.18269168, 0.19456402, 0.20720788, 0.22067342,
2148
- 0.23501402, 0.25028656, 0.26655159, 0.28387361,
2149
- 0.30232132, 0.32196786, 0.34289114, 0.36517414,
2150
- 0.38890521, 0.41417847, 0.44109412, 0.46975890,
2151
- 0.50028648, 0.53279791, 0.56742212, 0.60429640,
2152
- 0.64356699, 0.68538959, 0.72993007, 0.77736504,
2153
- 0.82788260, 0.88168307, 0.9389798, 1.
2154
- </pre></div></div><div class="appendix" lang="en"><h2 class="title" style="clear: both"><a name="vorbis-over-ogg"></a>1.�Embedding Vorbis into an Ogg stream</h2><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id319760"></a>1.1.�Overview</h3></div></div></div><p>
2155
- This document describes using Ogg logical and physical transport
2156
- streams to encapsulate Vorbis compressed audio packet data into file
2157
- form.</p><p>
2158
- The <a href="#vorbis-spec-intro" title="1.�Introduction and Description">Section�1, &#8220;Introduction and Description&#8221;</a> provides an overview of the construction
2159
- of Vorbis audio packets.</p><p>
2160
- The <a href="oggstream.html" target="_top">Ogg
2161
- bitstream overview</a> and <a href="framing.html" target="_top">Ogg logical
2162
- bitstream and framing spec</a> provide detailed descriptions of Ogg
2163
- transport streams. This specification document assumes a working
2164
- knowledge of the concepts covered in these named backround
2165
- documents. Please read them first.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id336562"></a>1.1.1.�Restrictions</h4></div></div></div><p>
2166
- The Ogg/Vorbis I specification currently dictates that Ogg/Vorbis
2167
- streams use Ogg transport streams in degenerate, unmultiplexed
2168
- form only. That is:
2169
-
2170
- </p><div class="itemizedlist"><ul type="disc"><li>
2171
- A meta-headerless Ogg file encapsulates the Vorbis I packets
2172
- </li><li>
2173
- The Ogg stream may be chained, i.e. contain multiple, contigous logical streams (links).
2174
- </li><li>
2175
- The Ogg stream must be unmultiplexed (only one stream, a Vorbis audio stream, per link)
2176
- </li></ul></div><p>
2177
- </p><p>
2178
- This is not to say that it is not currently possible to multiplex
2179
- Vorbis with other media types into a multi-stream Ogg file. At the
2180
- time this document was written, Ogg was becoming a popular container
2181
- for low-bitrate movies consisting of DiVX video and Vorbis audio.
2182
- However, a 'Vorbis I audio file' is taken to imply Vorbis audio
2183
- existing alone within a degenerate Ogg stream. A compliant 'Vorbis
2184
- audio player' is not required to implement Ogg support beyond the
2185
- specific support of Vorbis within a degenrate ogg stream (naturally,
2186
- application authors are encouraged to support full multiplexed Ogg
2187
- handling).
2188
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id330723"></a>1.1.2.�MIME type</h4></div></div></div><p>
2189
- The correct MIME type of any Ogg file is <code class="literal">application/ogg</code>.
2190
- However, if a file is a Vorbis I audio file (which implies a
2191
- degenerate Ogg stream including only unmultiplexed Vorbis audio), the
2192
- mime type <code class="literal">audio/x-vorbis</code> is also allowed.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id328095"></a>1.2.�Encapsulation</h3></div></div></div><p>
2193
- Ogg encapsulation of a Vorbis packet stream is straightforward.</p><div class="itemizedlist"><ul type="disc"><li>
2194
- The first Vorbis packet (the identification header), which
2195
- uniquely identifies a stream as Vorbis audio, is placed alone in the
2196
- first page of the logical Ogg stream. This results in a first Ogg
2197
- page of exactly 58 bytes at the very beginning of the logical stream.
2198
- </li><li>
2199
- This first page is marked 'beginning of stream' in the page flags.
2200
- </li><li>
2201
- The second and third vorbis packets (comment and setup
2202
- headers) may span one or more pages beginning on the second page of
2203
- the logical stream. However many pages they span, the third header
2204
- packet finishes the page on which it ends. The next (first audio) packet
2205
- must begin on a fresh page.
2206
- </li><li>
2207
- The granule position of these first pages containing only headers is zero.
2208
- </li><li>
2209
- The first audio packet of the logical stream begins a fresh Ogg page.
2210
- </li><li>
2211
- Packets are placed into ogg pages in order until the end of stream.
2212
- </li><li>
2213
- The last page is marked 'end of stream' in the page flags.
2214
- </li><li>
2215
- Vorbis packets may span page boundaries.
2216
- </li><li>
2217
- The granule position of pages containing Vorbis audio is in units
2218
- of PCM audio samples (per channel; a stereo stream's granule position
2219
- does not increment at twice the speed of a mono stream).
2220
- </li><li>
2221
- The granule position of a page represents the end PCM sample
2222
- position of the last packet <span class="emphasis"><em>completed</em></span> on that page.
2223
- A page that is entirely spanned by a single packet (that completes on a
2224
- subsequent page) has no granule position, and the granule position is
2225
- set to '-1'.
2226
- </li><li><p>
2227
- The granule (PCM) position of the first page need not indicate
2228
- that the stream started at position zero. Although the granule
2229
- position belongs to the last completed packet on the page and a
2230
- valid granule position must be positive, by
2231
- inference it may indicate that the PCM position of the beginning
2232
- of audio is positive or negative.
2233
- </p><div class="itemizedlist"><ul type="circle"><li>
2234
- A positive starting value simply indicates that this stream begins at
2235
- some positive time offset, potentially within a larger
2236
- program. This is a common case when connecting to the middle
2237
- of broadcast stream.
2238
- </li><li>
2239
- A negative value indicates that
2240
- output samples preceeding time zero should be discarded during
2241
- decoding; this technique is used to allow sample-granularity
2242
- editing of the stream start time of already-encoded Vorbis
2243
- streams. The number of samples to be discarded must not exceed
2244
- the overlap-add span of the first two audio packets.
2245
- </li></ul></div><p>
2246
- In both of these cases in which the initial audio PCM starting
2247
- offset is nonzero, the second finished audio packet must flush the
2248
- page on which it appears and the third packet begin a fresh page.
2249
- This allows the decoder to always be able to perform PCM position
2250
- adjustments before needing to return any PCM data from synthesis,
2251
- resulting in correct positioning information without any aditional
2252
- seeking logic.
2253
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
2254
- Failure to do so should, at worst, cause a
2255
- decoder implementation to return incorrect positioning information
2256
- for seeking operations at the very beginning of the stream.
2257
- </p></div></li><li>
2258
- A granule position on the final page in a stream that indicates
2259
- less audio data than the final packet would normally return is used to
2260
- end the stream on other than even frame boundaries. The difference
2261
- between the actual available data returned and the declared amount
2262
- indicates how many trailing samples to discard from the decoding
2263
- process.
2264
- </li></ul></div></div></div><div class="appendix" lang="en"><h2 class="title" style="clear: both"><a name="vorbis-over-rtp"></a>2.�Vorbis encapsulation in RTP</h2><pre class="literallayout">
2265
-
2266
-
2267
-
2268
- <p>Please consult the internet draft <em class="citetitle">RTP Payload Format for Vorbis Encoded
2269
- Audio</em> for description of how to embed Vorbis audio in an RTP stream.</p>
2270
-
2271
- </pre></div><div class="appendix" lang="en"><h2 class="title" style="clear: both"><a name="footer"></a>3.�Colophon</h2><div class="mediaobject"><img src="white-xifish.png" alt="[Xiph.org logo]"></div><p>
2272
- Ogg is a <a href="http://www.xiph.org/" target="_top">Xiph.org Foundation</a> effort
2273
- to protect essential tenets of Internet multimedia from corporate
2274
- hostage-taking; Open Source is the net's greatest tool to keep
2275
- everyone honest. See <a href="http://www.xiph.org/about.html" target="_top">About
2276
- the Xiph.org Foundation</a> for details.
2277
- </p><p>
2278
- Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
2279
- distribute the Ogg and Vorbis specification, whether in a private,
2280
- public or corporate capacity. However, the Xiph.org Foundation and
2281
- the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
2282
- specification and certify specification compliance.</p><p>
2283
- Xiph.org's Vorbis software CODEC implementation is distributed under a
2284
- BSD-like license. This does not restrict third parties from
2285
- distributing independent implementations of Vorbis software under
2286
- other licenses.</p><p>
2287
- Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
2288
- of the <a href="http://www.xiph.org/" target="_top">Xiph.org Foundation</a>. These
2289
- pages are copyright (C) 1994-2007 Xiph.org Foundation. All rights
2290
- reserved.</p><p>
2291
- This document is set in DocBook XML.
2292
- </p></div></div></body></html>