org.yamcs.tctm.RawFrameDecoder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yamcs-core Show documentation

There is a newer version: 5.10.9

package org.yamcs.tctm;

/**
 * 
 * Decodes raw frames performing derandomization and error correction.
 * 
 * We assume the all frames are of pre-configured fixed length.
 */
public interface RawFrameDecoder {
    /**
     * Decodes frame in the buffer at offset. The decoded frame is stored in the same buffer.
     * 
     * Returns the length of the decoded and corrected frame or -1 if the frame could not be decoded
     */
    int decodeFrame(byte[] data, int offset, int length);

    /**
     * Returns the length of the encoded (input) frame or -1 if it can be variable
     * 
     * @return
     */
    int encodedFrameLength();

    /**
     * Returns the length of the decoded frame or -1 if it can be variable
     * 
     * @return
     */
    int decodedFrameLength();

}