Development/Tutorials/Games/KALEngine - Revision history

Maidis: /* The Code */ try to update explanations, need more work

2013-05-13T19:00:53Z

‎The Code: try to update explanations, need more work

Maidis: /* Hello Word */ add new code

2013-05-13T18:21:23Z

‎Hello Word: add new code

Maidis: remove installation section, i suppose gluon package is available for distros

2013-05-13T18:08:41Z

remove installation section, i suppose gluon package is available for distros

Maidis: /* Abstract */ KALEngine -> Gluon's audio module

2013-05-13T18:05:23Z

‎Abstract: KALEngine -> Gluon's audio module

Tstaerk at 08:36, 26 September 2011

2011-09-26T08:36:37Z

Neverendingo: Text replace - "" to ""

2011-06-29T20:51:31Z

Text replace - "</code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T20:44:52Z
Text replace - "<code>" to "<syntaxhighlight lang="text">"

				
				
				
				
			
			← Older revision
			Revision as of 20:44, 29 June 2011
			
Line 34:
Line 34:
  If you're using a Debian-based distribution, you can install them that way :   If you're using a Debian-based distribution, you can install them that way :
    
− <code>sudo apt-get install libalut0-dev libopenal1-dev libsndfile1-dev libvorbis-dev libvorbisfile libogg-dev</code> + <syntaxhighlight lang="text">sudo apt-get install libalut0-dev libopenal1-dev libsndfile1-dev libvorbis-dev libvorbisfile libogg-dev</code>
    
  2: Build and install KALEngine from svn :   2: Build and install KALEngine from svn :
− <code>svn co svn://anonsvn.kde.org/home/kde/trunk/playground/games/KALEngine/</code> + <syntaxhighlight lang="text">svn co svn://anonsvn.kde.org/home/kde/trunk/playground/games/KALEngine/</code>
    
  * cmake -DCMAKE_INSTALL_PREFIX=$(kde-config --prefix)   * cmake -DCMAKE_INSTALL_PREFIX=$(kde-config --prefix)



Neverendingo: Text replace - "" to ""

2011-06-29T20:28:49Z
Text replace - "<code cppqt>" to "<syntaxhighlight lang="cpp-qt">"

				
				
				
				
			
			← Older revision
			Revision as of 20:28, 29 June 2011
			
Line 47:
Line 47:
  In this example, we will play a "Hello Word". We don't need to specify any sound file, openAL provides a default sound itself.   In this example, we will play a "Hello Word". We don't need to specify any sound file, openAL provides a default sound itself.
    
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
    
  #include <KALEngine>   #include <KALEngine>
Line 85:
Line 85:
  - First, we initialize the sound engine. The init() function can optionally takes one argument, the device name. You can retrieve the list of devices, using this static function :   - First, we initialize the sound engine. The init() function can optionally takes one argument, the device name. You can retrieve the list of devices, using this static function :
    
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  QStringList devicesList().   QStringList devicesList().
  </code>   </code>
