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): ______________________________________.
 *
 * $Revision: 24177 $
 * $Author: rjongbloed $
 * $Date: 2010-04-05 06:52:04 -0500 (Mon, 05 Apr 2010) $
 */


#ifndef PTLIB_SOUND_H
#define PTLIB_SOUND_H

#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  
    );

    PBoolean Load(
      const PFilePath & filename   
    );

    PBoolean Save(
      const PFilePath & filename   
    );


    PBoolean Play();

    PBoolean 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 PBoolean PlayFile(
      const PFilePath & file, 
      PBoolean 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 PStringArray GetDriverNames(
      PPluginManager * pluginMgr = NULL   
    );

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

    // For backward compatibility
    static inline PStringArray 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 PStringArray GetDeviceNames(
      Directions direction,               
      PPluginManager * pluginMgr = NULL   
    );

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

    virtual PBoolean IsOpen() const;

    virtual PBoolean Close();

    virtual int GetHandle() const;

    virtual PString GetName() const;

    virtual PBoolean Abort();

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

    virtual unsigned GetChannels() const;

    virtual unsigned GetSampleRate() const;

    virtual unsigned GetSampleSize() const;

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

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

    enum {
      MaxVolume = 100
    };

    virtual PBoolean SetVolume(
      unsigned volume   
    );

    virtual PBoolean GetVolume(
      unsigned & volume   
    );


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

    virtual PINDEX GetLastWriteCount() const;

    virtual PBoolean PlaySound(
      const PSound & sound,   
      PBoolean wait = true        
    );

    virtual PBoolean PlayFile(
      const PFilePath & file, 
      PBoolean wait = true        
    );

    virtual PBoolean HasPlayCompleted();

    virtual PBoolean WaitForPlayCompletion();


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

    PINDEX GetLastReadCount() const;

    virtual PBoolean RecordSound(
      PSound & sound 
    );

    virtual PBoolean RecordFile(
      const PFilePath & file 
    );

    virtual PBoolean StartRecording();

    virtual PBoolean IsRecordBufferFull();

    virtual PBoolean AreAllRecordBuffersFull();

    virtual PBoolean WaitForRecordBufferFull();

    virtual PBoolean WaitForAllRecordBuffersFull();

  protected:
    PSoundChannel * baseChannel;

    Directions      activeDirection;
};



// define the sound plugin service descriptor

template <class className> class PSoundChannelPluginServiceDescriptor : public PDevicePluginServiceDescriptor
{
  public:
    virtual PObject *    CreateInstance(int /*userData*/) const { return new className; }
    virtual PStringArray 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)

#ifdef _WIN32
  PPLUGIN_STATIC_LOAD(WindowsMultimedia, PSoundChannel);
#elif defined(__BEOS__)
  PPLUGIN_STATIC_LOAD(BeOS, PSoundChannel);
#endif

#if defined(P_DIRECTSOUND) && ! defined(P_DIRECTSOUND_WINCE)
  PPLUGIN_STATIC_LOAD(DirectSound, PSoundChannel);
#endif

#if defined(P_WAVFILE)
  PPLUGIN_STATIC_LOAD(WAVFile, PSoundChannel)
#endif


#endif // PTLIB_SOUND_H


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

---