Module org.monte.media
Package org.monte.media.avi

Class AVIOutputStream

java.lang.Object
org.monte.media.avi.AbstractAVIStream
org.monte.media.avi.AVIOutputStream
Direct Known Subclasses:
AVIWriter
public class AVIOutputStream extends AbstractAVIStream
Provides low-level support for writing already encoded audio and video samples into an AVI 1.0 file.

The length of an AVI 1.0 file is limited to 1 GB. This class supports lengths of up to 4 GB, but such files may not work on all players.

For detailed information about the AVI 1.0 file format see:
msdn.microsoft.com AVI RIFF
www.microsoft.com FOURCC for Video Compression
www.saettler.com RIFF

Author:
Werner Randelshofer

  • Field Details

  • Constructor Details

  • Method Details

    • addVideoTrack

      public int addVideoTrack(String fccHandler, long scale, long rate, int width, int height, int depth, int syncInterval) throws IOException
      Adds a video track.
      Parameters:
      fccHandler - The 4-character code of the format.
      scale - The numerator of the sample rate.
      rate - The denominator of the sample rate.
      width - The width of a video image. Must be greater than 0.
      height - The height of a video image. Must be greater than 0.
      depth - The number of bits per pixel. Must be greater than 0.
      syncInterval - Interval for sync-samples. 0=automatic. 1=all frames are keyframes. Values larger than 1 specify that for every n-th frame is a keyframe.
      Returns:
      Returns the track index.
      Throws:
      IllegalArgumentException - if the width or the height is smaller than 1.
      IOException

    • addAudioTrack

      public int addAudioTrack(int waveFormatTag, long scale, long rate, int numberOfChannels, int sampleSizeInBits, boolean isCompressed, int frameDuration, int frameSize) throws IOException
      Adds an audio track.
      Parameters:
      waveFormatTag - The format of the audio stream given in MMREG.H, for example 0x0001 for WAVE_FORMAT_PCM.
      scale - The numerator of the sample rate.
      rate - The denominator of the sample rate.
      numberOfChannels - The number of channels: 1 for mono, 2 for stereo.
      sampleSizeInBits - The number of bits in a sample: 8 or 16.
      isCompressed - Whether the sound is compressed.
      frameDuration - The frame duration, expressed in the media’s timescale, where the timescale is equal to the sample rate. For uncompressed formats, this field is always 1.
      frameSize - For uncompressed audio, the number of bytes in a sample for a single channel (sampleSize divided by 8). For compressed audio, the number of bytes in a frame.
      Returns:
      Returns the track index.
      Throws:
      IllegalArgumentException - if the format is not 4 characters long, if the time scale is not between 1 and 2^32, if the integer portion of the sampleRate is not equal to the scale, if numberOfChannels is not 1 or 2.
      IOException

    • setPalette

      public void setPalette(int track, ColorModel palette)
      Sets the global color palette.

    • getVideoDimension

      public Dimension getVideoDimension(int track)
      Gets the dimension of a track.

    • putExtraHeader

      public void putExtraHeader(int track, String fourcc, byte[] data) throws IOException
      Returns the contents of the extra track header. Returns null if the header is not present.

      Note: this method can only be performed before media data has been written into the tracks.

      Parameters:
      track -
      fourcc -
      data - the extra header as a byte array
      Throws:
      IOException

    • getExtraHeaderFourCCs

      public String[] getExtraHeaderFourCCs(int track) throws IOException
      Returns the fourcc's of all extra stream headers.
      Parameters:
      track -
      Returns:
      An array of fourcc's of all extra stream headers.
      Throws:
      IOException

    • setName

      public void setName(int track, String name)

    • setCompressionQuality

      public void setCompressionQuality(int track, float newValue)
      Sets the compression quality of a track.

      A value of 0 stands for "high compression is important" a value of 1 for "high image quality is important".

      Changing this value affects the encoding of video frames which are subsequently written into the track. Frames which have already been written are not changed.

      This value has no effect on videos encoded with lossless encoders such as the PNG format.

      The default value is 0.97.

      Parameters:
      newValue -

    • getCompressionQuality

      public float getCompressionQuality(int track)
      Returns the compression quality of a track.
      Returns:
      compression quality

    • ensureStarted

      protected void ensureStarted() throws IOException
      Sets the state of the QuickTimeOutpuStream to started.

      If the state is changed by this method, the prolog is written.

      Throws:
      IOException

    • ensureFinished

      protected void ensureFinished() throws IOException
      Sets the state of the QuickTimeOutpuStream to finished.

      If the state is changed by this method, the prolog is written.

      Throws:
      IOException

    • writePalette

      public void writePalette(int track, byte[] data, int off, int len, boolean isKeyframe) throws IOException
      Writes an already encoded palette change into the specified track.

      If a track contains palette changes, then all key frames must be immediately preceeded by a palette change chunk which also is a key frame. If a key frame is not preceeded by a key frame palette change chunk, it will be downgraded to a delta frame.

      Throws:
      IllegalArgumentException - if the track is not a video track.
      IOException

    • writeSample

      public void writeSample(int track, File file, boolean isKeyframe) throws IOException
      Writes an already encoded sample from a file to the specified track.

      This method does not inspect the contents of the file. For example, Its your responsibility to only append JPG files if you have chosen the JPEG video format.

      If you append all frames from files or from input streams, then you have to explicitly set the dimension of the video track before you call finish() or close().

      Parameters:
      file - The file which holds the sample data.
      Throws:
      IllegalStateException - if the duration is less than 1.
      IOException - if writing the sample data failed.

    • writeSample

      public void writeSample(int track, InputStream in, boolean isKeyframe) throws IOException
      Writes an already encoded sample from an input stream to the specified track.

      This method does not inspect the contents of the file. For example, its your responsibility to only append JPG files if you have chosen the JPEG video format.

      If you append all frames from files or from input streams, then you have to explicitly set the dimension of the video track before you call finish() or close().

      Parameters:
      track - The track number.
      in - The input stream which holds the sample data.
      isKeyframe - True if the sample is a key frame.
      Throws:
      IllegalArgumentException - if the duration is less than 1.
      IOException - if writing the sample data failed.

    • writeSample

      public void writeSample(int track, byte[] data, int off, int len, boolean isKeyframe) throws IOException
      Writes an already encoded sample from a byte array into a track.

      This method does not inspect the contents of the samples. The contents has to match the format and dimensions of the media in this track.

      If a track contains palette changes, then all key frames must be immediately preceeded by a palette change chunk. If a key frame is not preceeded by a palette change chunk, it will be downgraded to a delta frame.

      Parameters:
      track - The track index.
      data - The encoded sample data.
      off - The startTime offset in the data.
      len - The number of bytes to write.
      isKeyframe - Whether the sample is a sync sample (keyframe).
      Throws:
      IllegalArgumentException - if the duration is less than 1.
      IOException - if writing the sample data failed.

    • writeSamples

      public void writeSamples(int track, int sampleCount, byte[] data, int off, int len, boolean isKeyframe) throws IOException
      Writes multiple already encoded samples from a byte array into a track.

      This method does not inspect the contents of the data. The contents has to match the format and dimensions of the media in this track.

      Parameters:
      track - The track index.
      sampleCount - The number of samples.
      data - The encoded sample data.
      off - The startTime offset in the data.
      len - The number of bytes to write. Must be dividable by sampleCount.
      isKeyframe - Whether the samples are sync samples. All samples must either be sync samples or non-sync samples.
      Throws:
      IllegalArgumentException - if the duration is less than 1.
      IOException - if writing the sample data failed.

    • getMediaDuration

      public long getMediaDuration(int track)
      Returns the duration of the track in media time scale units.
      Parameters:
      track - track number
      Returns:
      duration in time scale units

    • close

      public void close() throws IOException
      Closes the stream.
      Throws:
      IOException - if an I/O error has occurred

    • finish

      public void finish() throws IOException
      Finishes writing the contents of the AVI output stream without closing the underlying stream. Use this method when applying multiple filters in succession to the same output stream.
      Throws:
      IllegalStateException - if the dimension of the video track has not been specified or determined yet.
      IOException - if an I/O exception has occurred

    • isDataLimitReached

      public boolean isDataLimitReached()
      Returns true if the limit for media samples has been reached. If this limit is reached, no more samples should be added to the movie.

      AVI 1.0 files have a file size limit of 2 GB. This method returns true if a file size of 1.8 GB has been reached.