libjava/classpath/javax/sound/sampled/ReverbType.java

   1 /* Reverb attributes
   2    Copyright (C) 2005 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.sound.sampled;
  40
  41 /**
  42  * This represents a reverb effect which can be applied to an audio signal.
  43  * @since 1.3
  44  */
  45 public class ReverbType
  46 {
  47   private String name;
  48   private int earlyReflectionDelay;
  49   private float earlyReflectionIntensity;
  50   private int lateReflectionDelay;
  51   private float lateReflectionIntensity;
  52   private int decayTime;
  53
  54   /**
  55    * Create a new ReverbType given its attributes.
  56    * @param name the name of this type
  57    * @param earlyDelay the early delay time in microseconds
  58    * @param earlyInten the early intensity in decibels
  59    * @param lateDelay the late delay time in microseconds
  60    * @param lateInten the late intensity in decibels
  61    * @param decay the decay time in microseconds
  62    */
  63   protected ReverbType(String name, int earlyDelay, float earlyInten,
  64                        int lateDelay, float lateInten, int decay)
  65   {
  66     this.name = name;
  67     this.earlyReflectionDelay = earlyDelay;
  68     this.earlyReflectionIntensity = earlyInten;
  69     this.lateReflectionDelay = lateDelay;
  70     this.lateReflectionIntensity = lateInten;
  71     this.decayTime = decay;
  72   }
  73
  74   public final boolean equals(Object o)
  75   {
  76     return super.equals(o);
  77   }
  78
  79   public final int hashCode()
  80   {
  81     return super.hashCode();
  82   }
  83
  84   /**
  85    * Return the decay time.
  86    */
  87   public final int getDecayTime()
  88   {
  89     return decayTime;
  90   }
  91
  92   /**
  93    * Return the early reflection delay.
  94    */
  95   public final int getEarlyReflectionDelay()
  96   {
  97     return earlyReflectionDelay;
  98   }
  99
 100   /**
 101    * Return the early reflection intensity.
 102    */
 103   public final float getEarlyReflectionIntensity()
 104   {
 105     return earlyReflectionIntensity;
 106   }
 107
 108   /**
 109    * Return the late reflection delay.
 110    */
 111   public final int getLateReflectionDelay()
 112   {
 113     return lateReflectionDelay;
 114   }
 115
 116   /**
 117    * Return the late reflection intensity.
 118    */
 119   public final float getLateReflectionIntensity()
 120   {
 121     return lateReflectionIntensity;
 122   }
 123
 124   /**
 125    * Return the name of this ReverbType.
 126    * @since 1.5
 127    */
 128   public String getName()
 129   {
 130     return name;
 131   }
 132
 133   /**
 134    * Return a description of this ReverbType.
 135    */
 136   public final String toString()
 137   {
 138     return ("name=" + name + "; earlyReflectionDelay=" + earlyReflectionDelay
 139             + "; earlyReflectionIntensity=" + earlyReflectionIntensity
 140             + "; lateReflectionDelay=" + lateReflectionDelay
 141             + "; lateReflectionIntensity=" + lateReflectionIntensity
 142             + "; decayTime=" + decayTime);
 143   }
 144 }