sound.h

Go to the documentation of this file.

/*
 * sound.h
 *
 * Sound interface class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 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 Equivalence Pty. Ltd.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 *
 * $Log: sound.h,v $
 * Revision 1.40  2007/04/13 07:03:19  rjongbloed
 * Added WAV file audio device "plug in".
 *
 * Revision 1.39  2007/02/01 03:16:15  csoutheren
 * Implement GetName for sound channels
 *
 * Revision 1.38  2006/10/19 12:05:32  rjongbloed
 * Added missing Close() function apss thru on PSoundChannel wrapper class.
 *
 * Revision 1.37  2006/06/21 03:28:41  csoutheren
 * Various cleanups thanks for Frederic Heem
 *
 * Revision 1.36  2005/11/25 03:43:47  csoutheren
 * Fixed function argument comments to be compatible with Doxygen
 *
 * Revision 1.35  2005/08/09 09:08:09  rjongbloed
 * Merged new video code from branch back to the trunk.
 *
 * Revision 1.34.2.2  2005/07/17 11:47:45  rjongbloed
 * Fixed backward compatibility
 *
 * Revision 1.34.2.1  2005/07/17 09:27:04  rjongbloed
 * Major revisions of the PWLib video subsystem including:
 *   removal of F suffix on colour formats for vertical flipping, all done with existing bool
 *   working through use of RGB and BGR formats so now consistent
 *   cleaning up the plug in system to use virtuals instead of pointers to functions.
 *   rewrite of SDL to be a plug in compatible video output device.
 *   extensive enhancement of video test program
 *
 * Revision 1.34  2005/07/13 13:02:35  csoutheren
 * Unified interface across Windows and Unix
 *
 * Revision 1.33  2005/07/04 11:35:03  shorne
 * Added ability to play sound to specfied device (Win32).
 *
 * Revision 1.32  2005/01/04 07:44:03  csoutheren
 * More changes to implement the new configuration methodology, and also to
 * attack the global static problem
 *
 * Revision 1.31  2004/11/01 23:16:59  ykiryanov
 * Added macro declaring sound plugin to be static for BeOS
 *
 * Revision 1.30  2003/12/28 02:03:18  csoutheren
 * Fixed problem with GetLastReadCount/GetLastWriteCount  on Windows sound devices
 *
 * Revision 1.29  2003/11/18 10:50:26  csoutheren
 * Changed name of Windows sound device
 *
 * Revision 1.28  2003/11/14 05:59:09  csoutheren
 * Added Read function, thanks to Derek Smithies
 *
 * Revision 1.27  2003/11/12 10:25:41  csoutheren
 * Changes to allow operation of static plugins under Windows
 *
 * Revision 1.26  2003/11/12 05:18:04  csoutheren
 * Added more backwards compatibility functions for PSoundChannel
 *
 * Revision 1.25  2003/11/12 04:33:32  csoutheren
 * Fixed problem with static linking of sound plugins
 * Fixed problem with Windows sound driver
 *
 * Revision 1.24  2003/11/12 03:29:51  csoutheren
 * Initial version of plugin code from Snark of GnomeMeeting with changes
 *    by Craig Southeren of Post Increment
 *
 * Revision 1.23.2.2  2003/10/13 02:42:39  dereksmithies
 * Add additional functions, so plugins work better.
 *
 * Revision 1.23.2.1  2003/10/07 03:02:28  csoutheren
 * Initial checkin of pwlib code to do plugins.
 * Modified from original code and concept provided by Snark of Gnomemeeting
 *
 * Revision 1.23  2003/09/17 05:41:59  csoutheren
 * Removed recursive includes
 *
 * Revision 1.22  2003/09/17 01:18:02  csoutheren
 * Removed recursive include file system and removed all references
 * to deprecated coooperative threading support
 *
 * Revision 1.21  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.20  2002/02/08 09:58:44  robertj
 * Slight adjustment to API and documentation for volume functions.
 *
 * Revision 1.19  2002/02/07 20:57:21  dereks
 * add SetVolume and GetVolume methods to PSoundChannel
 *
 * Revision 1.18  2001/05/22 12:49:32  robertj
 * Did some seriously wierd rewrite of platform headers to eliminate the
 *   stupid GNU compiler warning about braces not matching.
 *
 * Revision 1.17  2001/02/07 03:33:43  craigs
 * Added functions to get sound channel parameters
 *
 * Revision 1.16  2000/03/04 10:15:32  robertj
 * Added simple play functions for sound files.
 *
 * Revision 1.15  1999/05/28 14:04:10  robertj
 * Added function to get default audio device.
 *
 * Revision 1.14  1999/03/09 02:59:51  robertj
 * Changed comments to doc++ compatible documentation.
 *
 * Revision 1.13  1999/02/22 10:15:14  robertj
 * Sound driver interface implementation to Linux OSS specification.
 *
 * Revision 1.12  1999/02/16 06:02:27  robertj
 * Major implementation to Linux OSS model
 *
 * Revision 1.11  1998/09/23 06:21:27  robertj
 * Added open source copyright license.
 *
 * Revision 1.10  1995/06/17 11:13:26  robertj
 * Documentation update.
 *
 * Revision 1.9  1995/03/14 12:42:40  robertj
 * Updated documentation to use HTML codes.
 *
 * Revision 1.8  1995/01/16  09:42:05  robertj
 * Documentation.
 *
 * Revision 1.7  1994/08/23  11:32:52  robertj
 * Oops
 *
 * Revision 1.6  1994/08/22  00:46:48  robertj
 * Added pragma fro GNU C++ compiler.
 *
 * Revision 1.5  1994/06/25  11:55:15  robertj
 * Unix version synchronisation.
 *
 * Revision 1.4  1994/01/03  04:42:23  robertj
 * Mass changes to common container classes and interactors etc etc etc.
 *
 * Revision 1.3  1993/09/29  03:06:30  robertj
 * Added unix compatibility to Beep()
 *
 * Revision 1.2  1993/07/14  12:49:16  robertj
 * Fixed RCS keywords.
 *
 */


