Synchronised lyrics/text frame is another way of incorporating the * words, said or sung lyrics, in the audio file as text, this time, however, * in sync with the audio. It might also be used to describing events e.g. * occurring on a stage or on the screen in sync with the audio. * * There may be more than one SYLT 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_SYLT extends ID3_Frame implements ID3_Encoding, ID3_Language, ID3_Timing { /** * The list of content types. * * @var Array */ public static $types = array ("Other", "Lyrics", "Text transcription", "Movement/Part name", "Events", "Chord", "Trivia", "URLs to webpages", "URLs to images"); /** @var integer */ private $_encoding = ID3_Encoding::UTF8; /** @var string */ private $_language = "und"; /** @var integer */ private $_format = ID3_Timing::MPEG_FRAMES; /** @var integer */ private $_type = 0; /** @var string */ private $_description; /** @var Array */ private $_events = array(); /** * 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->_format = Transform::fromUInt8($this->_data[4]); $this->_type = Transform::fromUInt8($this->_data[5]); $this->_data = substr($this->_data, 6); switch ($this->_encoding) { case self::UTF16: list($this->_description, $this->_data) = $this->explodeString16($this->_data, 2); $this->_description = Transform::fromString16($this->_description); break; case self::UTF16BE: list($this->_description, $this->_data) = $this->explodeString16($this->_data, 2); $this->_description = Transform::fromString16BE($this->_description); break; default: list($this->_description, $this->_data) = $this->explodeString8($this->_data, 2); $this->_description = Transform::fromString8($this->_description); } while (strlen($this->_data) > 0) { switch ($this->_encoding) { case self::UTF16: list($syllable, $this->_data) = $this->explodeString16($this->_data, 2); $syllable = Transform::fromString16($syllable); break; case self::UTF16BE: list($syllable, $this->_data) = $this->explodeString16($this->_data, 2); $syllable = Transform::fromString16BE($syllable); break; default: list($syllable, $this->_data) = $this->explodeString8($this->_data, 2); $syllable = Transform::fromString8($syllable); } $this->_events[Transform::fromUInt32BE(substr($this->_data, 0, 4))] = $syllable; $this->_data = substr($this->_data, 4); } ksort($this->_events); } /** * 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 timing format. * * @return integer */ public function getFormat() { return $this->_format; } /** * Sets the timing format. * * @see ID3_Timing * @param integer $format The timing format. */ public function setFormat($format) { $this->_format = $format; } /** * Returns the content type code. * * @return integer */ public function getType() { return $this->_type; } /** * Sets the content type code. * * @param integer $type The content type code. */ public function setType($type) { $this->_type = $type; } /** * Returns the 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 syllable events with their timestamps. * * @return Array */ public function getEvents() { return $this->_events; } /** * Sets the syllable events with their timestamps using given encoding. * The text language and encoding must be that of the description text. * * @param Array $text The test string. * @param string $language The language code. * @param integer $encoding The text encoding. */ public function setEvents($events, $language = false, $encoding = false) { $this->_events = $events; if ($language !== false) $this->setLanguage($language); if ($encoding !== false) $this->setEncoding($encoding); ksort($this->_events); } /** * Returns the frame raw data. * * @return string */ public function __toString() { $data = Transform::toUInt8($this->_encoding) . $this->_language . Transform::toUInt8($this->_format) . Transform::toUInt8($this->_type); switch ($this->_encoding) { case self::UTF16: case self::UTF16LE: $data .= Transform::toString16 ($this->_description, $this->_encoding == self::UTF16 ? Transform::MACHINE_ENDIAN_ORDER : Transform::LITTLE_ENDIAN_ORDER) . "\0\0"; break; case self::UTF16BE: $data .= Transform::toString16BE($this->_description) . "\0\0"; break; default: $data .= $this->_description . "\0"; } foreach ($this->_events as $timestamp => $syllable) { switch ($this->_encoding) { case self::UTF16: case self::UTF16LE: $data .= Transform::toString16 ($syllable, $this->_encoding == self::UTF16 ? Transform::MACHINE_ENDIAN_ORDER : Transform::LITTLE_ENDIAN_ORDER) . "\0\0"; break; case self::UTF16BE: $data .= Transform::toString16BE($syllable) . "\0\0"; break; default: $data .= $syllable . "\0"; } $data .= Transform::toUInt32BE($timestamp); } $this->setData($data); return parent::__toString(); } }