FFmpeg
Files | Data Structures | Macros | Functions
libswscale

Color conversion and scaling library. More...

Files

file  swscale.h
 

Data Structures

struct  SwsVector
 
struct  SwsFilter
 

Macros

#define SWS_FAST_BILINEAR   1
 
#define SWS_BILINEAR   2
 
#define SWS_BICUBIC   4
 
#define SWS_X   8
 
#define SWS_POINT   0x10
 
#define SWS_AREA   0x20
 
#define SWS_BICUBLIN   0x40
 
#define SWS_GAUSS   0x80
 
#define SWS_SINC   0x100
 
#define SWS_LANCZOS   0x200
 
#define SWS_SPLINE   0x400
 
#define SWS_SRC_V_CHR_DROP_MASK   0x30000
 
#define SWS_SRC_V_CHR_DROP_SHIFT   16
 
#define SWS_PARAM_DEFAULT   123456
 
#define SWS_PRINT_INFO   0x1000
 
#define SWS_FULL_CHR_H_INT   0x2000
 
#define SWS_FULL_CHR_H_INP   0x4000
 
#define SWS_DIRECT_BGR   0x8000
 
#define SWS_ACCURATE_RND   0x40000
 
#define SWS_BITEXACT   0x80000
 
#define SWS_ERROR_DIFFUSION   0x800000
 
#define SWS_MAX_REDUCE_CUTOFF   0.002
 
#define SWS_CS_ITU709   1
 
#define SWS_CS_FCC   4
 
#define SWS_CS_ITU601   5
 
#define SWS_CS_ITU624   5
 
#define SWS_CS_SMPTE170M   5
 
#define SWS_CS_SMPTE240M   7
 
#define SWS_CS_DEFAULT   5
 
#define SWS_CS_BT2020   9
 

Functions

unsigned swscale_version (void)
 
const char * swscale_configuration (void)
 Return the libswscale build-time configuration. More...
 
const char * swscale_license (void)
 Return the libswscale license. More...
 
const intsws_getCoefficients (int colorspace)
 Return a pointer to yuv<->rgb coefficients for the given colorspace suitable for sws_setColorspaceDetails(). More...
 
int sws_isSupportedInput (enum AVPixelFormat pix_fmt)
 Return a positive value if pix_fmt is a supported input format, 0 otherwise. More...
 
int sws_isSupportedOutput (enum AVPixelFormat pix_fmt)
 Return a positive value if pix_fmt is a supported output format, 0 otherwise. More...
 
int sws_isSupportedEndiannessConversion (enum AVPixelFormat pix_fmt)
 
struct SwsContextsws_alloc_context (void)
 Allocate an empty SwsContext. More...
 
av_warn_unused_result int sws_init_context (struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter)
 Initialize the swscaler context sws_context. More...
 
void sws_freeContext (struct SwsContext *swsContext)
 Free the swscaler context swsContext. More...
 
struct SwsContextsws_getContext (int srcW, int srcH, enum AVPixelFormat srcFormat, int dstW, int dstH, enum AVPixelFormat dstFormat, int flags, SwsFilter *srcFilter, SwsFilter *dstFilter, const double *param)
 Allocate and return an SwsContext. More...
 
int sws_scale (struct SwsContext *c, const uint8_t *const srcSlice[], const int srcStride[], int srcSliceY, int srcSliceH, uint8_t *const dst[], const int dstStride[])
 Scale the image slice in srcSlice and put the resulting scaled slice in the image in dst. More...
 
int sws_scale_frame (struct SwsContext *c, AVFrame *dst, const AVFrame *src)
 Scale source data from src and write the output to dst. More...
 
int sws_frame_start (struct SwsContext *c, AVFrame *dst, const AVFrame *src)
 Initialize the scaling process for a given pair of source/destination frames. More...
 
void sws_frame_end (struct SwsContext *c)
 Finish the scaling process for a pair of source/destination frames previously submitted with sws_frame_start(). More...
 
int sws_send_slice (struct SwsContext *c, unsigned int slice_start, unsigned int slice_height)
 Indicate that a horizontal slice of input data is available in the source frame previously provided to sws_frame_start(). More...
 
