neo/openal/docs/ChangeLog

   1 2001-02-06  Bernd Kreimeier  <bk@lokigames.com>
   2
   3         * chp-rendering.sgml: added annotation about CONE calculation.
   4         * chp-state.sgml: added more annotation on log vs. linear GAIN.
   5
   6 2001-01-09  Bernd Kreimeier  <bk@lokigames.com>
   7
   8         * chp-state.sgml: ungrep of scratched DISTANCE_SCALE.
   9
  10 2001-01-08  Bernd Kreimeier  <bk@lokigames.com>
  11
  12         * chp-rendering.sgml: amended MAX_DISTANCE.
  13         * chp-state.sgml: culling clarification.
  14         Note: MAX_DISTANCE (and consequently the current
  15         Inverse Clamped Distance Model) do not fit the API.
  16         The clamping of the distance (instead of clamping
  17         to the effective gain at the max. distance) will
  18         potentially break other distance-dependend calculations
  19         further down in the processing chain.
  20         TODO: revisit Inverse Clamped Distance Model. _DS3D extension?
  21
  22 2001-01-05  Bernd Kreimeier  <bk@lokigames.com>
  23
  24         * chp-rendering.sgml: SOURCE_RELATIVE specification.
  25
  26         * chp-state.sgml: clarified distance attentuation calculation
  27         a bit, and added back in the linear version as an annotation.
  28         Note: watch this, it's tied into the GAIN_LINEAR issue.
  29         TODO: added dist calculation requirements.
  30
  31 2001-01-04  Bernd Kreimeier  <bk@lokigames.com>
  32
  33         * chp-operation.sgml: INVALID_ENUM for getters and enable,
  34         not INVALID_OPERATION. Later: Delete{Object}s accepts zero.
  35
  36 2000-12-04  Bernd Kreimeier  <bk@lokigames.com>
  37
  38         * Makefile: added HTML ZIP targets ("update" for website).
  39
  40 2000-11-10  Bernd Kreimeier  <bk@lokigames.com>
  41
  42         * WWW: reworked the OpenAL web site as in CVS. This
  43         includes emptying HTML files with obsolete whitepaper
  44         and specification content not even linked from the
  45         official pages, and reworking the official pages to
  46         remove redundancy, and generally point to the snapshots.
  47         Also created snapshots page (along with cronjob and
  48         automated update installed by Rafael).
  49
  50         * Makefile: added ZIP file generation to update target.
  51
  52         * index.html: edited for snapshots/ page on www.openal.org.
  53         As it is next to impossible to reproduce the Official OpenAL
  54         Look w/o lots of tap dancing, I use the style from the
  55         DocBook HTML rendering instead.
  56
  57 2000-11-06  Bernd Kreimeier  <bk@lokigames.com>
  58
  59         * Makefile (full): full rendering target added.
  60         * ent-marks-full.sgml: created.
  61
  62 2000-10-27  Bernd Kreimeier  <bk@lokigames.com>
  63
  64         * Makefile: rendering targets for cronjob driven update.
  65
  66 2000-10-26  Bernd Kreimeier  <bk@lokigames.com>
  67
  68         * alc-context.sgml: annotation on release of hardware resources.
  69         Removed version query enry point, added size-safe GetIntegerv
  70         and GetString, removed GetErrorString, added integer and string
  71         query tokens, added device enumeration query. Added more annotation.
  72
  73         * chp-rendering.sgml: remark on release of hardware resources.
  74
  75         * alc-context.sgml: had INVALID_DEVICE also marked by RFC.
  76         Removed the "device parameter should be NULL" leftovers.
  77         Added Query functions. Removed redundant device parameters
  78         to avoid GLX-style redundancy and resulting BadMatch errors.
  79
  80
  81 2000-10-25  Bernd Kreimeier  <bk@lokigames.com>
  82
  83         * oalspecs.sgml: include extension list entity (below).
  84         * ent-extensions.sgml: created.
  85         Note: during several unsuccessful attempts to convince
  86         DocBook and the DocBook toolchain to handle CDATA external
  87         entities properly for <literallayout> and <programlisting>,
  88         I also had to recover accidentally deleted files.
  89
  90 2000-10-24  Bernd Kreimeier  <bk@lokigames.com>
  91
  92         * alc-context.sgml: shared object section. Mike Kelly request
  93         as RFC. ALC Error section placeholder. ALC attribute section
  94         as placeholder. Process/Suspend added plus annotation, Update
  95         removed. More typo fixes. Added extension query. Removed old
  96         RFC's. No UNDERFLOW error. No CHANNELS attribute, MIXAHEAD
  97         redundant. Removed alcUpdate( PROCESS | SUSPEND ) RFC.
  98
  99
 100 2000-10-23  Bernd Kreimeier  <bk@lokigames.com>
 101
 102         * alc-context.sgml: entities for ALCdevice and ALCcontext.
 103         Fixed typos reported by CarloV on non-pointer handles.
 104
 105         * chp-rendering.sgml: infinite LOOPING attribute.
 106
 107 2000-10-20  Bernd Kreimeier  <bk@lokigames.com>
 108
 109         * ent-examples.sgml: experimenting with external sample.c
 110         files as CDATA entities, to no avail.
 111         * oalspecs.sgml: example entities.
 112
 113 2000-10-16  Bernd Kreimeier  <bk@lokigames.com>
 114
 115         * chp-rendering.sgml: moved in buffer queueing.
 116         Scratched PLAY_COUNT. Fixed SourceStart{v} residue.
 117
 118         * chp-queueing.sgml: proof-reading, contents then moved out.
 119
 120 2000-10-13  Bernd Kreimeier  <bk@lokigames.com>
 121
 122         * chp-queueing.sgml: changed according to discussion.
 123         Removed some, but not all redundant annotation, and removed
 124         remainders of old attribute based approach. Added annotation
 125         on repetition by multiple calls. Changed signatures.
 126
 127 2000-10-11  Bernd Kreimeier  <bk@lokigames.com>
 128
 129         * chp-state.sgml: removed GAIN_LINAR based equations.
 130         * chp-rendering.sgml: removed GAIN_LINAR.
 131         * ext-gainlinear.sgml: collected GAIN_LINEAR related sections.
 132         Note: choosing to use GAIN_LINEAR_LOKI for now. The duplication
 133         of tokens complicates specification and implementation, and
 134         requires further discussion.
 135
 136         * ent-marks.sgml: added Revision mark.
 137
 138         * oalspecs.sgml: added per-file revision history (appendix).
 139         Note: we might wind up never rendering these, I can't see
 140         a consistent way to do this.
 141
 142         * ChangeLog: moved in revision history from oalspecs.sgml.
 143         Note: see the very first entry in this document for the
 144         revision history that predates this ChangeLog.
 145         TODO: include ChangeLog in RFC/Revision rendering.
 146
 147         * chp-introduction.sgml: removed CVS based revision history.
 148         Added a %Revision marked section (we now have these per-file).
 149
 150 2000-10-10  Bernd Kreimeier  <bk@lokigames.com>
 151
 152         * oalspecs.sgml: reworked for new distributed document.
 153
 154         * app-annotations.sgml: created from original doc.
 155         * app-extensionprocess.sgml: created from original doc.
 156         * app-extensions.sgml: created from original doc.
 157         * app-constants.sgml: created from original doc.
 158
 159         * alc-context.sgml: created from original doc.
 160         Note: this breaks the scheme a bit, as this is technically
 161         a chapter, but if ALC turns into a multi-chapter
 162         documentation at some point down the road it will have
 163         to be a separate document anyway.
 164
 165         * chp-multichannel.sgml: created from original doc.
 166         * chp-queueing.sgml: created from original doc.
 167         * chp-buffers.sgml: created from original doc.
 168         * chp-rendering.sgml: created from original doc.
 169         * chp-state.sgml: created from original doc.
 170         * chp-operation.sgml: created from original doc.
 171         * chp-introduction.sgml: created from original doc.
 172         * sec-bookinfo.sgml:  created from original doc.
 173
 174         * ent-names.sgml: created from original doc.
 175         * ent-marks.sgml: got it working.
 176         Note: this will be a temporary file (created from the Makefile),
 177         not sure whether it should be in CVS at all.
 178
 179         * ChangeLog: created.
 180
 181 2000--1999  Bernd Kreimeier  <bk@lokigames.com>
 182
 183         * oalspecs.sgml: moved out CVS Revision History (below).
 184
 185         The AL Specification was originally maintained as an HTML
 186         document, and subsequently as a single SGML file. With the
 187         split into several files, it is no longer possible or
 188         desirable to maintain a single revision history. As we
 189         have a manually maintained revhistory within the DocBook
 190         source, I decided to move the old revision history into
 191         the ChangeLog.
 192
 193         Revision 1.11  2000/10/11 18:44:46  bk
 194         More JMJ typo corrections. IA-SID I3DL2 section rephrased. Moved
 195         marked section toggles in ent-marks.sgml file so that these can
 196         be generated or modified from the Makefile. Split document up into
 197         several separate files using external entities. Created external
 198         ChangeLog. From now on, revision history and changes will be
 199         maintained in the ChangeLog as it is scattered over files.
 200
 201         Revision 1.10  2000/09/27 22:57:02  bk
 202         Commit w/o subdoc (doesn't work).
 203
 204         Revision 1.9  2000/09/27 22:54:36  bk
 205         Typos from MKV and JMJ. Fixed Inverse Square Law. Scratched
 206         ProgagationSpeed. Described distance models in full. Changed
 207         to INVERSE_DISTANCE (both models use ROF). Added GH text (parts)
 208         as annotation to "View" sections, added Basic AL Operation text
 209         he sent (some changes, removed redundant section), marked source
 210         as Example sections. Changed Terminology annotation. Added TBA
 211         on Fundamentals. RFC'ed distributed error section from GL and
 212         annotation. Added TBA on Floating Point Computation. Added AL
 213         State TBA. Added AL entity as opposed to OAL. Added Command Syntax
 214         TBA (minimal) plus annotation. More fixes from JMJ. No NaN
 215         check comment. Rephrased invalid commmands. Disclaimer on
 216         Enable/Disable being unused. Query with NULL destination
 217         clarified. Example values for simple query. TBA on data
 218         conversions. Cleaned out Time query/scaling, added RFC,
 219         marked DURATION/REMAINDER as Scratch. Euclidean. No Transforms
 220         now annotation. Promoted RFC on Source( BUFER, NONE ) to spec
 221         text. Scratch'ed Streaming Buffer remarks. Removed IMPLIED.
 222         Scratch'ed Buffer Traversal and a whole shebang of queueing
 223         annotation to go with it. ALC cleanup, RFC on multiple
 224         current contexts. Skipped Buffer Queueing section for now.
 225         SUBDOC NO in DocBook declaration. Validation pass for CVS.
 226
 227         Revision 1.8  2000/09/20 01:21:33  bk
 228         Fixes from Ian Ollman: fixed wrong title on Buffer Attributes
 229         section. Annotation on No application selected Names. Fixes
 230         from JMJ: typos and mistakes on I3DL2. Renamed LOOP_COUNT to
 231         PLAY_COUNT and clarified counting as requested. DOPPLER_FACTOR,
 232         DOPPLER_VELOCITY, Doppler Effect section rewritten according to
 233         announced changes. Removed DistanceFactor, added scale invariance.
 234         Scratch-marked Multichannel sketch. Added BufferWriteData as Loki
 235         extension. Removed obsolete RFC on depercating BUFFER. Rewrote
 236         Buffer queueing state section and renamed BUFFERS_USED to
 237         BUFFERS_PROCESSED following discussion with John Kraft, to remove
 238         ambiguity. Rewrote BUFFERS_PROCESSED description. Added
 239         MAX_DISTANCE plus MUTE annotation. Added No Culling section.
 240         Edited DISTANCE_MODEL section. Distance Model Source Attributes
 241         added. Rolloff quantization annotation added. Evaluation order
 242         on attenuation/gain. Marked Scratch the current IASIG section
 243         per JMJ's request, added Source Environment Attribute section
 244         as TBA. Removed and moved RFC's (AppendData, GenStreaming).
 245         Clarified directional attenuation. Clarified CONE_OUTER_GAIN
 246         as scaling factor. Added a Programmers and Implementors View.
 247
 248         Revision 1.7  2000/08/15 02:47:03  bk
 249         Fixed RFC markup error needed for Full version.
 250
 251         Revision 1.6  2000/08/15 02:20:49  bk
 252         Clarified BUFFER_USED vs. buffer state. Started section on
 253         handling multichannel output. Moved out GenStreamingBuffer
 254         in annotation on BufferAppendData extension. Added BufferWriteData
 255         with internalFormat parameter and discussion on mono vs.
 256         multichannel buffers. Added Multichannel objects (kept short in
 257         case we demote to extension or replace). Some annotation.
 258         Tried GGI docbook2texi in attempt to end those rogue linux/doc
 259         activities, to no avail. Removed messy scratchpad section.
 260         Removed outdated example listing. Turned remaining scratch
 261         annotation into appendix. Created minimal Makefile (cleanup).
 262
 263         Revision 1.5  2000/08/08 02:56:05  bk
 264         alcGetCurrentContext. Attempt to formulate Design Objectives as
 265         a guideline. RFC's on INITIAL state, ACTIVE misnomer. RFC on
 266         INVALID_POINTER. Lots of scratch stuff (fallout from buffer
 267         queueing discussions). Annotations on various buffer queue
 268         rejects and related issues. Added Scaling and Timing sections
 269         and related calls. Added CONE_OUTER_GAIN. Added Doppler sections.
 270         Rewrote and shuffle globale state, simple query, string query.
 271         Moved Extensions sections in Appendix. Added annotation and
 272         RFC's regarding distance/gain model. No more ILLGEAL - finally
 273         checked the specs and Mesa 3.3 to be sure. Picked OPERATION at
 274         the same time, also specs conformat (no comment...). Removed
 275         JMJ as responsible author (all blame shall be mine). Fixed
 276         Play(), INITIAL vs. STOPPED. Edited related RFC's, stripped
 277         obsolete commentary. Rewrote State/State Transition section.
 278         Fixes on SGML. CHANNELS and BITS moved in RFC's. Moved and
 279         rewrote RFC on Duration/Remainder queries into Time section.
 280         Stripped BYTE_LOKI of all but the essentials. Added placeholders
 281         for Callback and AppendData in same (backwards compatibility)
 282         section. Lots of Buffer Queueing.
 283
 284         Revision 1.4  2000/07/25 17:19:17  bk
 285         Changed ILLEGAL_OPERATION to ILLEGAL_COMMAND consistently. Added
 286         excerpts from mailinglist to scratch section. Added Appendix on
 287         Extension Process. Typos. RFC on EXTENSIONS changed to Annotation.
 288         SGML validation and error fixes (not done on cvs1.3, sorry).
 289
 290         Revision 1.3  2000/07/24 21:18:53  bk
 291         Reordered manual revision history to be CVS compliant. Diff against
 292         Rev. 1.4/bk000626 as it was not checked in CVS. Created scratch
 293         section for removed RFC 's. Checked edits on Extension section and
 294         removal of related RFC/bk000506. Converted removed RFC/bk000504
 295         on IsExtensionPresent in Annotation. Rewrote Mike's annotations
 296         on source types and distance attentuation clamping as RFC's and
 297         added some removed RFC sections back. Rewrote annotation added by
 298         MikeV on compressed buffers, split of RFC on AL_SIZE query.
 299         Re-added RFC's an buffer attribute defaults, edited annotation
 300         on GetEnumValue return. RFC's on factory methods for streaming
 301         buffers, memory budgeting, initial object state. Re-inserted and
 302         extended RFC on format enum issue. Re-inserted the global
 303         setter/getter in scratch section. Implementation requirement
 304         section. Resurrected CONE_OUTSIDE_GAIN as RFC. BITS bitching,
 305         annotation to explain why not enumerating frequencies. Got a grip
 306         and recognized BITS and CHANNELS as query-only. More on frequency
 307         in BufferData. Into CVS before current discussions are added.
 308
 309         Revision 1.2  2000/07/19 15:16:58  briareos
 310         Enable/Disable return void, not enum.
 311
 312         Revision 1.1  2000/06/29 00:27:24  briareos
 313         Initial draft of OpenAL specs.
 314
 315
 316         1.4/briareos : not in CVS
 317         Finished editing related to my comments, with Joe's
 318         feedback, in preparation for use by Creative and eventual
 319         public dissemination later this week.
 320
 321         1.4/bk000626 : not in CVS
 322         Started using id attribute on RFC note elements, to ensure unique
 323         identifiers. Added Annote level. Added oal15-jm/overview.html
 324         changes. Added oal15-jm/object-state.html (mostly). Removed
 325         Filtering/Spatialization distinction and merged attribute table.
 326         Moved Filter chapter to annotation. Moved Geometry to annotation,
 327         rewrote annotation with my latest conclusions on A3D/EAGLE like
 328         approach. Stripped out ALU and ALUT, added annotation on reasons.
 329         Added some text to introduction chapter. Moved ALC chapter to end
 330         of specification. Followed John Hall advice to enable section
 331         numbers in print stylesheet. Rewrote section on GetError. Created
 332         I3DL2 extension appendix. Reworked all tables for better
 333         formatting with separated descriptions. Took out a bunch of
 334         outdated RFC's. Rewrote Query and String Query section. Added
 335         Scratch sections. Added ARB/Ack section. Didn't get RFC comments
 336         from MikeV. Fixed permission to copy.
 337
 338         1.4/bk000508 : not in CVS.
 339         Added RFC to Device section. Made nested RFC around entire
 340         device section to make sure. Added trailing blanks to data type
 341         entities as a cheap workaround to the HTML backend problem in
 342         FuncSynopsis. Added RFC from BYTE_LOKI discussion on mailinglist.
 343
 344         1.4/bk000507 : not in CVS.
 345         Added altypes.h info on scalar types, copied Linux OpenGL Base
 346         ABI layout. Also added some missing enums. Checked alc.h header,
 347         added UpdateContext and RFC's. Changed alc*Context signatures to
 348         include ALCdevice handle. Checked al.h header, fixed outdated
 349         BufferData/BufferAppendData signatures, added RFC's. Added comments
 350         on differing return types. This pretty much concludes the inventory.
 351
 352         1.4/bk000506 : not in CVS.
 353         The HTML in CVS was completely mangled between the 1.2 and 1.3
 354         revisions. Also, redundant al and AL_ prefixes were added, and
 355         the document was restructured. I tried SaveAs ASCII and
 356         whitespace insensitive compare, and finally did the compare
 357         manually (no guarantees). The text sections that looked
 358         relevant have been added in RFC's with the bk000506 tag.
 359         Also added a revision history and CVS tags for future CVS based
 360         revision control (post-E3).
 361
 362         1.4/bk000505 : not in CVS.
 363         SGML version. Merges AL specification and API reference as
 364         of GDC (v1.2) with each other. Adds ALC placeholder.
 365         Addition of several RFCs based on recent discussions.
 366
 367         1.3/cvogelsa : only in CVS.
 368         api-reference.html    CVS v1.14
 369         specification.html    CVS v1.3
 370
 371         1.2/briareos : 8 March 2000, released at GDC.
 372         api-reference.html    CVS v1.13
 373         specification.html    CVS v1.2
 374
 375         x.xx/nn : early specifications.
 376         Neither the early working papers by Terry Sikes, Sean L. Palmer
 377         and others nor the first versions of the &OAL; specification
 378         as compiled at Loki were archived and versioned in a coherent way.