org.bytedeco.ffmpeg.global

Class swresample

java.lang.Object

org.bytedeco.ffmpeg.presets.swresample

org.bytedeco.ffmpeg.global.swresample

All Implemented Interfaces:

InfoMapper

public class swresample
extends swresample

Field Summary

Fields

Modifier and Type	Field and Description
static int	SWR_DITHER_NB enum SwrDitherType
static int	SWR_DITHER_NONE enum SwrDitherType
static int	SWR_DITHER_NS enum SwrDitherType
static int	SWR_DITHER_NS_F_WEIGHTED enum SwrDitherType
static int	SWR_DITHER_NS_HIGH_SHIBATA enum SwrDitherType
static int	SWR_DITHER_NS_IMPROVED_E_WEIGHTED enum SwrDitherType
static int	SWR_DITHER_NS_LIPSHITZ enum SwrDitherType
static int	SWR_DITHER_NS_LOW_SHIBATA enum SwrDitherType
static int	SWR_DITHER_NS_MODIFIED_E_WEIGHTED enum SwrDitherType
static int	SWR_DITHER_NS_SHIBATA enum SwrDitherType
static int	SWR_DITHER_RECTANGULAR enum SwrDitherType
static int	SWR_DITHER_TRIANGULAR enum SwrDitherType
static int	SWR_DITHER_TRIANGULAR_HIGHPASS enum SwrDitherType
static int	SWR_ENGINE_NB enum SwrEngine
static int	SWR_ENGINE_SOXR enum SwrEngine
static int	SWR_ENGINE_SWR enum SwrEngine
static int	SWR_FILTER_TYPE_BLACKMAN_NUTTALL enum SwrFilterType
static int	SWR_FILTER_TYPE_CUBIC enum SwrFilterType
static int	SWR_FILTER_TYPE_KAISER enum SwrFilterType
static int	SWR_FLAG_RESAMPLE Force resampling even if equal sample rate

Constructor Summary

Constructors

Constructor and Description
swresample()

Method Summary

Modifier and Type	Method and Description
static SwrContext	swr_alloc_set_opts(SwrContext s, long out_ch_layout, int out_sample_fmt, int out_sample_rate, long in_ch_layout, int in_sample_fmt, int in_sample_rate, int log_offset, Pointer log_ctx) Allocate SwrContext if needed and set/reset common parameters.
static SwrContext	swr_alloc() Allocate SwrContext.
static int	swr_build_matrix(long in_layout, long out_layout, double center_mix_level, double surround_mix_level, double lfe_mix_level, double rematrix_maxval, double rematrix_volume, double[] matrix, int stride, int matrix_encoding, Pointer log_ctx)
static int	swr_build_matrix(long in_layout, long out_layout, double center_mix_level, double surround_mix_level, double lfe_mix_level, double rematrix_maxval, double rematrix_volume, DoubleBuffer matrix, int stride, int matrix_encoding, Pointer log_ctx)
static int	swr_build_matrix(long in_layout, long out_layout, double center_mix_level, double surround_mix_level, double lfe_mix_level, double rematrix_maxval, double rematrix_volume, DoublePointer matrix, int stride, int matrix_encoding, Pointer log_ctx) Generate a channel mixing matrix.
static void	swr_close(SwrContext s) Closes the context so that swr_is_initialized() returns 0.
static int	swr_config_frame(SwrContext swr, AVFrame out, AVFrame in) Configure or reconfigure the SwrContext using the information provided by the AVFrames.
static int	swr_convert_frame(SwrContext swr, AVFrame output, AVFrame input) Convert the samples in the input AVFrame and write them to the output AVFrame.
static int	swr_convert(SwrContext s, byte[] out, int out_count, byte[] in, int in_count)
static int	swr_convert(SwrContext s, ByteBuffer out, int out_count, ByteBuffer in, int in_count)
static int	swr_convert(SwrContext s, BytePointer out, int out_count, BytePointer in, int in_count)
static int	swr_convert(SwrContext s, PointerPointer out, int out_count, PointerPointer in, int in_count) Convert audio.
static int	swr_drop_output(SwrContext s, int count) Drops the specified number of output samples.
static void	swr_free(PointerPointer s) Free the given SwrContext and set the pointer to NULL.
static void	swr_free(SwrContext s)
static AVClass	swr_get_class() Get the AVClass for SwrContext.
static long	swr_get_delay(SwrContext s, long base) Gets the delay the next input sample will experience relative to the next output sample.
static int	swr_get_out_samples(SwrContext s, int in_samples) Find an upper bound on the number of samples that the next swr_convert call will output, if called with in_samples of input samples.
static int	swr_init(SwrContext s) Initialize context after user parameters have been set.
static int	swr_inject_silence(SwrContext s, int count) Injects the specified number of silence samples.
static int	swr_is_initialized(SwrContext s) Check whether an swr context has been initialized or not.
static long	swr_next_pts(SwrContext s, long pts) Convert the next timestamp from input to output timestamps are in 1/(in_sample_rate * out_sample_rate) units.
static int	swr_set_channel_mapping(SwrContext s, int[] channel_map)
static int	swr_set_channel_mapping(SwrContext s, IntBuffer channel_map)
static int	swr_set_channel_mapping(SwrContext s, IntPointer channel_map) Set a customized input channel mapping.
static int	swr_set_compensation(SwrContext s, int sample_delta, int compensation_distance) Activate resampling compensation ("soft" compensation).
static int	swr_set_matrix(SwrContext s, double[] matrix, int stride)
static int	swr_set_matrix(SwrContext s, DoubleBuffer matrix, int stride)
static int	swr_set_matrix(SwrContext s, DoublePointer matrix, int stride) Set a customized remix matrix.
static BytePointer	swresample_configuration() Return the swr build-time configuration.
static BytePointer	swresample_license() Return the swr license.
static int	swresample_version() Return the \ref LIBSWRESAMPLE_VERSION_INT constant.