int sws_receive_slice (struct SwsContext *c, unsigned int slice_start, unsigned int slice_height)
 Request a horizontal slice of the output data to be written into the frame previously provided to sws_frame_start(). More...
 
unsigned int sws_receive_slice_alignment (const struct SwsContext *c)
 Get the alignment required for slices. More...
 
int sws_setColorspaceDetails (struct SwsContext *c, const int inv_table[4], int srcRange, const int table[4], int dstRange, int brightness, int contrast, int saturation)
 
int sws_getColorspaceDetails (struct SwsContext *c, int **inv_table, int *srcRange, int **table, int *dstRange, int *brightness, int *contrast, int *saturation)
 
SwsVectorsws_allocVec (int length)
 Allocate and return an uninitialized vector with length coefficients. More...
 
SwsVectorsws_getGaussianVec (double variance, double quality)
 Return a normalized Gaussian curve used to filter stuff quality = 3 is high quality, lower is lower quality. More...
 
void sws_scaleVec (SwsVector *a, double scalar)
 Scale all the coefficients of a by the scalar value. More...
 
void sws_normalizeVec (SwsVector *a, double height)
 Scale all the coefficients of a so that their sum equals height. More...
 
void sws_freeVec (SwsVector *a)
 
SwsFiltersws_getDefaultFilter (float lumaGBlur, float chromaGBlur, float lumaSharpen, float chromaSharpen, float chromaHShift, float chromaVShift, int verbose)
 
void sws_freeFilter (SwsFilter *filter)
 
struct SwsContextsws_getCachedContext (struct SwsContext *context, int srcW, int srcH, enum AVPixelFormat srcFormat, int dstW, int dstH, enum AVPixelFormat dstFormat, int flags, SwsFilter *srcFilter, SwsFilter *dstFilter, const double *param)
 Check if context can be reused, otherwise reallocate a new one. More...
 
void sws_convertPalette8ToPacked32 (const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette)
 Convert an 8-bit paletted frame into a frame with a color depth of 32 bits. More...
 
void sws_convertPalette8ToPacked24 (const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette)
 Convert an 8-bit paletted frame into a frame with a color depth of 24 bits. More...
 
const AVClasssws_get_class (void)
 Get the AVClass for swsContext. More...
 

Detailed Description

Color conversion and scaling library.

Return the LIBSWSCALE_VERSION_INT constant.

Macro Definition Documentation

◆ SWS_FAST_BILINEAR

#define SWS_FAST_BILINEAR   1

Definition at line 65 of file swscale.h.

◆ SWS_BILINEAR

#define SWS_BILINEAR   2
Examples
scale_video.c.

Definition at line 66 of file swscale.h.

◆ SWS_BICUBIC

#define SWS_BICUBIC   4

Definition at line 67 of file swscale.h.

◆ SWS_X

#define SWS_X   8

Definition at line 68 of file swscale.h.

◆ SWS_POINT

#define SWS_POINT   0x10

Definition at line 69 of file swscale.h.

◆ SWS_AREA

#define SWS_AREA   0x20

Definition at line 70 of file swscale.h.

◆ SWS_BICUBLIN

#define SWS_BICUBLIN   0x40

Definition at line 71 of file swscale.h.

◆ SWS_GAUSS

#define SWS_GAUSS   0x80

Definition at line 72 of file swscale.h.

◆ SWS_SINC

#define SWS_SINC   0x100

Definition at line 73 of file swscale.h.

◆ SWS_LANCZOS

#define SWS_LANCZOS   0x200

Definition at line 74 of file swscale.h.

◆ SWS_SPLINE

#define SWS_SPLINE   0x400

Definition at line 75 of file swscale.h.

◆ SWS_SRC_V_CHR_DROP_MASK

#define SWS_SRC_V_CHR_DROP_MASK   0x30000

Definition at line 77 of file swscale.h.

◆ SWS_SRC_V_CHR_DROP_SHIFT

#define SWS_SRC_V_CHR_DROP_SHIFT   16

Definition at line 78 of file swscale.h.

◆ SWS_PARAM_DEFAULT

#define SWS_PARAM_DEFAULT   123456

Definition at line 80 of file swscale.h.

