org.libav.IEncoder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jlibav Show documentation

Java wrapper for Libav

There is a newer version: 0.2.1

/*
 * Copyright (C) 2012 Ondrej Perutka
 *
 * This program is free software: you can redistribute it and/or 
 * modify it under the terms of the GNU Lesser General Public 
 * License as published by the Free Software Foundation, either 
 * version 3 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public 
 * License along with this library. If not, see 
 * .
 */
package org.libav;

import org.libav.avcodec.ICodecContextWrapper;
import org.libav.avformat.IStreamWrapper;
import org.libav.data.IFrameConsumer;
import org.libav.data.IPacketProducer;

/**
 * Encoder interface.
 * 
 * @author Ondrej Perutka
 */
public interface IEncoder extends IFrameConsumer, IPacketProducer {
    
    /**
     * Get encoding codec context.
     * 
     * You may use the codec context to affect the quality of the stream
     * (bitrate, ...)
     * 
     * @return encoding codec context
     */
    ICodecContextWrapper getCodecContext();
    
    /**
     * Get underlaying stream.
     * 
     * @return underlaying stream
     */
    IStreamWrapper getStream();
    
    /**
     * Close the encoder.
     */
    void close();
    
    /**
     * Check whether the encoder has been closed.
     * 
     * @return true if the encoder has been closed, false otherwise
     */
    boolean isClosed();
    
    /**
     * Flush the encoder. (Call this at the end of encoding process.)
     * 
     * @throws LibavException if an error occurs
     */
    void flush() throws LibavException;
    
}