note
	description: "External C feature for Audio libraries."
	author: "Louis Marchand"
	date: "Tue, 07 Apr 2015 01:15:20 +0000"
	revision: "2.0"

class 
	AUDIO_EXTERNAL

create 
	default_create

feature {NONE} -- Initialization

	default_create
			-- Process instances of classes with no creation clause.
			-- (Default: do nothing.)
			-- (from ANY)
		do
		end
	
feature -- Access

	generating_type: TYPE [detachable AUDIO_EXTERNAL]
			-- Type of current object
			-- (type of which it is a direct instance)
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			generating_type_not_void: Result /= Void
		end

	generator: STRING_8
			-- Name of current object's generating class
			-- (base class of the type of which it is a direct instance)
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			generator_not_void: Result /= Void
			generator_not_empty: not Result.is_empty
		end
	
feature -- Comparison

	frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void
			-- or attached to isomorphic object structures?
			-- (from ANY)
		do
			if a = Void then
				Result := b = Void
			else
				Result := b /= Void and then a.is_deep_equal (b)
			end
		ensure -- from ANY
			instance_free: class
			shallow_implies_deep: standard_equal (a, b) implies Result
			both_or_none_void: (a = Void) implies (Result = (b = Void))
			same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b))
			symmetric: Result implies deep_equal (b, a)
		end

	frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		do
			if a = Void then
				Result := b = Void
			else
				Result := b /= Void and then a.is_equal (b)
			end
		ensure -- from ANY
			instance_free: class
			definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b))
		end

	frozen is_deep_equal alias "≡≡≡" (other: AUDIO_EXTERNAL): BOOLEAN
			-- Are Current and other attached to isomorphic object structures?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		external
			"built_in"
		ensure -- from ANY
			shallow_implies_deep: standard_is_equal (other) implies Result
			same_type: Result implies same_type (other)
			symmetric: Result implies other.is_deep_equal (Current)
		end

	is_equal (other: AUDIO_EXTERNAL): BOOLEAN
			-- Is other attached to an object considered
			-- equal to current object?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		external
			"built_in"
		ensure -- from ANY
			symmetric: Result implies other ~ Current
			consistent: standard_is_equal (other) implies Result
		end

	frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void or attached to
			-- field-by-field identical objects of the same type?
			-- Always uses default object comparison criterion.
			-- (from ANY)
		do
			if a = Void then
				Result := b = Void
			else
				Result := b /= Void and then a.standard_is_equal (b)
			end
		ensure -- from ANY
			instance_free: class
			definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b))
		end

	frozen standard_is_equal alias "≜" (other: AUDIO_EXTERNAL): BOOLEAN
			-- Is other attached to an object of the same type
			-- as current object, and field-by-field identical to it?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		external
			"built_in"
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
		end
	
feature -- Status report

	conforms_to (other: ANY): BOOLEAN
			-- Does type of current object conform to type
			-- of other (as per Eiffel: The Language, chapter 13)?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		external
			"built_in"
		end

	same_type (other: ANY): BOOLEAN
			-- Is type of current object identical to type of other?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		external
			"built_in"
		ensure -- from ANY
			definition: Result = (conforms_to (other) and other.conforms_to (Current))
		end
	
feature -- Duplication

	frozen clone (other: detachable ANY): like other
		obsolete "Use `twin' instead. [2017-05-31]"
			-- Void if other is void; otherwise new object
			-- equal to other
			--
			-- For non-void other, clone calls copy;
			-- to change copying/cloning semantics, redefine copy.
			-- (from ANY)
		do
			if other /= Void then
				Result := other.twin
			end
		ensure -- from ANY
			instance_free: class
			equal: Result ~ other
		end

	copy (other: AUDIO_EXTERNAL)
			-- Update current object using fields of object attached
			-- to other, so as to yield equal objects.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		external
			"built_in"
		ensure -- from ANY
			is_equal: Current ~ other
		end

	frozen deep_clone (other: detachable ANY): like other
		obsolete "Use `deep_twin' instead. [2017-05-31]"
			-- Void if other is void: otherwise, new object structure
			-- recursively duplicated from the one attached to other
			-- (from ANY)
		do
			if other /= Void then
				Result := other.deep_twin
			end
		ensure -- from ANY
			instance_free: class
			deep_equal: deep_equal (other, Result)
		end

	frozen deep_copy (other: AUDIO_EXTERNAL)
			-- Effect equivalent to that of:
			--		copy (other . deep_twin)
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		do
			copy (other.deep_twin)
		ensure -- from ANY
			deep_equal: deep_equal (Current, other)
		end

	frozen deep_twin: AUDIO_EXTERNAL
			-- New object structure recursively duplicated from Current.
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			deep_twin_not_void: Result /= Void
			deep_equal: deep_equal (Current, Result)
		end

	frozen standard_clone (other: detachable ANY): like other
		obsolete "Use `standard_twin' instead. [2017-05-31]"
			-- Void if other is void; otherwise new object
			-- field-by-field identical to other.
			-- Always uses default copying semantics.
			-- (from ANY)
		do
			if other /= Void then
				Result := other.standard_twin
			end
		ensure -- from ANY
			instance_free: class
			equal: standard_equal (Result, other)
		end

	frozen standard_copy (other: AUDIO_EXTERNAL)
			-- Copy every field of other onto corresponding field
			-- of current object.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		external
			"built_in"
		ensure -- from ANY
			is_standard_equal: standard_is_equal (other)
		end

	frozen standard_twin: AUDIO_EXTERNAL
			-- New object field-by-field identical to other.
			-- Always uses default copying semantics.
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			standard_twin_not_void: Result /= Void
			equal: standard_equal (Result, Current)
		end

	frozen twin: AUDIO_EXTERNAL
			-- New object equal to Current
			-- twin calls copy; to change copying/twinning semantics, redefine copy.
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			twin_not_void: Result /= Void
			is_equal: Result ~ Current
		end
	