◆ SWS_PRINT_INFO

#define SWS_PRINT_INFO   0x1000

Definition at line 82 of file swscale.h.

◆ SWS_FULL_CHR_H_INT

#define SWS_FULL_CHR_H_INT   0x2000

Definition at line 86 of file swscale.h.

◆ SWS_FULL_CHR_H_INP

#define SWS_FULL_CHR_H_INP   0x4000

Definition at line 88 of file swscale.h.

◆ SWS_DIRECT_BGR

#define SWS_DIRECT_BGR   0x8000

Definition at line 89 of file swscale.h.

◆ SWS_ACCURATE_RND

#define SWS_ACCURATE_RND   0x40000

Definition at line 90 of file swscale.h.

◆ SWS_BITEXACT

#define SWS_BITEXACT   0x80000

Definition at line 91 of file swscale.h.

◆ SWS_ERROR_DIFFUSION

#define SWS_ERROR_DIFFUSION   0x800000

Definition at line 92 of file swscale.h.

◆ SWS_MAX_REDUCE_CUTOFF

#define SWS_MAX_REDUCE_CUTOFF   0.002

Definition at line 94 of file swscale.h.

◆ SWS_CS_ITU709

#define SWS_CS_ITU709   1

Definition at line 96 of file swscale.h.

◆ SWS_CS_FCC

#define SWS_CS_FCC   4

Definition at line 97 of file swscale.h.

◆ SWS_CS_ITU601

#define SWS_CS_ITU601   5

Definition at line 98 of file swscale.h.

◆ SWS_CS_ITU624

#define SWS_CS_ITU624   5

Definition at line 99 of file swscale.h.

◆ SWS_CS_SMPTE170M

#define SWS_CS_SMPTE170M   5

Definition at line 100 of file swscale.h.

◆ SWS_CS_SMPTE240M

#define SWS_CS_SMPTE240M   7

Definition at line 101 of file swscale.h.

◆ SWS_CS_DEFAULT

#define SWS_CS_DEFAULT   5

Definition at line 102 of file swscale.h.

◆ SWS_CS_BT2020

#define SWS_CS_BT2020   9

Definition at line 103 of file swscale.h.

Function Documentation

◆ swscale_version()

unsigned swscale_version ( void  )

Definition at line 26 of file version.c.

◆ swscale_configuration()

const char* swscale_configuration ( void  )

Return the libswscale build-time configuration.

Definition at line 32 of file version.c.

◆ swscale_license()

const char* swscale_license ( void  )

Return the libswscale license.

Definition at line 37 of file version.c.

◆ sws_getCoefficients()

const int* sws_getCoefficients ( int  colorspace)

Return a pointer to yuv<->rgb coefficients for the given colorspace suitable for sws_setColorspaceDetails().

Parameters
colorspaceOne of the SWS_CS_* macros. If invalid, SWS_CS_DEFAULT is used.

Definition at line 62 of file yuv2rgb.c.

Referenced by parse_yuv_type().

◆ sws_isSupportedInput()

int sws_isSupportedInput ( enum AVPixelFormat  pix_fmt)

Return a positive value if pix_fmt is a supported input format, 0 otherwise.

Definition at line 329 of file utils.c.

Referenced by sws_init_single_context().

◆ sws_isSupportedOutput()

int sws_isSupportedOutput ( enum AVPixelFormat  pix_fmt)

Return a positive value if pix_fmt is a supported output format, 0 otherwise.

Definition at line 335 of file utils.c.

Referenced by sws_init_single_context().

◆ sws_isSupportedEndiannessConversion()

int sws_isSupportedEndiannessConversion ( enum AVPixelFormat  pix_fmt)
Parameters
[in]pix_fmtthe pixel format
Returns
a positive value if an endianness conversion for pix_fmt is supported, 0 otherwise.

Definition at line 341 of file utils.c.

Referenced by query_formats(), and sws_init_single_context().

◆ sws_alloc_context()

struct SwsContext* sws_alloc_context ( void  )

◆ sws_init_context()

av_warn_unused_result int sws_init_context ( struct SwsContext sws_context,
SwsFilter srcFilter,
SwsFilter dstFilter 
)

◆ sws_freeContext()

