View Javadoc

1   /**
2    * Copyright (c) 2011, The University of Southampton and the individual contributors.
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without modification,
6    * are permitted provided that the following conditions are met:
7    *
8    *   * 	Redistributions of source code must retain the above copyright notice,
9    * 	this list of conditions and the following disclaimer.
10   *
11   *   *	Redistributions in binary form must reproduce the above copyright notice,
12   * 	this list of conditions and the following disclaimer in the documentation
13   * 	and/or other materials provided with the distribution.
14   *
15   *   *	Neither the name of the University of Southampton nor the names of its
16   * 	contributors may be used to endorse or promote products derived from this
17   * 	software without specific prior written permission.
18   *
19   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21   * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
23   * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26   * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28   * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29   */
30  package org.openimaj.audio.reader;
31  
32  import java.io.IOException;
33  import java.io.InputStream;
34  import java.util.ArrayList;
35  import java.util.List;
36  
37  import org.openimaj.audio.SampleChunk;
38  import org.openimaj.audio.processor.FixedSizeSampleAudioProcessor;
39  import org.openimaj.audio.samples.SampleBuffer;
40  import org.openimaj.io.InputStreamObjectReader;
41  import org.openimaj.video.xuggle.XuggleAudio;
42  
43  /**
44   *	This class reads an input stream that contains audio data, and returns a list of
45   *	{@link SampleBuffer}s that each contain 1 second of audio. The number of samples in
46   *	each sample buffer may not be the same, as the length of the buffers is calculated
47   *	from the format of the audio in the stream.
48   *
49   *	@author David Dupplaw (dpd@ecs.soton.ac.uk)
50   *  @created 7 May 2013
51   *	@version $Author$, $Revision$, $Date$
52   */
53  public class OneSecondClipReader implements InputStreamObjectReader<List<SampleBuffer>>
54  {
55  	/**
56  	 *	{@inheritDoc}
57  	 * 	@see org.openimaj.io.ObjectReader#read(java.lang.Object)
58  	 */
59  	@Override
60  	public List<SampleBuffer> read( final InputStream stream ) throws IOException
61  	{
62  		// Open the stream.
63  		final XuggleAudio xa = new XuggleAudio( stream );
64  
65  		// Setup a chunker that will get samples in one second chunks.
66  		final int nSamplesInOneSecond = (int)(xa.getFormat().getSampleRateKHz() * 1000);
67  		final FixedSizeSampleAudioProcessor f = new FixedSizeSampleAudioProcessor(
68  				xa, nSamplesInOneSecond );
69  
70  		// Setup our output list
71  		final List<SampleBuffer> buffers = new ArrayList<SampleBuffer>();
72  
73  		// Now read the audio until we're done
74  		SampleChunk sc = null;
75  		while( (sc = f.nextSampleChunk()) != null )
76  			buffers.add( sc.getSampleBuffer() );
77  
78  		System.out.println( "Got "+buffers.size()+" one-second sample buffers.");
79  
80  		return buffers;
81  	}
82  
83  	/**
84  	 *	{@inheritDoc}
85  	 * 	@see org.openimaj.io.InputStreamObjectReader#canRead(java.io.InputStream, java.lang.String)
86  	 */
87  	@Override
88  	public boolean canRead( final InputStream stream, final String name )
89  	{
90  		return true;
91  	}
92  }