Changeset 4698 for extensions/AMetaData/JpegMetaData/Readers/PentaxReader.class.php

Timestamp:

Jan 17, 2010, 7:05:35 PM (14 years ago)

Author:

grum

Message:

[Plugin:AMetaData] Finished to comment the JpegMetaData classes and rename some methods

File:

• extensions/AMetaData/JpegMetaData/Readers/PentaxReader.class.php (modified) (8 diffs)

extensions/AMetaData/JpegMetaData/Readers/PentaxReader.class.php

@@ -9 +9 @@
  *   << May the Little SpaceFrog be with you ! >>
  *
+ *
+ * +-----------------------------------------------------------------------+
+ * | JpegMetaData - a PHP based Jpeg Metadata manager                      |
+ * +-----------------------------------------------------------------------+
+ * | Copyright(C) 2010  Grum - http://www.grum.fr                          |
+ * +-----------------------------------------------------------------------+
+ * | This program is free software; you can redistribute it and/or modify  |
+ * | it under the terms of the GNU General Public License as published by  |
+ * | the Free Software Foundation                                          |
+ * |                                                                       |
+ * | This program is distributed in the hope that it will be useful, but   |
+ * | WITHOUT ANY WARRANTY; without even the implied warranty of            |
+ * | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      |
+ * | General Public License for more details.                              |
+ * |                                                                       |
+ * | You should have received a copy of the GNU General Public License     |
+ * | along with this program; if not, write to the Free Software           |
+ * | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
+ * | USA.                                                                  |
+ * +-----------------------------------------------------------------------+
+ *
+ *
  * -----------------------------------------------------------------------------
  *
+ * The PentaxReader class is the dedicated to read the specific Pentax tags
+ *
+ * ====> See MakerNotesReader.class.php to know more about the structure <======
+ *
  * -----------------------------------------------------------------------------
- * Pentax reader class
+ *
+ * .. Notes ..
+ *
+ *
+ * The PentaxReader class is derived from the MakerNotesReader class.
+ *
+ * ======> See MakerNotesReader.class.php to know more about common methods <======
+ *
  * -----------------------------------------------------------------------------
  */
 
+
+
   require_once(JPEG_METADATA_DIR."TagDefinitions/PentaxTags.class.php");
   require_once(JPEG_METADATA_DIR."Readers/MakerNotesReader.class.php");
@@ -21 +56 @@
   class PentaxReader extends MakerNotesReader
   {
+    /**
+     * The constructor needs, like the ancestor, the datas to be parsed
+     *
+     * Some datas are offset on extra data, and this offset can be (some time)
+     * absolute inside the IFD, or relative. So, the offset of the IFD structure
+     * is needed
+     *
+     * The byte order can be different from the TIFF byte order !
+     *
+     * The constructor need the maker signature (see the MakerNotesSignatures
+     * class for a list of known signatures)
+     *
+     * @param String $data
+     * @param ULong $offset : offset of IFD block in the jpeg file
+     * @param String $byteOrder
+     * @param String $makerSignature :
+     */
     function __construct($data, $offset, $byteOrder, $makerSignature)
     {
@@ -39 +91 @@
     }
 
+
+    /**
+     * initialize the definition for Pentax exif tags
+     */
     protected function initializeTagDef()
     {
@@ -44 +100 @@
     }
 
+    /**
+     * skip the IFD header
+     */
     protected function skipHeader($headerSize=0)
     {
@@ -49 +108 @@
     }
 
+    /**
+     * this function do the interpretation of specials tags
+     *
+     * the function return the interpreted value for the tag
+     *
+     * @param $tagId             : the id of the tag
+     * @param $values            : 'raw' value to be interpreted
+     * @param UByte $type        : if needed (for IFD structure) the type of data
+     * @param ULong $valueOffset : if needed, the offset of data in the jpeg file
+     * @return String or Array or DateTime or Integer or Float...
+     */
     protected function processSpecialTag($tagId, $values, $type, $valuesOffset=0)
     {
@@ -172 +242 @@
           $returned=53190 -$values;
           break;
+
+        /* theses tags decoding is not yet implemented
+         * have to take a look on the algorithm in exiftool (it seems to work
+         * but I don't understand everything...)
+         */
+
         case 0x0205: // "ShotInfo",
         case 0x0206: // "AEInfo",
@@ -192 +268 @@
         case 0x0222: // "ColorInfo",
 
-        /* theses tags decoding is not yet implemented
-         * have to take a look on the algorithm in exiftool (it seems to work
-         * but I don't understand everything...)
-         */
         case 0x0029: // "FrameNumber",
         case 0x0041: // "DigitalFilter",
@@ -207 +279 @@
           $returned="Not yet implemented;".ConvertData::toHexDump($tagId, ByteType::USHORT)." => ".ConvertData::toHexDump($values, $type);
           break;
-
       }
-
       return($returned);
     }
-
   }
 
-
 ?>