Mp3LameFormatConversionProvider.java

/tritonus-0.3.7/src/classes/org/tritonus/sampled/convert/lame/Mp3LameFormatConversionProvider.java

# · Java · 388 lines · 284 code · 30 blank · 74 comment · 55 complexity · 8df72ed39cce8cb0ff8e53d0cf85271b MD5 · raw file

/*
 *	Mp3LameFormatConversionProvider.java
 *
 *	This file is part of Tritonus: http://www.tritonus.org/
 */

/*
 *  Copyright (c) 2000 by Florian Bomers <http://www.bomers.de>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Library General Public License as published
 *   by the Free Software Foundation; either version 2 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 Library General Public License for more details.
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this program; if not, write to the Free Software
 *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*
 |<---            this code is formatted to fit into 80 columns             --->|
 */

package org.tritonus.sampled.convert.lame;

import java.io.InputStream;
import java.io.IOException;

import java.util.Arrays;
import java.util.Iterator;

import javax.sound.sampled.AudioSystem;
import javax.sound.sampled.AudioFormat;
import javax.sound.sampled.AudioInputStream;

import org.tritonus.share.TDebug;
import org.tritonus.share.sampled.AudioFormatSet;
import org.tritonus.share.sampled.convert.TSimpleFormatConversionProvider;
import org.tritonus.share.sampled.convert.TAsynchronousFilteredAudioInputStream;

import org.tritonus.lowlevel.lame.Lame;

/**
 * ConversionProvider for encoding MP3 audio files with the lame lib.
 * <p>
 * It uses a sloppy implementation of the MPEG1L3 encoding: It is used as a
 * common denominator. So users can always ask for MPEG1L3 encoding but may get
 * in fact an MPEG2L3 or MPEG2.5L3 encoded stream.
 * 
 * @author Florian Bomers
 */
