juce_AudioFormat.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  AudioFormat
{
public:
    //==============================================================================
    virtual ~AudioFormat();
 
    //==============================================================================
    const String& getFormatName() const;
 
    //==============================================================================
    virtual StringArray getFileExtensions() const;

    virtual bool canHandleFile (const File& fileToTest);

    virtual Array<int> getPossibleSampleRates() = 0;

    virtual Array<int> getPossibleBitDepths() = 0;

    virtual bool canDoStereo() = 0;

    virtual bool canDoMono() = 0;

    virtual bool isCompressed();

    virtual bool isChannelLayoutSupported (const AudioChannelSet& channelSet);

    virtual StringArray getQualityOptions();
 
    //==============================================================================
    virtual AudioFormatReader* createReaderFor (InputStream* sourceStream,
                                                bool deleteStreamIfOpeningFails) = 0;

    virtual MemoryMappedAudioFormatReader* createMemoryMappedReader (const File& file);
    virtual MemoryMappedAudioFormatReader* createMemoryMappedReader (FileInputStream* fin);

    virtual AudioFormatWriter* createWriterFor (OutputStream* streamToWriteTo,
                                                double sampleRateToUse,
                                                unsigned int numberOfChannels,
                                                int bitsPerSample,
                                                const StringPairArray& metadataValues,
                                                int qualityOptionIndex) = 0;

    virtual AudioFormatWriter* createWriterFor (OutputStream* streamToWriteTo,
                                                double sampleRateToUse,
                                                const AudioChannelSet& channelLayout,
                                                int bitsPerSample,
                                                const StringPairArray& metadataValues,
                                                int qualityOptionIndex);
 
protected:
    AudioFormat (String formatName, StringArray fileExtensions);

    AudioFormat (StringRef formatName, StringRef fileExtensions);
 
private:
    //==============================================================================
    String formatName;
    StringArray fileExtensions;
};
 
} // namespace juce