-/*
- * Sonitus - Format.java - Copyright © 2013 David Roden
- *
- * 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 net.pterodactylus.sonitus.data;
-
-/**
- * A format is a combination of a number of channels, a sampling frequency, and
- * an encoding scheme.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
- */
-public class Format {
-
- /** Constant for an unknown number of channels. */
- public static final int UNKNOWN_CHANNELS = -1;
-
- /** Constant for an unknown frequency. */
- public static final int UNKNOWN_FREQUENCY = -1;
-
- /** Constant for an unknown format. */
- public static final String UNKNOWN_ENCODING = "UNKNOWN";
-
- /** The number of channels of this format. */
- private final int channels;
-
- /** The sampling frequency of this format. */
- private final int frequency;
-
- /** The encoding of this format. */
- private final String encoding;
-
- /**
- * Creates a new format.
- *
- * @param channels
- * The number of channels of this format
- * @param frequency
- * The sampling frequency of this format
- * @param encoding
- * The encoding of this format
- */
- public Format(int channels, int frequency, String encoding) {
- this.channels = channels;
- this.frequency = frequency;
- this.encoding = encoding;
- }
-
- //
- // ACCESSORS
- //
-
- /**
- * Returns the number of channels of this format.
- *
- * @return The number of channels of this format
- */
- public int channels() {
- return channels;
- }
-
- /**
- * Returns the sampling frequency of this format.
- *
- * @return The sampling frequency of this format
- */
- public int frequency() {
- return frequency;
- }
-
- /**
- * Returns the encoding of this format
- *
- * @return The encoding of this format
- */
- public String encoding() {
- return encoding;
- }
-
- //
- // MUTATORS
- //
-
- /**
- * Returns a format with the same parameters as this format and the given
- * number of channels.
- *
- * @param channels
- * The new number of channels
- * @return A new format with the given number of channels
- */
- public Format channels(int channels) {
- return new Format(channels, frequency, encoding);
- }
-
- /**
- * Returns a new format with the same parameters as this format and the given
- * frequency.
- *
- * @param frequency
- * The new frequency
- * @return A new format with the given frequency
- */
- public Format frequency(int frequency) {
- return new Format(channels, frequency, encoding);
- }
-
- /**
- * Returns a new format with the same parameters as this format and the given
- * encoding.
- *
- * @param encoding
- * The new encoding
- * @return A new format with the given encoding
- */
- public Format encoding(String encoding) {
- return new Format(channels, frequency, encoding);
- }
-
- //
- // OBJECT METHODS
- //
-
- @Override
- public int hashCode() {
- return (channels << 16) ^ frequency ^ encoding.toUpperCase().hashCode();
- }
-
- @Override
- public boolean equals(Object object) {
- if ((object == null) || (getClass() != object.getClass())) {
- return false;
- }
- Format format = (Format) object;
- return (format.channels == channels) && (format.frequency == frequency) && format.encoding.equalsIgnoreCase(encoding());
- }
-
- @Override
- public String toString() {
- return String.format("%d Channel%s, %d Hz, %s", channels, channels != 1 ? "s" : "", frequency, encoding);
- }
-
-}