pwavfile.h

Go to the documentation of this file.

/*
 * pwavfile.h
 *
 * WAV file I/O channel class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 2001 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is
 * Roger Hardiman <roger@freebsd.org>
 * and Shawn Pai-Hsiang Hsiao <shawn@eecs.harvard.edu>
 *
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 *
 * $Log: pwavfile.h,v $
 * Revision 1.31  2007/05/09 12:20:15  csoutheren
 * Applied 1712697 - WAVE form registration number for G.729A
 * Thanks to Borko Jandras
 *
 * Revision 1.30  2007/04/23 01:15:14  csoutheren
 * Removed warnings on Windows
 *
 * Revision 1.29  2007/04/20 07:59:29  csoutheren
 * Applied 1675658 - various pwavfile.[h|cxx] improvments
 * Thanks to Drazen Dimoti
 *
 * Revision 1.28  2007/04/19 04:33:53  csoutheren
 * Fixed problems with pre-compiled headers
 *
 * Revision 1.27  2006/08/08 08:14:59  rjongbloed
 * Fixed GCC warnings on packed structures that do not need packing.
 *
 * Revision 1.26  2006/06/21 05:19:38  csoutheren
 * Fixed build with latest PWLib
 *
 * Revision 1.25  2006/04/10 23:57:25  csoutheren
 * Checked in changes to remove some warnings with gcc effc++ flag
 *
 * Revision 1.24  2006/04/06 00:39:37  csoutheren
 * Ensure autoconvert format is preserved across file close
 *
 * Revision 1.23  2005/11/30 12:47:37  csoutheren
 * Removed tabs, reformatted some code, and changed tags for Doxygen
 *
 * Revision 1.22  2005/10/30 23:25:51  csoutheren
 * Fixed formatting
 * Removed throw() declarations (PWLib does not do exceptions)
 * Removed duplicate destructor declarations and definitions
 *
 * Revision 1.21  2005/10/30 19:41:53  dominance
 * fixed most of the warnings occuring during compilation
 *
 * Revision 1.20  2005/06/09 00:33:12  csoutheren
 * Fixed crash problem caused by recent leak fix
 * Removed bogus error when reading all of file contents in a single read
 *
 * Revision 1.19  2005/05/12 05:25:04  csoutheren
 * PWAVFile format abstract factory must use a PCaseless as a key
 *
 * Revision 1.18  2005/03/19 02:52:53  csoutheren
 * Fix warnings from gcc 4.1-20050313 shapshot
 *
 * Revision 1.17  2005/01/04 07:44:02  csoutheren
 * More changes to implement the new configuration methodology, and also to
 * attack the global static problem
 *
 * Revision 1.16  2004/11/11 07:34:50  csoutheren
 * Added #include <ptlib.h>
 *
 * Revision 1.15  2004/11/08 04:07:40  csoutheren
 * Fixed crash opportunity under some conditions
 * Fixed incorrect WAV file type display
 *
 * Revision 1.14  2004/07/15 03:12:41  csoutheren
 * Migrated changes from crs_vxnml_devel branch into main trunk
 *
 * Revision 1.13.4.4  2004/07/13 08:13:04  csoutheren
 * Lots of implementation of factory-based PWAVFile
 *
 * Revision 1.13.4.3  2004/07/12 09:17:19  csoutheren
 * Fixed warnings and errors under Linux
 *
 * Revision 1.13.4.2  2004/07/12 08:30:16  csoutheren
 * More fixes for abstract factory implementation of PWAVFile
 *
 * Revision 1.13.4.1  2004/07/07 07:07:41  csoutheren
 * Changed PWAVFile to use abstract factories (extensively)
 * Removed redundant blocking/unblocking when using G.723.1
 * More support for call transfer
 *
 * Revision 1.13  2003/03/07 06:12:05  robertj
 * Added more WAV file "magic numbers".
 *
 * Revision 1.12  2002/09/16 01:08:59  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 1.11  2002/06/20 00:51:38  craigs
 * Added virtuals to allow overriding
 *
 * Revision 1.10  2002/05/21 01:56:53  robertj
 * Removed the enum which made yet another set of magic numbers for audio
 *   formats, now uses the WAV file format numbers.
 * Fixed failure to write header when destroying object without and explicit
 *   call to Close().
 * Fixed missing Open() function which does not have file name parameter.
 * Added ability to set the audio format after construction.
 *
 * Revision 1.9  2002/01/22 03:55:07  craigs
 * Added #define guards when file moved to PTCLib
 *
 * Revision 1.8  2002/01/13 21:00:41  rogerh
 * The type of new .WAV files must now be specified in the class constructor.
 * Take out Open() function from the last commit and create a new Open()
 * function which replaces the one in the PFile base class.
 *
 * Revision 1.7  2002/01/11 16:33:46  rogerh
 * Create a PWAVFile Open() function, which processes the WAV header
 *
 * Revision 1.6  2001/10/16 13:27:37  rogerh
 * Add support for writing G.723.1 WAV files.
 * MS Windows can play G.723.1 WAV Files in Media Player and Sound Recorder.
 * Sound Recorder can also convert them to normal PCM format WAV files.
 * Thanks go to M.Stoychev <M.Stoychev@cnsys.bg> for sample WAV files.
 *
 * Revision 1.5  2001/10/15 11:48:15  rogerh
 * Add GetFormat to return the format of a WAV file
 *
 * Revision 1.4  2001/07/23 01:20:20  rogerh
 * Add updates from Shawn - ensure isvalidWAV is false for zero length files.
 * GetDataLength uses actual file size to support file updates as well as appends.
 * Add updates from Roger - Update Header() just writes to specific fields which
 * preserves any 'extra' data in an existing header between FORMAT and DATA chunks.
 *
 * Revision 1.3  2001/07/20 07:06:27  rogerh
 * Fix a typo
 *
 * Revision 1.2  2001/07/20 03:30:59  robertj
 * Minor cosmetic changes to new PWAVFile class.
 *
 * Revision 1.1  2001/07/19 09:55:48  rogerh
 * Add PWAVFile, a class to read and write .wav files, written by
 * Roger Hardiman and <roger@freebsd.org> and
 * Shawn Pai-Hsiang Hsiao <shawn@eecs.harvard.edu>
 *
 *
 */

