Add support for ID3v2.4

git-svn-id: http://php-reader.googlecode.com/svn/trunk@11 51a70ab9-7547-0410-9469-37e369ee0574
2008-03-12 12:06:41 +00:00
parent afdfc67582
commit 165d162582
93 changed files with 7630 additions and 0 deletions
--- a/src/ID3/Frame/COMM.php
+++ b/src/ID3/Frame/COMM.php
@@ -0,0 +1,134 @@
+<?php
+/**
+ * PHP Reader Library
+ *
+ * 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 BEHR Software Systems 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 BEHR Software Systems
+ * @license    http://www.opensource.org/licenses/bsd-license.php New BSD License
+ * @version    $Id$
+ */
+
+/**#@+ @ignore */
+require_once("ID3/Frame.php");
+require_once("ID3/Encoding.php");
+require_once("ID3/Language.php");
+/**#@-*/
+
+/**
+ * The <i>Comments</i> frame is intended for any kind of full text information
+ * that does not fit in any other frame. It consists of a frame header followed
+ * by encoding, language and content descriptors and is ended with the actual
+ * comment as a text string. Newline characters are allowed in the comment text
+ * string. There may be more than one comment frame in each tag, but only one
+ * with the same language and content descriptor.
+ *
+ * @package    php-reader
+ * @subpackage ID3
+ * @author     Sven Vollbehr <sven.vollbehr@behrss.eu>
+ * @copyright  Copyright (c) 2008 BEHR Software Systems
+ * @license    http://www.opensource.org/licenses/bsd-license.php New BSD License
+ * @version    $Rev$
+ */
+final class ID3_Frame_COMM extends ID3_Frame
+  implements ID3_Encoding, ID3_Language
+{
+  /** @var integer */
+  private $_encoding;
+  
+  /** @var string */
+  private $_language;
+  
+  /** @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.
+   */
+  public function __construct($reader)
+  {
+    parent::__construct($reader);
+
+    $this->_encoding = substr($this->_data, 0, 1);
+    $this->_language = substr($this->_data, 1, 3);
+    
+    switch ($this->_encoding) {
+    case self::UTF16:
+      list ($this->_description, $this->_text) =
+        preg_split("/\\x00\\x00/", substr($this->_data, 4), 2);
+      $this->_description = Transform::getString16LE($this->_description);
+      $this->_text = Transform::getString16LE($this->_text);
+      break;
+    case self::UTF16BE:
+      list ($this->_description, $this->_text) =
+        preg_split("/\\x00\\x00/", substr($this->_data, 4), 2);
+      $this->_description = Transform::getString16BE($this->_description);
+      $this->_text = Transform::getString16BE($this->_text);
+      break;
+    default:
+      list ($this->_description, $this->_text) =
+        preg_split("/\\x00/", substr($this->_data, 4), 2);
+      $this->_description = Transform::getString8($this->_description);
+      $this->_text = Transform::getString8($this->_text);
+    }
+  }
+  
+  /**
+   * Returns the text encoding.
+   * 
+   * @return integer
+   */
+  public function getEncoding() { return $this->_encoding; }
+
+  /**
+   * Returns the language code as specified in the
+   * {@link http://www.loc.gov/standards/iso639-2/ ISO-639-2} standard.
+   * 
+   * @see ID3_Language#ISO_639_2
+   * @return string
+   */
+  public function getLanguage() { return $this->_language; }
+
+  /**
+   * Returns the short content description.
+   * 
+   * @return string
+   */
+  public function getDescription() { return $this->_description; }
+
+  /**
+   * Returns the comment text.
+   * 
+   * @return string
+   */
+  public function getText() { return $this->_text; }
+}