Methods inherited from class org.bytedeco.ffmpeg.presets.swresample

map

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SWR_FLAG_RESAMPLE

public static final int SWR_FLAG_RESAMPLE

Force resampling even if equal sample rate

See Also:

Constant Field Values

SWR_DITHER_NONE

public static final int SWR_DITHER_NONE

enum SwrDitherType

See Also:

Constant Field Values

SWR_DITHER_RECTANGULAR

public static final int SWR_DITHER_RECTANGULAR

enum SwrDitherType

See Also:

Constant Field Values

SWR_DITHER_TRIANGULAR

public static final int SWR_DITHER_TRIANGULAR

enum SwrDitherType

See Also:

Constant Field Values

SWR_DITHER_TRIANGULAR_HIGHPASS

public static final int SWR_DITHER_TRIANGULAR_HIGHPASS

enum SwrDitherType

See Also:

Constant Field Values

SWR_DITHER_NS

public static final int SWR_DITHER_NS

enum SwrDitherType

See Also:

Constant Field Values

SWR_DITHER_NS_LIPSHITZ

public static final int SWR_DITHER_NS_LIPSHITZ

enum SwrDitherType

See Also:

Constant Field Values

SWR_DITHER_NS_F_WEIGHTED

public static final int SWR_DITHER_NS_F_WEIGHTED

enum SwrDitherType

See Also:

Constant Field Values

SWR_DITHER_NS_MODIFIED_E_WEIGHTED

public static final int SWR_DITHER_NS_MODIFIED_E_WEIGHTED

enum SwrDitherType

See Also:

Constant Field Values

SWR_DITHER_NS_IMPROVED_E_WEIGHTED

public static final int SWR_DITHER_NS_IMPROVED_E_WEIGHTED

enum SwrDitherType

See Also:

Constant Field Values

SWR_DITHER_NS_SHIBATA

public static final int SWR_DITHER_NS_SHIBATA

enum SwrDitherType

See Also:

Constant Field Values

SWR_DITHER_NS_LOW_SHIBATA

public static final int SWR_DITHER_NS_LOW_SHIBATA

enum SwrDitherType

See Also:

Constant Field Values

SWR_DITHER_NS_HIGH_SHIBATA

public static final int SWR_DITHER_NS_HIGH_SHIBATA

enum SwrDitherType

See Also:

Constant Field Values

SWR_DITHER_NB

public static final int SWR_DITHER_NB

