1ffa1965f4
git-svn-id: http://php-reader.googlecode.com/svn/trunk@145 51a70ab9-7547-0410-9469-37e369ee0574
254 lines
8.2 KiB
PHP
254 lines
8.2 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$
|
|
*/
|
|
|
|
/**#@+ @ignore */
|
|
require_once("ID3/Frame.php");
|
|
require_once("ID3/Encoding.php");
|
|
/**#@-*/
|
|
|
|
/**
|
|
* In the <i>General encapsulated object</i> frame any type of file can be
|
|
* encapsulated.
|
|
*
|
|
* @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$
|
|
*/
|
|
final class ID3_Frame_GEOB extends ID3_Frame
|
|
implements ID3_Encoding
|
|
{
|
|
/** @var integer */
|
|
private $_encoding;
|
|
|
|
/** @var string */
|
|
private $_mimeType;
|
|
|
|
/** @var string */
|
|
private $_filename;
|
|
|
|
/** @var string */
|
|
private $_description;
|
|
|
|
/** @var string */
|
|
private $_objectData;
|
|
|
|
/**
|
|
* Constructs the class with given parameters and parses object related data.
|
|
*
|
|
* @param Reader $reader The reader object.
|
|
* @param Array $options The options array.
|
|
*/
|
|
public function __construct($reader = null, &$options = array())
|
|
{
|
|
parent::__construct($reader, $options);
|
|
|
|
$this->_encoding = $this->getOption("encoding", ID3_Encoding::UTF8);
|
|
|
|
if ($reader === null)
|
|
return;
|
|
|
|
$encoding = Transform::fromUInt8($this->_data[0]);
|
|
$this->_mimeType = substr
|
|
($this->_data, 1, ($pos = strpos($this->_data, "\0", 1)) - 1);
|
|
$this->_data = substr($this->_data, $pos + 1);
|
|
|
|
switch ($encoding) {
|
|
case self::UTF16:
|
|
list ($this->_filename, $this->_description, $this->_objectData) =
|
|
$this->_explodeString16($this->_data, 3);
|
|
$this->_filename = $this->_convertString
|
|
(Transform::fromString16($this->_filename), "utf-16");
|
|
$this->_description = $this->_convertString
|
|
(Transform::fromString16($this->_description), "utf-16");
|
|
break;
|
|
case self::UTF16BE:
|
|
list ($this->_filename, $this->_description, $this->_objectData) =
|
|
$this->_explodeString16($this->_data, 3);
|
|
$this->_filename = $this->_convertString
|
|
(Transform::fromString16($this->_filename), "utf-16be");
|
|
$this->_description = $this->_convertString
|
|
(Transform::fromString16($this->_description), "utf-16be");
|
|
break;
|
|
case self::UTF8:
|
|
list ($this->_filename, $this->_description, $this->_objectData) =
|
|
$this->_explodeString8($this->_data, 3);
|
|
$this->_filename = $this->_convertString
|
|
(Transform::fromString8($this->_filename), "utf-8");
|
|
$this->_description = $this->_convertString
|
|
(Transform::fromString8($this->_description), "utf-8");
|
|
break;
|
|
default:
|
|
list ($this->_filename, $this->_description, $this->_objectData) =
|
|
$this->_explodeString8($this->_data, 3);
|
|
$this->_filename = $this->_convertString
|
|
(Transform::fromString8($this->_filename), "iso-8859-1");
|
|
$this->_description = $this->_convertString
|
|
(Transform::fromString8($this->_description), "iso-8859-1");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the text encoding.
|
|
*
|
|
* All the strings read from a file are automatically converted to the
|
|
* character encoding specified with the <var>encoding</var> option. See
|
|
* {@link ID3v2} for details. This method returns the original text encoding
|
|
* used to write the frame.
|
|
*
|
|
* @return integer
|
|
*/
|
|
public function getEncoding() { return $this->_encoding; }
|
|
|
|
/**
|
|
* Sets the text encoding.
|
|
*
|
|
* All the string written to the frame are done so using given character
|
|
* encoding. No conversions of existing data take place upon the call to this
|
|
* method thus all texts must be given in given character encoding.
|
|
*
|
|
* The default character encoding used to write the frame is UTF-8.
|
|
*
|
|
* @see ID3_Encoding
|
|
* @param integer $encoding The text encoding.
|
|
*/
|
|
public function setEncoding($encoding) { $this->_encoding = $encoding; }
|
|
|
|
/**
|
|
* Returns the MIME type. The MIME type is always encoded with ISO-8859-1.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getMimeType() { return $this->_mimeType; }
|
|
|
|
/**
|
|
* Sets the MIME type. The MIME type is always ISO-8859-1 encoded.
|
|
*
|
|
* @param string $mimeType The MIME type.
|
|
*/
|
|
public function setMimeType($mimeType) { $this->_mimeType = $mimeType; }
|
|
|
|
/**
|
|
* Returns the file name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getFilename() { return $this->_filename; }
|
|
|
|
/**
|
|
* Sets the file name using given encoding. The file name encoding must be
|
|
* that of the description text.
|
|
*
|
|
* @param string $description The file description text.
|
|
* @param integer $encoding The text encoding.
|
|
*/
|
|
public function setFilename($filename, $encoding = false)
|
|
{
|
|
$this->_filename = $filename;
|
|
if ($encoding !== false)
|
|
$this->_encoding = $encoding;
|
|
}
|
|
|
|
/**
|
|
* Returns the file description.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getDescription() { return $this->_description; }
|
|
|
|
/**
|
|
* Sets the file description text using given encoding. The description
|
|
* encoding must be that of the file name.
|
|
*
|
|
* @param string $description The file description text.
|
|
* @param integer $encoding The text encoding.
|
|
*/
|
|
public function setDescription($description, $encoding = false)
|
|
{
|
|
$this->_description = $description;
|
|
if ($encoding !== false)
|
|
$this->_encoding = $encoding;
|
|
}
|
|
|
|
/**
|
|
* Returns the embedded object binary data.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getObjectData() { return $this->_objectData; }
|
|
|
|
/**
|
|
* Sets the embedded object binary data.
|
|
*
|
|
* @param string $objectData The object data.
|
|
*/
|
|
public function setObjectData($objectData)
|
|
{
|
|
$this->_objectData = $objectData;
|
|
}
|
|
|
|
/**
|
|
* Returns the frame raw data without the header.
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function _getData()
|
|
{
|
|
$data = Transform::toUInt8($this->_encoding) . $this->_mimeType . "\0";
|
|
switch ($this->_encoding) {
|
|
case self::UTF16LE:
|
|
$data .= Transform::toString16
|
|
($this->_filename, Transform::LITTLE_ENDIAN_ORDER, 1) .
|
|
Transform::toString16
|
|
($this->_description, Transform::LITTLE_ENDIAN_ORDER, 1);
|
|
break;
|
|
case self::UTF16:
|
|
case self::UTF16BE:
|
|
$data .= Transform::toString16($this->_filename, false, 1) .
|
|
Transform::toString16($this->_description, false, 1);
|
|
break;
|
|
default:
|
|
$data .= $this->_filename . "\0" . $this->_description . "\0";
|
|
}
|
|
return $data . $this->_objectData;
|
|
}
|
|
}
|