FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavcodec/encode.h
Date: 2026-08-14 09:18:33
Exec Total Coverage
Lines: 7 9 77.8%
Functions: 2 2 100.0%
Branches: 2 4 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/opt.h"
25 #include "libavutil/dict.h"
26 #include "libavutil/frame.h"
27
28 #include "avcodec.h"
29 #include "packet.h"
30
31 /**
32 * Used by some encoders as upper bound for the length of headers.
33 * TODO: Use proper codec-specific upper bounds.
34 */
35 #define FF_INPUT_BUFFER_MIN_SIZE 16384
36
37 /**
38 * Called by encoders to get the next frame for encoding.
39 *
40 * @param frame An empty frame to be filled with data.
41 * @return 0 if a new reference has been successfully written to frame
42 * AVERROR(EAGAIN) if no data is currently available
43 * AVERROR_EOF if end of stream has been reached, so no more data
44 * will be available
45 */
46 int ff_encode_get_frame(AVCodecContext *avctx, AVFrame *frame);
47
48 /**
49 * Get a buffer for a packet. This is a wrapper around
50 * AVCodecContext.get_encode_buffer() and should be used instead calling get_encode_buffer()
51 * directly.
52 */
53 int ff_get_encode_buffer(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int flags);
54
55 /**
56 * Allocate buffers for a frame. Encoder equivalent to ff_get_buffer().
57 */
58 int ff_encode_alloc_frame(AVCodecContext *avctx, AVFrame *frame);
59
60 /**
61 * Check AVPacket size and allocate data.
62 *
63 * Encoders of type FF_CODEC_CB_TYPE_ENCODE can use this as a convenience to
64 * obtain a big enough buffer for the encoded bitstream.
65 *
66 * @param avctx the AVCodecContext of the encoder
67 * @param avpkt The AVPacket: on success, avpkt->data will point to a buffer
68 * of size at least `size`; the packet will not be refcounted.
69 * This packet must be initially blank.
70 * @param size an upper bound of the size of the packet to encode
71 * @return non negative on success, negative error code on failure
72 */
73 int ff_alloc_packet(AVCodecContext *avctx, AVPacket *avpkt, int64_t size);
74
75 /**
76 * Propagate user opaque values from the frame to avctx/pkt as needed.
77 */
78 int ff_encode_reordered_opaque(AVCodecContext *avctx,
79 AVPacket *pkt, const AVFrame *frame);
80
81 int ff_encode_encode_cb(AVCodecContext *avctx, AVPacket *avpkt,
82 AVFrame *frame, int *got_packet);
83
84 int ff_encode_reconf_parse_dict(AVCodecContext *avctx, AVDictionary **dict);
85
86 /**
87 * Add a CPB properties side data to an encoding context.
88 */
89 AVCPBProperties *ff_encode_add_cpb_side_data(AVCodecContext *avctx);
90
91 int ff_encode_add_stats_side_data(AVPacket *pkt, int quality, const int64_t error[],
92 int error_count, enum AVPictureType pict_type);
93
94 /**
95 * Rescale from sample rate to AVCodecContext.time_base.
96 */
97 395497 static av_always_inline int64_t ff_samples_to_time_base(const AVCodecContext *avctx,
98 int64_t samples)
99 {
100
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 395497 times.
395497 if (samples == AV_NOPTS_VALUE)
101 return AV_NOPTS_VALUE;
102 395497 return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
103 avctx->time_base);
104 }
105
106 /**
107 * Rescale from time base to AVCodecContext.sample_rate.
108 */
109 108 static av_always_inline int64_t ff_samples_from_time_base(const AVCodecContext *avctx,
110 int64_t duration)
111 {
112
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 108 times.
108 if (!duration)
113 return duration;
114 108 return av_rescale_q(duration, avctx->time_base,
115 108 (AVRational){ 1, avctx->sample_rate });
116 }
117
118 /**
119 * Check if the elements of codec context matrices (intra_matrix, inter_matrix or
120 * chroma_intra_matrix) are within the specified range.
121 */
122 #define FF_MATRIX_TYPE_INTRA (1U << 0)
123 #define FF_MATRIX_TYPE_INTER (1U << 1)
124 #define FF_MATRIX_TYPE_CHROMA_INTRA (1U << 2)
125 int ff_check_codec_matrices(AVCodecContext *avctx, unsigned types, uint16_t min, uint16_t max);
126
127 #endif /* AVCODEC_ENCODE_H */
128