ru.sbtqa.monte.media.MovieWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of monte-media
monte-media description
There is a newer version: 1.1.0-JAVA7
/* @(#)MovieWriter.java
 * Copyright © 2011 Werner Randelshofer, Switzerland. 
 * You may only use this software in accordance with the license terms.
 */
package ru.sbtqa.monte.media;

import java.io.IOException;
import ru.sbtqa.monte.media.math.Rational;

/**
 * A simple API for writing movie data (audio and video) into a file.
 *
 * @author Werner Randelshofer
 * @version $Id: MovieWriter.java 364 2016-11-09 19:54:25Z werner $
 */
public interface MovieWriter extends Multiplexer {

    /**
     * Returns the file format.
     *
     * @return TODO
     * @throws java.io.IOException TODO
     */
    public Format getFileFormat() throws IOException;

    /**
     * Adds a track to the writer for a suggested input format.
     * 
     * The format should at least specify the desired
     * {@link FormatKeys.MediaType}. The actual input format is a refined
     * version of the suggested format. For example, if a MovieWriter only
     * supports fixed frame rate video, then the MovieWriter will extend the
     * format with that information.
     * 
     * If the suggested input format is not compatible, then an IOException is
     * thrown. For example, if a MovieWriter only supports fixed frame rate
     * video, but a format with variable frame rate was requested.
     *
     * @param format The desired input format of the track. The actual input
     * format may be a refined version of the specified format.
     * @return The track number.
     * @throws java.io.IOException TODO
     */
    public int addTrack(Format format) throws IOException;

    /**
     * Returns the media format of the specified track. This is a refined
     * version of the format that was requested when the track was added. See
     * {@link #addTrack}.
     *
     * @param track Track number.
     * @return The media format of the track.
     */
    public Format getFormat(int track);

    /**
     * Returns the number of tracks.
     *
     * @return TODO
     */
    public int getTrackCount();

    /**
     * Writes a sample into the specified track. Does nothing if the
     * discard-flag in the buffer is set to true.
     *
     * @param track The track number.
     * @param buf The buffer containing the sample data.
     * @throws java.io.IOException TODO
     */
    @Override
    public void write(int track, Buffer buf) throws IOException;

    /**
     * Closes the writer.
     *
     * @throws java.io.IOException TODO
     */
    @Override
    public void close() throws IOException;

    /**
     * Returns true if the limit for media data has been reached. If this limit
     * is reached, no more samples should be added to the movie.
     * 
     * This limit is imposed by data structures of the movie file which will
     * overflow if more samples are added to the movie.
     * 
     * FIXME - Maybe replace by getCapacity():long.
     *
     * @return TODO
     */
    public boolean isDataLimitReached();

    /**
     * Returns the duration of the track in seconds.
     *
     * @param track TODO
     * @return TODO
     */
    public Rational getDuration(int track);

    /**
     * Returns true if the specified track has no samples.
     *
     * @param track TODO
     * @return TODO
     */
    public boolean isEmpty(int track);
}