Attached picture frame contains a picture directly related to the * audio file. Image format is the MIME type and subtype for the image. * * There may be several pictures attached to one file, each in their individual * APIC frame, but only one with the same content descriptor. There may only * be one picture with the same picture type. There is the possibility to put * only a link to the image file by using the MIME type "-->" and having a * complete URL instead of picture data. * * The use of linked files should however be used sparingly since there is the * risk of separation of files. * * @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_APIC extends ID3_Frame implements ID3_Encoding { /** * The list of image types. * * @var Array */ public static $types = array ("Other", "32x32 pixels file icon (PNG only)", "Other file icon", "Cover (front)", "Cover (back)", "Leaflet page", "Media (e.g. label side of CD)", "Lead artist/lead performer/soloist", "Artist/performer", "Conductor", "Band/Orchestra", "Composer", "Lyricist/text writer", "Recording Location", "During recording", "During performance", "Movie/video screen capture", "A bright coloured fish", "Illustration", "Band/artist logotype", "Publisher/Studio logotype"); /** @var integer */ private $_encoding = ID3_Encoding::UTF8; /** @var string */ private $_mimeType = "image/unknown"; /** @var integer */ private $_imageType = 0; /** @var string */ private $_description; /** @var string */ private $_imageData; /** @var integer */ private $_imageSize = 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->_encoding = Transform::fromUInt8($this->_data[0]); $this->_mimeType = substr ($this->_data, 1, ($pos = strpos($this->_data, "\0", 1)) - 1); $this->_imageType = Transform::fromUInt8($this->_data[++$pos]); $this->_data = substr($this->_data, $pos + 1); switch ($this->_encoding) { case self::UTF16: list ($this->_description, $this->_imageData) = $this->explodeString16($this->_data, 2); $this->_description = Transform::fromString16($this->_description); break; case self::UTF16BE: list ($this->_description, $this->_imageData) = $this->explodeString16($this->_data, 2); $this->_description = Transform::fromString16BE($this->_description); break; default: list ($this->_description, $this->_imageData) = $this->explodeString8($this->_data, 2); } $this->_imageSize = strlen($this->_imageData); } /** * 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 MIME type. The MIME type is always ISO-8859-1 encoded. * * @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 image type. * * @return integer */ public function getImageType() { return $this->_imageType; } /** * Sets the image type code. * * @param integer $imageType The image type code. */ public function setImageType($imageType) { $this->_imageType = $imageType; } /** * Returns the file description. * * @return string */ public function getDescription() { return $this->_description; } /** * Sets the content description text using given encoding. * * @param string $description The content 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 image data. * * @return string */ public function getImageData() { return $this->_imageData; } /** * Sets the embedded image data. Also updates the image size field to * correspond the new data. * * @param string $imageData The image data. */ public function setImageData($imageData) { $this->_imageData = $imageData; $this->_imageSize = strlen($imageData); } /** * Returns the size of the embedded image data. * * @return integer */ public function getImageSize() { return $this->_imageSize; } /** * Returns the frame raw data. * * @return string */ public function __toString() { $data = Transform::toUInt8($this->_encoding) . $this->_mimeType . "\0" . Transform::toUInt8($this->_imageType); 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"; } parent::setData($data . $this->_imageData); return parent::__toString(); } }