wp-includes/ID3/getid3.lib.php

   1 <?php
   2 /////////////////////////////////////////////////////////////////
   3 /// getID3() by James Heinrich <info@getid3.org>               //
   4 //  available at http://getid3.sourceforge.net                 //
   5 //            or http://www.getid3.org                         //
   6 /////////////////////////////////////////////////////////////////
   7 //                                                             //
   8 // getid3.lib.php - part of getID3()                           //
   9 // See readme.txt for more details                             //
  10 //                                                            ///
  11 /////////////////////////////////////////////////////////////////
  12
  13
  14 class getid3_lib
  15 {
  16
  17         public static function PrintHexBytes($string, $hex=true, $spaces=true, $htmlencoding='UTF-8') {
  18                 $returnstring = '';
  19                 for ($i = 0; $i < strlen($string); $i++) {
  20                         if ($hex) {
  21                                 $returnstring .= str_pad(dechex(ord($string{$i})), 2, '0', STR_PAD_LEFT);
  22                         } else {
  23                                 $returnstring .= ' '.(preg_match("#[\x20-\x7E]#", $string{$i}) ? $string{$i} : '¤');
  24                         }
  25                         if ($spaces) {
  26                                 $returnstring .= ' ';
  27                         }
  28                 }
  29                 if (!empty($htmlencoding)) {
  30                         if ($htmlencoding === true) {
  31                                 $htmlencoding = 'UTF-8'; // prior to getID3 v1.9.0 the function's 4th parameter was boolean
  32                         }
  33                         $returnstring = htmlentities($returnstring, ENT_QUOTES, $htmlencoding);
  34                 }
  35                 return $returnstring;
  36         }
  37
  38         public static function trunc($floatnumber) {
  39                 // truncates a floating-point number at the decimal point
  40                 // returns int (if possible, otherwise float)
  41                 if ($floatnumber >= 1) {
  42                         $truncatednumber = floor($floatnumber);
  43                 } elseif ($floatnumber <= -1) {
  44                         $truncatednumber = ceil($floatnumber);
  45                 } else {
  46                         $truncatednumber = 0;
  47                 }
  48                 if (self::intValueSupported($truncatednumber)) {
  49                         $truncatednumber = (int) $truncatednumber;
  50                 }
  51                 return $truncatednumber;
  52         }
  53
  54
  55         public static function safe_inc(&$variable, $increment=1) {
  56                 if (isset($variable)) {
  57                         $variable += $increment;
  58                 } else {
  59                         $variable = $increment;
  60                 }
  61                 return true;
  62         }
  63
  64         public static function CastAsInt($floatnum) {
  65                 // convert to float if not already
  66                 $floatnum = (float) $floatnum;
  67
  68                 // convert a float to type int, only if possible
  69                 if (self::trunc($floatnum) == $floatnum) {
  70                         // it's not floating point
  71                         if (self::intValueSupported($floatnum)) {
  72                                 // it's within int range
  73                                 $floatnum = (int) $floatnum;
  74                         }
  75                 }
  76                 return $floatnum;
  77         }
  78
  79         public static function intValueSupported($num) {
  80                 // check if integers are 64-bit
  81                 static $hasINT64 = null;
  82                 if ($hasINT64 === null) { // 10x faster than is_null()
  83                         $hasINT64 = is_int(pow(2, 31)); // 32-bit int are limited to (2^31)-1
  84                         if (!$hasINT64 && !defined('PHP_INT_MIN')) {
  85                                 define('PHP_INT_MIN', ~PHP_INT_MAX);
  86                         }
  87                 }
  88                 // if integers are 64-bit - no other check required
  89                 if ($hasINT64 || (($num <= PHP_INT_MAX) && ($num >= PHP_INT_MIN))) {
  90                         return true;
  91                 }
  92                 return false;
  93         }
  94
  95         public static function DecimalizeFraction($fraction) {
  96                 list($numerator, $denominator) = explode('/', $fraction);
  97                 return $numerator / ($denominator ? $denominator : 1);
  98         }
  99
 100
 101         public static function DecimalBinary2Float($binarynumerator) {
 102                 $numerator   = self::Bin2Dec($binarynumerator);
 103                 $denominator = self::Bin2Dec('1'.str_repeat('0', strlen($binarynumerator)));
 104                 return ($numerator / $denominator);
 105         }
 106
 107
 108         public static function NormalizeBinaryPoint($binarypointnumber, $maxbits=52) {
 109                 // http://www.scri.fsu.edu/~jac/MAD3401/Backgrnd/binary.html
 110                 if (strpos($binarypointnumber, '.') === false) {
 111                         $binarypointnumber = '0.'.$binarypointnumber;
 112                 } elseif ($binarypointnumber{0} == '.') {
 113                         $binarypointnumber = '0'.$binarypointnumber;
 114                 }
 115                 $exponent = 0;
 116                 while (($binarypointnumber{0} != '1') || (substr($binarypointnumber, 1, 1) != '.')) {
 117                         if (substr($binarypointnumber, 1, 1) == '.') {
 118                                 $exponent--;
 119                                 $binarypointnumber = substr($binarypointnumber, 2, 1).'.'.substr($binarypointnumber, 3);
 120                         } else {
 121                                 $pointpos = strpos($binarypointnumber, '.');
 122                                 $exponent += ($pointpos - 1);
 123                                 $binarypointnumber = str_replace('.', '', $binarypointnumber);
 124                                 $binarypointnumber = $binarypointnumber{0}.'.'.substr($binarypointnumber, 1);
 125                         }
 126                 }
 127                 $binarypointnumber = str_pad(substr($binarypointnumber, 0, $maxbits + 2), $maxbits + 2, '0', STR_PAD_RIGHT);
 128                 return array('normalized'=>$binarypointnumber, 'exponent'=>(int) $exponent);
 129         }
 130
 131
 132         public static function Float2BinaryDecimal($floatvalue) {
 133                 // http://www.scri.fsu.edu/~jac/MAD3401/Backgrnd/binary.html
 134                 $maxbits = 128; // to how many bits of precision should the calculations be taken?
 135                 $intpart   = self::trunc($floatvalue);
 136                 $floatpart = abs($floatvalue - $intpart);
 137                 $pointbitstring = '';
 138                 while (($floatpart != 0) && (strlen($pointbitstring) < $maxbits)) {
 139                         $floatpart *= 2;
 140                         $pointbitstring .= (string) self::trunc($floatpart);
 141                         $floatpart -= self::trunc($floatpart);
 142                 }
 143                 $binarypointnumber = decbin($intpart).'.'.$pointbitstring;
 144                 return $binarypointnumber;
 145         }
 146
 147
 148         public static function Float2String($floatvalue, $bits) {
 149                 // http://www.scri.fsu.edu/~jac/MAD3401/Backgrnd/ieee-expl.html
 150                 switch ($bits) {
 151                         case 32:
 152                                 $exponentbits = 8;
 153                                 $fractionbits = 23;
 154                                 break;
 155
 156                         case 64:
 157                                 $exponentbits = 11;
 158                                 $fractionbits = 52;
 159                                 break;
 160
 161                         default:
 162                                 return false;
 163                                 break;
 164                 }
 165                 if ($floatvalue >= 0) {
 166                         $signbit = '0';
 167                 } else {
 168                         $signbit = '1';
 169                 }
 170                 $normalizedbinary  = self::NormalizeBinaryPoint(self::Float2BinaryDecimal($floatvalue), $fractionbits);
 171                 $biasedexponent    = pow(2, $exponentbits - 1) - 1 + $normalizedbinary['exponent']; // (127 or 1023) +/- exponent
 172                 $exponentbitstring = str_pad(decbin($biasedexponent), $exponentbits, '0', STR_PAD_LEFT);
 173                 $fractionbitstring = str_pad(substr($normalizedbinary['normalized'], 2), $fractionbits, '0', STR_PAD_RIGHT);
 174
 175                 return self::BigEndian2String(self::Bin2Dec($signbit.$exponentbitstring.$fractionbitstring), $bits % 8, false);
 176         }
 177
 178
 179         public static function LittleEndian2Float($byteword) {
 180                 return self::BigEndian2Float(strrev($byteword));
 181         }
 182
 183
 184         public static function BigEndian2Float($byteword) {
 185                 // ANSI/IEEE Standard 754-1985, Standard for Binary Floating Point Arithmetic
 186                 // http://www.psc.edu/general/software/packages/ieee/ieee.html
 187                 // http://www.scri.fsu.edu/~jac/MAD3401/Backgrnd/ieee.html
 188
 189                 $bitword = self::BigEndian2Bin($byteword);
 190                 if (!$bitword) {
 191                         return 0;
 192                 }
 193                 $signbit = $bitword{0};
 194
 195                 switch (strlen($byteword) * 8) {
 196                         case 32:
 197                                 $exponentbits = 8;
 198                                 $fractionbits = 23;
 199                                 break;
 200
 201                         case 64:
 202                                 $exponentbits = 11;
 203                                 $fractionbits = 52;
 204                                 break;
 205
 206                         case 80:
 207                                 // 80-bit Apple SANE format
 208                                 // http://www.mactech.com/articles/mactech/Vol.06/06.01/SANENormalized/
 209                                 $exponentstring = substr($bitword, 1, 15);
 210                                 $isnormalized = intval($bitword{16});
 211                                 $fractionstring = substr($bitword, 17, 63);
 212                                 $exponent = pow(2, self::Bin2Dec($exponentstring) - 16383);
 213                                 $fraction = $isnormalized + self::DecimalBinary2Float($fractionstring);
 214                                 $floatvalue = $exponent * $fraction;
 215                                 if ($signbit == '1') {
 216                                         $floatvalue *= -1;
 217                                 }
 218                                 return $floatvalue;
 219                                 break;
 220
 221                         default:
 222                                 return false;
 223                                 break;
 224                 }
 225                 $exponentstring = substr($bitword, 1, $exponentbits);
 226                 $fractionstring = substr($bitword, $exponentbits + 1, $fractionbits);
 227                 $exponent = self::Bin2Dec($exponentstring);
 228                 $fraction = self::Bin2Dec($fractionstring);
 229
 230                 if (($exponent == (pow(2, $exponentbits) - 1)) && ($fraction != 0)) {
 231                         // Not a Number
 232                         $floatvalue = false;
 233                 } elseif (($exponent == (pow(2, $exponentbits) - 1)) && ($fraction == 0)) {
 234                         if ($signbit == '1') {
 235                                 $floatvalue = '-infinity';
 236                         } else {
 237                                 $floatvalue = '+infinity';
 238                         }
 239                 } elseif (($exponent == 0) && ($fraction == 0)) {
 240                         if ($signbit == '1') {
 241                                 $floatvalue = -0;
 242                         } else {
 243                                 $floatvalue = 0;
 244                         }
 245                         $floatvalue = ($signbit ? 0 : -0);
 246                 } elseif (($exponent == 0) && ($fraction != 0)) {
 247                         // These are 'unnormalized' values
 248                         $floatvalue = pow(2, (-1 * (pow(2, $exponentbits - 1) - 2))) * self::DecimalBinary2Float($fractionstring);
 249                         if ($signbit == '1') {
 250                                 $floatvalue *= -1;
 251                         }
 252                 } elseif ($exponent != 0) {
 253                         $floatvalue = pow(2, ($exponent - (pow(2, $exponentbits - 1) - 1))) * (1 + self::DecimalBinary2Float($fractionstring));
 254                         if ($signbit == '1') {
 255                                 $floatvalue *= -1;
 256                         }
 257                 }
 258                 return (float) $floatvalue;
 259         }
 260
 261
 262         public static function BigEndian2Int($byteword, $synchsafe=false, $signed=false) {
 263                 $intvalue = 0;
 264                 $bytewordlen = strlen($byteword);
 265                 if ($bytewordlen == 0) {
 266                         return false;
 267                 }
 268                 for ($i = 0; $i < $bytewordlen; $i++) {
 269                         if ($synchsafe) { // disregard MSB, effectively 7-bit bytes
 270                                 //$intvalue = $intvalue | (ord($byteword{$i}) & 0x7F) << (($bytewordlen - 1 - $i) * 7); // faster, but runs into problems past 2^31 on 32-bit systems
 271                                 $intvalue += (ord($byteword{$i}) & 0x7F) * pow(2, ($bytewordlen - 1 - $i) * 7);
 272                         } else {
 273                                 $intvalue += ord($byteword{$i}) * pow(256, ($bytewordlen - 1 - $i));
 274                         }
 275                 }
 276                 if ($signed && !$synchsafe) {
 277                         // synchsafe ints are not allowed to be signed
 278                         if ($bytewordlen <= PHP_INT_SIZE) {
 279                                 $signMaskBit = 0x80 << (8 * ($bytewordlen - 1));
 280                                 if ($intvalue & $signMaskBit) {
 281                                         $intvalue = 0 - ($intvalue & ($signMaskBit - 1));
 282                                 }
 283                         } else {
 284                                 throw new Exception('ERROR: Cannot have signed integers larger than '.(8 * PHP_INT_SIZE).'-bits ('.strlen($byteword).') in self::BigEndian2Int()');
 285                                 break;
 286                         }
 287                 }
 288                 return self::CastAsInt($intvalue);
 289         }
 290
 291
 292         public static function LittleEndian2Int($byteword, $signed=false) {
 293                 return self::BigEndian2Int(strrev($byteword), false, $signed);
 294         }
 295
 296
 297         public static function BigEndian2Bin($byteword) {
 298                 $binvalue = '';
 299                 $bytewordlen = strlen($byteword);
 300                 for ($i = 0; $i < $bytewordlen; $i++) {
 301                         $binvalue .= str_pad(decbin(ord($byteword{$i})), 8, '0', STR_PAD_LEFT);
 302                 }
 303                 return $binvalue;
 304         }
 305
 306
 307         public static function BigEndian2String($number, $minbytes=1, $synchsafe=false, $signed=false) {
 308                 if ($number < 0) {
 309                         throw new Exception('ERROR: self::BigEndian2String() does not support negative numbers');
 310                 }
 311                 $maskbyte = (($synchsafe || $signed) ? 0x7F : 0xFF);
 312                 $intstring = '';
 313                 if ($signed) {
 314                         if ($minbytes > PHP_INT_SIZE) {
 315                                 throw new Exception('ERROR: Cannot have signed integers larger than '.(8 * PHP_INT_SIZE).'-bits in self::BigEndian2String()');
 316                         }
 317                         $number = $number & (0x80 << (8 * ($minbytes - 1)));
 318                 }
 319                 while ($number != 0) {
 320                         $quotient = ($number / ($maskbyte + 1));
 321                         $intstring = chr(ceil(($quotient - floor($quotient)) * $maskbyte)).$intstring;
 322                         $number = floor($quotient);
 323                 }
 324                 return str_pad($intstring, $minbytes, "\x00", STR_PAD_LEFT);
 325         }
 326
 327
 328         public static function Dec2Bin($number) {
 329                 while ($number >= 256) {
 330                         $bytes[] = (($number / 256) - (floor($number / 256))) * 256;
 331                         $number = floor($number / 256);
 332                 }
 333                 $bytes[] = $number;
 334                 $binstring = '';
 335                 for ($i = 0; $i < count($bytes); $i++) {
 336                         $binstring = (($i == count($bytes) - 1) ? decbin($bytes[$i]) : str_pad(decbin($bytes[$i]), 8, '0', STR_PAD_LEFT)).$binstring;
 337                 }
 338                 return $binstring;
 339         }
 340
 341
 342         public static function Bin2Dec($binstring, $signed=false) {
 343                 $signmult = 1;
 344                 if ($signed) {
 345                         if ($binstring{0} == '1') {
 346                                 $signmult = -1;
 347                         }
 348                         $binstring = substr($binstring, 1);
 349                 }
 350                 $decvalue = 0;
 351                 for ($i = 0; $i < strlen($binstring); $i++) {
 352                         $decvalue += ((int) substr($binstring, strlen($binstring) - $i - 1, 1)) * pow(2, $i);
 353                 }
 354                 return self::CastAsInt($decvalue * $signmult);
 355         }
 356
 357
 358         public static function Bin2String($binstring) {
 359                 // return 'hi' for input of '0110100001101001'
 360                 $string = '';
 361                 $binstringreversed = strrev($binstring);
 362                 for ($i = 0; $i < strlen($binstringreversed); $i += 8) {
 363                         $string = chr(self::Bin2Dec(strrev(substr($binstringreversed, $i, 8)))).$string;
 364                 }
 365                 return $string;
 366         }
 367
 368
 369         public static function LittleEndian2String($number, $minbytes=1, $synchsafe=false) {
 370                 $intstring = '';
 371                 while ($number > 0) {
 372                         if ($synchsafe) {
 373                                 $intstring = $intstring.chr($number & 127);
 374                                 $number >>= 7;
 375                         } else {
 376                                 $intstring = $intstring.chr($number & 255);
 377                                 $number >>= 8;
 378                         }
 379                 }
 380                 return str_pad($intstring, $minbytes, "\x00", STR_PAD_RIGHT);
 381         }
 382
 383
 384         public static function array_merge_clobber($array1, $array2) {
 385                 // written by kcØhireability*com
 386                 // taken from http://www.php.net/manual/en/function.array-merge-recursive.php
 387                 if (!is_array($array1) || !is_array($array2)) {
 388                         return false;
 389                 }
 390                 $newarray = $array1;
 391                 foreach ($array2 as $key => $val) {
 392                         if (is_array($val) && isset($newarray[$key]) && is_array($newarray[$key])) {
 393                                 $newarray[$key] = self::array_merge_clobber($newarray[$key], $val);
 394                         } else {
 395                                 $newarray[$key] = $val;
 396                         }
 397                 }
 398                 return $newarray;
 399         }
 400
 401
 402         public static function array_merge_noclobber($array1, $array2) {
 403                 if (!is_array($array1) || !is_array($array2)) {
 404                         return false;
 405                 }
 406                 $newarray = $array1;
 407                 foreach ($array2 as $key => $val) {
 408                         if (is_array($val) && isset($newarray[$key]) && is_array($newarray[$key])) {
 409                                 $newarray[$key] = self::array_merge_noclobber($newarray[$key], $val);
 410                         } elseif (!isset($newarray[$key])) {
 411                                 $newarray[$key] = $val;
 412                         }
 413                 }
 414                 return $newarray;
 415         }
 416
 417
 418         public static function ksort_recursive(&$theArray) {
 419                 ksort($theArray);
 420                 foreach ($theArray as $key => $value) {
 421                         if (is_array($value)) {
 422                                 self::ksort_recursive($theArray[$key]);
 423                         }
 424                 }
 425                 return true;
 426         }
 427
 428         public static function fileextension($filename, $numextensions=1) {
 429                 if (strstr($filename, '.')) {
 430                         $reversedfilename = strrev($filename);
 431                         $offset = 0;
 432                         for ($i = 0; $i < $numextensions; $i++) {
 433                                 $offset = strpos($reversedfilename, '.', $offset + 1);
 434                                 if ($offset === false) {
 435                                         return '';
 436                                 }
 437                         }
 438                         return strrev(substr($reversedfilename, 0, $offset));
 439                 }
 440                 return '';
 441         }
 442
 443
 444         public static function PlaytimeString($seconds) {
 445                 $sign = (($seconds < 0) ? '-' : '');
 446                 $seconds = round(abs($seconds));
 447                 $H = (int) floor( $seconds                            / 3600);
 448                 $M = (int) floor(($seconds - (3600 * $H)            ) /   60);
 449                 $S = (int) round( $seconds - (3600 * $H) - (60 * $M)        );
 450                 return $sign.($H ? $H.':' : '').($H ? str_pad($M, 2, '0', STR_PAD_LEFT) : intval($M)).':'.str_pad($S, 2, 0, STR_PAD_LEFT);
 451         }
 452
 453
 454         public static function DateMac2Unix($macdate) {
 455                 // Macintosh timestamp: seconds since 00:00h January 1, 1904
 456                 // UNIX timestamp:      seconds since 00:00h January 1, 1970
 457                 return self::CastAsInt($macdate - 2082844800);
 458         }
 459
 460
 461         public static function FixedPoint8_8($rawdata) {
 462                 return self::BigEndian2Int(substr($rawdata, 0, 1)) + (float) (self::BigEndian2Int(substr($rawdata, 1, 1)) / pow(2, 8));
 463         }
 464
 465
 466         public static function FixedPoint16_16($rawdata) {
 467                 return self::BigEndian2Int(substr($rawdata, 0, 2)) + (float) (self::BigEndian2Int(substr($rawdata, 2, 2)) / pow(2, 16));
 468         }
 469
 470
 471         public static function FixedPoint2_30($rawdata) {
 472                 $binarystring = self::BigEndian2Bin($rawdata);
 473                 return self::Bin2Dec(substr($binarystring, 0, 2)) + (float) (self::Bin2Dec(substr($binarystring, 2, 30)) / pow(2, 30));
 474         }
 475
 476
 477         public static function CreateDeepArray($ArrayPath, $Separator, $Value) {
 478                 // assigns $Value to a nested array path:
 479                 //   $foo = self::CreateDeepArray('/path/to/my', '/', 'file.txt')
 480                 // is the same as:
 481                 //   $foo = array('path'=>array('to'=>'array('my'=>array('file.txt'))));
 482                 // or
 483                 //   $foo['path']['to']['my'] = 'file.txt';
 484                 $ArrayPath = ltrim($ArrayPath, $Separator);
 485                 if (($pos = strpos($ArrayPath, $Separator)) !== false) {
 486                         $ReturnedArray[substr($ArrayPath, 0, $pos)] = self::CreateDeepArray(substr($ArrayPath, $pos + 1), $Separator, $Value);
 487                 } else {
 488                         $ReturnedArray[$ArrayPath] = $Value;
 489                 }
 490                 return $ReturnedArray;
 491         }
 492
 493         public static function array_max($arraydata, $returnkey=false) {
 494                 $maxvalue = false;
 495                 $maxkey = false;
 496                 foreach ($arraydata as $key => $value) {
 497                         if (!is_array($value)) {
 498                                 if ($value > $maxvalue) {
 499                                         $maxvalue = $value;
 500                                         $maxkey = $key;
 501                                 }
 502                         }
 503                 }
 504                 return ($returnkey ? $maxkey : $maxvalue);
 505         }
 506
 507         public static function array_min($arraydata, $returnkey=false) {
 508                 $minvalue = false;
 509                 $minkey = false;
 510                 foreach ($arraydata as $key => $value) {
 511                         if (!is_array($value)) {
 512                                 if ($value > $minvalue) {
 513                                         $minvalue = $value;
 514                                         $minkey = $key;
 515                                 }
 516                         }
 517                 }
 518                 return ($returnkey ? $minkey : $minvalue);
 519         }
 520
 521         public static function XML2array($XMLstring) {
 522                 if ( function_exists( 'simplexml_load_string' ) && function_exists( 'libxml_disable_entity_loader' ) ) {
 523                         $loader = libxml_disable_entity_loader( true );
 524                         $XMLobject = simplexml_load_string( $XMLstring, 'SimpleXMLElement', LIBXML_NOENT );
 525                         $return = self::SimpleXMLelement2array( $XMLobject );
 526                         libxml_disable_entity_loader( $loader );
 527                         return $return;
 528                 }
 529                 return false;
 530         }
 531
 532         public static function SimpleXMLelement2array($XMLobject) {
 533                 if (!is_object($XMLobject) && !is_array($XMLobject)) {
 534                         return $XMLobject;
 535                 }
 536                 $XMLarray = (is_object($XMLobject) ? get_object_vars($XMLobject) : $XMLobject);
 537                 foreach ($XMLarray as $key => $value) {
 538                         $XMLarray[$key] = self::SimpleXMLelement2array($value);
 539                 }
 540                 return $XMLarray;
 541         }
 542
 543
 544         // Allan Hansen <ahØartemis*dk>
 545         // self::md5_data() - returns md5sum for a file from startuing position to absolute end position
 546         public static function hash_data($file, $offset, $end, $algorithm) {
 547                 static $tempdir = '';
 548                 if (!self::intValueSupported($end)) {
 549                         return false;
 550                 }
 551                 switch ($algorithm) {
 552                         case 'md5':
 553                                 $hash_function = 'md5_file';
 554                                 $unix_call     = 'md5sum';
 555                                 $windows_call  = 'md5sum.exe';
 556                                 $hash_length   = 32;
 557                                 break;
 558
 559                         case 'sha1':
 560                                 $hash_function = 'sha1_file';
 561                                 $unix_call     = 'sha1sum';
 562                                 $windows_call  = 'sha1sum.exe';
 563                                 $hash_length   = 40;
 564                                 break;
 565
 566                         default:
 567                                 throw new Exception('Invalid algorithm ('.$algorithm.') in self::hash_data()');
 568                                 break;
 569                 }
 570                 $size = $end - $offset;
 571                 while (true) {
 572                         if (GETID3_OS_ISWINDOWS) {
 573
 574                                 // It seems that sha1sum.exe for Windows only works on physical files, does not accept piped data
 575                                 // Fall back to create-temp-file method:
 576                                 if ($algorithm == 'sha1') {
 577                                         break;
 578                                 }
 579
 580                                 $RequiredFiles = array('cygwin1.dll', 'head.exe', 'tail.exe', $windows_call);
 581                                 foreach ($RequiredFiles as $required_file) {
 582                                         if (!is_readable(GETID3_HELPERAPPSDIR.$required_file)) {
 583                                                 // helper apps not available - fall back to old method
 584                                                 break 2;
 585                                         }
 586                                 }
 587                                 $commandline  = GETID3_HELPERAPPSDIR.'head.exe -c '.$end.' '.escapeshellarg(str_replace('/', DIRECTORY_SEPARATOR, $file)).' | ';
 588                                 $commandline .= GETID3_HELPERAPPSDIR.'tail.exe -c '.$size.' | ';
 589                                 $commandline .= GETID3_HELPERAPPSDIR.$windows_call;
 590
 591                         } else {
 592
 593                                 $commandline  = 'head -c'.$end.' '.escapeshellarg($file).' | ';
 594                                 $commandline .= 'tail -c'.$size.' | ';
 595                                 $commandline .= $unix_call;
 596
 597                         }
 598                         if (preg_match('#(1|ON)#i', ini_get('safe_mode'))) {
 599                                 //throw new Exception('PHP running in Safe Mode - backtick operator not available, using slower non-system-call '.$algorithm.' algorithm');
 600                                 break;
 601                         }
 602                         return substr(`$commandline`, 0, $hash_length);
 603                 }
 604
 605                 if (empty($tempdir)) {
 606                         // yes this is ugly, feel free to suggest a better way
 607                         require_once(dirname(__FILE__).'/getid3.php');
 608                         $getid3_temp = new getID3();
 609                         $tempdir = $getid3_temp->tempdir;
 610                         unset($getid3_temp);
 611                 }
 612                 // try to create a temporary file in the system temp directory - invalid dirname should force to system temp dir
 613                 if (($data_filename = tempnam($tempdir, 'gI3')) === false) {
 614                         // can't find anywhere to create a temp file, just fail
 615                         return false;
 616                 }
 617
 618                 // Init
 619                 $result = false;
 620
 621                 // copy parts of file
 622                 try {
 623                         self::CopyFileParts($file, $data_filename, $offset, $end - $offset);
 624                         $result = $hash_function($data_filename);
 625                 } catch (Exception $e) {
 626                         throw new Exception('self::CopyFileParts() failed in getid_lib::hash_data(): '.$e->getMessage());
 627                 }
 628                 unlink($data_filename);
 629                 return $result;
 630         }
 631
 632         public static function CopyFileParts($filename_source, $filename_dest, $offset, $length) {
 633                 if (!self::intValueSupported($offset + $length)) {
 634                         throw new Exception('cannot copy file portion, it extends beyond the '.round(PHP_INT_MAX / 1073741824).'GB limit');
 635                 }
 636                 if (is_readable($filename_source) && is_file($filename_source) && ($fp_src = fopen($filename_source, 'rb'))) {
 637                         if (($fp_dest = fopen($filename_dest, 'wb'))) {
 638                                 if (fseek($fp_src, $offset, SEEK_SET) == 0) {
 639                                         $byteslefttowrite = $length;
 640                                         while (($byteslefttowrite > 0) && ($buffer = fread($fp_src, min($byteslefttowrite, getID3::FREAD_BUFFER_SIZE)))) {
 641                                                 $byteswritten = fwrite($fp_dest, $buffer, $byteslefttowrite);
 642                                                 $byteslefttowrite -= $byteswritten;
 643                                         }
 644                                         return true;
 645                                 } else {
 646                                         throw new Exception('failed to seek to offset '.$offset.' in '.$filename_source);
 647                                 }
 648                                 fclose($fp_dest);
 649                         } else {
 650                                 throw new Exception('failed to create file for writing '.$filename_dest);
 651                         }
 652                         fclose($fp_src);
 653                 } else {
 654                         throw new Exception('failed to open file for reading '.$filename_source);
 655                 }
 656                 return false;
 657         }
 658
 659         public static function iconv_fallback_int_utf8($charval) {
 660                 if ($charval < 128) {
 661                         // 0bbbbbbb
 662                         $newcharstring = chr($charval);
 663                 } elseif ($charval < 2048) {
 664                         // 110bbbbb 10bbbbbb
 665                         $newcharstring  = chr(($charval >>   6) | 0xC0);
 666                         $newcharstring .= chr(($charval & 0x3F) | 0x80);
 667                 } elseif ($charval < 65536) {
 668                         // 1110bbbb 10bbbbbb 10bbbbbb
 669                         $newcharstring  = chr(($charval >>  12) | 0xE0);
 670                         $newcharstring .= chr(($charval >>   6) | 0xC0);
 671                         $newcharstring .= chr(($charval & 0x3F) | 0x80);
 672                 } else {
 673                         // 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
 674                         $newcharstring  = chr(($charval >>  18) | 0xF0);
 675                         $newcharstring .= chr(($charval >>  12) | 0xC0);
 676                         $newcharstring .= chr(($charval >>   6) | 0xC0);
 677                         $newcharstring .= chr(($charval & 0x3F) | 0x80);
 678                 }
 679                 return $newcharstring;
 680         }
 681
 682         // ISO-8859-1 => UTF-8
 683         public static function iconv_fallback_iso88591_utf8($string, $bom=false) {
 684                 if (function_exists('utf8_encode')) {
 685                         return utf8_encode($string);
 686                 }
 687                 // utf8_encode() unavailable, use getID3()'s iconv_fallback() conversions (possibly PHP is compiled without XML support)
 688                 $newcharstring = '';
 689                 if ($bom) {
 690                         $newcharstring .= "\xEF\xBB\xBF";
 691                 }
 692                 for ($i = 0; $i < strlen($string); $i++) {
 693                         $charval = ord($string{$i});
 694                         $newcharstring .= self::iconv_fallback_int_utf8($charval);
 695                 }
 696                 return $newcharstring;
 697         }
 698
 699         // ISO-8859-1 => UTF-16BE
 700         public static function iconv_fallback_iso88591_utf16be($string, $bom=false) {
 701                 $newcharstring = '';
 702                 if ($bom) {
 703                         $newcharstring .= "\xFE\xFF";
 704                 }
 705                 for ($i = 0; $i < strlen($string); $i++) {
 706                         $newcharstring .= "\x00".$string{$i};
 707                 }
 708                 return $newcharstring;
 709         }
 710
 711         // ISO-8859-1 => UTF-16LE
 712         public static function iconv_fallback_iso88591_utf16le($string, $bom=false) {
 713                 $newcharstring = '';
 714                 if ($bom) {
 715                         $newcharstring .= "\xFF\xFE";
 716                 }
 717                 for ($i = 0; $i < strlen($string); $i++) {
 718                         $newcharstring .= $string{$i}."\x00";
 719                 }
 720                 return $newcharstring;
 721         }
 722
 723         // ISO-8859-1 => UTF-16LE (BOM)
 724         public static function iconv_fallback_iso88591_utf16($string) {
 725                 return self::iconv_fallback_iso88591_utf16le($string, true);
 726         }
 727
 728         // UTF-8 => ISO-8859-1
 729         public static function iconv_fallback_utf8_iso88591($string) {
 730                 if (function_exists('utf8_decode')) {
 731                         return utf8_decode($string);
 732                 }
 733                 // utf8_decode() unavailable, use getID3()'s iconv_fallback() conversions (possibly PHP is compiled without XML support)
 734                 $newcharstring = '';
 735                 $offset = 0;
 736                 $stringlength = strlen($string);
 737                 while ($offset < $stringlength) {
 738                         if ((ord($string{$offset}) | 0x07) == 0xF7) {
 739                                 // 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
 740                                 $charval = ((ord($string{($offset + 0)}) & 0x07) << 18) &
 741                                                    ((ord($string{($offset + 1)}) & 0x3F) << 12) &
 742                                                    ((ord($string{($offset + 2)}) & 0x3F) <<  6) &
 743                                                         (ord($string{($offset + 3)}) & 0x3F);
 744                                 $offset += 4;
 745                         } elseif ((ord($string{$offset}) | 0x0F) == 0xEF) {
 746                                 // 1110bbbb 10bbbbbb 10bbbbbb
 747                                 $charval = ((ord($string{($offset + 0)}) & 0x0F) << 12) &
 748                                                    ((ord($string{($offset + 1)}) & 0x3F) <<  6) &
 749                                                         (ord($string{($offset + 2)}) & 0x3F);
 750                                 $offset += 3;
 751                         } elseif ((ord($string{$offset}) | 0x1F) == 0xDF) {
 752                                 // 110bbbbb 10bbbbbb
 753                                 $charval = ((ord($string{($offset + 0)}) & 0x1F) <<  6) &
 754                                                         (ord($string{($offset + 1)}) & 0x3F);
 755                                 $offset += 2;
 756                         } elseif ((ord($string{$offset}) | 0x7F) == 0x7F) {
 757                                 // 0bbbbbbb
 758                                 $charval = ord($string{$offset});
 759                                 $offset += 1;
 760                         } else {
 761                                 // error? throw some kind of warning here?
 762                                 $charval = false;
 763                                 $offset += 1;
 764                         }
 765                         if ($charval !== false) {
 766                                 $newcharstring .= (($charval < 256) ? chr($charval) : '?');
 767                         }
 768                 }
 769                 return $newcharstring;
 770         }
 771
 772         // UTF-8 => UTF-16BE
 773         public static function iconv_fallback_utf8_utf16be($string, $bom=false) {
 774                 $newcharstring = '';
 775                 if ($bom) {
 776                         $newcharstring .= "\xFE\xFF";
 777                 }
 778                 $offset = 0;
 779                 $stringlength = strlen($string);
 780                 while ($offset < $stringlength) {
 781                         if ((ord($string{$offset}) | 0x07) == 0xF7) {
 782                                 // 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
 783                                 $charval = ((ord($string{($offset + 0)}) & 0x07) << 18) &
 784                                                    ((ord($string{($offset + 1)}) & 0x3F) << 12) &
 785                                                    ((ord($string{($offset + 2)}) & 0x3F) <<  6) &
 786                                                         (ord($string{($offset + 3)}) & 0x3F);
 787                                 $offset += 4;
 788                         } elseif ((ord($string{$offset}) | 0x0F) == 0xEF) {
 789                                 // 1110bbbb 10bbbbbb 10bbbbbb
 790                                 $charval = ((ord($string{($offset + 0)}) & 0x0F) << 12) &
 791                                                    ((ord($string{($offset + 1)}) & 0x3F) <<  6) &
 792                                                         (ord($string{($offset + 2)}) & 0x3F);
 793                                 $offset += 3;
 794                         } elseif ((ord($string{$offset}) | 0x1F) == 0xDF) {
 795                                 // 110bbbbb 10bbbbbb
 796                                 $charval = ((ord($string{($offset + 0)}) & 0x1F) <<  6) &
 797                                                         (ord($string{($offset + 1)}) & 0x3F);
 798                                 $offset += 2;
 799                         } elseif ((ord($string{$offset}) | 0x7F) == 0x7F) {
 800                                 // 0bbbbbbb
 801                                 $charval = ord($string{$offset});
 802                                 $offset += 1;
 803                         } else {
 804                                 // error? throw some kind of warning here?
 805                                 $charval = false;
 806                                 $offset += 1;
 807                         }
 808                         if ($charval !== false) {
 809                                 $newcharstring .= (($charval < 65536) ? self::BigEndian2String($charval, 2) : "\x00".'?');
 810                         }
 811                 }
 812                 return $newcharstring;
 813         }
 814
 815         // UTF-8 => UTF-16LE
 816         public static function iconv_fallback_utf8_utf16le($string, $bom=false) {
 817                 $newcharstring = '';
 818                 if ($bom) {
 819                         $newcharstring .= "\xFF\xFE";
 820                 }
 821                 $offset = 0;
 822                 $stringlength = strlen($string);
 823                 while ($offset < $stringlength) {
 824                         if ((ord($string{$offset}) | 0x07) == 0xF7) {
 825                                 // 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
 826                                 $charval = ((ord($string{($offset + 0)}) & 0x07) << 18) &
 827                                                    ((ord($string{($offset + 1)}) & 0x3F) << 12) &
 828                                                    ((ord($string{($offset + 2)}) & 0x3F) <<  6) &
 829                                                         (ord($string{($offset + 3)}) & 0x3F);
 830                                 $offset += 4;
 831                         } elseif ((ord($string{$offset}) | 0x0F) == 0xEF) {
 832                                 // 1110bbbb 10bbbbbb 10bbbbbb
 833                                 $charval = ((ord($string{($offset + 0)}) & 0x0F) << 12) &
 834                                                    ((ord($string{($offset + 1)}) & 0x3F) <<  6) &
 835                                                         (ord($string{($offset + 2)}) & 0x3F);
 836                                 $offset += 3;
 837                         } elseif ((ord($string{$offset}) | 0x1F) == 0xDF) {
 838                                 // 110bbbbb 10bbbbbb
 839                                 $charval = ((ord($string{($offset + 0)}) & 0x1F) <<  6) &
 840                                                         (ord($string{($offset + 1)}) & 0x3F);
 841                                 $offset += 2;
 842                         } elseif ((ord($string{$offset}) | 0x7F) == 0x7F) {
 843                                 // 0bbbbbbb
 844                                 $charval = ord($string{$offset});
 845                                 $offset += 1;
 846                         } else {
 847                                 // error? maybe throw some warning here?
 848                                 $charval = false;
 849                                 $offset += 1;
 850                         }
 851                         if ($charval !== false) {
 852                                 $newcharstring .= (($charval < 65536) ? self::LittleEndian2String($charval, 2) : '?'."\x00");
 853                         }
 854                 }
 855                 return $newcharstring;
 856         }
 857
 858         // UTF-8 => UTF-16LE (BOM)
 859         public static function iconv_fallback_utf8_utf16($string) {
 860                 return self::iconv_fallback_utf8_utf16le($string, true);
 861         }
 862
 863         // UTF-16BE => UTF-8
 864         public static function iconv_fallback_utf16be_utf8($string) {
 865                 if (substr($string, 0, 2) == "\xFE\xFF") {
 866                         // strip BOM
 867                         $string = substr($string, 2);
 868                 }
 869                 $newcharstring = '';
 870                 for ($i = 0; $i < strlen($string); $i += 2) {
 871                         $charval = self::BigEndian2Int(substr($string, $i, 2));
 872                         $newcharstring .= self::iconv_fallback_int_utf8($charval);
 873                 }
 874                 return $newcharstring;
 875         }
 876
 877         // UTF-16LE => UTF-8
 878         public static function iconv_fallback_utf16le_utf8($string) {
 879                 if (substr($string, 0, 2) == "\xFF\xFE") {
 880                         // strip BOM
 881                         $string = substr($string, 2);
 882                 }
 883                 $newcharstring = '';
 884                 for ($i = 0; $i < strlen($string); $i += 2) {
 885                         $charval = self::LittleEndian2Int(substr($string, $i, 2));
 886                         $newcharstring .= self::iconv_fallback_int_utf8($charval);
 887                 }
 888                 return $newcharstring;
 889         }
 890
 891         // UTF-16BE => ISO-8859-1
 892         public static function iconv_fallback_utf16be_iso88591($string) {
 893                 if (substr($string, 0, 2) == "\xFE\xFF") {
 894                         // strip BOM
 895                         $string = substr($string, 2);
 896                 }
 897                 $newcharstring = '';
 898                 for ($i = 0; $i < strlen($string); $i += 2) {
 899                         $charval = self::BigEndian2Int(substr($string, $i, 2));
 900                         $newcharstring .= (($charval < 256) ? chr($charval) : '?');
 901                 }
 902                 return $newcharstring;
 903         }
 904
 905         // UTF-16LE => ISO-8859-1
 906         public static function iconv_fallback_utf16le_iso88591($string) {
 907                 if (substr($string, 0, 2) == "\xFF\xFE") {
 908                         // strip BOM
 909                         $string = substr($string, 2);
 910                 }
 911                 $newcharstring = '';
 912                 for ($i = 0; $i < strlen($string); $i += 2) {
 913                         $charval = self::LittleEndian2Int(substr($string, $i, 2));
 914                         $newcharstring .= (($charval < 256) ? chr($charval) : '?');
 915                 }
 916                 return $newcharstring;
 917         }
 918
 919         // UTF-16 (BOM) => ISO-8859-1
 920         public static function iconv_fallback_utf16_iso88591($string) {
 921                 $bom = substr($string, 0, 2);
 922                 if ($bom == "\xFE\xFF") {
 923                         return self::iconv_fallback_utf16be_iso88591(substr($string, 2));
 924                 } elseif ($bom == "\xFF\xFE") {
 925                         return self::iconv_fallback_utf16le_iso88591(substr($string, 2));
 926                 }
 927                 return $string;
 928         }
 929
 930         // UTF-16 (BOM) => UTF-8
 931         public static function iconv_fallback_utf16_utf8($string) {
 932                 $bom = substr($string, 0, 2);
 933                 if ($bom == "\xFE\xFF") {
 934                         return self::iconv_fallback_utf16be_utf8(substr($string, 2));
 935                 } elseif ($bom == "\xFF\xFE") {
 936                         return self::iconv_fallback_utf16le_utf8(substr($string, 2));
 937                 }
 938                 return $string;
 939         }
 940
 941         public static function iconv_fallback($in_charset, $out_charset, $string) {
 942
 943                 if ($in_charset == $out_charset) {
 944                         return $string;
 945                 }
 946
 947                 // iconv() availble
 948                 if (function_exists('iconv')) {
 949                         if ($converted_string = @iconv($in_charset, $out_charset.'//TRANSLIT', $string)) {
 950                                 switch ($out_charset) {
 951                                         case 'ISO-8859-1':
 952                                                 $converted_string = rtrim($converted_string, "\x00");
 953                                                 break;
 954                                 }
 955                                 return $converted_string;
 956                         }
 957
 958                         // iconv() may sometimes fail with "illegal character in input string" error message
 959                         // and return an empty string, but returning the unconverted string is more useful
 960                         return $string;
 961                 }
 962
 963
 964                 // iconv() not available
 965                 static $ConversionFunctionList = array();
 966                 if (empty($ConversionFunctionList)) {
 967                         $ConversionFunctionList['ISO-8859-1']['UTF-8']    = 'iconv_fallback_iso88591_utf8';
 968                         $ConversionFunctionList['ISO-8859-1']['UTF-16']   = 'iconv_fallback_iso88591_utf16';
 969                         $ConversionFunctionList['ISO-8859-1']['UTF-16BE'] = 'iconv_fallback_iso88591_utf16be';
 970                         $ConversionFunctionList['ISO-8859-1']['UTF-16LE'] = 'iconv_fallback_iso88591_utf16le';
 971                         $ConversionFunctionList['UTF-8']['ISO-8859-1']    = 'iconv_fallback_utf8_iso88591';
 972                         $ConversionFunctionList['UTF-8']['UTF-16']        = 'iconv_fallback_utf8_utf16';
 973                         $ConversionFunctionList['UTF-8']['UTF-16BE']      = 'iconv_fallback_utf8_utf16be';
 974                         $ConversionFunctionList['UTF-8']['UTF-16LE']      = 'iconv_fallback_utf8_utf16le';
 975                         $ConversionFunctionList['UTF-16']['ISO-8859-1']   = 'iconv_fallback_utf16_iso88591';
 976                         $ConversionFunctionList['UTF-16']['UTF-8']        = 'iconv_fallback_utf16_utf8';
 977                         $ConversionFunctionList['UTF-16LE']['ISO-8859-1'] = 'iconv_fallback_utf16le_iso88591';
 978                         $ConversionFunctionList['UTF-16LE']['UTF-8']      = 'iconv_fallback_utf16le_utf8';
 979                         $ConversionFunctionList['UTF-16BE']['ISO-8859-1'] = 'iconv_fallback_utf16be_iso88591';
 980                         $ConversionFunctionList['UTF-16BE']['UTF-8']      = 'iconv_fallback_utf16be_utf8';
 981                 }
 982                 if (isset($ConversionFunctionList[strtoupper($in_charset)][strtoupper($out_charset)])) {
 983                         $ConversionFunction = $ConversionFunctionList[strtoupper($in_charset)][strtoupper($out_charset)];
 984                         return self::$ConversionFunction($string);
 985                 }
 986                 throw new Exception('PHP does not have iconv() support - cannot convert from '.$in_charset.' to '.$out_charset);
 987         }
 988
 989
 990         public static function MultiByteCharString2HTML($string, $charset='ISO-8859-1') {
 991                 $string = (string) $string; // in case trying to pass a numeric (float, int) string, would otherwise return an empty string
 992                 $HTMLstring = '';
 993
 994                 switch ($charset) {
 995                         case '1251':
 996                         case '1252':
 997                         case '866':
 998                         case '932':
 999                         case '936':
1000                         case '950':
1001                         case 'BIG5':
1002                         case 'BIG5-HKSCS':
1003                         case 'cp1251':
1004                         case 'cp1252':
1005                         case 'cp866':
1006                         case 'EUC-JP':
1007                         case 'EUCJP':
1008                         case 'GB2312':
1009                         case 'ibm866':
1010                         case 'ISO-8859-1':
1011                         case 'ISO-8859-15':
1012                         case 'ISO8859-1':
1013                         case 'ISO8859-15':
1014                         case 'KOI8-R':
1015                         case 'koi8-ru':
1016                         case 'koi8r':
1017                         case 'Shift_JIS':
1018                         case 'SJIS':
1019                         case 'win-1251':
1020                         case 'Windows-1251':
1021                         case 'Windows-1252':
1022                                 $HTMLstring = htmlentities($string, ENT_COMPAT, $charset);
1023                                 break;
1024
1025                         case 'UTF-8':
1026                                 $strlen = strlen($string);
1027                                 for ($i = 0; $i < $strlen; $i++) {
1028                                         $char_ord_val = ord($string{$i});
1029                                         $charval = 0;
1030                                         if ($char_ord_val < 0x80) {
1031                                                 $charval = $char_ord_val;
1032                                         } elseif ((($char_ord_val & 0xF0) >> 4) == 0x0F  &&  $i+3 < $strlen) {
1033                                                 $charval  = (($char_ord_val & 0x07) << 18);
1034                                                 $charval += ((ord($string{++$i}) & 0x3F) << 12);
1035                                                 $charval += ((ord($string{++$i}) & 0x3F) << 6);
1036                                                 $charval +=  (ord($string{++$i}) & 0x3F);
1037                                         } elseif ((($char_ord_val & 0xE0) >> 5) == 0x07  &&  $i+2 < $strlen) {
1038                                                 $charval  = (($char_ord_val & 0x0F) << 12);
1039                                                 $charval += ((ord($string{++$i}) & 0x3F) << 6);
1040                                                 $charval +=  (ord($string{++$i}) & 0x3F);
1041                                         } elseif ((($char_ord_val & 0xC0) >> 6) == 0x03  &&  $i+1 < $strlen) {
1042                                                 $charval  = (($char_ord_val & 0x1F) << 6);
1043                                                 $charval += (ord($string{++$i}) & 0x3F);
1044                                         }
1045                                         if (($charval >= 32) && ($charval <= 127)) {
1046                                                 $HTMLstring .= htmlentities(chr($charval));
1047                                         } else {
1048                                                 $HTMLstring .= '&#'.$charval.';';
1049                                         }
1050                                 }
1051                                 break;
1052
1053                         case 'UTF-16LE':
1054                                 for ($i = 0; $i < strlen($string); $i += 2) {
1055                                         $charval = self::LittleEndian2Int(substr($string, $i, 2));
1056                                         if (($charval >= 32) && ($charval <= 127)) {
1057                                                 $HTMLstring .= chr($charval);
1058                                         } else {
1059                                                 $HTMLstring .= '&#'.$charval.';';
1060                                         }
1061                                 }
1062                                 break;
1063
1064                         case 'UTF-16BE':
1065                                 for ($i = 0; $i < strlen($string); $i += 2) {
1066                                         $charval = self::BigEndian2Int(substr($string, $i, 2));
1067                                         if (($charval >= 32) && ($charval <= 127)) {
1068                                                 $HTMLstring .= chr($charval);
1069                                         } else {
1070                                                 $HTMLstring .= '&#'.$charval.';';
1071                                         }
1072                                 }
1073                                 break;
1074
1075                         default:
1076                                 $HTMLstring = 'ERROR: Character set "'.$charset.'" not supported in MultiByteCharString2HTML()';
1077                                 break;
1078                 }
1079                 return $HTMLstring;
1080         }
1081
1082
1083
1084         public static function RGADnameLookup($namecode) {
1085                 static $RGADname = array();
1086                 if (empty($RGADname)) {
1087                         $RGADname[0] = 'not set';
1088                         $RGADname[1] = 'Track Gain Adjustment';
1089                         $RGADname[2] = 'Album Gain Adjustment';
1090                 }
1091
1092                 return (isset($RGADname[$namecode]) ? $RGADname[$namecode] : '');
1093         }
1094
1095
1096         public static function RGADoriginatorLookup($originatorcode) {
1097                 static $RGADoriginator = array();
1098                 if (empty($RGADoriginator)) {
1099                         $RGADoriginator[0] = 'unspecified';
1100                         $RGADoriginator[1] = 'pre-set by artist/producer/mastering engineer';
1101                         $RGADoriginator[2] = 'set by user';
1102                         $RGADoriginator[3] = 'determined automatically';
1103                 }
1104
1105                 return (isset($RGADoriginator[$originatorcode]) ? $RGADoriginator[$originatorcode] : '');
1106         }
1107
1108
1109         public static function RGADadjustmentLookup($rawadjustment, $signbit) {
1110                 $adjustment = $rawadjustment / 10;
1111                 if ($signbit == 1) {
1112                         $adjustment *= -1;
1113                 }
1114                 return (float) $adjustment;
1115         }
1116
1117
1118         public static function RGADgainString($namecode, $originatorcode, $replaygain) {
1119                 if ($replaygain < 0) {
1120                         $signbit = '1';
1121                 } else {
1122                         $signbit = '0';
1123                 }
1124                 $storedreplaygain = intval(round($replaygain * 10));
1125                 $gainstring  = str_pad(decbin($namecode), 3, '0', STR_PAD_LEFT);
1126                 $gainstring .= str_pad(decbin($originatorcode), 3, '0', STR_PAD_LEFT);
1127                 $gainstring .= $signbit;
1128                 $gainstring .= str_pad(decbin($storedreplaygain), 9, '0', STR_PAD_LEFT);
1129
1130                 return $gainstring;
1131         }
1132
1133         public static function RGADamplitude2dB($amplitude) {
1134                 return 20 * log10($amplitude);
1135         }
1136
1137
1138         public static function GetDataImageSize($imgData, &$imageinfo=array()) {
1139                 static $tempdir = '';
1140                 if (empty($tempdir)) {
1141                         // yes this is ugly, feel free to suggest a better way
1142                         require_once(dirname(__FILE__).'/getid3.php');
1143                         $getid3_temp = new getID3();
1144                         $tempdir = $getid3_temp->tempdir;
1145                         unset($getid3_temp);
1146                 }
1147                 $GetDataImageSize = false;
1148                 if ($tempfilename = tempnam($tempdir, 'gI3')) {
1149                         if (is_writable($tempfilename) && is_file($tempfilename) && ($tmp = fopen($tempfilename, 'wb'))) {
1150                                 fwrite($tmp, $imgData);
1151                                 fclose($tmp);
1152                                 $GetDataImageSize = @getimagesize($tempfilename, $imageinfo);
1153                         }
1154                         unlink($tempfilename);
1155                 }
1156                 return $GetDataImageSize;
1157         }
1158
1159         public static function ImageExtFromMime($mime_type) {
1160                 // temporary way, works OK for now, but should be reworked in the future
1161                 return str_replace(array('image/', 'x-', 'jpeg'), array('', '', 'jpg'), $mime_type);
1162         }
1163
1164         public static function ImageTypesLookup($imagetypeid) {
1165                 static $ImageTypesLookup = array();
1166                 if (empty($ImageTypesLookup)) {
1167                         $ImageTypesLookup[1]  = 'gif';
1168                         $ImageTypesLookup[2]  = 'jpeg';
1169                         $ImageTypesLookup[3]  = 'png';
1170                         $ImageTypesLookup[4]  = 'swf';
1171                         $ImageTypesLookup[5]  = 'psd';
1172                         $ImageTypesLookup[6]  = 'bmp';
1173                         $ImageTypesLookup[7]  = 'tiff (little-endian)';
1174                         $ImageTypesLookup[8]  = 'tiff (big-endian)';
1175                         $ImageTypesLookup[9]  = 'jpc';
1176                         $ImageTypesLookup[10] = 'jp2';
1177                         $ImageTypesLookup[11] = 'jpx';
1178                         $ImageTypesLookup[12] = 'jb2';
1179                         $ImageTypesLookup[13] = 'swc';
1180                         $ImageTypesLookup[14] = 'iff';
1181                 }
1182                 return (isset($ImageTypesLookup[$imagetypeid]) ? $ImageTypesLookup[$imagetypeid] : '');
1183         }
1184
1185         public static function CopyTagsToComments(&$ThisFileInfo) {
1186
1187                 // Copy all entries from ['tags'] into common ['comments']
1188                 if (!empty($ThisFileInfo['tags'])) {
1189                         foreach ($ThisFileInfo['tags'] as $tagtype => $tagarray) {
1190                                 foreach ($tagarray as $tagname => $tagdata) {
1191                                         foreach ($tagdata as $key => $value) {
1192                                                 if (!empty($value)) {
1193                                                         if (empty($ThisFileInfo['comments'][$tagname])) {
1194
1195                                                                 // fall through and append value
1196
1197                                                         } elseif ($tagtype == 'id3v1') {
1198
1199                                                                 $newvaluelength = strlen(trim($value));
1200                                                                 foreach ($ThisFileInfo['comments'][$tagname] as $existingkey => $existingvalue) {
1201                                                                         $oldvaluelength = strlen(trim($existingvalue));
1202                                                                         if (($newvaluelength <= $oldvaluelength) && (substr($existingvalue, 0, $newvaluelength) == trim($value))) {
1203                                                                                 // new value is identical but shorter-than (or equal-length to) one already in comments - skip
1204                                                                                 break 2;
1205                                                                         }
1206                                                                 }
1207
1208                                                         } elseif (!is_array($value)) {
1209
1210                                                                 $newvaluelength = strlen(trim($value));
1211                                                                 foreach ($ThisFileInfo['comments'][$tagname] as $existingkey => $existingvalue) {
1212                                                                         $oldvaluelength = strlen(trim($existingvalue));
1213                                                                         if (($newvaluelength > $oldvaluelength) && (substr(trim($value), 0, strlen($existingvalue)) == $existingvalue)) {
1214                                                                                 $ThisFileInfo['comments'][$tagname][$existingkey] = trim($value);
1215                                                                                 break 2;
1216                                                                         }
1217                                                                 }
1218
1219                                                         }
1220                                                         if (is_array($value) || empty($ThisFileInfo['comments'][$tagname]) || !in_array(trim($value), $ThisFileInfo['comments'][$tagname])) {
1221                                                                 $value = (is_string($value) ? trim($value) : $value);
1222                                                                 $ThisFileInfo['comments'][$tagname][] = $value;
1223                                                         }
1224                                                 }
1225                                         }
1226                                 }
1227                         }
1228
1229                         // Copy to ['comments_html']
1230                         foreach ($ThisFileInfo['comments'] as $field => $values) {
1231                                 if ($field == 'picture') {
1232                                         // pictures can take up a lot of space, and we don't need multiple copies of them
1233                                         // let there be a single copy in [comments][picture], and not elsewhere
1234                                         continue;
1235                                 }
1236                                 foreach ($values as $index => $value) {
1237                                         if (is_array($value)) {
1238                                                 $ThisFileInfo['comments_html'][$field][$index] = $value;
1239                                         } else {
1240                                                 $ThisFileInfo['comments_html'][$field][$index] = str_replace('&#0;', '', self::MultiByteCharString2HTML($value, $ThisFileInfo['encoding']));
1241                                         }
1242                                 }
1243                         }
1244                 }
1245                 return true;
1246         }
1247
1248
1249         public static function EmbeddedLookup($key, $begin, $end, $file, $name) {
1250
1251                 // Cached
1252                 static $cache;
1253                 if (isset($cache[$file][$name])) {
1254                         return (isset($cache[$file][$name][$key]) ? $cache[$file][$name][$key] : '');
1255                 }
1256
1257                 // Init
1258                 $keylength  = strlen($key);
1259                 $line_count = $end - $begin - 7;
1260
1261                 // Open php file
1262                 $fp = fopen($file, 'r');
1263
1264                 // Discard $begin lines
1265                 for ($i = 0; $i < ($begin + 3); $i++) {
1266                         fgets($fp, 1024);
1267                 }
1268
1269                 // Loop thru line
1270                 while (0 < $line_count--) {
1271
1272                         // Read line
1273                         $line = ltrim(fgets($fp, 1024), "\t ");
1274
1275                         // METHOD A: only cache the matching key - less memory but slower on next lookup of not-previously-looked-up key
1276                         //$keycheck = substr($line, 0, $keylength);
1277                         //if ($key == $keycheck)  {
1278                         //      $cache[$file][$name][$keycheck] = substr($line, $keylength + 1);
1279                         //      break;
1280                         //}
1281
1282                         // METHOD B: cache all keys in this lookup - more memory but faster on next lookup of not-previously-looked-up key
1283                         //$cache[$file][$name][substr($line, 0, $keylength)] = trim(substr($line, $keylength + 1));
1284                         $explodedLine = explode("\t", $line, 2);
1285                         $ThisKey   = (isset($explodedLine[0]) ? $explodedLine[0] : '');
1286                         $ThisValue = (isset($explodedLine[1]) ? $explodedLine[1] : '');
1287                         $cache[$file][$name][$ThisKey] = trim($ThisValue);
1288                 }
1289
1290                 // Close and return
1291                 fclose($fp);
1292                 return (isset($cache[$file][$name][$key]) ? $cache[$file][$name][$key] : '');
1293         }
1294
1295         public static function IncludeDependency($filename, $sourcefile, $DieOnFailure=false) {
1296                 global $GETID3_ERRORARRAY;
1297
1298                 if (file_exists($filename)) {
1299                         if (include_once($filename)) {
1300                                 return true;
1301                         } else {
1302                                 $diemessage = basename($sourcefile).' depends on '.$filename.', which has errors';
1303                         }
1304                 } else {
1305                         $diemessage = basename($sourcefile).' depends on '.$filename.', which is missing';
1306                 }
1307                 if ($DieOnFailure) {
1308                         throw new Exception($diemessage);
1309                 } else {
1310                         $GETID3_ERRORARRAY[] = $diemessage;
1311                 }
1312                 return false;
1313         }
1314
1315         public static function trimNullByte($string) {
1316                 return trim($string, "\x00");
1317         }
1318
1319         public static function getFileSizeSyscall($path) {
1320                 $filesize = false;
1321
1322                 if (GETID3_OS_ISWINDOWS) {
1323                         if (class_exists('COM')) { // From PHP 5.3.15 and 5.4.5, COM and DOTNET is no longer built into the php core.you have to add COM support in php.ini:
1324                                 $filesystem = new COM('Scripting.FileSystemObject');
1325                                 $file = $filesystem->GetFile($path);
1326                                 $filesize = $file->Size();
1327                                 unset($filesystem, $file);
1328                         } else {
1329                                 $commandline = 'for %I in ('.escapeshellarg($path).') do @echo %~zI';
1330                         }
1331                 } else {
1332                         $commandline = 'ls -l '.escapeshellarg($path).' | awk \'{print $5}\'';
1333                 }
1334                 if (isset($commandline)) {
1335                         $output = trim(`$commandline`);
1336                         if (ctype_digit($output)) {
1337                                 $filesize = (float) $output;
1338                         }
1339                 }
1340                 return $filesize;
1341         }
1342 }