void sws_freeContext ( struct SwsContext swsContext)

◆ sws_getContext()

struct SwsContext* sws_getContext ( int  srcW,
int  srcH,
enum AVPixelFormat  srcFormat,
int  dstW,
int  dstH,
enum AVPixelFormat  dstFormat,
int  flags,
SwsFilter srcFilter,
SwsFilter dstFilter,
const double param 
)

Allocate and return an SwsContext.

You need it to perform scaling/conversion operations using sws_scale().

Parameters
srcWthe width of the source image
srcHthe height of the source image
srcFormatthe source image format
dstWthe width of the destination image
dstHthe height of the destination image
dstFormatthe destination image format
flagsspecify which algorithm and options to use for rescaling
paramextra parameters to tune the used scaler For SWS_BICUBIC param[0] and [1] tune the shape of the basis function, param[0] tunes f(1) and param[1] f´(1) For SWS_GAUSS param[0] tunes the exponent and thus cutoff frequency For SWS_LANCZOS param[0] tunes the width of the window function
Returns
a pointer to an allocated context, or NULL in case of error
Note
this function is to be removed after a saner alternative is written
Examples
mux.c, and scale_video.c.

Definition at line 2096 of file utils.c.

Referenced by config_output(), doTest(), ff_frame_to_dnn_classify(), ff_frame_to_dnn_detect(), ff_proc_from_dnn_to_frame(), ff_proc_from_frame_to_dnn(), ff_scale_image(), get_video_frame(), main(), open_filter_param(), prepare_uv_scale(), process_frame(), recon_frame_process(), and sws_init_single_context().

◆ sws_scale()

int sws_scale ( struct SwsContext c,
const uint8_t *const  srcSlice[],
const int  srcStride[],
int  srcSliceY,
int  srcSliceH,
uint8_t *const  dst[],
const int  dstStride[] 
)

Scale the image slice in srcSlice and put the resulting scaled slice in the image in dst.

A slice is a sequence of consecutive rows in an image.

Slices have to be provided in sequential order, either in top-bottom or bottom-top order. If slices are provided in non-sequential order the behavior of the function is undefined.

Parameters
cthe scaling context previously created with sws_getContext()
srcSlicethe array containing the pointers to the planes of the source slice
srcStridethe array containing the strides for each plane of the source image
srcSliceYthe position in the source image of the slice to process, that is the number (counted starting from zero) in the image of the first row of the slice
srcSliceHthe height of the source slice, that is the number of rows in the slice
dstthe array containing the pointers to the planes of the destination image
dstStridethe array containing the strides for each plane of the destination image
Returns
the height of the output slice

Scale the image slice in srcSlice and put the resulting scaled slice in the image in dst.

Assumes planar YUV to be in YUV order instead of YVU.

Definition at line 1205 of file swscale.c.

Referenced by blur(), copy_uv_planes(), doTest(), ff_frame_to_dnn_classify(), ff_frame_to_dnn_detect(), ff_proc_from_dnn_to_frame(), ff_proc_from_frame_to_dnn(), ff_scale_image(), filter_frame(), get_video_frame(), main(), output_single_frame(), process_frame(), video_image_display(), and wrap().

◆ sws_scale_frame()

int sws_scale_frame ( struct SwsContext c,
AVFrame dst,
const AVFrame src 
)

Scale source data from src and write the output to dst.

This is merely a convenience wrapper around

Parameters
cThe scaling context
dstThe destination frame. See documentation for sws_frame_start() for more details.
srcThe source frame.
Returns
0 on success, a negative AVERROR code on failure

Definition at line 1184 of file swscale.c.

Referenced by recon_frame_process(), scale_field(), and scale_frame().

◆ sws_frame_start()

int sws_frame_start ( struct SwsContext c,
AVFrame dst,
const AVFrame src 
)

Initialize the scaling process for a given pair of source/destination frames.

Must be called before any calls to sws_send_slice() and sws_receive_slice().

This function will retain references to src and dst, so they must both use refcounted buffers (if allocated by the caller, in case of dst).

