1/* 2 * generic encoding-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_ENCODE_H 22#define AVCODEC_ENCODE_H 23 24#include "libavutil/frame.h" 25 26#include "avcodec.h" 27#include "packet.h" 28 29/** 30 * Called by encoders to get the next frame for encoding. 31 * 32 * @param frame An empty frame to be filled with data. 33 * @return 0 if a new reference has been successfully written to frame 34 * AVERROR(EAGAIN) if no data is currently available 35 * AVERROR_EOF if end of stream has been reached, so no more data 36 * will be available 37 */ 38int ff_encode_get_frame(AVCodecContext *avctx, AVFrame *frame); 39 40/** 41 * Get a buffer for a packet. This is a wrapper around 42 * AVCodecContext.get_encode_buffer() and should be used instead calling get_encode_buffer() 43 * directly. 44 */ 45int ff_get_encode_buffer(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int flags); 46 47/** 48 * Allocate buffers for a frame. Encoder equivalent to ff_get_buffer(). 49 */ 50int ff_encode_alloc_frame(AVCodecContext *avctx, AVFrame *frame); 51 52/** 53 * Check AVPacket size and allocate data. 54 * 55 * Encoders supporting FFCodec.encode2() can use this as a convenience to 56 * obtain a big enough buffer for the encoded bitstream. 57 * 58 * @param avctx the AVCodecContext of the encoder 59 * @param avpkt The AVPacket: on success, avpkt->data will point to a buffer 60 * of size at least `size`; the packet will not be refcounted. 61 * This packet must be initially blank. 62 * @param size an upper bound of the size of the packet to encode 63 * @return non negative on success, negative error code on failure 64 */ 65int ff_alloc_packet(AVCodecContext *avctx, AVPacket *avpkt, int64_t size); 66 67/* 68 * Perform encoder initialization and validation. 69 * Called when opening the encoder, before the FFCodec.init() call. 70 */ 71int ff_encode_preinit(AVCodecContext *avctx); 72 73#endif /* AVCODEC_ENCODE_H */ 74