#ifndef _PWAVFILE
#define _PWAVFILE

//#ifdef P_USE_PRAGMA
//#pragma interface
//#endif

#ifndef _PTLIB_H
#include <ptlib.h>
#endif

#include <ptlib/pfactory.h>

class PWAVFile;

namespace PWAV {

#ifdef __GNUC__
#define P_PACKED    __attribute__ ((packed));
#else
#define P_PACKED
#pragma pack(1)
#endif

struct ChunkHeader
{
  char    tag[4];
  PInt32l len    P_PACKED;
};

struct RIFFChunkHeader 
{
  ChunkHeader hdr;
  char        tag[4];
};

struct FMTChunk
{
  ChunkHeader hdr;                    
  PUInt16l format          P_PACKED;  
  PUInt16l numChannels     P_PACKED;  
  PUInt32l sampleRate      P_PACKED;  
  PUInt32l bytesPerSec     P_PACKED;  
  PUInt16l bytesPerSample  P_PACKED;  
  PUInt16l bitsPerSample   P_PACKED;  
};

}; // namespace PWAV

#ifdef __GNUC__
#undef P_PACKED
#else
#pragma pack()
#endif

class PWAVFileFormat
{
  public:
    virtual ~PWAVFileFormat() { }

    virtual unsigned GetFormat() const = 0;

    virtual PString GetFormatString() const = 0;

    virtual PString GetDescription() const = 0;

    virtual void CreateHeader(PWAV::FMTChunk & header, PBYTEArray & extendedHeader) = 0;

    virtual void UpdateHeader(PWAV::FMTChunk & /*header*/, PBYTEArray & /*extendedHeader*/)
    { }

    virtual BOOL WriteExtraChunks(PWAVFile & /*file*/)
    { return TRUE; }

    virtual BOOL ReadExtraChunks(PWAVFile & /*file*/)
    { return TRUE; }

    virtual void OnStart()
    { }

    virtual void OnStop()
    { }

    virtual BOOL Read(PWAVFile & file, void * buf, PINDEX & len);

    virtual BOOL Write(PWAVFile & file, const void * buf, PINDEX & len);
};

typedef PFactory<PWAVFileFormat, PCaselessString> PWAVFileFormatByFormatFactory;
typedef PFactory<PWAVFileFormat, unsigned> PWAVFileFormatByIDFactory;

class PWAVFileConverter 
{
  public:
    virtual ~PWAVFileConverter() { }
    virtual unsigned GetFormat    (const PWAVFile & file) const = 0;
    virtual off_t GetPosition     (const PWAVFile & file) const = 0;
    virtual BOOL SetPosition      (PWAVFile & file, off_t pos, PFile::FilePositionOrigin origin) = 0;
    virtual unsigned GetSampleSize(const PWAVFile & file) const = 0;
    virtual off_t GetDataLength   (PWAVFile & file) = 0;
    virtual BOOL Read             (PWAVFile & file, void * buf, PINDEX len)  = 0;
    virtual BOOL Write            (PWAVFile & file, const void * buf, PINDEX len) = 0;
};

