ryujinx/Opentk
1
0
Fork 0
mirror of https://github.com/Ryujinx/Opentk.git synced 2024-12-27 06:45:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
Opentk/Source/OpenTK/Audio/OpenAL/AL/AL.cs

1607 lines
95 KiB
C#
Raw Normal View History

Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
#region --- OpenTK.OpenAL License ---
/* AlFunctions.cs
* C header: \OpenAL 1.1 SDK\include\Al.h
* Spec: http://www.openal.org/openal_webstf/specs/OpenAL11Specification.pdf
* Copyright (c) 2008 Christoph Brandtner and Stefanos Apostolopoulos
* See license.txt for license details
* http://www.OpenTK.net */
#endregion
using System;
using System.Runtime.InteropServices;
using System.Security;
Merged openal-next branch (rev. 1969) to trunk. Tested with Audio-Info and Parrot examples and works as expected.
2009-07-16 12:49:24 +00:00
using OpenTK;
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
/* Type Mapping
// 8-bit boolean
typedef char ALboolean;
* bool
// character
typedef char ALchar;
* byte
// signed 8-bit 2's complement integer
typedef char ALbyte;
* byte
// unsigned 8-bit integer
typedef unsigned char ALubyte;
* byte
// signed 16-bit 2's complement integer
typedef short ALshort;
* short
// unsigned 16-bit integer
typedef unsigned short ALushort;
* ushort
// unsigned 32-bit integer
typedef unsigned int ALuint;
* uint
// signed 32-bit 2's complement integer
typedef int ALint;
* int
// non-negative 32-bit binary integer size
typedef int ALsizei;
* int
// enumerated 32-bit value
typedef int ALenum;
* int
// 32-bit IEEE754 floating-point
typedef float ALfloat;
* float
// 64-bit IEEE754 floating-point
typedef double ALdouble;
* double
// void type (for opaque pointers only)
typedef void ALvoid;
* void
*/
Moved Alut to OpenTK.Compatibility. Moved SoundData and SoundFormat to OpenTK.Compatibility. Moved AL and Alc classes to OpenTK.Audio.OpenAL and added the previous namespace to OpenTK.Compatibility. Removed SoundData wrappers from AL class. Updated samples to use the new API.
2009-08-17 10:32:20 +00:00
namespace OpenTK.Audio.OpenAL
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
{
Added missing XML documentation and fixed invalid XML doc references. Removed deprecated methods from IGraphicsContext.
2009-09-04 21:25:29 +00:00
/// <summary>
/// Provides access to the OpenAL 1.1 flat API.
/// </summary>
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
public static partial class AL
{
Merged openal-next branch (rev. 1969) to trunk. Tested with Audio-Info and Parrot examples and works as expected.
2009-07-16 12:49:24 +00:00
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
#region Constants
OpenAL DllImport library should be internal, not public.
2009-09-04 13:02:44 +00:00
internal const string Lib = "openal32.dll";
Merged openal-next branch (rev. 1969) to trunk. Tested with Audio-Info and Parrot examples and works as expected.
2009-07-16 12:49:24 +00:00
private const CallingConvention Style = CallingConvention.Cdecl;
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
#endregion Constants
#region Renderer State management
/// <summary>This function enables a feature of the OpenAL driver. There are no capabilities defined in OpenAL 1.1 to be used with this function, but it may be used by an extension.</summary>
/// <param name="capability">The name of a capability to enable.</param>
[DllImport(AL.Lib, EntryPoint = "alEnable", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void Enable(ALCapability capability);
//AL_API void AL_APIENTRY alEnable( ALenum capability );
/// <summary>This function disables a feature of the OpenAL driver.</summary>
/// <param name="capability">The name of a capability to disable.</param>
[DllImport(AL.Lib, EntryPoint = "alDisable", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void Disable(ALCapability capability);
// AL_API void AL_APIENTRY alDisable( ALenum capability );
/// <summary>This function returns a boolean indicating if a specific feature is enabled in the OpenAL driver.</summary>
/// <param name="capability">The name of a capability to enable.</param>
/// <returns>True if enabled, False if disabled.</returns>
[DllImport(AL.Lib, EntryPoint = "alIsEnabled", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern bool IsEnabled(ALCapability capability);
// AL_API ALboolean AL_APIENTRY alIsEnabled( ALenum capability );
#endregion Renderer State management
#region State retrieval
[DllImport(AL.Lib, EntryPoint = "alGetString", ExactSpelling = true, CallingConvention = AL.Style, CharSet = CharSet.Ansi), SuppressUnmanagedCodeSecurity()]
private static extern IntPtr GetStringPrivate(ALGetString param); // accepts the enums AlError, AlContextString
// AL_API const ALchar* AL_APIENTRY alGetString( ALenum param );
/// <summary>This function retrieves an OpenAL string property.</summary>
/// <param name="param">The property to be returned: Vendor, Version, Renderer and Extensions</param>
/// <returns>Returns a pointer to a null-terminated string.</returns>
public static string Get(ALGetString param)
{
return Marshal.PtrToStringAnsi(GetStringPrivate(param));
}
/// <summary>This function retrieves an OpenAL string property.</summary>
/// <param name="param">The human-readable errorstring to be returned.</param>
/// <returns>Returns a pointer to a null-terminated string.</returns>
public static string GetErrorString(ALError param)
{
return Marshal.PtrToStringAnsi(GetStringPrivate((ALGetString)param));
}
/* no functions return more than 1 result ..
// AL_API void AL_APIENTRY alGetBooleanv( ALenum param, ALboolean* buffer );
// AL_API void AL_APIENTRY alGetIntegerv( ALenum param, ALint* buffer );
// AL_API void AL_APIENTRY alGetFloatv( ALenum param, ALfloat* buffer );
// AL_API void AL_APIENTRY alGetDoublev( ALenum param, ALdouble* buffer );
*/
/* disabled due to no token using it
/// <summary>This function returns a boolean OpenAL state.</summary>
/// <param name="param">the state to be queried: AL_DOPPLER_FACTOR, AL_SPEED_OF_SOUND, AL_DISTANCE_MODEL</param>
/// <returns>The boolean state described by param will be returned.</returns>
[DllImport( AL.Lib, EntryPoint = "alGetBoolean", ExactSpelling = true, CallingConvention = AL.Style ), SuppressUnmanagedCodeSecurity( )]
public static extern bool Get( ALGetBoolean param );
// AL_API ALboolean AL_APIENTRY alGetBoolean( ALenum param );
*/
/// <summary>This function returns an integer OpenAL state.</summary>
/// <param name="param">the state to be queried: DistanceModel.</param>
/// <returns>The integer state described by param will be returned.</returns>
[DllImport(AL.Lib, EntryPoint = "alGetInteger", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern int Get(ALGetInteger param);
// AL_API ALint AL_APIENTRY alGetInteger( ALenum param );
/// <summary>This function returns a floating point OpenAL state.</summary>
/// <param name="param">the state to be queried: DopplerFactor, SpeedOfSound.</param>
/// <returns>The floating point state described by param will be returned.</returns>
[DllImport(AL.Lib, EntryPoint = "alGetFloat", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern float Get(ALGetFloat param);
// AL_API ALfloat AL_APIENTRY alGetFloat( ALenum param );
/* disabled due to no token using it
/// <summary>This function returns a double precision floating point OpenAL state.</summary>
/// <param name="param">the state to be queried: AL_DOPPLER_FACTOR, AL_SPEED_OF_SOUND, AL_DISTANCE_MODEL</param>
/// <returns>The double value described by param will be returned.</returns>
[DllImport( AL.Lib, EntryPoint = "alGetDouble", ExactSpelling = true, CallingConvention = AL.Style ), SuppressUnmanagedCodeSecurity( )]
public static extern double Get( ALGetDouble param );
// AL_API ALdouble AL_APIENTRY alGetDouble( ALenum param );
*/
/// <summary>Error support. Obtain the most recent error generated in the AL state machine. When an error is detected by AL, a flag is set and the error code is recorded. Further errors, if they occur, do not affect this recorded code. When alGetError is called, the code is returned and the flag is cleared, so that a further error will again record its code.</summary>
/// <returns>The first error that occured. can be used with AL.GetString. Returns an Alenum representing the error state. When an OpenAL error occurs, the error state is set and will not be changed until the error state is retrieved using alGetError. Whenever alGetError is called, the error state is cleared and the last state (the current state when the call was made) is returned. To isolate error detection to a specific portion of code, alGetError should be called before the isolated section to clear the current error state.</returns>
[DllImport(AL.Lib, EntryPoint = "alGetError", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern ALError GetError();
// AL_API ALenum AL_APIENTRY alGetError( void );
#endregion State retrieval
#region Extension support.
///<summary>This function tests if a specific Extension is available for the OpenAL driver.</summary>
/// <param name="extname">A string naming the desired extension. Example: "EAX-RAM"</param>
/// <returns>Returns True if the Extension is available or False if not available.</returns>
[DllImport(AL.Lib, EntryPoint = "alIsExtensionPresent", ExactSpelling = true, CallingConvention = AL.Style, CharSet = CharSet.Ansi), SuppressUnmanagedCodeSecurity()]
public static extern bool IsExtensionPresent([In] string extname);
// AL_API ALboolean AL_APIENTRY alIsExtensionPresent( const ALchar* extname );
/// <summary>This function returns the address of an OpenAL extension function. Handle with care.</summary>
/// <param name="fname">A string containing the function name.</param>
/// <returns>The return value is a pointer to the specified function. The return value will be IntPtr.Zero if the function is not found.</returns>
[DllImport(AL.Lib, EntryPoint = "alGetProcAddress", ExactSpelling = true, CallingConvention = AL.Style, CharSet = CharSet.Ansi), SuppressUnmanagedCodeSecurity()]
public static extern IntPtr GetProcAddress([In] string fname);
// AL_API void* AL_APIENTRY alGetProcAddress( const ALchar* fname );
/// <summary>This function returns the enumeration value of an OpenAL token, described by a string.</summary>
/// <param name="ename">A string describing an OpenAL token. Example "AL_DISTANCE_MODEL"</param>
/// <returns>Returns the actual ALenum described by a string. Returns 0 if the string doesn’t describe a valid OpenAL token.</returns>
[DllImport(AL.Lib, EntryPoint = "alGetEnumValue", ExactSpelling = true, CallingConvention = AL.Style, CharSet = CharSet.Ansi), SuppressUnmanagedCodeSecurity()]
public static extern int GetEnumValue([In] string ename);
// AL_API ALenum AL_APIENTRY alGetEnumValue( const ALchar* ename );
#endregion Extension support.
/* Listener
* Listener represents the location and orientation of the
* 'user' in 3D-space.
*
* Properties include: -
*
* Gain AL_GAIN ALfloat
* Position AL_POSITION ALfloat[3]
* Velocity AL_VELOCITY ALfloat[3]
* Orientation AL_ORIENTATION ALfloat[6] (Forward then Up vectors)
*/
#region Set Listener parameters
/// <summary>This function sets a floating point property for the listener.</summary>
/// <param name="param">The name of the attribute to be set: ALListenerf.Gain</param>
/// <param name="value">The float value to set the attribute to.</param>
[DllImport(AL.Lib, EntryPoint = "alListenerf", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void Listener(ALListenerf param, float value);
// AL_API void AL_APIENTRY alListenerf( ALenum param, ALfloat value );
/// <summary>This function sets a floating point property for the listener.</summary>
/// <param name="param">The name of the attribute to set: ALListener3f.Position, ALListener3f.Velocity</param>
/// <param name="value1">The value to set the attribute to.</param>
/// <param name="value2">The value to set the attribute to.</param>
/// <param name="value3">The value to set the attribute to.</param>
[DllImport(AL.Lib, EntryPoint = "alListener3f", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void Listener(ALListener3f param, float value1, float value2, float value3);
// AL_API void AL_APIENTRY alListener3f( ALenum param, ALfloat value1, ALfloat value2, ALfloat value3 );
/// <summary>This function sets a Math.Vector3 property for the listener.</summary>
/// <param name="param">The name of the attribute to set: ALListener3f.Position, ALListener3f.Velocity</param>
/// <param name="values">The Math.Vector3 to set the attribute to.</param>
public static void Listener(ALListener3f param, ref Vector3 values)
{
Listener(param, values.X, values.Y, values.Z);
}
[DllImport(AL.Lib, EntryPoint = "alListenerfv", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
unsafe private static extern void ListenerPrivate(ALListenerfv param, float* values);
// AL_API void AL_APIENTRY alListenerfv( ALenum param, const ALfloat* values );
/// <summary>This function sets a floating point-vector property of the listener.</summary>
/// <param name="param">The name of the attribute to be set: ALListener3f.Position, ALListener3f.Velocity, ALListenerfv.Orientation</param>
/// <param name="values">Pointer to floating point-vector values.</param>
public static void Listener(ALListenerfv param, ref float[] values)
{
unsafe
{
fixed (float* ptr = &values[0])
{
ListenerPrivate(param, ptr);
}
}
}
/// <summary>This function sets two Math.Vector3 properties of the listener.</summary>
/// <param name="param">The name of the attribute to be set: ALListenerfv.Orientation</param>
/// <param name="at">A Math.Vector3 for the At-Vector.</param>
/// <param name="up">A Math.Vector3 for the Up-Vector.</param>
public static void Listener(ALListenerfv param, ref Vector3 at, ref Vector3 up)
{
float[] temp = new float[6];
temp[0] = at.X;
temp[1] = at.Y;
temp[2] = at.Z;
temp[3] = up.X;
temp[4] = up.Y;
temp[5] = up.Z;
unsafe
{
fixed (float* ptr = &temp[0])
{
ListenerPrivate(param, ptr);
}
}
}
// Not used by any Enums
// AL_API void AL_APIENTRY alListeneri( ALenum param, ALint value );
// AL_API void AL_APIENTRY alListener3i( ALenum param, ALint value1, ALint value2, ALint value3 );
// AL_API void AL_APIENTRY alListeneriv( ALenum param, const ALint* values );
#endregion Set Listener parameters
#region Get Listener parameters
/// <summary>This function retrieves a floating point property of the listener.</summary>
/// <param name="param">the name of the attribute to be retrieved: ALListenerf.Gain</param>
/// <param name="value">a pointer to the floating point value being retrieved.</param>
[DllImport(AL.Lib, EntryPoint = "alGetListenerf", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void GetListener(ALListenerf param, [Out] out float value);
// AL_API void AL_APIENTRY alGetListenerf( ALenum param, ALfloat* value );
/// <summary>This function retrieves a set of three floating point values from a property of the listener.</summary>
/// <param name="param">The name of the attribute to be retrieved: ALListener3f.Position, ALListener3f.Velocity</param>
/// <param name="value1">Pointers to the three floating point being retrieved.</param>
/// <param name="value2">Pointers to the three floating point being retrieved.</param>
/// <param name="value3">Pointers to the three floating point being retrieved.</param>
[DllImport(AL.Lib, EntryPoint = "alGetListener3f", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void GetListener(ALListener3f param, [Out] out float value1, [Out] out float value2, [Out] out float value3);
// AL_API void AL_APIENTRY alGetListener3f( ALenum param, ALfloat *value1, ALfloat *value2, ALfloat *value3 );
/// <summary>This function retrieves a Math.Vector3 from a property of the listener.</summary>
/// <param name="param">The name of the attribute to be retrieved: ALListener3f.Position, ALListener3f.Velocity</param>
/// <param name="values">A Math.Vector3 to hold the three floats being retrieved.</param>
public static void GetListener(ALListener3f param, out Vector3 values)
{
GetListener(param, out values.X, out values.Y, out values.Z);
}
/// <summary>This function retrieves a floating point-vector property of the listener. You must pin it manually.</summary>
/// <param name="param">the name of the attribute to be retrieved: ALListener3f.Position, ALListener3f.Velocity, ALListenerfv.Orientation</param>
/// <param name="values">A pointer to the floating point-vector value being retrieved.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alGetListenerfv", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
unsafe public static extern void GetListener(ALListenerfv param, float* values);
// AL_API void AL_APIENTRY alGetListenerfv( ALenum param, ALfloat* values );
/// <summary>This function retrieves two Math.Vector3 properties of the listener.</summary>
/// <param name="param">the name of the attribute to be retrieved: ALListenerfv.Orientation</param>
/// <param name="at">A Math.Vector3 for the At-Vector.</param>
/// <param name="up">A Math.Vector3 for the Up-Vector.</param>
public static void GetListener(ALListenerfv param, out Vector3 at, out Vector3 up)
{
float[] pinned = new float[6]; // should lose scope when the function exits
unsafe
{
fixed (float* ptr = &pinned[0])
{
GetListener(param, ptr);
at.X = pinned[0];
at.Y = pinned[1];
at.Z = pinned[2];
up.X = pinned[3];
up.Y = pinned[4];
up.Z = pinned[5];
}
}
}
// Not used by any Enum:
// AL_API void AL_APIENTRY alGetListeneri( ALenum param, ALint* value );
// AL_API void AL_APIENTRY alGetListener3i( ALenum param, ALint *value1, ALint *value2, ALint *value3 );
// AL_API void AL_APIENTRY alGetListeneriv( ALenum param, ALint* values );
#endregion Get Listener parameters
/* Source
* Sources represent individual sound objects in 3D-space.
* Sources take the PCM buffer provided in the specified Buffer,
* apply Source-specific modifications, and then
* submit them to be mixed according to spatial arrangement etc.
*
* Properties include: -
*
* Position AL_POSITION ALfloat[3]
* Velocity AL_VELOCITY ALfloat[3]
* Direction AL_DIRECTION ALfloat[3]
* Head Relative Mode AL_SOURCE_RELATIVE ALint (AL_TRUE or AL_FALSE)
* Looping AL_LOOPING ALint (AL_TRUE or AL_FALSE)
*
* Reference Distance AL_REFERENCE_DISTANCE ALfloat
* Max Distance AL_MAX_DISTANCE ALfloat
* RollOff Factor AL_ROLLOFF_FACTOR ALfloat
* Pitch AL_PITCH ALfloat
* Gain AL_GAIN ALfloat
* Min Gain AL_MIN_GAIN ALfloat
* Max Gain AL_MAX_GAIN ALfloat
* Inner Angle AL_CONE_INNER_ANGLE ALint or ALfloat
* Outer Angle AL_CONE_OUTER_ANGLE ALint or ALfloat
* Cone Outer Gain AL_CONE_OUTER_GAIN ALint or ALfloat
*
* MS Offset AL_MSEC_OFFSET ALint or ALfloat
* Byte Offset AL_BYTE_OFFSET ALint or ALfloat
* Sample Offset AL_SAMPLE_OFFSET ALint or ALfloat
* Attached Buffer AL_BUFFER ALint
*
* State (Query only) AL_SOURCE_STATE ALint
* Buffers Queued (Query only) AL_BUFFERS_QUEUED ALint
* Buffers Processed (Query only) AL_BUFFERS_PROCESSED ALint
*/
#region Create Source objects
#region GenSources()
[DllImport(AL.Lib, EntryPoint = "alGenSources", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
unsafe private static extern void GenSourcesPrivate(int n, [Out] uint* sources);
// AL_API void AL_APIENTRY alGenSources( ALsizei n, ALuint* Sources );
/// <summary>This function generates one or more sources. References to sources are uint values, which are used wherever a source reference is needed (in calls such as AL.DeleteSources and AL.Source with parameter ALSourcei).</summary>
/// <param name="n">The number of sources to be generated.</param>
/// <param name="sources">Pointer to an array of uint values which will store the names of the new sources.</param>
[CLSCompliant(false)]
* AL/AL.cs: * Alc/AlcEnums.cs: Fixed documentation warnings.
2009-10-07 11:20:44 +00:00
public static void GenSources(int n, out uint sources)
{
unsafe
{
fixed (uint* sources_ptr = &sources)
{
GenSourcesPrivate(n, sources_ptr);
}
}
}
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
/// <summary>This function generates one or more sources. References to sources are int values, which are used wherever a source reference is needed (in calls such as AL.DeleteSources and AL.Source with parameter ALSourcei).</summary>
/// <param name="n">The number of sources to be generated.</param>
/// <param name="sources">Pointer to an array of int values which will store the names of the new sources.</param>
* AL/AL.cs: * Alc/AlcEnums.cs: Fixed documentation warnings.
2009-10-07 11:20:44 +00:00
public static void GenSources(int n, out int sources)
{
unsafe
{
fixed (int* sources_ptr = &sources)
{
GenSourcesPrivate(n, (uint*)sources_ptr);
}
}
}
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
/// <summary>This function generates one or more sources. References to sources are int values, which are used wherever a source reference is needed (in calls such as AL.DeleteSources and AL.Source with parameter ALSourcei).</summary>
/// <param name="sources">Pointer to an array of int values which will store the names of the new sources.</param>
public static void GenSources(int[] sources)
{
uint[] temp = new uint[sources.Length];
GenSources(temp.Length, out temp[0]);
for (int i = 0; i < temp.Length; i++)
{
sources[i] = (int)temp[i];
}
}
/// <summary>This function generates one or more sources. References to sources are int values, which are used wherever a source reference is needed (in calls such as AL.DeleteSources and AL.Source with parameter ALSourcei).</summary>
/// <param name="n">The number of sources to be generated.</param>
/// <returns>Pointer to an array of int values which will store the names of the new sources.</returns>
public static int[] GenSources(int n)
{
uint[] temp = new uint[n];
GenSources(temp.Length, out temp[0]);
int[] sources = new int[n];
for (int i = 0; i < temp.Length; i++)
{
sources[i] = (int)temp[i];
}
return sources;
}
/// <summary>This function generates one source only. References to sources are int values, which are used wherever a source reference is needed (in calls such as AL.DeleteSources and AL.Source with parameter ALSourcei).</summary>
/// <returns>Pointer to an int value which will store the name of the new source.</returns>
public static int GenSource()
{
int temp;
GenSources(1, out temp);
return (int)temp;
}
/// <summary>This function generates one source only. References to sources are uint values, which are used wherever a source reference is needed (in calls such as AL.DeleteSources and AL.Source with parameter ALSourcei).</summary>
/// <param name="source">Pointer to an uint value which will store the name of the new source.</param>
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
[CLSCompliant(false)]
public static void GenSource(out uint source)
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
{
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
GenSources(1, out source);
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
}
#endregion GenSources()
#region DeleteSources()
/// <summary>This function deletes one or more sources.</summary>
/// <param name="n">The number of sources to be deleted.</param>
/// <param name="sources">Pointer to an array of source names identifying the sources to be deleted.</param>
[CLSCompliant(false)]
[DllImport(AL.Lib, EntryPoint = "alDeleteSources", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
unsafe public static extern void DeleteSources(int n, [In] uint* sources); // Delete Source objects
// AL_API void AL_APIENTRY alDeleteSources( ALsizei n, const ALuint* Sources );
/// <summary>This function deletes one or more sources.</summary>
/// <param name="n">The number of sources to be deleted.</param>
/// <param name="sources">Reference to a single source, or an array of source names identifying the sources to be deleted.</param>
[CLSCompliant(false)]
[DllImport(AL.Lib, EntryPoint = "alDeleteSources", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void DeleteSources(int n, ref uint sources);
/// <summary>This function deletes one or more sources.</summary>
/// <param name="n">The number of sources to be deleted.</param>
/// <param name="sources">Reference to a single source, or an array of source names identifying the sources to be deleted.</param>
[DllImport(AL.Lib, EntryPoint = "alDeleteSources", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void DeleteSources(int n, ref int sources);
/// <summary>This function deletes one or more sources.</summary>
/// <param name="sources">An array of source names identifying the sources to be deleted.</param>
[CLSCompliant(false)]
public static void DeleteSources(uint[] sources)
{
if (sources == null) throw new ArgumentNullException();
if (sources.Length == 0) throw new ArgumentOutOfRangeException();
DeleteBuffers(sources.Length, ref sources[0]);
}
/// <summary>This function deletes one or more sources.</summary>
/// <param name="sources">An array of source names identifying the sources to be deleted.</param>
public static void DeleteSources(int[] sources)
{
if (sources == null) throw new ArgumentNullException();
if (sources.Length == 0) throw new ArgumentOutOfRangeException();
DeleteBuffers(sources.Length, ref sources[0]);
}
/// <summary>This function deletes one source only.</summary>
/// <param name="source">Pointer to a source name identifying the source to be deleted.</param>
[CLSCompliant(false)]
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
public static void DeleteSource(ref uint source)
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
{
DeleteSources(1, ref source);
}
/// <summary>This function deletes one source only.</summary>
/// <param name="source">Pointer to a source name identifying the source to be deleted.</param>
public static void DeleteSource(int source)
{
DeleteSources(1, ref source);
}
#endregion DeleteSources()
#region IsSource()
/// <summary>This function tests if a source name is valid, returning True if valid and False if not.</summary>
/// <param name="sid">A source name to be tested for validity</param>
/// <returns>Success.</returns>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alIsSource", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern bool IsSource(uint sid);
// AL_API ALboolean AL_APIENTRY alIsSource( ALuint sid );
/// <summary>This function tests if a source name is valid, returning True if valid and False if not.</summary>
/// <param name="sid">A source name to be tested for validity</param>
/// <returns>Success.</returns>
public static bool IsSource(int sid)
{
return IsSource((uint)sid);
}
#endregion IsSource()
#endregion Create Source objects
#region Set Source parameters
#region Sourcef
/// <summary>This function sets a floating point property of a source.</summary>
/// <param name="sid">Source name whose attribute is being set</param>
/// <param name="param">The name of the attribute to set: ALSourcef.Pitch, Gain, MinGain, MaxGain, MaxDistance, RolloffFactor, ConeOuterGain, ConeInnerAngle, ConeOuterAngle, ReferenceDistance, EfxAirAbsorptionFactor, EfxRoomRolloffFactor, EfxConeOuterGainHighFrequency.</param>
/// <param name="value">The value to set the attribute to.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alSourcef", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void Source(uint sid, ALSourcef param, float value);
// AL_API void AL_APIENTRY alSourcef( ALuint sid, ALenum param, ALfloat value );
/// <summary>This function sets a floating point property of a source.</summary>
/// <param name="sid">Source name whose attribute is being set</param>
/// <param name="param">The name of the attribute to set: ALSourcef.Pitch, Gain, MinGain, MaxGain, MaxDistance, RolloffFactor, ConeOuterGain, ConeInnerAngle, ConeOuterAngle, ReferenceDistance, EfxAirAbsorptionFactor, EfxRoomRolloffFactor, EfxConeOuterGainHighFrequency.</param>
/// <param name="value">The value to set the attribute to.</param>
public static void Source(int sid, ALSourcef param, float value)
{
Source((uint)sid, param, value);
}
#endregion Sourcef
#region Source3f
/// <summary>This function sets a source property requiring three floating point values.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="value1">The three ALfloat values which the attribute will be set to.</param>
/// <param name="value2">The three ALfloat values which the attribute will be set to.</param>
/// <param name="value3">The three ALfloat values which the attribute will be set to.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alSource3f", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void Source(uint sid, ALSource3f param, float value1, float value2, float value3);
// AL_API void AL_APIENTRY alSource3f( ALuint sid, ALenum param, ALfloat value1, ALfloat value2, ALfloat value3 );
/// <summary>This function sets a source property requiring three floating point values.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="value1">The three ALfloat values which the attribute will be set to.</param>
/// <param name="value2">The three ALfloat values which the attribute will be set to.</param>
/// <param name="value3">The three ALfloat values which the attribute will be set to.</param>
public static void Source(int sid, ALSource3f param, float value1, float value2, float value3)
{
Source((uint)sid, param, value1, value2, value3);
}
/// <summary>This function sets a source property requiring three floating point values.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="values">A Math.Vector3 which the attribute will be set to.</param>
[CLSCompliant(false)]
public static void Source(uint sid, ALSource3f param, ref Vector3 values)
{
Source(sid, param, values.X, values.Y, values.Z);
}
/// <summary>This function sets a source property requiring three floating point values.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="values">A Math.Vector3 which the attribute will be set to.</param>
public static void Source(int sid, ALSource3f param, ref Vector3 values)
{
Source((uint)sid, param, values.X, values.Y, values.Z);
}
#endregion Source3f
#region Sourcei
/// <summary>This function sets an integer property of a source.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSourcei.SourceRelative, ConeInnerAngle, ConeOuterAngle, Looping, Buffer, SourceState.</param>
/// <param name="value">The value to set the attribute to.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alSourcei", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void Source(uint sid, ALSourcei param, int value);
// AL_API void AL_APIENTRY alSourcei( ALuint sid, ALenum param, ALint value );
/// <summary>This function sets an integer property of a source.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSourcei.SourceRelative, ConeInnerAngle, ConeOuterAngle, Looping, Buffer, SourceState.</param>
/// <param name="value">The value to set the attribute to.</param>
public static void Source(int sid, ALSourcei param, int value)
{
Source((uint)sid, param, value);
}
/// <summary>This function sets an bool property of a source.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSourceb.SourceRelative, Looping.</param>
/// <param name="value">The value to set the attribute to.</param>
[CLSCompliant(false)]
public static void Source(uint sid, ALSourceb param, bool value)
{
Source(sid, (ALSourcei)param, (value) ? 1 : 0);
}
/// <summary>This function sets an bool property of a source.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: ALSourceb.SourceRelative, Looping.</param>
/// <param name="value">The value to set the attribute to.</param>
public static void Source(int sid, ALSourceb param, bool value)
{
Source((uint)sid, (ALSourcei)param, (value) ? 1 : 0);
}
/// <summary>(Helper) Binds a Buffer to a Source handle.</summary>
/// <param name="source">Source name to attach the Buffer to.</param>
/// <param name="buffer">Buffer name which is attached to the Source.</param>
[CLSCompliant(false)]
public static void BindBufferToSource(uint source, uint buffer)
{
Source(source, ALSourcei.Buffer, (int)buffer);
}
/// <summary>(Helper) Binds a Buffer to a Source handle.</summary>
/// <param name="source">Source name to attach the Buffer to.</param>
/// <param name="buffer">Buffer name which is attached to the Source.</param>
public static void BindBufferToSource(int source, int buffer)
{
Source((uint)source, ALSourcei.Buffer, buffer);
}
#endregion Sourcei
#region Source3i
/// <summary>This function sets 3 integer properties of a source. This property is used to establish connections between Sources and Auxiliary Effect Slots.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: EfxAuxiliarySendFilter</param>
/// <param name="value1">The value to set the attribute to. (EFX Extension) The destination Auxiliary Effect Slot ID</param>
/// <param name="value2">The value to set the attribute to. (EFX Extension) The Auxiliary Send number.</param>
///<param name="value3">The value to set the attribute to. (EFX Extension) optional Filter ID.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alSource3i", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void Source(uint sid, ALSource3i param, int value1, int value2, int value3);
// AL_API void AL_APIENTRY alSource3i( ALuint sid, ALenum param, ALint value1, ALint value2, ALint value3 );
/// <summary>This function sets 3 integer properties of a source. This property is used to establish connections between Sources and Auxiliary Effect Slots.</summary>
/// <param name="sid">Source name whose attribute is being set.</param>
/// <param name="param">The name of the attribute to set: EfxAuxiliarySendFilter</param>
/// <param name="value1">The value to set the attribute to. (EFX Extension) The destination Auxiliary Effect Slot ID</param>
/// <param name="value2">The value to set the attribute to. (EFX Extension) The Auxiliary Send number.</param>
///<param name="value3">The value to set the attribute to. (EFX Extension) optional Filter ID.</param>
public static void Source(int sid, ALSource3i param, int value1, int value2, int value3)
{
Source((uint)sid, param, value1, value2, value3);
}
#endregion Source3i
// Not used by any Enum:
// AL_API void AL_APIENTRY alSourcefv( ALuint sid, ALenum param, const ALfloat* values );
// AL_API void AL_APIENTRY alSourceiv( ALuint sid, ALenum param, const ALint* values );
#endregion Set Source parameters
#region Get Source parameters
#region GetSourcef
/// <summary>This function retrieves a floating point property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">The name of the attribute to set: ALSourcef.Pitch, Gain, MinGain, MaxGain, MaxDistance, RolloffFactor, ConeOuterGain, ConeInnerAngle, ConeOuterAngle, ReferenceDistance, EfxAirAbsorptionFactor, EfxRoomRolloffFactor, EfxConeOuterGainHighFrequency.</param>
/// <param name="value">A pointer to the floating point value being retrieved</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alGetSourcef", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void GetSource(uint sid, ALSourcef param, [Out] out float value);
// AL_API void AL_APIENTRY alGetSourcef( ALuint sid, ALenum param, ALfloat* value );
/// <summary>This function retrieves a floating point property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">The name of the attribute to set: ALSourcef.Pitch, Gain, MinGain, MaxGain, MaxDistance, RolloffFactor, ConeOuterGain, ConeInnerAngle, ConeOuterAngle, ReferenceDistance, EfxAirAbsorptionFactor, EfxRoomRolloffFactor, EfxConeOuterGainHighFrequency.</param>
/// <param name="value">A pointer to the floating point value being retrieved</param>
public static void GetSource(int sid, ALSourcef param, out float value)
{
GetSource((uint)sid, param, out value);
}
#endregion GetSourcef
#region GetSource3f
/// <summary>This function retrieves three floating point values representing a property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">the name of the attribute being retrieved: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="value1">Pointer to the value to retrieve.</param>
/// <param name="value2">Pointer to the value to retrieve.</param>
/// <param name="value3">Pointer to the value to retrieve.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alGetSource3f", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void GetSource(uint sid, ALSource3f param, [Out] out float value1, [Out] out float value2, [Out] out float value3);
// AL_API void AL_APIENTRY alGetSource3f( ALuint sid, ALenum param, ALfloat* value1, ALfloat* value2, ALfloat* value3);
/// <summary>This function retrieves three floating point values representing a property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">the name of the attribute being retrieved: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="value1">Pointer to the value to retrieve.</param>
/// <param name="value2">Pointer to the value to retrieve.</param>
/// <param name="value3">Pointer to the value to retrieve.</param>
public static void GetSource(int sid, ALSource3f param, out float value1, out float value2, out float value3)
{
GetSource((uint)sid, param, out value1, out value2, out value3);
}
/// <summary>This function retrieves three floating point values representing a property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">the name of the attribute being retrieved: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="values">A Math.Vector3 to retrieve the values to.</param>
[CLSCompliant(false)]
public static void GetSource(uint sid, ALSource3f param, out Vector3 values)
{
GetSource(sid, param, out values.X, out values.Y, out values.Z);
}
/// <summary>This function retrieves three floating point values representing a property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">the name of the attribute being retrieved: ALSource3f.Position, Velocity, Direction.</param>
/// <param name="values">A Math.Vector3 to retrieve the values to.</param>
public static void GetSource(int sid, ALSource3f param, out Vector3 values)
{
GetSource((uint)sid, param, out values.X, out values.Y, out values.Z);
}
#endregion GetSource3f
#region GetSourcei
/// <summary>This function retrieves an integer property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">The name of the attribute to retrieve: ALSourcei.SourceRelative, Buffer, SourceState, BuffersQueued, BuffersProcessed.</param>
/// <param name="value">A pointer to the integer value being retrieved.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alGetSourcei", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void GetSource(uint sid, ALGetSourcei param, [Out] out int value);
// AL_API void AL_APIENTRY alGetSourcei( ALuint sid, ALenum param, ALint* value );
/// <summary>This function retrieves an integer property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">The name of the attribute to retrieve: ALSourcei.SourceRelative, Buffer, SourceState, BuffersQueued, BuffersProcessed.</param>
/// <param name="value">A pointer to the integer value being retrieved.</param>
public static void GetSource(int sid, ALGetSourcei param, out int value)
{
GetSource((uint)sid, param, out value);
}
/// <summary>This function retrieves a bool property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">The name of the attribute to get: ALSourceb.SourceRelative, Looping.</param>
/// <param name="value">A pointer to the bool value being retrieved.</param>
[CLSCompliant(false)]
public static void GetSource(uint sid, ALSourceb param, out bool value)
{
int result;
GetSource(sid, (ALGetSourcei)param, out result);
value = result != 0;
}
/// <summary>This function retrieves a bool property of a source.</summary>
/// <param name="sid">Source name whose attribute is being retrieved.</param>
/// <param name="param">The name of the attribute to get: ALSourceb.SourceRelative, Looping.</param>
/// <param name="value">A pointer to the bool value being retrieved.</param>
public static void GetSource(int sid, ALSourceb param, out bool value)
{
int result;
GetSource((uint)sid, (ALGetSourcei)param, out result);
value = result != 0;
}
#endregion GetSourcei
// Not used by any Enum:
// AL_API void AL_APIENTRY alGetSource3i( ALuint sid, ALenum param, ALint* value1, ALint* value2, ALint* value3);
// AL_API void AL_APIENTRY alGetSourcefv( ALuint sid, ALenum param, ALfloat* values );
// AL_API void AL_APIENTRY alGetSourceiv( ALuint sid, ALenum param, ALint* values );
#endregion Get Source parameters
#region Source vector based playback calls
#region SourcePlay
/// <summary>This function plays a set of sources. The playing sources will have their state changed to ALSourceState.Playing. When called on a source which is already playing, the source will restart at the beginning. When the attached buffer(s) are done playing, the source will progress to the ALSourceState.Stopped state.</summary>
/// <param name="ns">The number of sources to be played.</param>
/// <param name="sids">A pointer to an array of sources to be played.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alSourcePlayv"), SuppressUnmanagedCodeSecurity]
unsafe public static extern void SourcePlay(int ns, [In] uint* sids);
// AL_API void AL_APIENTRY alSourcePlayv( ALsizei ns, const ALuint *sids );
/// <summary>This function plays a set of sources. The playing sources will have their state changed to ALSourceState.Playing. When called on a source which is already playing, the source will restart at the beginning. When the attached buffer(s) are done playing, the source will progress to the ALSourceState.Stopped state.</summary>
/// <param name="ns">The number of sources to be played.</param>
/// <param name="sids">A pointer to an array of sources to be played.</param>
[CLSCompliant(false)]
public static void SourcePlay(int ns, uint[] sids)
{
unsafe
{
fixed (uint* ptr = sids)
{
SourcePlay(ns, ptr);
}
}
}
/// <summary>This function plays a set of sources. The playing sources will have their state changed to ALSourceState.Playing. When called on a source which is already playing, the source will restart at the beginning. When the attached buffer(s) are done playing, the source will progress to the ALSourceState.Stopped state.</summary>
/// <param name="ns">The number of sources to be played.</param>
/// <param name="sids">A pointer to an array of sources to be played.</param>
public static void SourcePlay(int ns, int[] sids)
{
uint[] temp = new uint[ns];
for (int i = 0; i < ns; i++)
{
temp[i] = (uint)sids[i];
}
SourcePlay(ns, temp);
}
/// <summary>This function plays a set of sources. The playing sources will have their state changed to ALSourceState.Playing. When called on a source which is already playing, the source will restart at the beginning. When the attached buffer(s) are done playing, the source will progress to the ALSourceState.Stopped state.</summary>
/// <param name="ns">The number of sources to be played.</param>
/// <param name="sids">A pointer to an array of sources to be played.</param>
[CLSCompliant(false)]
public static void SourcePlay(int ns, ref uint sids)
{
unsafe
{
fixed (uint* ptr = &sids)
{
SourcePlay(ns, ptr);
}
}
}
#endregion SourcePlay
#region SourceStop
/// <summary>This function stops a set of sources. The stopped sources will have their state changed to ALSourceState.Stopped.</summary>
/// <param name="ns">The number of sources to stop.</param>
/// <param name="sids">A pointer to an array of sources to be stopped.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alSourceStopv"), SuppressUnmanagedCodeSecurity]
unsafe public static extern void SourceStop(int ns, [In] uint* sids);
// AL_API void AL_APIENTRY alSourceStopv( ALsizei ns, const ALuint *sids );
/// <summary>This function stops a set of sources. The stopped sources will have their state changed to ALSourceState.Stopped.</summary>
/// <param name="ns">The number of sources to stop.</param>
/// <param name="sids">A pointer to an array of sources to be stopped.</param>
[CLSCompliant(false)]
public static void SourceStop(int ns, uint[] sids)
{
unsafe
{
fixed (uint* ptr = sids)
{
SourceStop(ns, ptr);
}
}
}
/// <summary>This function stops a set of sources. The stopped sources will have their state changed to ALSourceState.Stopped.</summary>
/// <param name="ns">The number of sources to stop.</param>
/// <param name="sids">A pointer to an array of sources to be stopped.</param>
public static void SourceStop(int ns, int[] sids)
{
uint[] temp = new uint[ns];
for (int i = 0; i < ns; i++)
{
temp[i] = (uint)sids[i];
}
SourceStop(ns, temp);
}
/// <summary>This function stops a set of sources. The stopped sources will have their state changed to ALSourceState.Stopped.</summary>
/// <param name="ns">The number of sources to stop.</param>
/// <param name="sids">A pointer to an array of sources to be stopped.</param>
[CLSCompliant(false)]
public static void SourceStop(int ns, ref uint sids)
{
unsafe
{
fixed (uint* ptr = &sids)
{
SourceStop(ns, ptr);
}
}
}
#endregion SourceStop
#region SourceRewind
/// <summary>This function stops a set of sources and sets all their states to ALSourceState.Initial.</summary>
/// <param name="ns">The number of sources to be rewound.</param>
/// <param name="sids">A pointer to an array of sources to be rewound.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alSourceRewindv"), SuppressUnmanagedCodeSecurity]
unsafe public static extern void SourceRewind(int ns, [In] uint* sids);
// AL_API void AL_APIENTRY alSourceRewindv( ALsizei ns, const ALuint *sids );
/// <summary>This function stops a set of sources and sets all their states to ALSourceState.Initial.</summary>
/// <param name="ns">The number of sources to be rewound.</param>
/// <param name="sids">A pointer to an array of sources to be rewound.</param>
[CLSCompliant(false)]
public static void SourceRewind(int ns, uint[] sids)
{
unsafe
{
fixed (uint* ptr = sids)
{
SourceRewind(ns, ptr);
}
}
}
/// <summary>This function stops a set of sources and sets all their states to ALSourceState.Initial.</summary>
/// <param name="ns">The number of sources to be rewound.</param>
/// <param name="sids">A pointer to an array of sources to be rewound.</param>
public static void SourceRewind(int ns, int[] sids)
{
uint[] temp = new uint[ns];
for (int i = 0; i < ns; i++)
{
temp[i] = (uint)sids[i];
}
SourceRewind(ns, temp);
}
/// <summary>This function stops a set of sources and sets all their states to ALSourceState.Initial.</summary>
/// <param name="ns">The number of sources to be rewound.</param>
/// <param name="sids">A pointer to an array of sources to be rewound.</param>
[CLSCompliant(false)]
public static void SourceRewind(int ns, ref uint sids)
{
unsafe
{
fixed (uint* ptr = &sids)
{
SourceRewind(ns, ptr);
}
}
}
#endregion SourceRewind
#region SourcePause
/// <summary>This function pauses a set of sources. The paused sources will have their state changed to ALSourceState.Paused.</summary>
/// <param name="ns">The number of sources to be paused.</param>
/// <param name="sids">A pointer to an array of sources to be paused.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alSourcePausev"), SuppressUnmanagedCodeSecurity]
unsafe public static extern void SourcePause(int ns, [In] uint* sids);
// AL_API void AL_APIENTRY alSourcePausev( ALsizei ns, const ALuint *sids );
/// <summary>This function pauses a set of sources. The paused sources will have their state changed to ALSourceState.Paused.</summary>
/// <param name="ns">The number of sources to be paused.</param>
/// <param name="sids">A pointer to an array of sources to be paused.</param>
[CLSCompliant(false)]
public static void SourcePause(int ns, uint[] sids)
{
unsafe
{
fixed (uint* ptr = sids)
{
SourcePause(ns, ptr);
}
}
}
/// <summary>This function pauses a set of sources. The paused sources will have their state changed to ALSourceState.Paused.</summary>
/// <param name="ns">The number of sources to be paused.</param>
/// <param name="sids">A pointer to an array of sources to be paused.</param>
public static void SourcePause(int ns, int[] sids)
{
uint[] temp = new uint[ns];
for (int i = 0; i < ns; i++)
{
temp[i] = (uint)sids[i];
}
SourcePause(ns, temp);
}
/// <summary>This function pauses a set of sources. The paused sources will have their state changed to ALSourceState.Paused.</summary>
/// <param name="ns">The number of sources to be paused.</param>
/// <param name="sids">A pointer to an array of sources to be paused.</param>
[CLSCompliant(false)]
public static void SourcePause(int ns, ref uint sids)
{
unsafe
{
fixed (uint* ptr = &sids)
{
SourcePause(ns, ptr);
}
}
}
#endregion SourcePause
#endregion Source vector based playback calls
#region Source based playback calls
#region SourcePlay
/// <summary>This function plays, replays or resumes a source. The playing source will have it's state changed to ALSourceState.Playing. When called on a source which is already playing, the source will restart at the beginning. When the attached buffer(s) are done playing, the source will progress to the ALSourceState.Stopped state.</summary>
/// <param name="sid">The name of the source to be played.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alSourcePlay", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void SourcePlay(uint sid);
// AL_API void AL_APIENTRY alSourcePlay( ALuint sid );
/// <summary>This function plays, replays or resumes a source. The playing source will have it's state changed to ALSourceState.Playing. When called on a source which is already playing, the source will restart at the beginning. When the attached buffer(s) are done playing, the source will progress to the ALSourceState.Stopped state.</summary>
/// <param name="sid">The name of the source to be played.</param>
public static void SourcePlay(int sid)
{
SourcePlay((uint)sid);
}
#endregion SourcePlay
#region SourceStop
/// <summary>This function stops a source. The stopped source will have it's state changed to ALSourceState.Stopped.</summary>
/// <param name="sid">The name of the source to be stopped.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alSourceStop", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void SourceStop(uint sid);
// AL_API void AL_APIENTRY alSourceStop( ALuint sid );
/// <summary>This function stops a source. The stopped source will have it's state changed to ALSourceState.Stopped.</summary>
/// <param name="sid">The name of the source to be stopped.</param>
public static void SourceStop(int sid)
{
SourceStop((uint)sid);
}
#endregion SourceStop
#region SourceRewind
/// <summary>This function stops the source and sets its state to ALSourceState.Initial.</summary>
/// <param name="sid">The name of the source to be rewound.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alSourceRewind", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void SourceRewind(uint sid);
// AL_API void AL_APIENTRY alSourceRewind( ALuint sid );
/// <summary>This function stops the source and sets its state to ALSourceState.Initial.</summary>
/// <param name="sid">The name of the source to be rewound.</param>
public static void SourceRewind(int sid)
{
SourceRewind((uint)sid);
}
#endregion SourceRewind
#region SourcePause
/// <summary>This function pauses a source. The paused source will have its state changed to ALSourceState.Paused.</summary>
/// <param name="sid">The name of the source to be paused.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alSourcePause", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void SourcePause(uint sid);
// AL_API void AL_APIENTRY alSourcePause( ALuint sid );
/// <summary>This function pauses a source. The paused source will have its state changed to ALSourceState.Paused.</summary>
/// <param name="sid">The name of the source to be paused.</param>
public static void SourcePause(int sid)
{
SourcePause((uint)sid);
}
#endregion SourcePause
#endregion Source based playback calls
#region Source Queuing
#region SourceQueueBuffers
/// <summary>This function queues a set of buffers on a source. All buffers attached to a source will be played in sequence, and the number of processed buffers can be detected using AL.GetSource with parameter ALGetSourcei.BuffersProcessed. When first created, a source will be of type ALSourceType.Undetermined. A successful AL.SourceQueueBuffers call will change the source type to ALSourceType.Streaming.</summary>
/// <param name="sid">The name of the source to queue buffers onto.</param>
/// <param name="numEntries">The number of buffers to be queued.</param>
/// <param name="bids">A pointer to an array of buffer names to be queued.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alSourceQueueBuffers"), SuppressUnmanagedCodeSecurity]
unsafe public static extern void SourceQueueBuffers(uint sid, int numEntries, [In] uint* bids);
// AL_API void AL_APIENTRY alSourceQueueBuffers( ALuint sid, ALsizei numEntries, const ALuint *bids );
/// <summary>This function queues a set of buffers on a source. All buffers attached to a source will be played in sequence, and the number of processed buffers can be detected using AL.GetSource with parameter ALGetSourcei.BuffersProcessed. When first created, a source will be of type ALSourceType.Undetermined. A successful AL.SourceQueueBuffers call will change the source type to ALSourceType.Streaming.</summary>
/// <param name="sid">The name of the source to queue buffers onto.</param>
/// <param name="numEntries">The number of buffers to be queued.</param>
/// <param name="bids">A pointer to an array of buffer names to be queued.</param>
[CLSCompliant(false)]
public static void SourceQueueBuffers(uint sid, int numEntries, uint[] bids)
{
unsafe
{
fixed (uint* ptr = bids)
{
SourceQueueBuffers(sid, numEntries, ptr);
}
}
}
/// <summary>This function queues a set of buffers on a source. All buffers attached to a source will be played in sequence, and the number of processed buffers can be detected using AL.GetSource with parameter ALGetSourcei.BuffersProcessed. When first created, a source will be of type ALSourceType.Undetermined. A successful AL.SourceQueueBuffers call will change the source type to ALSourceType.Streaming.</summary>
/// <param name="sid">The name of the source to queue buffers onto.</param>
/// <param name="numEntries">The number of buffers to be queued.</param>
/// <param name="bids">A pointer to an array of buffer names to be queued.</param>
public static void SourceQueueBuffers(int sid, int numEntries, int[] bids)
{
uint[] temp = new uint[numEntries];
for (int i = 0; i < numEntries; i++)
{
temp[i] = (uint)bids[i];
}
SourceQueueBuffers((uint)sid, numEntries, temp);
}
/// <summary>This function queues a set of buffers on a source. All buffers attached to a source will be played in sequence, and the number of processed buffers can be detected using AL.GetSource with parameter ALGetSourcei.BuffersProcessed. When first created, a source will be of type ALSourceType.Undetermined. A successful AL.SourceQueueBuffers call will change the source type to ALSourceType.Streaming.</summary>
/// <param name="sid">The name of the source to queue buffers onto.</param>
/// <param name="numEntries">The number of buffers to be queued.</param>
/// <param name="bids">A pointer to an array of buffer names to be queued.</param>
[CLSCompliant(false)]
public static void SourceQueueBuffers(uint sid, int numEntries, ref uint bids)
{
unsafe
{
fixed (uint* ptr = &bids)
{
SourceQueueBuffers(sid, numEntries, ptr);
}
}
}
/// <summary>This function queues a set of buffers on a source. All buffers attached to a source will be played in sequence, and the number of processed buffers can be detected using AL.GetSource with parameter ALGetSourcei.BuffersProcessed. When first created, a source will be of type ALSourceType.Undetermined. A successful AL.SourceQueueBuffers call will change the source type to ALSourceType.Streaming.</summary>
Fixed all known build warnings, apart from missing xml comments.
2009-03-25 21:53:12 +00:00
/// <param name="source">The name of the source to queue buffers onto.</param>
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
/// <param name="buffer">The name of the buffer to be queued.</param>
public static void SourceQueueBuffer(int source, int buffer)
{
unsafe { AL.SourceQueueBuffers((uint)source, 1, (uint*)&buffer); }
}
#endregion SourceQueueBuffers
#region SourceUnqueueBuffers
/// <summary>This function unqueues a set of buffers attached to a source. The number of processed buffers can be detected using AL.GetSource with parameter ALGetSourcei.BuffersProcessed, which is the maximum number of buffers that can be unqueued using this call. The unqueue operation will only take place if all n buffers can be removed from the queue.</summary>
/// <param name="sid">The name of the source to unqueue buffers from.</param>
/// <param name="numEntries">The number of buffers to be unqueued.</param>
/// <param name="bids">A pointer to an array of buffer names that were removed.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alSourceUnqueueBuffers"), SuppressUnmanagedCodeSecurity]
unsafe public static extern void SourceUnqueueBuffers(uint sid, int numEntries, [In] uint* bids);
// AL_API void AL_APIENTRY alSourceUnqueueBuffers( ALuint sid, ALsizei numEntries, ALuint *bids );
/// <summary>This function unqueues a set of buffers attached to a source. The number of processed buffers can be detected using AL.GetSource with parameter ALGetSourcei.BuffersProcessed, which is the maximum number of buffers that can be unqueued using this call. The unqueue operation will only take place if all n buffers can be removed from the queue.</summary>
/// <param name="sid">The name of the source to unqueue buffers from.</param>
/// <param name="numEntries">The number of buffers to be unqueued.</param>
/// <param name="bids">A pointer to an array of buffer names that were removed.</param>
[CLSCompliant(false)]
[DllImport(AL.Lib, EntryPoint = "alSourceUnqueueBuffers"), SuppressUnmanagedCodeSecurity]
public static extern void SourceUnqueueBuffers(uint sid, int numEntries, [Out] uint[] bids);
/// <summary>This function unqueues a set of buffers attached to a source. The number of processed buffers can be detected using AL.GetSource with parameter ALGetSourcei.BuffersProcessed, which is the maximum number of buffers that can be unqueued using this call. The unqueue operation will only take place if all n buffers can be removed from the queue.</summary>
/// <param name="sid">The name of the source to unqueue buffers from.</param>
/// <param name="numEntries">The number of buffers to be unqueued.</param>
/// <param name="bids">A pointer to an array of buffer names that were removed.</param>
[DllImport(AL.Lib, EntryPoint = "alSourceUnqueueBuffers"), SuppressUnmanagedCodeSecurity]
public static extern void SourceUnqueueBuffers(int sid, int numEntries, [Out] int[] bids);
/// <summary>This function unqueues a set of buffers attached to a source. The number of processed buffers can be detected using AL.GetSource with parameter ALGetSourcei.BuffersProcessed, which is the maximum number of buffers that can be unqueued using this call. The unqueue operation will only take place if all n buffers can be removed from the queue.</summary>
/// <param name="sid">The name of the source to unqueue buffers from.</param>
/// <param name="numEntries">The number of buffers to be unqueued.</param>
/// <param name="bids">A pointer to an array of buffer names that were removed.</param>
[CLSCompliant(false)]
[DllImport(AL.Lib, EntryPoint = "alSourceUnqueueBuffers"), SuppressUnmanagedCodeSecurity]
public static extern void SourceUnqueueBuffers(uint sid, int numEntries, ref uint bids);
/// <summary>This function unqueues a set of buffers attached to a source. The number of processed buffers can be detected using AL.GetSource with parameter ALGetSourcei.BuffersProcessed, which is the maximum number of buffers that can be unqueued using this call. The unqueue operation will only take place if all n buffers can be removed from the queue.</summary>
/// <param name="sid">The name of the source to unqueue buffers from.</param>
/// <param name="numEntries">The number of buffers to be unqueued.</param>
/// <param name="bids">A pointer to an array of buffer names that were removed.</param>
[DllImport(AL.Lib, EntryPoint = "alSourceUnqueueBuffers"), SuppressUnmanagedCodeSecurity]
public static extern void SourceUnqueueBuffers(int sid, int numEntries, ref int bids);
/// <summary>This function unqueues a set of buffers attached to a source. The number of processed buffers can be detected using AL.GetSource with parameter ALGetSourcei.BuffersProcessed, which is the maximum number of buffers that can be unqueued using this call. The unqueue operation will only take place if all n buffers can be removed from the queue.</summary>
/// <param name="sid">The name of the source to unqueue buffers from.</param>
public static int SourceUnqueueBuffer(int sid)
{
uint buf;
unsafe { SourceUnqueueBuffers((uint)sid, 1, &buf); }
return (int)buf;
}
/// <summary>This function unqueues a set of buffers attached to a source. The number of processed buffers can be detected using AL.GetSource with parameter ALGetSourcei.BuffersProcessed, which is the maximum number of buffers that can be unqueued using this call. The unqueue operation will only take place if all n buffers can be removed from the queue.</summary>
/// <param name="sid">The name of the source to unqueue buffers from.</param>
/// <param name="numEntries">The number of buffers to be unqueued.</param>
public static int[] SourceUnqueueBuffers(int sid, int numEntries)
{
if (numEntries <= 0) throw new ArgumentOutOfRangeException("numEntries", "Must be greater than zero.");
int[] buf = new int[numEntries];
SourceUnqueueBuffers(sid, numEntries, buf);
return buf;
}
#endregion SourceUnqueueBuffers
#endregion Source Queuing
/*
* Buffer
* Buffer objects are storage space for sample buffer.
* Buffers are referred to by Sources. One Buffer can be used
* by multiple Sources.
*
* Properties include: -
*
* Frequency (Query only) AL_FREQUENCY ALint
* Size (Query only) AL_SIZE ALint
* Bits (Query only) AL_BITS ALint
* Channels (Query only) AL_CHANNELS ALint
*/
#region Buffer objects
#region GenBuffers
/// <summary>This function generates one or more buffers, which contain audio buffer (see AL.BufferData). References to buffers are uint values, which are used wherever a buffer reference is needed (in calls such as AL.DeleteBuffers, AL.Source with parameter ALSourcei, AL.SourceQueueBuffers, and AL.SourceUnqueueBuffers).</summary>
/// <param name="n">The number of buffers to be generated.</param>
/// <param name="buffers">Pointer to an array of uint values which will store the names of the new buffers.</param>
[CLSCompliant(false)]
[DllImport(AL.Lib, EntryPoint = "alGenBuffers", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity]
unsafe public static extern void GenBuffers(int n, [Out] uint* buffers);
// AL_API void AL_APIENTRY alGenBuffers( ALsizei n, ALuint* Buffers );
/// <summary>This function generates one or more buffers, which contain audio buffer (see AL.BufferData). References to buffers are uint values, which are used wherever a buffer reference is needed (in calls such as AL.DeleteBuffers, AL.Source with parameter ALSourcei, AL.SourceQueueBuffers, and AL.SourceUnqueueBuffers).</summary>
/// <param name="n">The number of buffers to be generated.</param>
/// <param name="buffers">Pointer to an array of uint values which will store the names of the new buffers.</param>
[CLSCompliant(false)]
[DllImport(AL.Lib, EntryPoint = "alGenBuffers", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity]
public static extern void GenBuffers(int n, out uint buffers);
/// <summary>This function generates one or more buffers, which contain audio buffer (see AL.BufferData). References to buffers are uint values, which are used wherever a buffer reference is needed (in calls such as AL.DeleteBuffers, AL.Source with parameter ALSourcei, AL.SourceQueueBuffers, and AL.SourceUnqueueBuffers).</summary>
/// <param name="n">The number of buffers to be generated.</param>
/// <param name="buffers">Pointer to an array of uint values which will store the names of the new buffers.</param>
[DllImport(AL.Lib, EntryPoint = "alGenBuffers", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity]
public static extern void GenBuffers(int n, out int buffers);
/// <summary>This function generates one or more buffers, which contain audio data (see AL.BufferData). References to buffers are uint values, which are used wherever a buffer reference is needed (in calls such as AL.DeleteBuffers, AL.Source with parameter ALSourcei, AL.SourceQueueBuffers, and AL.SourceUnqueueBuffers).</summary>
/// <param name="n">The number of buffers to be generated.</param>
/// <returns>Pointer to an array of uint values which will store the names of the new buffers.</returns>
public static int[] GenBuffers(int n)
{
int[] buffers = new int[n];
GenBuffers(buffers.Length, out buffers[0]);
return buffers;
}
/// <summary>This function generates one buffer only, which contain audio data (see AL.BufferData). References to buffers are uint values, which are used wherever a buffer reference is needed (in calls such as AL.DeleteBuffers, AL.Source with parameter ALSourcei, AL.SourceQueueBuffers, and AL.SourceUnqueueBuffers).</summary>
/// <returns>Pointer to an uint value which will store the name of the new buffer.</returns>
public static int GenBuffer()
{
int temp;
GenBuffers(1, out temp);
return (int)temp;
}
/// <summary>This function generates one buffer only, which contain audio data (see AL.BufferData). References to buffers are uint values, which are used wherever a buffer reference is needed (in calls such as AL.DeleteBuffers, AL.Source with parameter ALSourcei, AL.SourceQueueBuffers, and AL.SourceUnqueueBuffers).</summary>
Fixed all known build warnings, apart from missing xml comments.
2009-03-25 21:53:12 +00:00
/// <param name="buffer">Pointer to an uint value which will store the names of the new buffer.</param>
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
[CLSCompliant(false)]
public static void GenBuffer(out uint buffer)
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
{
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
GenBuffers(1, out buffer);
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
}
#endregion GenBuffers
#region DeleteBuffers
/// <summary>This function deletes one or more buffers, freeing the resources used by the buffer. Buffers which are attached to a source can not be deleted. See AL.Source (ALSourcei) and AL.SourceUnqueueBuffers for information on how to detach a buffer from a source.</summary>
/// <param name="n">The number of buffers to be deleted.</param>
/// <param name="buffers">Pointer to an array of buffer names identifying the buffers to be deleted.</param>
[CLSCompliant(false)]
[DllImport(AL.Lib, EntryPoint = "alDeleteBuffers", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
unsafe public static extern void DeleteBuffers(int n, [In] uint* buffers);
// AL_API void AL_APIENTRY alDeleteBuffers( ALsizei n, const ALuint* Buffers );
/// <summary>This function deletes one or more buffers, freeing the resources used by the buffer. Buffers which are attached to a source can not be deleted. See AL.Source (ALSourcei) and AL.SourceUnqueueBuffers for information on how to detach a buffer from a source.</summary>
/// <param name="n">The number of buffers to be deleted.</param>
/// <param name="buffers">Pointer to an array of buffer names identifying the buffers to be deleted.</param>
[CLSCompliant(false)]
[DllImport(AL.Lib, EntryPoint = "alDeleteBuffers", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void DeleteBuffers(int n, [In] ref uint buffers);
/// <summary>This function deletes one or more buffers, freeing the resources used by the buffer. Buffers which are attached to a source can not be deleted. See AL.Source (ALSourcei) and AL.SourceUnqueueBuffers for information on how to detach a buffer from a source.</summary>
/// <param name="n">The number of buffers to be deleted.</param>
/// <param name="buffers">Pointer to an array of buffer names identifying the buffers to be deleted.</param>
[DllImport(AL.Lib, EntryPoint = "alDeleteBuffers", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void DeleteBuffers(int n, [In] ref int buffers);
/// <summary>This function deletes one buffer only, freeing the resources used by the buffer. Buffers which are attached to a source can not be deleted. See AL.Source (ALSourcei) and AL.SourceUnqueueBuffers for information on how to detach a buffer from a source.</summary>
Fixed all known build warnings, apart from missing xml comments.
2009-03-25 21:53:12 +00:00
/// <param name="buffers">Pointer to a buffer name identifying the buffer to be deleted.</param>
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
[CLSCompliant(false)]
public static void DeleteBuffers(uint[] buffers)
{
if (buffers == null) throw new ArgumentNullException();
if (buffers.Length == 0) throw new ArgumentOutOfRangeException();
DeleteBuffers(buffers.Length, ref buffers[0]);
}
/// <summary>This function deletes one or more buffers, freeing the resources used by the buffer. Buffers which are attached to a source can not be deleted. See AL.Source (ALSourcei) and AL.SourceUnqueueBuffers for information on how to detach a buffer from a source.</summary>
/// <param name="buffers">Pointer to an array of buffer names identifying the buffers to be deleted.</param>
public static void DeleteBuffers(int[] buffers)
{
if (buffers == null) throw new ArgumentNullException();
if (buffers.Length == 0) throw new ArgumentOutOfRangeException();
DeleteBuffers(buffers.Length, ref buffers[0]);
}
/// <summary>This function deletes one buffer only, freeing the resources used by the buffer. Buffers which are attached to a source can not be deleted. See AL.Source (ALSourcei) and AL.SourceUnqueueBuffers for information on how to detach a buffer from a source.</summary>
/// <param name="buffer">Pointer to a buffer name identifying the buffer to be deleted.</param>
[CLSCompliant(false)]
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
public static void DeleteBuffer(ref uint buffer)
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
{
DeleteBuffers(1, ref buffer);
}
/// <summary>This function deletes one buffer only, freeing the resources used by the buffer. Buffers which are attached to a source can not be deleted. See AL.Source (ALSourcei) and AL.SourceUnqueueBuffers for information on how to detach a buffer from a source.</summary>
/// <param name="buffer">Pointer to a buffer name identifying the buffer to be deleted.</param>
Fixed XML documentation warnings. Removed unnecessary [CLSCompliant(true)] attributes.
2009-09-04 23:12:10 +00:00
public static void DeleteBuffer(int buffer)
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
{
DeleteBuffers(1, ref buffer);
}
#endregion DeleteBuffers
#region IsBuffer
/// <summary>This function tests if a buffer name is valid, returning True if valid, False if not.</summary>
Fixed all known build warnings, apart from missing xml comments.
2009-03-25 21:53:12 +00:00
/// <param name="bid">A buffer Handle previously allocated with <see cref="GenBuffers(int)"/>.</param>
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
/// <returns>Success.</returns>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alIsBuffer", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern bool IsBuffer(uint bid);
// AL_API ALboolean AL_APIENTRY alIsBuffer( ALuint bid );
/// <summary>This function tests if a buffer name is valid, returning True if valid, False if not.</summary>
Fixed all known build warnings, apart from missing xml comments.
2009-03-25 21:53:12 +00:00
/// <param name="bid">A buffer Handle previously allocated with <see cref="GenBuffers(int)"/>.</param>
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
/// <returns>Success.</returns>
public static bool IsBuffer(int bid)
{
uint temp = (uint)bid;
return IsBuffer(temp);
}
#endregion IsBuffer
#region BufferData
/// <summary>This function fills a buffer with audio buffer. All the pre-defined formats are PCM buffer, but this function may be used by extensions to load other buffer types as well.</summary>
/// <param name="bid">buffer Handle/Name to be filled with buffer.</param>
/// <param name="format">Format type from among the following: ALFormat.Mono8, ALFormat.Mono16, ALFormat.Stereo8, ALFormat.Stereo16.</param>
Improved BlittableValueType API (Check, StrideOf methods). Added AL.BufferData<T> method.
2009-07-19 20:56:17 +00:00
/// <param name="buffer">Pointer to a pinned audio buffer.</param>
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
/// <param name="size">The size of the audio buffer in bytes.</param>
/// <param name="freq">The frequency of the audio buffer.</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alBufferData", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
Fixed all known build warnings, apart from missing xml comments.
2009-03-25 21:53:12 +00:00
public static extern void BufferData(uint bid, ALFormat format, IntPtr buffer, int size, int freq);
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
// AL_API void AL_APIENTRY alBufferData( ALuint bid, ALenum format, const ALvoid* buffer, ALsizei size, ALsizei freq );
/// <summary>This function fills a buffer with audio buffer. All the pre-defined formats are PCM buffer, but this function may be used by extensions to load other buffer types as well.</summary>
/// <param name="bid">buffer Handle/Name to be filled with buffer.</param>
/// <param name="format">Format type from among the following: ALFormat.Mono8, ALFormat.Mono16, ALFormat.Stereo8, ALFormat.Stereo16.</param>
Improved BlittableValueType API (Check, StrideOf methods). Added AL.BufferData<T> method.
2009-07-19 20:56:17 +00:00
/// <param name="buffer">Pointer to a pinned audio buffer.</param>
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
/// <param name="size">The size of the audio buffer in bytes.</param>
/// <param name="freq">The frequency of the audio buffer.</param>
Fixed all known build warnings, apart from missing xml comments.
2009-03-25 21:53:12 +00:00
public static void BufferData(int bid, ALFormat format, IntPtr buffer, int size, int freq)
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
{
Fixed all known build warnings, apart from missing xml comments.
2009-03-25 21:53:12 +00:00
BufferData((uint)bid, format, buffer, size, freq);
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
}
Improved BlittableValueType API (Check, StrideOf methods). Added AL.BufferData<T> method.
2009-07-19 20:56:17 +00:00
/// <summary>This function fills a buffer with audio buffer. All the pre-defined formats are PCM buffer, but this function may be used by extensions to load other buffer types as well.</summary>
/// <param name="bid">buffer Handle/Name to be filled with buffer.</param>
/// <param name="format">Format type from among the following: ALFormat.Mono8, ALFormat.Mono16, ALFormat.Stereo8, ALFormat.Stereo16.</param>
/// <param name="buffer">The audio buffer.</param>
/// <param name="size">The size of the audio buffer in bytes.</param>
/// <param name="freq">The frequency of the audio buffer.</param>
public static void BufferData<TBuffer>(int bid, ALFormat format, TBuffer[] buffer, int size, int freq)
where TBuffer : struct
{
if (!BlittableValueType.Check(buffer))
throw new ArgumentException("buffer");
GCHandle handle = GCHandle.Alloc(buffer, GCHandleType.Pinned);
try { BufferData(bid, format, handle.AddrOfPinnedObject(), size, freq); }
finally { handle.Free(); }
}
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
#endregion BufferData
#endregion Buffer objects
#region Set Buffer parameters (currently parameters can only be read)
/*
Remarks (from Manual)
* There are no relevant buffer properties defined in OpenAL 1.1 which can be affected by this call,
* but this function may be used by OpenAL extensions.
// AL_API void AL_APIENTRY alBufferf( ALuint bid, ALenum param, ALfloat value );
// AL_API void AL_APIENTRY alBufferfv( ALuint bid, ALenum param, const ALfloat* values );
// AL_API void AL_APIENTRY alBufferi( ALuint bid, ALenum param, ALint value );
// AL_API void AL_APIENTRY alBuffer3i( ALuint bid, ALenum param, ALint value1, ALint value2, ALint value3 );
// AL_API void AL_APIENTRY alBufferiv( ALuint bid, ALenum param, const ALint* values );
// AL_API void AL_APIENTRY alBuffer3f( ALuint bid, ALenum param, ALfloat value1, ALfloat value2, ALfloat value3 );
*/
/*
[DllImport( Al.Lib, EntryPoint = "alBuffer3f", ExactSpelling = true, CallingConvention = Al.Style ), SuppressUnmanagedCodeSecurity( )]
public static extern void Buffer3f( uint bid, ALenum param, ALfloat value1, ALfloat value2, ALfloat value3 );
public static void Bufferv3( uint bid, Alenum param, ref Vector3 values )
{
Buffer3f( bid, param, values.X, values.Y, values.Z );
}*/
#endregion Set Buffer parameters
#region Get Buffer parameters
#region GetBufferi
/// <summary>This function retrieves an integer property of a buffer.</summary>
/// <param name="bid">Buffer name whose attribute is being retrieved</param>
/// <param name="param">The name of the attribute to be retrieved: ALGetBufferi.Frequency, Bits, Channels, Size, and the currently hidden AL_DATA (dangerous).</param>
/// <param name="value">A pointer to an int to hold the retrieved buffer</param>
[CLSCompliant(false), DllImport(AL.Lib, EntryPoint = "alGetBufferi", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void GetBuffer(uint bid, ALGetBufferi param, [Out] out int value);
// AL_API void AL_APIENTRY alGetBufferi( ALuint bid, ALenum param, ALint* value );
/// <summary>This function retrieves an integer property of a buffer.</summary>
/// <param name="bid">Buffer name whose attribute is being retrieved</param>
/// <param name="param">The name of the attribute to be retrieved: ALGetBufferi.Frequency, Bits, Channels, Size, and the currently hidden AL_DATA (dangerous).</param>
/// <param name="value">A pointer to an int to hold the retrieved buffer</param>
public static void GetBuffer(int bid, ALGetBufferi param, out int value)
{
GetBuffer((uint)bid, param, out value);
}
#endregion GetBufferi
// AL_API void AL_APIENTRY alGetBufferf( ALuint bid, ALenum param, ALfloat* value );
// AL_API void AL_APIENTRY alGetBuffer3f( ALuint bid, ALenum param, ALfloat* value1, ALfloat* value2, ALfloat* value3);
// AL_API void AL_APIENTRY alGetBufferfv( ALuint bid, ALenum param, ALfloat* values );
// AL_API void AL_APIENTRY alGetBuffer3i( ALuint bid, ALenum param, ALint* value1, ALint* value2, ALint* value3);
// AL_API void AL_APIENTRY alGetBufferiv( ALuint bid, ALenum param, ALint* values );
#endregion Get Buffer parameters
#region Global Parameters
/// <summary>AL.DopplerFactor is a simple scaling of source and listener velocities to exaggerate or deemphasize the Doppler (pitch) shift resulting from the calculation.</summary>
/// <param name="value">A negative value will result in an error, the command is then ignored. The default value is 1f. The current setting can be queried using AL.Get with parameter ALGetFloat.SpeedOfSound.</param>
[DllImport(AL.Lib, EntryPoint = "alDopplerFactor", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void DopplerFactor(float value);
// AL_API void AL_APIENTRY alDopplerFactor( ALfloat value );
/// <summary>This function is deprecated and should not be used.</summary>
/// <param name="value">The default is 1.0f.</param>
[DllImport(AL.Lib, EntryPoint = "alDopplerVelocity", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void DopplerVelocity(float value);
// AL_API void AL_APIENTRY alDopplerVelocity( ALfloat value );
/// <summary>AL.SpeedOfSound allows the application to change the reference (propagation) speed used in the Doppler calculation. The source and listener velocities should be expressed in the same units as the speed of sound.</summary>
/// <param name="value">A negative or zero value will result in an error, and the command is ignored. Default: 343.3f (appropriate for velocity units of meters and air as the propagation medium). The current setting can be queried using AL.Get with parameter ALGetFloat.SpeedOfSound.</param>
[DllImport(AL.Lib, EntryPoint = "alSpeedOfSound", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void SpeedOfSound(float value);
// AL_API void AL_APIENTRY alSpeedOfSound( ALfloat value );
/// <summary>This function selects the OpenAL distance model – ALDistanceModel.InverseDistance, ALDistanceModel.InverseDistanceClamped, ALDistanceModel.LinearDistance, ALDistanceModel.LinearDistanceClamped, ALDistanceModel.ExponentDistance, ALDistanceModel.ExponentDistanceClamped, or ALDistanceModel.None. The default distance model in OpenAL is ALDistanceModel.InverseDistanceClamped.</summary>
/// <remarks>
/// The ALDistanceModel .InverseDistance model works according to the following formula:
/// gain = ALSourcef.ReferenceDistance / (ALSourcef.ReferenceDistance + ALSourcef.RolloffFactor * (distance – ALSourcef.ReferenceDistance));
///
/// The ALDistanceModel .InverseDistanceClamped model works according to the following formula:
/// distance = max(distance,ALSourcef.ReferenceDistance);
/// distance = min(distance,ALSourcef.MaxDistance);
/// gain = ALSourcef.ReferenceDistance / (ALSourcef.ReferenceDistance + ALSourcef.RolloffFactor * (distance – ALSourcef.ReferenceDistance));
///
/// The ALDistanceModel.LinearDistance model works according to the following formula:
/// distance = min(distance, ALSourcef.MaxDistance) // avoid negative gain
/// gain = (1 – ALSourcef.RolloffFactor * (distance – ALSourcef.ReferenceDistance) / (ALSourcef.MaxDistance – ALSourcef.ReferenceDistance))
///
/// The ALDistanceModel.LinearDistanceClamped model works according to the following formula:
/// distance = max(distance, ALSourcef.ReferenceDistance)
/// distance = min(distance, ALSourcef.MaxDistance)
/// gain = (1 – ALSourcef.RolloffFactor * (distance – ALSourcef.ReferenceDistance) / (ALSourcef.MaxDistance – ALSourcef.ReferenceDistance))
///
/// The ALDistanceModel.ExponentDistance model works according to the following formula:
/// gain = (distance / ALSourcef.ReferenceDistance) ^ (- ALSourcef.RolloffFactor)
///
/// The ALDistanceModel.ExponentDistanceClamped model works according to the following formula:
/// distance = max(distance, ALSourcef.ReferenceDistance)
/// distance = min(distance, ALSourcef.MaxDistance)
/// gain = (distance / ALSourcef.ReferenceDistance) ^ (- ALSourcef.RolloffFactor)
///
/// The ALDistanceModel.None model works according to the following formula:
/// gain = 1f;
/// </remarks>
/// <param name="distancemodel"></param>
[DllImport(AL.Lib, EntryPoint = "alDistanceModel", ExactSpelling = true, CallingConvention = AL.Style), SuppressUnmanagedCodeSecurity()]
public static extern void DistanceModel(ALDistanceModel distancemodel);
// AL_API void AL_APIENTRY alDistanceModel( ALenum distanceModel );
#endregion Global Parameters
#region Helpers
/// <summary>(Helper) Returns Source state information.</summary>
/// <param name="sid">The source to be queried.</param>
/// <returns>state information from OpenAL.</returns>
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
[CLSCompliant(false)]
public static ALSourceState GetSourceState(uint sid)
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
{
int temp;
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
AL.GetSource(sid, ALGetSourcei.SourceState, out temp);
return (ALSourceState)temp;
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
}
/// <summary>(Helper) Returns Source state information.</summary>
/// <param name="sid">The source to be queried.</param>
/// <returns>state information from OpenAL.</returns>
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
public static ALSourceState GetSourceState(int sid)
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
{
int temp;
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
AL.GetSource(sid, ALGetSourcei.SourceState, out temp);
return (ALSourceState)temp;
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
}
/// <summary>(Helper) Returns Source type information.</summary>
/// <param name="sid">The source to be queried.</param>
/// <returns>type information from OpenAL.</returns>
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
[CLSCompliant(false)]
public static ALSourceType GetSourceType(uint sid)
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
{
int temp;
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
AL.GetSource(sid, ALGetSourcei.SourceType, out temp);
return (ALSourceType)temp;
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
}
/// <summary>(Helper) Returns Source type information.</summary>
/// <param name="sid">The source to be queried.</param>
/// <returns>type information from OpenAL.</returns>
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
public static ALSourceType GetSourceType(int sid)
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
{
int temp;
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
AL.GetSource(sid, ALGetSourcei.SourceType, out temp);
return (ALSourceType)temp;
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
}
Fixed XML documentation warnings. Removed unnecessary [CLSCompliant(true)] attributes.
2009-09-04 23:12:10 +00:00
/// <summary>
/// Returns the <see cref="ALDistanceModel"/> of the current context.
/// </summary>
/// <returns>The <see cref="ALDistanceModel"/> of the current context.</returns>
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
public static ALDistanceModel GetDistanceModel()
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
{
* Audio/*: Cleaned up whitespace. * AudioContext.cs: Get device name specifier once a device is opened.
2009-03-25 18:41:50 +00:00
return (ALDistanceModel)AL.Get(ALGetInteger.DistanceModel);
Normalize line endings and set the mime-type=text/plain and eol-style=native properties on all files.
2009-02-22 10:43:35 +00:00
}
#endregion Helpers
}
}
Reference in a new issue Copy permalink