MediaAudioResampler (humble-video-noarch 0.3.0 API)

java.lang.Object
- io.humble.ferry.RefCounted
- - io.humble.video.Configurable
  - - io.humble.video.MediaResampler
    - - io.humble.video.MediaAudioResampler

```
public class MediaAudioResampler
extends MediaResampler
```
A MediaAudioResampler object resamples MediaAudio objects from
one format/sample-rate/channel-layout to another.

Nested Class Summary
- Nested classes/interfaces inherited from class io.humble.video.MediaResampler
  MediaResampler.State

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MediaAudioResampler`	`copyReference()` Create a new MediaAudioResampler object that is actually referring to the exact same underlying native object.
`int`	`dropOutput(int count)` Set a customized input channel mapping.
`boolean`	`equals(Object obj)` Compares two values, returning true if the underlying objects in native code are the same object.
`long`	`getDelay(long base)` Gets the delay the next input sample will experience relative to the next output sample. The resampler 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.
`int`	`getInputChannels()` Get number of input channels (derived from #getInputLayout()).
`AudioFormat.Type`	`getInputFormat()` Get input audio format.
`AudioChannel.Layout`	`getInputLayout()` Get input channel layout.
`int`	`getInputSampleRate()` Get input sample rate.
`long`	`getNextPts(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. First is when automatic timestamp compensation is not used, (min_compensation >= FLT_MAX) in this case timestamps will be passed through with delays compensated Second is when automatic timestamp compensation is used, (min_compensation < FLT_MAX) in this case the output timestamps will match output sample numbers
`int`	`getNumResampledSamples(int numSamples)` Returns the number of resampled samples (rounded up) that would be required when resampling a given number of samples. That was a mouthful, yes? So here's the way to think of this.
`int`	`getOutputChannels()` Get number of output channels (derived from #getOutputLayout()).
`AudioFormat.Type`	`getOutputFormat()` Get output audio format.
`AudioChannel.Layout`	`getOutputLayout()` Get output channel layout.
`int`	`getOutputSampleRate()` Get output sample rate.
`MediaResampler.State`	`getState()`
`Rational`	`getTimeBase()` Get the timebase used when outputting time stamps for audio. Defaults to 1 / (the lowest common multiple of getInputSampleRate() and getOutputSampleRate()) in order to ensure that no rounding of time stamps occur. For example, if the input sample rate is 22050 and the output sample rate is 44100, then the output time base will be (1/44100).
`int`	`hashCode()` Get a hashable value for this object.
`int`	`injectSilence(int count)` Injects the specified number of silence samples.
`static MediaAudioResampler`	`make(AudioChannel.Layout outLayout, int outSampleRate, AudioFormat.Type outFormat, AudioChannel.Layout inLayout, int inSampleRate, AudioFormat.Type inFormat)` Create a new MediaAudioResampler.
`void`	`open()` Opens the resampler so it can be ready for resampling. You should NOT set options after you open this object.
`int`	`resample(MediaSampled out, MediaSampled in)` Convert audio. in can be set to null 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 providing more output space than input. Conversion will run directly without copying whenever possible.
`int`	`resampleAudio(MediaAudio out, MediaAudio in)`
`void`	`setCompensation(int sample_delta, int compensation_distance)` Activate resampling compensation.
`void`	`setTimeBase(Rational rational)` Set the timebase to use for timestamps on output audio.

Methods inherited from class io.humble.video.Configurable
getNumProperties, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsInt, getPropertyAsLong, getPropertyAsRational, getPropertyAsString, getPropertyMetaData, getPropertyMetaData, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty

Methods inherited from class io.humble.ferry.RefCounted
delete, getCurrentRefCount

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - copyReference
```
public MediaAudioResampler copyReference()
```
    Create a new MediaAudioResampler object that is actually referring to the exact same underlying native object.
    
    Overrides:
    
    copyReference in class MediaResampler
    
    Returns:
    
    the new Java object.
  - equals
```
public boolean equals(Object obj)
```
    Compares two values, returning true if the underlying objects in native code are the same object. That means you can have two different Java objects, but when you do a comparison, you'll find out they are the EXACT same object.
    
    Overrides:
    
    equals in class MediaResampler
    
    Returns:
    
    True if the underlying native object is the same. False otherwise.
  - hashCode
```
public int hashCode()
```
    Get a hashable value for this object.
    
    Overrides:
    
    hashCode in class MediaResampler
    
    Returns:
    
    the hashable value.
  - make
```
public static MediaAudioResampler make(AudioChannel.Layout outLayout,
                                       int outSampleRate,
                                       AudioFormat.Type outFormat,
                                       AudioChannel.Layout inLayout,
                                       int inSampleRate,
                                       AudioFormat.Type inFormat)
```
    Create a new MediaAudioResampler.
  - getOutputLayout
```
public AudioChannel.Layout getOutputLayout()
```
    Get output channel layout.
  - getInputLayout
```
public AudioChannel.Layout getInputLayout()
```
    Get input channel layout.
  - getOutputSampleRate
```
public int getOutputSampleRate()
```
    Get output sample rate.
  - getInputSampleRate
```
public int getInputSampleRate()
```
    Get input sample rate.
  - getOutputFormat
```
public AudioFormat.Type getOutputFormat()
```
    Get output audio format.
  - getInputFormat
```
public AudioFormat.Type getInputFormat()
```
    Get input audio format.
  - getInputChannels
```
public int getInputChannels()
```
    Get number of input channels (derived from #getInputLayout()).
  - getOutputChannels
```
public int getOutputChannels()
```
    Get number of output channels (derived from #getOutputLayout()).
  - open
```
public void open()
```
    Opens the resampler so it can be ready for resampling.
    You should NOT set options after you open this object.
  - resample
```
public int resample(MediaSampled out,
                    MediaSampled in)
```
    Convert audio.
    
    in can be set to null 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 providing more output space than input.
    Conversion will run directly without copying whenever possible.
    
    Overrides:
    
    resample in class MediaResampler
    
    Parameters:
    
    out - output audio object. caller is responsible for making the correct size.
    
    in - input audio.
    
    Returns:
    
    number of samples output per channel.
    
    Throws:
    
    RuntimeError - if we get an error or InvalidArgument if the attributes of
    in or out do not match what this resampler expected.
  - resampleAudio
```
public int resampleAudio(MediaAudio out,
                         MediaAudio in)
```
  - getNextPts
```
public long getNextPts(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.
    First is when automatic timestamp compensation is not used, (min_compensation >= FLT_MAX)
    in this case timestamps will be passed through with delays compensated
    Second is when automatic timestamp compensation is used, (min_compensation < FLT_MAX)
    in this case the output timestamps will match output sample numbers
    
    Parameters:
    
    pts - timestamp for the next input sample, INT64_MIN if unknown
    
    Returns:
    
    the output timestamp for the next output sample
  - setCompensation
```
public void setCompensation(int sample_delta,
                            int compensation_distance)
```
    Activate resampling compensation.
  - dropOutput
```
public int dropOutput(int count)
```
    Set a customized input channel mapping.
    
    Returns:
    
    AVERROR error code in case of failure.
    
    Set a customized remix matrix.
  - injectSilence
```
public int injectSilence(int count)
```
    Injects the specified number of silence samples.
    
    Returns:
    
    # of samples injected.
  - getDelay
```
public long getDelay(long base)
```
    Gets the delay the next input sample will experience relative to the next output sample.
    
    The resampler 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:
    
    base - timebase in which the returned delay will be
    if its set to 1 the returned delay is in seconds
    if its set to 1000 the returned delay is in milli seconds
    if its set to the input sample rate then the returned delay is in input samples
    if its set to the output sample rate then the returned delay is in output samples
    an exact rounding free delay can be found by using LCM(in_sample_rate, out_sample_rate)
    
    Returns:
    
    the delay in 1/base units.
  - getNumResampledSamples
```
public int getNumResampledSamples(int numSamples)
```
    Returns the number of resampled samples (rounded up) that would
    be required when resampling a given number of samples.
    That was a mouthful, yes? So here's the way to think of this. If your input
    audio is at 48000 hz, and you pass in 0.5 seconds of audio, that's 24,000 input samples.
    But if you're resampling to 22050 hz, then 0.5 seconds of audio is 11,025 output samples.
    So getNumResampledSamples(24000) would return 11025 if the input
    sample rate was 48,000 and hte output was 22,050.
  - getTimeBase
```
public Rational getTimeBase()
```
    Get the timebase used when outputting time stamps for audio.
    
    Defaults to 1 / (the lowest common multiple of getInputSampleRate()
    and getOutputSampleRate()) in order to ensure that no rounding
    of time stamps occur.
    
    For example, if the input sample rate is 22050 and the output sample
    rate is 44100, then the output time base will be (1/44100). But if the
    input sample rate is 48000 and the output sample rate is 22050, then
    the output time base will be (1/lcm(48000,22050)) which will be 1/7056000
    (trust me). This is done so that timestamp values do not get rounded (and
    therefore introduce drift).
  - setTimeBase
```
public void setTimeBase(Rational rational)
```
    Set the timebase to use for timestamps on output audio.
    
    Throws:
    
    InvalidArgument - if null.
  - getState
```
public MediaResampler.State getState()
```
    Overrides:
    
    getState in class MediaResampler

Class MediaAudioResampler

Nested Class Summary

Nested classes/interfaces inherited from class io.humble.video.MediaResampler

Method Summary

Methods inherited from class io.humble.video.Configurable

Methods inherited from class io.humble.ferry.RefCounted

Methods inherited from class java.lang.Object

Method Detail

copyReference

equals

hashCode

make

getOutputLayout

getInputLayout

getOutputSampleRate

getInputSampleRate

getOutputFormat

getInputFormat

getInputChannels

getOutputChannels

open

resample

resampleAudio

getNextPts

setCompensation

dropOutput

injectSilence

getDelay

getNumResampledSamples

getTimeBase

setTimeBase

getState