| 1 | <html> |
|---|
| 2 | |
|---|
| 3 | <head> |
|---|
| 4 | <title>libvorbisenc - Documentation</title> |
|---|
| 5 | <link rel=stylesheet href="style.css" type="text/css"> |
|---|
| 6 | </head> |
|---|
| 7 | |
|---|
| 8 | <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> |
|---|
| 9 | <table border=0 width=100%> |
|---|
| 10 | <tr> |
|---|
| 11 | <td><p class=tiny>libvorbisenc documentation</p></td> |
|---|
| 12 | <td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td> |
|---|
| 13 | </tr> |
|---|
| 14 | </table> |
|---|
| 15 | |
|---|
| 16 | <h1>Libvorbisenc API changes 1.0 through 1.1</h1> |
|---|
| 17 | |
|---|
| 18 | This document describes API additions to libvorbisenc between release |
|---|
| 19 | 1.0 and 1.1. |
|---|
| 20 | |
|---|
| 21 | <h2>1.0.1</h2> |
|---|
| 22 | |
|---|
| 23 | The programming API and binary application ABI are unchanged and fully |
|---|
| 24 | forward/backward compatible between release 1.0 and 1.0.1. Libvorbis, |
|---|
| 25 | libvorbisenc and libvorbisfile must match versions amongst themselves, |
|---|
| 26 | however. |
|---|
| 27 | |
|---|
| 28 | <h2>1.1</h2> |
|---|
| 29 | |
|---|
| 30 | The binary ABI from release 1.0.1 to 1.1 is backward compatible; |
|---|
| 31 | applications linked against libvorbis/libvorbisenc 1.0 and 1.0.1 will |
|---|
| 32 | continue to function correctly when upgrading the libvorbis and |
|---|
| 33 | libvorbisenc dynamic libraries without re-linking. <p> |
|---|
| 34 | |
|---|
| 35 | Release 1.1 adds several possible requests to the libvorbisenc <a |
|---|
| 36 | href="vorbis_encode_ctl.html">vorbis_encode_ctl()</a> call in order to |
|---|
| 37 | reflect the shift to <a href="overview.html#BBR">bit-reservoir style |
|---|
| 38 | bitrate management</a>. In addition, several <a |
|---|
| 39 | href="vorbis_encode_ctl.html">vorbis_encode_ctl()</a> requests are |
|---|
| 40 | deprecated (but functional) as they are redered semantically obsolete |
|---|
| 41 | by the <a href="overview.html#BBR">new bitrate management</a>.<p> |
|---|
| 42 | |
|---|
| 43 | <h3>Deprecated in 1.1</h3> |
|---|
| 44 | |
|---|
| 45 | These calls are still available to older codebases to preserve |
|---|
| 46 | compatability; the fields of the <a |
|---|
| 47 | href="ovectl_ratemanage_arg.html">ovectl_ratemanage_arg</a> argument |
|---|
| 48 | are mapped as closely as possible to the fields of the new <a |
|---|
| 49 | href="ovectl_ratemanage2_arg.html">ovectl_ratemanage2_arg</a> |
|---|
| 50 | structure. |
|---|
| 51 | |
|---|
| 52 | <dl> |
|---|
| 53 | <dt><a href="vorbis_encode_ctl.html#OV_ECTL_RATEMANAGE_GET">OV_ECTL_RATEMANAGE_GET</a>:<dd> Use <a |
|---|
| 54 | href="vorbis_encode_ctl.html#OV_ECTL_RATEMANAGE2_GET">OV_ECTL_RATEMANAGE2_GET</a> |
|---|
| 55 | instead. |
|---|
| 56 | |
|---|
| 57 | |
|---|
| 58 | <dt><a href="vorbis_encode_ctl.html#OV_ECTL_RATEMANAGE_SET">OV_ECTL_RATEMANAGE_SET</a>:<dd> Use <a |
|---|
| 59 | href="vorbis_encode_ctl.html#OV_ECTL_RATEMANAGE2_SET">OV_ECTL_RATEMANAGE2_SET</a> |
|---|
| 60 | instead. |
|---|
| 61 | |
|---|
| 62 | <dt><a href="vorbis_encode_ctl.html#OV_ECTL_RATEMANAGE_AVG">OV_ECTL_RATEMANAGE_AVG</a>:<dd> Use <a |
|---|
| 63 | href="vorbis_encode_ctl.html#OV_ECTL_RATEMANAGE2_SET">OV_ECTL_RATEMANAGE2_SET</a> |
|---|
| 64 | instead. |
|---|
| 65 | |
|---|
| 66 | <dt><a href="vorbis_encode_ctl.html#OV_ECTL_RATEMANAGE_HARD">OV_ECTL_RATEMANAGE_HARD</a>:<dd> Use <a |
|---|
| 67 | href="vorbis_encode_ctl.html#OV_ECTL_RATEMANAGE2_SET">OV_ECTL_RATEMANAGE2_SET</a> |
|---|
| 68 | instead. |
|---|
| 69 | </dl> |
|---|
| 70 | |
|---|
| 71 | <h3>Newly added in 1.1</h3> |
|---|
| 72 | |
|---|
| 73 | The following calls are added in 1.1 to semantically reflect movement |
|---|
| 74 | to a <a href="overview.html#BBR">bit-reservoir-based bitrate |
|---|
| 75 | management</a> scheme by introducing the <a |
|---|
| 76 | href="ovectl_ratemanage2_arg.html">ovectl_ratemanage2_arg</a> |
|---|
| 77 | structure in order to better represent the abilities of the bitrate |
|---|
| 78 | manager.<p> |
|---|
| 79 | |
|---|
| 80 | <dl> |
|---|
| 81 | <dt><a href="vorbis_encode_ctl.html#OV_ECTL_RATEMANAGE2_GET">OV_ECTL_RATEMANAGE2_GET</a><dd> |
|---|
| 82 | |
|---|
| 83 | Used to query the current state of bitrate management setup. |
|---|
| 84 | |
|---|
| 85 | <dt><a href="vorbis_encode_ctl.html#OV_ECTL_RATEMANAGE2_SET">OV_ECTL_RATEMANAGE2_SET</a><dd> |
|---|
| 86 | |
|---|
| 87 | Used to set or alter bitrate management settings. |
|---|
| 88 | </dl> |
|---|
| 89 | |
|---|
| 90 | <br><br> |
|---|
| 91 | <hr noshade> |
|---|
| 92 | <table border=0 width=100%> |
|---|
| 93 | <tr valign=top> |
|---|
| 94 | <td><p class=tiny>copyright © 2000-2004 vorbis team</p></td> |
|---|
| 95 | <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> |
|---|
| 96 | </tr><tr> |
|---|
| 97 | <td><p class=tiny>libvorbisenc documentation</p></td> |
|---|
| 98 | <td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td> |
|---|
| 99 | </tr> |
|---|
| 100 | </table> |
|---|
| 101 | |
|---|
| 102 | </body> |
|---|
| 103 | |
|---|
| 104 | </html> |
|---|
