FFmpeg: libavfilter/vf_tonemap.c Source File
Go to the documentation of this file. 1 /*
2 * Copyright (c) 2017 Vittorio Giovara <vittorio.giovara@gmail.com>
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 * tonemap algorithms
24 */
25
27 #include <stdio.h>
28
36
41
51 };
52
55
60
63
65 {
67
72 break;
75 s->param = (1.0f -
s->param) /
s->param;
76 break;
80 break;
81 }
82
85
86 return 0;
87 }
88
90 {
91 float a = 0.15f,
b = 0.50f,
c = 0.10f, d = 0.20f, e = 0.02f,
f = 0.30f;
92 return (in * (in *
a +
b *
c) + d * e) / (in * (in *
a +
b) + d *
f) - e /
f;
93 }
94
95 static float mobius(
float in,
float j,
double peak)
96 {
98
99 if (in <= j)
100 return in;
101
102 a = -j * j * (peak - 1.0f) / (j * j - 2.0
f * j + peak);
103 b = (j * j - 2.0f * j * peak + peak) /
FFMAX(peak - 1.0
f, 1e-6);
104
105 return (
b *
b + 2.0
f *
b * j + j * j) / (
b -
a) * (in +
a) / (in +
b);
106 }
107
108 #define MIX(x,y,a) (x) * (1 - (a)) + (y) * (a)
111 {
112 int map[3] = {
desc->comp[0].plane,
desc->comp[1].plane,
desc->comp[2].plane };
116 float *r_out = (
float *)(
out->data[
map[0]] + x *
desc->comp[
map[0]].step + y *
out->linesize[
map[0]]);
117 float *g_out = (
float *)(
out->data[
map[1]] + x *
desc->comp[
map[1]].step + y *
out->linesize[
map[1]]);
118 float *b_out = (
float *)(
out->data[
map[2]] + x *
desc->comp[
map[2]].step + y *
out->linesize[
map[2]]);
119 float sig, sig_orig;
120
121 /* load values */
122 *r_out = *r_in;
123 *g_out = *g_in;
124 *b_out = *b_in;
125
126 /* desaturate to prevent unnatural colors */
128 float luma =
av_q2d(
s->coeffs->cr) * *r_in +
av_q2d(
s->coeffs->cg) * *g_in +
av_q2d(
s->coeffs->cb) * *b_in;
129 float overbright =
FFMAX(luma -
s->desat, 1e-6) /
FFMAX(luma, 1e-6);
130 *r_out =
MIX(*r_in, luma, overbright);
131 *g_out =
MIX(*g_in, luma, overbright);
132 *b_out =
MIX(*b_in, luma, overbright);
133 }
134
135 /* pick the brightest component, reducing the value range as necessary
136 * to keep the entire signal in range and preventing discoloration due to
137 * out-of-bounds clipping */
139 sig_orig = sig;
140
142 default:
144 // do nothing
145 break;
147 sig = sig *
s->param / peak;
148 break;
150 sig = sig > 0.05f ? pow(sig / peak, 1.0
f /
s->param)
151 : sig * pow(0.05
f / peak, 1.0
f /
s->param) / 0.05f;
152 break;
155 break;
158 break;
160 sig = sig / (sig +
s->param) * (peak +
s->param) / peak;
161 break;
163 sig =
mobius(sig,
s->param, peak);
164 break;
165 }
166
167 /* apply the computed scale factor to the color,
168 * linearly to prevent discoloration */
169 *r_out *= sig / sig_orig;
170 *g_out *= sig / sig_orig;
171 *b_out *= sig / sig_orig;
172 }
173
179
181 {
189 double peak = td->
peak;
190
192 for (
int x = 0; x <
out->width; x++)
194
195 return 0;
196 }
197
199 {
208 double peak =
s->peak;
209
210 if (!
desc || !odesc) {
213 }
214
219 }
220
226 }
227
228 /* input and output transfer will be linear */
234
235 /* read peak from side data if not passed in */
236 if (!peak) {
239 }
240
241 /* load original color space even if pixel format is RGB to compute overbrights */
251 }
252
253 /* do the tone map */
260
261 /* copy/generate alpha if needed */
265 out->linesize[3], outlink->
h);
267 for (y = 0; y <
out->height; y++) {
268 for (x = 0; x <
out->width; x++) {
271 }
272 }
273 }
274
276
278
280 }
281
282 #define OFFSET(x) offsetof(TonemapContext, x)
283 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM
297 };
298
300
302 {
306 },
307 };
308
312 .p.priv_class = &tonemap_class,
319 };
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
enum AVColorTransferCharacteristic color_trc
#define AV_LOG_WARNING
Something somehow does not look correct.
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
const FFFilter ff_vf_tonemap
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)
@ AVCOL_TRC_LINEAR
"Linear transfer characteristics"
static float hable(float in)
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
enum AVColorSpace colorspace
YUV colorspace type.
#define FILTER_INPUTS(array)
This structure describes decoded (raw) audio or video data.
const struct AVLumaCoefficients * av_csp_luma_coeffs_from_avcsp(enum AVColorSpace csp)
Retrieves the Luma coefficients necessary to construct a conversion matrix from an enum constant desc...
int step
Number of elements between 2 horizontally consecutive pixels.
static const AVOption tonemap_options[]
double ff_determine_signal_peak(AVFrame *in)
const AVPixFmtDescriptor * desc
Struct containing luma coefficients to be used for RGB to YUV/YCoCg, or similar calculations.
static const AVFilterPad tonemap_inputs[]
const char * name
Filter name.
static av_always_inline uint32_t av_float2int(float f)
Reinterpret a float as a 32-bit integer.
A link between two filters.
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
void av_image_copy_plane(uint8_t *dst, int dst_linesize, const uint8_t *src, int src_linesize, int bytewidth, int height)
Copy image plane from src to dst.
static int slice_end(AVCodecContext *avctx, AVFrame *pict, int *got_output)
Handle slice ends.
const char * av_color_space_name(enum AVColorSpace space)
static void tonemap(TonemapContext *s, AVFrame *out, const AVFrame *in, const AVPixFmtDescriptor *desc, int x, int y, double peak)
A filter pad used for either input or output.
const AVFilterPad ff_video_default_filterpad[1]
An AVFilterPad array whose only entry has name "default" and is of type AVMEDIA_TYPE_VIDEO.
@ AV_OPT_TYPE_DOUBLE
Underlying C type is double.
static double av_q2d(AVRational a)
Convert an AVRational to a double.
static int tonemap_slice(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
#define AV_PIX_FMT_FLAG_ALPHA
The pixel format has an alpha channel.
#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
static av_cold int init(AVFilterContext *ctx)
Describe the class of an AVClass context structure.
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
uint64_t flags
Combination of AV_PIX_FMT_FLAG_...
Undefined Behavior In the C some operations are like signed integer dereferencing freed accessing outside allocated Undefined Behavior must not occur in a C it is not safe even if the output of undefined operations is unused The unsafety may seem nit picking but Optimizing compilers have in fact optimized code on the assumption that no undefined Behavior occurs Optimizing code based on wrong assumptions can and has in some cases lead to effects beyond the output of computations The signed integer overflow problem in speed critical code Code which is highly optimized and works with signed integers sometimes has the problem that often the output of the computation does not c
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
#define AV_PIX_FMT_GBRPF32
int format
agreed upon media format
void ff_update_hdr_metadata(AVFrame *in, double peak)
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames,...
The reader does not expect b to be semantically here and if the code is changed by maybe adding a a division or other the signedness will almost certainly be mistaken To avoid this confusion a new type was SUINT is the C unsigned type but it holds a signed int to use the same example SUINT a
AVFILTER_DEFINE_CLASS(tonemap)
int w
agreed upon image width
int ff_filter_get_nb_threads(AVFilterContext *ctx)
Get number of threads for current filter instance.
Used for passing data between threads.
const char * name
Pad name.
#define FILTER_PIXFMTS(...)
static int slice_start(SliceContext *sc, VVCContext *s, VVCFrameContext *fc, const CodedBitstreamUnit *unit, const int is_first_slice)
static float mobius(float in, float j, double peak)
int h
agreed upon image height
int ff_filter_execute(AVFilterContext *ctx, avfilter_action_func *func, void *arg, int *ret, int nb_jobs)
@ AV_OPT_TYPE_INT
Underlying C type is int.
#define AV_PIX_FMT_GBRAPF32
AVComponentDescriptor comp[4]
Parameters that describe how pixels are packed.
#define AVFILTER_FLAG_SLICE_THREADS
The filter supports multithreading by splitting frames into multiple parts and processing them concur...
AVFilter p
The public AVFilter.
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
const VDPAUPixFmtMap * map
enum TonemapAlgorithm tonemap
const AVLumaCoefficients * coeffs
#define AVERROR_BUG
Internal bug, also see AVERROR_BUG2.
int linesize[AV_NUM_DATA_POINTERS]
For video, a positive or negative value, which is typically indicating the size in bytes of each pict...
static int filter_frame(AVFilterLink *link, AVFrame *in)
@ AV_OPT_TYPE_CONST
Special option type for declaring named constants.
Generated on Tue Nov 18 2025 19:23:18 for FFmpeg by
doxygen
1.8.17