Unsynchronised lyrics/text transcription frame contains the lyrics * of the song or a text transcription of other vocal activities. There may be * more than one unsynchronised lyrics/text transcription frame in each tag, but * only one with the same language and content descriptor. * * @package php-reader * @subpackage ID3 * @author Sven Vollbehr * @author Ryan Butterfield * @copyright Copyright (c) 2008 The PHP Reader Project Workgroup * @license http://code.google.com/p/php-reader/wiki/License New BSD License * @version $Rev: 105 $ */ final class ID3_Frame_USLT extends ID3_Frame implements ID3_Encoding, ID3_Language { /** @var integer */ private $_encoding = ID3_Encoding::UTF8; /** @var string */ private $_language = "und"; /** @var string */ private $_description; /** @var string */ private $_text; /** * 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); if ($reader === null) return; $this->_encoding = Transform::fromUInt8($this->_data[0]); $this->_language = substr($this->_data, 1, 3); if ($this->_language == "XXX") $this->_language = "und"; $this->_data = substr($this->_data, 4); switch ($this->_encoding) { case self::UTF16: list ($this->_description, $this->_text) = $this->explodeString16($this->_data, 2); $this->_description = Transform::fromString16($this->_description); $this->_text = Transform::fromString16($this->_text); break; case self::UTF16BE: list ($this->_description, $this->_text) = $this->explodeString16($this->_data, 2); $this->_description = Transform::fromString16BE($this->_description); $this->_text = Transform::fromString16BE($this->_text); break; default: list ($this->_description, $this->_text) = $this->explodeString8($this->_data, 2); $this->_description = Transform::fromString8($this->_description); $this->_text = Transform::fromString8($this->_text); } } /** * Returns the text encoding. * * @return integer */ public function getEncoding() { return $this->_encoding; } /** * Sets the text encoding. * * @see ID3_Encoding * @param integer $encoding The text encoding. */ public function setEncoding($encoding) { $this->_encoding = $encoding; } /** * Returns the language code as specified in the * {@link http://www.loc.gov/standards/iso639-2/ ISO-639-2} standard. * * @return string */ public function getLanguage() { return $this->_language; } /** * Sets the text language code as specified in the * {@link http://www.loc.gov/standards/iso639-2/ ISO-639-2} standard. * * @see ID3_Language * @param string $language The language code. */ public function setLanguage($language) { if ($language == "XXX") $language = "und"; $this->_language = substr($language, 0, 3); } /** * Returns the short content description. * * @return string */ public function getDescription() { return $this->_description; } /** * Sets the content description text using given encoding. The description * language and encoding must be that of the actual text. * * @param string $description The content description text. * @param string $language The language code. * @param integer $encoding The text encoding. */ public function setDescription($description, $language = false, $encoding = false) { $this->_description = $description; if ($language !== false) $this->setLanguage($language); if ($encoding !== false) $this->setEncoding($encoding); } /** * Returns the lyrics/text. * * @return string */ public function getText() { return $this->_text; } /** * Sets the text using given encoding. The text language and encoding must be * that of the description text. * * @param mixed $text The test string. * @param string $language The language code. * @param integer $encoding The text encoding. */ public function setText($text, $language = false, $encoding = false) { $this->_text = $text; if ($language !== false) $this->setLanguage($language); if ($encoding !== false) $this->setEncoding($encoding); } /** * Returns the frame raw data. * * @return string */ public function __toString() { $data = Transform::toUInt8($this->_encoding) . $this->_language; switch ($this->_encoding) { case self::UTF16: case self::UTF16LE: $order = $this->_encoding == self::UTF16 ? Transform::MACHINE_ENDIAN_ORDER : Transform::LITTLE_ENDIAN_ORDER; $data .= Transform::toString16($this->_description, $order) . "\0\0" . Transform::toString16($this->_text, $order); break; case self::UTF16BE: $data .= Transform::toString16BE($this->_description) . "\0\0" . Transform::toString16BE($this->_text); break; default: $data .= $this->_description . "\0" . $this->_text; } $this->setData($data); return parent::__toString(); } }