// TODO: add decoding ? more work on LAME itself...
// TODO: byte swapping support in LAME ?
public class Mp3LameFormatConversionProvider extends
		TSimpleFormatConversionProvider {

	private static final int ALL = AudioSystem.NOT_SPECIFIED;

	private static final int MPEG_BITS_PER_SAMPLE = ALL;
	private static final int MPEG_FRAME_RATE = ALL;
	@SuppressWarnings("unused")
	private static final int MPEG_FRAME_SIZE = ALL;

	public static final AudioFormat.Encoding MPEG1L3 = Lame.MPEG1L3;
	// Lame converts automagically to MPEG2 or MPEG2.5, if necessary.
	public static final AudioFormat.Encoding MPEG2L3 = Lame.MPEG2L3;
	public static final AudioFormat.Encoding MPEG2DOT5L3 = Lame.MPEG2DOT5L3;

	/**
	 * Lame provides these formats:<br>
	 * MPEG1 layer III samplerates(kHz): 32 44.1 48<br>
	 * bitrates(kbs): 32 40 48 56 64 80 96 112 128 160 192 224 256 320<br>
	 * <br>
	 * MPEG2 layer III samplerates(kHz): 16 22.05 24<br>
	 * bitrates(kbs): 8 16 24 32 40 48 56 64 80 96 112 128 144 160<br>
	 * <br>
	 * MPEG2.5 layer III samplerates(kHz): 8 11.025 12<br>
	 * bitrates(kbs): 8 16 24 32 40 48 56 64 80 96 112 128 144 160<br>
	 */

	private static final AudioFormat[] OUTPUT_FORMATS = {
			new AudioFormat(MPEG2DOT5L3, 8000, ALL, 1, ALL, ALL, false),
			new AudioFormat(MPEG2DOT5L3, 8000, ALL, 2, ALL, ALL, false),
			new AudioFormat(MPEG2DOT5L3, 8000, ALL, 1, ALL, ALL, true),
			new AudioFormat(MPEG2DOT5L3, 8000, ALL, 2, ALL, ALL, true),
			new AudioFormat(MPEG2DOT5L3, 11025, ALL, 1, ALL, ALL, false),
			new AudioFormat(MPEG2DOT5L3, 11025, ALL, 2, ALL, ALL, false),
			new AudioFormat(MPEG2DOT5L3, 11025, ALL, 1, ALL, ALL, true),
			new AudioFormat(MPEG2DOT5L3, 11025, ALL, 2, ALL, ALL, true),
			new AudioFormat(MPEG2DOT5L3, 12000, ALL, 1, ALL, ALL, false),
			new AudioFormat(MPEG2DOT5L3, 12000, ALL, 2, ALL, ALL, false),
			new AudioFormat(MPEG2DOT5L3, 12000, ALL, 1, ALL, ALL, true),
			new AudioFormat(MPEG2DOT5L3, 12000, ALL, 2, ALL, ALL, true),

			new AudioFormat(MPEG2L3, 16000, ALL, 1, ALL, ALL, false),
			new AudioFormat(MPEG2L3, 16000, ALL, 2, ALL, ALL, false),
			new AudioFormat(MPEG2L3, 16000, ALL, 1, ALL, ALL, true),
			new AudioFormat(MPEG2L3, 16000, ALL, 2, ALL, ALL, true),
			new AudioFormat(MPEG2L3, 22050, ALL, 1, ALL, ALL, false),
			new AudioFormat(MPEG2L3, 22050, ALL, 2, ALL, ALL, false),
			new AudioFormat(MPEG2L3, 22050, ALL, 1, ALL, ALL, true),
			new AudioFormat(MPEG2L3, 22050, ALL, 2, ALL, ALL, true),
			new AudioFormat(MPEG2L3, 24000, ALL, 1, ALL, ALL, false),
			new AudioFormat(MPEG2L3, 24000, ALL, 2, ALL, ALL, false),
			new AudioFormat(MPEG2L3, 24000, ALL, 1, ALL, ALL, true),
			new AudioFormat(MPEG2L3, 24000, ALL, 2, ALL, ALL, true),
			// automagic
			new AudioFormat(MPEG1L3, 8000, ALL, 1, ALL, ALL, false), // MPEG2DOT5L3
			new AudioFormat(MPEG1L3, 8000, ALL, 2, ALL, ALL, false), // MPEG2DOT5L3
			new AudioFormat(MPEG1L3, 8000, ALL, 1, ALL, ALL, true), // MPEG2DOT5L3
			new AudioFormat(MPEG1L3, 8000, ALL, 2, ALL, ALL, true), // MPEG2DOT5L3
			new AudioFormat(MPEG1L3, 11025, ALL, 1, ALL, ALL, false),// MPEG2DOT5L3
			new AudioFormat(MPEG1L3, 11025, ALL, 2, ALL, ALL, false),// MPEG2DOT5L3
			new AudioFormat(MPEG1L3, 11025, ALL, 1, ALL, ALL, true), // MPEG2DOT5L3
			new AudioFormat(MPEG1L3, 11025, ALL, 2, ALL, ALL, true), // MPEG2DOT5L3
			new AudioFormat(MPEG1L3, 12000, ALL, 1, ALL, ALL, false),// MPEG2DOT5L3
			new AudioFormat(MPEG1L3, 12000, ALL, 2, ALL, ALL, false),// MPEG2DOT5L3
			new AudioFormat(MPEG1L3, 12000, ALL, 1, ALL, ALL, true), // MPEG2DOT5L3
			new AudioFormat(MPEG1L3, 12000, ALL, 2, ALL, ALL, true), // MPEG2DOT5L3
			// automagic
			new AudioFormat(MPEG1L3, 16000, ALL, 1, ALL, ALL, false), // MPEG2L3
			new AudioFormat(MPEG1L3, 16000, ALL, 2, ALL, ALL, false), // MPEG2L3
			new AudioFormat(MPEG1L3, 16000, ALL, 1, ALL, ALL, true), // MPEG2L3
			new AudioFormat(MPEG1L3, 16000, ALL, 2, ALL, ALL, true), // MPEG2L3
			new AudioFormat(MPEG1L3, 22050, ALL, 1, ALL, ALL, false), // MPEG2L3
			new AudioFormat(MPEG1L3, 22050, ALL, 2, ALL, ALL, false), // MPEG2L3
			new AudioFormat(MPEG1L3, 22050, ALL, 1, ALL, ALL, true), // MPEG2L3
			new AudioFormat(MPEG1L3, 22050, ALL, 2, ALL, ALL, true), // MPEG2L3
			new AudioFormat(MPEG1L3, 24000, ALL, 1, ALL, ALL, false), // MPEG2L3
			new AudioFormat(MPEG1L3, 24000, ALL, 2, ALL, ALL, false), // MPEG2L3
			new AudioFormat(MPEG1L3, 24000, ALL, 1, ALL, ALL, true), // MPEG2L3
			new AudioFormat(MPEG1L3, 24000, ALL, 2, ALL, ALL, true), // MPEG2L3

			new AudioFormat(MPEG1L3, 32000, ALL, 1, ALL, ALL, false),
			new AudioFormat(MPEG1L3, 32000, ALL, 2, ALL, ALL, false),
			new AudioFormat(MPEG1L3, 32000, ALL, 1, ALL, ALL, true),
			new AudioFormat(MPEG1L3, 32000, ALL, 2, ALL, ALL, true),
			new AudioFormat(MPEG1L3, 44100, ALL, 1, ALL, ALL, false),
			new AudioFormat(MPEG1L3, 44100, ALL, 2, ALL, ALL, false),
			new AudioFormat(MPEG1L3, 44100, ALL, 1, ALL, ALL, true),
			new AudioFormat(MPEG1L3, 44100, ALL, 2, ALL, ALL, true),
			new AudioFormat(MPEG1L3, 48000, ALL, 1, ALL, ALL, false),
			new AudioFormat(MPEG1L3, 48000, ALL, 2, ALL, ALL, false),
			new AudioFormat(MPEG1L3, 48000, ALL, 1, ALL, ALL, true),
			new AudioFormat(MPEG1L3, 48000, ALL, 2, ALL, ALL, true),
	};

	private static final AudioFormat[] INPUT_FORMATS = {
			new AudioFormat(8000, 16, 1, true, false),
			new AudioFormat(8000, 16, 1, true, true),
			new AudioFormat(11025, 16, 1, true, false),
			new AudioFormat(11025, 16, 1, true, true),
			new AudioFormat(12000, 16, 1, true, false),
			new AudioFormat(12000, 16, 1, true, true),
			new AudioFormat(16000, 16, 1, true, false),
			new AudioFormat(16000, 16, 1, true, true),
			new AudioFormat(22050, 16, 1, true, false),
			new AudioFormat(22050, 16, 1, true, true),
			new AudioFormat(24000, 16, 1, true, false),
			new AudioFormat(24000, 16, 1, true, true),
			new AudioFormat(32000, 16, 1, true, false),
			new AudioFormat(32000, 16, 1, true, true),
			new AudioFormat(44100, 16, 1, true, false),
			new AudioFormat(44100, 16, 1, true, true),
			new AudioFormat(48000, 16, 1, true, false),
			new AudioFormat(48000, 16, 1, true, true),

			new AudioFormat(8000, 16, 2, true, false),
			new AudioFormat(8000, 16, 2, true, true),
			new AudioFormat(11025, 16, 2, true, false),
			new AudioFormat(11025, 16, 2, true, true),
			new AudioFormat(12000, 16, 2, true, false),
			new AudioFormat(12000, 16, 2, true, true),
			new AudioFormat(16000, 16, 2, true, false),
			new AudioFormat(16000, 16, 2, true, true),
			new AudioFormat(22050, 16, 2, true, false),
			new AudioFormat(22050, 16, 2, true, true),
			new AudioFormat(24000, 16, 2, true, false),
			new AudioFormat(24000, 16, 2, true, true),
			new AudioFormat(32000, 16, 2, true, false),
			new AudioFormat(32000, 16, 2, true, true),
			new AudioFormat(44100, 16, 2, true, false),
			new AudioFormat(44100, 16, 2, true, true),
			new AudioFormat(48000, 16, 2, true, false),
			new AudioFormat(48000, 16, 2, true, true),
	};

	/**
	 * Constructor.
	 */
	public Mp3LameFormatConversionProvider() {
		super(Arrays.asList(INPUT_FORMATS), Arrays.asList(OUTPUT_FORMATS));
		if (!Lame.isLibAvailable()) {
			disable();
			if (TDebug.TraceAudioConverter) {
				TDebug.out("******* Error initializing LAME mp3 encoder: "
						+ Lame.getLinkError());
			}
		}
	}

	public AudioInputStream getAudioInputStream(AudioFormat targetFormat,
			AudioInputStream audioInputStream) {
		if (isConversionSupported(targetFormat, audioInputStream.getFormat())) {
			return new EncodedMpegAudioInputStream(getDefaultTargetFormat(
					targetFormat, audioInputStream.getFormat(), false),
					audioInputStream);
		} else {
			throw new IllegalArgumentException("conversion not supported");
		}
	}

	public AudioFormat[] getTargetFormats(AudioFormat.Encoding targetEncoding,
			AudioFormat sourceFormat) {
		if (TDebug.TraceAudioConverter) {
			TDebug.out(">MP3Lame getTargetFormats(AudioFormat.Encoding, AudioFormat):");
			TDebug.out("checking out possible target formats");
			TDebug.out("from: " + sourceFormat);
			TDebug.out("to  : " + targetEncoding);
		}
		if (isConversionSupported(targetEncoding, sourceFormat)) {
			AudioFormatSet result = new AudioFormatSet();
			Iterator iterator = getCollectionTargetFormats().iterator();
			while (iterator.hasNext()) {
				AudioFormat targetFormat = (AudioFormat) iterator.next();
				// if (TDebug.TraceAudioConverter) {
				// TDebug.out("-checking target format "+targetFormat);
				// }
				if (doMatch(targetFormat.getSampleRate(),
						sourceFormat.getSampleRate())
						&& targetFormat.getEncoding().equals(targetEncoding)
						&& doMatch(targetFormat.getChannels(),
								sourceFormat.getChannels())) {
					targetFormat = getDefaultTargetFormat(targetFormat,
							sourceFormat, true);
					// if (TDebug.TraceAudioConverter) {
					// TDebug.out("-yes. added "+targetFormat);
					// }
					result.add(targetFormat);
				} // else {
				// if (TDebug.TraceAudioConverter) {
				// boolean e=targetFormat.getEncoding().equals(targetEncoding);
				// TDebug.out("-no.
				// \""+targetFormat.getEncoding()+"\"==\""+targetEncoding+"\" ?
				// "+e);
				// }
				// }
			}

			if (TDebug.TraceAudioConverter) {
				TDebug.out("<found " + result.size() + " matching formats.");
			}
			return result.toAudioFormatArray();
		} else {
			if (TDebug.TraceAudioConverter) {
				TDebug.out("<returning empty array.");
			}
			return EMPTY_FORMAT_ARRAY;
		}
	}

	protected AudioFormat getDefaultTargetFormat(AudioFormat targetFormat,
			AudioFormat sourceFormat, boolean allowNotSpecified) {
		// always set bits per sample to MPEG_BITS_PER_SAMPLE
		// set framerate to MPEG_FRAME_RATE, framesize to FRAME_SIZE
		// always retain sample rate
		float targetSampleRate = targetFormat.getSampleRate();
		if (targetSampleRate == AudioSystem.NOT_SPECIFIED) {
			targetSampleRate = sourceFormat.getSampleRate();
		}
		if ((!allowNotSpecified && targetSampleRate == AudioSystem.NOT_SPECIFIED)
				|| (targetSampleRate != AudioSystem.NOT_SPECIFIED
						&& sourceFormat.getSampleRate() != AudioSystem.NOT_SPECIFIED && targetSampleRate != sourceFormat.getSampleRate())) {
			throw new IllegalArgumentException("Illegal sample rate ("
					+ targetSampleRate + ") !");
		}
		int targetChannels = targetFormat.getChannels();
		if (targetChannels == AudioSystem.NOT_SPECIFIED) {
			targetChannels = sourceFormat.getChannels();
		}
		if ((!allowNotSpecified && targetChannels == AudioSystem.NOT_SPECIFIED)
				|| (targetChannels != AudioSystem.NOT_SPECIFIED
						&& sourceFormat.getChannels() != AudioSystem.NOT_SPECIFIED && targetChannels != sourceFormat.getChannels())) {
			throw new IllegalArgumentException("Illegal number of channels ("
					+ targetChannels + ") !");
		}
		AudioFormat newTargetFormat = new AudioFormat(
				targetFormat.getEncoding(), targetSampleRate,
				MPEG_BITS_PER_SAMPLE, targetChannels, getFrameSize(
						targetFormat.getEncoding(), targetSampleRate,
						MPEG_BITS_PER_SAMPLE, targetChannels, MPEG_FRAME_RATE,
						false, 0), MPEG_FRAME_RATE, false, targetFormat.properties());
		return newTargetFormat;
	}

	// implementation from TSimpleFormatConversionProvider
	protected int getFrameSize(AudioFormat.Encoding encoding, float sampleRate,
			int sampleSize, int channels, float frameRate, boolean bigEndian,
			int oldFrameSize) {
		if (encoding.equals(AudioFormat.Encoding.PCM_SIGNED)
				|| encoding.equals(AudioFormat.Encoding.PCM_UNSIGNED)) {
			return super.getFrameSize(encoding, sampleRate, sampleSize,
					channels, frameRate, bigEndian, oldFrameSize);
		}
		// return default frame rate for MPEG
		return MPEG_FRAME_RATE;
	}

	public static class EncodedMpegAudioInputStream extends
			TAsynchronousFilteredAudioInputStream {
		private InputStream pcmStream;
		private Lame encoder;

		private byte[] pcmBuffer;
		private byte[] encodedBuffer;

		public EncodedMpegAudioInputStream(AudioFormat targetFormat,
				AudioInputStream sourceStream) {
			super(targetFormat, -1);
			pcmStream = sourceStream;
			encoder = new Lame(sourceStream.getFormat(), targetFormat);
			this.format = encoder.getEffectiveFormat();
			pcmBuffer = new byte[encoder.getPCMBufferSize()];
			encodedBuffer = new byte[encoder.getMP3BufferSize()];
		}

		public void execute() {
			try {
				if (encoder == null) {
					if (TDebug.TraceAudioConverter) {
						TDebug.out("mp3 lame encoder is null (already at end of stream)");
					}
					getCircularBuffer().close();
					return;
				}
				int encodedBytes = 0;
				byte[] buffer = null;
				while (encodedBytes == 0 && encoder != null) {
					int readBytes = pcmStream.read(pcmBuffer);
					// what to do in case of readBytes==0 ?
					if (readBytes > 0) {
						encodedBytes = encoder.encodeBuffer(pcmBuffer, 0,
								readBytes, encodedBuffer);
						buffer = encodedBuffer;
					} else {
						// take the larger buffer for the remaining frame(s)
						buffer = encodedBuffer.length > pcmBuffer.length ? encodedBuffer
								: pcmBuffer;
						encodedBytes = encoder.encodeFinish(buffer);
						encoder.close();
						encoder = null;
					}
				}
				if (encodedBytes > 0) {
					getCircularBuffer().write(buffer, 0, encodedBytes);
				}
				if (encoder == null) {
					getCircularBuffer().close();
				}
			} catch (ArrayIndexOutOfBoundsException e) {
				if (TDebug.TraceAudioConverter || TDebug.TraceAllExceptions) {
					TDebug.out(e);
				}
			} catch (IOException e) {
				if (TDebug.TraceAudioConverter || TDebug.TraceAllExceptions) {
					TDebug.out(e);
				}
			}
		}

		public void close() throws IOException {
			super.close();
			pcmStream.close();
			if (encoder != null) {
				encoder.encodeFinish(null);
				encoder.close();
				encoder = null;
			}
		}
	}
}

/** * Mp3LameFormatConversionProvider.java ** */
Tech Fingerprint

Alerts (15)

'+' Performance Info: Using string concatenation ('+' or '+=') inside loops can be inefficient due to repeated String object creation. Use StringBuilder (or StringBuffer for thread-safety) instead.
223 224
'Set' Raw collection type used. Specify generic type arguments (e.g., List<String>, Map<Integer, Client>) for type safety and clarity. Avoid raw types unless interacting with legacy code.
227
Complexity hotspot; lines 276 to 278 (total complexity: 9)
276 277 278
Complexity hotspot; lines 286 to 288 (total complexity: 9)
286 287 288
'.close()' Manual .close() call detected. Prefer using try-with-resources (Java 7+) for automatic and safer resource management, especially handling exceptions during close.
338 355 363 377 378 381