GetId3\Module\Audio\Mod Class Reference

GetId3() by James Heinrich info@.nosp@m.geti.nosp@m.d3.or.nosp@m.g //. More...

Inheritance diagram for GetId3\Module\Audio\Mod:

Collaboration diagram for GetId3\Module\Audio\Mod:

Public Member Functions
	analyze ()
	getMODheaderFilepointer ()
	getXMheaderFilepointer ()
	getS3MheaderFilepointer ()
	getITheaderFilepointer ()
Public Member Functions inherited from GetId3\Handler\BaseHandler
	__construct (GetId3Core $getid3, $call_module=null)
	analyze ()
	Analyze from file pointer. More...
	AnalyzeString (&$string)
	Analyze from string instead. More...
	saveAttachment (&$ThisFileInfoIndex, $filename, $offset, $length)

Additional Inherited Members
Protected Member Functions inherited from GetId3\Handler\BaseHandler
	ftell ()
	fread ($bytes)
	fseek ($bytes, $whence=SEEK_SET)
	feof ()
	isDependencyFor ($module)
	error ($text)
	warning ($text)
Protected Attributes inherited from GetId3\Handler\BaseHandler
	$getid3
	$data_string_flag = false
	$data_string = ''
	$data_string_position = 0
	$data_string_length = 0

Detailed Description

GetId3() by James Heinrich info@.nosp@m.geti.nosp@m.d3.or.nosp@m.g //.

module for analyzing MOD Audio files

Author

James Heinrich info@.nosp@m.geti.nosp@m.d3.or.nosp@m.g http://www.getid3.org

Definition at line 28 of file Mod.php.

Member Function Documentation

analyze()

GetId3\Module\Audio\Mod::analyze

(

)

Returns

boolean

Definition at line 35 of file Mod.php.

References $info, GetId3\Handler\BaseHandler\fread(), GetId3\Handler\BaseHandler\fseek(), GetId3\Module\Audio\Mod\getITheaderFilepointer(), GetId3\Module\Audio\Mod\getMODheaderFilepointer(), GetId3\Module\Audio\Mod\getS3MheaderFilepointer(), and GetId3\Module\Audio\Mod\getXMheaderFilepointer().

    {
        $info = &$this->getid3->info;
        fseek($this->getid3->fp, $info['avdataoffset'], SEEK_SET);
        $fileheader = fread($this->getid3->fp, 1088);
        if (preg_match('#^IMPM#', $fileheader)) {
            return $this->getITheaderFilepointer();
        } elseif (preg_match('#^Extended Module#', $fileheader)) {
            return $this->getXMheaderFilepointer();
        } elseif (preg_match('#^.{44}SCRM#', $fileheader)) {
            return $this->getS3MheaderFilepointer();
        } elseif (preg_match('#^.{1080}(M\\.K\\.|M!K!|FLT4|FLT8|[5-9]CHN|[1-3][0-9]CH)#', $fileheader)) {
            return $this->getMODheaderFilepointer();
        }
        $info['error'][] = 'This is not a known type of MOD file';

        return false;
    }

Here is the call graph for this function:

getITheaderFilepointer()

GetId3\Module\Audio\Mod::getITheaderFilepointer

(

)

Returns

boolean

Definition at line 124 of file Mod.php.

References $info, GetId3\Handler\BaseHandler\fread(), and GetId3\Handler\BaseHandler\fseek().

Referenced by GetId3\Module\Audio\Mod\analyze().

    {
        $info = &$this->getid3->info;
        fseek($this->getid3->fp, $info['avdataoffset']);
        $FormatID = fread($this->getid3->fp, 4);
        if (!preg_match('#^IMPM$#', $FormatID)) {
            $info['error'][] = 'This is not an ImpulseTracker MOD file';

            return false;
        }

        $info['fileformat'] = 'it';

        $info['error'][] = 'ImpulseTracker parsing not enabled in this version of GetId3Core() ['.$this->getid3->version().']';

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMODheaderFilepointer()

GetId3\Module\Audio\Mod::getMODheaderFilepointer

(

)

Returns

boolean

Definition at line 58 of file Mod.php.

References $info, GetId3\Handler\BaseHandler\fread(), and GetId3\Handler\BaseHandler\fseek().

Referenced by GetId3\Module\Audio\Mod\analyze().

    {
        $info = &$this->getid3->info;
        fseek($this->getid3->fp, $info['avdataoffset'] + 1080);
        $FormatID = fread($this->getid3->fp, 4);
        if (!preg_match('#^(M.K.|[5-9]CHN|[1-3][0-9]CH)$#', $FormatID)) {
            $info['error'][] = 'This is not a known type of MOD file';

            return false;
        }

        $info['fileformat'] = 'mod';

        $info['error'][] = 'MOD parsing not enabled in this version of GetId3Core() ['.$this->getid3->version().']';

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getS3MheaderFilepointer()

GetId3\Module\Audio\Mod::getS3MheaderFilepointer

(

)

Returns

boolean

Definition at line 102 of file Mod.php.

References $info, GetId3\Handler\BaseHandler\fread(), and GetId3\Handler\BaseHandler\fseek().

Referenced by GetId3\Module\Audio\Mod\analyze().

    {
        $info = &$this->getid3->info;
        fseek($this->getid3->fp, $info['avdataoffset'] + 44);
        $FormatID = fread($this->getid3->fp, 4);
        if (!preg_match('#^SCRM$#', $FormatID)) {
            $info['error'][] = 'This is not a ScreamTracker MOD file';

            return false;
        }

        $info['fileformat'] = 's3m';

        $info['error'][] = 'ScreamTracker parsing not enabled in this version of GetId3Core() ['.$this->getid3->version().']';

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getXMheaderFilepointer()

GetId3\Module\Audio\Mod::getXMheaderFilepointer

(

)

Returns

boolean

Definition at line 80 of file Mod.php.

References $info, GetId3\Handler\BaseHandler\fread(), and GetId3\Handler\BaseHandler\fseek().

Referenced by GetId3\Module\Audio\Mod\analyze().

    {
        $info = &$this->getid3->info;
        fseek($this->getid3->fp, $info['avdataoffset']);
        $FormatID = fread($this->getid3->fp, 15);
        if (!preg_match('#^Extended Module$#', $FormatID)) {
            $info['error'][] = 'This is not a known type of XM-MOD file';

            return false;
        }

        $info['fileformat'] = 'xm';

        $info['error'][] = 'XM-MOD parsing not enabled in this version of GetId3Core() ['.$this->getid3->version().']';

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phansys/getid3/GetId3/Module/Audio/Mod.php