enum SwrDitherType

See Also:

Constant Field Values

SWR_ENGINE_SWR

public static final int SWR_ENGINE_SWR

enum SwrEngine

See Also:

Constant Field Values

SWR_ENGINE_SOXR

public static final int SWR_ENGINE_SOXR

enum SwrEngine

See Also:

Constant Field Values

SWR_ENGINE_NB

public static final int SWR_ENGINE_NB

enum SwrEngine

See Also:

Constant Field Values

SWR_FILTER_TYPE_CUBIC

public static final int SWR_FILTER_TYPE_CUBIC

enum SwrFilterType

See Also:

Constant Field Values

SWR_FILTER_TYPE_BLACKMAN_NUTTALL

public static final int SWR_FILTER_TYPE_BLACKMAN_NUTTALL

enum SwrFilterType

See Also:

Constant Field Values

SWR_FILTER_TYPE_KAISER

public static final int SWR_FILTER_TYPE_KAISER

enum SwrFilterType

See Also:

Constant Field Values

Constructor Detail

swresample

public swresample()

Method Detail

swr_get_class

@NoException
 @Const
public static AVClass swr_get_class()

Get the AVClass for SwrContext. It can be used in combination with AV_OPT_SEARCH_FAKE_OBJ for examining options.

Returns:

the AVClass of SwrContext

See Also:

av_opt_find().

swr_alloc

@NoException
public static SwrContext swr_alloc()

Allocate SwrContext. If you use this function you will need to set the parameters (manually or with swr_alloc_set_opts()) before calling swr_init().

Returns:

NULL on error, allocated context otherwise

See Also:

swr_alloc_set_opts(), swr_init(), swr_free()

swr_init

@NoException
public static int swr_init(SwrContext s)

Initialize context after user parameters have been set. \note The context must be configured using the AVOption API.

Parameters:

s - [in,out] Swr context to initialize

Returns:

AVERROR error code in case of failure.

See Also:

av_opt_set_int(), av_opt_set_dict()

swr_is_initialized

@NoException
public static int swr_is_initialized(SwrContext s)

Check whether an swr context has been initialized or not.

Parameters:

s - [in] Swr context to check

Returns:

positive if it has been initialized, 0 if not initialized

See Also:

swr_init()

swr_alloc_set_opts

@NoException
public static SwrContext swr_alloc_set_opts(SwrContext s,
                                                          @Cast(value="int64_t")
                                                          long out_ch_layout,
                                                          @Cast(value="AVSampleFormat")
                                                          int out_sample_fmt,
                                                          int out_sample_rate,
                                                          @Cast(value="int64_t")
                                                          long in_ch_layout,
                                                          @Cast(value="AVSampleFormat")
                                                          int in_sample_fmt,
                                                          int in_sample_rate,
                                                          int log_offset,
                                                          Pointer log_ctx)

Allocate SwrContext if needed and set/reset common parameters. This function does not require s to be allocated with swr_alloc(). On the other hand, swr_alloc() can use swr_alloc_set_opts() to set the parameters on the allocated context.

Parameters:

s - existing Swr context if available, or NULL if not

out_ch_layout - output channel layout (AV_CH_LAYOUT_*)

out_sample_fmt - output sample format (AV_SAMPLE_FMT_*).

out_sample_rate - output sample rate (frequency in Hz)

in_ch_layout - input channel layout (AV_CH_LAYOUT_*)

in_sample_fmt - input sample format (AV_SAMPLE_FMT_*).

in_sample_rate - input sample rate (frequency in Hz)

log_offset - logging level offset

log_ctx - parent logging context, can be NULL

Returns:

NULL on error, allocated context otherwise

See Also:

swr_init(), swr_free()

swr_free

@NoException
public static void swr_free(@Cast(value="SwrContext**")
                                          PointerPointer s)

Free the given SwrContext and set the pointer to NULL.

Parameters:

s - [in] a pointer to a pointer to Swr context

swr_free

@NoException
public static void swr_free(@ByPtrPtr
                                          SwrContext s)

swr_close

@NoException
public static void swr_close(SwrContext s)

Closes the context so that swr_is_initialized() returns 0. The context can be brought back to life by running swr_init(), swr_init() can also be used without swr_close(). This function is mainly provided for simplifying the usecase where one tries to support libavresample and libswresample.

