org.harctoolbox.harchardware.ir.IrAudioDevice Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of HarcHardware Show documentation
Helper functions for accessing hardware etc.
There is a newer version: 2.4.1
/*
Copyright (C) 2013 Bengt Martensson.

This program 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.

This program 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
this program. If not, see http://www.gnu.org/licenses/.
*/

package org.harctoolbox.harchardware.ir;

import java.io.IOException;
import javax.sound.sampled.LineUnavailableException;
import org.harctoolbox.harchardware.HarcHardwareException;
import org.harctoolbox.harchardware.IHarcHardware;
import org.harctoolbox.ircore.InvalidArgumentException;
import org.harctoolbox.ircore.IrSignal;
import org.harctoolbox.ircore.ModulatedIrSequence;

/**
 * This class does something interesting and useful. Or not...
 */
public class IrAudioDevice implements IHarcHardware, IRawIrSender {
    private int sampleFrequency;
    private int sampleSize;
    private int channels;
    private boolean bigEndian;
    private boolean omitTail;
    private boolean square;
    private boolean divide;

    private boolean verbose;

    /**
     *
     * @param sampleFrequency
     * @param sampleSize
     * @param channels
     * @param bigEndian
     * @param omitTail
     * @param square
     * @param divide
     * @param verbose
     */
    public IrAudioDevice(int sampleFrequency, int sampleSize, int channels, boolean bigEndian,
            boolean omitTail, boolean square, boolean divide, boolean verbose) {
        this.sampleFrequency = sampleFrequency;
        this.sampleSize = sampleSize;
        this.channels = channels;
        this.bigEndian = bigEndian;
        this.omitTail = omitTail;
        this.square = square;
        this.divide = divide;
        this.verbose = verbose;
    }

    /**
     *
     * @param sampleFrequency
     * @param channels
     * @param omitTail
     * @param verbose
     */
    public IrAudioDevice(int sampleFrequency, int channels, boolean omitTail, boolean verbose) {
        this(sampleFrequency, 8, channels, false, omitTail, true, true, verbose);
    }

    /**
     *
     * @param sampleFrequency
     * @param sampleSize
     * @param channels
     * @param omitTail
     * @param verbose
     */
    public IrAudioDevice(int sampleFrequency, int sampleSize, int channels, boolean omitTail, boolean verbose) {
        this(sampleFrequency, sampleSize, channels, false, omitTail, true, true, verbose);
    }

    @Override
    public boolean sendIr(IrSignal irSignal, int count, Transmitter transmitter) throws NoSuchTransmitterException, IOException, HarcHardwareException, InvalidArgumentException {
        ModulatedIrSequence seq = irSignal.toModulatedIrSequence(count);
        Wave wave = new Wave(seq, sampleFrequency, sampleSize, channels, bigEndian, omitTail, square, divide);
        try {
            wave.play();
            if (verbose)
                System.err.println("Sent IrSignal @ " + sampleFrequency + "Hz, " + sampleSize + "bits, "
                        + (channels == 2 ? "stereo" : "mono") + ", to audio device");
            return true;
        } catch (LineUnavailableException ex) {
            throw new HarcHardwareException(ex);
        }
    }

    @Override
    public String getVersion() throws IOException {
        return null;
    }

    @Override
    public void setVerbose(boolean verbose) {
        this.verbose = verbose;
    }

    @Override
    public void setTimeout(int timeout) {
        // there is no timeout to be set.
    }

    @Override
    public boolean isValid() {
        return true;
    }

    @Override
    public void close() throws IOException {
        // nothing to do
    }

    @Override
    public void open() throws IOException {
        // nothing to do
    }

    @Override
    public Transmitter getTransmitter() {
        return null;
    }

    @Override
    public void setDebug(int debug) {
    }

    /**
     * @return the sampleFrequency
     */
    public int getSampleFrequency() {
        return sampleFrequency;
    }

    /**
     * @param sampleFrequency the sampleFrequency to set
     */
    public void setSampleFrequency(int sampleFrequency) {
        this.sampleFrequency = sampleFrequency;
    }

    /**
     * @param sampleSize the sampleSize to set
     */
    public void setSampleSize(int sampleSize) {
        this.sampleSize = sampleSize;
    }

    /**
     * @param channels the channels to set
     */
    public void setChannels(int channels) {
        this.channels = channels;
    }

    /**
     * @param omitTail the omitTail to set
     */
    public void setOmitTail(boolean omitTail) {
        this.omitTail = omitTail;
    }
}