001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030/**
031 * 
032 */
033package org.openimaj.audio;
034
035/**
036 *      Represents an audio stream that can be read chunk-by-chunk.
037 *
038 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
039 *  @created 8 Jun 2011
040 *      
041 */
042public abstract class AudioStream extends Audio
043{
044        /**
045         *      Retrieve the next SampleChunk from the audio stream.
046         *      @return The next sample chunk in the audio stream.
047         */
048        public abstract SampleChunk nextSampleChunk();
049        
050        /**
051         *      Reset the audio stream.
052         */
053        public abstract void reset();
054        
055        /**
056         *      Returns the length of the audio stream in milliseconds. If the length
057         *      is unknown (for a live stream for example), then this method should
058         *      return -1.
059         * 
060         *      @return The length in milliseconds, or -1
061         */
062        public abstract long getLength();
063        
064
065        /**
066         *      Seeks the audio to the given timestamp. The timestamp of the audio
067         *      should be checked after calling seek() as the seek method may not
068         *      succeed if the stream does not support seeking.
069         *  
070         *      @param timestamp The timestamp to seek to
071         */
072        public void seek( final long timestamp )
073        {
074                // Seek supported? Then override this method.
075        }
076}