feature -- Basic operations

	frozen as_attached: attached AUDIO_EXTERNAL
		obsolete "Remove calls to this feature. [2017-05-31]"
			-- Attached version of Current.
			-- (Can be used during transitional period to convert
			-- non-void-safe classes to void-safe ones.)
			-- (from ANY)
		do
			Result := Current
		end

	frozen default: detachable AUDIO_EXTERNAL
			-- Default value of object's type
			-- (from ANY)
		do
		end

	frozen default_pointer: POINTER
			-- Default value of type POINTER
			-- (Avoid the need to write p.default for
			-- some p of type POINTER.)
			-- (from ANY)
		do
		ensure -- from ANY
			instance_free: class
		end

	default_rescue
			-- Process exception for routines with no Rescue clause.
			-- (Default: do nothing.)
			-- (from ANY)
		do
		end

	frozen do_nothing
			-- Execute a null action.
			-- (from ANY)
		do
		ensure -- from ANY
			instance_free: class
		end
	
feature -- OpenAL Constants

	frozen al_buffers_processed: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_BUFFERS_PROCESSED"
		end

	frozen al_buffers_queued: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_BUFFERS_QUEUED"
		end

	frozen al_direction: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_DIRECTION"
		end

	frozen al_format_mono16: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_FORMAT_MONO16"
		end

	frozen al_format_mono8: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_FORMAT_MONO8"
		end

	frozen al_format_stereo16: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_FORMAT_STEREO16"
		end

	frozen al_format_stereo8: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_FORMAT_STEREO8"
		end

	frozen al_gain: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_GAIN"
		end

	frozen al_initial: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_INITIAL"
		end

	frozen al_invalid_enum: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_INVALID_ENUM"
		end

	frozen al_invalid_name: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_INVALID_NAME"
		end

	frozen al_invalid_operation: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_INVALID_OPERATION"
		end

	frozen al_invalid_value: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_INVALID_VALUE"
		end

	frozen al_no_error: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_NO_ERROR"
		end

	frozen al_orientation: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_ORIENTATION"
		end

	frozen al_out_of_memory: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_OUT_OF_MEMORY"
		end

	frozen al_paused: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_PAUSED"
		end

	frozen al_playing: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_PLAYING"
		end

	frozen al_position: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_POSITION"
		end

	frozen al_source_state: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_SOURCE_STATE"
		end

	frozen al_stopped: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_STOPPED"
		end

	frozen al_velocity: INTEGER_32
		external
			"C inline use <al.h>"
		alias
			"AL_VELOCITY"
		end

	frozen alc_all_device_specifier: INTEGER_32
		external
			"C inline use <alc.h>"
		alias
			"ALC_ALL_DEVICES_SPECIFIER"
		end

	frozen alc_capture_device_specifier: INTEGER_32
		external
			"C inline use <alc.h>"
		alias
			"ALC_CAPTURE_DEVICE_SPECIFIER"
		end

	frozen alc_device_specifier: INTEGER_32
		external
			"C inline use <alc.h>"
		alias
			"ALC_DEVICE_SPECIFIER"
		end

	frozen alc_invalid_context: INTEGER_32
		external
			"C inline use <alc.h>"
		alias
			"ALC_INVALID_CONTEXT"
		end

	frozen alc_invalid_device: INTEGER_32
		external
			"C inline use <alc.h>"
		alias
			"ALC_INVALID_DEVICE"
		end

	frozen alc_invalid_enum: INTEGER_32
		external
			"C inline use <alc.h>"
		alias
			"ALC_INVALID_ENUM"
		end

	frozen alc_invalid_value: INTEGER_32
		external
			"C inline use <alc.h>"
		alias
			"ALC_INVALID_VALUE"
		end

	frozen alc_no_error: INTEGER_32
		external
			"C inline use <alc.h>"
		alias
			"ALC_NO_ERROR"
		end

	frozen alc_out_of_memory: INTEGER_32
		external
			"C inline use <alc.h>"
		alias
			"ALC_OUT_OF_MEMORY"
		end
	
