Docs @ Psychtoolbox Wiki: PsychPortAudio

Revision [14025]

Last edited on 2011-07-05 05:37:22 by ZweiWolf

Additions:

[oldyieldInterval, oldMutexEnable, lockToCore1, audioserver_autosuspend] = PsychPortAudio('EngineTunables' [, yieldInterval] [, MutexEnable] [, lockToCore1] [, audioserver_autosuspend]);
pahandle = PsychPortAudio('OpenSlave', pamaster [, mode][, channels][, selectchannels]);
[audiodata absrecposition overflow cstarttime] = PsychPortAudio('GetAudioData', pahandle [, amountToAllocateSecs][, minimumAmountToReturnSecs][, maximumAmountToReturnSecs][, singleType=0]);

Deletions:

[oldyieldInterval, oldMutexEnable, lockToCore1] = PsychPortAudio('EngineTunables' [, yieldInterval] [, MutexEnable] [, lockToCore1]);
[audiodata absrecposition overflow cstarttime] = PsychPortAudio('GetAudioData', pahandle [, amountToAllocateSecs][, minimumAmountToReturnSecs][, maximumAmountToReturnSecs]);

Revision [10005]

Edited on 2010-07-10 09:16:46 by ZweiWolf [updates to PPA page.]

Additions:

~- Allows start of playback at a scheduled future system time: E.g., schedule sound onset for a specific time in the future (e.g., visual stimulus onset time), then do other things in your Matlab code. Scheduled start of playback can be accurate to the sub-millisecond level on some system setups.

Deletions:

~- Allows start of playback at a scheduled future system time: E.g., schedule sound onset for a specific time in the future (e.g., visual stimulus onset time), then do other things in your Matlab code.
~~-Scheduled start of playback can be accurate to the sub-millisecond level on some system setups.

Revision [10003]

Edited on 2010-07-10 09:06:51 by ZweiWolf [updated according to subfunction updates in PPA.]

Additions:

pahandle = PsychPortAudio('Open' [, deviceid][, mode][, reqlatencyclass][, freq][, channels][, buffersize][, suggestedLatency][, selectchannels][, specialFlags=0]);
[oldMasterVolume, oldChannelVolumes] = PsychPortAudio('Volume', pahandle [, masterVolume][, channelVolumes]);
startTime = PsychPortAudio('Start', pahandle [, repetitions=1] [, when=0] [, waitForStart=0] [, stopTime=inf] [, resume=0]);
[success, freeslots] = PsychPortAudio('AddToSchedule', pahandle [, bufferHandle=0][, repetitions=1][, startSample=0][, endSample=max][, UnitIsSeconds=0][, specialFlags=0]);

Deletions:

pahandle = PsychPortAudio('Open' [, deviceid][, mode][, reqlatencyclass][, freq][, channels][, buffersize][, suggestedLatency][, selectchannels]);
startTime = PsychPortAudio('Start', pahandle [, repetitions=1] [, when=0] [, waitForStart=0] [, stopTime=inf]);
[success, freeslots] = PsychPortAudio('AddToSchedule', pahandle [, bufferHandle=0][, repetitions=1][, startSample=0][, endSample=max][, UnitIsSeconds=0]);

Revision [9664]

Edited on 2009-08-25 13:11:36 by ZweiWolf [updated according to subfunction updates in PPA.]

Additions:

type %%(matlab)>> PsychPortAudio%%
and %%(matlab)>> PsychPortAudio Subfunctionname?%%

Deletions:

type %%(matlab)PsychPortAudio%%
and %%(matlab)PsychPortAudio Subfunctionname?%%

Revision [9663]

Edited on 2009-08-25 08:52:28 by ZweiWolf [move MATLAB box down for nicer wrapping]

Additions:

==== High precision sound driver for Psychtoolbox-3. ====
>>====Contents====

Deletions:

>>==== High precision sound driver for Psychtoolbox-3. ====
====Contents====

Revision [9662]

Edited on 2009-08-25 08:50:02 by ZweiWolf [Add tab.le of contents to protected page]

Additions:

====Contents====
~1)""<a class="ext" href="#features">Features</a>""
~1)""<a class="ext" href="#see">See also</a>""
~1)**""<a class="ext" href="#usage">Usage</a>""**
~1)""<a class="ext" href="#caution">Caution</a>""
""<a name="features"> </a>""
""<a name="see"> </a>""
""<a name="usage"> </a>""
""<a name="caution"> </a>""

Revision [9661]

