/usr/include/ptlib/sound.h is in libpt-dev 2.10.11~dfsg-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 | /*
* 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: 28275 $
* $Author: rjongbloed $
* $Date: 2012-08-29 21:42:35 -0500 (Wed, 29 Aug 2012) $
*/
#ifndef PTLIB_SOUND_H
#define PTLIB_SOUND_H
#ifdef P_USE_PRAGMA
#pragma interface
#endif
#include <ptlib/plugin.h>
#include <ptlib/pluginmgr.h>
/** A class representing a sound. A sound is a highly platform dependent
entity that is abstracted for use here. Very little manipulation of the
sounds are possible.
The most common sound to use is the static function <code>Beep()</code> which
emits the system standard "warning" or "attention" sound.
*/
class PSound : public PBYTEArray
{
PCLASSINFO(PSound, PBYTEArray);
public:
/**@name Construction */
//@{
/**Create a new sound, using the parameters provided.
It is expected that the "lowest common denominator" encoding, linear PCM,
is used.
All other values for the encoding are platform dependent.
*/
PSound(
unsigned numChannels = 1, ///< Number of channels eg mono/stereo
unsigned sampleRate = 8000, ///< Samples per second
unsigned bitsPerSample = 16, ///< Number of bits per sample
PINDEX bufferSize = 0, ///< Size of data
const BYTE * data = NULL ///< Pointer to initial data
);
/**Create a new sound, reading from a platform dependent file.
*/
PSound(
const PFilePath & filename ///< Sound file to load.
);
/**Set new data bytes for the sound.
*/
PSound & operator=(
const PBYTEArray & data ///< New data for sound
);
//@}
/**@name File functions */
//@{
/**Load a platform dependent sound file (eg .WAV file for Win32) into the
object. Note the whole file must able to be loaded into memory.
Also note that not all possible files are playable by this library. No
format conversions between file and driver are performed.
@return
true if the sound is loaded successfully.
*/
PBoolean Load(
const PFilePath & filename ///< Sound file to load.
);
/**Save a platform dependent sound file (eg .WAV file for Win32) from the
object.
@return
true if the sound is saved successfully.
*/
PBoolean Save(
const PFilePath & filename ///< Sound file to load.
);
//@}
/**@name Access functions */
//@{
/// Play the sound on the default sound device.
PBoolean Play();
/// Play the sound to the specified sound device.
PBoolean Play(const PString & device);
/**Set the internal sound format to linear PCM at the specification in
the parameters.
*/
void SetFormat(
unsigned numChannels, ///< Number of channels eg mono/stereo
unsigned sampleRate, ///< Samples per second
unsigned bitsPerSample ///< Number of bits per sample
);
/**Get the current encoding. A value of 0 indicates linear PCM, any other
value is platform dependent.
*/
unsigned GetEncoding() const { return encoding; }
/// Get the number of channels (mono/stereo) in the sound.
unsigned GetChannels() const { return numChannels; }
/// Get the sample rate in samples per second.
unsigned GetSampleRate() const { return sampleRate; }
/// Get the sample size in bits per sample.
unsigned GetSampleSize() const { return sampleSize; }
/// Get the platform dependent error code from the last file load.
DWORD GetErrorCode() const { return dwLastError; }
/// Get the size of the platform dependent format info.
PINDEX GetFormatInfoSize() const { return formatInfo.GetSize(); }
/// Get pointer to the platform dependent format info.
const void * GetFormatInfoData() const { return (const BYTE *)formatInfo; }
//@}
/**@name Miscellaneous functions */
//@{
/**Play a sound file to the default device. If the <code>wait</code>
parameter is true then the function does not return until the file has
been played. If false then the sound play is begun asynchronously and
the function returns immediately.
@return
true if the sound is playing or has played.
*/
static PBoolean PlayFile(
const PFilePath & file, ///< Sound file to play.
PBoolean wait = true ///< Flag to play sound synchronously.
);
/// Play the "standard" warning beep for the platform.
static void Beep();
//@}
protected:
/// Format code
unsigned encoding;
/// Number of channels eg mono/stereo
unsigned numChannels;
/// Samples per second
unsigned sampleRate;
/// Number of bits per sample
unsigned sampleSize;
/// Last error code for Load()/Save() functions
DWORD dwLastError;
/// Full info on the format (platform dependent)
PBYTEArray formatInfo;
};
/**
Abstract class for a generalised sound channel, and an implementation of
PSoundChannel for old code that is not plugin-aware.
When instantiated, it selects the first plugin of the base class
"PSoundChannel"
As an abstract class, this represents a sound channel. Drivers for real,
platform dependent sound hardware will be ancestors of this class and
can be found in the plugins section of PTLib.
A sound channel is either playing or recording. If simultaneous
playing and recording is desired, two instances of PSoundChannel
must be created. It is an error for the same thread to attempt to
both read and write audio data to once instance of a PSoundChannel
class.
PSoundChannel instances are designed to be reentrant. The actual
usage model employed is left to the developer. One model could be
where one thread is responsible for construction, setup, opening and
read/write operations. After creating and eventually opening the channel
this thread is responsible for handling read/writes fast enough to avoid
gaps in the generated audio stream.
Remaining operations may beinvoked from other threads.
This includes Close() and actually gathering the necessary data to
be sent to the device.
Besides the basic I/O task, the Read()/Write(() functions have well
defined timing characteristics. When a PSoundChannel instance is
used from Opal, the read/write operations are designed to also act
as timers so as to nicely space the generated network packets of
audio/ sound packets to the speaker.
Read and Writes of audio data to a PSoundChannel are blocking. The
length of time required to read/write a block of audio from/to a
PSoundChannel instance is equal to the time required for that block
of audio to record/play. So for a sound rate of 8khz, 240 samples,
it is going to take 30ms to do a read/write.
Since the Read()/Write(() functions have well defined
timing characteristics; they are designed to also act as timers in a loop
involving data transfers to/from the codecs.
The sound is buffered and the size and number of buffers should be set
before playing/recording. Each call to Write() will use one buffer, so care
needs to be taken not to use a large number of small writes but tailor the
buffers to the size of each write you make.
Similarly for reading, an entire buffer must be read before any of it is
available to a Read() call. Note that once a buffer is filled you can read
it a byte at a time if desired, but as soon as all the data in the buffer
is used, the next read will wait until the entire next buffer is
read from the hardware. So again, tailor the number and size of buffers to
the application. To avoid being blocked until the buffer fills, you can use
the StartRecording() function to initiate the buffer filling, and the
IsRecordingBufferFull() function to determine when the Read() function will
no longer block.
Note that this sound channel is implicitly a linear PCM channel. No data
conversion is performed on data to/from the channel.
*/
class PSoundChannel : public PChannel
{
PCLASSINFO(PSoundChannel, PChannel);
public:
/**@name Construction */
//@{
enum Directions {
Closed = -1,
Recorder,
Player
};
/// Create a sound channel.
PSoundChannel();
/** Create a sound channel.
Create a reference to the sound drivers for the platform.
*/
PSoundChannel(
const PString & device, ///< Name of sound driver/device
Directions dir, ///< Sound I/O direction
unsigned numChannels = 1, ///< Number of channels eg mono/stereo
unsigned sampleRate = 8000, ///< Samples per second
unsigned bitsPerSample = 16 ///< Number of bits per sample
);
//
virtual ~PSoundChannel();
// Destroy and close the sound driver
//@}
/**@name Open functions */
//@{
/**Get the list of available sound drivers (plug-ins)
*/
static PStringArray GetDriverNames(
PPluginManager * pluginMgr = NULL ///< Plug in manager, use default if NULL
);
/**Get sound devices that correspond to the specified driver name.
If driverName is an empty string or the value "*" then GetAllDeviceNames()
is used.
*/
static PStringArray GetDriversDeviceNames(
const PString & driverName, ///< Name of driver
Directions direction, ///< Direction for device (record or play)
PPluginManager * pluginMgr = NULL ///< Plug in manager, use default if NULL
);
// For backward compatibility
static inline PStringArray GetDeviceNames(
const PString & driverName,
Directions direction,
PPluginManager * pluginMgr = NULL
) { return GetDriversDeviceNames(driverName, direction, pluginMgr); }
/**Create the sound channel that corresponds to the specified driver name.
*/
static PSoundChannel * CreateChannel (
const PString & driverName, ///< Name of driver
PPluginManager * pluginMgr = NULL ///< Plug in manager, use default if 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, ///< Name of device
Directions direction, ///< Direction for device (record or play)
PPluginManager * pluginMgr = NULL ///< Plug in manager, use default if NULL
);
/**Create an opened sound channel that corresponds to the specified names.
If the driverName parameter is an empty string or "*" then CreateChannelByName
is used with the deviceName parameter which is assumed to be a value returned
from GetAllDeviceNames().
*/
static PSoundChannel * CreateOpenedChannel(
const PString & driverName, ///< Name of driver
const PString & deviceName, ///< Name of device
Directions direction, ///< Direction for device (record or play)
unsigned numChannels = 1, ///< Number of channels 1=mon, 2=stereo
unsigned sampleRate = 8000, ///< Sample rate
unsigned bitsPerSample = 16, ///< Bits per sample
PPluginManager * pluginMgr = NULL ///< Plug in manager, use default if NULL
);
/**Get the name for the default sound devices/driver that is on this
platform. Note that a named device may not necessarily do both
playing and recording so the string returned with the <code>dir</code>
parameter in each value is not necessarily the same.
@return
A platform dependent string for the sound player/recorder.
*/
static PString GetDefaultDevice(
Directions dir // Sound I/O direction
);
/**Get the list of all devices name for the default sound devices/driver that is on this
platform. Note that a named device may not necessarily do both
playing and recording so the arrays returned with the <code>dir</code>
parameter in each value is not necessarily the same.
This will return a list of unique device names across all of the available
drivers. If two drivers have identical names for devices, then the string
returned will be of the form driver+'\\t'+device.
@return
Platform dependent strings for the sound player/recorder.
*/
static PStringArray GetDeviceNames(
Directions direction, ///< Direction for device (record or play)
PPluginManager * pluginMgr = NULL ///< Plug in manager, use default if NULL
);
/**Open the specified device for playing or recording. The device name is
platform specific and is as returned in the GetDevices() function.
@return
true if the sound device is valid for playing/recording.
*/
virtual PBoolean Open(
const PString & device, ///< Name of sound driver/device
Directions dir, ///< Sound I/O direction
unsigned numChannels = 1, ///< Number of channels eg mono/stereo
unsigned sampleRate = 8000, ///< Samples per second
unsigned bitsPerSample = 16 ///< Number of bits per sample
);
/**Test if this instance of PSoundChannel is open.
@return
true if this instance is open.
*/
virtual PBoolean IsOpen() const;
/** Close the channel, shutting down the link to the data source.
@return true if the channel successfully closed.
*/
virtual PBoolean Close();
/**Get the OS specific handle for the PSoundChannel.
@return
integer value of the handle.
*/
virtual int GetHandle() const;
/// Get the name of the open channel
virtual PString GetName() const;
/// Get the direction of the channel
Directions GetDirection() const
{
return activeDirection;
}
/// Get text representing the direction of the channel
static const char * GetDirectionText(Directions dir);
virtual const char * GetDirectionText() const
{
return GetDirectionText(activeDirection);
}
/** Abort the background playing/recording of the sound channel.
There will be a logic assertion if you attempt to Abort a
sound channel operation, when the device is currently closed.
@return
true if the sound has successfully been aborted.
*/
virtual PBoolean Abort();
//@}
/**@name Channel set up functions */
//@{
/**Set the format for play/record. Note that linear PCM data is the only
one supported at this time.
Note that if the PlayFile() function is used, this may be overridden
by information in the file being played.
@return
true if the format is valid.
*/
virtual PBoolean SetFormat(
unsigned numChannels = 1, ///< Number of channels eg mono/stereo
unsigned sampleRate = 8000, ///< Samples per second
unsigned bitsPerSample = 16 ///< Number of bits per sample
);
/// Get the number of channels (mono/stereo) in the sound.
virtual unsigned GetChannels() const;
/// Get the sample rate in samples per second.
virtual unsigned GetSampleRate() const;
/// Get the sample size in bits per sample.
virtual unsigned GetSampleSize() const;
/**Set the internal buffers for the sound channel I/O.
Note that with Linux OSS, the size is always rounded up to the nearest
power of two, so 20000 => 32768.
@return
true if the sound device is valid for playing/recording.
*/
virtual PBoolean SetBuffers(
PINDEX size, ///< Size of each buffer
PINDEX count = 2 ///< Number of buffers
);
/**Get the internal buffers for the sound channel I/O.
@return
true if the buffer size were obtained.
*/
virtual PBoolean GetBuffers(
PINDEX & size, // Size of each buffer
PINDEX & count // Number of buffers
);
enum {
MaxVolume = 100
};
/**Set the volume of the play/read process.
The volume range is 0 == muted, 100 == LOUDEST. The volume is a
logarithmic scale mapped from the lowest gain possible on the device to
the highest gain.
@return
true if there were no errors.
*/
virtual PBoolean SetVolume(
unsigned volume ///< New volume level
);
/**Get the volume of the play/read process.
The volume range is 0 == muted, 100 == LOUDEST. The volume is a
logarithmic scale mapped from the lowest gain possible on the device to
the highest gain.
@return
true if there were no errors.
*/
virtual PBoolean GetVolume(
unsigned & volume ///< Variable to receive volume level.
);
/**Set the mute state of the play/read process.
@return
true if there were no errors.
*/
virtual bool SetMute(
bool mute ///< New mute state
);
/**Get the mute state of the play/read process.
@return
true if there were no errors.
*/
virtual bool GetMute(
bool & mute ///< Variable to receive mute state.
);
//@}
/**@name Play functions */
//@{
/** Low level write (or play) to the channel.
It will generate a logical assertion if you attempt write to a
channel set up for recording.
@param buf is a pointer to the data to be written to the
channel. It is an error for this pointer to be NULL. A logical
assert will be generated when buf is NULL.
@param len Nr of bytes to send. If len equals the buffer size
set by SetBuffers() it will block for
(1000*len)/(samplesize*samplerate) ms. Typically, the sample
size is 2 bytes. If len == 0, this will return immediately,
where the return value is equal to the value of IsOpen().
@return true if len bytes were written to the channel,
otherwise false. The GetErrorCode() function should be
consulted after Write() returns false to determine what
caused the failure.
*/
virtual PBoolean Write(const void * buf, PINDEX len);
/** Low level write (or play) with watermark to the channel.
It will generate a logical assertion if you attempt write to a
channel set up for recording.
@param buf is a pointer to the data to be written to the
channel. It is an error for this pointer to be NULL. A logical
assert will be generated when buf is NULL.
@param len Nr of bytes to send. If len equals the buffer size
set by SetBuffers() it will block for
(1000*len)/(samplesize*samplerate) ms. Typically, the sample
size is 2 bytes. If len == 0, this will return immediately,
where the return value is equal to the value of IsOpen().
@param mark Unique identifer to identify the write
@return PTrue if len bytes were written to the channel,
otherwise PFalse. The GetErrorCode() function should be
consulted after Write() returns PFalse to determine what
caused the failure.
*/
virtual PBoolean Write(
const void * buf, ///< Pointer to a block of memory to write.
PINDEX len, ///< Number of bytes to write.
const void * mark ///< Unique Marker to identify write
);
/** Get number of bytes written in last Write() operation. */
virtual PINDEX GetLastWriteCount() const;
/**Play a sound to the open device. If the <code>wait</code> parameter is
true then the function does not return until the file has been played.
If false then the sound play is begun asynchronously and the function
returns immediately.
Note: if the driver is closed while playing the sound, the play
operation stops immediately.
Also note that not all possible sounds and sound files are playable by
this library. No format conversions between sound object and driver are
performed.
@return
true if the sound is playing or has played.
*/
virtual PBoolean PlaySound(
const PSound & sound, ///< Sound to play.
PBoolean wait = true ///< Flag to play sound synchronously.
);
/**Play a sound file to the open device. If the <code>wait</code>
parameter is true then the function does not return until the file has
been played. If false then the sound play is begun asynchronously and
the function returns immediately.
Note if the driver is closed of the object destroyed then the sound
play is aborted.
Also note that not all possible sounds and sound files are playable by
this library. No format conversions between sound object and driver are
performed.
@return
true if the sound is playing or has played.
*/
virtual PBoolean PlayFile(
const PFilePath & file, ///< Sound file to play.
PBoolean wait = true ///< Flag to play sound synchronously.
);
/**Indicate if the sound play begun with PlayBuffer() or PlayFile() has
completed.
@return
true if the sound has completed playing.
*/
virtual PBoolean HasPlayCompleted();
/**Block calling thread until the sound play begun with PlaySound() or
PlayFile() has completed.
@return
true if the sound has successfully completed playing.
*/
virtual PBoolean WaitForPlayCompletion();
//@}
/**@name Record functions */
//@{
/** Low level read from the channel. This function may block until the
requested number of characters were read or the read timeout was
reached. The GetLastReadCount() function returns the actual number
of bytes read.
It will generate a logical assertion if you attempt to read
from a PSoundChannel that is setup for playing.
The GetErrorCode() function should be consulted after Read() returns
false to determine what caused the failure.
@param len Nr of bytes to endeaveour to read from the sound
device. If len equals the buffer size set by SetBuffers() it
will block for (1000*len)/(samplesize*samplerate)
ms. Typically, the sample size is 2 bytes. If len == 0, this
will return immediately, where the return value is equal to
the value of IsOpen().
@param buf is a pointer to the empty data area, which will
contain the data collected from the sound device. It is an
error for this pointer to be NULL. A logical assert will be
generated when buf is NULL.
@return true indicates that at least one character was read
from the channel. false means no bytes were read due to some
I/O error, (which includes timeout or some other thread closed
the device).
*/
virtual PBoolean Read(
void * buf, ///< Pointer to a block of memory to receive the read bytes.
PINDEX len ///< Maximum number of bytes to read into the buffer.
);
/** Return number of bytes read in last Read() call. */
PINDEX GetLastReadCount() const;
/**Record into the sound object all of the buffer's of sound data. Use the
SetBuffers() function to determine how long the recording will be made.
For the Win32 platform, the most efficient way to record a PSound is to
use the SetBuffers() function to set a single buffer of the desired
size and then do the recording. For Linux OSS this can cause problems
as the buffers are rounded up to a power of two, so to gain more
accuracy you need a number of smaller buffers.
Note that this function will block until all of the data is buffered.
If you wish to do this asynchronously, use StartRecording() and
AreAllrecordBuffersFull() to determine when you can call RecordSound()
without blocking.
@return
true if the sound has been recorded.
*/
virtual PBoolean RecordSound(
PSound & sound ///< Sound recorded
);
/**Record into the platform dependent sound file all of the buffer's of
sound data. Use the SetBuffers() function to determine how long the
recording will be made.
Note that this function will block until all of the data is buffered.
If you wish to do this asynchronously, use StartRecording() and
AreAllrecordBuffersFull() to determine when you can call RecordSound()
without blocking.
@return
true if the sound has been recorded.
*/
virtual PBoolean RecordFile(
const PFilePath & file ///< Sound file recorded
);
/**Start filling record buffers. The first call to Read() will also
initiate the recording.
@return
true if the sound driver has successfully started recording.
*/
virtual PBoolean StartRecording();
/**Determine if a record buffer has been filled, so that the next Read()
call will not block. Provided that the amount of data read is less than
the buffer size.
@return
true if the sound driver has filled a buffer.
*/
virtual PBoolean IsRecordBufferFull();
/**Determine if all of the record buffer allocated has been filled. There
is an implicit Abort() of the recording if this occurs and recording is
stopped. The channel may need to be closed and opened again to start
a new recording.
@return
true if the sound driver has filled a buffer.
*/
virtual PBoolean AreAllRecordBuffersFull();
/**Block the thread until a record buffer has been filled, so that the
next Read() call will not block. Provided that the amount of data read
is less than the buffer size.
@return
true if the sound driver has filled a buffer.
*/
virtual PBoolean WaitForRecordBufferFull();
/**Block the thread until all of the record buffer allocated has been
filled. There is an implicit Abort() of the recording if this occurs
and recording is stopped. The channel may need to be closed and opened
again to start a new recording.
@return
true if the sound driver has filled a buffer.
*/
virtual PBoolean WaitForAllRecordBuffersFull();
//@}
protected:
PSoundChannel * m_baseChannel;
PReadWriteMutex m_baseMutex;
/**This is the direction that this sound channel is opened for use
in. Should the user attempt to used this opened class instance
in a direction opposite to that specified in activeDirection,
an assert happens. */
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)
PPLUGIN_STATIC_LOAD(DirectSound, PSoundChannel);
#endif
#if defined(P_WAVFILE)
PPLUGIN_STATIC_LOAD(WAVFile, PSoundChannel)
#endif
#endif // PTLIB_SOUND_H
// End Of File ///////////////////////////////////////////////////////////////
|