SoundSystem.java

/*
 * $Id: SoundSystem.java 536 2008-02-19 06:03:27Z weiju $
 * 
 * Created on 2006/01/29
 * Copyright 2005-2008 by Wei-ju Wu
 * This file is part of The Z-machine Preservation Project (ZMPP).
 *
 * ZMPP is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * ZMPP is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with ZMPP.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.zmpp.media;

/**
 * This interface defines the sound system of the Z-machine preservation
 * project.
 *
 * @author Wei-ju Wu
 * @version 1.0
 */
public interface SoundSystem {

    /**
     * High pitched bleep.
     */
    public static final int BLEEP_HIGH = 1;

    /**
     * Low pitched bleep.
     */
    public static final int BLEEP_LOW = 2;

    /**
     * Prepares a sound.
     */
    public static final int EFFECT_PREPARE = 1;

    /**
     * Starts a sound.
     */
    public static final int EFFECT_START = 2;

    /**
     * Stops a sound.
     */
    public static final int EFFECT_STOP = 3;

    /**
     * Finishes a sound.
     */
    public static final int EFFECT_FINISH = 4;

    /**
     * The maximum value for volume.
     */
    public static final int VOLUME_MAX = 0;

    /**
     * The minimum value for volume.
     */
    public static final int VOLUME_MIN = 255;

    /**
     * Sets the volume to default.
     */
    public static final int VOLUME_DEFAULT = -1;

    /**
     * Plays a sound.
     *
     * @param number the number of the resource, 1 and 2 are bleeps
     * @param effect the effect
     * @param volume the volume
     * @param repeats how often should the sound be played
     * @param routine the interrupt routine (can be 0)
     */
    void play(int number, int effect, int volume, int repeats, int routine);

    /**
     * Resets the sound system.
     */
    void reset();
}