Edited on 2009-08-25 08:46:56 by ZweiWolf [Protect page and manually reformat to be much more readable.]

Additions:

>> ====Inside MATLAB: ====
PsychPortAudio has subfunctions;
type %%(matlab)PsychPortAudio%%
for a list overview of supported subfunctions
and %%(matlab)PsychPortAudio Subfunctionname?%%
for help on a specific subfunction.
>>==== High precision sound driver for Psychtoolbox-3. ====
replacement for all other Matlab based sound drivers and PTB's old [[SND]]()
~- Allows instant start of sound playback with a very low onset latency compared to other sound drivers (on well working hardware).
~- Allows start of playback at a scheduled future system time: E.g., schedule sound onset for a specific time in the future (e.g., visual stimulus onset time), then do other things in your Matlab code.
~~-Scheduled start of playback can be accurate to the sub-millisecond level on some system setups.
~- Wait for sound onset, or continue with execution of Matlab code immediately.
~- Asynchronous operation: Sound playback works in the background while your Matlab code continues to do other things.
~- Infinitely repeating playback, or playback of a sound for 'n' times.
~- Returns timestamps and status for all crucial events.
~- Support multi-channel devices, e.g., 8-channel sound cards.
~- Supports multi-channel sound capture and full-duplex capture and playback of sound on some systems.
~- Enumerate, open and use multiple sound cards in parallel.
~- Reliable (compared to Matlabs sound facilities).
~- Efficient, causes only very low cpu load.
=== See ===
InitializePsychSound for more info on low-latency configurations.
BasicSoundOutputDemo for a very basic demo of sound output (without special emphasis on low-latency).
BasicSoundInputDemo for a basic demo of sound capture.
BasicSoundFeedbackDemo shows how to implement a simple audio feedback loop with controllable delay.
PsychPortAudioTimingTest is a script that we used for testing PA's sound onset
latency and accuracy. It also serves as an example on how to get perfectly
synched audio-visual stimulus onsets.
====Usage:====
''The {{color hex="#993333" text="red keywords"}} are links for per-function documentation!''
%%(matlab)
% PsychPortAudio - A sound driver built around the PortAudio sound library:
% General information:
version = PsychPortAudio('Version');
oldlevel = PsychPortAudio('Verbosity' [,level]);
count = PsychPortAudio('GetOpenDeviceCount');
devices = PsychPortAudio('GetDevices' [,devicetype] [, deviceIndex]);
% General settings:
[oldyieldInterval, oldMutexEnable, lockToCore1] = PsychPortAudio('EngineTunables' [, yieldInterval] [, MutexEnable] [, lockToCore1]);
oldRunMode = PsychPortAudio('RunMode', pahandle [,runMode]);
% Device setup and shutdown:
pahandle = PsychPortAudio('Open' [, deviceid][, mode][, reqlatencyclass][, freq][, channels][, buffersize][, suggestedLatency][, selectchannels]);
PsychPortAudio('Close' [, pahandle]);
oldOpMode = PsychPortAudio('SetOpMode', pahandle [, opModeOverride]);
oldbias = PsychPortAudio('LatencyBias', pahandle [,biasSecs]);
enable = PsychPortAudio('DirectInputMonitoring', pahandle, enable [, inputChannel = -1][, outputChannel = 0][, gainLevel = 0.0][, stereoPan = 0.5]);
[underflow, nextSampleStartIndex, nextSampleETASecs] = PsychPortAudio('FillBuffer', pahandle, bufferdata [, streamingrefill=0][, startIndex=Append]);
bufferhandle = PsychPortAudio('CreateBuffer' [, pahandle], bufferdata);
PsychPortAudio('DeleteBuffer'[, bufferhandle] [, waitmode]);
PsychPortAudio('RefillBuffer', pahandle [, bufferhandle=0], bufferdata [, startIndex=0]);
PsychPortAudio('SetLoop', pahandle[, startSample=0][, endSample=max][, UnitIsSeconds=0]);
startTime = PsychPortAudio('Start', pahandle [, repetitions=1] [, when=0] [, waitForStart=0] [, stopTime=inf]);
startTime = PsychPortAudio('RescheduleStart', pahandle, when [, waitForStart=0] [, repetitions] [, stopTime]);
status = PsychPortAudio('GetStatus' pahandle);
[audiodata absrecposition overflow cstarttime] = PsychPortAudio('GetAudioData', pahandle [, amountToAllocateSecs][, minimumAmountToReturnSecs][, maximumAmountToReturnSecs]);
[startTime endPositionSecs xruns estStopTime] = PsychPortAudio('Stop', pahandle [,waitForEndOfPlayback=0] [, blockUntilStopped=1] [, repetitions] [, stopTime]);
PsychPortAudio('UseSchedule', pahandle, enableSchedule [, maxSize = 128]);
[success, freeslots] = PsychPortAudio('AddToSchedule', pahandle [, bufferHandle=0][, repetitions=1][, startSample=0][, endSample=max][, UnitIsSeconds=0]);
%%
==== CAUTION ====
You *must* call InitializePsychSound before first invocation of
<code>Psychtoolbox/PsychBasic/PsychPortAudio.m</code>
""""

Deletions:

PsychPortAudio - High precision sound driver for Psychtoolbox-3.
replacement for all other Matlab based sound drivers and PTB's old SND()
- Allows instant start of sound playback with a very low onset latency
compared to other sound drivers (on well working hardware).
- Allows start of playback at a scheduled future system time: E.g.,
schedule sound onset for a specific time in the future (e.g., visual
stimulus onset time), then do other things in your Matlab code.
Scheduled start of playback can be accurate to the sub-millisecond level
on some system setups.
- Wait for sound onset, or continue with execution of Matlab code
immediately.
- Asynchronous operation: Sound playback works in the background while
your Matlab code continues to do other things.
- Infinitely repeating playback, or playback of a sound for 'n' times.
- Returns timestamps and status for all crucial events.
- Support multi-channel devices, e.g., 8-channel sound cards.
- Supports multi-channel sound capture and full-duplex capture
and playback of sound on some systems.
- Enumerate, open and use multiple sound cards in parallel.
- Reliable (compared to Matlabs sound facilities).
- Efficient, causes only very low cpu load.
See the "help InitializePsychSound" for more info on low-latency
configurations. See "help BasicSoundOutputDemo" for a very basic demo of
sound output (without special emphasis on low-latency). See
"BasicSoundInputDemo" for a basic demo of sound capture.
"BasicSoundFeedbackDemo" shows how to implement a simple audio feedback
loop with controllable delay.
"PsychPortAudioTimingTest" is a script that we used for testing PA's
sound onset latency and accuracy. It also serves as an example on how to
get perfectly synched audio-visual stimulus onsets.
Type "PsychPortAudio" for an overview of supported subfunctions and
"PsychPortAudio Subfunctionname?" for help on a specific subfunction.
CAUTION: You *must* call InitializePsychSound before first invocation of
<code>Psychtoolbox/PsychBasic/PsychPortAudio.m</code>

Revision [9247]

Edited on 2008-11-05 06:43:24 by DocBot [Protect page and manually reformat to be much more readable.]

Additions:

function.
compared to other sound drivers (on well working hardware).
CAUTION: You *must* call InitializePsychSound before first invocation of
PsychPortAudio(), at least on MS-Windows, but possibly also on OS/X! If
you omit that call, initialization of the driver may fail with some
"Invalid MEX file" error from Matlab!

Deletions:

function. It is pretty new and therefore got limited real world testing,
so use it with care, may still have some problems on some combos of sound
hardware!
compared to other sound drivers.
=== WARNING: BETA STAGE - USE WITH CAUTION! ===

Revision [7587]

Edited on 2008-09-25 18:08:49 by DocBot [Protect page and manually reformat to be much more readable.]

Additions:

""
<div class="code_header" style="text-align:right;">
<span style="float:left;">Path </span> <span class="counter">Retrieve current version of PsychPortAudio.m from berliOS: <a href=
"http://svn.berlios.de/svnroot/repos/osxptb/beta/Psychtoolbox/PsychBasic/PsychPortAudio.m">beta</a> | view in <a href=
"http://svn.berlios.de/viewcvs/osxptb/beta/Psychtoolbox/PsychBasic/PsychPortAudio.m?view=markup">WebSVN with changelog</a></span>
</div>
<div class="code">
<code>Psychtoolbox/PsychBasic/PsychPortAudio.m</code>
</div>
""

Deletions:

~~%%(php;Path)Psychtoolbox/PsychBasic/PsychPortAudio.m%%~~

Revision [5196]

Edited on 2008-06-15 19:56:52 by DocBot [Protect page and manually reformat to be much more readable.]

Additions:

==[[Psychtoolbox]] › [[PsychBasic]]==

Deletions:

~~==[[Psychtoolbox]] › PsychBasic==~~

Revision [3237]

Edited on 2008-03-21 11:14:31 by DocBot [Protect page and manually reformat to be much more readable.]

Additions:

PsychPortAudio - High precision sound driver for Psychtoolbox-3.
PsychPortAudio is a new sounddriver for PTB-3. It is meant to become a
replacement for all other Matlab based sound drivers and PTB's old SND()
function. It is pretty new and therefore got limited real world testing,
so use it with care, may still have some problems on some combos of sound
hardware!
=== PsychPortAudio provides the following features: ===
- Allows instant start of sound playback with a very low onset latency
compared to other sound drivers.
- Allows start of playback at a scheduled future system time: E.g.,
schedule sound onset for a specific time in the future (e.g., visual
stimulus onset time), then do other things in your Matlab code.
Scheduled start of playback can be accurate to the sub-millisecond level
on some system setups.
- Wait for sound onset, or continue with execution of Matlab code
immediately.
- Asynchronous operation: Sound playback works in the background while
your Matlab code continues to do other things.
- Infinitely repeating playback, or playback of a sound for 'n' times.
- Returns timestamps and status for all crucial events.
- Support multi-channel devices, e.g., 8-channel sound cards.
- Supports multi-channel sound capture and full-duplex capture
and playback of sound on some systems.
- Enumerate, open and use multiple sound cards in parallel.
- Reliable (compared to Matlabs sound facilities).
- Efficient, causes only very low cpu load.
See the "help InitializePsychSound" for more info on low-latency
configurations. See "help BasicSoundOutputDemo" for a very basic demo of
sound output (without special emphasis on low-latency). See
"BasicSoundInputDemo" for a basic demo of sound capture.
"BasicSoundFeedbackDemo" shows how to implement a simple audio feedback
loop with controllable delay.
"PsychPortAudioTimingTest" is a script that we used for testing PA's
sound onset latency and accuracy. It also serves as an example on how to
get perfectly synched audio-visual stimulus onsets.
Type "PsychPortAudio" for an overview of supported subfunctions and
"PsychPortAudio Subfunctionname?" for help on a specific subfunction.
=== WARNING: BETA STAGE - USE WITH CAUTION! ===
PsychPortAudio is built around a modified version of the free, open-source
PortAudio sound library for portable realtime sound: http://www.portaudio.com

Deletions:

Revision [2811]

Edited on 2008-03-21 04:54:05 by DocBot [Protect page and manually reformat to be much more readable.]

Additions:

=== PsychPortAudio provides the following features: ===
=== WARNING: BETA STAGE - USE WITH CAUTION! ===

Deletions:

PsychPortAudio provides the following features:
WARNING: BETA STAGE - USE WITH CAUTION!

Revision [2810]

Edited on 2008-03-21 04:47:42 by DocBot [Protect page and manually reformat to be much more readable.]

Additions:

WARNING: BETA STAGE - USE WITH CAUTION!

Deletions:

WARNING
WARNING
PERVERSE
=== Windows ===

Revision [2809]

Edited on 2008-03-21 04:38:05 by DocBot [Protect page and manually reformat to be much more readable.]

Additions:

PsychPortAudio is a new sounddriver for PTB-3. It is meant to become a
replacement for all other Matlab based sound drivers and PTB's old SND()
"PsychPortAudioTimingTest" is a script that we used for testing PA's
WARNING
WARNING
PERVERSE

Deletions:

PsychPortAudio is a new sounddriver for === PTB- ===3. It is meant to become a
replacement for all other Matlab based sound drivers and === PTB ==='s old === SND ===()
"PsychPortAudioTimingTest" is a script that we used for testing === PA ==='s
=== WARNING ===
=== WARNING ===
=== PERVERSE ===

Revision [2808]

Edited on 2008-03-21 04:32:49 by DocBot [Protect page and manually reformat to be much more readable.]

Additions:

Deletions:

Revision [2807]

Edited on 2008-03-21 04:31:59 by DocBot [Protect page and manually reformat to be much more readable.]

Additions:

WARNING

Revision [2806]

Edited on 2008-03-21 04:30:51 by DocBot [Protect page and manually reformat to be much more readable.]

Additions:

PERVERSE

Revision [2805]

Edited on 2008-03-21 04:27:00 by DocBot [Protect page and manually reformat to be much more readable.]

Additions:

WARNING

Deletions:

~~WARNING: BETA STAGE - USE WITH CAUTION!~~

Revision [2804]

Edited on 2008-03-21 04:25:12 by DocBot [Protect page and manually reformat to be much more readable.]

Additions:

=== Windows ===

Deletions:

~~WARNING~~

Full history for this page cannot be displayed within a single page, click here to view more.