feature -- OpenAL Functions

	frozen al_buffer_data (buffer_id: NATURAL_32; format: INTEGER_32; buffers: POINTER; size, freq: INTEGER_32)
		external
			"C (ALuint, ALenum, ALvoid *, ALsizei, ALsizei) | <al.h>"
		alias
			"alBufferData"
		end

	frozen al_delete_buffers (nb: INTEGER_32; buffers: POINTER)
		external
			"C (ALsizei, ALuint *) | <al.h>"
		alias
			"alDeleteBuffers"
		end

	frozen al_delete_sources (nb: INTEGER_32; sources: POINTER)
		external
			"C (ALsizei, ALuint *) | <al.h>"
		alias
			"alDeleteSources"
		end

	frozen al_gen_buffers (nb: INTEGER_32; buffers: POINTER)
		external
			"C (ALsizei, ALuint *) | <al.h>"
		alias
			"alGenBuffers"
		end

	frozen al_gen_sources (nb: INTEGER_32; sources: POINTER)
		external
			"C (ALsizei, ALuint *) | <al.h>"
		alias
			"alGenSources"
		end

	frozen al_get_error: INTEGER_32
		external
			"C : ALenum | <al.h>"
		alias
			"alGetError"
		end

	frozen al_get_listener_fv (param: INTEGER_32; les_params: POINTER)
		external
			"C (ALenum, ALfloat *) | <al.h>"
		alias
			"alGetListenerfv"
		end

	frozen al_get_source_f (source_id: NATURAL_32; param: INTEGER_32; les_params: POINTER)
		external
			"C (ALuint, ALenum, ALfloat *) | <al.h>"
		alias
			"alGetSourcef"
		end

	frozen al_get_source_fv (source_id: NATURAL_32; param: INTEGER_32; les_params: POINTER)
		external
			"C (ALuint, ALenum, ALfloat *) | <al.h>"
		alias
			"alGetSourcefv"
		end

	frozen al_get_source_i (source_id: NATURAL_32; param: INTEGER_32; les_params: POINTER)
		external
			"C (ALuint, ALenum, ALint *) | <al.h>"
		alias
			"alGetSourcei"
		end

	frozen al_is_buffer (buffer: NATURAL_32): BOOLEAN
		external
			"C (ALuint) : ALboolean | <al.h>"
		alias
			"alIsBuffer"
		end

	frozen al_is_source (source_id: NATURAL_32): BOOLEAN
		external
			"C (ALuint) : ALboolean | <al.h>"
		alias
			"alIsSource"
		end

	frozen al_set_listener_fv (param: INTEGER_32; les_params: POINTER)
		external
			"C (ALenum, ALfloat *) | <al.h>"
		alias
			"alListenerfv"
		end

	frozen al_set_source_f (source_id: NATURAL_32; param: INTEGER_32; les_params: REAL_32)
		external
			"C (ALuint, ALenum, ALfloat) | <al.h>"
		alias
			"alSourcef"
		end

	frozen al_set_source_fv (source_id: NATURAL_32; param: INTEGER_32; les_params: POINTER)
		external
			"C (ALuint, ALenum, ALfloat *) | <al.h>"
		alias
			"alSourcefv"
		end

	frozen al_source_pause (source: NATURAL_32)
		external
			"C (ALuint) | <al.h>"
		alias
			"alSourcePause"
		end

	frozen al_source_play (source: NATURAL_32)
		external
			"C (ALuint) | <al.h>"
		alias
			"alSourcePlay"
		end

	frozen al_source_queue_buffers (source: NATURAL_32; nb: INTEGER_32; buffers: POINTER)
		external
			"C (ALuint, ALsizei, ALuint *) | <al.h>"
		alias
			"alSourceQueueBuffers"
		end

	frozen al_source_rewind (source: NATURAL_32)
		external
			"C (ALuint) | <al.h>"
		alias
			"alSourceRewind"
		end

	frozen al_source_stop (source: NATURAL_32)
		external
			"C (ALuint) | <al.h>"
		alias
			"alSourceStop"
		end

	frozen al_source_unqueue_buffers (source: NATURAL_32; nb: INTEGER_32; buffers: POINTER)
		external
			"C (ALuint, ALsizei, ALuint *) | <al.h>"
		alias
			"alSourceUnqueueBuffers"
		end

	frozen alc_capture_close_device (a_device: POINTER): BOOLEAN
		external
			"C (ALCdevice *) : ALCboolean | <alc.h>"
		alias
			"alcCaptureCloseDevice"
		end

	frozen alc_capture_open_device (a_devicename: POINTER; a_frequency: NATURAL_32; a_format, a_buffersize: INTEGER_32): POINTER
		external
			"C (const ALCchar *, ALCuint, ALCenum, ALCsizei) : ALCdevice * | <alc.h>"
		alias
			"alcCaptureOpenDevice"
		end

	frozen alc_capture_samples (a_device, a_buffer: POINTER; a_samples: INTEGER_32)
		external
			"C (ALCdevice *, ALCvoid *, ALCsizei) | <alc.h>"
		alias
			"alcCaptureSamples"
		end

	frozen alc_capture_start (a_device: POINTER)
		external
			"C (ALCdevice *) | <alc.h>"
		alias
			"alcCaptureStart"
		end

	frozen alc_capture_stop (a_device: POINTER)
		external
			"C (ALCdevice *) | <alc.h>"
		alias
			"alcCaptureStop"
		end

	frozen alc_close_device (device: POINTER): BOOLEAN
		external
			"C (ALCdevice *) : ALCboolean | <alc.h>"
		alias
			"alcCloseDevice"
		end

	frozen alc_create_context (device: POINTER; flags: POINTER): POINTER
		external
			"C (ALCdevice *,ALCint *) : ALCcontext * | <alc.h>"
		alias
			"alcCreateContext"
		end

	frozen alc_destroy_context (context: POINTER)
		external
			"C (ALCcontext *) | <alc.h>"
		alias
			"alcDestroyContext"
		end

	frozen alc_get_current_context: POINTER
		external
			"C : ALCcontext * | <alc.h>"
		alias
			"alcGetCurrentContext"
		end

	frozen alc_get_error (device: POINTER): INTEGER_32
		external
			"C (ALCdevice *) : ALCenum | <alc.h>"
		alias
			"alcGetError"
		end

	frozen alc_get_string (devicehandle: POINTER; token: INTEGER_32): POINTER
		external
			"C (ALCdevice *, ALCenum) : const ALCchar * | <alc.h>"
		alias
			"alcGetString"
		end

	frozen alc_is_extension_present (a_device, a_extname: POINTER): BOOLEAN
		external
			"C (ALCdevice *, const ALCchar *) : ALCboolean | <alc.h>"
		alias
			"alcIsExtensionPresent"
		end

	frozen alc_make_context_current (context: POINTER): BOOLEAN
		external
			"C (ALCcontext *) : ALCboolean | <alc.h>"
		alias
			"alcMakeContextCurrent"
		end

	frozen alc_open_device (device_name: POINTER): POINTER
		external
			"C (const ALCchar *) : ALCdevice * | <alc.h>"
		alias
			"alcOpenDevice"
		end

	frozen alc_suspend_context (context: POINTER)
		external
			"C (ALCcontext *) | <alc.h>"
		alias
			"alcSuspendContext"
		end
	
