library/Zend/Id3/Adapter/Id3v2/Exception.php library/Zend/Id3/Adapter/Id3v2/Frames.php library/Zend/Id3/Adapter/Id3v2/Frames/Abstract.php library/Zend/Id3/Adapter/Id3v2/Frames/Exception.php @@ -14,117 +14,117 @@ class Zend_Id3 { - /** - * Size of read buffer in bytes - */ - const FREAD_BUFFER_SIZE = 16384; - - /** - * Name of the file - * - * @var string - */ - protected $_filename; - - /** - * File Pointer - * - * @var resource - */ - protected $_filePointer; - - /** - * id3 tag info - * - * @var array - */ - protected $_info = array(); - - /** - * - */ - function __construct() - { - // nothing yet - } - - /** - * - * @param $filename string - */ - public function analyze($filename) - { - // Remote files not supported - if (preg_match('#^([a-z][a-z0-9+.-]+):(//)?(.*?@)?#i', $filename)) { - include_once 'Zend/Id3/Exception.php'; - throw new Zend_Id3_Exception('Remote files are not supported'); - } - - $this->_filename = $filename; - - // Open local file - if (false === ($this->_filePointer = @fopen($this->_filename, 'rb'))) { - include_once 'Zend/Id3/Exception.php'; - throw new Zend_Id3_Exception('Could not open file "' . $filename . "'"); - } - - // Set filesize related parameters - $this->_info['filesize'] = filesize($filename); - $this->_info['avdataoffset'] = 0; - $this->_info['avdataend'] = $this->info['filesize']; - - - foreach(array('id3v1', 'id3v2') as $tagName) { - switch($tagName) { - case 'id3v1': - include_once 'Zend/Id3/Adapter/Id3v1.php'; - $tag = new Zend_Id3_Adapter_Id3v1($this); - $tag->analyze(); - break; - case 'id3v2': - include_once 'Zend/Id3/Adapter/Id3v2.php'; - $tag = new Zend_Id3_Adapter_Id3v2($this); - $tag->analyze(); - break; - } - } - - fclose($this->_filePointer); - - - return $this->_info; - } - - /** - * Gets the open file pointer - * - * @return resource - */ - public function getFilePointer() - { - return $this->_filePointer; - } - - /** - * Gets the file info - * - * @return array - */ - public function getFileInfo() - { - return $this->_info; - } - - /** - * Sets the file info - * - * @param array $info - * @return Zend_Id3 - */ - public function setFileInfo(array $info) - { - $this->_info = $info; - - return $this; - } + /** + * Size of read buffer in bytes + */ + const FREAD_BUFFER_SIZE = 16384; + + /** + * Name of the file + * + * @var string + */ + protected $_filename; + + /** + * File Pointer + * + * @var resource + */ + protected $_filePointer; + + /** + * id3 tag info + * + * @var array + */ + protected $_info = array(); + + /** + * + */ + function __construct() + { + // nothing yet + } + + /** + * + * @param $filename string + */ + public function analyze($filename) + { + // Remote files not supported + if (preg_match('#^([a-z][a-z0-9+.-]+):(//)?(.*?@)?#i', $filename)) { + include_once 'Zend/Id3/Exception.php'; + throw new Zend_Id3_Exception('Remote files are not supported'); + } + + $this->_filename = $filename; + + // Open local file + if (false === ($this->_filePointer = @fopen($this->_filename, 'rb'))) { + include_once 'Zend/Id3/Exception.php'; + throw new Zend_Id3_Exception('Could not open file "' . $filename . "'"); + } + + // Set filesize related parameters + $this->_info['filesize'] = filesize($filename); + $this->_info['avdataoffset'] = 0; + $this->_info['avdataend'] = $this->_info['filesize']; + + + foreach(array('id3v1', 'id3v2') as $tagName) { + switch($tagName) { + case 'id3v1': + include_once 'Zend/Id3/Adapter/Id3v1.php'; + $tag = new Zend_Id3_Adapter_Id3v1($this); + $tag->analyze(); + break; + case 'id3v2': + include_once 'Zend/Id3/Adapter/Id3v2.php'; + $tag = new Zend_Id3_Adapter_Id3v2($this); + $tag->analyze(); + break; + } + } + + fclose($this->_filePointer); + + + return $this->_info; + } + + /** + * Gets the open file pointer + * + * @return resource + */ + public function getFilePointer() + { + return $this->_filePointer; + } + + /** + * Gets the file info + * + * @return array + */ + public function getFileInfo() + { + return $this->_info; + } + + /** + * Sets the file info + * + * @param array $info + * @return Zend_Id3 + */ + public function setFileInfo(array $info) + { + $this->_info = $info; + + return $this; + } } library/Zend/Id3.php @@ -15,244 +15,245 @@ require_once ('library/Zend/Id3/Adapter/Abstract.php'); class Zend_Id3_Adapter_Id3v1 extends Zend_Id3_Adapter_Abstract { - /** - * List of Geners for Id3v1 - * - * @var array - */ - protected $_genres = array ( - 0 => 'Blues', - 1 => 'Classic Rock', - 2 => 'Country', - 3 => 'Dance', - 4 => 'Disco', - 5 => 'Funk', - 6 => 'Grunge', - 7 => 'Hip-Hop', - 8 => 'Jazz', - 9 => 'Metal', - 10 => 'New Age', - 11 => 'Oldies', - 12 => 'Other', - 13 => 'Pop', - 14 => 'R&B', - 15 => 'Rap', - 16 => 'Reggae', - 17 => 'Rock', - 18 => 'Techno', - 19 => 'Industrial', - 20 => 'Alternative', - 21 => 'Ska', - 22 => 'Death Metal', - 23 => 'Pranks', - 24 => 'Soundtrack', - 25 => 'Euro-Techno', - 26 => 'Ambient', - 27 => 'Trip-Hop', - 28 => 'Vocal', - 29 => 'Jazz+Funk', - 30 => 'Fusion', - 31 => 'Trance', - 32 => 'Classical', - 33 => 'Instrumental', - 34 => 'Acid', - 35 => 'House', - 36 => 'Game', - 37 => 'Sound Clip', - 38 => 'Gospel', - 39 => 'Noise', - 40 => 'Alt. Rock', - 41 => 'Bass', - 42 => 'Soul', - 43 => 'Punk', - 44 => 'Space', - 45 => 'Meditative', - 46 => 'Instrumental Pop', - 47 => 'Instrumental Rock', - 48 => 'Ethnic', - 49 => 'Gothic', - 50 => 'Darkwave', - 51 => 'Techno-Industrial', - 52 => 'Electronic', - 53 => 'Pop-Folk', - 54 => 'Eurodance', - 55 => 'Dream', - 56 => 'Southern Rock', - 57 => 'Comedy', - 58 => 'Cult', - 59 => 'Gangsta Rap', - 60 => 'Top 40', - 61 => 'Christian Rap', - 62 => 'Pop/Funk', - 63 => 'Jungle', - 64 => 'Native American', - 65 => 'Cabaret', - 66 => 'New Wave', - 67 => 'Psychedelic', - 68 => 'Rave', - 69 => 'Showtunes', - 70 => 'Trailer', - 71 => 'Lo-Fi', - 72 => 'Tribal', - 73 => 'Acid Punk', - 74 => 'Acid Jazz', - 75 => 'Polka', - 76 => 'Retro', - 77 => 'Musical', - 78 => 'Rock & Roll', - 79 => 'Hard Rock', - 80 => 'Folk', - 81 => 'Folk/Rock', - 82 => 'National Folk', - 83 => 'Swing', - 84 => 'Fast-Fusion', - 85 => 'Bebob', - 86 => 'Latin', - 87 => 'Revival', - 88 => 'Celtic', - 89 => 'Bluegrass', - 90 => 'Avantgarde', - 91 => 'Gothic Rock', - 92 => 'Progressive Rock', - 93 => 'Psychedelic Rock', - 94 => 'Symphonic Rock', - 95 => 'Slow Rock', - 96 => 'Big Band', - 97 => 'Chorus', - 98 => 'Easy Listening', - 99 => 'Acoustic', - 100 => 'Humour', - 101 => 'Speech', - 102 => 'Chanson', - 103 => 'Opera', - 104 => 'Chamber Music', - 105 => 'Sonata', - 106 => 'Symphony', - 107 => 'Booty Bass', - 108 => 'Primus', - 109 => 'Porn Groove', - 110 => 'Satire', - 111 => 'Slow Jam', - 112 => 'Club', - 113 => 'Tango', - 114 => 'Samba', - 115 => 'Folklore', - 116 => 'Ballad', - 117 => 'Power Ballad', - 118 => 'Rhythmic Soul', - 119 => 'Freestyle', - 120 => 'Duet', - 121 => 'Punk Rock', - 122 => 'Drum Solo', - 123 => 'A Cappella', - 124 => 'Euro-House', - 125 => 'Dance Hall', - 126 => 'Goa', - 127 => 'Drum & Bass', - 128 => 'Club-House', - 129 => 'Hardcore', - 130 => 'Terror', - 131 => 'Indie', - 132 => 'BritPop', - 133 => 'Negerpunk', - 134 => 'Polsk Punk', - 135 => 'Beat', - 136 => 'Christian Gangsta Rap', - 137 => 'Heavy Metal', - 138 => 'Black Metal', - 139 => 'Crossover', - 140 => 'Contemporary Christian', - 141 => 'Christian Rock', - 142 => 'Merengue', - 143 => 'Salsa', - 144 => 'Trash Metal', - 145 => 'Anime', - 146 => 'JPop', - 147 => 'Synthpop', + /** + * List of Geners for Id3v1 + * + * @var array + */ + protected $_genres = array ( + 0 => 'Blues', + 1 => 'Classic Rock', + 2 => 'Country', + 3 => 'Dance', + 4 => 'Disco', + 5 => 'Funk', + 6 => 'Grunge', + 7 => 'Hip-Hop', + 8 => 'Jazz', + 9 => 'Metal', + 10 => 'New Age', + 11 => 'Oldies', + 12 => 'Other', + 13 => 'Pop', + 14 => 'R&B', + 15 => 'Rap', + 16 => 'Reggae', + 17 => 'Rock', + 18 => 'Techno', + 19 => 'Industrial', + 20 => 'Alternative', + 21 => 'Ska', + 22 => 'Death Metal', + 23 => 'Pranks', + 24 => 'Soundtrack', + 25 => 'Euro-Techno', + 26 => 'Ambient', + 27 => 'Trip-Hop', + 28 => 'Vocal', + 29 => 'Jazz+Funk', + 30 => 'Fusion', + 31 => 'Trance', + 32 => 'Classical', + 33 => 'Instrumental', + 34 => 'Acid', + 35 => 'House', + 36 => 'Game', + 37 => 'Sound Clip', + 38 => 'Gospel', + 39 => 'Noise', + 40 => 'Alt. Rock', + 41 => 'Bass', + 42 => 'Soul', + 43 => 'Punk', + 44 => 'Space', + 45 => 'Meditative', + 46 => 'Instrumental Pop', + 47 => 'Instrumental Rock', + 48 => 'Ethnic', + 49 => 'Gothic', + 50 => 'Darkwave', + 51 => 'Techno-Industrial', + 52 => 'Electronic', + 53 => 'Pop-Folk', + 54 => 'Eurodance', + 55 => 'Dream', + 56 => 'Southern Rock', + 57 => 'Comedy', + 58 => 'Cult', + 59 => 'Gangsta Rap', + 60 => 'Top 40', + 61 => 'Christian Rap', + 62 => 'Pop/Funk', + 63 => 'Jungle', + 64 => 'Native American', + 65 => 'Cabaret', + 66 => 'New Wave', + 67 => 'Psychedelic', + 68 => 'Rave', + 69 => 'Showtunes', + 70 => 'Trailer', + 71 => 'Lo-Fi', + 72 => 'Tribal', + 73 => 'Acid Punk', + 74 => 'Acid Jazz', + 75 => 'Polka', + 76 => 'Retro', + 77 => 'Musical', + 78 => 'Rock & Roll', + 79 => 'Hard Rock', + 80 => 'Folk', + 81 => 'Folk/Rock', + 82 => 'National Folk', + 83 => 'Swing', + 84 => 'Fast-Fusion', + 85 => 'Bebob', + 86 => 'Latin', + 87 => 'Revival', + 88 => 'Celtic', + 89 => 'Bluegrass', + 90 => 'Avantgarde', + 91 => 'Gothic Rock', + 92 => 'Progressive Rock', + 93 => 'Psychedelic Rock', + 94 => 'Symphonic Rock', + 95 => 'Slow Rock', + 96 => 'Big Band', + 97 => 'Chorus', + 98 => 'Easy Listening', + 99 => 'Acoustic', + 100 => 'Humour', + 101 => 'Speech', + 102 => 'Chanson', + 103 => 'Opera', + 104 => 'Chamber Music', + 105 => 'Sonata', + 106 => 'Symphony', + 107 => 'Booty Bass', + 108 => 'Primus', + 109 => 'Porn Groove', + 110 => 'Satire', + 111 => 'Slow Jam', + 112 => 'Club', + 113 => 'Tango', + 114 => 'Samba', + 115 => 'Folklore', + 116 => 'Ballad', + 117 => 'Power Ballad', + 118 => 'Rhythmic Soul', + 119 => 'Freestyle', + 120 => 'Duet', + 121 => 'Punk Rock', + 122 => 'Drum Solo', + 123 => 'A Cappella', + 124 => 'Euro-House', + 125 => 'Dance Hall', + 126 => 'Goa', + 127 => 'Drum & Bass', + 128 => 'Club-House', + 129 => 'Hardcore', + 130 => 'Terror', + 131 => 'Indie', + 132 => 'BritPop', + 133 => 'Negerpunk', + 134 => 'Polsk Punk', + 135 => 'Beat', + 136 => 'Christian Gangsta Rap', + 137 => 'Heavy Metal', + 138 => 'Black Metal', + 139 => 'Crossover', + 140 => 'Contemporary Christian', + 141 => 'Christian Rock', + 142 => 'Merengue', + 143 => 'Salsa', + 144 => 'Trash Metal', + 145 => 'Anime', + 146 => 'JPop', + 147 => 'Synthpop', - 255 => 'Unknown', + 255 => 'Unknown', - 'CR' => 'Cover', - 'RX' => 'Remix' - ); + 'CR' => 'Cover', + 'RX' => 'Remix' + ); - public function analyze() - { - $fp = $this->_id3->getFilePointer(); - $info = $this->_id3->getFileInfo(); + public function analyze() + { + $fp = $this->_id3->getFilePointer(); + $info = $this->_id3->getFileInfo(); - fseek($fp, -256, SEEK_END); - $_beforeId3v1 = fread($fp, 128); - $_id3Tag = fread($fp, 128); + fseek($fp, -256, SEEK_END); + $_beforeId3v1 = fread($fp, 128); + $_id3Tag = fread($fp, 128); - if(substr($_id3Tag, 0, 3) == 'TAG') { - $info['avdataend'] -= 128; + if(substr($_id3Tag, 0, 3) == 'TAG') { + $info['avdataend'] -= 128; - $info['id3v1'] = array(); + $info['id3v1'] = array(); - $info['id3v1']['title'] = $this->_cutfield(substr($_id3Tag, 3, 30)); - $info['id3v1']['artist'] = $this->_cutfield(substr($_id3Tag, 33, 30)); - $info['id3v1']['album'] = $this->_cutfield(substr($_id3Tag, 63, 30)); - $info['id3v1']['year'] = $this->_cutfield(substr($_id3Tag, 93, 4)); - $info['id3v1']['comment'] = substr($_id3Tag, 97, 30); - $info['id3v1']['genreid'] = ord(substr($_id3Tag, 127, 1)); + $info['id3v1']['title'] = $this->_cutfield(substr($_id3Tag, 3, 30)); + $info['id3v1']['artist'] = $this->_cutfield(substr($_id3Tag, 33, 30)); + $info['id3v1']['album'] = $this->_cutfield(substr($_id3Tag, 63, 30)); + $info['id3v1']['year'] = $this->_cutfield(substr($_id3Tag, 93, 4)); + $info['id3v1']['comment'] = substr($_id3Tag, 97, 30); + $info['id3v1']['genreid'] = ord(substr($_id3Tag, 127, 1)); - // check to see if this is ID3v1.1 to see if there is a track number - if(($_id3Tag{125} === "\x00") && ($_id3Tag{126} !== "\x00")) { - $info['id3v1']['track'] = ord(substr($info['id3v1']['comment'], 29, 1)); - $info['id3v1']['comment'] = substr($info['id3v1']['comment'], 0, 28); - } - $info['id3v1']['comment'] = $this->_cutfield($info['comment']); + // check to see if this is ID3v1.1 to see if there is a track number + if(($_id3Tag{125} === "\x00") && ($_id3Tag{126} !== "\x00")) { + $info['id3v1']['track'] = ord(substr($info['id3v1']['comment'], 29, 1)); + $info['id3v1']['comment'] = substr($info['id3v1']['comment'], 0, 28); + } - $info['id3v1']['genre'] = $this->_lookupGenreName($info['id3v1']['genreid']); - if (!empty($info['id3v1']['genre'])) { - unset($info['id3v1']['genreid']); - } - if (empty($info['id3v1']['genre']) || (@$info['id3v1']['genre'] == 'Unknown')) { - unset($info['id3v1']['genre']); - } + $info['id3v1']['comment'] = $this->_cutfield($info['id3v1']['comment']); - $info['id3v1']['tag_offset_end'] = $info['filesize']; - $info['id3v1']['tag_offset_start'] = $info['id3v1']['tag_offset_end'] - 128; - } + $info['id3v1']['genre'] = $this->_lookupGenreName($info['id3v1']['genreid']); + if (!empty($info['id3v1']['genre'])) { + unset($info['id3v1']['genreid']); + } + if (empty($info['id3v1']['genre']) || (@$info['id3v1']['genre'] == 'Unknown')) { + unset($info['id3v1']['genre']); + } - if (substr($_beforeId3v1, 0, 3) == 'TAG') { - // The way iTunes handles tags is, well, brain-damaged. - // It completely ignores v1 if ID3v2 is present. - // This goes as far as adding a new v1 tag *even if there already is one* + $info['id3v1']['tag_offset_end'] = $info['filesize']; + $info['id3v1']['tag_offset_start'] = $info['id3v1']['tag_offset_end'] - 128; + } - // A suspected double-ID3v1 tag has been detected, but it could be that the "TAG" identifier is a legitimate part of an APE or Lyrics3 tag - if (substr($_beforeId3v1, 96, 8) == 'APETAGEX') { - // an APE tag footer was found before the last ID3v1, assume false "TAG" synch - } elseif (substr($_beforeId3v1, 119, 6) == 'LYRICS') { - // a Lyrics3 tag footer was found before the last ID3v1, assume false "TAG" synch - } else { - // APE and Lyrics3 footers not found - assume double ID3v1 - $info['id3v1']['avdataend'] -= 128; - } - } + if (substr($_beforeId3v1, 0, 3) == 'TAG') { + // The way iTunes handles tags is, well, brain-damaged. + // It completely ignores v1 if ID3v2 is present. + // This goes as far as adding a new v1 tag *even if there already is one* - $this->_id3->setFileInfo($info); + // A suspected double-ID3v1 tag has been detected, but it could be that the "TAG" identifier is a legitimate part of an APE or Lyrics3 tag + if (substr($_beforeId3v1, 96, 8) == 'APETAGEX') { + // an APE tag footer was found before the last ID3v1, assume false "TAG" synch + } elseif (substr($_beforeId3v1, 119, 6) == 'LYRICS') { + // a Lyrics3 tag footer was found before the last ID3v1, assume false "TAG" synch + } else { + // APE and Lyrics3 footers not found - assume double ID3v1 + $info['id3v1']['avdataend'] -= 128; + } + } - return true; - } + $this->_id3->setFileInfo($info); - protected function _cutfield($str) - { - return trim(substr($str, 0, strcspn($str, "\x00"))); - } + return true; + } - protected function _lookupGenreName($genreId) - { - switch ($genreId) { - case 'RX': - // break intentionally omitted - case 'CR': - break; - default: - $genreId = intval($genreId); // to handle 3 or '3' or '03' - break; - } - return (isset($this->_genres[$genreId]) ? $this->_genres[$genreId] : false); - } + protected function _cutfield($str) + { + return trim(substr($str, 0, strcspn($str, "\x00"))); + } + + protected function _lookupGenreName($genreId) + { + switch ($genreId) { + case 'RX': + // break intentionally omitted + case 'CR': + break; + default: + $genreId = intval($genreId); // to handle 3 or '3' or '03' + break; + } + return (isset($this->_genres[$genreId]) ? $this->_genres[$genreId] : false); + } } \ No newline at end of file library/Zend/Id3/Adapter/Id3v1.php @@ -20,265 +20,270 @@ require_once 'Zend/Id3/ByteConvert.php'; class Zend_Id3_Adapter_Id3v2 extends Zend_Id3_Adapter_Abstract { - /** - * Starting offset - * - * @var integer - */ - protected $_startingOffset = 0; - - protected $_frameDataOffset = 0; - - /** - * Major Version of the tag for easy access - * - * @var integer - */ - protected $_tagMajorVersion; - - /** - * An Array that Stores the tag info - * - * @var array - */ - protected $_tagInfo = array(); - - public function analyze() - { - /** - * Overall tag structure: - * +-----------------------------+ - * | Header (10 bytes) | - * +-----------------------------+ - * | Extended Header | - * | (variable length, OPTIONAL) | - * +-----------------------------+ - * | Frames (variable length) | - * +-----------------------------+ - * | Padding | - * | (variable length, OPTIONAL) | - * +-----------------------------+ - * | Footer (10 bytes, OPTIONAL) | - * +-----------------------------+ - * - * Header - * ID3v2/file identifier "ID3" - * ID3v2 version $04 00 - * ID3v2 flags (%ab000000 in v2.2, %abc00000 in v2.3, %abcd0000 in v2.4.x) - * ID3v2 size 4 * %0xxxxxxx - */ - - //$fp = $this->_id3->getFilePointer(); - $this->_tagInfo = $this->_id3->getFileInfo(); - - - $this->_tagInfo['id3v2']['flags'] = array (); - - $this->fseek($this->_startingOffset, SEEK_SET); - $header = $this->fread(10); - if (substr($header, 0, 3) == 'ID3' && strlen($header) == 10) { - - $this->_tagInfo['id3v2']['majorversion'] = ord($header{3}); - $this->_tagInfo['id3v2']['minorversion'] = ord($header{4}); - - $this->_tagMajorVersion = $this->_tagInfo['id3v2']['majorversion']; - - } else { - return false; - } - - /** - * The current max major version is 4 so that's what we support up to. - */ - if ($this->_tagMajorVersion > 4) { - include_once 'Zend/Id3/Adapter/Exception.php'; - throw new Zend_Id3_Adapter_Exception('Zend_Id3_Adapter_Id3v2 can only parse upt to Id3v2.4'); - } - - $this->_tagInfo['id3v2']['flags'] = $this->_processTagFlags(ord($header{5})); - - // length of ID3v2 tag in 10-byte header doesn't include 10-byte header length - $this->_tagInfo['id3v2']['headerlength'] = Zend_Id3_ByteConvert::bigEndianSyncSafe2Int(substr($header, 6, 4)) + 10; - - $this->_tagInfo['id3v2']['tag_offset_start'] = $this->_startingOffset; - $this->_tagInfo['id3v2']['tag_offset_end'] = $this->_tagInfo['id3v2']['tag_offset_start'] + $this->_tagInfo['id3v2']['headerlength']; - - - $this->_id3->setFileInfo($this->_tagInfo); - - return true; - - } - - /** - * Handle the proccesing of the Id3v2 Tag Flags - * - * v2.2 = %ab000000 - * v2.3 = %abc00000 - * v2.4 = %abcd0000 - * - * @param integer $flags - * @return array - */ - protected function _processTagFlags($flags) - { - $arrFlags = array(); - switch ($this->_tagMajorVersion) { - case 2: - $arrFlags['unsynch'] = (bool)($flags & 0x80); // a - Unsynchronisation - $arrFlags['compression'] = (bool)($flags & 0x40); // b - Compression - break; - - case 3: - $arrFlags['unsynch'] = (bool)($flags & 0x80); // a - Unsynchronisation - $arrFlags['exthead'] = (bool)($flags & 0x40); // b - Extended header - $arrFlags['experim'] = (bool)($flags & 0x20); // c - Experimental indicator - break; - - case 4: - $arrFlags['unsynch'] = (bool)($flags & 0x80); // a - Unsynchronisation - $arrFlags['exthead'] = (bool)($flags & 0x40); // b - Extended header - $arrFlags['experim'] = (bool)($flags & 0x20); // c - Experimental indicator - $arrFlags['isfooter'] = (bool)($flags & 0x10); // d - Footer present - break; - } - - return $arrFlags; - } - - /** - * Proccess Frame Data - * All ID3v2 frames consists of one frame header followed by one or more - * fields containing the actual information. The header is always 10 - * bytes and laid out as follows: - * - * Frame ID $xx xx xx xx (four characters) - * Size 4 * %0xxxxxxx - * Flags $xx xx - */ - protected function _fetchFrameData() - { - - // get the frame size with out the 10-byte initial header - $frameSize = $this->_tagInfo['id3v2']['headerlength'] - 10; - - // the footer takes the last 10 bytes of the header, after the frame data and before the audio - if(isset($this->_tagInfo['id3v2']['flags']['isfooter'])) { - $frameSize -= 10; - } - - if($frameSize > 0) { - - $frameData = $this->fread($frameSize); - - // If the entire frame data is unsynched, de-unsynch it now (ID3v2.3.x) - if(isset($this->_tagInfo['id3v2']['flags']['unsync']) && $this->_tagMajorVersion <= 3) { - $frameData = str_replace("\xFF\x00", "\xFF", $frameData); - } - - /** - * [in ID3v2.4.0] Unsynchronisation [S:6.1] is done on frame level, instead - * of on tag level, making it easier to skip frames, increasing the streamability - * of the tag. The unsynchronisation flag in the header [S:3.1] indicates that - * there exists an unsynchronised frame, while the new unsynchronisation flag in - * the frame header [S:4.1.2] indicates unsynchronisation. - */ - // how many bytes into the stream - start from after the 10-byte header - $this->_frameDataOffset = 10; - - if(isset($this->_tagInfo['id3v2']['flags']['exthead']) && true == $this->_tagInfo['id3v2']['flags']['exthead']) { - $frameData = $this->_proccessExtendedFrameHeader($frameData); - } - - } - } - - /** - * - */ - protected function _proccessExtendedFrameHeader($frameData) - { - $extendedHeaderOffset = 0; - switch($this->_tagMajorVersion) { - /** - * v2.3 definition: - * - * Extended header size $xx xx xx xx // 32-bit integer - * Extended Flags $xx xx - * %x0000000 %00000000 // v2.3 - * x - CRC data present - * Size of padding $xx xx xx xx - */ - case 3: - $this->_tagInfo['id3v2']['exthead']['length'] = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, 4), 0); - $extendedHeaderOffset += 4; - - $this->_tagInfo['id3v2']['exthead']['flag_bytes'] = 2; - $this->_tagInfo['id3v2']['exthead']['flag_raw'] = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, $this->_tagInfo['id3v2']['exthead']['flag_bytes'])); - $extendedHeaderOffset += $this->_tagInfo['id3v2']['exthead']['flag_bytes']; - - $this->_tagInfo['id3v2']['exthead']['flags']['crc'] = (bool) ($this->_tagInfo['id3v2']['exthead']['flag_raw'] & 0x8000); - - $this->_tagInfo['id3v2']['exthead']['padding_size'] = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, 4)); - $extendedHeaderOffset += 4; - - if ($this->_tagInfo['id3v2']['exthead']['flags']['crc']) { - $this->_tagInfo['id3v2']['exthead']['flag_data']['crc'] = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, 4)); - $extendedHeaderOffset += 4; - } - $extendedHeaderOffset += $this->_tagInfo['id3v2']['exthead']['padding_size']; - break; - - /** - * v2.4 definition: - * - * Extended header size 4 * %0xxxxxxx * 28-bit synchsafe integer - * Number of flag bytes $01 - * Extended Flags $xx - * %0bcd0000 * v2.4 - * b - Tag is an update - * Flag data length $00 - * c - CRC data present - * Flag data length $05 - * Total frame CRC 5 * %0xxxxxxx - * d - Tag restrictions - * Flag data length $01 - */ - case 4: - - $this->_tagInfo['id3v2']['exthead']['length'] = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, 4), 1); - $extendedHeaderOffset += 4; - - $this->_tagInfo['id3v2']['exthead']['flag_bytes'] = 1; - $this->_tagInfo['id3v2']['exthead']['flag_raw'] = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, $this->_tagInfo['id3v2']['exthead']['flag_bytes'])); - $extendedHeaderOffset += $this->_tagInfo['id3v2']['exthead']['flag_bytes']; - - $this->_tagInfo['id3v2']['exthead']['flags']['update'] = (bool) ($this->_tagInfo['id3v2']['exthead']['flag_raw'] & 0x4000); - $this->_tagInfo['id3v2']['exthead']['flags']['crc'] = (bool) ($this->_tagInfo['id3v2']['exthead']['flag_raw'] & 0x2000); - $this->_tagInfo['id3v2']['exthead']['flags']['restrictions'] = (bool) ($this->_tagInfo['id3v2']['exthead']['flag_raw'] & 0x1000); - - if ($this->_tagInfo['id3v2']['exthead']['flags']['crc']) { - $this->_tagInfo['id3v2']['exthead']['flag_data']['crc'] = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, 5), 1); - $extendedHeaderOffset += 5; - } - if ($this->_tagInfo['id3v2']['exthead']['flags']['restrictions']) { - // %ppqrrstt - $restrictionsByte = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, 1)); - $extendedHeaderOffset += 1; - $this->_tagInfo['id3v2']['exthead']['flags']['restrictions']['tagsize'] = ($restrictionsByte && 0xC0) >> 6; // p - Tag size restrictions - $this->_tagInfo['id3v2']['exthead']['flags']['restrictions']['textenc'] = ($restrictionsByte && 0x20) >> 5; // q - Text encoding restrictions - $this->_tagInfo['id3v2']['exthead']['flags']['restrictions']['textsize'] = ($restrictionsByte && 0x18) >> 3; // r - Text fields size restrictions - $this->_tagInfo['id3v2']['exthead']['flags']['restrictions']['imgenc'] = ($restrictionsByte && 0x04) >> 2; // s - Image encoding restrictions - $this->_tagInfo['id3v2']['exthead']['flags']['restrictions']['imgsize'] = ($restrictionsByte && 0x03) >> 0; // t - Image size restrictions - } - - break; - - } - - $this->_frameDataOffset += $extendedHeaderOffset; - $frameData = substr($frameData, $extendedHeaderOffset); - - return $frameData; - } + /** + * Starting offset + * + * @var integer + */ + protected $_startingOffset = 0; + + protected $_frameDataOffset = 0; + + /** + * Major Version of the tag for easy access + * + * @var integer + */ + protected $_tagMajorVersion; + + /** + * An Array that Stores the tag info + * + * @var array + */ + protected $_tagInfo = array(); + + public function analyze() + { + /** + * Overall tag structure: + * +-----------------------------+ + * | Header (10 bytes) | + * +-----------------------------+ + * | Extended Header | + * | (variable length, OPTIONAL) | + * +-----------------------------+ + * | Frames (variable length) | + * +-----------------------------+ + * | Padding | + * | (variable length, OPTIONAL) | + * +-----------------------------+ + * | Footer (10 bytes, OPTIONAL) | + * +-----------------------------+ + * + * Header + * ID3v2/file identifier "ID3" + * ID3v2 version $04 00 + * ID3v2 flags (%ab000000 in v2.2, %abc00000 in v2.3, %abcd0000 in v2.4.x) + * ID3v2 size 4 * %0xxxxxxx + */ + + //$fp = $this->_id3->getFilePointer(); + $this->_tagInfo = $this->_id3->getFileInfo(); + + + $this->_tagInfo['id3v2']['flags'] = array (); + + $this->fseek($this->_startingOffset, SEEK_SET); + $header = $this->fread(10); + if (substr($header, 0, 3) == 'ID3' && strlen($header) == 10) { + + $this->_tagInfo['id3v2']['majorversion'] = ord($header{3}); + $this->_tagInfo['id3v2']['minorversion'] = ord($header{4}); + + $this->_tagMajorVersion = $this->_tagInfo['id3v2']['majorversion']; + + } else { + return false; + } + + /** + * The current max major version is 4 so that's what we support up to. + */ + if ($this->_tagMajorVersion > 4) { + include_once 'Zend/Id3/Adapter/Exception.php'; + throw new Zend_Id3_Adapter_Exception('Zend_Id3_Adapter_Id3v2 can only parse upt to Id3v2.4'); + } + + $this->_tagInfo['id3v2']['flags'] = $this->_processTagFlags(ord($header{5})); + + // length of ID3v2 tag in 10-byte header doesn't include 10-byte header length + $this->_tagInfo['id3v2']['headerlength'] = Zend_Id3_ByteConvert::bigEndianSyncSafe2Int(substr($header, 6, 4)) + 10; + + $this->_tagInfo['id3v2']['tag_offset_start'] = $this->_startingOffset; + $this->_tagInfo['id3v2']['tag_offset_end'] = $this->_tagInfo['id3v2']['tag_offset_start'] + $this->_tagInfo['id3v2']['headerlength']; + + + $this->_parseFrameData(); + + $this->_id3->setFileInfo($this->_tagInfo); + + return true; + + } + + /** + * Handle the proccesing of the Id3v2 Tag Flags + * + * v2.2 = %ab000000 + * v2.3 = %abc00000 + * v2.4 = %abcd0000 + * + * @param integer $flags + * @return array + */ + protected function _processTagFlags($flags) + { + $arrFlags = array(); + switch ($this->_tagMajorVersion) { + case 2: + $arrFlags['unsynch'] = (bool)($flags & 0x80); // a - Unsynchronisation + $arrFlags['compression'] = (bool)($flags & 0x40); // b - Compression + break; + + case 3: + $arrFlags['unsynch'] = (bool)($flags & 0x80); // a - Unsynchronisation + $arrFlags['exthead'] = (bool)($flags & 0x40); // b - Extended header + $arrFlags['experim'] = (bool)($flags & 0x20); // c - Experimental indicator + break; + + case 4: + $arrFlags['unsynch'] = (bool)($flags & 0x80); // a - Unsynchronisation + $arrFlags['exthead'] = (bool)($flags & 0x40); // b - Extended header + $arrFlags['experim'] = (bool)($flags & 0x20); // c - Experimental indicator + $arrFlags['isfooter'] = (bool)($flags & 0x10); // d - Footer present + break; + } + + return $arrFlags; + } + + /** + * Proccess Frame Data + * All ID3v2 frames consists of one frame header followed by one or more + * fields containing the actual information. The header is always 10 + * bytes and laid out as follows: + * + * Frame ID $xx xx xx xx (four characters) + * Size 4 * %0xxxxxxx + * Flags $xx xx + */ + protected function _parseFrameData() + { + + // get the frame size with out the 10-byte initial header + $frameSize = $this->_tagInfo['id3v2']['headerlength'] - 10; + + // the footer takes the last 10 bytes of the header, after the frame data and before the audio + if(isset($this->_tagInfo['id3v2']['flags']['isfooter'])) { + $frameSize -= 10; + } + + if($frameSize > 0) { + + $frameData = $this->fread($frameSize); + + // If the entire frame data is unsynched, de-unsynch it now (ID3v2.3.x) + if(isset($this->_tagInfo['id3v2']['flags']['unsync']) && $this->_tagMajorVersion <= 3) { + $frameData = str_replace("\xFF\x00", "\xFF", $frameData); + } + + /** + * [in ID3v2.4.0] Unsynchronisation [S:6.1] is done on frame level, instead + * of on tag level, making it easier to skip frames, increasing the streamability + * of the tag. The unsynchronisation flag in the header [S:3.1] indicates that + * there exists an unsynchronised frame, while the new unsynchronisation flag in + * the frame header [S:4.1.2] indicates unsynchronisation. + */ + // how many bytes into the stream - start from after the 10-byte header + $this->_frameDataOffset = 10; + + if(isset($this->_tagInfo['id3v2']['flags']['exthead']) && true == $this->_tagInfo['id3v2']['flags']['exthead']) { + $frameData = $this->_proccessExtendedFrameHeader($frameData); + } + + include_once 'Zend/Id3/Adapter/Id3v2/Frames.php'; + $frames = new Zend_Id3_Adapter_Id3v2_Frames($frameData, $this->_frameDataOffset, $this->_tagMajorVersion); + + } + } + + /** + * + */ + protected function _proccessExtendedFrameHeader($frameData) + { + $extendedHeaderOffset = 0; + switch($this->_tagMajorVersion) { + /** + * v2.3 definition: + * + * Extended header size $xx xx xx xx // 32-bit integer + * Extended Flags $xx xx + * %x0000000 %00000000 // v2.3 + * x - CRC data present + * Size of padding $xx xx xx xx + */ + case 3: + $this->_tagInfo['id3v2']['exthead']['length'] = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, 4), 0); + $extendedHeaderOffset += 4; + + $this->_tagInfo['id3v2']['exthead']['flag_bytes'] = 2; + $this->_tagInfo['id3v2']['exthead']['flag_raw'] = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, $this->_tagInfo['id3v2']['exthead']['flag_bytes'])); + $extendedHeaderOffset += $this->_tagInfo['id3v2']['exthead']['flag_bytes']; + + $this->_tagInfo['id3v2']['exthead']['flags']['crc'] = (bool) ($this->_tagInfo['id3v2']['exthead']['flag_raw'] & 0x8000); + + $this->_tagInfo['id3v2']['exthead']['padding_size'] = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, 4)); + $extendedHeaderOffset += 4; + + if ($this->_tagInfo['id3v2']['exthead']['flags']['crc']) { + $this->_tagInfo['id3v2']['exthead']['flag_data']['crc'] = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, 4)); + $extendedHeaderOffset += 4; + } + $extendedHeaderOffset += $this->_tagInfo['id3v2']['exthead']['padding_size']; + break; + + /** + * v2.4 definition: + * + * Extended header size 4 * %0xxxxxxx * 28-bit synchsafe integer + * Number of flag bytes $01 + * Extended Flags $xx + * %0bcd0000 * v2.4 + * b - Tag is an update + * Flag data length $00 + * c - CRC data present + * Flag data length $05 + * Total frame CRC 5 * %0xxxxxxx + * d - Tag restrictions + * Flag data length $01 + */ + case 4: + + $this->_tagInfo['id3v2']['exthead']['length'] = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, 4), 1); + $extendedHeaderOffset += 4; + + $this->_tagInfo['id3v2']['exthead']['flag_bytes'] = 1; + $this->_tagInfo['id3v2']['exthead']['flag_raw'] = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, $this->_tagInfo['id3v2']['exthead']['flag_bytes'])); + $extendedHeaderOffset += $this->_tagInfo['id3v2']['exthead']['flag_bytes']; + + $this->_tagInfo['id3v2']['exthead']['flags']['update'] = (bool) ($this->_tagInfo['id3v2']['exthead']['flag_raw'] & 0x4000); + $this->_tagInfo['id3v2']['exthead']['flags']['crc'] = (bool) ($this->_tagInfo['id3v2']['exthead']['flag_raw'] & 0x2000); + $this->_tagInfo['id3v2']['exthead']['flags']['restrictions'] = (bool) ($this->_tagInfo['id3v2']['exthead']['flag_raw'] & 0x1000); + + if ($this->_tagInfo['id3v2']['exthead']['flags']['crc']) { + $this->_tagInfo['id3v2']['exthead']['flag_data']['crc'] = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, 5), 1); + $extendedHeaderOffset += 5; + } + if ($this->_tagInfo['id3v2']['exthead']['flags']['restrictions']) { + // %ppqrrstt + $restrictionsByte = Zend_Id3_ByteConvert::bigEndian2Int(substr($frameData, $extendedHeaderOffset, 1)); + $extendedHeaderOffset += 1; + $this->_tagInfo['id3v2']['exthead']['flags']['restrictions']['tagsize'] = ($restrictionsByte && 0xC0) >> 6; // p - Tag size restrictions + $this->_tagInfo['id3v2']['exthead']['flags']['restrictions']['textenc'] = ($restrictionsByte && 0x20) >> 5; // q - Text encoding restrictions + $this->_tagInfo['id3v2']['exthead']['flags']['restrictions']['textsize'] = ($restrictionsByte && 0x18) >> 3; // r - Text fields size restrictions + $this->_tagInfo['id3v2']['exthead']['flags']['restrictions']['imgenc'] = ($restrictionsByte && 0x04) >> 2; // s - Image encoding restrictions + $this->_tagInfo['id3v2']['exthead']['flags']['restrictions']['imgsize'] = ($restrictionsByte && 0x03) >> 0; // t - Image size restrictions + } + + break; + + } + + $this->_frameDataOffset += $extendedHeaderOffset; + $frameData = substr($frameData, $extendedHeaderOffset); + + return $frameData; + } } library/Zend/Id3/Adapter/Id3v2.php 3a2d6336423b634785c475e9d8fa4987df3889c5 Sid Highwind sidhighwind@peter.(none) http://github.com/sidhighwind/zend_id3/commit/2b94654bad6ae4b51920094606ac7f2924033149 2b94654bad6ae4b51920094606ac7f2924033149 2008-10-11T19:30:54-07:00 2008-10-11T19:30:54-07:00 Create v2 Frame Parser and started the abstract class for the different frames to implement e7c4d3c4f1f07f6f2b5a9e2caa708b82d831ea5b Sid Highwind sidhighwind@peter.(none)