FFmpeg/libavcodec/avcodec_internal.h

/*
 * This file is part of FFmpeg.
 *
 * FFmpeg 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 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg 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 FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/*
 * APIs internal to the generic codec layer.
 *
 * MUST NOT be included by individual encoders or decoders.
 */

#ifndef AVCODEC_AVCODEC_INTERNAL_H
#define AVCODEC_AVCODEC_INTERNAL_H

#include "libavutil/frame.h"

#include "packet.h"

struct AVCodecContext;

typedef struct SideDataMap {
    enum AVPacketSideDataType packet;
    enum AVFrameSideDataType frame;
} SideDataMap;

/**
 * A map between packet and frame side data types.
 * Terminated with an entry where packet=AV_PKT_DATA_NB.
 */
extern const SideDataMap ff_sd_global_map[];

/**
 * avcodec_receive_frame() implementation for decoders.
 */
int ff_decode_receive_frame(struct AVCodecContext *avctx, struct AVFrame *frame);

/**
 * avcodec_receive_frame() implementation for encoders.
 */
int ff_encode_receive_frame(struct AVCodecContext *avctx, struct AVFrame *frame);

/*
 * Perform encoder initialization and validation.
 * Called when opening the encoder, before the FFCodec.init() call.
 */
int ff_encode_preinit(struct AVCodecContext *avctx);

/**
 * Perform decoder initialization and validation.
 * Called when opening the decoder, before the FFCodec.init() call.
 */
int ff_decode_preinit(struct AVCodecContext *avctx);

void ff_decode_flush_buffers(struct AVCodecContext *avctx);
void ff_encode_flush_buffers(struct AVCodecContext *avctx);

struct AVCodecInternal *ff_decode_internal_alloc(void);
void ff_decode_internal_sync(struct AVCodecContext *dst,
                             const struct AVCodecContext *src);
void ff_decode_internal_uninit(struct AVCodecContext *avctx);

struct AVCodecInternal *ff_encode_internal_alloc(void);

void ff_codec_close(struct AVCodecContext *avctx);

int ff_thread_init(struct AVCodecContext *s);
void ff_thread_free(struct AVCodecContext *s);

/**
 * Wait for decoding threads to finish and reset internal state.
 * Called by avcodec_flush_buffers().
 *
 * @param avctx The context.
 */
void ff_thread_flush(struct AVCodecContext *avctx);

/**
 * Submit available packets for decoding to worker threads, return a
 * decoded frame if available. Returns AVERROR(EAGAIN) if none is available.
 *
 * Parameters are the same as FFCodec.receive_frame.
 */
int ff_thread_receive_frame(struct AVCodecContext *avctx, AVFrame *frame);

/**
 * Do the actual decoding and obtain a decoded frame from the decoder, if
 * available. When frame threading is used, this is invoked by the worker
 * threads, otherwise by the top layer directly.
 */
int ff_decode_receive_frame_internal(struct AVCodecContext *avctx, AVFrame *frame);

/**
 * Get a packet for decoding. This gets invoked by the worker threads.
 */
int ff_thread_get_packet(struct AVCodecContext *avctx, AVPacket *pkt);

#endif // AVCODEC_AVCODEC_INTERNAL_H