home *** CD-ROM | disk | FTP | other *** search
/ Game Audio Programming / GameAudioProgramming.iso / Extras / Sensaura / SDK1.0 / data1.cab / Example_Files / DS3DDemo / readme.txt < prev   
Encoding:
Text File  |  2000-06-13  |  11.1 KB  |  270 lines
  1. *****************************************************************************
  2.                                                                             
  3.     Sensaura DirectSound3D Windows Demo Application                            
  4.     Demo Version 1.04.000
  5.     May 12 2000
  6.                                                                             
  7. *****************************************************************************
  8.  
  9. Table of contents:
  10.  
  11.     1.    Introduction
  12.     2.    What's new in version 1.04.000
  13.     3.    How to install the demo
  14.     4.    How to play the demo
  15.     5.    What's in the source code
  16.     6.    How to build the source code
  17.     7.    Which bits do you need for your programs
  18.     8.    Copyright issues - why there aren't any
  19.     9.    Troubleshooting
  20.     10.    Known problems
  21.     11.    Contacting Sensaura
  22.  
  23.  
  24. *****************************************************************************
  25.                                                                             
  26.     1.    Introduction                                                        
  27.                                                                             
  28. *****************************************************************************
  29.  
  30. Welcome to the Sensaura DirectSound3D demonstration.  The purpose of this 
  31. demo is to show how easily you can add 3D positional audio to your games and 
  32. other programs, simply by using the Microsoft« DirectSound3D« API.  
  33. All Sensaura sound cards support the DirectSound3D API, providing hardware 
  34. acceleration of 3D positional audio to give you sounds in front, behind above 
  35. and below you.  If you write your games using DirectSound3D, not only does 
  36. the alien fighter fly off the top of the screen, the sound of its engine 
  37. screams over the player's head.  Hear the roar of the other cars and the 
  38. crowd all around you as you cross the finish line in the grand prix.  And get
  39. all this without hitting your CPU, because your Sensaura sound card is doing
  40. all the work.  Even if you don't have a Sensaura sound card, DirectSound3D
  41. can take advantage of any other 3D audio hardware that may be available, so
  42. you know that your game will run on the broadest possible base of 
  43. 3D-accelerated sound hardware.
  44.  
  45. *****************************************************************************
  46.                                                                             
  47.     2.    What's new in version 1.04.000                                                        
  48.                                                                             
  49. *****************************************************************************
  50.  
  51. Version 1.04.000 of the Sensaura DirectSound3D demonstration consists of
  52. minor modifications for DirectX 7.0 plus integration into the Sensaura SDK.
  53. The code functionality is identical to the previous versions (1.03.000/1.01.000).
  54.  
  55. *****************************************************************************
  56.                                                                             
  57.     3.    How to install the demo                                                
  58.                                                                             
  59. *****************************************************************************
  60.  
  61. To run the demo you will need to have Microsoft« DirectX« version 5.0 or 
  62. higher installed.  If you don't already have it you can install it from this 
  63. CD-ROM.
  64.  
  65. Install the Sensaura DirectSound3D demo by running setup.exe, then from the
  66. start menu select Programs/Sensaura/DirectSound3D Demo/DirectSound3D Demo to
  67. run the demo.
  68.  
  69. *****************************************************************************
  70.                                                                             
  71.     4.    How to play the demo                                                
  72.                                                                             
  73. *****************************************************************************
  74.  
  75. This is an extremely simple demo.  The keys to play the demo are:
  76.  
  77.     Up Arrow:    Forward
  78.     Down Arrow:    Back
  79.     Left Arrow:    Turn Left
  80.     Right Arrow:    Turn Right
  81.     Page Up:    Up
  82.     Page Down:    Down
  83.     Space:        Fire
  84.  
  85. As you move around, listen to the sounds of the flying saucer and meteor as
  86. they fly around, behind, above and below you.  When you press fire, listen to
  87. how the sound of the bullets comes from beyond the loudspeakers.  When you
  88. blow something up, try flying towards and past the explosion to hear the 
  89. sound go right past your ears.
  90.  
  91. There are several menu options which control the sound so that you can hear
  92. the differences between Sensaura 3D positional audio, Microsoft DirectSound3D
  93. software emulation of 3D positional audio, and normal stereo.  The 
  94. accelerator keys for these options are:
  95.  
  96.     F5:        Sensaura 3D positional audio.  Get full 3D positional
  97.             audio and hardware acceleration.  If Sensaura is not 
  98.             available on you system, then this menu option will 
  99.             be disabled.
  100.     F6:        Hardware DirectSound3D audio.  If you don't have 
  101.             Sensaura, but other 3D audio hardware is available on 
  102.             your system, then use this option to take advantage 
  103.             of the hardware acceleration provided.
  104.     F7:        Microsoft DirectSound3D software emulation.  If no 3D
  105.             audio hardware is available, DirectX will do its own 
  106.             3D processing in software on the CPU.  The 3D audio 
  107.             quality    is greatly reduced and your CPU is now using 
  108.             up time    which could be better spent on the graphics 
  109.             and gameplay
  110.     F8:        Stereo.  The sounds are panned between the speakers.
  111.             This is what you've been listening to up until now, 
  112.             even on the best games.  Boring, isn't it.
  113.  
  114.     F9:        Loudspeaker output.  
  115.     F10:        Headphone output.
  116.             Sensaura and other DirectSound3D positional audio can 
  117.             be configured for the chosen output device i.e. 
  118.             loudspeakers or headphones. Normal stereo cannot be 
  119.             configured in this way.
  120.                         
  121. *****************************************************************************
  122.                                                                             
  123.     5.    What's in the source code                                            
  124.                                                                             
  125. *****************************************************************************
  126.  
  127. At first sight, the code seems to contain a bewildering number of files, but
  128. don't panic !!  All the code for 3D positional audio is contained in a few 
  129. files.  All the others are there to produce a complete program, and to show 
  130. you how to integrate your DirectSound3D code into a complete application.
  131.  
  132. *****************************************************************************
  133.                                                                             
  134.     6.    How to build the source code                                        
  135.                                                                             
  136. *****************************************************************************
  137.  
  138. Before you get started, you'll need to have the Microsoft DirectX SDK, 
  139. version 5.0 or above.  If you're installing this demo from our CD-ROM then
  140. you can install DirectX 7.0 from the CD-ROM.  Otherwise, you can visit the 
  141. good ol' boys at Microsoft to find out how to get it:
  142.  
  143. http://www.microsoft.com/directx
  144.  
  145. If you're using Microsoft Visual C++ version 5.0 or above, load up the
  146. project workspace, ds3ddemo.dsw.  Then ensure that the compiler can see the 
  147. DirectX SDK include and library directories.  From the Tools menu, select
  148. options.  Select the Directories tab from the dialog box which appears and
  149. make sure that the SDK include directory, e.g. c:\mssdk\include is the
  150. first directory in the include files.  Then do the same for the SDK library
  151. directory, e.g. c:\mssdk\lib, in the library files.  Then, hit the build 
  152. button!!!
  153.  
  154. To view the source code in Visual C++ (or anywhere else for that matter), 
  155. ensure that your editor's indent and tab settings are both set to 4.
  156.  
  157. *****************************************************************************
  158.                                                         
  159.     7.    Which bits do you need for your programs                            
  160.                                                                             
  161. *****************************************************************************
  162.  
  163. Although there are a large number of source files, all the code you need to
  164. look at is contained in the following files:
  165.  
  166.     sensaura.cpp
  167.         The functions you need to create a Sensaura-specific 
  168.         DirectSound3D object are here.
  169.  
  170.     directx.cpp
  171.         This contains a C++ class, DirectXObject, to handle all the 
  172.         general    initialization, termination and management of your 
  173.         DirectX environment, including your DirectSound3D setup.
  174.  
  175.     dswave.cpp
  176.         This contains a handy C++ class, DirectSoundWave, which 
  177.         automates creating a sound from a WAVE resource and creating 
  178.         a DirectSound buffer from it, so you don't have to do all that 
  179.         tedious mucking about with parsing WAVE data.
  180.  
  181.     dxwindow.cpp
  182.         Shows how to switch between different types of DirectSound, so 
  183.         that you can hear the difference between Sensaura, Microsoft 
  184.         software DirectSound3D and normal stereo.
  185.  
  186.     dxwldobj.cpp
  187.         Some specific 3D objects with sounds attached to them.  The 
  188.         flying saucer and meteor objects have attached sounds which 
  189.         move with the object, whilst the bullet object has an attached 
  190.         sound which doesn't move, staying at the position where the 
  191.         bullet started
  192.  
  193.     dxworld.cpp
  194.         Shows how to integrate your DirectSound3D code into an 
  195.         application.  Includes code so that, if no hardware 3D 
  196.         positional audio is available, the game will use stereo 
  197.         panning and volume change to position sounds, rather than use 
  198.         DirectSound3D software emulation.
  199.  
  200.  
  201.     handyfns.cpp & handyfns.h
  202.         Contains some useful macros to save your poor little fingers 
  203.         from repetitive strain injury. 
  204.  
  205.     object3d.cpp
  206.         Contains C++ base classes for creating objects with 3D sounds 
  207.         attached to them.  The class also contains code for 
  208.         positioning sounds in 2D using stereo panning and volume change 
  209.         if no 3D hardware is available.
  210.  
  211. *****************************************************************************
  212.                                                         
  213.     8.    Copyright issues - why there aren't any                                
  214.                                                                             
  215. *****************************************************************************
  216.  
  217. All the code in this demo uses Microsoft's DirectX API.  You can include it 
  218. in your programs as is, modify it or do whatever you like.  Just go forth and
  219. write great sounding programs using DirectSound3D!!!
  220.  
  221. *****************************************************************************
  222.                                                                     
  223.     9.    Troubleshooting                                                        
  224.                                                                             
  225. *****************************************************************************
  226.  
  227. If you're reading this, then we didn't do our job properly.  However, life
  228. being what it is, you may encounter some problems.  If the solution isn't in
  229. this list, then let us know what it is and we'll fix it !!
  230.  
  231. Trouble running the program:
  232.     Check that the executable, ds3ddemo.exe, and all the DirectX files
  233.     i.e. bullet.x, saucer.x etc., are in the same directory
  234.  
  235.     Check that you have DirectX 5.0 or above installed on your system.
  236.     
  237. Not getting Sensaura:
  238.     You need a Sensaura sound card.  Hopefully, you've got one, so make 
  239.     sure that it's installed and selected. 
  240.  
  241. *****************************************************************************
  242.                                                                     
  243.     10.    Known problems                                                    
  244.                                                                             
  245. *****************************************************************************
  246.  
  247. Uninstallation: If you have more than one Sensaura DirectSound3D demo program
  248. installed and you uninstall one of them, the Start Menu entries will not be
  249. updated until the PC is reastarted
  250.  
  251. *****************************************************************************
  252.                                                                     
  253.     11.    Contacting Sensaura                                                    
  254.                                                                             
  255. *****************************************************************************
  256.  
  257. For technical support, questions, enquiries or general information, please
  258. contact us:
  259.  
  260. Telephone:        +44 (0)181 848 6636
  261.  
  262. Fax:            +44 (0)181 848 6543
  263.  
  264. e-mail:            dev@sensaura.co.uk
  265.  
  266. World Wide Web:    www.sensaura.co.uk
  267.  
  268. Also, if you've created a great program using DirectSound3D, we'd like to hear 
  269. from you !!!
  270.