Parameters:

s - [in,out] Swr context to be closed

swr_convert

@NoException
public static int swr_convert(SwrContext s,
                                            @Cast(value="uint8_t**")
                                            PointerPointer out,
                                            int out_count,
                                            @Cast(value="const uint8_t**")
                                            PointerPointer in,
                                            int in_count)

Convert audio. in and in_count can be set to 0 to flush the last few samples out at the end. If more input is provided than output space, then the input will be buffered. You can avoid this buffering by using swr_get_out_samples() to retrieve an upper bound on the required number of output samples for the given number of input samples. Conversion will run directly without copying whenever possible.

Parameters:

s - allocated Swr context, with parameters set

out - output buffers, only the first one need be set in case of packed audio

out_count - amount of space available for output in samples per channel

in - input buffers, only the first one need to be set in case of packed audio

in_count - number of input samples available in one channel

Returns:

number of samples output per channel, negative value on error

swr_convert

@NoException
public static int swr_convert(SwrContext s,
                                            @Cast(value="uint8_t**") @ByPtrPtr
                                            BytePointer out,
                                            int out_count,
                                            @Cast(value="const uint8_t**") @ByPtrPtr
                                            BytePointer in,
                                            int in_count)

swr_convert

@NoException
public static int swr_convert(SwrContext s,
                                            @Cast(value="uint8_t**") @ByPtrPtr
                                            ByteBuffer out,
                                            int out_count,
                                            @Cast(value="const uint8_t**") @ByPtrPtr
                                            ByteBuffer in,
                                            int in_count)

swr_convert

@NoException
public static int swr_convert(SwrContext s,
                                            @Cast(value="uint8_t**") @ByPtrPtr
                                            byte[] out,
                                            int out_count,
                                            @Cast(value="const uint8_t**") @ByPtrPtr
                                            byte[] in,
                                            int in_count)

swr_next_pts

@NoException
 @Cast(value="int64_t")
public static long swr_next_pts(SwrContext s,
                                                                       @Cast(value="int64_t")
                                                                       long pts)

Convert the next timestamp from input to output timestamps are in 1/(in_sample_rate * out_sample_rate) units. \note There are 2 slightly differently behaving modes. \li When automatic timestamp compensation is not used, (min_compensation >= FLT_MAX) in this case timestamps will be passed through with delays compensated \li When automatic timestamp compensation is used, (min_compensation < FLT_MAX) in this case the output timestamps will match output sample numbers. See ffmpeg-resampler(1) for the two modes of compensation.

Parameters:

s[in] - initialized Swr context

pts[in] - timestamp for the next input sample, INT64_MIN if unknown

Returns:

the output timestamp for the next output sample

See Also:

swr_set_compensation(), swr_drop_output(), and swr_inject_silence() are function used internally for timestamp compensation.

swr_set_compensation

@NoException
public static int swr_set_compensation(SwrContext s,
                                                     int sample_delta,
                                                     int compensation_distance)

Activate resampling compensation ("soft" compensation). This function is internally called when needed in swr_next_pts().

Parameters:

s - [in,out] allocated Swr context. If it is not initialized, or SWR_FLAG_RESAMPLE is not set, swr_init() is called with the flag set.

sample_delta - [in] delta in PTS per sample

compensation_distance - [in] number of samples to compensate for

Returns:

>= 0 on success, AVERROR error codes if: \li \c s is NULL, \li \c compensation_distance is less than 0, \li \c compensation_distance is 0 but sample_delta is not, \li compensation unsupported by resampler, or \li swr_init() fails when called.

swr_set_channel_mapping

@NoException
public static int swr_set_channel_mapping(SwrContext s,
                                                        @Const
                                                        IntPointer channel_map)

Set a customized input channel mapping.

Parameters:

s - [in,out] allocated Swr context, not yet initialized

channel_map - [in] customized input channel mapping (array of channel indexes, -1 for a muted channel)

Returns:

>= 0 on success, or AVERROR error code in case of failure.

swr_set_channel_mapping

@NoException
public static int swr_set_channel_mapping(SwrContext s,
                                                        @Const
                                                        IntBuffer channel_map)

