lwjgl/src/java/org/lwjgl/test/openal/BasicTest.java

/*
 * Copyright (c) 2002 Lightweight Java Game Library Project
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'Light Weight Java Game Library' nor the names of
 *   its contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.lwjgl.test.openal;

import org.lwjgl.openal.AL;
import org.lwjgl.openal.ALC;
import org.lwjgl.openal.ALCcontext;
import org.lwjgl.openal.ALCdevice;

import java.nio.ByteBuffer;
import java.nio.ByteOrder;
import java.nio.IntBuffer;

/**
 * $Id$
 *
 * This is a basic test, which contains the most used stuff
 *
 * @author Brian Matzon <brian@matzon.dk>
 * @version $Revision$
 */
public abstract class BasicTest {
    
    /** OpenAL instance */
    protected AL al;
    
    /** OpenAL Context instance */
    protected ALC alc;
       
    /** OpenAL context */
    protected ALCcontext context;
    
    /** OpenAL device */
    protected ALCdevice device;   
    
    /**
     * Creates an instance of PlayTest
     */
    public BasicTest() {
        al      = new AL();
        try {
            al.create();
        } catch (Exception e) {
            e.printStackTrace();
            return;
        }        
        
        alc     = new ALC();
        try {
            alc.create();
        } catch (Exception e) {
            e.printStackTrace();
            return;
        }              
    }
    
    /**
     * Initializes OpenAL
     */
    protected void alInitialize() {
        
        //get default device
        device = alc.openDevice(null);
        if(device == null) {
            throw new RuntimeException("Error creating device");
        }
        
        //create context (no attributes specified)
        context = alc.createContext(device, 0);
        if(context == null) {
            throw new RuntimeException("Error creating context");
        }
        
        //make context current
        alc.makeContextCurrent(context);
        if(alc.getError(device) != ALC.NO_ERROR) {
            throw new RuntimeException("An error occurred while making context current");
        }
    }
    
    /**
     * Shutdowns OpenAL
     */
    protected void alExit() {
        
      //Get active context
      context = alc.getCurrentContext();
      
      //Get device for active context
      device = alc.getContextsDevice(context);
      
      //Disable context
      alc.makeContextCurrent(null);
      
      //Release context(s)
      alc.destroyContext(context);
      
      //Close device
      alc.closeDevice(device);
    }
    
    /**
     * Creates an integer buffer to hold specified ints
     * - strictly a utility method
     *
     * @param size how many int to contain
     * @return created IntBuffer
     */
    protected IntBuffer createIntBuffer(int size) {
        ByteBuffer temp = ByteBuffer.allocateDirect(4*size);
        temp.order(ByteOrder.nativeOrder());
        
        return temp.asIntBuffer();
    }
    
    /**
     * Exits the test NOW, printing errorcode to stdout
     *
     * @param error Error code causing exit
     */
    protected void exit(int error) {
        System.out.println("OpenAL Error: " + al.getString(error));
        alExit();
        System.exit(-1);
    }
}