org.red5.codec.IVideoStreamCodec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of red5-io Show documentation
The Red5 I/O library
There is a newer version: 2.0.15
/*
 * RED5 Open Source Media Server - https://github.com/Red5/ Copyright 2006-2023 by respective authors (see below). All rights reserved. Licensed under the Apache License, Version
 * 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless
 * required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language governing permissions and limitations under the License.
 */

package org.red5.codec;

import org.apache.mina.core.buffer.IoBuffer;

/**
 * Represents a Video codec and its associated decoder configuration.
 */
public interface IVideoStreamCodec {

    /**
     * FLV frame marker constant
     */
    static final byte FLV_FRAME_KEY = 0x10;

    /**
     * @return the codec type.
     */
    VideoCodec getCodec();

    /**
     * @return the name of the video codec.
     */
    String getName();

    /**
     * Reset the codec to its initial state.
     */
    void reset();

    /**
     * Check if the codec supports frame dropping.
     *
     * @return if the codec supports frame dropping.
     */
    boolean canDropFrames();

    /**
     * Returns true if the codec knows how to handle the passed stream data.
     *
     * @param data
     *            some sample data to see if this codec can handle it
     * @return can this code handle the data.
     */
    boolean canHandleData(IoBuffer data);

    /**
     * Update the state of the codec with the passed data.
     *
     * @param data
     *            data to tell the codec we're adding
     * @return true for success. false for error
     */
    boolean addData(IoBuffer data);

    /**
     * Update the state of the codec with the passed data.
     *
     * @param data
     *            data to tell the codec we're adding
     * @param timestamp time associated with the data
     * @return true for success. false for error
     */
    boolean addData(IoBuffer data, int timestamp);

    /**
     * Add video data with a time stamp and a flag identifying the content as AMF or not.
     *
     * @param data
     * @param timestamp
     * @param amf if true, data is in AMF format otherwise its most likely from non-AMF source like RTP
     * @return true if data is added and false otherwise
     */
    boolean addData(IoBuffer data, int timestamp, boolean amf);

    /**
     * Returns keyframe data.
     *
     * @return the data for a keyframe
     */
    IoBuffer getKeyframe();

    /**
     * Returns all the keyframe data.
     *
     * @return array of keyframe data
     */
    FrameData[] getKeyframes();

    /**
     * Returns information used to configure the decoder.
     *
     * @return the data for decoder setup
     */
    default IoBuffer getDecoderConfiguration() {
        return null;
    }

    /**
     * Returns the number of interframes collected from last keyframe.
     *
     * @return number of interframes
     */
    int getNumInterframes();

    /**
     * Gets data of interframe with the specified index.
     *
     * @param index
     *            of interframe
     * @return data of the interframe or null if index is not valid
     */
    FrameData getInterframe(int index);

    /**
     * Holder for video frame data.
     */
    public final static class FrameData {

        private byte[] frame;

        private int compTimeOffset;

        public FrameData() {
        }

        public FrameData(IoBuffer data) {
            setData(data);
        }

        public FrameData(IoBuffer data, int compTimeOffset) {
            setData(data);
            this.compTimeOffset = compTimeOffset;
        }

        /**
         * Makes a copy of the incoming bytes and places them in an IoBuffer. No flip or rewind is performed on the
         * source data. Ensure that the data is at the correct position before calling this method.
         *
         * @param data
         *            data
         */
        public void setData(IoBuffer data) {
            if (frame != null) {
                frame = null;
            }
            frame = new byte[data.remaining()];
            data.get(frame);
        }

        public IoBuffer getFrame() {
            return frame == null ? null : IoBuffer.wrap(frame).asReadOnlyBuffer();
        }

        public byte[] getFrameBytes() {
            return frame;
        }

        public int getCompTimeOffset() {
            return compTimeOffset;
        }

    }

    /**
     * Returns true if the codec is enhanced.
     *
     * @return true if enhanced and false otherwise
     */
    default boolean isEnhanced() {
        return false;
    }

    /**
     * Returns the multitrack type for the codec.
     *
     * @return the multitrack type
     */
    default AvMultitrackType getMultitrackType() {
        return null;
    }

    /**
     * Returns the frame type for the codec.
     *
     * @return the frame type
     */
    default VideoFrameType getFrameType() {
        return null;
    }

    /**
     * Returns the packet type for the codec.
     *
     * @return the packet type
     */
    default VideoPacketType getPacketType() {
        return null;
    }

    /**
     * Sets the track id.
     */
    default void setTrackId(int trackId) {
    }

    /**
     * Returns the track id.
     *
     * @return track id
     */
    default int getTrackId() {
        return 0;
    }

}