feature -- Output

	Io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)
		once
			create Result;
			Result.set_output_default
		ensure -- from ANY
			instance_free: class
			io_not_void: Result /= Void
		end

	out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- (from ANY)
		do
			Result := tagged_out
		ensure -- from ANY
			out_not_void: Result /= Void
		end

	print (o: detachable ANY)
			-- Write terse external representation of o
			-- on standard output.
			-- (from ANY)
		local
			s: READABLE_STRING_8
		do
			if attached o then
				s := o.out
				if attached {READABLE_STRING_32} s as s32 then
					Io.put_string_32 (s32)
				elseif attached {READABLE_STRING_8} s as s8 then
					Io.put_string (s8)
				else
					Io.put_string_32 (s.as_string_32)
				end
			end
		ensure -- from ANY
			instance_free: class
		end

	frozen tagged_out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			tagged_out_not_void: Result /= Void
		end
	
feature -- Platform

	Operating_environment: OPERATING_ENVIRONMENT
			-- Objects available from the operating system
			-- (from ANY)
		once
			create Result
		ensure -- from ANY
			instance_free: class
			operating_environment_not_void: Result /= Void
		end
	
feature {NONE} -- Retrieval

	frozen internal_correct_mismatch
			-- Called from runtime to perform a proper dynamic dispatch on correct_mismatch
			-- from MISMATCH_CORRECTOR.
			-- (from ANY)
		local
			l_msg: STRING_32
			l_exc: EXCEPTIONS
		do
			if attached {MISMATCH_CORRECTOR} Current as l_corrector then
				l_corrector.correct_mismatch
			else
				create l_msg.make_from_string ("Mismatch: ".as_string_32)
				create l_exc;
				l_msg.append (generating_type.name_32);
				l_exc.raise_retrieval_exception (l_msg)
			end
		end
	
invariant
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

end -- class AUDIO_EXTERNAL

Generated by ISE EiffelStudio