#ifndef _PSOUND
#define _PSOUND

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib/plugin.h>
#include <ptlib/pluginmgr.h>

class PSound : public PBYTEArray
{
  PCLASSINFO(PSound, PBYTEArray);

  public:
    PSound(
      unsigned numChannels = 1,    
      unsigned sampleRate = 8000,  
      unsigned bitsPerSample = 16, 
      PINDEX   bufferSize = 0,     
      const BYTE * data = NULL     
    );

    PSound(
      const PFilePath & filename   
    );

    PSound & operator=(
      const PBYTEArray & data  
    );

    BOOL Load(
      const PFilePath & filename   
    );

    BOOL Save(
      const PFilePath & filename   
    );


    BOOL Play();

    BOOL Play(const PString & device);

    void SetFormat(
      unsigned numChannels,   
      unsigned sampleRate,    
      unsigned bitsPerSample  
    );

    unsigned GetEncoding()   const { return encoding; }

    unsigned GetChannels()   const { return numChannels; }

    unsigned GetSampleRate() const { return sampleRate; }

    unsigned GetSampleSize() const { return sampleSize; }

    DWORD    GetErrorCode()  const { return dwLastError; }

    PINDEX   GetFormatInfoSize()  const { return formatInfo.GetSize(); }

    const void * GetFormatInfoData() const { return (const BYTE *)formatInfo; }

    static BOOL PlayFile(
      const PFilePath & file, 
      BOOL wait = TRUE        
    );

    static void Beep();

  protected:
    unsigned   encoding;      
    unsigned   numChannels;   
    unsigned   sampleRate;    
    unsigned   sampleSize;    
    DWORD      dwLastError;   
    PBYTEArray formatInfo;    
};


class PSoundChannel : public PChannel
{
  PCLASSINFO(PSoundChannel, PChannel);

  public:
    enum Directions {
      Recorder,
      Player
    };

    PSoundChannel();

    PSoundChannel(
      const PString & device,       
      Directions dir,               
      unsigned numChannels = 1,     
      unsigned sampleRate = 8000,   
      unsigned bitsPerSample = 16   
    );
    // 

    virtual ~PSoundChannel();
    // Destroy and close the sound driver

    static PStringList GetDriverNames(
      PPluginManager * pluginMgr = NULL   
    );

