com.peterphi.std.types

Class SampleCount

java.lang.Object

com.peterphi.std.types.SampleCount

public class SampleCount
extends java.lang.Object

A number of samples at a given sample rate

Constructor Summary

Constructors

Constructor and Description
SampleCount(long samples, Timebase rate)

Method Summary

Methods

Modifier and Type	Method and Description
SampleCount	add(SampleCount that)
SampleCount	addPrecise(SampleCount that)
boolean	equals(java.lang.Object o)
Timebase	getRate()
long	getSamples()
long	getSamples(Timebase newRate) Returns the number of samples represented by this SampleCount, converted to newRate. This method can lose precision if the samples cannot be precisely represented.
long	getSamplesPrecise(Timebase newRate) Returns the number of samples represented by this SampleCount, converted to newRate.
double	getSeconds() Compute the duration of this sample count in seconds The intention of this method is to be used for presentation, rather than accurate computation so it does not warn about resampling errors
int	hashCode()
static SampleCount	parseVidispine(java.lang.String countAndRate) Deprecated.
SampleCount	resample(Timebase newRate) Resample this sample count to another rate
static SampleCount	seconds(Timebase rate, int seconds)
SampleCount	subtract(SampleCount that)
SampleCount	subtractPrecise(SampleCount that)
java.lang.String	toFfmpegString() Returns the sample count in FFmpeg's time-based duration format.
java.lang.String	toString() Encode the SampleCount as samples@[str_timebase|nom[:denom]] (e.g.
java.lang.String	toVidispineString() Deprecated.
static SampleCount	valueOf(java.lang.String countAndRate) Parse a sample count & timebase as samples@[str_timebase|nom[:denom]] N.B.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SampleCount

public SampleCount(long samples,
           Timebase rate)

Method Detail

resample

public SampleCount resample(Timebase newRate)

Resample this sample count to another rate

Parameters:

newRate -

Returns:

add

public SampleCount add(SampleCount that)

addPrecise

public SampleCount addPrecise(SampleCount that)
                       throws ResamplingException

Throws:

ResamplingException

subtract

public SampleCount subtract(SampleCount that)

subtractPrecise

public SampleCount subtractPrecise(SampleCount that)
                            throws ResamplingException

Parameters:

that - the sample count to subtract

Returns:

Throws:

ResamplingException - if the delta cannot be expressed without losing accuracy

getRate

public Timebase getRate()

getSamples

public long getSamples()

getSamples

public long getSamples(Timebase newRate)

Returns the number of samples represented by this SampleCount, converted to newRate.
This method can lose precision if the samples cannot be precisely represented. Use getSamplesPrecise for lossless-or-exception resampling

Parameters:

newRate -

Returns:

getSamplesPrecise

public long getSamplesPrecise(Timebase newRate)
                       throws ResamplingException

Returns the number of samples represented by this SampleCount, converted to newRate. If precision would be lost this method throws an exception
This method uses Timebase.resamplePrecise for lossless-or-exception resampling

Parameters:

newRate -

Returns:

Throws:

ResamplingException - if precision would be lost by the resample

toString

public java.lang.String toString()

Encode the SampleCount as samples@[str_timebase|nom[:denom]] (e.g. 124222@44100, 400@30000:1001)

Overrides:

toString in class java.lang.Object

Returns:

toFfmpegString

public java.lang.String toFfmpegString()

Returns the sample count in FFmpeg's time-based duration format. The format of the sample count is hh:mm:ss:uuuuuu (where u = microseconds).

Returns:

See Also:

Timecode.toFfmpegString()

parseVidispine

@Deprecated
public static SampleCount parseVidispine(java.lang.String countAndRate)

Deprecated.

Parse a vidispine sample count & timebase as represented in point 1 of http://wiki.vidispine.com/vidiwiki/Time#Time_codes
N.B. This does NOT consider the case where only a sample count is specified: it MUST include a timebase

Parameters:

countAndRate - A sample count and a time base. The syntax is {number of samples}@{textual representation of time base} 124222@44100, 400@30000:1001, 400@NTSC

Returns:

valueOf

public static SampleCount valueOf(java.lang.String countAndRate)

Parse a sample count & timebase as samples@[str_timebase|nom[:denom]] N.B. This does NOT consider the case where only a sample count is specified: it MUST include a timebase

Parameters:

countAndRate - A sample count and a time base. The syntax is {number of samples}@{textual representation of time base} 124222@44100, 400@30000:1001, 400@NTSC

Returns:

seconds

public static SampleCount seconds(Timebase rate,
                  int seconds)

toVidispineString

@Deprecated
public java.lang.String toVidispineString()

Deprecated.

getSeconds

public double getSeconds()

Compute the duration of this sample count in seconds
The intention of this method is to be used for presentation, rather than accurate computation so it does not warn about resampling errors

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object