swr_set_channel_mapping

@NoException
public static int swr_set_channel_mapping(SwrContext s,
                                                        @Const
                                                        int[] channel_map)

swr_build_matrix

@NoException
public static int swr_build_matrix(@Cast(value="uint64_t")
                                                 long in_layout,
                                                 @Cast(value="uint64_t")
                                                 long out_layout,
                                                 double center_mix_level,
                                                 double surround_mix_level,
                                                 double lfe_mix_level,
                                                 double rematrix_maxval,
                                                 double rematrix_volume,
                                                 DoublePointer matrix,
                                                 int stride,
                                                 @Cast(value="AVMatrixEncoding")
                                                 int matrix_encoding,
                                                 Pointer log_ctx)

Generate a channel mixing matrix. This function is the one used internally by libswresample for building the default mixing matrix. It is made public just as a utility function for building custom matrices.

Parameters:

in_layout - input channel layout

out_layout - output channel layout

center_mix_level - mix level for the center channel

surround_mix_level - mix level for the surround channel(s)

lfe_mix_level - mix level for the low-frequency effects channel

rematrix_maxval - if 1.0, coefficients will be normalized to prevent overflow. if INT_MAX, coefficients will not be normalized.

matrix - [out] mixing coefficients; matrix[i + stride * o] is the weight of input channel i in output channel o.

stride - distance between adjacent input channels in the matrix array

matrix_encoding - matrixed stereo downmix mode (e.g. dplii)

log_ctx - parent logging context, can be NULL

Returns:

0 on success, negative AVERROR code on failure

swr_build_matrix

@NoException
public static int swr_build_matrix(@Cast(value="uint64_t")
                                                 long in_layout,
                                                 @Cast(value="uint64_t")
                                                 long out_layout,
                                                 double center_mix_level,
                                                 double surround_mix_level,
                                                 double lfe_mix_level,
                                                 double rematrix_maxval,
                                                 double rematrix_volume,
                                                 DoubleBuffer matrix,
                                                 int stride,
                                                 @Cast(value="AVMatrixEncoding")
                                                 int matrix_encoding,
                                                 Pointer log_ctx)

swr_build_matrix

@NoException
public static int swr_build_matrix(@Cast(value="uint64_t")
                                                 long in_layout,
                                                 @Cast(value="uint64_t")
                                                 long out_layout,
                                                 double center_mix_level,
                                                 double surround_mix_level,
                                                 double lfe_mix_level,
                                                 double rematrix_maxval,
                                                 double rematrix_volume,
                                                 double[] matrix,
                                                 int stride,
                                                 @Cast(value="AVMatrixEncoding")
                                                 int matrix_encoding,
                                                 Pointer log_ctx)

swr_set_matrix

@NoException
public static int swr_set_matrix(SwrContext s,
                                               @Const
                                               DoublePointer matrix,
                                               int stride)

Set a customized remix matrix.

Parameters:

s - allocated Swr context, not yet initialized

matrix - remix coefficients; matrix[i + stride * o] is the weight of input channel i in output channel o

stride - offset between lines of the matrix

Returns:

>= 0 on success, or AVERROR error code in case of failure.

swr_set_matrix

@NoException
public static int swr_set_matrix(SwrContext s,
                                               @Const
                                               DoubleBuffer matrix,
                                               int stride)

swr_set_matrix

@NoException
public static int swr_set_matrix(SwrContext s,
                                               @Const
                                               double[] matrix,
                                               int stride)

swr_drop_output

@NoException
public static int swr_drop_output(SwrContext s,
                                                int count)

Drops the specified number of output samples. This function, along with swr_inject_silence(), is called by swr_next_pts() if needed for "hard" compensation.

Parameters:

s - allocated Swr context

count - number of samples to be dropped

Returns:

>= 0 on success, or a negative AVERROR code on failure

swr_inject_silence

@NoException
public static int swr_inject_silence(SwrContext s,
                                                   int count)

Injects the specified number of silence samples. This function, along with swr_drop_output(), is called by swr_next_pts() if needed for "hard" compensation.

Parameters:

s - allocated Swr context

count - number of samples to be dropped

Returns:

