note description: "Wrapper for the MPG123 internal library" author: "Louis Marchand" date: "Tue, 21 Feb 2017 01:08:21 +0000" revision: "0.2" class interface MPG_EXTERNAL create default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) feature -- Access generating_type: TYPE [detachable MPG_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: MPG_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: MPG_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: MPG_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: MPG_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: MPG_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: MPG_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: MPG_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: MPG_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: MPG_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 MPG_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 -- Constants frozen mpg123_enc_signed_16: INTEGER_32 frozen mpg123_enc_ulaw_8: INTEGER_32 frozen mpg123_err: INTEGER_32 frozen mpg123_id3_constant: INTEGER_32 frozen mpg123_ok: INTEGER_32 frozen seek_set: INTEGER_32 frozen sizeof_mpg123_id3v1_album: INTEGER_32 frozen sizeof_mpg123_id3v1_artist: INTEGER_32 frozen sizeof_mpg123_id3v1_comment: INTEGER_32 frozen sizeof_mpg123_id3v1_title: INTEGER_32 frozen sizeof_mpg123_id3v1_year: INTEGER_32 feature -- Externals frozen mpg123_close (mh: POINTER): INTEGER_32 -- Closes the source mh, if libmpg123 opened it. frozen mpg123_delete (mh: POINTER) -- Delete handle mh. mh is either a valid mpg123 handle or NULL. frozen mpg123_exit -- Function to close down the mpg123 library. -- This function is not thread-safe. Call it exactly once per process. frozen mpg123_format (mh: POINTER; rate, channels, encoding: INTEGER_32): INTEGER_32 -- Set the audio format support (rate, channels and encoding) of a mpg123_handle mh frozen mpg123_format_none (mh: POINTER): INTEGER_32 -- Configure a mpg123 handle mh to accept no output format at all. -- Use before specifying supported formats with mpg123_format frozen mpg123_getformat (mh, rate, channels, encoding: POINTER): INTEGER_32 -- Get the current output format written to the addresses given. frozen mpg123_id3 (mh, v1, v2: POINTER): INTEGER_32 -- Point v1 and v2 to existing data structures wich may change -- on any next read/decode function call. v1 and/or v2 can be -- set to NULL when there is no corresponding data. frozen mpg123_init: INTEGER_32 -- Function to initialise the mpg123 library. -- This function is not thread-safe. Call it exactly once per process, before any other (possibly threaded) work with the library. frozen mpg123_length (mh: POINTER): INTEGER_32 -- Return, if possible, the full (expected) length of current track in samples. frozen mpg123_meta_check (mh: POINTER): INTEGER_32 -- Query if there is (new) meta info, be it ID3 or ICY (or something new in future). frozen mpg123_new (decoder, error: POINTER): POINTER -- Create a handle with optional choice of decoder and optional retrieval of an error code. -- Any of or both the parameters may be NULL. frozen mpg123_open (mh, path: POINTER): INTEGER_32 -- Open in the handler mh and prepare to decode the specified file by filesystem path. frozen mpg123_plain_strerror (errcode: INTEGER_32): POINTER -- Look up error strings given errcode. frozen mpg123_read (mh, outmemory: POINTER; outmemsize: INTEGER_32; done: POINTER): INTEGER_32 -- Read from stream and decode up to outmemsize bytes. frozen mpg123_scan (mh: POINTER): INTEGER_32 -- Make a full parsing scan of each frame in the file. frozen mpg123_seek (mh: POINTER; sampleoff, whence: INTEGER_32): INTEGER_32 -- Seek to a desired sample offset. Usage is modelled afer the standard lseek(). frozen mpg123_tell (mh: POINTER): INTEGER_32 -- Returns the current position in samples. On the next successful read, you'd get that sample. 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 feature -- Structures frozen get_mpg123_id3v1_struct_album (a_mpg123_id3v1: POINTER): POINTER -- Album string of the ID3 V1 metadata frozen get_mpg123_id3v1_struct_artist (a_mpg123_id3v1: POINTER): POINTER -- Artist string of the ID3 V1 metadata frozen get_mpg123_id3v1_struct_comment (a_mpg123_id3v1: POINTER): POINTER -- Comment string of the ID3 V1 metadata frozen get_mpg123_id3v1_struct_genre (a_mpg123_id3v1: POINTER): NATURAL_8 -- Genre index of the ID3 V1 metadata frozen get_mpg123_id3v1_struct_title (a_mpg123_id3v1: POINTER): POINTER -- Title string of the ID3 V1 metadata frozen get_mpg123_id3v1_struct_year (a_mpg123_id3v1: POINTER): POINTER -- Year string of the ID3 V1 metadata frozen get_mpg123_id3v2_struct_album (a_mpg123_id3v1: POINTER): POINTER -- Album string of the ID3 V2 metadata frozen get_mpg123_id3v2_struct_artist (a_mpg123_id3v1: POINTER): POINTER -- Artist string of the ID3 V2 metadata frozen get_mpg123_id3v2_struct_comment (a_mpg123_id3v1: POINTER): POINTER -- Comment string of the ID3 V2 metadata frozen get_mpg123_id3v2_struct_genre (a_mpg123_id3v1: POINTER): POINTER -- Genre string of the ID3 V2 metadata frozen get_mpg123_id3v2_struct_title (a_mpg123_id3v1: POINTER): POINTER -- Title string of the ID3 V2 metadata frozen get_mpg123_id3v2_struct_year (a_mpg123_id3v1: POINTER): POINTER -- Year string of the ID3 V2 metadata frozen get_mpg123_string_struct_fill (a_mpg123_string: POINTER): INTEGER_32 -- Get the data size from a mpg123_string frozen get_mpg123_string_struct_p (a_mpg123_string: POINTER): POINTER -- Get the data pointer from a mpg123_string invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) end -- class MPG_EXTERNAL
Generated by ISE EiffelStudio