Parameters
cThe scaling context
dstThe destination frame.
       The data buffers may either be already allocated by the caller or
       left clear, in which case they will be allocated by the scaler.
       The latter may have performance advantages - e.g. in certain cases
       some output planes may be references to input planes, rather than
       copies.

       Output data will be written into this frame in successful
       sws_receive_slice() calls.
srcThe source frame. The data buffers must be allocated, but the frame data does not have to be ready at this point. Data availability is then signalled by sws_send_slice().
Returns
0 on success, a negative AVERROR code on failure
See also
sws_frame_end()

Definition at line 1083 of file swscale.c.

Referenced by sws_scale_frame().

◆ sws_frame_end()

void sws_frame_end ( struct SwsContext c)

Finish the scaling process for a pair of source/destination frames previously submitted with sws_frame_start().

Must be called after all sws_send_slice() and sws_receive_slice() calls are done, before any new sws_frame_start() calls.

Parameters
cThe scaling context

Definition at line 1076 of file swscale.c.

Referenced by sws_scale_frame().

◆ sws_send_slice()

int sws_send_slice ( struct SwsContext c,
unsigned int  slice_start,
unsigned int  slice_height 
)

Indicate that a horizontal slice of input data is available in the source frame previously provided to sws_frame_start().

The slices may be provided in any order, but may not overlap. For vertically subsampled pixel formats, the slices must be aligned according to subsampling.

Parameters
cThe scaling context
slice_startfirst row of the slice
slice_heightnumber of rows in the slice
Returns
a non-negative number on success, a negative AVERROR code on failure.

Definition at line 1113 of file swscale.c.

Referenced by sws_scale_frame().

◆ sws_receive_slice()

int sws_receive_slice ( struct SwsContext c,
unsigned int  slice_start,
unsigned int  slice_height 
)

Request a horizontal slice of the output data to be written into the frame previously provided to sws_frame_start().

Parameters
cThe scaling context
slice_startfirst row of the slice; must be a multiple of sws_receive_slice_alignment()
slice_heightnumber of rows in the slice; must be a multiple of sws_receive_slice_alignment(), except for the last slice (i.e. when slice_start+slice_height is equal to output frame height)
Returns
a non-negative number if the data was successfully written into the output AVERROR(EAGAIN) if more input data needs to be provided before the output can be produced another negative AVERROR code on other kinds of scaling failure

Definition at line 1133 of file swscale.c.

Referenced by sws_scale_frame().

◆ sws_receive_slice_alignment()

unsigned int sws_receive_slice_alignment ( const struct SwsContext c)

Get the alignment required for slices.

Parameters
cThe scaling context
Returns
alignment required for output slices requested with sws_receive_slice(). Slice offsets and sizes passed to sws_receive_slice() must be multiples of the value returned from this function.

Definition at line 1125 of file swscale.c.

Referenced by sws_receive_slice().

◆ sws_setColorspaceDetails()

int sws_setColorspaceDetails ( struct SwsContext c,
const int  inv_table[4],
int  srcRange,
const int  table[4],
int  dstRange,
int  brightness,
int  contrast,
int  saturation 
)
Parameters
cthe scaling context
dstRangeflag indicating the while-black range of the output (1=jpeg / 0=mpeg)
srcRangeflag indicating the while-black range of the input (1=jpeg / 0=mpeg)
tablethe yuv2rgb coefficients describing the output yuv space, normally ff_yuv2rgb_coeffs[x]
inv_tablethe yuv2rgb coefficients describing the input yuv space, normally ff_yuv2rgb_coeffs[x]
brightness16.16 fixed point brightness correction
contrast16.16 fixed point contrast correction
saturation16.16 fixed point saturation correction
Returns
A negative error code on error, non negative otherwise. If LIBSWSCALE_VERSION_MAJOR < 7, returns -1 if not supported.

Definition at line 1001 of file utils.c.

Referenced by scale_frame(), and sws_init_single_context().

◆ sws_getColorspaceDetails()

int sws_getColorspaceDetails ( struct SwsContext c,
int **  inv_table,
int srcRange,
int **  table,
int dstRange,
int brightness,
int contrast,
int saturation 
)
Returns
A negative error code on error, non negative otherwise. If LIBSWSCALE_VERSION_MAJOR < 7, returns -1 if not supported.

