git.sesse.net Git - ffmpeg/blob - libavcodec/decode.h

   1 /*
   2  * generic decoding-related code
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef AVCODEC_DECODE_H
  22 #define AVCODEC_DECODE_H
  23
  24 #include "libavutil/buffer.h"
  25 #include "libavutil/frame.h"
  26
  27 #include "avcodec.h"
  28
  29 /**
  30  * This struct stores per-frame lavc-internal data and is attached to it via
  31  * private_ref.
  32  */
  33 typedef struct FrameDecodeData {
  34     /**
  35      * The callback to perform some delayed processing on the frame right
  36      * before it is returned to the caller.
  37      *
  38      * @note This code is called at some unspecified point after the frame is
  39      * returned from the decoder's decode/receive_frame call. Therefore it cannot rely
  40      * on AVCodecContext being in any specific state, so it does not get to
  41      * access AVCodecContext directly at all. All the state it needs must be
  42      * stored in the post_process_opaque object.
  43      */
  44     int (*post_process)(void *logctx, AVFrame *frame);
  45     void *post_process_opaque;
  46     void (*post_process_opaque_free)(void *opaque);
  47
  48     /**
  49      * Per-frame private data for hwaccels.
  50      */
  51     void *hwaccel_priv;
  52     void (*hwaccel_priv_free)(void *priv);
  53 } FrameDecodeData;
  54
  55 /**
  56  * Called by decoders to get the next packet for decoding.
  57  *
  58  * @param pkt An empty packet to be filled with data.
  59  * @return 0 if a new reference has been successfully written to pkt
  60  *         AVERROR(EAGAIN) if no data is currently available
  61  *         AVERROR_EOF if and end of stream has been reached, so no more data
  62  *                     will be available
  63  */
  64 int ff_decode_get_packet(AVCodecContext *avctx, AVPacket *pkt);
  65
  66 void ff_decode_bsfs_uninit(AVCodecContext *avctx);
  67
  68 int ff_attach_decode_data(AVFrame *frame);
  69
  70 #endif /* AVCODEC_DECODE_H */