123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328 |
- <?php
-
- /////////////////////////////////////////////////////////////////
- /// getID3() by James Heinrich <info@getid3.org> //
- // available at https://github.com/JamesHeinrich/getID3 //
- // or https://www.getid3.org //
- // or http://getid3.sourceforge.net //
- // see readme.txt for more details //
- /////////////////////////////////////////////////////////////////
- /// //
- // write.id3v2.php //
- // module for writing ID3v2 tags //
- // dependencies: module.tag.id3v2.php //
- // ///
- /////////////////////////////////////////////////////////////////
-
- if (!defined('GETID3_INCLUDEPATH')) { // prevent path-exposing attacks that access modules directly on public webservers
- exit;
- }
- getid3_lib::IncludeDependency(GETID3_INCLUDEPATH.'module.tag.id3v2.php', __FILE__, true);
-
- class getid3_write_id3v2
- {
- /**
- * @var string
- */
- public $filename;
-
- /**
- * @var array|null
- */
- public $tag_data;
-
- /**
- * Read buffer size in bytes.
- *
- * @var int
- */
- public $fread_buffer_size = 32768;
-
- /**
- * Minimum length of ID3v2 tag in bytes.
- *
- * @var int
- */
- public $paddedlength = 4096;
-
- /**
- * ID3v2 major version (2, 3 (recommended), 4).
- *
- * @var int
- */
- public $majorversion = 3;
-
- /**
- * ID3v2 minor version - always 0.
- *
- * @var int
- */
- public $minorversion = 0;
-
- /**
- * If true, merge new data with existing tags; if false, delete old tag data and only write new tags.
- *
- * @var bool
- */
- public $merge_existing_data = false;
-
- /**
- * Default text encoding (ISO-8859-1) if not explicitly passed.
- *
- * @var int
- */
- public $id3v2_default_encodingid = 0;
-
- /**
- * The specs say it should be TRUE, but most other ID3v2-aware programs are broken if unsynchronization is used,
- * so by default don't use it.
- *
- * @var bool
- */
- public $id3v2_use_unsynchronisation = false;
-
- /**
- * Any non-critical errors will be stored here.
- *
- * @var array
- */
- public $warnings = array();
-
- /**
- * Any critical errors will be stored here.
- *
- * @var array
- */
- public $errors = array();
-
- public function __construct() {
- }
-
- /**
- * @return bool
- */
- public function WriteID3v2() {
- // File MUST be writeable - CHMOD(646) at least. It's best if the
- // directory is also writeable, because that method is both faster and less susceptible to errors.
-
- if (!empty($this->filename) && (getID3::is_writable($this->filename) || (!file_exists($this->filename) && getID3::is_writable(dirname($this->filename))))) {
- // Initialize getID3 engine
- $getID3 = new getID3;
- $OldThisFileInfo = $getID3->analyze($this->filename);
- if (!getid3_lib::intValueSupported($OldThisFileInfo['filesize'])) {
- $this->errors[] = 'Unable to write ID3v2 because file is larger than '.round(PHP_INT_MAX / 1073741824).'GB';
- return false;
- }
- if ($this->merge_existing_data) {
- // merge with existing data
- if (!empty($OldThisFileInfo['id3v2'])) {
- $this->tag_data = $this->array_join_merge($OldThisFileInfo['id3v2'], $this->tag_data);
- }
- }
- $this->paddedlength = (isset($OldThisFileInfo['id3v2']['headerlength']) ? max($OldThisFileInfo['id3v2']['headerlength'], $this->paddedlength) : $this->paddedlength);
-
- if ($NewID3v2Tag = $this->GenerateID3v2Tag()) {
-
- if (file_exists($this->filename) && getID3::is_writable($this->filename) && isset($OldThisFileInfo['id3v2']['headerlength']) && ($OldThisFileInfo['id3v2']['headerlength'] == strlen($NewID3v2Tag))) {
-
- // best and fastest method - insert-overwrite existing tag (padded to length of old tag if neccesary)
- if (file_exists($this->filename)) {
-
- if (is_readable($this->filename) && getID3::is_writable($this->filename) && is_file($this->filename) && ($fp = fopen($this->filename, 'r+b'))) {
- rewind($fp);
- fwrite($fp, $NewID3v2Tag, strlen($NewID3v2Tag));
- fclose($fp);
- } else {
- $this->errors[] = 'Could not fopen("'.$this->filename.'", "r+b")';
- }
-
- } else {
-
- if (getID3::is_writable($this->filename) && is_file($this->filename) && ($fp = fopen($this->filename, 'wb'))) {
- rewind($fp);
- fwrite($fp, $NewID3v2Tag, strlen($NewID3v2Tag));
- fclose($fp);
- } else {
- $this->errors[] = 'Could not fopen("'.$this->filename.'", "wb")';
- }
-
- }
-
- } else {
-
- if ($tempfilename = tempnam(GETID3_TEMP_DIR, 'getID3')) {
- if (is_readable($this->filename) && is_file($this->filename) && ($fp_source = fopen($this->filename, 'rb'))) {
- if (getID3::is_writable($tempfilename) && is_file($tempfilename) && ($fp_temp = fopen($tempfilename, 'wb'))) {
-
- fwrite($fp_temp, $NewID3v2Tag, strlen($NewID3v2Tag));
-
- rewind($fp_source);
- if (!empty($OldThisFileInfo['avdataoffset'])) {
- fseek($fp_source, $OldThisFileInfo['avdataoffset']);
- }
-
- while ($buffer = fread($fp_source, $this->fread_buffer_size)) {
- fwrite($fp_temp, $buffer, strlen($buffer));
- }
-
- fclose($fp_temp);
- fclose($fp_source);
- copy($tempfilename, $this->filename);
- unlink($tempfilename);
- return true;
-
- } else {
- $this->errors[] = 'Could not fopen("'.$tempfilename.'", "wb")';
- }
- fclose($fp_source);
-
- } else {
- $this->errors[] = 'Could not fopen("'.$this->filename.'", "rb")';
- }
- }
- return false;
-
- }
-
- } else {
-
- $this->errors[] = '$this->GenerateID3v2Tag() failed';
-
- }
-
- if (!empty($this->errors)) {
- return false;
- }
- return true;
- } else {
- $this->errors[] = 'WriteID3v2() failed: !is_writeable('.$this->filename.')';
- }
- return false;
- }
-
- /**
- * @return bool
- */
- public function RemoveID3v2() {
- // File MUST be writeable - CHMOD(646) at least. It's best if the
- // directory is also writeable, because that method is both faster and less susceptible to errors.
- if (getID3::is_writable(dirname($this->filename))) {
-
- // preferred method - only one copying operation, minimal chance of corrupting
- // original file if script is interrupted, but required directory to be writeable
- if (is_readable($this->filename) && is_file($this->filename) && ($fp_source = fopen($this->filename, 'rb'))) {
-
- // Initialize getID3 engine
- $getID3 = new getID3;
- $OldThisFileInfo = $getID3->analyze($this->filename);
- if (!getid3_lib::intValueSupported($OldThisFileInfo['filesize'])) {
- $this->errors[] = 'Unable to remove ID3v2 because file is larger than '.round(PHP_INT_MAX / 1073741824).'GB';
- fclose($fp_source);
- return false;
- }
- rewind($fp_source);
- if ($OldThisFileInfo['avdataoffset'] !== false) {
- fseek($fp_source, $OldThisFileInfo['avdataoffset']);
- }
- if (getID3::is_writable($this->filename) && is_file($this->filename) && ($fp_temp = fopen($this->filename.'getid3tmp', 'w+b'))) {
- while ($buffer = fread($fp_source, $this->fread_buffer_size)) {
- fwrite($fp_temp, $buffer, strlen($buffer));
- }
- fclose($fp_temp);
- } else {
- $this->errors[] = 'Could not fopen("'.$this->filename.'getid3tmp", "w+b")';
- }
- fclose($fp_source);
- } else {
- $this->errors[] = 'Could not fopen("'.$this->filename.'", "rb")';
- }
- if (file_exists($this->filename)) {
- unlink($this->filename);
- }
- rename($this->filename.'getid3tmp', $this->filename);
-
- } elseif (getID3::is_writable($this->filename)) {
-
- // less desirable alternate method - double-copies the file, overwrites original file
- // and could corrupt source file if the script is interrupted or an error occurs.
- if (is_readable($this->filename) && is_file($this->filename) && ($fp_source = fopen($this->filename, 'rb'))) {
-
- // Initialize getID3 engine
- $getID3 = new getID3;
- $OldThisFileInfo = $getID3->analyze($this->filename);
- if (!getid3_lib::intValueSupported($OldThisFileInfo['filesize'])) {
- $this->errors[] = 'Unable to remove ID3v2 because file is larger than '.round(PHP_INT_MAX / 1073741824).'GB';
- fclose($fp_source);
- return false;
- }
- rewind($fp_source);
- if ($OldThisFileInfo['avdataoffset'] !== false) {
- fseek($fp_source, $OldThisFileInfo['avdataoffset']);
- }
- if ($fp_temp = tmpfile()) {
- while ($buffer = fread($fp_source, $this->fread_buffer_size)) {
- fwrite($fp_temp, $buffer, strlen($buffer));
- }
- fclose($fp_source);
- if (getID3::is_writable($this->filename) && is_file($this->filename) && ($fp_source = fopen($this->filename, 'wb'))) {
- rewind($fp_temp);
- while ($buffer = fread($fp_temp, $this->fread_buffer_size)) {
- fwrite($fp_source, $buffer, strlen($buffer));
- }
- fseek($fp_temp, -128, SEEK_END);
- fclose($fp_source);
- } else {
- $this->errors[] = 'Could not fopen("'.$this->filename.'", "wb")';
- }
- fclose($fp_temp);
- } else {
- $this->errors[] = 'Could not create tmpfile()';
- }
- } else {
- $this->errors[] = 'Could not fopen("'.$this->filename.'", "rb")';
- }
-
- } else {
-
- $this->errors[] = 'Directory and file both not writeable';
-
- }
-
- if (!empty($this->errors)) {
- return false;
- }
- return true;
- }
-
- /**
- * @param array $flags
- *
- * @return string|false
- */
- public function GenerateID3v2TagFlags($flags) {
- $flag = null;
- switch ($this->majorversion) {
- case 4:
- // %abcd0000
- $flag = (!empty($flags['unsynchronisation']) ? '1' : '0'); // a - Unsynchronisation
- $flag .= (!empty($flags['extendedheader'] ) ? '1' : '0'); // b - Extended header
- $flag .= (!empty($flags['experimental'] ) ? '1' : '0'); // c - Experimental indicator
- $flag .= (!empty($flags['footer'] ) ? '1' : '0'); // d - Footer present
- $flag .= '0000';
- break;
-
- case 3:
- // %abc00000
- $flag = (!empty($flags['unsynchronisation']) ? '1' : '0'); // a - Unsynchronisation
- $flag .= (!empty($flags['extendedheader'] ) ? '1' : '0'); // b - Extended header
- $flag .= (!empty($flags['experimental'] ) ? '1' : '0'); // c - Experimental indicator
- $flag .= '00000';
- break;
-
- case 2:
- // %ab000000
- $flag = (!empty($flags['unsynchronisation']) ? '1' : '0'); // a - Unsynchronisation
- $flag .= (!empty($flags['compression'] ) ? '1' : '0'); // b - Compression
- $flag .= '000000';
- break;
-
- default:
- return false;
- }
- return chr(bindec($flag));
- }
-
- /**
- * @param bool $TagAlter
- * @param bool $FileAlter
- * @param bool $ReadOnly
- * @param bool $Compression
- * @param bool $Encryption
- * @param bool $GroupingIdentity
- * @param bool $Unsynchronisation
- * @param bool $DataLengthIndicator
- *
- * @return string|false
- */
- public function GenerateID3v2FrameFlags($TagAlter=false, $FileAlter=false, $ReadOnly=false, $Compression=false, $Encryption=false, $GroupingIdentity=false, $Unsynchronisation=false, $DataLengthIndicator=false) {
- $flag1 = null;
- $flag2 = null;
- switch ($this->majorversion) {
- case 4:
- // %0abc0000 %0h00kmnp
- $flag1 = '0';
- $flag1 .= $TagAlter ? '1' : '0'; // a - Tag alter preservation (true == discard)
- $flag1 .= $FileAlter ? '1' : '0'; // b - File alter preservation (true == discard)
- $flag1 .= $ReadOnly ? '1' : '0'; // c - Read only (true == read only)
- $flag1 .= '0000';
-
- $flag2 = '0';
- $flag2 .= $GroupingIdentity ? '1' : '0'; // h - Grouping identity (true == contains group information)
- $flag2 .= '00';
- $flag2 .= $Compression ? '1' : '0'; // k - Compression (true == compressed)
- $flag2 .= $Encryption ? '1' : '0'; // m - Encryption (true == encrypted)
- $flag2 .= $Unsynchronisation ? '1' : '0'; // n - Unsynchronisation (true == unsynchronised)
- $flag2 .= $DataLengthIndicator ? '1' : '0'; // p - Data length indicator (true == data length indicator added)
- break;
-
- case 3:
- // %abc00000 %ijk00000
- $flag1 = $TagAlter ? '1' : '0'; // a - Tag alter preservation (true == discard)
- $flag1 .= $FileAlter ? '1' : '0'; // b - File alter preservation (true == discard)
- $flag1 .= $ReadOnly ? '1' : '0'; // c - Read only (true == read only)
- $flag1 .= '00000';
-
- $flag2 = $Compression ? '1' : '0'; // i - Compression (true == compressed)
- $flag2 .= $Encryption ? '1' : '0'; // j - Encryption (true == encrypted)
- $flag2 .= $GroupingIdentity ? '1' : '0'; // k - Grouping identity (true == contains group information)
- $flag2 .= '00000';
- break;
-
- default:
- return false;
-
- }
- return chr(bindec($flag1)).chr(bindec($flag2));
- }
-
- /**
- * @param string $frame_name
- * @param array $source_data_array
- *
- * @return string|false
- */
- public function GenerateID3v2FrameData($frame_name, $source_data_array) {
- if (!getid3_id3v2::IsValidID3v2FrameName($frame_name, $this->majorversion)) {
- return false;
- }
- $framedata = '';
-
- if (($this->majorversion < 3) || ($this->majorversion > 4)) {
-
- $this->errors[] = 'Only ID3v2.3 and ID3v2.4 are supported in GenerateID3v2FrameData()';
-
- } else { // $this->majorversion 3 or 4
-
- switch ($frame_name) {
- case 'UFID':
- // 4.1 UFID Unique file identifier
- // Owner identifier <text string> $00
- // Identifier <up to 64 bytes binary data>
- if (strlen($source_data_array['data']) > 64) {
- $this->errors[] = 'Identifier not allowed to be longer than 64 bytes in '.$frame_name.' (supplied data was '.strlen($source_data_array['data']).' bytes long)';
- } else {
- $framedata .= str_replace("\x00", '', $source_data_array['ownerid'])."\x00";
- $framedata .= substr($source_data_array['data'], 0, 64); // max 64 bytes - truncate anything longer
- }
- break;
-
- case 'TXXX':
- // 4.2.2 TXXX User defined text information frame
- // Text encoding $xx
- // Description <text string according to encoding> $00 (00)
- // Value <text string according to encoding>
- $source_data_array['encodingid'] = (isset($source_data_array['encodingid']) ? $source_data_array['encodingid'] : $this->id3v2_default_encodingid);
- if (!$this->ID3v2IsValidTextEncoding($source_data_array['encodingid'])) {
- $this->errors[] = 'Invalid Text Encoding in '.$frame_name.' ('.$source_data_array['encodingid'].') for ID3v2.'.$this->majorversion;
- } else {
- $framedata .= chr($source_data_array['encodingid']);
- $framedata .= $source_data_array['description'].getid3_id3v2::TextEncodingTerminatorLookup($source_data_array['encodingid']);
- $framedata .= $source_data_array['data'];
- }
- break;
-
- case 'WXXX':
- // 4.3.2 WXXX User defined URL link frame
- // Text encoding $xx
- // Description <text string according to encoding> $00 (00)
- // URL <text string>
- $source_data_array['encodingid'] = (isset($source_data_array['encodingid']) ? $source_data_array['encodingid'] : $this->id3v2_default_encodingid);
- if (!$this->ID3v2IsValidTextEncoding($source_data_array['encodingid'])) {
- $this->errors[] = 'Invalid Text Encoding in '.$frame_name.' ('.$source_data_array['encodingid'].') for ID3v2.'.$this->majorversion;
- } elseif (!isset($source_data_array['data']) || !$this->IsValidURL($source_data_array['data'], false)) {
- //$this->errors[] = 'Invalid URL in '.$frame_name.' ('.$source_data_array['data'].')';
- // probably should be an error, need to rewrite IsValidURL() to handle other encodings
- $this->warnings[] = 'Invalid URL in '.$frame_name.' ('.$source_data_array['data'].')';
- } else {
- $framedata .= chr($source_data_array['encodingid']);
- $framedata .= $source_data_array['description'].getid3_id3v2::TextEncodingTerminatorLookup($source_data_array['encodingid']);
- $framedata .= $source_data_array['data'];
- }
- break;
-
- case 'IPLS':
- // 4.4 IPLS Involved people list (ID3v2.3 only)
- // Text encoding $xx
- // People list strings <textstrings>
- $source_data_array['encodingid'] = (isset($source_data_array['encodingid']) ? $source_data_array['encodingid'] : $this->id3v2_default_encodingid);
- if (!$this->ID3v2IsValidTextEncoding($source_data_array['encodingid'])) {
- $this->errors[] = 'Invalid Text Encoding in '.$frame_name.' ('.$source_data_array['encodingid'].') for ID3v2.'.$this->majorversion;
- } else {
- $framedata .= chr($source_data_array['encodingid']);
- $framedata .= $source_data_array['data'];
- }
- break;
-
- case 'MCDI':
- // 4.4 MCDI Music CD identifier
- // CD TOC <binary data>
- $framedata .= $source_data_array['data'];
- break;
-
- case 'ETCO':
- // 4.5 ETCO Event timing codes
- // Time stamp format $xx
- // Where time stamp format is:
- // $01 (32-bit value) MPEG frames from beginning of file
- // $02 (32-bit value) milliseconds from beginning of file
- // Followed by a list of key events in the following format:
- // Type of event $xx
- // Time stamp $xx (xx ...)
- // The 'Time stamp' is set to zero if directly at the beginning of the sound
- // or after the previous event. All events MUST be sorted in chronological order.
- if (($source_data_array['timestampformat'] > 2) || ($source_data_array['timestampformat'] < 1)) {
- $this->errors[] = 'Invalid Time Stamp Format byte in '.$frame_name.' ('.$source_data_array['timestampformat'].')';
- } else {
- $framedata .= chr($source_data_array['timestampformat']);
- foreach ($source_data_array as $key => $val) {
- if (!$this->ID3v2IsValidETCOevent($val['typeid'])) {
- $this->errors[] = 'Invalid Event Type byte in '.$frame_name.' ('.$val['typeid'].')';
- } elseif (($key != 'timestampformat') && ($key != 'flags')) {
- if (($val['timestamp'] > 0) && isset($previousETCOtimestamp) && ($previousETCOtimestamp >= $val['timestamp'])) {
- // The 'Time stamp' is set to zero if directly at the beginning of the sound
- // or after the previous event. All events MUST be sorted in chronological order.
- $this->errors[] = 'Out-of-order timestamp in '.$frame_name.' ('.$val['timestamp'].') for Event Type ('.$val['typeid'].')';
- } else {
- $framedata .= chr($val['typeid']);
- $framedata .= getid3_lib::BigEndian2String($val['timestamp'], 4, false);
- $previousETCOtimestamp = $val['timestamp'];
- }
- }
- }
- }
- break;
-
- case 'MLLT':
- // 4.6 MLLT MPEG location lookup table
- // MPEG frames between reference $xx xx
- // Bytes between reference $xx xx xx
- // Milliseconds between reference $xx xx xx
- // Bits for bytes deviation $xx
- // Bits for milliseconds dev. $xx
- // Then for every reference the following data is included;
- // Deviation in bytes %xxx....
- // Deviation in milliseconds %xxx....
- if (($source_data_array['framesbetweenreferences'] > 0) && ($source_data_array['framesbetweenreferences'] <= 65535)) {
- $framedata .= getid3_lib::BigEndian2String($source_data_array['framesbetweenreferences'], 2, false);
- } else {
- $this->errors[] = 'Invalid MPEG Frames Between References in '.$frame_name.' ('.$source_data_array['framesbetweenreferences'].')';
- }
- if (($source_data_array['bytesbetweenreferences'] > 0) && ($source_data_array['bytesbetweenreferences'] <= 16777215)) {
- $framedata .= getid3_lib::BigEndian2String($source_data_array['bytesbetweenreferences'], 3, false);
- } else {
- $this->errors[] = 'Invalid bytes Between References in '.$frame_name.' ('.$source_data_array['bytesbetweenreferences'].')';
- }
- if (($source_data_array['msbetweenreferences'] > 0) && ($source_data_array['msbetweenreferences'] <= 16777215)) {
- $framedata .= getid3_lib::BigEndian2String($source_data_array['msbetweenreferences'], 3, false);
- } else {
- $this->errors[] = 'Invalid Milliseconds Between References in '.$frame_name.' ('.$source_data_array['msbetweenreferences'].')';
- }
- if (!$this->IsWithinBitRange($source_data_array['bitsforbytesdeviation'], 8, false)) {
- if (($source_data_array['bitsforbytesdeviation'] % 4) == 0) {
- $framedata .= chr($source_data_array['bitsforbytesdeviation']);
- } else {
- $this->errors[] = 'Bits For Bytes Deviation in '.$frame_name.' ('.$source_data_array['bitsforbytesdeviation'].') must be a multiple of 4.';
- }
- } else {
- $this->errors[] = 'Invalid Bits For Bytes Deviation in '.$frame_name.' ('.$source_data_array['bitsforbytesdeviation'].')';
- }
- if (!$this->IsWithinBitRange($source_data_array['bitsformsdeviation'], 8, false)) {
- if (($source_data_array['bitsformsdeviation'] % 4) == 0) {
- $framedata .= chr($source_data_array['bitsformsdeviation']);
- } else {
- $this->errors[] = 'Bits For Milliseconds Deviation in '.$frame_name.' ('.$source_data_array['bitsforbytesdeviation'].') must be a multiple of 4.';
- }
- } else {
- $this->errors[] = 'Invalid Bits For Milliseconds Deviation in '.$frame_name.' ('.$source_data_array['bitsformsdeviation'].')';
- }
- $unwrittenbitstream = '';
- foreach ($source_data_array as $key => $val) {
- if (($key != 'framesbetweenreferences') && ($key != 'bytesbetweenreferences') && ($key != 'msbetweenreferences') && ($key != 'bitsforbytesdeviation') && ($key != 'bitsformsdeviation') && ($key != 'flags')) {
- $unwrittenbitstream .= str_pad(getid3_lib::Dec2Bin($val['bytedeviation']), $source_data_array['bitsforbytesdeviation'], '0', STR_PAD_LEFT);
- $unwrittenbitstream .= str_pad(getid3_lib::Dec2Bin($val['msdeviation']), $source_data_array['bitsformsdeviation'], '0', STR_PAD_LEFT);
- }
- }
- for ($i = 0; $i < strlen($unwrittenbitstream); $i += 8) {
- $highnibble = bindec(substr($unwrittenbitstream, $i, 4)) << 4;
- $lownibble = bindec(substr($unwrittenbitstream, $i + 4, 4));
- $framedata .= chr($highnibble & $lownibble);
- }
- break;
-
- case 'SYTC':
- // 4.7 SYTC Synchronised tempo codes
- // Time stamp format $xx
- // Tempo data <binary data>
- // Where time stamp format is:
- // $01 (32-bit value) MPEG frames from beginning of file
- // $02 (32-bit value) milliseconds from beginning of file
- if (($source_data_array['timestampformat'] > 2) || ($source_data_array['timestampformat'] < 1)) {
- $this->errors[] = 'Invalid Time Stamp Format byte in '.$frame_name.' ('.$source_data_array['timestampformat'].')';
- } else {
- $framedata .= chr($source_data_array['timestampformat']);
- foreach ($source_data_array as $key => $val) {
- if (!$this->ID3v2IsValidETCOevent($val['typeid'])) {
- $this->errors[] = 'Invalid Event Type byte in '.$frame_name.' ('.$val['typeid'].')';
- } elseif (($key != 'timestampformat') && ($key != 'flags')) {
- if (($val['tempo'] < 0) || ($val['tempo'] > 510)) {
- $this->errors[] = 'Invalid Tempo (max = 510) in '.$frame_name.' ('.$val['tempo'].') at timestamp ('.$val['timestamp'].')';
- } else {
- if ($val['tempo'] > 255) {
- $framedata .= chr(255);
- $val['tempo'] -= 255;
- }
- $framedata .= chr($val['tempo']);
- $framedata .= getid3_lib::BigEndian2String($val['timestamp'], 4, false);
- }
- }
- }
- }
- break;
-
- case 'USLT':
- // 4.8 USLT Unsynchronised lyric/text transcription
- // Text encoding $xx
- // Language $xx xx xx
- // Content descriptor <text string according to encoding> $00 (00)
- // Lyrics/text <full text string according to encoding>
- $source_data_array['encodingid'] = (isset($source_data_array['encodingid']) ? $source_data_array['encodingid'] : $this->id3v2_default_encodingid);
- if (!$this->ID3v2IsValidTextEncoding($source_data_array['encodingid'])) {
- $this->errors[] = 'Invalid Text Encoding in '.$frame_name.' ('.$source_data_array['encodingid'].') for ID3v2.'.$this->majorversion;
- } elseif (getid3_id3v2::LanguageLookup($source_data_array['language'], true) == '') {
- $this->errors[] = 'Invalid Language in '.$frame_name.' ('.$source_data_array['language'].')';
- } else {
- $framedata .= chr($source_data_array['encodingid']);
- $framedata .= strtolower($source_data_array['language']);
- $framedata .= $source_data_array['description'].getid3_id3v2::TextEncodingTerminatorLookup($source_data_array['encodingid']);
- $framedata .= $source_data_array['data'];
- }
- break;
-
- case 'SYLT':
- // 4.9 SYLT Synchronised lyric/text
- // Text encoding $xx
- // Language $xx xx xx
- // Time stamp format $xx
- // $01 (32-bit value) MPEG frames from beginning of file
- // $02 (32-bit value) milliseconds from beginning of file
- // Content type $xx
- // Content descriptor <text string according to encoding> $00 (00)
- // Terminated text to be synced (typically a syllable)
- // Sync identifier (terminator to above string) $00 (00)
- // Time stamp $xx (xx ...)
- $source_data_array['encodingid'] = (isset($source_data_array['encodingid']) ? $source_data_array['encodingid'] : $this->id3v2_default_encodingid);
- if (!$this->ID3v2IsValidTextEncoding($source_data_array['encodingid'])) {
- $this->errors[] = 'Invalid Text Encoding in '.$frame_name.' ('.$source_data_array['encodingid'].') for ID3v2.'.$this->majorversion;
- } elseif (getid3_id3v2::LanguageLookup($source_data_array['language'], true) == '') {
- $this->errors[] = 'Invalid Language in '.$frame_name.' ('.$source_data_array['language'].')';
- } elseif (($source_data_array['timestampformat'] > 2) || ($source_data_array['timestampformat'] < 1)) {
- $this->errors[] = 'Invalid Time Stamp Format byte in '.$frame_name.' ('.$source_data_array['timestampformat'].')';
- } elseif (!$this->ID3v2IsValidSYLTtype($source_data_array['contenttypeid'])) {
- $this->errors[] = 'Invalid Content Type byte in '.$frame_name.' ('.$source_data_array['contenttypeid'].')';
- } elseif (!is_array($source_data_array['data'])) {
- $this->errors[] = 'Invalid Lyric/Timestamp data in '.$frame_name.' (must be an array)';
- } else {
- $framedata .= chr($source_data_array['encodingid']);
- $framedata .= strtolower($source_data_array['language']);
- $framedata .= chr($source_data_array['timestampformat']);
- $framedata .= chr($source_data_array['contenttypeid']);
- $framedata .= $source_data_array['description'].getid3_id3v2::TextEncodingTerminatorLookup($source_data_array['encodingid']);
- ksort($source_data_array['data']);
- foreach ($source_data_array['data'] as $key => $val) {
- $framedata .= $val['data'].getid3_id3v2::TextEncodingTerminatorLookup($source_data_array['encodingid']);
- $framedata .= getid3_lib::BigEndian2String($val['timestamp'], 4, false);
- }
- }
- break;
-
- case 'COMM':
- // 4.10 COMM Comments
- // Text encoding $xx
- // Language $xx xx xx
- // Short content descrip. <text string according to encoding> $00 (00)
- // The actual text <full text string according to encoding>
- $source_data_array['encodingid'] = (isset($source_data_array['encodingid']) ? $source_data_array['encodingid'] : $this->id3v2_default_encodingid);
- if (!$this->ID3v2IsValidTextEncoding($source_data_array['encodingid'])) {
- $this->errors[] = 'Invalid Text Encoding in '.$frame_name.' ('.$source_data_array['encodingid'].') for ID3v2.'.$this->majorversion;
- } elseif (getid3_id3v2::LanguageLookup($source_data_array['language'], true) == '') {
- $this->errors[] = 'Invalid Language in '.$frame_name.' ('.$source_data_array['language'].')';
- } else {
- $framedata .= chr($source_data_array['encodingid']);
- $framedata .= strtolower($source_data_array['language']);
- $framedata .= $source_data_array['description'].getid3_id3v2::TextEncodingTerminatorLookup($source_data_array['encodingid']);
- $framedata .= $source_data_array['data'];
- }
- break;
-
- case 'RVA2':
- // 4.11 RVA2 Relative volume adjustment (2) (ID3v2.4+ only)
- // Identification <text string> $00
- // The 'identification' string is used to identify the situation and/or
- // device where this adjustment should apply. The following is then
- // repeated for every channel:
- // Type of channel $xx
- // Volume adjustment $xx xx
- // Bits representing peak $xx
- // Peak volume $xx (xx ...)
- $framedata .= str_replace("\x00", '', $source_data_array['description'])."\x00";
- foreach ($source_data_array as $key => $val) {
- if ($key != 'description') {
- $framedata .= chr($val['channeltypeid']);
- $framedata .= getid3_lib::BigEndian2String($val['volumeadjust'], 2, false, true); // signed 16-bit
- if (!$this->IsWithinBitRange($source_data_array['bitspeakvolume'], 8, false)) {
- $framedata .= chr($val['bitspeakvolume']);
- if ($val['bitspeakvolume'] > 0) {
- $framedata .= getid3_lib::BigEndian2String($val['peakvolume'], ceil($val['bitspeakvolume'] / 8), false, false);
- }
- } else {
- $this->errors[] = 'Invalid Bits Representing Peak Volume in '.$frame_name.' ('.$val['bitspeakvolume'].') (range = 0 to 255)';
- }
- }
- }
- break;
-
- case 'RVAD':
- // 4.12 RVAD Relative volume adjustment (ID3v2.3 only)
- // Increment/decrement %00fedcba
- // Bits used for volume descr. $xx
- // Relative volume change, right $xx xx (xx ...) // a
- // Relative volume change, left $xx xx (xx ...) // b
- // Peak volume right $xx xx (xx ...)
- // Peak volume left $xx xx (xx ...)
- // Relative volume change, right back $xx xx (xx ...) // c
- // Relative volume change, left back $xx xx (xx ...) // d
- // Peak volume right back $xx xx (xx ...)
- // Peak volume left back $xx xx (xx ...)
- // Relative volume change, center $xx xx (xx ...) // e
- // Peak volume center $xx xx (xx ...)
- // Relative volume change, bass $xx xx (xx ...) // f
- // Peak volume bass $xx xx (xx ...)
- if (!$this->IsWithinBitRange($source_data_array['bitsvolume'], 8, false)) {
- $this->errors[] = 'Invalid Bits For Volume Description byte in '.$frame_name.' ('.$source_data_array['bitsvolume'].') (range = 1 to 255)';
- } else {
- $incdecflag = '00';
- $incdecflag .= $source_data_array['incdec']['right'] ? '1' : '0'; // a - Relative volume change, right
- $incdecflag .= $source_data_array['incdec']['left'] ? '1' : '0'; // b - Relative volume change, left
- $incdecflag .= $source_data_array['incdec']['rightrear'] ? '1' : '0'; // c - Relative volume change, right back
- $incdecflag .= $source_data_array['incdec']['leftrear'] ? '1' : '0'; // d - Relative volume change, left back
- $incdecflag .= $source_data_array['incdec']['center'] ? '1' : '0'; // e - Relative volume change, center
- $incdecflag .= $source_data_array['incdec']['bass'] ? '1' : '0'; // f - Relative volume change, bass
- $framedata .= chr(bindec($incdecflag));
- $framedata .= chr($source_data_array['bitsvolume']);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['volumechange']['right'], ceil($source_data_array['bitsvolume'] / 8), false);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['volumechange']['left'], ceil($source_data_array['bitsvolume'] / 8), false);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['peakvolume']['right'], ceil($source_data_array['bitsvolume'] / 8), false);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['peakvolume']['left'], ceil($source_data_array['bitsvolume'] / 8), false);
- if ($source_data_array['volumechange']['rightrear'] || $source_data_array['volumechange']['leftrear'] ||
- $source_data_array['peakvolume']['rightrear'] || $source_data_array['peakvolume']['leftrear'] ||
- $source_data_array['volumechange']['center'] || $source_data_array['peakvolume']['center'] ||
- $source_data_array['volumechange']['bass'] || $source_data_array['peakvolume']['bass']) {
- $framedata .= getid3_lib::BigEndian2String($source_data_array['volumechange']['rightrear'], ceil($source_data_array['bitsvolume']/8), false);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['volumechange']['leftrear'], ceil($source_data_array['bitsvolume']/8), false);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['peakvolume']['rightrear'], ceil($source_data_array['bitsvolume']/8), false);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['peakvolume']['leftrear'], ceil($source_data_array['bitsvolume']/8), false);
- }
- if ($source_data_array['volumechange']['center'] || $source_data_array['peakvolume']['center'] ||
- $source_data_array['volumechange']['bass'] || $source_data_array['peakvolume']['bass']) {
- $framedata .= getid3_lib::BigEndian2String($source_data_array['volumechange']['center'], ceil($source_data_array['bitsvolume']/8), false);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['peakvolume']['center'], ceil($source_data_array['bitsvolume']/8), false);
- }
- if ($source_data_array['volumechange']['bass'] || $source_data_array['peakvolume']['bass']) {
- $framedata .= getid3_lib::BigEndian2String($source_data_array['volumechange']['bass'], ceil($source_data_array['bitsvolume']/8), false);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['peakvolume']['bass'], ceil($source_data_array['bitsvolume']/8), false);
- }
- }
- break;
-
- case 'EQU2':
- // 4.12 EQU2 Equalisation (2) (ID3v2.4+ only)
- // Interpolation method $xx
- // $00 Band
- // $01 Linear
- // Identification <text string> $00
- // The following is then repeated for every adjustment point
- // Frequency $xx xx
- // Volume adjustment $xx xx
- if (($source_data_array['interpolationmethod'] < 0) || ($source_data_array['interpolationmethod'] > 1)) {
- $this->errors[] = 'Invalid Interpolation Method byte in '.$frame_name.' ('.$source_data_array['interpolationmethod'].') (valid = 0 or 1)';
- } else {
- $framedata .= chr($source_data_array['interpolationmethod']);
- $framedata .= str_replace("\x00", '', $source_data_array['description'])."\x00";
- foreach ($source_data_array['data'] as $key => $val) {
- $framedata .= getid3_lib::BigEndian2String(intval(round($key * 2)), 2, false);
- $framedata .= getid3_lib::BigEndian2String($val, 2, false, true); // signed 16-bit
- }
- }
- break;
-
- case 'EQUA':
- // 4.12 EQUA Equalisation (ID3v2.3 only)
- // Adjustment bits $xx
- // This is followed by 2 bytes + ('adjustment bits' rounded up to the
- // nearest byte) for every equalisation band in the following format,
- // giving a frequency range of 0 - 32767Hz:
- // Increment/decrement %x (MSB of the Frequency)
- // Frequency (lower 15 bits)
- // Adjustment $xx (xx ...)
- if (!$this->IsWithinBitRange($source_data_array['bitsvolume'], 8, false)) {
- $this->errors[] = 'Invalid Adjustment Bits byte in '.$frame_name.' ('.$source_data_array['bitsvolume'].') (range = 1 to 255)';
- } else {
- $framedata .= chr($source_data_array['adjustmentbits']);
- foreach ($source_data_array as $key => $val) {
- if ($key != 'bitsvolume') {
- if (($key > 32767) || ($key < 0)) {
- $this->errors[] = 'Invalid Frequency in '.$frame_name.' ('.$key.') (range = 0 to 32767)';
- } else {
- if ($val >= 0) {
- // put MSB of frequency to 1 if increment, 0 if decrement
- $key |= 0x8000;
- }
- $framedata .= getid3_lib::BigEndian2String($key, 2, false);
- $framedata .= getid3_lib::BigEndian2String($val, ceil($source_data_array['adjustmentbits'] / 8), false);
- }
- }
- }
- }
- break;
-
- case 'RVRB':
- // 4.13 RVRB Reverb
- // Reverb left (ms) $xx xx
- // Reverb right (ms) $xx xx
- // Reverb bounces, left $xx
- // Reverb bounces, right $xx
- // Reverb feedback, left to left $xx
- // Reverb feedback, left to right $xx
- // Reverb feedback, right to right $xx
- // Reverb feedback, right to left $xx
- // Premix left to right $xx
- // Premix right to left $xx
- if (!$this->IsWithinBitRange($source_data_array['left'], 16, false)) {
- $this->errors[] = 'Invalid Reverb Left in '.$frame_name.' ('.$source_data_array['left'].') (range = 0 to 65535)';
- } elseif (!$this->IsWithinBitRange($source_data_array['right'], 16, false)) {
- $this->errors[] = 'Invalid Reverb Left in '.$frame_name.' ('.$source_data_array['right'].') (range = 0 to 65535)';
- } elseif (!$this->IsWithinBitRange($source_data_array['bouncesL'], 8, false)) {
- $this->errors[] = 'Invalid Reverb Bounces, Left in '.$frame_name.' ('.$source_data_array['bouncesL'].') (range = 0 to 255)';
- } elseif (!$this->IsWithinBitRange($source_data_array['bouncesR'], 8, false)) {
- $this->errors[] = 'Invalid Reverb Bounces, Right in '.$frame_name.' ('.$source_data_array['bouncesR'].') (range = 0 to 255)';
- } elseif (!$this->IsWithinBitRange($source_data_array['feedbackLL'], 8, false)) {
- $this->errors[] = 'Invalid Reverb Feedback, Left-To-Left in '.$frame_name.' ('.$source_data_array['feedbackLL'].') (range = 0 to 255)';
- } elseif (!$this->IsWithinBitRange($source_data_array['feedbackLR'], 8, false)) {
- $this->errors[] = 'Invalid Reverb Feedback, Left-To-Right in '.$frame_name.' ('.$source_data_array['feedbackLR'].') (range = 0 to 255)';
- } elseif (!$this->IsWithinBitRange($source_data_array['feedbackRR'], 8, false)) {
- $this->errors[] = 'Invalid Reverb Feedback, Right-To-Right in '.$frame_name.' ('.$source_data_array['feedbackRR'].') (range = 0 to 255)';
- } elseif (!$this->IsWithinBitRange($source_data_array['feedbackRL'], 8, false)) {
- $this->errors[] = 'Invalid Reverb Feedback, Right-To-Left in '.$frame_name.' ('.$source_data_array['feedbackRL'].') (range = 0 to 255)';
- } elseif (!$this->IsWithinBitRange($source_data_array['premixLR'], 8, false)) {
- $this->errors[] = 'Invalid Premix, Left-To-Right in '.$frame_name.' ('.$source_data_array['premixLR'].') (range = 0 to 255)';
- } elseif (!$this->IsWithinBitRange($source_data_array['premixRL'], 8, false)) {
- $this->errors[] = 'Invalid Premix, Right-To-Left in '.$frame_name.' ('.$source_data_array['premixRL'].') (range = 0 to 255)';
- } else {
- $framedata .= getid3_lib::BigEndian2String($source_data_array['left'], 2, false);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['right'], 2, false);
- $framedata .= chr($source_data_array['bouncesL']);
- $framedata .= chr($source_data_array['bouncesR']);
- $framedata .= chr($source_data_array['feedbackLL']);
- $framedata .= chr($source_data_array['feedbackLR']);
- $framedata .= chr($source_data_array['feedbackRR']);
- $framedata .= chr($source_data_array['feedbackRL']);
- $framedata .= chr($source_data_array['premixLR']);
- $framedata .= chr($source_data_array['premixRL']);
- }
- break;
-
- case 'APIC':
- // 4.14 APIC Attached picture
- // Text encoding $xx
- // MIME type <text string> $00
- // Picture type $xx
- // Description <text string according to encoding> $00 (00)
- // Picture data <binary data>
- $source_data_array['encodingid'] = (isset($source_data_array['encodingid']) ? $source_data_array['encodingid'] : $this->id3v2_default_encodingid);
- if (!$this->ID3v2IsValidTextEncoding($source_data_array['encodingid'])) {
- $this->errors[] = 'Invalid Text Encoding in '.$frame_name.' ('.$source_data_array['encodingid'].') for ID3v2.'.$this->majorversion;
- } elseif (!$this->ID3v2IsValidAPICpicturetype($source_data_array['picturetypeid'])) {
- $this->errors[] = 'Invalid Picture Type byte in '.$frame_name.' ('.$source_data_array['picturetypeid'].') for ID3v2.'.$this->majorversion;
- } elseif ((!$this->ID3v2IsValidAPICimageformat($source_data_array['mime']))) {
- $this->errors[] = 'Invalid MIME Type in '.$frame_name.' ('.$source_data_array['mime'].') for ID3v2.'.$this->majorversion;
- } elseif (($source_data_array['mime'] == '-->') && (!$this->IsValidURL($source_data_array['data'], false))) {
- //$this->errors[] = 'Invalid URL in '.$frame_name.' ('.$source_data_array['data'].')';
- // probably should be an error, need to rewrite IsValidURL() to handle other encodings
- $this->warnings[] = 'Invalid URL in '.$frame_name.' ('.$source_data_array['data'].')';
- } else {
- $framedata .= chr($source_data_array['encodingid']);
- $framedata .= str_replace("\x00", '', $source_data_array['mime'])."\x00";
- $framedata .= chr($source_data_array['picturetypeid']);
- $framedata .= (!empty($source_data_array['description']) ? $source_data_array['description'] : '').getid3_id3v2::TextEncodingTerminatorLookup($source_data_array['encodingid']);
- $framedata .= $source_data_array['data'];
- }
- break;
-
- case 'GEOB':
- // 4.15 GEOB General encapsulated object
- // Text encoding $xx
- // MIME type <text string> $00
- // Filename <text string according to encoding> $00 (00)
- // Content description <text string according to encoding> $00 (00)
- // Encapsulated object <binary data>
- $source_data_array['encodingid'] = (isset($source_data_array['encodingid']) ? $source_data_array['encodingid'] : $this->id3v2_default_encodingid);
- if (!$this->ID3v2IsValidTextEncoding($source_data_array['encodingid'])) {
- $this->errors[] = 'Invalid Text Encoding in '.$frame_name.' ('.$source_data_array['encodingid'].') for ID3v2.'.$this->majorversion;
- } elseif (!$this->IsValidMIMEstring($source_data_array['mime'])) {
- $this->errors[] = 'Invalid MIME Type in '.$frame_name.' ('.$source_data_array['mime'].')';
- } elseif (!$source_data_array['description']) {
- $this->errors[] = 'Missing Description in '.$frame_name;
- } else {
- $framedata .= chr($source_data_array['encodingid']);
- $framedata .= str_replace("\x00", '', $source_data_array['mime'])."\x00";
- $framedata .= $source_data_array['filename'].getid3_id3v2::TextEncodingTerminatorLookup($source_data_array['encodingid']);
- $framedata .= $source_data_array['description'].getid3_id3v2::TextEncodingTerminatorLookup($source_data_array['encodingid']);
- $framedata .= $source_data_array['data'];
- }
- break;
-
- case 'PCNT':
- // 4.16 PCNT Play counter
- // When the counter reaches all one's, one byte is inserted in
- // front of the counter thus making the counter eight bits bigger
- // Counter $xx xx xx xx (xx ...)
- $framedata .= getid3_lib::BigEndian2String($source_data_array['data'], 4, false);
- break;
-
- case 'POPM':
- // 4.17 POPM Popularimeter
- // When the counter reaches all one's, one byte is inserted in
- // front of the counter thus making the counter eight bits bigger
- // Email to user <text string> $00
- // Rating $xx
- // Counter $xx xx xx xx (xx ...)
- if (!$this->IsValidEmail($source_data_array['email'])) {
- // https://github.com/JamesHeinrich/getID3/issues/216
- // https://en.wikipedia.org/wiki/ID3#ID3v2_rating_tag_issue
- // ID3v2 specs say it should be an email address, but Windows instead uses string like "Windows Media Player 9 Series"
- $this->warnings[] = 'Invalid Email in '.$frame_name.' ('.$source_data_array['email'].')';
- }
- if (!$this->IsWithinBitRange($source_data_array['rating'], 8, false)) {
- $this->errors[] = 'Invalid Rating byte in '.$frame_name.' ('.$source_data_array['rating'].') (range = 0 to 255)';
- } else {
- $framedata .= str_replace("\x00", '', $source_data_array['email'])."\x00";
- $framedata .= chr($source_data_array['rating']);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['data'], 4, false);
- }
- break;
-
- case 'RBUF':
- // 4.18 RBUF Recommended buffer size
- // Buffer size $xx xx xx
- // Embedded info flag %0000000x
- // Offset to next tag $xx xx xx xx
- if (!$this->IsWithinBitRange($source_data_array['buffersize'], 24, false)) {
- $this->errors[] = 'Invalid Buffer Size in '.$frame_name;
- } elseif (!$this->IsWithinBitRange($source_data_array['nexttagoffset'], 32, false)) {
- $this->errors[] = 'Invalid Offset To Next Tag in '.$frame_name;
- } else {
- $framedata .= getid3_lib::BigEndian2String($source_data_array['buffersize'], 3, false);
- $flag = '0000000';
- $flag .= $source_data_array['flags']['embededinfo'] ? '1' : '0';
- $framedata .= chr(bindec($flag));
- $framedata .= getid3_lib::BigEndian2String($source_data_array['nexttagoffset'], 4, false);
- }
- break;
-
- case 'AENC':
- // 4.19 AENC Audio encryption
- // Owner identifier <text string> $00
- // Preview start $xx xx
- // Preview length $xx xx
- // Encryption info <binary data>
- if (!$this->IsWithinBitRange($source_data_array['previewstart'], 16, false)) {
- $this->errors[] = 'Invalid Preview Start in '.$frame_name.' ('.$source_data_array['previewstart'].')';
- } elseif (!$this->IsWithinBitRange($source_data_array['previewlength'], 16, false)) {
- $this->errors[] = 'Invalid Preview Length in '.$frame_name.' ('.$source_data_array['previewlength'].')';
- } else {
- $framedata .= str_replace("\x00", '', $source_data_array['ownerid'])."\x00";
- $framedata .= getid3_lib::BigEndian2String($source_data_array['previewstart'], 2, false);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['previewlength'], 2, false);
- $framedata .= $source_data_array['encryptioninfo'];
- }
- break;
-
- case 'LINK':
- // 4.20 LINK Linked information
- // Frame identifier $xx xx xx xx
- // URL <text string> $00
- // ID and additional data <text string(s)>
- if (!getid3_id3v2::IsValidID3v2FrameName($source_data_array['frameid'], $this->majorversion)) {
- $this->errors[] = 'Invalid Frame Identifier in '.$frame_name.' ('.$source_data_array['frameid'].')';
- } elseif (!$this->IsValidURL($source_data_array['data'], true)) {
- //$this->errors[] = 'Invalid URL in '.$frame_name.' ('.$source_data_array['data'].')';
- // probably should be an error, need to rewrite IsValidURL() to handle other encodings
- $this->warnings[] = 'Invalid URL in '.$frame_name.' ('.$source_data_array['data'].')';
- } elseif ((($source_data_array['frameid'] == 'AENC') || ($source_data_array['frameid'] == 'APIC') || ($source_data_array['frameid'] == 'GEOB') || ($source_data_array['frameid'] == 'TXXX')) && ($source_data_array['additionaldata'] == '')) {
- $this->errors[] = 'Content Descriptor must be specified as additional data for Frame Identifier of '.$source_data_array['frameid'].' in '.$frame_name;
- } elseif (($source_data_array['frameid'] == 'USER') && (getid3_id3v2::LanguageLookup($source_data_array['additionaldata'], true) == '')) {
- $this->errors[] = 'Language must be specified as additional data for Frame Identifier of '.$source_data_array['frameid'].' in '.$frame_name;
- } elseif (($source_data_array['frameid'] == 'PRIV') && ($source_data_array['additionaldata'] == '')) {
- $this->errors[] = 'Owner Identifier must be specified as additional data for Frame Identifier of '.$source_data_array['frameid'].' in '.$frame_name;
- } elseif ((($source_data_array['frameid'] == 'COMM') || ($source_data_array['frameid'] == 'SYLT') || ($source_data_array['frameid'] == 'USLT')) && ((getid3_id3v2::LanguageLookup(substr($source_data_array['additionaldata'], 0, 3), true) == '') || (substr($source_data_array['additionaldata'], 3) == ''))) {
- $this->errors[] = 'Language followed by Content Descriptor must be specified as additional data for Frame Identifier of '.$source_data_array['frameid'].' in '.$frame_name;
- } else {
- $framedata .= $source_data_array['frameid'];
- $framedata .= str_replace("\x00", '', $source_data_array['data'])."\x00";
- switch ($source_data_array['frameid']) {
- case 'COMM':
- case 'SYLT':
- case 'USLT':
- case 'PRIV':
- case 'USER':
- case 'AENC':
- case 'APIC':
- case 'GEOB':
- case 'TXXX':
- $framedata .= $source_data_array['additionaldata'];
- break;
- case 'ASPI':
- case 'ETCO':
- case 'EQU2':
- case 'MCID':
- case 'MLLT':
- case 'OWNE':
- case 'RVA2':
- case 'RVRB':
- case 'SYTC':
- case 'IPLS':
- case 'RVAD':
- case 'EQUA':
- // no additional data required
- break;
- case 'RBUF':
- if ($this->majorversion == 3) {
- // no additional data required
- } else {
- $this->errors[] = $source_data_array['frameid'].' is not a valid Frame Identifier in '.$frame_name.' (in ID3v2.'.$this->majorversion.')';
- }
- break;
-
- default:
- if ((substr($source_data_array['frameid'], 0, 1) == 'T') || (substr($source_data_array['frameid'], 0, 1) == 'W')) {
- // no additional data required
- } else {
- $this->errors[] = $source_data_array['frameid'].' is not a valid Frame Identifier in '.$frame_name.' (in ID3v2.'.$this->majorversion.')';
- }
- break;
- }
- }
- break;
-
- case 'POSS':
- // 4.21 POSS Position synchronisation frame (ID3v2.3+ only)
- // Time stamp format $xx
- // Position $xx (xx ...)
- if (($source_data_array['timestampformat'] < 1) || ($source_data_array['timestampformat'] > 2)) {
- $this->errors[] = 'Invalid Time Stamp Format in '.$frame_name.' ('.$source_data_array['timestampformat'].') (valid = 1 or 2)';
- } elseif (!$this->IsWithinBitRange($source_data_array['position'], 32, false)) {
- $this->errors[] = 'Invalid Position in '.$frame_name.' ('.$source_data_array['position'].') (range = 0 to 4294967295)';
- } else {
- $framedata .= chr($source_data_array['timestampformat']);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['position'], 4, false);
- }
- break;
-
- case 'USER':
- // 4.22 USER Terms of use (ID3v2.3+ only)
- // Text encoding $xx
- // Language $xx xx xx
- // The actual text <text string according to encoding>
- $source_data_array['encodingid'] = (isset($source_data_array['encodingid']) ? $source_data_array['encodingid'] : $this->id3v2_default_encodingid);
- if (!$this->ID3v2IsValidTextEncoding($source_data_array['encodingid'])) {
- $this->errors[] = 'Invalid Text Encoding in '.$frame_name.' ('.$source_data_array['encodingid'].')';
- } elseif (getid3_id3v2::LanguageLookup($source_data_array['language'], true) == '') {
- $this->errors[] = 'Invalid Language in '.$frame_name.' ('.$source_data_array['language'].')';
- } else {
- $framedata .= chr($source_data_array['encodingid']);
- $framedata .= strtolower($source_data_array['language']);
- $framedata .= $source_data_array['data'];
- }
- break;
-
- case 'OWNE':
- // 4.23 OWNE Ownership frame (ID3v2.3+ only)
- // Text encoding $xx
- // Price paid <text string> $00
- // Date of purch. <text string>
- // Seller <text string according to encoding>
- $source_data_array['encodingid'] = (isset($source_data_array['encodingid']) ? $source_data_array['encodingid'] : $this->id3v2_default_encodingid);
- if (!$this->ID3v2IsValidTextEncoding($source_data_array['encodingid'])) {
- $this->errors[] = 'Invalid Text Encoding in '.$frame_name.' ('.$source_data_array['encodingid'].')';
- } elseif (!getid3_id3v2::IsANumber($source_data_array['pricepaid']['value'], false)) {
- $this->errors[] = 'Invalid Price Paid in '.$frame_name.' ('.$source_data_array['pricepaid']['value'].')';
- } elseif (!getid3_id3v2::IsValidDateStampString($source_data_array['purchasedate'])) {
- $this->errors[] = 'Invalid Date Of Purchase in '.$frame_name.' ('.$source_data_array['purchasedate'].') (format = YYYYMMDD)';
- } else {
- $framedata .= chr($source_data_array['encodingid']);
- $framedata .= str_replace("\x00", '', $source_data_array['pricepaid']['value'])."\x00";
- $framedata .= $source_data_array['purchasedate'];
- $framedata .= $source_data_array['seller'];
- }
- break;
-
- case 'COMR':
- // 4.24 COMR Commercial frame (ID3v2.3+ only)
- // Text encoding $xx
- // Price string <text string> $00
- // Valid until <text string>
- // Contact URL <text string> $00
- // Received as $xx
- // Name of seller <text string according to encoding> $00 (00)
- // Description <text string according to encoding> $00 (00)
- // Picture MIME type <string> $00
- // Seller logo <binary data>
- $source_data_array['encodingid'] = (isset($source_data_array['encodingid']) ? $source_data_array['encodingid'] : $this->id3v2_default_encodingid);
- if (!$this->ID3v2IsValidTextEncoding($source_data_array['encodingid'])) {
- $this->errors[] = 'Invalid Text Encoding in '.$frame_name.' ('.$source_data_array['encodingid'].')';
- } elseif (!getid3_id3v2::IsValidDateStampString($source_data_array['pricevaliduntil'])) {
- $this->errors[] = 'Invalid Valid Until date in '.$frame_name.' ('.$source_data_array['pricevaliduntil'].') (format = YYYYMMDD)';
- } elseif (!$this->IsValidURL($source_data_array['contacturl'], false)) {
- $this->errors[] = 'Invalid Contact URL in '.$frame_name.' ('.$source_data_array['contacturl'].') (allowed schemes: http, https, ftp, mailto)';
- } elseif (!$this->ID3v2IsValidCOMRreceivedAs($source_data_array['receivedasid'])) {
- $this->errors[] = 'Invalid Received As byte in '.$frame_name.' ('.$source_data_array['contacturl'].') (range = 0 to 8)';
- } elseif (!$this->IsValidMIMEstring($source_data_array['mime'])) {
- $this->errors[] = 'Invalid MIME Type in '.$frame_name.' ('.$source_data_array['mime'].')';
- } else {
- $framedata .= chr($source_data_array['encodingid']);
- $pricestrings = array();
- foreach ($source_data_array['price'] as $key => $val) {
- if ($this->ID3v2IsValidPriceString($key.$val['value'])) {
- $pricestrings[] = $key.$val['value'];
- } else {
- $this->errors[] = 'Invalid Price String in '.$frame_name.' ('.$key.$val['value'].')';
- }
- }
- $framedata .= implode('/', $pricestrings);
- $framedata .= $source_data_array['pricevaliduntil'];
- $framedata .= str_replace("\x00", '', $source_data_array['contacturl'])."\x00";
- $framedata .= chr($source_data_array['receivedasid']);
- $framedata .= $source_data_array['sellername'].getid3_id3v2::TextEncodingTerminatorLookup($source_data_array['encodingid']);
- $framedata .= $source_data_array['description'].getid3_id3v2::TextEncodingTerminatorLookup($source_data_array['encodingid']);
- $framedata .= $source_data_array['mime']."\x00";
- $framedata .= $source_data_array['logo'];
- }
- break;
-
- case 'ENCR':
- // 4.25 ENCR Encryption method registration (ID3v2.3+ only)
- // Owner identifier <text string> $00
- // Method symbol $xx
- // Encryption data <binary data>
- if (!$this->IsWithinBitRange($source_data_array['methodsymbol'], 8, false)) {
- $this->errors[] = 'Invalid Group Symbol in '.$frame_name.' ('.$source_data_array['methodsymbol'].') (range = 0 to 255)';
- } else {
- $framedata .= str_replace("\x00", '', $source_data_array['ownerid'])."\x00";
- $framedata .= ord($source_data_array['methodsymbol']);
- $framedata .= $source_data_array['data'];
- }
- break;
-
- case 'GRID':
- // 4.26 GRID Group identification registration (ID3v2.3+ only)
- // Owner identifier <text string> $00
- // Group symbol $xx
- // Group dependent data <binary data>
- if (!$this->IsWithinBitRange($source_data_array['groupsymbol'], 8, false)) {
- $this->errors[] = 'Invalid Group Symbol in '.$frame_name.' ('.$source_data_array['groupsymbol'].') (range = 0 to 255)';
- } else {
- $framedata .= str_replace("\x00", '', $source_data_array['ownerid'])."\x00";
- $framedata .= ord($source_data_array['groupsymbol']);
- $framedata .= $source_data_array['data'];
- }
- break;
-
- case 'PRIV':
- // 4.27 PRIV Private frame (ID3v2.3+ only)
- // Owner identifier <text string> $00
- // The private data <binary data>
- $framedata .= str_replace("\x00", '', $source_data_array['ownerid'])."\x00";
- $framedata .= $source_data_array['data'];
- break;
-
- case 'SIGN':
- // 4.28 SIGN Signature frame (ID3v2.4+ only)
- // Group symbol $xx
- // Signature <binary data>
- if (!$this->IsWithinBitRange($source_data_array['groupsymbol'], 8, false)) {
- $this->errors[] = 'Invalid Group Symbol in '.$frame_name.' ('.$source_data_array['groupsymbol'].') (range = 0 to 255)';
- } else {
- $framedata .= ord($source_data_array['groupsymbol']);
- $framedata .= $source_data_array['data'];
- }
- break;
-
- case 'SEEK':
- // 4.29 SEEK Seek frame (ID3v2.4+ only)
- // Minimum offset to next tag $xx xx xx xx
- if (!$this->IsWithinBitRange($source_data_array['data'], 32, false)) {
- $this->errors[] = 'Invalid Minimum Offset in '.$frame_name.' ('.$source_data_array['data'].') (range = 0 to 4294967295)';
- } else {
- $framedata .= getid3_lib::BigEndian2String($source_data_array['data'], 4, false);
- }
- break;
-
- case 'ASPI':
- // 4.30 ASPI Audio seek point index (ID3v2.4+ only)
- // Indexed data start (S) $xx xx xx xx
- // Indexed data length (L) $xx xx xx xx
- // Number of index points (N) $xx xx
- // Bits per index point (b) $xx
- // Then for every index point the following data is included:
- // Fraction at index (Fi) $xx (xx)
- if (!$this->IsWithinBitRange($source_data_array['datastart'], 32, false)) {
- $this->errors[] = 'Invalid Indexed Data Start in '.$frame_name.' ('.$source_data_array['datastart'].') (range = 0 to 4294967295)';
- } elseif (!$this->IsWithinBitRange($source_data_array['datalength'], 32, false)) {
- $this->errors[] = 'Invalid Indexed Data Length in '.$frame_name.' ('.$source_data_array['datalength'].') (range = 0 to 4294967295)';
- } elseif (!$this->IsWithinBitRange($source_data_array['indexpoints'], 16, false)) {
- $this->errors[] = 'Invalid Number Of Index Points in '.$frame_name.' ('.$source_data_array['indexpoints'].') (range = 0 to 65535)';
- } elseif (!$this->IsWithinBitRange($source_data_array['bitsperpoint'], 8, false)) {
- $this->errors[] = 'Invalid Bits Per Index Point in '.$frame_name.' ('.$source_data_array['bitsperpoint'].') (range = 0 to 255)';
- } elseif ($source_data_array['indexpoints'] != count($source_data_array['indexes'])) {
- $this->errors[] = 'Number Of Index Points does not match actual supplied data in '.$frame_name;
- } else {
- $framedata .= getid3_lib::BigEndian2String($source_data_array['datastart'], 4, false);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['datalength'], 4, false);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['indexpoints'], 2, false);
- $framedata .= getid3_lib::BigEndian2String($source_data_array['bitsperpoint'], 1, false);
- foreach ($source_data_array['indexes'] as $key => $val) {
- $framedata .= getid3_lib::BigEndian2String($val, ceil($source_data_array['bitsperpoint'] / 8), false);
- }
- }
- break;
-
- case 'RGAD':
- // RGAD Replay Gain Adjustment
- // http://privatewww.essex.ac.uk/~djmrob/replaygain/
- // Peak Amplitude $xx $xx $xx $xx
- // Radio Replay Gain Adjustment %aaabbbcd %dddddddd
- // Audiophile Replay Gain Adjustment %aaabbbcd %dddddddd
- // a - name code
- // b - originator code
- // c - sign bit
- // d - replay gain adjustment
-
- if (($source_data_array['track_adjustment'] > 51) || ($source_data_array['track_adjustment'] < -51)) {
- $this->errors[] = 'Invalid Track Adjustment in '.$frame_name.' ('.$source_data_array['track_adjustment'].') (range = -51.0 to +51.0)';
- } elseif (($source_data_array['album_adjustment'] > 51) || ($source_data_array['album_adjustment'] < -51)) {
- $this->errors[] = 'Invalid Album Adjustment in '.$frame_name.' ('.$source_data_array['album_adjustment'].') (range = -51.0 to +51.0)';
- } elseif (!$this->ID3v2IsValidRGADname($source_data_array['raw']['track_name'])) {
- $this->errors[] = 'Invalid Track Name Code in '.$frame_name.' ('.$source_data_array['raw']['track_name'].') (range = 0 to 2)';
- } elseif (!$this->ID3v2IsValidRGADname($source_data_array['raw']['album_name'])) {
- $this->errors[] = 'Invalid Album Name Code in '.$frame_name.' ('.$source_data_array['raw']['album_name'].') (range = 0 to 2)';
- } elseif (!$this->ID3v2IsValidRGADoriginator($source_data_array['raw']['track_originator'])) {
- $this->errors[] = 'Invalid Track Originator Code in '.$frame_name.' ('.$source_data_array['raw']['track_originator'].') (range = 0 to 3)';
- } elseif (!$this->ID3v2IsValidRGADoriginator($source_data_array['raw']['album_originator'])) {
- $this->errors[] = 'Invalid Album Originator Code in '.$frame_name.' ('.$source_data_array['raw']['album_originator'].') (range = 0 to 3)';
- } else {
- $framedata .= getid3_lib::Float2String($source_data_array['peakamplitude'], 32);
- $framedata .= getid3_lib::RGADgainString($source_data_array['raw']['track_name'], $source_data_array['raw']['track_originator'], $source_data_array['track_adjustment']);
- $framedata .= getid3_lib::RGADgainString($source_data_array['raw']['album_name'], $source_data_array['raw']['album_originator'], $source_data_array['album_adjustment']);
- }
- break;
-
- default:
- if (/*(($this->majorversion == 2) && (strlen($frame_name) != 3)) || (($this->majorversion > 2) && (*/strlen($frame_name) != 4/*))*/) {
- $this->errors[] = 'Invalid frame name "'.$frame_name.'" for ID3v2.'.$this->majorversion;
- } elseif ($frame_name[0] == 'T') {
- // 4.2. T??? Text information frames
- // Text encoding $xx
- // Information <text string(s) according to encoding>
- $source_data_array['encodingid'] = (isset($source_data_array['encodingid']) ? $source_data_array['encodingid'] : $this->id3v2_default_encodingid);
- if (!$this->ID3v2IsValidTextEncoding($source_data_array['encodingid'])) {
- $this->errors[] = 'Invalid Text Encoding in '.$frame_name.' ('.$source_data_array['encodingid'].') for ID3v2.'.$this->majorversion;
- } else {
- $framedata .= chr($source_data_array['encodingid']);
- $framedata .= $source_data_array['data'];
- }
- } elseif ($frame_name[0] == 'W') {
- // 4.3. W??? URL link frames
- // URL <text string>
- if (!$this->IsValidURL($source_data_array['data'], false)) {
- //$this->errors[] = 'Invalid URL in '.$frame_name.' ('.$source_data_array['data'].')';
- // probably should be an error, need to rewrite IsValidURL() to handle other encodings
- $this->warnings[] = 'Invalid URL in '.$frame_name.' ('.$source_data_array['data'].')';
- } else {
- $framedata .= $source_data_array['data'];
- }
- } else {
- $this->errors[] = $frame_name.' not yet supported in $this->GenerateID3v2FrameData()';
- }
- break;
- }
- }
- if (!empty($this->errors)) {
- return false;
- }
- return $framedata;
- }
-
- /**
- * @param string|null $frame_name
- * @param array $source_data_array
- *
- * @return bool
- */
- public function ID3v2FrameIsAllowed($frame_name, $source_data_array) {
- static $PreviousFrames = array();
-
- if ($frame_name === null) {
- // if the writing functions are called multiple times, the static array needs to be
- // cleared - this can be done by calling $this->ID3v2FrameIsAllowed(null, '')
- $PreviousFrames = array();
- return true;
- }
- if ($this->majorversion == 4) {
- switch ($frame_name) {
- case 'UFID':
- case 'AENC':
- case 'ENCR':
- case 'GRID':
- if (!isset($source_data_array['ownerid'])) {
- $this->errors[] = '[ownerid] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['ownerid'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same OwnerID ('.$source_data_array['ownerid'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['ownerid'];
- }
- break;
-
- case 'TXXX':
- case 'WXXX':
- case 'RVA2':
- case 'EQU2':
- case 'APIC':
- case 'GEOB':
- if (!isset($source_data_array['description'])) {
- $this->errors[] = '[description] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['description'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same Description ('.$source_data_array['description'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['description'];
- }
- break;
-
- case 'USER':
- if (!isset($source_data_array['language'])) {
- $this->errors[] = '[language] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['language'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same Language ('.$source_data_array['language'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['language'];
- }
- break;
-
- case 'USLT':
- case 'SYLT':
- case 'COMM':
- if (!isset($source_data_array['language'])) {
- $this->errors[] = '[language] not specified for '.$frame_name;
- } elseif (!isset($source_data_array['description'])) {
- $this->errors[] = '[description] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['language'].$source_data_array['description'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same Language + Description ('.$source_data_array['language'].' + '.$source_data_array['description'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['language'].$source_data_array['description'];
- }
- break;
-
- case 'POPM':
- if (!isset($source_data_array['email'])) {
- $this->errors[] = '[email] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['email'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same Email ('.$source_data_array['email'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['email'];
- }
- break;
-
- case 'IPLS':
- case 'MCDI':
- case 'ETCO':
- case 'MLLT':
- case 'SYTC':
- case 'RVRB':
- case 'PCNT':
- case 'RBUF':
- case 'POSS':
- case 'OWNE':
- case 'SEEK':
- case 'ASPI':
- case 'RGAD':
- if (in_array($frame_name, $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed';
- } else {
- $PreviousFrames[] = $frame_name;
- }
- break;
-
- case 'LINK':
- // this isn't implemented quite right (yet) - it should check the target frame data for compliance
- // but right now it just allows one linked frame of each type, to be safe.
- if (!isset($source_data_array['frameid'])) {
- $this->errors[] = '[frameid] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['frameid'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same FrameID ('.$source_data_array['frameid'].')';
- } elseif (in_array($source_data_array['frameid'], $PreviousFrames)) {
- // no links to singleton tags
- $this->errors[] = 'Cannot specify a '.$frame_name.' tag to a singleton tag that already exists ('.$source_data_array['frameid'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['frameid']; // only one linked tag of this type
- $PreviousFrames[] = $source_data_array['frameid']; // no non-linked singleton tags of this type
- }
- break;
-
- case 'COMR':
- // There may be more than one 'commercial frame' in a tag, but no two may be identical
- // Checking isn't implemented at all (yet) - just assumes that it's OK.
- break;
-
- case 'PRIV':
- case 'SIGN':
- if (!isset($source_data_array['ownerid'])) {
- $this->errors[] = '[ownerid] not specified for '.$frame_name;
- } elseif (!isset($source_data_array['data'])) {
- $this->errors[] = '[data] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['ownerid'].$source_data_array['data'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same OwnerID + Data ('.$source_data_array['ownerid'].' + '.$source_data_array['data'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['ownerid'].$source_data_array['data'];
- }
- break;
-
- default:
- if (($frame_name[0] != 'T') && ($frame_name[0] != 'W')) {
- $this->errors[] = 'Frame not allowed in ID3v2.'.$this->majorversion.': '.$frame_name;
- }
- break;
- }
-
- } elseif ($this->majorversion == 3) {
-
- switch ($frame_name) {
- case 'UFID':
- case 'AENC':
- case 'ENCR':
- case 'GRID':
- if (!isset($source_data_array['ownerid'])) {
- $this->errors[] = '[ownerid] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['ownerid'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same OwnerID ('.$source_data_array['ownerid'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['ownerid'];
- }
- break;
-
- case 'TXXX':
- case 'WXXX':
- case 'APIC':
- case 'GEOB':
- if (!isset($source_data_array['description'])) {
- $this->errors[] = '[description] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['description'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same Description ('.$source_data_array['description'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['description'];
- }
- break;
-
- case 'USER':
- if (!isset($source_data_array['language'])) {
- $this->errors[] = '[language] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['language'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same Language ('.$source_data_array['language'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['language'];
- }
- break;
-
- case 'USLT':
- case 'SYLT':
- case 'COMM':
- if (!isset($source_data_array['language'])) {
- $this->errors[] = '[language] not specified for '.$frame_name;
- } elseif (!isset($source_data_array['description'])) {
- $this->errors[] = '[description] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['language'].$source_data_array['description'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same Language + Description ('.$source_data_array['language'].' + '.$source_data_array['description'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['language'].$source_data_array['description'];
- }
- break;
-
- case 'POPM':
- if (!isset($source_data_array['email'])) {
- $this->errors[] = '[email] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['email'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same Email ('.$source_data_array['email'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['email'];
- }
- break;
-
- case 'IPLS':
- case 'MCDI':
- case 'ETCO':
- case 'MLLT':
- case 'SYTC':
- case 'RVAD':
- case 'EQUA':
- case 'RVRB':
- case 'PCNT':
- case 'RBUF':
- case 'POSS':
- case 'OWNE':
- case 'RGAD':
- if (in_array($frame_name, $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed';
- } else {
- $PreviousFrames[] = $frame_name;
- }
- break;
-
- case 'LINK':
- // this isn't implemented quite right (yet) - it should check the target frame data for compliance
- // but right now it just allows one linked frame of each type, to be safe.
- if (!isset($source_data_array['frameid'])) {
- $this->errors[] = '[frameid] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['frameid'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same FrameID ('.$source_data_array['frameid'].')';
- } elseif (in_array($source_data_array['frameid'], $PreviousFrames)) {
- // no links to singleton tags
- $this->errors[] = 'Cannot specify a '.$frame_name.' tag to a singleton tag that already exists ('.$source_data_array['frameid'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['frameid']; // only one linked tag of this type
- $PreviousFrames[] = $source_data_array['frameid']; // no non-linked singleton tags of this type
- }
- break;
-
- case 'COMR':
- // There may be more than one 'commercial frame' in a tag, but no two may be identical
- // Checking isn't implemented at all (yet) - just assumes that it's OK.
- break;
-
- case 'PRIV':
- if (!isset($source_data_array['ownerid'])) {
- $this->errors[] = '[ownerid] not specified for '.$frame_name;
- } elseif (!isset($source_data_array['data'])) {
- $this->errors[] = '[data] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['ownerid'].$source_data_array['data'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same OwnerID + Data ('.$source_data_array['ownerid'].' + '.$source_data_array['data'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['ownerid'].$source_data_array['data'];
- }
- break;
-
- default:
- if (($frame_name[0] != 'T') && ($frame_name[0] != 'W')) {
- $this->errors[] = 'Frame not allowed in ID3v2.'.$this->majorversion.': '.$frame_name;
- }
- break;
- }
-
- } elseif ($this->majorversion == 2) {
-
- switch ($frame_name) {
- case 'UFI':
- case 'CRM':
- case 'CRA':
- if (!isset($source_data_array['ownerid'])) {
- $this->errors[] = '[ownerid] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['ownerid'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same OwnerID ('.$source_data_array['ownerid'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['ownerid'];
- }
- break;
-
- case 'TXX':
- case 'WXX':
- case 'PIC':
- case 'GEO':
- if (!isset($source_data_array['description'])) {
- $this->errors[] = '[description] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['description'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same Description ('.$source_data_array['description'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['description'];
- }
- break;
-
- case 'ULT':
- case 'SLT':
- case 'COM':
- if (!isset($source_data_array['language'])) {
- $this->errors[] = '[language] not specified for '.$frame_name;
- } elseif (!isset($source_data_array['description'])) {
- $this->errors[] = '[description] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['language'].$source_data_array['description'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same Language + Description ('.$source_data_array['language'].' + '.$source_data_array['description'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['language'].$source_data_array['description'];
- }
- break;
-
- case 'POP':
- if (!isset($source_data_array['email'])) {
- $this->errors[] = '[email] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['email'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same Email ('.$source_data_array['email'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['email'];
- }
- break;
-
- case 'IPL':
- case 'MCI':
- case 'ETC':
- case 'MLL':
- case 'STC':
- case 'RVA':
- case 'EQU':
- case 'REV':
- case 'CNT':
- case 'BUF':
- if (in_array($frame_name, $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed';
- } else {
- $PreviousFrames[] = $frame_name;
- }
- break;
-
- case 'LNK':
- // this isn't implemented quite right (yet) - it should check the target frame data for compliance
- // but right now it just allows one linked frame of each type, to be safe.
- if (!isset($source_data_array['frameid'])) {
- $this->errors[] = '[frameid] not specified for '.$frame_name;
- } elseif (in_array($frame_name.$source_data_array['frameid'], $PreviousFrames)) {
- $this->errors[] = 'Only one '.$frame_name.' tag allowed with the same FrameID ('.$source_data_array['frameid'].')';
- } elseif (in_array($source_data_array['frameid'], $PreviousFrames)) {
- // no links to singleton tags
- $this->errors[] = 'Cannot specify a '.$frame_name.' tag to a singleton tag that already exists ('.$source_data_array['frameid'].')';
- } else {
- $PreviousFrames[] = $frame_name.$source_data_array['frameid']; // only one linked tag of this type
- $PreviousFrames[] = $source_data_array['frameid']; // no non-linked singleton tags of this type
- }
- break;
-
- default:
- if (($frame_name[0] != 'T') && ($frame_name[0] != 'W')) {
- $this->errors[] = 'Frame not allowed in ID3v2.'.$this->majorversion.': '.$frame_name;
- }
- break;
- }
- }
-
- if (!empty($this->errors)) {
- return false;
- }
- return true;
- }
-
- /**
- * @param bool $noerrorsonly
- *
- * @return string|false
- */
- public function GenerateID3v2Tag($noerrorsonly=true) {
- $this->ID3v2FrameIsAllowed(null, ''); // clear static array in case this isn't the first call to $this->GenerateID3v2Tag()
-
- $tagstring = '';
- if (is_array($this->tag_data)) {
- foreach ($this->tag_data as $frame_name => $frame_rawinputdata) {
- foreach ($frame_rawinputdata as $irrelevantindex => $source_data_array) {
- if (getid3_id3v2::IsValidID3v2FrameName($frame_name, $this->majorversion)) {
- unset($frame_length);
- unset($frame_flags);
- $frame_data = false;
- if ($this->ID3v2FrameIsAllowed($frame_name, $source_data_array)) {
- if(array_key_exists('description', $source_data_array) && array_key_exists('encodingid', $source_data_array) && array_key_exists('encoding', $this->tag_data)) {
- $source_data_array['description'] = getid3_lib::iconv_fallback($this->tag_data['encoding'], $source_data_array['encoding'], $source_data_array['description']);
- }
- if ($frame_data = $this->GenerateID3v2FrameData($frame_name, $source_data_array)) {
- $FrameUnsynchronisation = false;
- if ($this->majorversion >= 4) {
- // frame-level unsynchronisation
- $unsynchdata = $frame_data;
- if ($this->id3v2_use_unsynchronisation) {
- $unsynchdata = $this->Unsynchronise($frame_data);
- }
- if (strlen($unsynchdata) != strlen($frame_data)) {
- // unsynchronisation needed
- $FrameUnsynchronisation = true;
- $frame_data = $unsynchdata;
- if (isset($TagUnsynchronisation) && $TagUnsynchronisation === false) {
- // only set to true if ALL frames are unsynchronised
- } else {
- $TagUnsynchronisation = true;
- }
- } else {
- if (isset($TagUnsynchronisation)) {
- $TagUnsynchronisation = false;
- }
- }
- unset($unsynchdata);
-
- $frame_length = getid3_lib::BigEndian2String(strlen($frame_data), 4, true);
- } else {
- $frame_length = getid3_lib::BigEndian2String(strlen($frame_data), 4, false);
- }
- $frame_flags = $this->GenerateID3v2FrameFlags($this->ID3v2FrameFlagsLookupTagAlter($frame_name), $this->ID3v2FrameFlagsLookupFileAlter($frame_name), false, false, false, false, $FrameUnsynchronisation, false);
- }
- } else {
- $this->errors[] = 'Frame "'.$frame_name.'" is NOT allowed';
- }
- if ($frame_data === false) {
- $this->errors[] = '$this->GenerateID3v2FrameData() failed for "'.$frame_name.'"';
- if ($noerrorsonly) {
- return false;
- } else {
- $frame_name = null;
- }
- }
- } else {
- // ignore any invalid frame names, including 'title', 'header', etc
- $this->warnings[] = 'Ignoring invalid ID3v2 frame type: "'.$frame_name.'"';
- $frame_name = null;
- unset($frame_length);
- unset($frame_flags);
- unset($frame_data);
- }
- if (null !== $frame_name && isset($frame_length) && isset($frame_flags) && isset($frame_data)) {
- $tagstring .= $frame_name.$frame_length.$frame_flags.$frame_data;
- }
- }
- }
-
- if (!isset($TagUnsynchronisation)) {
- $TagUnsynchronisation = false;
- }
- if (($this->majorversion <= 3) && $this->id3v2_use_unsynchronisation) {
- // tag-level unsynchronisation
- $unsynchdata = $this->Unsynchronise($tagstring);
- if (strlen($unsynchdata) != strlen($tagstring)) {
- // unsynchronisation needed
- $TagUnsynchronisation = true;
- $tagstring = $unsynchdata;
- }
- }
-
- while ($this->paddedlength < (strlen($tagstring) + getid3_id3v2::ID3v2HeaderLength($this->majorversion))) {
- $this->paddedlength += 1024;
- }
-
- $footer = false; // ID3v2 footers not yet supported in getID3()
- if (/*!$footer && */($this->paddedlength > (strlen($tagstring) + getid3_id3v2::ID3v2HeaderLength($this->majorversion)))) {
- // pad up to $paddedlength bytes if unpadded tag is shorter than $paddedlength
- // "Furthermore it MUST NOT have any padding when a tag footer is added to the tag."
- if (($this->paddedlength - strlen($tagstring) - getid3_id3v2::ID3v2HeaderLength($this->majorversion)) > 0) {
- $tagstring .= str_repeat("\x00", $this->paddedlength - strlen($tagstring) - getid3_id3v2::ID3v2HeaderLength($this->majorversion));
- }
- }
- if ($this->id3v2_use_unsynchronisation && (substr($tagstring, strlen($tagstring) - 1, 1) == "\xFF")) {
- // special unsynchronisation case:
- // if last byte == $FF then appended a $00
- $TagUnsynchronisation = true;
- $tagstring .= "\x00";
- }
-
- $tagheader = 'ID3';
- $tagheader .= chr($this->majorversion);
- $tagheader .= chr($this->minorversion);
- $tagheader .= $this->GenerateID3v2TagFlags(array('unsynchronisation'=>$TagUnsynchronisation));
- $tagheader .= getid3_lib::BigEndian2String(strlen($tagstring), 4, true);
-
- return $tagheader.$tagstring;
- }
- $this->errors[] = 'tag_data is not an array in GenerateID3v2Tag()';
- return false;
- }
-
- /**
- * @param string $pricestring
- *
- * @return bool
- */
- public function ID3v2IsValidPriceString($pricestring) {
- if (getid3_id3v2::LanguageLookup(substr($pricestring, 0, 3), true) == '') {
- return false;
- } elseif (!getid3_id3v2::IsANumber(substr($pricestring, 3), true)) {
- return false;
- }
- return true;
- }
-
- /**
- * @param string $framename
- *
- * @return bool
- */
- public function ID3v2FrameFlagsLookupTagAlter($framename) {
- // unfinished
- switch ($framename) {
- case 'RGAD':
- $allow = true;
- break;
- default:
- $allow = false;
- break;
- }
- return $allow;
- }
-
- /**
- * @param string $framename
- *
- * @return bool
- */
- public function ID3v2FrameFlagsLookupFileAlter($framename) {
- // unfinished
- switch ($framename) {
- case 'RGAD':
- return false;
-
- default:
- return false;
- }
- }
-
- /**
- * @param int $eventid
- *
- * @return bool
- */
- public function ID3v2IsValidETCOevent($eventid) {
- if (($eventid < 0) || ($eventid > 0xFF)) {
- // outside range of 1 byte
- return false;
- } elseif (($eventid >= 0xF0) && ($eventid <= 0xFC)) {
- // reserved for future use
- return false;
- } elseif (($eventid >= 0x17) && ($eventid <= 0xDF)) {
- // reserved for future use
- return false;
- } elseif (($eventid >= 0x0E) && ($eventid <= 0x16) && ($this->majorversion == 2)) {
- // not defined in ID3v2.2
- return false;
- } elseif (($eventid >= 0x15) && ($eventid <= 0x16) && ($this->majorversion == 3)) {
- // not defined in ID3v2.3
- return false;
- }
- return true;
- }
-
- /**
- * @param int $contenttype
- *
- * @return bool
- */
- public function ID3v2IsValidSYLTtype($contenttype) {
- if (($contenttype >= 0) && ($contenttype <= 8) && ($this->majorversion == 4)) {
- return true;
- } elseif (($contenttype >= 0) && ($contenttype <= 6) && ($this->majorversion == 3)) {
- return true;
- }
- return false;
- }
-
- /**
- * @param int $channeltype
- *
- * @return bool
- */
- public function ID3v2IsValidRVA2channeltype($channeltype) {
- if (($channeltype >= 0) && ($channeltype <= 8) && ($this->majorversion == 4)) {
- return true;
- }
- return false;
- }
-
- /**
- * @param int $picturetype
- *
- * @return bool
- */
- public function ID3v2IsValidAPICpicturetype($picturetype) {
- if (($picturetype >= 0) && ($picturetype <= 0x14) && ($this->majorversion >= 2) && ($this->majorversion <= 4)) {
- return true;
- }
- return false;
- }
-
- /**
- * @param int|string $imageformat
- *
- * @return bool
- */
- public function ID3v2IsValidAPICimageformat($imageformat) {
- if ($imageformat == '-->') {
- return true;
- } elseif ($this->majorversion == 2) {
- if ((strlen($imageformat) == 3) && ($imageformat == strtoupper($imageformat))) {
- return true;
- }
- } elseif (($this->majorversion == 3) || ($this->majorversion == 4)) {
- if ($this->IsValidMIMEstring($imageformat)) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * @param int $receivedas
- *
- * @return bool
- */
- public function ID3v2IsValidCOMRreceivedAs($receivedas) {
- if (($this->majorversion >= 3) && ($receivedas >= 0) && ($receivedas <= 8)) {
- return true;
- }
- return false;
- }
-
- /**
- * @param int $RGADname
- *
- * @return bool
- */
- public static function ID3v2IsValidRGADname($RGADname) {
- if (($RGADname >= 0) && ($RGADname <= 2)) {
- return true;
- }
- return false;
- }
-
- /**
- * @param int $RGADoriginator
- *
- * @return bool
- */
- public static function ID3v2IsValidRGADoriginator($RGADoriginator) {
- if (($RGADoriginator >= 0) && ($RGADoriginator <= 3)) {
- return true;
- }
- return false;
- }
-
- /**
- * @param int $textencodingbyte
- *
- * @return bool
- */
- public function ID3v2IsValidTextEncoding($textencodingbyte) {
- // 0 = ISO-8859-1
- // 1 = UTF-16 with BOM
- // 2 = UTF-16BE without BOM
- // 3 = UTF-8
- static $ID3v2IsValidTextEncoding_cache = array(
- 2 => array(true, true), // ID3v2.2 - allow 0=ISO-8859-1, 1=UTF-16
- 3 => array(true, true), // ID3v2.3 - allow 0=ISO-8859-1, 1=UTF-16
- 4 => array(true, true, true, true), // ID3v2.4 - allow 0=ISO-8859-1, 1=UTF-16, 2=UTF-16BE, 3=UTF-8
- );
- return isset($ID3v2IsValidTextEncoding_cache[$this->majorversion][$textencodingbyte]);
- }
-
- /**
- * @param string $data
- *
- * @return string
- */
- public static function Unsynchronise($data) {
- // Whenever a false synchronisation is found within the tag, one zeroed
- // byte is inserted after the first false synchronisation byte. The
- // format of a correct sync that should be altered by ID3 encoders is as
- // follows:
- // %11111111 111xxxxx
- // And should be replaced with:
- // %11111111 00000000 111xxxxx
- // This has the side effect that all $FF 00 combinations have to be
- // altered, so they won't be affected by the decoding process. Therefore
- // all the $FF 00 combinations have to be replaced with the $FF 00 00
- // combination during the unsynchronisation.
-
- $data = str_replace("\xFF\x00", "\xFF\x00\x00", $data);
- $unsyncheddata = '';
- $datalength = strlen($data);
- for ($i = 0; $i < $datalength; $i++) {
- $thischar = $data[$i];
- $unsyncheddata .= $thischar;
- if ($thischar == "\xFF") {
- $nextchar = ord($data[$i + 1]);
- if (($nextchar & 0xE0) == 0xE0) {
- // previous byte = 11111111, this byte = 111?????
- $unsyncheddata .= "\x00";
- }
- }
- }
- return $unsyncheddata;
- }
-
- /**
- * @param mixed $var
- *
- * @return bool
- */
- public function is_hash($var) {
- // written by dev-nullØchristophe*vg
- // taken from http://www.php.net/manual/en/function.array-merge-recursive.php
- if (is_array($var)) {
- $keys = array_keys($var);
- $all_num = true;
- for ($i = 0; $i < count($keys); $i++) {
- if (is_string($keys[$i])) {
- return true;
- }
- }
- }
- return false;
- }
-
- /**
- * @param mixed $arr1
- * @param mixed $arr2
- *
- * @return array
- */
- public function array_join_merge($arr1, $arr2) {
- // written by dev-nullØchristophe*vg
- // taken from http://www.php.net/manual/en/function.array-merge-recursive.php
- if (is_array($arr1) && is_array($arr2)) {
- // the same -> merge
- $new_array = array();
-
- if ($this->is_hash($arr1) && $this->is_hash($arr2)) {
- // hashes -> merge based on keys
- $keys = array_merge(array_keys($arr1), array_keys($arr2));
- foreach ($keys as $key) {
- $new_array[$key] = $this->array_join_merge((isset($arr1[$key]) ? $arr1[$key] : ''), (isset($arr2[$key]) ? $arr2[$key] : ''));
- }
- } else {
- // two real arrays -> merge
- $new_array = array_reverse(array_unique(array_reverse(array_merge($arr1, $arr2))));
- }
- return $new_array;
- } else {
- // not the same ... take new one if defined, else the old one stays
- return $arr2 ? $arr2 : $arr1;
- }
- }
-
- /**
- * @param string $mimestring
- *
- * @return false|int
- */
- public static function IsValidMIMEstring($mimestring) {
- return preg_match('#^.+/.+$#', $mimestring);
- }
-
- /**
- * @param int $number
- * @param int $maxbits
- * @param bool $signed
- *
- * @return bool
- */
- public static function IsWithinBitRange($number, $maxbits, $signed=false) {
- if ($signed) {
- if (($number > (0 - pow(2, $maxbits - 1))) && ($number <= pow(2, $maxbits - 1))) {
- return true;
- }
- } else {
- if (($number >= 0) && ($number <= pow(2, $maxbits))) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * @param string $email
- *
- * @return false|int|mixed
- */
- public static function IsValidEmail($email) {
- if (function_exists('filter_var')) {
- return filter_var($email, FILTER_VALIDATE_EMAIL);
- }
- // VERY crude email validation
- return preg_match('#^[^ ]+@[a-z\\-\\.]+\\.[a-z]{2,}$#', $email);
- }
-
- /**
- * @param string $url
- * @param bool $allowUserPass
- *
- * @return bool
- */
- public static function IsValidURL($url, $allowUserPass=false) {
- if ($url == '') {
- return false;
- }
- if ($allowUserPass !== true) {
- if (strstr($url, '@')) {
- // in the format http://user:pass@example.com or http://user@example.com
- // but could easily be somebody incorrectly entering an email address in place of a URL
- return false;
- }
- }
- // 2016-06-08: relax URL checking to avoid falsely rejecting valid URLs, leave URL validation to the user
- // https://www.getid3.org/phpBB3/viewtopic.php?t=1926
- return true;
- /*
- if ($parts = $this->safe_parse_url($url)) {
- if (($parts['scheme'] != 'http') && ($parts['scheme'] != 'https') && ($parts['scheme'] != 'ftp') && ($parts['scheme'] != 'gopher')) {
- return false;
- } elseif (!preg_match('#^[[:alnum:]]([-.]?[0-9a-z])*\\.[a-z]{2,3}$#i', $parts['host'], $regs) && !preg_match('#^[0-9]{1,3}(\\.[0-9]{1,3}){3}$#', $parts['host'])) {
- return false;
- } elseif (!preg_match('#^([[:alnum:]-]|[\\_])*$#i', $parts['user'], $regs)) {
- return false;
- } elseif (!preg_match('#^([[:alnum:]-]|[\\_])*$#i', $parts['pass'], $regs)) {
- return false;
- } elseif (!preg_match('#^[[:alnum:]/_\\.@~-]*$#i', $parts['path'], $regs)) {
- return false;
- } elseif (!empty($parts['query']) && !preg_match('#^[[:alnum:]?&=+:;_()%\\#/,\\.-]*$#i', $parts['query'], $regs)) {
- return false;
- } else {
- return true;
- }
- }
- return false;
- */
- }
-
- /**
- * @param string $url
- *
- * @return array
- */
- public static function safe_parse_url($url) {
- $parts = @parse_url($url);
- $parts['scheme'] = (isset($parts['scheme']) ? $parts['scheme'] : '');
- $parts['host'] = (isset($parts['host']) ? $parts['host'] : '');
- $parts['user'] = (isset($parts['user']) ? $parts['user'] : '');
- $parts['pass'] = (isset($parts['pass']) ? $parts['pass'] : '');
- $parts['path'] = (isset($parts['path']) ? $parts['path'] : '');
- $parts['query'] = (isset($parts['query']) ? $parts['query'] : '');
- return $parts;
- }
-
- /**
- * @param int $majorversion
- * @param string $long_description
- *
- * @return string
- */
- public static function ID3v2ShortFrameNameLookup($majorversion, $long_description) {
- $long_description = str_replace(' ', '_', strtolower(trim($long_description)));
- static $ID3v2ShortFrameNameLookup = array();
- if (empty($ID3v2ShortFrameNameLookup)) {
-
- // The following are unique to ID3v2.2
- $ID3v2ShortFrameNameLookup[2]['recommended_buffer_size'] = 'BUF';
- $ID3v2ShortFrameNameLookup[2]['comment'] = 'COM';
- $ID3v2ShortFrameNameLookup[2]['audio_encryption'] = 'CRA';
- $ID3v2ShortFrameNameLookup[2]['encrypted_meta_frame'] = 'CRM';
- $ID3v2ShortFrameNameLookup[2]['equalisation'] = 'EQU';
- $ID3v2ShortFrameNameLookup[2]['event_timing_codes'] = 'ETC';
- $ID3v2ShortFrameNameLookup[2]['general_encapsulated_object'] = 'GEO';
- $ID3v2ShortFrameNameLookup[2]['involved_people_list'] = 'IPL';
- $ID3v2ShortFrameNameLookup[2]['linked_information'] = 'LNK';
- $ID3v2ShortFrameNameLookup[2]['music_cd_identifier'] = 'MCI';
- $ID3v2ShortFrameNameLookup[2]['mpeg_location_lookup_table'] = 'MLL';
- $ID3v2ShortFrameNameLookup[2]['attached_picture'] = 'PIC';
- $ID3v2ShortFrameNameLookup[2]['popularimeter'] = 'POP';
- $ID3v2ShortFrameNameLookup[2]['reverb'] = 'REV';
- $ID3v2ShortFrameNameLookup[2]['relative_volume_adjustment'] = 'RVA';
- $ID3v2ShortFrameNameLookup[2]['synchronised_lyric'] = 'SLT';
- $ID3v2ShortFrameNameLookup[2]['synchronised_tempo_codes'] = 'STC';
- $ID3v2ShortFrameNameLookup[2]['album'] = 'TAL';
- $ID3v2ShortFrameNameLookup[2]['beats_per_minute'] = 'TBP';
- $ID3v2ShortFrameNameLookup[2]['bpm'] = 'TBP';
- $ID3v2ShortFrameNameLookup[2]['composer'] = 'TCM';
- $ID3v2ShortFrameNameLookup[2]['genre'] = 'TCO';
- $ID3v2ShortFrameNameLookup[2]['part_of_a_compilation'] = 'TCP';
- $ID3v2ShortFrameNameLookup[2]['copyright_message'] = 'TCR';
- $ID3v2ShortFrameNameLookup[2]['date'] = 'TDA';
- $ID3v2ShortFrameNameLookup[2]['playlist_delay'] = 'TDY';
- $ID3v2ShortFrameNameLookup[2]['encoded_by'] = 'TEN';
- $ID3v2ShortFrameNameLookup[2]['file_type'] = 'TFT';
- $ID3v2ShortFrameNameLookup[2]['time'] = 'TIM';
- $ID3v2ShortFrameNameLookup[2]['initial_key'] = 'TKE';
- $ID3v2ShortFrameNameLookup[2]['language'] = 'TLA';
- $ID3v2ShortFrameNameLookup[2]['length'] = 'TLE';
- $ID3v2ShortFrameNameLookup[2]['media_type'] = 'TMT';
- $ID3v2ShortFrameNameLookup[2]['original_artist'] = 'TOA';
- $ID3v2ShortFrameNameLookup[2]['original_filename'] = 'TOF';
- $ID3v2ShortFrameNameLookup[2]['original_lyricist'] = 'TOL';
- $ID3v2ShortFrameNameLookup[2]['original_year'] = 'TOR';
- $ID3v2ShortFrameNameLookup[2]['original_album'] = 'TOT';
- $ID3v2ShortFrameNameLookup[2]['artist'] = 'TP1';
- $ID3v2ShortFrameNameLookup[2]['band'] = 'TP2';
- $ID3v2ShortFrameNameLookup[2]['conductor'] = 'TP3';
- $ID3v2ShortFrameNameLookup[2]['remixer'] = 'TP4';
- $ID3v2ShortFrameNameLookup[2]['part_of_a_set'] = 'TPA';
- $ID3v2ShortFrameNameLookup[2]['publisher'] = 'TPB';
- $ID3v2ShortFrameNameLookup[2]['isrc'] = 'TRC';
- $ID3v2ShortFrameNameLookup[2]['recording_dates'] = 'TRD';
- $ID3v2ShortFrameNameLookup[2]['tracknumber'] = 'TRK';
- $ID3v2ShortFrameNameLookup[2]['track_number'] = 'TRK';
- $ID3v2ShortFrameNameLookup[2]['album_artist_sort_order'] = 'TS2';
- $ID3v2ShortFrameNameLookup[2]['album_sort_order'] = 'TSA';
- $ID3v2ShortFrameNameLookup[2]['composer_sort_order'] = 'TSC';
- $ID3v2ShortFrameNameLookup[2]['size'] = 'TSI';
- $ID3v2ShortFrameNameLookup[2]['performer_sort_order'] = 'TSP';
- $ID3v2ShortFrameNameLookup[2]['encoder_settings'] = 'TSS';
- $ID3v2ShortFrameNameLookup[2]['title_sort_order'] = 'TST';
- $ID3v2ShortFrameNameLookup[2]['content_group_description'] = 'TT1';
- $ID3v2ShortFrameNameLookup[2]['title'] = 'TT2';
- $ID3v2ShortFrameNameLookup[2]['subtitle'] = 'TT3';
- $ID3v2ShortFrameNameLookup[2]['lyricist'] = 'TXT';
- $ID3v2ShortFrameNameLookup[2]['text'] = 'TXX';
- $ID3v2ShortFrameNameLookup[2]['year'] = 'TYE';
- $ID3v2ShortFrameNameLookup[2]['unique_file_identifier'] = 'UFI';
- $ID3v2ShortFrameNameLookup[2]['unsynchronised_lyric'] = 'ULT';
- $ID3v2ShortFrameNameLookup[2]['url_file'] = 'WAF';
- $ID3v2ShortFrameNameLookup[2]['url_artist'] = 'WAR';
- $ID3v2ShortFrameNameLookup[2]['url_source'] = 'WAS';
- $ID3v2ShortFrameNameLookup[2]['commercial_information'] = 'WCM';
- $ID3v2ShortFrameNameLookup[2]['copyright'] = 'WCP';
- $ID3v2ShortFrameNameLookup[2]['url_publisher'] = 'WPB';
- $ID3v2ShortFrameNameLookup[2]['url_user'] = 'WXX';
-
- // The following are common to ID3v2.3 and ID3v2.4
- $ID3v2ShortFrameNameLookup[3]['audio_encryption'] = 'AENC';
- $ID3v2ShortFrameNameLookup[3]['attached_picture'] = 'APIC';
- $ID3v2ShortFrameNameLookup[3]['picture'] = 'APIC';
- $ID3v2ShortFrameNameLookup[3]['comment'] = 'COMM';
- $ID3v2ShortFrameNameLookup[3]['commercial_frame'] = 'COMR';
- $ID3v2ShortFrameNameLookup[3]['encryption_method_registration'] = 'ENCR';
- $ID3v2ShortFrameNameLookup[3]['event_timing_codes'] = 'ETCO';
- $ID3v2ShortFrameNameLookup[3]['general_encapsulated_object'] = 'GEOB';
- $ID3v2ShortFrameNameLookup[3]['group_identification_registration'] = 'GRID';
- $ID3v2ShortFrameNameLookup[3]['linked_information'] = 'LINK';
- $ID3v2ShortFrameNameLookup[3]['music_cd_identifier'] = 'MCDI';
- $ID3v2ShortFrameNameLookup[3]['mpeg_location_lookup_table'] = 'MLLT';
- $ID3v2ShortFrameNameLookup[3]['ownership_frame'] = 'OWNE';
- $ID3v2ShortFrameNameLookup[3]['play_counter'] = 'PCNT';
- $ID3v2ShortFrameNameLookup[3]['popularimeter'] = 'POPM';
- $ID3v2ShortFrameNameLookup[3]['position_synchronisation_frame'] = 'POSS';
- $ID3v2ShortFrameNameLookup[3]['private_frame'] = 'PRIV';
- $ID3v2ShortFrameNameLookup[3]['recommended_buffer_size'] = 'RBUF';
- $ID3v2ShortFrameNameLookup[3]['replay_gain_adjustment'] = 'RGAD';
- $ID3v2ShortFrameNameLookup[3]['reverb'] = 'RVRB';
- $ID3v2ShortFrameNameLookup[3]['synchronised_lyric'] = 'SYLT';
- $ID3v2ShortFrameNameLookup[3]['synchronised_tempo_codes'] = 'SYTC';
- $ID3v2ShortFrameNameLookup[3]['album'] = 'TALB';
- $ID3v2ShortFrameNameLookup[3]['beats_per_minute'] = 'TBPM';
- $ID3v2ShortFrameNameLookup[3]['bpm'] = 'TBPM';
- $ID3v2ShortFrameNameLookup[3]['part_of_a_compilation'] = 'TCMP';
- $ID3v2ShortFrameNameLookup[3]['composer'] = 'TCOM';
- $ID3v2ShortFrameNameLookup[3]['genre'] = 'TCON';
- $ID3v2ShortFrameNameLookup[3]['copyright_message'] = 'TCOP';
- $ID3v2ShortFrameNameLookup[3]['playlist_delay'] = 'TDLY';
- $ID3v2ShortFrameNameLookup[3]['encoded_by'] = 'TENC';
- $ID3v2ShortFrameNameLookup[3]['lyricist'] = 'TEXT';
- $ID3v2ShortFrameNameLookup[3]['file_type'] = 'TFLT';
- $ID3v2ShortFrameNameLookup[3]['content_group_description'] = 'TIT1';
- $ID3v2ShortFrameNameLookup[3]['title'] = 'TIT2';
- $ID3v2ShortFrameNameLookup[3]['subtitle'] = 'TIT3';
- $ID3v2ShortFrameNameLookup[3]['initial_key'] = 'TKEY';
- $ID3v2ShortFrameNameLookup[3]['language'] = 'TLAN';
- $ID3v2ShortFrameNameLookup[3]['length'] = 'TLEN';
- $ID3v2ShortFrameNameLookup[3]['media_type'] = 'TMED';
- $ID3v2ShortFrameNameLookup[3]['original_album'] = 'TOAL';
- $ID3v2ShortFrameNameLookup[3]['original_filename'] = 'TOFN';
- $ID3v2ShortFrameNameLookup[3]['original_lyricist'] = 'TOLY';
- $ID3v2ShortFrameNameLookup[3]['original_artist'] = 'TOPE';
- $ID3v2ShortFrameNameLookup[3]['file_owner'] = 'TOWN';
- $ID3v2ShortFrameNameLookup[3]['artist'] = 'TPE1';
- $ID3v2ShortFrameNameLookup[3]['band'] = 'TPE2';
- $ID3v2ShortFrameNameLookup[3]['conductor'] = 'TPE3';
- $ID3v2ShortFrameNameLookup[3]['remixer'] = 'TPE4';
- $ID3v2ShortFrameNameLookup[3]['part_of_a_set'] = 'TPOS';
- $ID3v2ShortFrameNameLookup[3]['publisher'] = 'TPUB';
- $ID3v2ShortFrameNameLookup[3]['tracknumber'] = 'TRCK';
- $ID3v2ShortFrameNameLookup[3]['track_number'] = 'TRCK';
- $ID3v2ShortFrameNameLookup[3]['internet_radio_station_name'] = 'TRSN';
- $ID3v2ShortFrameNameLookup[3]['internet_radio_station_owner'] = 'TRSO';
- $ID3v2ShortFrameNameLookup[3]['album_artist_sort_order'] = 'TSO2';
- $ID3v2ShortFrameNameLookup[3]['album_sort_order'] = 'TSOA';
- $ID3v2ShortFrameNameLookup[3]['composer_sort_order'] = 'TSOC';
- $ID3v2ShortFrameNameLookup[3]['performer_sort_order'] = 'TSOP';
- $ID3v2ShortFrameNameLookup[3]['title_sort_order'] = 'TSOT';
- $ID3v2ShortFrameNameLookup[3]['isrc'] = 'TSRC';
- $ID3v2ShortFrameNameLookup[3]['encoder_settings'] = 'TSSE';
- $ID3v2ShortFrameNameLookup[3]['text'] = 'TXXX';
- $ID3v2ShortFrameNameLookup[3]['unique_file_identifier'] = 'UFID';
- $ID3v2ShortFrameNameLookup[3]['terms_of_use'] = 'USER';
- $ID3v2ShortFrameNameLookup[3]['unsynchronised_lyric'] = 'USLT';
- $ID3v2ShortFrameNameLookup[3]['commercial_information'] = 'WCOM';
- $ID3v2ShortFrameNameLookup[3]['copyright'] = 'WCOP';
- $ID3v2ShortFrameNameLookup[3]['url_file'] = 'WOAF';
- $ID3v2ShortFrameNameLookup[3]['url_artist'] = 'WOAR';
- $ID3v2ShortFrameNameLookup[3]['url_source'] = 'WOAS';
- $ID3v2ShortFrameNameLookup[3]['url_station'] = 'WORS';
- $ID3v2ShortFrameNameLookup[3]['url_payment'] = 'WPAY';
- $ID3v2ShortFrameNameLookup[3]['url_publisher'] = 'WPUB';
- $ID3v2ShortFrameNameLookup[3]['url_user'] = 'WXXX';
-
- // The above are common to ID3v2.3 and ID3v2.4
- // so copy them to ID3v2.4 before adding specifics for 2.3 and 2.4
- $ID3v2ShortFrameNameLookup[4] = $ID3v2ShortFrameNameLookup[3];
-
- // The following are unique to ID3v2.3
- $ID3v2ShortFrameNameLookup[3]['equalisation'] = 'EQUA';
- $ID3v2ShortFrameNameLookup[3]['involved_people_list'] = 'IPLS';
- $ID3v2ShortFrameNameLookup[3]['relative_volume_adjustment'] = 'RVAD';
- $ID3v2ShortFrameNameLookup[3]['date'] = 'TDAT';
- $ID3v2ShortFrameNameLookup[3]['time'] = 'TIME';
- $ID3v2ShortFrameNameLookup[3]['original_year'] = 'TORY';
- $ID3v2ShortFrameNameLookup[3]['recording_dates'] = 'TRDA';
- $ID3v2ShortFrameNameLookup[3]['size'] = 'TSIZ';
- $ID3v2ShortFrameNameLookup[3]['year'] = 'TYER';
-
-
- // The following are unique to ID3v2.4
- $ID3v2ShortFrameNameLookup[4]['audio_seek_point_index'] = 'ASPI';
- $ID3v2ShortFrameNameLookup[4]['equalisation'] = 'EQU2';
- $ID3v2ShortFrameNameLookup[4]['relative_volume_adjustment'] = 'RVA2';
- $ID3v2ShortFrameNameLookup[4]['seek_frame'] = 'SEEK';
- $ID3v2ShortFrameNameLookup[4]['signature_frame'] = 'SIGN';
- $ID3v2ShortFrameNameLookup[4]['encoding_time'] = 'TDEN';
- $ID3v2ShortFrameNameLookup[4]['original_release_time'] = 'TDOR';
- $ID3v2ShortFrameNameLookup[4]['recording_time'] = 'TDRC';
- $ID3v2ShortFrameNameLookup[4]['release_time'] = 'TDRL';
- $ID3v2ShortFrameNameLookup[4]['tagging_time'] = 'TDTG';
- $ID3v2ShortFrameNameLookup[4]['involved_people_list'] = 'TIPL';
- $ID3v2ShortFrameNameLookup[4]['musician_credits_list'] = 'TMCL';
- $ID3v2ShortFrameNameLookup[4]['mood'] = 'TMOO';
- $ID3v2ShortFrameNameLookup[4]['produced_notice'] = 'TPRO';
- $ID3v2ShortFrameNameLookup[4]['album_sort_order'] = 'TSOA';
- $ID3v2ShortFrameNameLookup[4]['performer_sort_order'] = 'TSOP';
- $ID3v2ShortFrameNameLookup[4]['title_sort_order'] = 'TSOT';
- $ID3v2ShortFrameNameLookup[4]['set_subtitle'] = 'TSST';
- $ID3v2ShortFrameNameLookup[4]['year'] = 'TDRC'; // subset of ISO 8601: valid timestamps are yyyy, yyyy-MM, yyyy-MM-dd, yyyy-MM-ddTHH, yyyy-MM-ddTHH:mm and yyyy-MM-ddTHH:mm:ss. All time stamps are UTC
- }
- return (isset($ID3v2ShortFrameNameLookup[$majorversion][strtolower($long_description)]) ? $ID3v2ShortFrameNameLookup[$majorversion][strtolower($long_description)] : '');
-
- }
-
- }
|