Definition at line 1158 of file utils.c.

Referenced by scale_frame().

◆ sws_allocVec()

SwsVector* sws_allocVec ( int  length)

Allocate and return an uninitialized vector with length coefficients.

Definition at line 2133 of file utils.c.

Referenced by sws_getConstVec(), and sws_getGaussianVec().

◆ sws_getGaussianVec()

SwsVector* sws_getGaussianVec ( double  variance,
double  quality 
)

Return a normalized Gaussian curve used to filter stuff quality = 3 is high quality, lower is lower quality.

Definition at line 2150 of file utils.c.

Referenced by alloc_sws_context(), open_filter_param(), and sws_getDefaultFilter().

◆ sws_scaleVec()

void sws_scaleVec ( SwsVector a,
double  scalar 
)

Scale all the coefficients of a by the scalar value.

Definition at line 2216 of file utils.c.

Referenced by alloc_sws_context(), sws_getDefaultFilter(), and sws_normalizeVec().

◆ sws_normalizeVec()

void sws_normalizeVec ( SwsVector a,
double  height 
)

Scale all the coefficients of a so that their sum equals height.

Definition at line 2224 of file utils.c.

Referenced by sws_getDefaultFilter(), and sws_getGaussianVec().

◆ sws_freeVec()

void sws_freeVec ( SwsVector a)

◆ sws_getDefaultFilter()

SwsFilter* sws_getDefaultFilter ( float  lumaGBlur,
float  chromaGBlur,
float  lumaSharpen,
float  chromaSharpen,
float  chromaHShift,
float  chromaVShift,
int  verbose 
)

Definition at line 2344 of file utils.c.

◆ sws_freeFilter()

void sws_freeFilter ( SwsFilter filter)

Definition at line 2332 of file utils.c.

◆ sws_getCachedContext()

struct SwsContext* sws_getCachedContext ( struct SwsContext context,
int  srcW,
int  srcH,
enum AVPixelFormat  srcFormat,
int  dstW,
int  dstH,
enum AVPixelFormat  dstFormat,
int  flags,
SwsFilter srcFilter,
SwsFilter dstFilter,
const double param 
)

Check if context can be reused, otherwise reallocate a new one.

If context is NULL, just calls sws_getContext() to get a new context. Otherwise, checks if the parameters are the ones already saved in context. If that is the case, returns the current context. Otherwise, frees context and gets a new context with the new parameters.

Be warned that srcFilter and dstFilter are not checked, they are assumed to remain the same.

Definition at line 2502 of file utils.c.

Referenced by alloc_sws_context(), and video_image_display().

◆ sws_convertPalette8ToPacked32()

void sws_convertPalette8ToPacked32 ( const uint8_t *  src,
uint8_t *  dst,
int  num_pixels,
const uint8_t *  palette 
)

Convert an 8-bit paletted frame into a frame with a color depth of 32 bits.

The output frame will have the same packed format as the palette.

Parameters
srcsource frame buffer
dstdestination frame buffer
num_pixelsnumber of pixels to convert
palettearray with [256] entries, which must match color arrangement (RGB or BGR) of src

Definition at line 2239 of file swscale_unscaled.c.

Referenced by palToRgbWrapper().

◆ sws_convertPalette8ToPacked24()

void sws_convertPalette8ToPacked24 ( const uint8_t *  src,
uint8_t *  dst,
int  num_pixels,
const uint8_t *  palette 
)

Convert an 8-bit paletted frame into a frame with a color depth of 24 bits.

With the palette format "ABCD", the destination frame ends up with the format "ABC".

Parameters
srcsource frame buffer
dstdestination frame buffer
num_pixelsnumber of pixels to convert
palettearray with [256] entries, which must match color arrangement (RGB or BGR) of src

Definition at line 2249 of file swscale_unscaled.c.

Referenced by palToRgbWrapper().

◆ sws_get_class()

const AVClass* sws_get_class ( void  )

Get the AVClass for swsContext.

It can be used in combination with AV_OPT_SEARCH_FAKE_OBJ for examining options.

See also
av_opt_find().

Definition at line 97 of file options.c.

Referenced by child_class_iterate(), opt_default(), and show_help_default().