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

class interface
	AUDIO_EXTERNAL

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

feature -- Access

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

	generator: STRING_8
			-- Name of current object's generating class
			-- (base class of the type of which it is a direct instance)
			-- (from ANY)
		ensure -- from ANY
			generator_not_void: Result /= Void
			generator_not_empty: not Result.is_empty
	
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)
		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)

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

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

	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
		ensure -- from ANY
			symmetric: Result implies other ~ Current
			consistent: standard_is_equal (other) implies Result

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

	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
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
	
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

	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
		ensure -- from ANY
			definition: Result = (conforms_to (other) and other.conforms_to (Current))
	
feature -- Duplication

	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)
		ensure -- from ANY
			is_equal: Current ~ other

	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
		ensure -- from ANY
			deep_equal: deep_equal (Current, other)

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

	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)
		ensure -- from ANY
			is_standard_equal: standard_is_equal (other)

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

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

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

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

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

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

	frozen al_buffers_processed: INTEGER_32

	frozen al_buffers_queued: INTEGER_32

	frozen al_direction: INTEGER_32

	frozen al_format_mono16: INTEGER_32

	frozen al_format_mono8: INTEGER_32

	frozen al_format_stereo16: INTEGER_32

	frozen al_format_stereo8: INTEGER_32

	frozen al_gain: INTEGER_32

	frozen al_initial: INTEGER_32

	frozen al_invalid_enum: INTEGER_32

	frozen al_invalid_name: INTEGER_32

	frozen al_invalid_operation: INTEGER_32

	frozen al_invalid_value: INTEGER_32

	frozen al_no_error: INTEGER_32

	frozen al_orientation: INTEGER_32

	frozen al_out_of_memory: INTEGER_32

	frozen al_paused: INTEGER_32

	frozen al_playing: INTEGER_32

	frozen al_position: INTEGER_32

	frozen al_source_state: INTEGER_32

	frozen al_stopped: INTEGER_32

	frozen al_velocity: INTEGER_32

	frozen alc_all_device_specifier: INTEGER_32

	frozen alc_capture_device_specifier: INTEGER_32

	frozen alc_device_specifier: INTEGER_32

	frozen alc_invalid_context: INTEGER_32

	frozen alc_invalid_device: INTEGER_32

	frozen alc_invalid_enum: INTEGER_32

	frozen alc_invalid_value: INTEGER_32

	frozen alc_no_error: INTEGER_32

	frozen alc_out_of_memory: INTEGER_32
	
feature -- OpenAL Functions

	frozen al_buffer_data (buffer_id: NATURAL_32; format: INTEGER_32; buffers: POINTER; size, freq: INTEGER_32)

	frozen al_delete_buffers (nb: INTEGER_32; buffers: POINTER)

	frozen al_delete_sources (nb: INTEGER_32; sources: POINTER)

	frozen al_gen_buffers (nb: INTEGER_32; buffers: POINTER)

	frozen al_gen_sources (nb: INTEGER_32; sources: POINTER)

	frozen al_get_error: INTEGER_32

	frozen al_get_listener_fv (param: INTEGER_32; les_params: POINTER)

	frozen al_get_source_f (source_id: NATURAL_32; param: INTEGER_32; les_params: POINTER)

	frozen al_get_source_fv (source_id: NATURAL_32; param: INTEGER_32; les_params: POINTER)

	frozen al_get_source_i (source_id: NATURAL_32; param: INTEGER_32; les_params: POINTER)

	frozen al_is_buffer (buffer: NATURAL_32): BOOLEAN

	frozen al_is_source (source_id: NATURAL_32): BOOLEAN

	frozen al_set_listener_fv (param: INTEGER_32; les_params: POINTER)

	frozen al_set_source_f (source_id: NATURAL_32; param: INTEGER_32; les_params: REAL_32)

	frozen al_set_source_fv (source_id: NATURAL_32; param: INTEGER_32; les_params: POINTER)

	frozen al_source_pause (source: NATURAL_32)

	frozen al_source_play (source: NATURAL_32)

	frozen al_source_queue_buffers (source: NATURAL_32; nb: INTEGER_32; buffers: POINTER)

	frozen al_source_rewind (source: NATURAL_32)

	frozen al_source_stop (source: NATURAL_32)

	frozen al_source_unqueue_buffers (source: NATURAL_32; nb: INTEGER_32; buffers: POINTER)

	frozen alc_capture_close_device (a_device: POINTER): BOOLEAN

	frozen alc_capture_open_device (a_devicename: POINTER; a_frequency: NATURAL_32; a_format, a_buffersize: INTEGER_32): POINTER

	frozen alc_capture_samples (a_device, a_buffer: POINTER; a_samples: INTEGER_32)

	frozen alc_capture_start (a_device: POINTER)

	frozen alc_capture_stop (a_device: POINTER)

	frozen alc_close_device (device: POINTER): BOOLEAN

	frozen alc_create_context (device: POINTER; flags: POINTER): POINTER

	frozen alc_destroy_context (context: POINTER)

	frozen alc_get_current_context: POINTER

	frozen alc_get_error (device: POINTER): INTEGER_32

	frozen alc_get_string (devicehandle: POINTER; token: INTEGER_32): POINTER

	frozen alc_is_extension_present (a_device, a_extname: POINTER): BOOLEAN

	frozen alc_make_context_current (context: POINTER): BOOLEAN

	frozen alc_open_device (device_name: POINTER): POINTER

	frozen alc_suspend_context (context: POINTER)
	
feature -- Output

	Io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			io_not_void: Result /= Void

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

	print (o: detachable ANY)
			-- Write terse external representation of o
			-- on standard output.
			-- (from ANY)
		ensure -- from ANY
			instance_free: class

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

	Operating_environment: OPERATING_ENVIRONMENT
			-- Objects available from the operating system
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			operating_environment_not_void: Result /= Void
	
invariant
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

end -- class AUDIO_EXTERNAL

Generated by ISE EiffelStudio