Recommended buffer size frame. If the embedded info * flag is set then this indicates that an ID3 tag with the maximum size * described in buffer size may occur in the audio stream. In such case the tag * should reside between two MPEG frames, if the audio is MPEG encoded. If the * position of the next tag is known, offset to next tag may be used. The offset * is calculated from the end of tag in which this frame resides to the first * byte of the header in the next. This field may be omitted. Embedded tags are * generally not recommended since this could render unpredictable behaviour * from present software/hardware. * * For applications like streaming audio it might be an idea to embed tags into * the audio stream though. If the clients connects to individual connections * like HTTP and there is a possibility to begin every transmission with a tag, * then this tag should include a recommended buffer size frame. If the client * is connected to a arbitrary point in the stream, such as radio or multicast, * then the recommended buffer size frame should be included in every tag. * * The buffer size should be kept to a minimum. There may only be one RBUF * frame in each tag. * * @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_RBUF extends ID3_Frame { /** * A flag to denote that an ID3 tag with the maximum size described in buffer * size may occur in the audio stream. */ const EMBEDDED = 0x1; /** @var integer */ private $_bufferSize; /** @var integer */ private $_infoFlags; /** @var integer */ private $_offset = 0; /** * 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->_bufferSize = Transform::fromUInt32BE("\0" . substr($this->_data, 0, 3)); $this->_infoFlags = Transform::fromInt8($this->_data[3]); if ($this->getSize() > 4) $this->_offset = Transform::fromInt32BE(substr($this->_data, 4, 4)); } /** * Returns the buffer size. * * @return integer */ public function getBufferSize() { return $this->_bufferSize; } /** * Sets the buffer size. * * @param integer $size The buffer size. */ public function setBufferSize($bufferSize) { $this->_bufferSize = $bufferSize; } /** * Checks whether or not the flag is set. Returns true if the flag * is set, false otherwise. * * @param integer $flag The flag to query. * @return boolean */ public function hasInfoFlag($flag) { return ($this->_infoFlags & $flag) == $flag; } /** * Returns the flags byte. * * @return integer */ public function getInfoFlags() { return $this->_infoFlags; } /** * Sets the flags byte. * * @param string $flags The flags byte. */ public function setInfoFlags($infoFlags) { $this->_infoFlags = $infoFlags; } /** * Returns the offset to next tag. * * @return integer */ public function getOffset() { return $this->_offset; } /** * Sets the offset to next tag. * * @param integer $offset The offset. */ public function setOffset($offset) { $this->_offset = $offset; } /** * Returns the frame raw data. * * @return string */ public function __toString() { $this->setData (substr(Transform::toUInt32BE($this->_bufferSize), 1, 3) . Transform::toInt8($this->_infoFlags) . Transform::toInt32BE($this->_offset)); return parent::__toString(); } }