class ID3_HEADER

(source code)

Client examples: ID3_TAG_INFO_TEST_SET

Description

ID3 header

note
	description: "ID3 header"

	author: "Finnian Reilly"
	copyright: "Copyright (c) 2001-2022 Finnian Reilly"
	contact: "finnian at eiffel hyphen loop dot com"

	license: "MIT license (See: en.wikipedia.org/wiki/MIT_License)"
	date: "2022-11-15 19:56:05 GMT (Tuesday 15th November 2022)"
	revision: "9"

class
	ID3_HEADER

create
	make, make_from_file

feature {NONE} -- Initialization

	make (a_file_path: FILE_PATH)
		local
			l_file: RAW_FILE
		do
			create l_file.make_open_read (a_file_path)
			make_from_file (l_file)
			l_file.close
		end

	make_from_file (file: RAW_FILE)
		do
			create buffer.make (Header_size)
			file.go (0)
			read_from_file (file, "ID3")
			if not is_valid then
				-- look for footer at end
				file.recede (Header_size - 1)
				read_from_file (file, "3DI")
			end
		end

feature -- Access

	id: STRING

	major_version: NATURAL_8

	revision: NATURAL_8
		-- version revision number

	version: REAL
		do
			Result := ((20 + major_version) / 10).truncated_to_real
		end

	version_name: ZSTRING
		do
			Result := Version_template #$ [major_version, revision]
		end

feature -- Element change

	set_version (a_version: like version)
		require
			valid_version: a_version >= 2.0
		do
			major_version := ((a_version * 10).rounded \\ 20).to_natural_8
		end

feature -- Measurement

	size: INTEGER

	total_size: INTEGER
		do
			if is_valid then
				Result := size + Header_size
				if has_footer then
					Result := Result + Header_size
				end
			end
		end

feature -- Status query

	has_extended_header: BOOLEAN
		do
			Result := flags.bit_test (6)
		end

	has_footer: BOOLEAN
		do
			if major_version = 4 then
				Result := flags.bit_test (4)
			end
		end

	is_experimental: BOOLEAN
		do
			Result := flags.bit_test (5)
		end

	is_unsynchronized: BOOLEAN
		do
			Result := flags.bit_test (7)
		end

	is_valid: BOOLEAN

feature {NONE} -- Implementation

	read_from_file (file: RAW_FILE; marker_id: STRING)
		local
			pos, byte: INTEGER
		do
			file.read_to_managed_pointer (buffer, 0, Header_size)
			read_id

			major_version := buffer.read_natural_8 (3)
			revision := buffer.read_natural_8 (4)
			flags := buffer.read_natural_8 (5)

			if id ~ marker_id then
				is_valid := True
				from pos := 3 until pos < 0 loop
					byte := buffer.read_integer_8 (9 - pos).to_integer
					byte := byte |<< (pos * 7)
					size := size | byte
					pos := pos - 1
				end
			end
		end

feature {NONE} -- Implementation

	buffer: MANAGED_POINTER

	flags: NATURAL_8

	read_id
		do
			create id.make_filled ('%U', 3)
			id.area.base_address.memory_copy (buffer.item, 3)
		end

feature -- Constants

	Header_size: INTEGER = 10

feature {NONE} -- Constants

	Version_template: ZSTRING
		once
			Result := "ID3v2.%S.%S"
		end

end