1b8eed275f
git-svn-id: http://php-reader.googlecode.com/svn/trunk@138 51a70ab9-7547-0410-9469-37e369ee0574
290 lines
8.6 KiB
PHP
290 lines
8.6 KiB
PHP
<?php
|
|
/**
|
|
* PHP Reader Library
|
|
*
|
|
* Copyright (c) 2008-2009 The PHP Reader Project Workgroup. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* - Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
* - Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
* - Neither the name of the project workgroup nor the names of its
|
|
* contributors may be used to endorse or promote products derived from this
|
|
* software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* @package php-reader
|
|
* @subpackage ID3
|
|
* @copyright Copyright (c) 2008-2009 The PHP Reader Project Workgroup
|
|
* @license http://code.google.com/p/php-reader/wiki/License New BSD License
|
|
* @version $Id$
|
|
*/
|
|
|
|
/**
|
|
* The base class for all ID3v2 objects.
|
|
*
|
|
* @package php-reader
|
|
* @subpackage ID3
|
|
* @author Sven Vollbehr <svollbehr@gmail.com>
|
|
* @author Ryan Butterfield <buttza@gmail.com>
|
|
* @copyright Copyright (c) 2008-2009 The PHP Reader Project Workgroup
|
|
* @license http://code.google.com/p/php-reader/wiki/License New BSD License
|
|
* @version $Rev$
|
|
*/
|
|
abstract class ID3_Object
|
|
{
|
|
/**
|
|
* The reader object.
|
|
*
|
|
* @var Reader
|
|
*/
|
|
protected $_reader;
|
|
|
|
/**
|
|
* The options array.
|
|
*
|
|
* @var Array
|
|
*/
|
|
private $_options;
|
|
|
|
/**
|
|
* Constructs the class with given parameters.
|
|
*
|
|
* @param Reader $reader The reader object.
|
|
* @param Array $options The options array.
|
|
*/
|
|
public function __construct($reader = null, &$options = array())
|
|
{
|
|
$this->_reader = $reader;
|
|
$this->_options = &$options;
|
|
}
|
|
|
|
/**
|
|
* Returns the options array.
|
|
*
|
|
* @return Array
|
|
*/
|
|
public final function getOptions() { return $this->_options; }
|
|
|
|
/**
|
|
* Returns the given option value, or the default value if the option is not
|
|
* defined.
|
|
*
|
|
* @param string $option The name of the option.
|
|
* @param mixed $defaultValue The default value to be returned.
|
|
*/
|
|
public final function getOption($option, $defaultValue = false)
|
|
{
|
|
if (isset($this->_options[$option]))
|
|
return $this->_options[$option];
|
|
return $defaultValue;
|
|
}
|
|
|
|
/**
|
|
* Sets the options array. See {@link ID3v2} class for available options.
|
|
*
|
|
* @param Array $options The options array.
|
|
*/
|
|
public final function setOptions(&$options) { $this->_options = &$options; }
|
|
|
|
/**
|
|
* Sets the given option the given value.
|
|
*
|
|
* @param string $option The name of the option.
|
|
* @param mixed $value The value to set for the option.
|
|
*/
|
|
public final function setOption($option, $value)
|
|
{
|
|
$this->_options[$option] = $value;
|
|
}
|
|
|
|
/**
|
|
* Magic function so that $obj->value will work.
|
|
*
|
|
* @param string $name The field name.
|
|
* @return mixed
|
|
*/
|
|
public function __get($name)
|
|
{
|
|
if (method_exists($this, "get" . ucfirst($name)))
|
|
return call_user_func(array($this, "get" . ucfirst($name)));
|
|
else throw new ID3_Exception("Unknown field: " . $name);
|
|
}
|
|
|
|
/**
|
|
* Magic function so that assignments with $obj->value will work.
|
|
*
|
|
* @param string $name The field name.
|
|
* @param string $value The field value.
|
|
* @return mixed
|
|
*/
|
|
public function __set($name, $value)
|
|
{
|
|
if (method_exists($this, "set" . ucfirst($name)))
|
|
call_user_func
|
|
(array($this, "set" . ucfirst($name)), $value);
|
|
else throw new ID3_Exception("Unknown field: " . $name);
|
|
}
|
|
|
|
/**
|
|
* Encodes the given 32-bit integer to 28-bit synchsafe integer, where the
|
|
* most significant bit of each byte is zero, making seven bits out of eight
|
|
* available.
|
|
*
|
|
* @param integer $val The integer to encode.
|
|
* @return integer
|
|
*/
|
|
protected final function encodeSynchsafe32($val)
|
|
{
|
|
return ($val & 0x7f) | ($val & 0x3f80) << 1 |
|
|
($val & 0x1fc000) << 2 | ($val & 0xfe00000) << 3;
|
|
}
|
|
|
|
/**
|
|
* Decodes the given 28-bit synchsafe integer to regular 32-bit integer.
|
|
*
|
|
* @param integer $val The integer to decode
|
|
* @return integer
|
|
*/
|
|
protected final function decodeSynchsafe32($val)
|
|
{
|
|
return ($val & 0x7f) | ($val & 0x7f00) >> 1 |
|
|
($val & 0x7f0000) >> 2 | ($val & 0x7f000000) >> 3;
|
|
}
|
|
|
|
/**
|
|
* Applies the unsynchronisation scheme to the given data string.
|
|
*
|
|
* Whenever a false synchronisation is found within the data, one zeroed byte
|
|
* is inserted after the first false synchronisation byte. This has the side
|
|
* effect that all 0xff00 combinations have to be altered, so they will not
|
|
* be affected by the decoding process. Therefore all the 0xff00 combinations
|
|
* have to be replaced with the 0xff0000 combination during the
|
|
* unsynchronisation.
|
|
*
|
|
* @param string $data The input data.
|
|
* @return string
|
|
*/
|
|
protected final function encodeUnsynchronisation(&$data)
|
|
{
|
|
$result = "";
|
|
for ($i = 0, $j = 0; $i < strlen($data) - 1; $i++)
|
|
if (ord($data[$i]) == 0xff &&
|
|
((($tmp = ord($data[$i + 1])) & 0xe0) == 0xe0 || $tmp == 0x0)) {
|
|
$result .= substr($data, $j, $i + 1 - $j) . "\0";
|
|
$j = $i + 1;
|
|
}
|
|
return $result . substr($data, $j);
|
|
}
|
|
|
|
/**
|
|
* Reverses the unsynchronisation scheme from the given data string.
|
|
*
|
|
* @see encodeUnsynchronisation
|
|
* @param string $data The input data.
|
|
* @return string
|
|
*/
|
|
protected final function decodeUnsynchronisation(&$data)
|
|
{
|
|
$result = "";
|
|
for ($i = 0, $j = 0; $i < strlen($data) - 1; $i++)
|
|
if (ord($data[$i]) == 0xff && ord($data[$i + 1]) == 0x0) {
|
|
$result .= substr($data, $j, $i + 1 - $j);
|
|
$j = $i + 2;
|
|
}
|
|
return $result . substr($data, $j);
|
|
}
|
|
|
|
/**
|
|
* Splits UTF-16 formatted binary data up according to null terminators
|
|
* residing in the string, up to a given limit.
|
|
*
|
|
* @param string $value The input string.
|
|
* @return Array
|
|
*/
|
|
protected final function explodeString16($value, $limit = null)
|
|
{
|
|
$i = 0;
|
|
$array = array();
|
|
while (count($array) < $limit - 1 || $limit === null) {
|
|
$start = $i;
|
|
do {
|
|
$i = strpos($value, "\x00\x00", $i);
|
|
if ($i === false) {
|
|
$array[] = substr($value, $start);
|
|
return $array;
|
|
}
|
|
} while ($i & 0x1 != 0 && $i++); // make sure its aligned
|
|
$array[] = substr($value, $start, $i - $start);
|
|
$i += 2;
|
|
}
|
|
$array[] = substr($value, $i);
|
|
return $array;
|
|
}
|
|
|
|
/**
|
|
* Splits UTF-8 or ISO-8859-1 formatted binary data according to null
|
|
* terminators residing in the string, up to a given limit.
|
|
*
|
|
* @param string $value The input string.
|
|
* @return Array
|
|
*/
|
|
protected final function explodeString8($value, $limit = null)
|
|
{
|
|
return preg_split("/\\x00/", $value, $limit);
|
|
}
|
|
|
|
/**
|
|
* Converts string to requested character encoding and returns it. See the
|
|
* documentation of iconv for accepted values for encoding.
|
|
*
|
|
* @param string|Array $string
|
|
* @param string $encoding
|
|
*/
|
|
protected final function convertString($string, $encoding)
|
|
{
|
|
$target = $this->getOption("encoding", ID3_Encoding::UTF8);
|
|
switch ($target) {
|
|
case ID3_Encoding::UTF16:
|
|
$target = "utf-16";
|
|
break;
|
|
case ID3_Encoding::UTF16LE:
|
|
$target = "utf-16le";
|
|
break;
|
|
case ID3_Encoding::UTF16BE:
|
|
$target = "utf-16be";
|
|
break;
|
|
case ID3_Encoding::UTF8:
|
|
$target = "utf-8";
|
|
break;
|
|
default:
|
|
$target = "iso-8859-1";
|
|
}
|
|
|
|
if (strtolower($target) == strtolower($encoding))
|
|
return $string;
|
|
|
|
if (is_array($string))
|
|
foreach ($string as $key => $value)
|
|
$string[$key] = iconv($encoding, $target, $value);
|
|
else
|
|
$string = iconv($encoding, $target, $string);
|
|
return $string;
|
|
}
|
|
}
|