typedef PFactory<PWAVFileConverter, unsigned> PWAVFileConverterFactory;

class PWAVFile : public PFile
{
  PCLASSINFO(PWAVFile, PFile);

  public:
    enum {
      fmt_PCM         = 1,      
      fmt_MSADPCM     = 2,      
      fmt_ALaw        = 6,      
      fmt_uLaw        = 7,      
      fmt_VOXADPCM    = 0x10,   
      fmt_IMAADPCM    = 0x11,   
      fmt_GSM         = 0x31,   
      fmt_G728        = 0x41,   
      fmt_G723        = 0x42,   
      fmt_MSG7231     = 0x42,   
      fmt_G726        = 0x64,   
      fmt_G722        = 0x65,   
      fmt_G729        = 0x83,   
      fmt_VivoG7231   = 0x111,  

      // For backward compatibility
      PCM_WavFile     = fmt_PCM,
      G7231_WavFile   = fmt_VivoG7231,

      // allow opening files without knowing the format
      fmt_NotKnown    = 0x10000
    };

    PWAVFile(
      unsigned format = fmt_PCM 
    );
    static PWAVFile * format(
      const PString & format    
    );

    PWAVFile(
      OpenMode mode,          
      int opts = ModeDefault, 
      unsigned format = fmt_PCM 
    );
    static PWAVFile * format(
      const PString & format,  
      PFile::OpenMode mode,          
      int opts = PFile::ModeDefault 
    );

    PWAVFile(
      const PFilePath & name,     
      OpenMode mode = ReadWrite,  
      int opts = ModeDefault,     
      unsigned format = fmt_PCM 
    );
    PWAVFile(
      const PString & format,  
      const PFilePath & name,     
      OpenMode mode = PFile::ReadWrite,  
      int opts = PFile::ModeDefault     
    );

    ~PWAVFile();

    virtual BOOL Read(
      void * buf,   
      PINDEX len    
    );

    virtual BOOL Write(
      const void * buf,   
      PINDEX len    
    );

    virtual BOOL Open(
      OpenMode mode = ReadWrite,  
      int opts = ModeDefault      
    );

    virtual BOOL Open(
      const PFilePath & name,    
      OpenMode mode = ReadWrite, 
      int opts = ModeDefault     
    );

    virtual BOOL Close();

    virtual BOOL SetPosition(
      off_t pos,                         
      FilePositionOrigin origin = Start  
    );

    virtual off_t GetPosition() const;

    virtual BOOL SetFormat(unsigned fmt);
    virtual BOOL SetFormat(const PString & format);

    virtual unsigned GetFormat() const;
    virtual PString GetFormatAsString() const;

    virtual unsigned GetChannels() const;
    virtual void SetChannels(unsigned v);

    virtual unsigned GetSampleRate() const;
    virtual void SetSampleRate(unsigned v);

    virtual unsigned GetSampleSize() const;
    virtual void SetSampleSize(unsigned v);

    virtual unsigned GetBytesPerSecond() const;
    virtual void SetBytesPerSecond(unsigned v);

    off_t GetHeaderLength() const;

    virtual off_t GetDataLength();

    BOOL IsValid() const { return isValidWAV; }

    PString GetFormatString() const
    { if (formatHandler == NULL) return PString("N/A"); else return formatHandler->GetFormatString(); }

    void SetAutoconvert();

 
    friend class PWAVFileConverter;

    BOOL RawRead(void * buf, PINDEX len);
    BOOL RawWrite(const void * buf, PINDEX len);

    BOOL FileRead(void * buf, PINDEX len);
    BOOL FileWrite(const void * buf, PINDEX len);

    off_t RawGetPosition() const;
    BOOL RawSetPosition(off_t pos, FilePositionOrigin origin);
    off_t RawGetDataLength();

    void SetLastReadCount(PINDEX v) { lastReadCount = v; } 

    PWAV::FMTChunk wavFmtChunk;
    PBYTEArray extendedHeader;

  protected:
    void Construct();
    void SelectFormat(unsigned fmt);
    void SelectFormat(const PString & format);

    PBYTEArray wavHeaderData;

    BOOL ProcessHeader();
    BOOL GenerateHeader();
    BOOL UpdateHeader();

    BOOL     isValidWAV;

    unsigned int origFmt;
    PWAVFileFormat * formatHandler;

    BOOL     autoConvert;
    PWAVFileConverter * autoConverter;

    off_t lenHeader;
    off_t lenData;

    BOOL     header_needs_updating;
};

#endif

// End Of File ///////////////////////////////////////////////////////////////

---