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.timecode;
034
035import org.openimaj.time.Timecode;
036
037/**
038 *      A basic audio timecode that represents the number of milliseconds from
039 *      the start of the audio file.
040 * 
041 *  @author David Dupplaw (dpd@ecs.soton.ac.uk)
042 *      
043 *      @created 21 Nov 2011
044 */
045public class AudioTimecode implements Timecode
046{
047        /** The number of milliseconds from the start of the audio file */
048        protected long milliseconds = 0;
049        
050        /**
051         *      Default constructor that takes the number of milliseconds
052         *      into the audio file.
053         * 
054         *  @param milliseconds The number of milliseconds from the start of the
055         *      audio file.
056         */
057        public AudioTimecode( long milliseconds )
058    {
059                this.milliseconds = milliseconds;
060    }
061        
062        /**
063         *  {@inheritDoc}
064         *  @see org.openimaj.time.Timecode#getTimecodeInMilliseconds()
065         */
066        @Override
067        public long getTimecodeInMilliseconds()
068        {
069                return milliseconds;    
070        }
071
072        /**
073         *  {@inheritDoc}
074         *  @see org.openimaj.time.Timecode#setTimecodeInMilliseconds(long)
075         */
076        @Override
077        public void setTimecodeInMilliseconds( long timeInMilliseconds )
078        {
079                this.milliseconds = timeInMilliseconds;
080        }
081        
082        /**
083         *  {@inheritDoc}
084         *  @see java.lang.Object#toString()
085         */
086        @Override
087        public String toString()
088        {
089            return "AudioTimecode: "+this.milliseconds;
090        }
091        
092        /**
093         *  {@inheritDoc}
094         */
095        @Override
096        public AudioTimecode clone()
097        {
098                return new AudioTimecode( milliseconds );
099        }
100}