class EE::Audio::SoundFileWriter

Overview

Abstract base class for sound file encoding. More…

#include <soundfilewriter.hpp>

class SoundFileWriter {
public:
    // construction

    virtual ~SoundFileWriter();

    // methods

    virtual bool open(const std::string& filename, unsigned int sampleRate, unsigned int channelCount) = 0;
    virtual void write(const Int16* samples, Uint64 count) = 0;
};

Detailed Documentation

Abstract base class for sound file encoding.

This class allows users to write audio file formats not natively supported by EEPP, and thus extend the set of supported writable audio formats.

A valid sound file writer must override the open and write functions, as well as providing a static check function; the latter is used by EEPP to find a suitable writer for a given filename.

To register a new writer, use the SoundFileFactory::registerWriter template function.

Usage example:

class MySoundFileWriter : public SoundFileWriter
{
public:

 static bool check(const std::string& filename)
 {
     // typically, check the extension
     // return true if the writer can handle the format
 }

 virtual bool open(const std::string& filename, unsigned int sampleRate, unsigned int
channelCount)
 {
     // open the file 'filename' for writing,
     // write the given sample rate and channel count to the file header
     // return true on success
 }

 virtual void write(const Int16* samples, Uint64 count)
 {
     // write 'count' samples stored at address 'samples',
     // convert them (for example to normalized float) if the format requires it
 }
};

SoundFileFactory::registerWriter<MySoundFileWriter>();

See also:

OutputSoundFile, SoundFileFactory, SoundFileReader

Methods

virtual bool open(const std::string& filename, unsigned int sampleRate, unsigned int channelCount) = 0

Open a sound file for writing.

Parameters:

filename	Path of the file to open
sampleRate	Sample rate of the sound
channelCount	Number of channels of the sound

Returns:

True if the file was successfully opened

virtual void write(const Int16* samples, Uint64 count) = 0

Write audio samples to the open file.

Parameters:

samples	Pointer to the sample array to write
count	Number of samples to write