note
	description: "External C feature for Audio snd files libraries."
	author: "Louis Marchand"
	date: "May 24, 2012"
	revision: "0.1"

class 
	AUDIO_SND_FILES_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_SND_FILES_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_SND_FILES_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_SND_FILES_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_SND_FILES_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_SND_FILES_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_SND_FILES_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_SND_FILES_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_SND_FILES_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_SND_FILES_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_SND_FILES_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_SND_FILES_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_SND_FILES_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 -- 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
	
feature -- libsndfile Constants

	frozen seek_cur: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"SEEK_CUR"
		end

	frozen seek_end: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"SEEK_END"
		end

	frozen seek_set: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"SEEK_SET"
		end

	frozen sf_str_album: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"SF_STR_ALBUM"
		end

	frozen sf_str_artist: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"SF_STR_ARTIST"
		end

	frozen sf_str_comment: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"SF_STR_COMMENT"
		end

	frozen sf_str_date: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"SF_STR_DATE"
		end

	frozen sf_str_genre: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"SF_STR_GENRE"
		end

	frozen sf_str_title: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"SF_STR_TITLE"
		end

	frozen sf_str_tracknumber: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"SF_STR_TRACKNUMBER"
		end

	frozen sfc_get_log_info: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"SFC_GET_LOG_INFO"
		end

	frozen sfm_rdwr: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"SFM_RDWR"
		end

	frozen sfm_read: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"SFM_READ"
		end

	frozen sfm_write: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"SFM_WRITE"
		end
	
feature -- libsndfile SF_INFO structure

	frozen c_sizeof_sf_info: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <stdint.h>"
		alias
			"sizeof(SF_INFO)"
		end

	frozen get_sf_info_struct_channels (sf_info: POINTER): INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C [struct <sndfile.h>] (SF_INFO):int"
		alias
			"channels"
		end

	frozen get_sf_info_struct_format (sf_info: POINTER): INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C [struct <sndfile.h>] (SF_INFO):int"
		alias
			"format"
		end

	frozen get_sf_info_struct_frames (sf_info: POINTER): INTEGER_64
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C [struct <sndfile.h>] (SF_INFO):sf_count_t"
		alias
			"frames"
		end

	frozen get_sf_info_struct_samplerate (sf_info: POINTER): INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C [struct <sndfile.h>] (SF_INFO):int"
		alias
			"samplerate"
		end

	frozen get_sf_info_struct_seekable (sf_info: POINTER): INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C [struct <sndfile.h>] (SF_INFO):int"
		alias
			"seekable"
		end
	
feature -- libsndfile fonctions

	frozen c_sizeof_sf_count_t: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <stdint.h>"
		alias
			"sizeof(sf_count_t)"
		end

	frozen c_sizeof_snd_file_virtual_io: INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C inline use <sndfile.h>"
		alias
			"sizeof(SF_VIRTUAL_IO)"
		end

	frozen sf_close (sndfile: POINTER): INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C (SNDFILE *) : int | <sndfile.h>"
		alias
			"sf_close"
		end

	frozen sf_command (sndfile: POINTER; cmd: INTEGER_32; data: POINTER; datasize: INTEGER_32): INTEGER_32
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C (SNDFILE *, int, void *, int) : int | <sndfile.h>"
		alias
			"sf_command"
		end

	frozen sf_get_string (sndfile: POINTER; str_type: INTEGER_32): POINTER
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C (SNDFILE *, int) : const char* | <sndfile.h>"
		alias
			"sf_get_string"
		end

	frozen sf_open (path: POINTER; mode: INTEGER_32; sf_info: POINTER): POINTER
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C (const char *, int , SF_INFO *) : SNDFILE* | <sndfile.h>"
		alias
			"sf_open"
		end

	frozen sf_open_virtual (sf_virtual_io: POINTER; mode: INTEGER_32; sf_info: POINTER; user_data: POINTER): POINTER
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C (SF_VIRTUAL_IO *, int , SF_INFO *, void *) : SNDFILE* | <sndfile.h>"
		alias
			"sf_open_virtual"
		end

	frozen sf_read_short (sndfile, ptr: POINTER; items: INTEGER_64): INTEGER_64
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C (SNDFILE *, short *, sf_count_t) : sf_count_t | <sndfile.h>"
		alias
			"sf_read_short"
		end

	frozen sf_seek (sndfile: POINTER; frames: INTEGER_64; whence: INTEGER_32): INTEGER_64
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C (SNDFILE *, sf_count_t, int) : sf_count_t | <sndfile.h>"
		alias
			"sf_seek"
		end

	frozen sf_strerror (sndfile: POINTER): POINTER
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C (SNDFILE *) : const char* | <sndfile.h>"
		alias
			"sf_strerror"
		end
	
feature -- sndfile_addition functions

	frozen set_snd_file_virtual_io (virtual_io: POINTER)
			-- (from AUDIO_SND_FILES_EXTERNAL_IMP)
		external
			"C (SF_VIRTUAL_IO *) | <sndfile_additions.h>"
		alias
			"setSndFileVirtualIo"
		end
	
invariant
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

end -- class AUDIO_SND_FILES_EXTERNAL

Generated by ISE EiffelStudio