>= 0 on success, or a negative AVERROR code on failure

swr_get_delay

@NoException
 @Cast(value="int64_t")
public static long swr_get_delay(SwrContext s,
                                                                        @Cast(value="int64_t")
                                                                        long base)

Gets the delay the next input sample will experience relative to the next output sample. Swresample can buffer data if more input has been provided than available output space, also converting between sample rates needs a delay. This function returns the sum of all such delays. The exact delay is not necessarily an integer value in either input or output sample rate. Especially when downsampling by a large value, the output sample rate may be a poor choice to represent the delay, similarly for upsampling and the input sample rate.

Parameters:

s - swr context

base - timebase in which the returned delay will be: \li if it's set to 1 the returned delay is in seconds \li if it's set to 1000 the returned delay is in milliseconds \li if it's set to the input sample rate then the returned delay is in input samples \li if it's set to the output sample rate then the returned delay is in output samples \li if it's the least common multiple of in_sample_rate and out_sample_rate then an exact rounding-free delay will be returned

Returns:

the delay in 1 / \c base units.

swr_get_out_samples

@NoException
public static int swr_get_out_samples(SwrContext s,
                                                    int in_samples)

Find an upper bound on the number of samples that the next swr_convert call will output, if called with in_samples of input samples. This depends on the internal state, and anything changing the internal state (like further swr_convert() calls) will may change the number of samples swr_get_out_samples() returns for the same number of input samples.

Parameters:

in_samples - number of input samples. \note any call to swr_inject_silence(), swr_convert(), swr_next_pts() or swr_set_compensation() invalidates this limit \note it is recommended to pass the correct available buffer size to all functions like swr_convert() even if swr_get_out_samples() indicates that less would be used.

Returns:

an upper bound on the number of samples that the next swr_convert will output or a negative value to indicate an error

swresample_version

@NoException
 @Cast(value="unsigned")
public static int swresample_version()

Return the \ref LIBSWRESAMPLE_VERSION_INT constant. This is useful to check if the build-time libswresample has the same version as the run-time one.

Returns:

the unsigned int-typed version

swresample_configuration

@NoException
 @Cast(value="const char*")
public static BytePointer swresample_configuration()

Return the swr build-time configuration.

Returns:

the build-time \c ./configure flags

swresample_license

@NoException
 @Cast(value="const char*")
public static BytePointer swresample_license()

Return the swr license.

Returns:

the license of libswresample, determined at build-time

swr_convert_frame

@NoException
public static int swr_convert_frame(SwrContext swr,
                                                  AVFrame output,
                                                  @Const
                                                  AVFrame input)

Convert the samples in the input AVFrame and write them to the output AVFrame. Input and output AVFrames must have channel_layout, sample_rate and format set. If the output AVFrame does not have the data pointers allocated the nb_samples field will be set using av_frame_get_buffer() is called to allocate the frame. The output AVFrame can be NULL or have fewer allocated samples than required. In this case, any remaining samples not written to the output will be added to an internal FIFO buffer, to be returned at the next call to this function or to swr_convert(). If converting sample rate, there may be data remaining in the internal resampling delay buffer. swr_get_delay() tells the number of remaining samples. To get this data as output, call this function or swr_convert() with NULL input. If the SwrContext configuration does not match the output and input AVFrame settings the conversion does not take place and depending on which AVFrame is not matching AVERROR_OUTPUT_CHANGED, AVERROR_INPUT_CHANGED or the result of a bitwise-OR of them is returned.

Parameters:

swr - audio resample context

output - output AVFrame

input - input AVFrame

Returns:

0 on success, AVERROR on failure or nonmatching configuration.

See Also:

swr_delay(), swr_convert(), swr_get_delay()

swr_config_frame

@NoException
public static int swr_config_frame(SwrContext swr,
                                                 @Const
                                                 AVFrame out,
                                                 @Const
                                                 AVFrame in)

Configure or reconfigure the SwrContext using the information provided by the AVFrames. The original resampling context is reset even on failure. The function calls swr_close() internally if the context is open.

Parameters:

swr - audio resample context

output - output AVFrame

input - input AVFrame

Returns:

0 on success, AVERROR on failure.

See Also:

swr_close();