juce_WavAudioFormat.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  WavAudioFormat  : public AudioFormat
{
public:
    //==============================================================================
    WavAudioFormat();

    ~WavAudioFormat() override;
 
    //==============================================================================
    // BWAV chunk properties:
 
    static const char* const bwavDescription;       
    static const char* const bwavOriginator;        
    static const char* const bwavOriginatorRef;     
    static const char* const bwavOriginationDate;   
    static const char* const bwavOriginationTime;   
    static const char* const bwavCodingHistory;     

    static const char* const bwavTimeReference;

    static StringPairArray createBWAVMetadata (const String& description,
                                               const String& originator,
                                               const String& originatorRef,
                                               Time dateAndTime,
                                               int64 timeReferenceSamples,
                                               const String& codingHistory);
 
    //==============================================================================
    // 'acid' chunk properties:
 
    static const char* const acidOneShot;           
    static const char* const acidRootSet;           
    static const char* const acidStretch;           
    static const char* const acidDiskBased;         
    static const char* const acidizerFlag;          
    static const char* const acidRootNote;          
    static const char* const acidBeats;             
    static const char* const acidDenominator;       
    static const char* const acidNumerator;         
    static const char* const acidTempo;             
 
    //==============================================================================
    // INFO chunk properties:
 
    static const char* const riffInfoArchivalLocation;      
    static const char* const riffInfoArtist;                
    static const char* const riffInfoBaseURL;               
    static const char* const riffInfoCinematographer;       
    static const char* const riffInfoComment;               
    static const char* const riffInfoComment2;              
    static const char* const riffInfoComments;              
    static const char* const riffInfoCommissioned;          
    static const char* const riffInfoCopyright;             
    static const char* const riffInfoCostumeDesigner;       
    static const char* const riffInfoCountry;               
    static const char* const riffInfoCropped;               
    static const char* const riffInfoDateCreated;           
    static const char* const riffInfoDateTimeOriginal;      
    static const char* const riffInfoDefaultAudioStream;    
    static const char* const riffInfoDimension;             
    static const char* const riffInfoDirectory;             
    static const char* const riffInfoDistributedBy;         
    static const char* const riffInfoDotsPerInch;           
    static const char* const riffInfoEditedBy;              
    static const char* const riffInfoEighthLanguage;        
    static const char* const riffInfoEncodedBy;             
    static const char* const riffInfoEndTimecode;           
    static const char* const riffInfoEngineer;              
    static const char* const riffInfoFifthLanguage;         
    static const char* const riffInfoFirstLanguage;         
    static const char* const riffInfoFourthLanguage;        
    static const char* const riffInfoGenre;                 
    static const char* const riffInfoKeywords;              
    static const char* const riffInfoLanguage;              
    static const char* const riffInfoLength;                
    static const char* const riffInfoLightness;             
    static const char* const riffInfoLocation;              
    static const char* const riffInfoLogoIconURL;           
    static const char* const riffInfoLogoURL;               
    static const char* const riffInfoMedium;                
    static const char* const riffInfoMoreInfoBannerImage;   
    static const char* const riffInfoMoreInfoBannerURL;     
    static const char* const riffInfoMoreInfoText;          
    static const char* const riffInfoMoreInfoURL;           
    static const char* const riffInfoMusicBy;               
    static const char* const riffInfoNinthLanguage;         
    static const char* const riffInfoNumberOfParts;         
    static const char* const riffInfoOrganisation;          
    static const char* const riffInfoPart;                  
    static const char* const riffInfoProducedBy;            
    static const char* const riffInfoProductName;           
    static const char* const riffInfoProductionDesigner;    
    static const char* const riffInfoProductionStudio;      
    static const char* const riffInfoRate;                  
    static const char* const riffInfoRated;                 
    static const char* const riffInfoRating;                
    static const char* const riffInfoRippedBy;              
    static const char* const riffInfoSecondaryGenre;        
    static const char* const riffInfoSecondLanguage;        
    static const char* const riffInfoSeventhLanguage;       
    static const char* const riffInfoSharpness;             
    static const char* const riffInfoSixthLanguage;         
    static const char* const riffInfoSoftware;              
    static const char* const riffInfoSoundSchemeTitle;      
    static const char* const riffInfoSource;                
    static const char* const riffInfoSourceFrom;            
    static const char* const riffInfoStarring_ISTR;         
    static const char* const riffInfoStarring_STAR;         
    static const char* const riffInfoStartTimecode;         
    static const char* const riffInfoStatistics;            
    static const char* const riffInfoSubject;               
    static const char* const riffInfoTapeName;              
    static const char* const riffInfoTechnician;            
    static const char* const riffInfoThirdLanguage;         
    static const char* const riffInfoTimeCode;              
    static const char* const riffInfoTitle;                 
    static const char* const riffInfoTrackNo;               
    static const char* const riffInfoTrackNumber;           
    static const char* const riffInfoURL;                   
    static const char* const riffInfoVegasVersionMajor;     
    static const char* const riffInfoVegasVersionMinor;     
    static const char* const riffInfoVersion;               
    static const char* const riffInfoWatermarkURL;          
    static const char* const riffInfoWrittenBy;             
    static const char* const riffInfoYear;                  
 
    //==============================================================================
    // ASWG chunk properties:
 
    static const char* const aswgContentType;               
    static const char* const aswgProject;                   
    static const char* const aswgOriginator;                
    static const char* const aswgOriginatorStudio;          
    static const char* const aswgNotes;                     
    static const char* const aswgSession;                   
    static const char* const aswgState;                     
    static const char* const aswgEditor;                    
    static const char* const aswgMixer;                     
    static const char* const aswgFxChainName;               
    static const char* const aswgChannelConfig;             
    static const char* const aswgAmbisonicFormat;           
    static const char* const aswgAmbisonicChnOrder;         
    static const char* const aswgAmbisonicNorm;             
    static const char* const aswgMicType;                   
    static const char* const aswgMicConfig;                 
    static const char* const aswgMicDistance;               
    static const char* const aswgRecordingLoc;              
    static const char* const aswgIsDesigned;                
    static const char* const aswgRecEngineer;               
    static const char* const aswgRecStudio;                 
    static const char* const aswgImpulseLocation;           
    static const char* const aswgCategory;                  
    static const char* const aswgSubCategory;               
    static const char* const aswgCatId;                     
    static const char* const aswgUserCategory;              
    static const char* const aswgUserData;                  
    static const char* const aswgVendorCategory;            
    static const char* const aswgFxName;                    
    static const char* const aswgLibrary;                   
    static const char* const aswgCreatorId;                 
    static const char* const aswgSourceId;                  
    static const char* const aswgRmsPower;                  
    static const char* const aswgLoudness;                  
    static const char* const aswgLoudnessRange;             
    static const char* const aswgMaxPeak;                   
    static const char* const aswgSpecDensity;               
    static const char* const aswgZeroCrossRate;             
    static const char* const aswgPapr;                      
    static const char* const aswgText;                      
    static const char* const aswgEfforts;                   
    static const char* const aswgEffortType;                
    static const char* const aswgProjection;                
    static const char* const aswgLanguage;                  
    static const char* const aswgTimingRestriction;         
    static const char* const aswgCharacterName;             
    static const char* const aswgCharacterGender;           
    static const char* const aswgCharacterAge;              
    static const char* const aswgCharacterRole;             
    static const char* const aswgActorName;                 
    static const char* const aswgActorGender;               
    static const char* const aswgDirector;                  
    static const char* const aswgDirection;                 
    static const char* const aswgFxUsed;                    
    static const char* const aswgUsageRights;               
    static const char* const aswgIsUnion;                   
    static const char* const aswgAccent;                    
    static const char* const aswgEmotion;                   
    static const char* const aswgComposor;                  
    static const char* const aswgArtist;                    
    static const char* const aswgSongTitle;                 
    static const char* const aswgGenre;                     
    static const char* const aswgSubGenre;                  
    static const char* const aswgProducer;                  
    static const char* const aswgMusicSup;                  
    static const char* const aswgInstrument;                
    static const char* const aswgMusicPublisher;            
    static const char* const aswgRightsOwner;               
    static const char* const aswgIsSource;                  
    static const char* const aswgIsLoop;                    
    static const char* const aswgIntensity;                 
    static const char* const aswgIsFinal;                   
    static const char* const aswgOrderRef;                  
    static const char* const aswgIsOst;                     
    static const char* const aswgIsCinematic;               
    static const char* const aswgIsLicensed;                
    static const char* const aswgIsDiegetic;                
    static const char* const aswgMusicVersion;              
    static const char* const aswgIsrcId;                    
    static const char* const aswgTempo;                     
    static const char* const aswgTimeSig;                   
    static const char* const aswgInKey;                     
    static const char* const aswgBillingCode;               
    static const char* const aswgVersion;                   
 
    //==============================================================================
    [[deprecated ("This string is identical to riffInfoSource, making it impossible to differentiate between the two")]]
    static const char* const ISRC;

    static const char* const internationalStandardRecordingCode;

    static const char* const tracktionLoopInfo;
 
    //==============================================================================
    Array<int> getPossibleSampleRates() override;
    Array<int> getPossibleBitDepths() override;
    bool canDoStereo() override;
    bool canDoMono() override;
    bool isChannelLayoutSupported (const AudioChannelSet& channelSet) override;
 
    //==============================================================================
    AudioFormatReader* createReaderFor (InputStream* sourceStream,
                                        bool deleteStreamIfOpeningFails) override;
 
    MemoryMappedAudioFormatReader* createMemoryMappedReader (const File&)      override;
    MemoryMappedAudioFormatReader* createMemoryMappedReader (FileInputStream*) override;
 
    AudioFormatWriter* createWriterFor (OutputStream* streamToWriteTo,
                                        double sampleRateToUse,
                                        unsigned int numberOfChannels,
                                        int bitsPerSample,
                                        const StringPairArray& metadataValues,
                                        int qualityOptionIndex) override;
 
    AudioFormatWriter* createWriterFor (OutputStream* streamToWriteTo,
                                        double sampleRateToUse,
                                        const AudioChannelSet& channelLayout,
                                        int bitsPerSample,
                                        const StringPairArray& metadataValues,
                                        int qualityOptionIndex) override;
    using AudioFormat::createWriterFor;
 
    //==============================================================================
    bool replaceMetadataInFile (const File& wavFile, const StringPairArray& newMetadata);
 
 
private:
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (WavAudioFormat)
};
 
} // namespace juce