note
	description: "An AUDIO_SOUND that has been loaded from an MPG file"
	author: "Louis Marchand"
	date: "Wed, 22 Feb 2017 03:42:57 +0000"
	revision: "0.3"

class interface
	MPG_SOUND_FILE

create 
	make

feature --Access

	scan
			-- Full parsing scan of each frame in the file.
			-- Find Metadatas and optimize seek
		require
			open: is_open
			seakable: is_seekable

	is_scanned: BOOLEAN
			-- Is scan has been used on Current

	title: detachable READABLE_STRING_GENERAL
			-- The readable identifier of Current
			-- Void if no 'title' available in Current
		require else
			is_scanned: is_scanned

	titles: LIST [READABLE_STRING_GENERAL]
			-- Every readable identifier of Current

	artist: detachable READABLE_STRING_GENERAL
			-- The name of the creator of Current
			-- Void if no 'artist' available in Current
		require else
			is_scanned: is_scanned

	artists: LIST [READABLE_STRING_GENERAL]
			-- The name of every creators of Current

	album: detachable READABLE_STRING_GENERAL
			-- The media that Current is from
			-- Void if no 'album' available in Current
		require else
			is_scanned: is_scanned

	albums: LIST [READABLE_STRING_GENERAL]
			-- The names of the medias that Current is from

	year: detachable READABLE_STRING_GENERAL
			-- The creation's date of Current
			-- Void if no 'date' available in Current
		require else
			is_scanned: is_scanned

	years: LIST [READABLE_STRING_GENERAL]
			-- The creation's years of Current

	genre: detachable READABLE_STRING_GENERAL
			-- The conventional category of Current
			-- Void if no 'genre' available in Current
		require else
			is_scanned: is_scanned

	genres: LIST [READABLE_STRING_GENERAL]
			-- Every conventional categories of Current

	comment: detachable READABLE_STRING_GENERAL
			-- Anything that can be add to the definition of Current
			-- Void if no 'comment' available in Current
		require else
			is_scanned: is_scanned

	comments: LIST [READABLE_STRING_GENERAL]
			-- Everything that can be add to the definition of Current

	track_number: INTEGER_32
			-- The number of Current in the album
			-- 0 if no 'track_number' available in Current

	is_openable: BOOLEAN
			-- Can Current be open

	open
			-- Open Current

	close
			-- Stop the management of the stream

	channel_count: INTEGER_32
			-- Get the channel number of Current (1=mono, 2=stereo, etc.).

	frequency: INTEGER_32
			-- Get the frequency (sample rate) of Current.

	bits_per_sample: INTEGER_32
			-- Get the bit resolution of one frame of Current.

	is_signed: BOOLEAN
			-- True if the frames in the buffer are signed.

	is_seekable: BOOLEAN
			-- Return true if Current support the seek functionnality.

	restart
			-- Restart Current to the beginning.

	sample_seek (a_frame_number: INTEGER_64)
			-- Seek at the frame a_frame_number from the beginning of Current

	sample_position: INTEGER_64
			-- The number of frames since the beginning of Current

	sample_count: INTEGER_64
			-- The total number of frames in Current
	
feature -- Implementation

	dispose
			-- Action to be executed just before garbage collection
			-- reclaims an object.
			-- Effect it in descendants to perform specific dispose
			-- actions. Those actions should only take care of freeing
			-- external resources; they should not perform remote calls
			-- on other objects since these may also be dead and reclaimed.
	
end -- class MPG_SOUND_FILE

Generated by ISE EiffelStudio