Module org.refcodes.audio
Package org.refcodes.audio

Class CsvSoundSampleWriter

java.lang.Object
org.refcodes.audio.AbstractCsvSampleWriter<SoundSample,CsvSoundSampleWriter>
org.refcodes.audio.CsvSoundSampleWriter
All Implemented Interfaces:
AutoCloseable, CsvSampleWriter<SoundSample,CsvSoundSampleWriter>, SampleWriter<SoundSample,CsvSoundSampleWriter>, SamplingRateAccessor, SamplingRateAccessor.SamplingRateBuilder<CsvSoundSampleWriter>, SamplingRateAccessor.SamplingRateMutator, SamplingRateAccessor.SamplingRateProperty, SoundSampleWriter<CsvSoundSampleWriter>, org.refcodes.io.RowWriter<SoundSample>
public class CsvSoundSampleWriter extends AbstractCsvSampleWriter<SoundSample,CsvSoundSampleWriter> implements SoundSampleWriter<CsvSoundSampleWriter>
The CsvSoundSampleWriter provides means to write sound samples to a CSV file.

  • Constructor Details

    • CsvSoundSampleWriter

      public CsvSoundSampleWriter(File aFile) throws FileNotFoundException
      Constructs the CsvSoundSampleWriter for writing sound samples to a CSV file or stream.
      Parameters:
      aFile - The File where to write the CSV records to.
      Throws:
      FileNotFoundException - If the given file object does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file.

    • CsvSoundSampleWriter

      public CsvSoundSampleWriter(OutputStream aOutputStream)
      Constructs the CsvSoundSampleWriter for writing sound samples to a CSV file or stream.
      Parameters:
      aOutputStream - The OutputStream where to write the CSV records to.

    • CsvSoundSampleWriter

      public CsvSoundSampleWriter(PrintStream aPrintStream)
      Constructs the CsvSoundSampleWriter for writing sound samples to a CSV file or stream.
      Parameters:
      aPrintStream - The PrintStream where to write the CSV records to.

    • CsvSoundSampleWriter

      public CsvSoundSampleWriter(File aFile, CsvDeltaMode aDeltaMode) throws FileNotFoundException
      Constructs the CsvSoundSampleWriter for writing sound samples to a CSV file or stream.
      Parameters:
      aFile - The File where to write the CSV records to.
      aDeltaMode - The CsvDeltaMode to use when writing the CSV rows.
      Throws:
      FileNotFoundException - If the given file object does not denote an existing, writable regular file and a new regular file of that name cannot be created, or if some other error occurs while opening or creating the file.

    • CsvSoundSampleWriter

      public CsvSoundSampleWriter(OutputStream aOutputStream, CsvDeltaMode aDeltaMode)
      Constructs the CsvSoundSampleWriter for writing sound samples to a CSV file or stream.
      Parameters:
      aOutputStream - The OutputStream where to write the CSV records to.
      aDeltaMode - The CsvDeltaMode to use when writing the CSV rows.

    • CsvSoundSampleWriter

      public CsvSoundSampleWriter(PrintStream aPrintStream, CsvDeltaMode aDeltaMode)
      Constructs the CsvSoundSampleWriter for writing sound samples to a CSV file or stream.
      Parameters:
      aPrintStream - The PrintStream where to write the CSV records to.
      aDeltaMode - The CsvDeltaMode to use when writing the CSV rows.

  • Method Details

    • writeNext

      public void writeNext(double... aSampleData)
      Writes the next samples, one sample for each channel. Provide one sample for mono audio, two samples for stereo audio and so on. In case you provide more or less samples than channels being supported by the writer, then it is up to the writer whether to duplicate the samples or calculate an average or the like.
      Specified by:
      writeNext in interface SoundSampleWriter<CsvSoundSampleWriter>
      Parameters:
      aSampleData - The samples, one for each channel.

    • writeNext

      public void writeNext(SoundSample aSample)
      Writes the next samples, one sample for each channel. Provide one sample for mono audio, two samples for stereo audio and so on. In case you provide more or less samples than channels being supported by the writer, then it is up to the writer whether to duplicate the samples or calculate an average or the like.
      Specified by:
      writeNext in interface org.refcodes.io.RowWriter<SoundSample>
      Specified by:
      writeNext in interface SampleWriter<SoundSample,CsvSoundSampleWriter>
      Specified by:
      writeNext in interface SoundSampleWriter<CsvSoundSampleWriter>
      Parameters:
      aSample - The samples, one for each channel.

    • getSamplingRate

      public int getSamplingRate()
      Retrieves the sampling rate from the sampling rate property.
      Specified by:
      getSamplingRate in interface SamplingRateAccessor
      Returns:
      The sampling rate stored by the sampling rate property.

    • setSamplingRate

      public void setSamplingRate(int aSamplingRate)
      Sets the sampling rate for the sampling rate property.
      Specified by:
      setSamplingRate in interface SamplingRateAccessor.SamplingRateMutator
      Parameters:
      aSamplingRate - The sampling rate to be stored by the sampling rate property.

    • withSamplingRate

      public CsvSoundSampleWriter withSamplingRate(int aSamplingRate)
      Sets the sampling rate for the sampling rate property.
      Specified by:
      withSamplingRate in interface SamplingRateAccessor.SamplingRateBuilder<CsvSoundSampleWriter>
      Parameters:
      aSamplingRate - The sampling rate to be stored by the sampling rate property.
      Returns:
      The builder for applying multiple build operations.