    static PStringList GetDriversDeviceNames(
      const PString & driverName,         
      Directions direction,               
      PPluginManager * pluginMgr = NULL   
    );

    // For backward compatibility
    static inline PStringList GetDeviceNames(
      const PString & driverName,
      Directions direction,
      PPluginManager * pluginMgr = NULL
    ) { return GetDriversDeviceNames(driverName, direction, pluginMgr); }

    static PSoundChannel * CreateChannel (
      const PString & driverName,         
      PPluginManager * pluginMgr = NULL   
    );

    /* Create the matching sound channel that corresponds to the device name.
       So, for "fake" return a device that will generate fake video.
       For "Phillips 680 webcam" (eg) will return appropriate grabber.
       Note that Phillips will return the appropriate grabber also.

       This is typically used with the return values from GetDeviceNames().
     */
    static PSoundChannel * CreateChannelByName(
      const PString & deviceName,         
      Directions direction,               
      PPluginManager * pluginMgr = NULL   
    );

    static PSoundChannel * CreateOpenedChannel(
      const PString & driverName,         
      const PString & deviceName,         
      Directions direction,               
      unsigned numChannels = 1,           
      unsigned sampleRate = 8000,         
      unsigned bitsPerSample = 16,        
      PPluginManager * pluginMgr = NULL   
    );

    static PString GetDefaultDevice(
      Directions dir    // Sound I/O direction
    );

    static PStringList GetDeviceNames(
      Directions direction,               
      PPluginManager * pluginMgr = NULL   
    );

    virtual BOOL Open(
      const PString & device,       
      Directions dir,               
      unsigned numChannels = 1,     
      unsigned sampleRate = 8000,   
      unsigned bitsPerSample = 16   
    );

    virtual BOOL IsOpen() const;

    virtual BOOL Close();

    virtual int GetHandle() const;

    virtual PString GetName() const;

    virtual BOOL Abort();

    virtual BOOL SetFormat(
      unsigned numChannels = 1,     
      unsigned sampleRate = 8000,   
      unsigned bitsPerSample = 16   
    );

    virtual unsigned GetChannels() const;

    virtual unsigned GetSampleRate() const;

    virtual unsigned GetSampleSize() const;

    virtual BOOL SetBuffers(
      PINDEX size,      
      PINDEX count = 2  
    );

    virtual BOOL GetBuffers(
      PINDEX & size,    // Size of each buffer
      PINDEX & count    // Number of buffers
    );

    enum {
      MaxVolume = 100
    };

    virtual BOOL SetVolume(
      unsigned volume   
    );

    virtual BOOL GetVolume(
      unsigned & volume   
    );


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

    virtual PINDEX GetLastWriteCount() const;

    virtual BOOL PlaySound(
      const PSound & sound,   
      BOOL wait = TRUE        
    );
    virtual BOOL PlayFile(
      const PFilePath & file, 
      BOOL wait = TRUE        
    );

    virtual BOOL HasPlayCompleted();

    virtual BOOL WaitForPlayCompletion();


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

    PINDEX GetLastReadCount() const;

    virtual BOOL RecordSound(
      PSound & sound 
    );

    virtual BOOL RecordFile(
      const PFilePath & file 
    );

    virtual BOOL StartRecording();

    virtual BOOL IsRecordBufferFull();

    virtual BOOL AreAllRecordBuffersFull();

    virtual BOOL WaitForRecordBufferFull();

    virtual BOOL WaitForAllRecordBuffersFull();

  protected:
    PSoundChannel * baseChannel;
};



// define the sound plugin service descriptor

template <class className> class PSoundChannelPluginServiceDescriptor : public PDevicePluginServiceDescriptor
{
  public:
    virtual PObject *   CreateInstance(int /*userData*/) const { return new className; }
    virtual PStringList GetDeviceNames(int userData) const { return className::GetDeviceNames((PSoundChannel::Directions)userData); }
};

#define PCREATE_SOUND_PLUGIN(name, className) \
  static PSoundChannelPluginServiceDescriptor<className> className##_descriptor; \
  PCREATE_PLUGIN(name, PSoundChannel, &className##_descriptor)

#endif

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

---