swresample (JavaCPP Presets for FFmpeg 2.7.1-1.0 API)

java.lang.Object
- org.bytedeco.javacpp.presets.swresample
- - org.bytedeco.javacpp.swresample

All Implemented Interfaces:: InfoMapper

public class swresample
extends swresample

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class swresample.SwrContext
The libswresample context.

Nested Classes
Modifier and Type	Class and Description
`static class`	`swresample.SwrContext` The libswresample context.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SWR_CH_MAX` Maximum number of channels
`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()

Constructors
Constructor and Description
`swresample()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static swresample.SwrContext`	`swr_alloc_set_opts(swresample.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 swresample.SwrContext`	`swr_alloc()` Allocate SwrContext.
`static void`	`swr_close(swresample.SwrContext s)` Closes the context so that swr_is_initialized() returns 0.
`static int`	`swr_config_frame(swresample.SwrContext swr, avutil.AVFrame out, avutil.AVFrame in)` Configure or reconfigure the SwrContext using the information provided by the AVFrames.
`static int`	`swr_convert_frame(swresample.SwrContext swr, avutil.AVFrame output, avutil.AVFrame input)` Convert the samples in the input AVFrame and write them to the output AVFrame.
`static int`	`swr_convert(swresample.SwrContext s, byte[] out, int out_count, byte[] in, int in_count)`
`static int`	`swr_convert(swresample.SwrContext s, ByteBuffer out, int out_count, ByteBuffer in, int in_count)`
`static int`	`swr_convert(swresample.SwrContext s, BytePointer out, int out_count, BytePointer in, int in_count)`
`static int`	`swr_convert(swresample.SwrContext s, PointerPointer out, int out_count, PointerPointer in, int in_count)` Convert audio.
`static int`	`swr_drop_output(swresample.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(swresample.SwrContext s)`
`static avutil.AVClass`	`swr_get_class()` Get the AVClass for SwrContext.
`static long`	`swr_get_delay(swresample.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(swresample.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(swresample.SwrContext s)` Initialize context after user parameters have been set.
`static int`	`swr_inject_silence(swresample.SwrContext s, int count)` Injects the specified number of silence samples.
`static int`	`swr_is_initialized(swresample.SwrContext s)` Check whether an swr context has been initialized or not.
`static long`	`swr_next_pts(swresample.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(swresample.SwrContext s, int[] channel_map)`
`static int`	`swr_set_channel_mapping(swresample.SwrContext s, IntBuffer channel_map)`
`static int`	`swr_set_channel_mapping(swresample.SwrContext s, IntPointer channel_map)` Set a customized input channel mapping.
`static int`	`swr_set_compensation(swresample.SwrContext s, int sample_delta, int compensation_distance)` Activate resampling compensation ("soft" compensation).
`static int`	`swr_set_matrix(swresample.SwrContext s, double[] matrix, int stride)`
`static int`	`swr_set_matrix(swresample.SwrContext s, DoubleBuffer matrix, int stride)`
`static int`	`swr_set_matrix(swresample.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.javacpp.presets.swresample
map

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SWR_CH_MAX
```
public static final int SWR_CH_MAX
```
    Maximum number of channels
    
    See Also:
    
    Constant Field Values
  - 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
```
@Const
public static avutil.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
```
public static swresample.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
```
public static int swr_init(swresample.SwrContext s)
```
    Initialize context after user parameters have been set.
    
    Returns:
    
    AVERROR error code in case of failure.
    
    See Also:
    
    av_opt_set_int(), av_opt_set_dict()
  - swr_is_initialized
```
public static int swr_is_initialized(swresample.SwrContext s)
```
    Check whether an swr context has been initialized or not.
    
    Returns:
    
    positive if it has been initialized, 0 if not initialized
    
    See Also:
    
    swr_init()
  - swr_alloc_set_opts
```
public static swresample.SwrContext swr_alloc_set_opts(swresample.SwrContext s,
                                                       long out_ch_layout,
                                                       @Cast(value="AVSampleFormat")
                                                       int out_sample_fmt,
                                                       int out_sample_rate,
                                                       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
```
public static void swr_free(@Cast(value="SwrContext**")
                            PointerPointer s)
```
    Free the given SwrContext and set the pointer to NULL.
  - swr_free
```
public static void swr_free(@ByPtrPtr
                            swresample.SwrContext s)
```
  - swr_close
```
public static void swr_close(swresample.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.
  - swr_convert
```
public static int swr_convert(swresample.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
```
public static int swr_convert(swresample.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
```
public static int swr_convert(swresample.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
```
public static int swr_convert(swresample.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
```
public static long swr_next_pts(swresample.SwrContext s,
                                long pts)
```
    Convert the next timestamp from input to output timestamps are in 1/(in_sample_rate * out_sample_rate) units.
    
    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
```
public static int swr_set_compensation(swresample.SwrContext s,
                                       int sample_delta,
                                       int compensation_distance)
```
    Activate resampling compensation ("soft" compensation). This function is internally called when needed in swr_next_pts().
    
    Returns:
    
    >= 0 on success, AVERROR error codes if:
  - swr_set_channel_mapping
```
public static int swr_set_channel_mapping(swresample.SwrContext s,
                                          @Const
                                          IntPointer channel_map)
```
    Set a customized input channel mapping.
    
    Returns:
    
    >= 0 on success, or AVERROR error code in case of failure.
  - swr_set_channel_mapping
```
public static int swr_set_channel_mapping(swresample.SwrContext s,
                                          @Const
                                          IntBuffer channel_map)
```
  - swr_set_channel_mapping
```
public static int swr_set_channel_mapping(swresample.SwrContext s,
                                          @Const
                                          int[] channel_map)
```
  - swr_set_matrix
```
public static int swr_set_matrix(swresample.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
```
public static int swr_set_matrix(swresample.SwrContext s,
                                 @Const
                                 DoubleBuffer matrix,
                                 int stride)
```
  - swr_set_matrix
```
public static int swr_set_matrix(swresample.SwrContext s,
                                 @Const
                                 double[] matrix,
                                 int stride)
```
  - swr_drop_output
```
public static int swr_drop_output(swresample.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
```
public static int swr_inject_silence(swresample.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
```
public static long swr_get_delay(swresample.SwrContext s,
                                 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:
  - swr_get_out_samples
```
public static int swr_get_out_samples(swresample.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.
  - swresample_version
```
@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.
  - swresample_configuration
```
@Cast(value="const char*")
public static BytePointer swresample_configuration()
```
    Return the swr build-time configuration.
  - swresample_license
```
@Cast(value="const char*")
public static BytePointer swresample_license()
```
    Return the swr license.
  - swr_convert_frame
```
public static int swr_convert_frame(swresample.SwrContext swr,
                                    avutil.AVFrame output,
                                    @Const
                                    avutil.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
```
public static int swr_config_frame(swresample.SwrContext swr,
                                   @Const
                                   avutil.AVFrame out,
                                   @Const
                                   avutil.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();

Class swresample

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

SWR_CH_MAX

SWR_FLAG_RESAMPLE

SWR_DITHER_NONE

SWR_DITHER_RECTANGULAR

SWR_DITHER_TRIANGULAR

SWR_DITHER_TRIANGULAR_HIGHPASS

SWR_DITHER_NS

SWR_DITHER_NS_LIPSHITZ

SWR_DITHER_NS_F_WEIGHTED

SWR_DITHER_NS_MODIFIED_E_WEIGHTED

SWR_DITHER_NS_IMPROVED_E_WEIGHTED

SWR_DITHER_NS_SHIBATA

SWR_DITHER_NS_LOW_SHIBATA

SWR_DITHER_NS_HIGH_SHIBATA

SWR_DITHER_NB

SWR_ENGINE_SWR

SWR_ENGINE_SOXR

SWR_ENGINE_NB

SWR_FILTER_TYPE_CUBIC

SWR_FILTER_TYPE_BLACKMAN_NUTTALL

SWR_FILTER_TYPE_KAISER

Constructor Detail

swresample

Method Detail

swr_get_class

swr_alloc

swr_init

swr_is_initialized

swr_alloc_set_opts

swr_free

swr_free

swr_close

swr_convert

swr_convert

swr_convert

swr_convert

swr_next_pts

swr_set_compensation

swr_set_channel_mapping

swr_set_channel_mapping

swr_set_channel_mapping

swr_set_matrix

swr_set_matrix

swr_set_matrix

swr_drop_output

swr_inject_silence

swr_get_delay

swr_get_out_samples

swresample_version

swresample_configuration

swresample_license

swr_convert_frame

swr_config_frame