Line 93:
Line 93:
  If you want to try playing something else than the default "Hello World", you can download this short simple : [[http://ktank.free.fr/kalengine/ocean.wav ocean.wav]] and replace the sound object definition by:   If you want to try playing something else than the default "Hello World", you can download this short simple : [[http://ktank.free.fr/kalengine/ocean.wav ocean.wav]] and replace the sound object definition by:
    
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
       KALSource *sound = new KALSource("ocean.wav");        KALSource *sound = new KALSource("ocean.wav");
  </code >   </code >



Tampakrap at 16:33, 6 March 2009
2009-03-06T16:33:09Z


				
				
				
				
			
			← Older revision
			Revision as of 16:33, 6 March 2009
			
Line 34:
Line 34:
  If you're using a Debian-based distribution, you can install them that way :   If you're using a Debian-based distribution, you can install them that way :
    
− <code>sudo apt-get install libalut0-dev libopenal1-dev libsndfile1-dev</code> + <code>sudo apt-get install libalut0-dev libopenal1-dev libsndfile1-dev libvorbis-dev libvorbisfile libogg-dev</code>
    
  2: Build and install KALEngine from svn :   2: Build and install KALEngine from svn :



Smarter: updated code
2009-02-14T20:11:20Z
updated code

				
				
				
				
			
			← Older revision
			Revision as of 20:11, 14 February 2009
			
Line 67:
Line 67:
    
       // print the elapsed time until the sound has finished playing        // print the elapsed time until the sound has finished playing
−      while (sound->getStatus() == AL_PLAYING) +      while (sound->status() == AL_PLAYING)
       {        {
−          kDebug() << sound->getElapsedTime(); +          kDebug() << sound->elapsedTime();
       }        }
    
Line 86:
Line 86:
    
  <code cppqt>   <code cppqt>
− QStringList getDevicesList(). + QStringList devicesList().
  </code>   </code>
    
Line 102:
Line 102:
  - The sound can now be played by simply calling <b>play()</b>. This function is asynchronous, meaning your program doesn't have to wait until the sound has finished playing to continue.   - The sound can now be played by simply calling <b>play()</b>. This function is asynchronous, meaning your program doesn't have to wait until the sound has finished playing to continue.
    
− - Then, to know when the sound has ended, we create a loop using <b>getStatus()</b> which returns ever <b>AL_PLAYING</b> or <b>AL_STOPED</b>. + - Then, to know when the sound has ended, we create a loop using <b>status()</b> which returns ever <b>AL_PLAYING</b> or <b>AL_STOPED</b>.
    
− - Inside the loop, we print the time since the sound started playing using <b>getElapsedTime()</b>. It returns an ALfloat with the elapsed time expressed in seconds. + - Inside the loop, we print the time since the sound started playing using <b>elapsedTime()</b>. It returns an ALfloat with the elapsed time expressed in seconds.
    
  - Finally, we have to clear the KALSource buffer by deleting the KALSource pointer and close the device by calling <b>shutdown()</b>.   - Finally, we have to clear the KALSource buffer by deleting the KALSource pointer and close the device by calling <b>shutdown()</b>.

@@ Line 25: / Line 25: @@
 Phonon is not really designed to handle multiple sounds at the same time. Gluon's audio module is made for games and create one thread per sound, using the openAL library. You also get all the other openAL goodness like 3D sounds, effects and multichannel.
-== Hello Word ==
+== The Code ==
-In this example, we will play a "Hello Word". We don't need to specify any sound file, openAL provides a default sound itself.
+In this example, we will play a simple sound file as "Hello Word".
 <syntaxhighlight lang="cpp-qt">
-#include <KALEngine>
+#include <QtCore/QDebug>
-#include <KALSource>
-#include <KDebug>
-int main(int argc, char **argv)
+int main( int argc, char* argv[] )
+{
-     // create an OpenAL object
+     // create a sound object
-     KALEngine soundEngine;
+     GluonAudio::Sound* sound = new GluonAudio::Sound;
-    // initialize OpenAL context and device
-    soundEngine.init();
-     // create a sound, since we haven't specified any filename in the constructor, it will play the "Hello World"
+     // load KDE's log in sound to the object
-     KALSource *sound = new KALSource();
+    sound->load( "/usr/share/sounds/KDE-Sys-Log-In-Long.ogg" );
      // play the sound
      sound->play();
-     // print the elapsed time until the sound has finished playing
+     // wait until playing is finished
-     while (sound->status() == AL_PLAYING)
+     while( sound->isPlaying() );
-−
-        kDebug() << sound->elapsedTime();
-−
      // clear the buffer
      delete sound;
      return 0;
+}
 </syntaxhighlight>

@@ Line 23: / Line 23: @@
 ==Abstract==
-Phonon is not really designed to handle multiple sounds at the same time. KALEngine is made for games and create one thread per sound, using the openAL library. You also get all the other openAL goodness like 3D sounds, effects and multichannel.
+Phonon is not really designed to handle multiple sounds at the same time. Gluon's audio module is made for games and create one thread per sound, using the openAL library. You also get all the other openAL goodness like 3D sounds, effects and multichannel.
 ==Installation==