FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavcodec/encode.h
Date: 2022-10-02 18:56:10
Exec Total Coverage
Lines: 3 4 75.0%
Branches: 1 2 50.0%

Line Branch Exec Source
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 * avcodec_receive_frame() implementation for encoders.
31 */
32 int ff_encode_receive_frame(AVCodecContext *avctx, AVFrame *frame);
33
34 /**
35 * Called by encoders to get the next frame for encoding.
36 *
37 * @param frame An empty frame to be filled with data.
38 * @return 0 if a new reference has been successfully written to frame
39 * AVERROR(EAGAIN) if no data is currently available
40 * AVERROR_EOF if end of stream has been reached, so no more data
41 * will be available
42 */
43 int ff_encode_get_frame(AVCodecContext *avctx, AVFrame *frame);
44
45 /**
46 * Get a buffer for a packet. This is a wrapper around
47 * AVCodecContext.get_encode_buffer() and should be used instead calling get_encode_buffer()
48 * directly.
49 */
50 int ff_get_encode_buffer(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int flags);
51
52 /**
53 * Allocate buffers for a frame. Encoder equivalent to ff_get_buffer().
54 */
55 int ff_encode_alloc_frame(AVCodecContext *avctx, AVFrame *frame);
56
57 /**
58 * Check AVPacket size and allocate data.
59 *
60 * Encoders of type FF_CODEC_CB_TYPE_ENCODE can use this as a convenience to
61 * obtain a big enough buffer for the encoded bitstream.
62 *
63 * @param avctx the AVCodecContext of the encoder
64 * @param avpkt The AVPacket: on success, avpkt->data will point to a buffer
65 * of size at least `size`; the packet will not be refcounted.
66 * This packet must be initially blank.
67 * @param size an upper bound of the size of the packet to encode
68 * @return non negative on success, negative error code on failure
69 */
70 int ff_alloc_packet(AVCodecContext *avctx, AVPacket *avpkt, int64_t size);
71
72 /*
73 * Perform encoder initialization and validation.
74 * Called when opening the encoder, before the FFCodec.init() call.
75 */
76 int ff_encode_preinit(AVCodecContext *avctx);
77
78 int ff_encode_encode_cb(AVCodecContext *avctx, AVPacket *avpkt,
79 AVFrame *frame, int *got_packet);
80
81 /**
82 * Rescale from sample rate to AVCodecContext.time_base.
83 */
84 321442 static av_always_inline int64_t ff_samples_to_time_base(const AVCodecContext *avctx,
85 int64_t samples)
86 {
87
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 321442 times.
321442 if (samples == AV_NOPTS_VALUE)
88 return AV_NOPTS_VALUE;
89 321442 return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
90 avctx->time_base);
91 }
92
93 #endif /* AVCODEC_ENCODE_H */
94