FFmpeg: libavfilter/vf_crop.c Source File
Go to the documentation of this file. 1 /*
2 * Copyright (c) 2007 Bobby Bingham
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 /**
22 * @file
23 * video crop filter
24 */
25
26 #include <stdio.h>
27
39
41 "in_w", "iw", ///< width of the input video
42 "in_h", "ih", ///< height of the input video
43 "out_w", "ow", ///< width of the cropped video
44 "out_h", "oh", ///< height of the cropped video
45 "a",
46 "sar",
47 "dar",
48 "hsub",
49 "vsub",
50 "x",
51 "y",
52 "n", ///< number of frame
53 "t", ///< timestamp expressed in seconds
55 };
56
72 };
73
76 int x;
///< x offset of the non-cropped area with respect to the input area
77 int y;
///< y offset of the non-cropped area with respect to the input area
78 int w;
///< width of the cropped area
79 int h;
///< height of the cropped area
80
83 int exact;
///< exact cropping, for subsampled formats
84
85 int max_step[4];
///< max pixel step for each plane, expressed as a number of bytes
91
95 {
97
100 }
101
103 {
105
110 }
111
113 {
115
118 } else if (d > INT_MAX || d < INT_MIN) {
119 *n = d > INT_MAX ? INT_MAX : INT_MIN;
121 } else
123
125 }
126
128 {
133 const char *expr;
134 double res;
135
149
151
155 } else {
158 }
159
167 goto fail_expr;
169 /* evaluate again ow as it may depend on oh */
173 goto fail_expr;
174
179 "Too big value or invalid expression for out_w/ow or out_h/oh. "
180 "Maybe the expression for out_w:'%s' or for out_h:'%s' is self-referencing.\n",
181 s->w_expr,
s->h_expr);
183 }
184
186 s->w &= ~((1 <<
s->hsub) - 1);
187 s->h &= ~((1 <<
s->vsub) - 1);
188 }
189
192 s->x_pexpr =
s->y_pexpr =
NULL;
198
199 if (
s->keep_aspect) {
204 } else
206
209 s->w,
s->h,
s->out_sar.num,
s->out_sar.den);
210
211 if (
s->w <= 0 ||
s->h <= 0 ||
214 "Invalid too big or non positive size for width '%d' or height '%d'\n",
217 }
218
219 /* set default, required in the case the first computed value for x/y is NAN */
220 s->x = (
link->w -
s->w) / 2;
221 s->y = (
link->h -
s->h) / 2;
223 s->x &= ~((1 <<
s->hsub) - 1);
224 s->y &= ~((1 <<
s->vsub) - 1);
225 }
226 return 0;
227
228 fail_expr:
231 }
232
234 {
237
239 // Hardware frames adjust the cropping regions rather than
240 // changing the frame size.
241 } else {
244 }
246
247 return 0;
248 }
249
251 {
257
263 /* It is necessary if x is expressed from y */
265
268
273 if ((
unsigned)
s->x + (
unsigned)
s->w >
link->w)
275 if ((
unsigned)
s->y + (
unsigned)
s->h >
link->h)
278 s->x &= ~((1 <<
s->hsub) - 1);
279 s->y &= ~((1 <<
s->vsub) - 1);
280 }
281
284 s->x,
s->y,
s->x+
s->w,
s->y+
s->h);
285
291 } else {
294
296 frame->data[0] +=
s->x *
s->max_step[0];
297
299 for (
i = 1;
i < 3;
i ++) {
302 frame->data[
i] += (
s->x *
s->max_step[
i]) >>
s->hsub;
303 }
304 }
305 }
306
307 /* alpha plane */
308 if (
frame->data[3]) {
310 frame->data[3] +=
s->x *
s->max_step[3];
311 }
312 }
313
315 }
316
318 char *res,
int res_len,
int flags)
319 {
322
323 if ( !strcmp(cmd, "out_w") || !strcmp(cmd, "w")
324 || !strcmp(cmd, "out_h") || !strcmp(cmd, "h")
325 || !strcmp(cmd, "x") || !strcmp(cmd, "y")) {
326
331
334
336
343 }
344
346
347 } else
349
351 }
352
353 #define OFFSET(x) offsetof(CropContext, x)
354 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
355 #define TFLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
356
367 };
368
370
372 {
377 },
378 };
379
381 {
385 },
386 };
387
391 .p.priv_class = &crop_class,
398 };
double var_values[VAR_VARS_NB]
static av_cold void uninit(AVFilterContext *ctx)
Filter the word "frame" indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
int x
x offset of the non-cropped area with respect to the input area
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
The exact code depends on how similar the blocks are and how related they are to the and needs to apply these operations to the correct inlink or outlink if there are several Macros are available to factor that when no extra processing is inlink
int y
y offset of the non-cropped area with respect to the input area
#define FILTER_INPUTS(array)
This structure describes decoded (raw) audio or video data.
int keep_aspect
keep display aspect ratio when cropping
static const AVOption crop_options[]
const FFFilter ff_vf_crop
#define AV_LOG_VERBOSE
Detailed information.
const char * name
Filter name.
A link between two filters.
static int normalize_double(int *n, double d)
int w
width of the cropped area
Link properties exposed to filter code, but not external callers.
int av_expr_parse(AVExpr **expr, const char *s, const char *const *const_names, const char *const *func1_names, double(*const *funcs1)(void *, double), const char *const *func2_names, double(*const *funcs2)(void *, double, double), int log_offset, void *log_ctx)
Parse an expression.
int vsub
chroma subsampling
static int config_output(AVFilterLink *link)
#define AV_PIX_FMT_FLAG_HWACCEL
Pixel format is an HW accelerated format.
int av_opt_set(void *obj, const char *name, const char *val, int search_flags)
int av_reduce(int *dst_num, int *dst_den, int64_t num, int64_t den, int64_t max)
Reduce a fraction.
void av_expr_free(AVExpr *e)
Free a parsed expression previously created with av_expr_parse().
A filter pad used for either input or output.
#define AV_LOG_TRACE
Extremely verbose debugging, useful for libav* development.
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
static double av_q2d(AVRational a)
Convert an AVRational to a double.
static const char *const var_names[]
double av_expr_eval(AVExpr *e, const double *const_values, void *opaque)
Evaluate a previously parsed expression.
uint8_t log2_chroma_w
Amount to shift the luma width right to find the chroma width.
#define FILTER_OUTPUTS(array)
Filter the word "frame" indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a link
Describe the class of an AVClass context structure.
AVFILTER_DEFINE_CLASS(crop)
Rational number (pair of numerator and denominator).
int h
height of the cropped area
uint64_t flags
Combination of AV_PIX_FMT_FLAG_...
static FilterLink * ff_filter_link(AVFilterLink *link)
static int filter_frame(AVFilterLink *link, AVFrame *frame)
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
int av_expr_parse_and_eval(double *d, const char *s, const char *const *const_names, const double *const_values, const char *const *func1_names, double(*const *funcs1)(void *, double), const char *const *func2_names, double(*const *funcs2)(void *, double, double), void *opaque, int log_offset, void *log_ctx)
Parse and evaluate an expression.
#define AV_NOPTS_VALUE
Undefined timestamp value.
AVRational time_base
Time base for the timestamps in this frame.
#define AV_PIX_FMT_FLAG_BITSTREAM
All values of a component are bit-wise packed end to end.
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames,...
int max_step[4]
max pixel step for each plane, expressed as a number of bytes
#define i(width, name, range_min, range_max)
static int config_input(AVFilterLink *link)
static const AVFilterPad avfilter_vf_crop_inputs[]
#define FILTER_QUERY_FUNC2(func)
const char * name
Pad name.
AVRational out_sar
output sample aspect ratio
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
AVRational sample_aspect_ratio
Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
static int query_formats(const AVFilterContext *ctx, AVFilterFormatsConfig **cfg_in, AVFilterFormatsConfig **cfg_out)
int exact
exact cropping, for subsampled formats
AVRational av_mul_q(AVRational b, AVRational c)
Multiply two rationals.
void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4], const AVPixFmtDescriptor *pixdesc)
Compute the max pixel step for each plane of an image with a format described by pixdesc.
AVFilter p
The public AVFilter.
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
@ AV_OPT_TYPE_BOOL
Underlying C type is int.
static const AVFilterPad avfilter_vf_crop_outputs[]
static int process_command(AVFilterContext *ctx, const char *cmd, const char *args, char *res, int res_len, int flags)
@ AV_OPT_TYPE_STRING
Underlying C type is a uint8_t* that is either NULL or points to a C string allocated with the av_mal...
#define AV_PIX_FMT_FLAG_PAL
Pixel format has a palette in data[1], values are indexes in this palette.
uint8_t log2_chroma_h
Amount to shift the luma height right to find the chroma height.
Generated on Tue Nov 18 2025 19:23:09 for FFmpeg by
doxygen
1.8.17