include/ptclib/pwavfile.h

   1 /*
   2  * pwavfile.h
   3  *
   4  * WAV file I/O channel class.
   5  *
   6  * Portable Windows Library
   7  *
   8  * Copyright (c) 2001 Equivalence Pty. Ltd.
   9  *
  10  * The contents of this file are subject to the Mozilla Public License
  11  * Version 1.0 (the "License"); you may not use this file except in
  12  * compliance with the License. You may obtain a copy of the License at
  13  * http://www.mozilla.org/MPL/
  14  *
  15  * Software distributed under the License is distributed on an "AS IS"
  16  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  17  * the License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * The Original Code is Portable Windows Library.
  21  *
  22  * The Initial Developer of the Original Code is
  23  * Roger Hardiman <roger@freebsd.org>
  24  * and Shawn Pai-Hsiang Hsiao <shawn@eecs.harvard.edu>
  25  *
  26  * All Rights Reserved.
  27  *
  28  * Contributor(s): ______________________________________.
  29  *
  30  * $Log$
  31  * Revision 1.14  2004/07/15 03:12:41  csoutheren
  32  * Migrated changes from crs_vxnml_devel branch into main trunk
  33  *
  34  * Revision 1.13.4.4  2004/07/13 08:13:04  csoutheren
  35  * Lots of implementation of factory-based PWAVFile
  36  *
  37  * Revision 1.13.4.3  2004/07/12 09:17:19  csoutheren
  38  * Fixed warnings and errors under Linux
  39  *
  40  * Revision 1.13.4.2  2004/07/12 08:30:16  csoutheren
  41  * More fixes for abstract factory implementation of PWAVFile
  42  *
  43  * Revision 1.13.4.1  2004/07/07 07:07:41  csoutheren
  44  * Changed PWAVFile to use abstract factories (extensively)
  45  * Removed redundant blocking/unblocking when using G.723.1
  46  * More support for call transfer
  47  *
  48  * Revision 1.13  2003/03/07 06:12:05  robertj
  49  * Added more WAV file "magic numbers".
  50  *
  51  * Revision 1.12  2002/09/16 01:08:59  robertj
  52  * Added #define so can select if #pragma interface/implementation is used on
  53  *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
  54  *
  55  * Revision 1.11  2002/06/20 00:51:38  craigs
  56  * Added virtuals to allow overriding
  57  *
  58  * Revision 1.10  2002/05/21 01:56:53  robertj
  59  * Removed the enum which made yet another set of magic numbers for audio
  60  *   formats, now uses the WAV file format numbers.
  61  * Fixed failure to write header when destroying object without and explicit
  62  *   call to Close().
  63  * Fixed missing Open() function which does not have file name parameter.
  64  * Added ability to set the audio format after construction.
  65  *
  66  * Revision 1.9  2002/01/22 03:55:07  craigs
  67  * Added #define guards when file moved to PTCLib
  68  *
  69  * Revision 1.8  2002/01/13 21:00:41  rogerh
  70  * The type of new .WAV files must now be specified in the class constructor.
  71  * Take out Open() function from the last commit and create a new Open()
  72  * function which replaces the one in the PFile base class.
  73  *
  74  * Revision 1.7  2002/01/11 16:33:46  rogerh
  75  * Create a PWAVFile Open() function, which processes the WAV header
  76  *
  77  * Revision 1.6  2001/10/16 13:27:37  rogerh
  78  * Add support for writing G.723.1 WAV files.
  79  * MS Windows can play G.723.1 WAV Files in Media Player and Sound Recorder.
  80  * Sound Recorder can also convert them to normal PCM format WAV files.
  81  * Thanks go to M.Stoychev <M.Stoychev@cnsys.bg> for sample WAV files.
  82  *
  83  * Revision 1.5  2001/10/15 11:48:15  rogerh
  84  * Add GetFormat to return the format of a WAV file
  85  *
  86  * Revision 1.4  2001/07/23 01:20:20  rogerh
  87  * Add updates from Shawn - ensure isvalidWAV is false for zero length files.
  88  * GetDataLength uses actual file size to support file updates as well as appends.
  89  * Add updates from Roger - Update Header() just writes to specific fields which
  90  * preserves any 'extra' data in an existing header between FORMAT and DATA chunks.
  91  *
  92  * Revision 1.3  2001/07/20 07:06:27  rogerh
  93  * Fix a typo
  94  *
  95  * Revision 1.2  2001/07/20 03:30:59  robertj
  96  * Minor cosmetic changes to new PWAVFile class.
  97  *
  98  * Revision 1.1  2001/07/19 09:55:48  rogerh
  99  * Add PWAVFile, a class to read and write .wav files, written by
 100  * Roger Hardiman and <roger@freebsd.org> and
 101  * Shawn Pai-Hsiang Hsiao <shawn@eecs.harvard.edu>
 102  *
 103  *
 104  */
 105
 106 #ifndef _PWAVFILE
 107 #define _PWAVFILE
 108
 109 //#ifdef P_USE_PRAGMA
 110 //#pragma interface
 111 //#endif
 112
 113 class PWAVFile;
 114
 115 namespace PWAV {
 116
 117 #ifdef __GNUC__
 118 #define P_PACKED    __attribute__ ((packed));
 119 #else
 120 #define P_PACKED
 121 #pragma pack(1)
 122 #endif
 123
 124 struct ChunkHeader
 125 {
 126   char    tag[4] P_PACKED;
 127   PInt32l len    P_PACKED;
 128 };
 129
 130 struct RIFFChunkHeader
 131 {
 132   ChunkHeader hdr    P_PACKED;
 133   char        tag[4] P_PACKED;
 134 };
 135
 136 struct FMTChunk
 137 {
 138   ChunkHeader hdr          P_PACKED;  // chunk header
 139   PUInt16l format          P_PACKED;  // Format
 140   PUInt16l numChannels     P_PACKED;  // Channels 0x01 = mono, 0x02 = stereo
 141   PUInt32l sampleRate      P_PACKED;  // Sample Rate in Hz
 142   PUInt32l bytesPerSec     P_PACKED;  // Average bytes Per Second
 143   PUInt16l bytesPerSample  P_PACKED;  // Bytes Per Sample, eg 2
 144   PUInt16l bitsPerSample   P_PACKED;  // Bits Per Sample, eg 16
 145 };
 146
 147 }; // namespace PWAV
 148
 149 #ifdef __GNUC__
 150 #undef P_PACKED
 151 #else
 152 #pragma pack()
 153 #endif
 154
 155 /**
 156   * abstract factory class for handling WAV files formats
 157   */
 158 class PWAVFileFormat
 159 {
 160   public:
 161     /**
 162       * return a PWAVFile format code
 163       */
 164     virtual unsigned GetFormat() const = 0;
 165
 166     /**
 167       * return a string that can be used as a media format
 168       */
 169     virtual PString GetFormatString() const = 0;
 170
 171     /**
 172      *  return a string that can be used as a text description
 173      */
 174     virtual PString GetDescription() const = 0;
 175
 176     /**
 177      *  populate the header with the correct values
 178      */
 179     virtual void CreateHeader(PWAV::FMTChunk & header, PBYTEArray & extendedHeader) = 0;
 180
 181     /**
 182       * write any extra headers after the FORMAT chunk
 183       */
 184     virtual BOOL WriteExtraChunks(PWAVFile & /*file*/)
 185     { return TRUE; }
 186
 187     /**
 188       * read any extra headers after the FORMAT chunk
 189       */
 190     virtual BOOL ReadExtraChunks(PWAVFile & /*file*/)
 191     { return TRUE; }
 192
 193      /**
 194       * called before the reading/writing starts
 195       */
 196     virtual void OnStart()
 197     { }
 198
 199      /**
 200       * called after the reading/writing stops
 201       */
 202     virtual void OnStop()
 203     { }
 204
 205     /**
 206       * write data to the file
 207       */
 208     virtual BOOL Read(PWAVFile & file, void * buf, PINDEX & len);
 209
 210     /**
 211       * read data from the file
 212       */
 213     virtual BOOL Write(PWAVFile & file, const void * buf, PINDEX & len);
 214 };
 215
 216 typedef PFactory<PWAVFileFormat> PWAVFileFormatByFormatFactory;
 217 typedef PFactory<PWAVFileFormat, unsigned> PWAVFileFormatByIDFactory;
 218
 219 /**
 220   * abstract factory class for autoconversion of WAV files to/from PCM-16
 221   */
 222 class PWAVFileConverter
 223 {
 224   public:
 225     virtual unsigned GetFormat    (const PWAVFile & file) const = 0;
 226     virtual off_t GetPosition     (const PWAVFile & file) const = 0;
 227     virtual BOOL SetPosition      (PWAVFile & file, off_t pos, PFile::FilePositionOrigin origin) = 0;
 228     virtual unsigned GetSampleSize(const PWAVFile & file) const = 0;
 229     virtual off_t GetDataLength   (PWAVFile & file) = 0;
 230     virtual BOOL Read             (PWAVFile & file, void * buf, PINDEX len)  = 0;
 231     virtual BOOL Write            (PWAVFile & file, const void * buf, PINDEX len) = 0;
 232 };
 233
 234 typedef PFactory<PWAVFileConverter, unsigned> PWAVFileConverterFactory;
 235
 236 /**A class representing a WAV audio file.
 237   */
 238 class PWAVFile : public PFile
 239 {
 240   PCLASSINFO(PWAVFile, PFile);
 241
 242   public:
 243   /**@name Construction */
 244   //@{
 245     /**When a file is opened for writing, we can specify if this is a PCM
 246        wav file or a G.723.1 wav file.
 247      */
 248     enum {
 249       fmt_PCM         = 1,      /// PCM, 8kHz, 16 bit, mono
 250       fmt_ALaw        = 6,      /// A-Law 8kHz
 251       fmt_uLaw        = 7,      /// u-Law 8kHz
 252       fmt_GSM         = 0x31,   /// GSM
 253       fmt_G728        = 0x41,   /// RFC2361
 254       fmt_G723        = 0x42,   /// RFC2361
 255       fmt_MSG7231     = 0x42,   /// Microsoft G.723.1
 256       fmt_G726        = 0x64,   /// RFC2361
 257       fmt_G722        = 0x65,   /// RFC2361
 258       fmt_G729        = 0x84,   /// RFC2361
 259       fmt_VivoG7231   = 0x111,  /// VivoActive G.723.1
 260
 261       // For backward compatibility
 262       PCM_WavFile     = fmt_PCM,
 263       G7231_WavFile   = fmt_VivoG7231,
 264
 265       // allow opening files without knowing the format
 266       fmt_NotKnown    = 0x10000
 267     };
 268
 269     /**Create a WAV file object but do not open it. It does not
 270        initially have a valid file name. However, an attempt to open the file
 271        using the #PFile::Open()# function will generate a unique
 272        temporary file.
 273
 274        If a WAV file is being created, the type parameter can be used
 275        to create a PCM Wave file or a G.723.1 Wave file by using
 276        #WaveType enum#
 277      */
 278     PWAVFile(
 279       unsigned format = fmt_PCM /// Type of WAV File to create
 280     );
 281     static PWAVFile * format(
 282       const PString & format    /// Type of WAV File to create
 283     );
 284
 285     /**Create a unique temporary file name, and open the file in the specified
 286        mode and using the specified options. Note that opening a new, unique,
 287        temporary file name in ReadOnly mode will always fail. This would only
 288        be usefull in a mode and options that will create the file.
 289
 290        If a WAV file is being created, the type parameter can be used
 291        to create a PCM Wave file or a G.723.1 Wave file by using
 292        #WaveType enum#
 293
 294        The #PChannel::IsOpen()# function may be used after object
 295        construction to determine if the file was successfully opened.
 296      */
 297     PWAVFile(
 298       OpenMode mode,          /// Mode in which to open the file.
 299       int opts = ModeDefault, /// #OpenOptions enum# for open operation.
 300       unsigned format = fmt_PCM /// Type of WAV File to create
 301     );
 302     static PWAVFile * format(
 303       const PString & format,  /// Type of WAV File to create
 304       PFile::OpenMode mode,          /// Mode in which to open the file.
 305       int opts = PFile::ModeDefault /// #OpenOptions enum# for open operation.
 306     );
 307
 308     /**Create a WAV file object with the specified name and open it in
 309        the specified mode and with the specified options.
 310        If a WAV file is being created, the type parameter can be used
 311        to create a PCM Wave file or a G.723.1 Wave file by using
 312        #WaveType enum#
 313
 314        The #PChannel::IsOpen()# function may be used after object
 315        construction to determine if the file was successfully opened.
 316      */
 317     PWAVFile(
 318       const PFilePath & name,     /// Name of file to open.
 319       OpenMode mode = ReadWrite,  /// Mode in which to open the file.
 320       int opts = ModeDefault,     /// #OpenOptions enum# for open operation.
 321       unsigned format = fmt_PCM /// Type of WAV File to create
 322     );
 323     PWAVFile(
 324       const PString & format,  /// Type of WAV File to create
 325       const PFilePath & name,     /// Name of file to open.
 326       OpenMode mode = PFile::ReadWrite,  /// Mode in which to open the file.
 327       int opts = PFile::ModeDefault     /// #OpenOptions enum# for open operation.
 328     );
 329
 330     /**Close the file before destruction.
 331       */
 332     ~PWAVFile() { Close(); }
 333   //@}
 334
 335   /**@name Overrides from class PFile */
 336   //@{
 337     /**Call PFile::Read() to read in audio data and perform necessary
 338        processing such as byte-order swaping.
 339
 340        @return
 341        TRUE indicates that at least one character was read from the channel.
 342        FALSE means no bytes were read due to timeout or some other I/O error.
 343     */
 344     virtual BOOL Read(
 345       void * buf,   /// Pointer to a block of memory to receive the read bytes.
 346       PINDEX len    /// Maximum number of bytes to read into the buffer.
 347     );
 348
 349     /**Call PFile::Write() to write out audio data and perform necessary
 350        processing such as byte-order swaping.
 351
 352        @return
 353        TRUE indicates that at least one character was written to the channel.
 354        FALSE means no bytes were written due to timeout or some other I/O error.
 355     */
 356     virtual BOOL Write(
 357       const void * buf,   /// Pointer to a block of memory to receive the write bytes.
 358       PINDEX len    /// Maximum number of bytes to write to the channel.
 359     );
 360
 361     /**Open the current file in the specified mode and with
 362        the specified options. If the file object already has an open file then
 363        it is closed.
 364
 365        If there has not been a filename attached to the file object (via
 366        #SetFilePath()#, the #name# parameter or a previous
 367        open) then a new unique temporary filename is generated.
 368
 369        @return
 370        TRUE if the file was successfully opened.
 371      */
 372     virtual BOOL Open(
 373       OpenMode mode = ReadWrite,  // Mode in which to open the file.
 374       int opts = ModeDefault      // Options for open operation.
 375     );
 376
 377     /**Open the specified WAV file name in the specified mode and with
 378        the specified options. If the file object already has an open file then
 379        it is closed.
 380        This reads (and validates) the header for existing files.
 381        For new files, it creates a new file (and header) using the type of
 382        WAV file specified in the class constructor.
 383
 384        Note: if #mode# is StandardInput, StandardOutput or StandardError,
 385        then the #name# parameter is ignored.
 386
 387        @return
 388        TRUE if the file was successfully opened.
 389      */
 390     virtual BOOL Open(
 391       const PFilePath & name,    // Name of file to open.
 392       OpenMode mode = ReadWrite, // Mode in which to open the file.
 393       int opts = ModeDefault     // #OpenOptions enum# for open operation.
 394     );
 395
 396     /** Close the file channel.
 397         If a WAV file has been written to, this will update the header
 398         to contain the correct size information.
 399         @return TRUE if close was OK.
 400       */
 401     virtual BOOL Close();
 402
 403     /**Set the current active position in the file for the next read or write
 404        operation. The #pos# variable is a signed number which is
 405        added to the specified origin. For #origin == PFile::Start#
 406        only positive values for #pos# are meaningful. For
 407        #origin == PFile::End# only negative values for
 408        #pos# are meaningful.
 409
 410        Note that for a WAV file, the origin of the file is right after
 411        the header. That is, the WAV header is not included when
 412        perform SetPosition().
 413
 414        @return
 415        TRUE if the new file position was set.
 416      */
 417     virtual BOOL SetPosition(
 418       off_t pos,                         /// New position to set.
 419       FilePositionOrigin origin = Start  /// Origin for position change.
 420     );
 421
 422     /**Get the current active position in the file for the next read
 423        or write operation. The WAV header is excluded from calculation
 424        the position.
 425
 426        @return
 427        current file position relative to the end of the WAV header.
 428      */
 429     virtual off_t GetPosition() const;
 430   //@}
 431
 432   /**@name Member variable access */
 433   //@{
 434     /**Find out the format of the WAV file. Eg 0x01 for PCM, 0x42 or 0x111 for G.723.1.
 435     */
 436     virtual BOOL SetFormat(unsigned fmt);
 437     virtual BOOL SetFormat(const PString & format);
 438
 439     /**Find out the format of the WAV file. Eg 0x01 for PCM, 0x42 or 0x111 for G.723.1.
 440     */
 441     virtual unsigned GetFormat() const;
 442     virtual PString GetFormatAsString() const;
 443
 444     /**Find out the number of channels the WAV file has. Typically this is 1 for
 445        mono and 2 for stereo.
 446     */
 447     virtual unsigned GetChannels() const;
 448     virtual void SetChannels(unsigned v);
 449
 450     /**Find out the sample rate of the WAV file in Hz.
 451     */
 452     virtual unsigned GetSampleRate() const;
 453     virtual void SetSampleRate(unsigned v);
 454
 455     /**Find out how may bits there are per sample, eg 8 or 16.
 456     */
 457     virtual unsigned GetSampleSize() const;
 458     virtual void SetSampleSize(unsigned v);
 459
 460     /**Find out the size of WAV header presented in the file.
 461     */
 462     off_t GetHeaderLength() const;
 463
 464     /**Find out how many bytes of audio data there are.
 465     */
 466     virtual off_t GetDataLength();
 467
 468     /**Determine if the WAV file is a valid wave file.
 469
 470       @return
 471       TRUE indicates that the WAV file is valid
 472       FALSE indicates that the WAV file is invalid
 473     */
 474     BOOL IsValid() const { return isValidWAV; }
 475
 476     /**
 477       *Return a string that describes the WAV format
 478       */
 479     PString GetFormatString() const
 480     { if (formatHandler == NULL) return PString("N/A"); else return formatHandler->GetFormat(); }
 481
 482     /**
 483       * enable autoconversion between PCM-16 and the native format
 484       */
 485     void SetAutoconvert();
 486
 487   //@}
 488
 489     friend class PWAVFileConverter;
 490
 491     BOOL RawRead(void * buf, PINDEX len);
 492     BOOL RawWrite(const void * buf, PINDEX len);
 493
 494     BOOL FileRead(void * buf, PINDEX len);
 495     BOOL FileWrite(const void * buf, PINDEX len);
 496
 497     off_t RawGetPosition() const;
 498     BOOL RawSetPosition(off_t pos, FilePositionOrigin origin);
 499     off_t RawGetDataLength();
 500
 501     void SetLastReadCount(PINDEX v) { lastReadCount = v; }
 502
 503     PWAV::FMTChunk wavFmtChunk;
 504     PBYTEArray extendedHeader;
 505
 506   protected:
 507     void Construct();
 508     void SelectFormat(unsigned fmt);
 509     void SelectFormat(const PString & format);
 510
 511     PBYTEArray wavHeaderData;
 512
 513     BOOL ProcessHeader();
 514     BOOL GenerateHeader();
 515     BOOL UpdateHeader();
 516
 517     BOOL     isValidWAV;
 518
 519     PWAVFileFormat * formatHandler;
 520
 521     BOOL     autoConvert;
 522     PWAVFileConverter * autoConverter;
 523
 524     off_t lenHeader;
 525     off_t lenData;
 526
 527     BOOL     header_needs_updating;
 528 };
 529
 530 #ifdef _WIN32
 531
 532 #  ifndef P_DISABLE_FACTORY_INSTANCES
 533
 534 #    ifndef  P_FACTORY_INSTANCE_PWAVFileConverter
 535 #      define P_FACTORY_INSTANCE_PWAVFileConverter 1
 536 #        pragma message("Including PWAVFileConverter factory loader")
 537          PLOAD_FACTORY(PWAVFileConverter, unsigned)
 538 #    endif
 539
 540 #    ifndef  P_FACTORY_INSTANCE_PWAVFileFormat
 541 #      define P_FACTORY_INSTANCE_PWAVFileFormat 1
 542 #        pragma message("Including PWAVFileFormat factory loader")
 543          PLOAD_FACTORY(PWAVFileFormat, unsigned)
 544 #    endif
 545
 546 # endif
 547
 548 #endif
 549
 550
 551 #endif
 552
 553 // End Of File ///////////////////////////////////////////////////////////////