trunk contents moved to root

libsrc/avi/src/org/monte/media/Codec.java

@@ -0,0 +1,73 @@
+/*
+ * To change this template, choose Tools | Templates
+ * and open the template in the editor.
+ */
+package org.monte.media;
+
+/**
+ * A {@code Codec} processes a {@code Buffer} and stores the result in another
+ * {@code Buffer}.
+ *
+ * @author Werner Randelshofer
+ * @version 1.0 2011-03-12 Created.
+ */
+public interface Codec {
+
+    /** The codec successfully converted the input to output. */
+    public final static int CODEC_OK = 0;
+    /** The codec could not handle the input. */
+    public final static int CODEC_FAILED = 1;
+    /** The codec did not fully consume the input buffer. 
+     * The codec has updated the input buffer to
+     * reflect the amount of data that it has processed. 
+     * The codec must be called again with the same input buffer.     
+     */
+    public final static int CODEC_INPUT_NOT_CONSUMED = 2;
+    /** The codec did not fully fill the output buffer. 
+     * The codec has updated the output buffer to
+     * reflect the amount of data that it has processed. 
+     * The codec must be called again with the same output buffer.     
+     */
+    public final static int CODEC_OUTPUT_NOT_FILLED = 4;
+
+    /** Lists all of the input formats that this codec accepts. */
+    public Format[] getInputFormats();
+
+    /** Lists all of the output formats that this codec can generate
+     * with the provided input format. If the input format is null, returns
+     * all supported output formats.
+     */
+    public Format[] getOutputFormats(Format input);
+
+    /** Sets the input format.
+     * Returns the format that was actually set. This is the closest format
+     * that the Codec supports. Returns null if the specified format is not
+     * supported and no reasonable match could be found.
+     */
+    public Format setInputFormat(Format input);
+
+    public Format getInputFormat();
+
+    /** Sets the output format.
+     * Returns the format that was actually set. This is the closest format
+     * that the Codec supports. Returns null if the specified format is not
+     * supported and no reasonable match could be found.
+     */
+    public Format setOutputFormat(Format output);
+
+    public Format getOutputFormat();
+
+    /** Performs the media processing defined by this codec. 
+     * <p>
+     * Copies the data from the input buffer into the output buffer.
+     * 
+     * @return A combination of processing flags.
+     */
+    public int process(Buffer in, Buffer out);
+
+    /** Returns a human readable name of the codec. */
+    public String getName();
+
+    /** Resets the state of the codec. */
+    public void reset();
+}