1/*
2 * Copyright (c) 2009-2010 jMonkeyEngine
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 *   notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above copyright
13 *   notice, this list of conditions and the following disclaimer in the
14 *   documentation and/or other materials provided with the distribution.
15 *
16 * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
17 *   may be used to endorse or promote products derived from this software
18 *   without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33package com.jme3.audio;
34
35import com.jme3.export.InputCapsule;
36import com.jme3.export.JmeExporter;
37import com.jme3.export.JmeImporter;
38import com.jme3.export.OutputCapsule;
39import com.jme3.util.NativeObject;
40import java.io.IOException;
41
42public class LowPassFilter extends Filter {
43
44    protected float volume, highFreqVolume;
45
46    public LowPassFilter(float volume, float highFreqVolume) {
47        super();
48        setVolume(volume);
49        setHighFreqVolume(highFreqVolume);
50    }
51
52    protected LowPassFilter(int id){
53        super(id);
54    }
55
56    public float getHighFreqVolume() {
57        return highFreqVolume;
58    }
59
60    public void setHighFreqVolume(float highFreqVolume) {
61        if (highFreqVolume < 0 || highFreqVolume > 1)
62            throw new IllegalArgumentException("High freq volume must be between 0 and 1");
63
64        this.highFreqVolume = highFreqVolume;
65        this.updateNeeded = true;
66    }
67
68    public float getVolume() {
69        return volume;
70    }
71
72    public void setVolume(float volume) {
73        if (volume < 0 || volume > 1)
74            throw new IllegalArgumentException("Volume must be between 0 and 1");
75
76        this.volume = volume;
77        this.updateNeeded = true;
78    }
79
80    public void write(JmeExporter ex) throws IOException{
81        super.write(ex);
82        OutputCapsule oc = ex.getCapsule(this);
83        oc.write(volume, "volume", 0);
84        oc.write(highFreqVolume, "hf_volume", 0);
85    }
86
87    @Override
88    public void read(JmeImporter im) throws IOException{
89        super.read(im);
90        InputCapsule ic = im.getCapsule(this);
91        volume = ic.readFloat("volume", 0);
92        highFreqVolume = ic.readFloat("hf_volume", 0);
93    }
94
95    @Override
96    public NativeObject createDestructableClone() {
97        return new LowPassFilter(id);
98    }
99
100}
101