summaryrefslogtreecommitdiff
path: root/includes/jpeg_metadata_tk/Makernotes/ricoh.php
blob: f858bbc2df738547e1e1d6f64dd96e618cfb5164 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
<?php

/******************************************************************************
*
* Filename:     ricoh.php
*
* Description:  Ricoh Makernote Parser
*               Provides functions to decode an Ricoh EXIF makernote and to interpret
*               the resulting array into html.
*
*               Ricoh Makernote Format:
*
*               Type 1 - Text Makernote
*
*               Field           Size            Description
*               ----------------------------------------------------------------
*               Text            Variable        Text, beginning with "Rv" or "Rev"
*               ---------------------------------------------------------------
*
*
*               Type 2 - Empty Makernote
*
*               Field           Size            Description
*               ----------------------------------------------------------------
*               Blank           Variable        Blank field filled with 0x00 characters
*               ---------------------------------------------------------------*
*
*
*               Type 3 - IFD Makernote
*
*               Field           Size            Description
*               ----------------------------------------------------------------
*               Header          5 Bytes        "Ricoh" or "RICOH"
*               Unknown         1 Byte          Unknown field
*               Zeros           2 Bytes         Two 0x00 characters
*               IFD Data        Variable        Standard IFD Data using Ricoh Tags
*                                               with Motorola byte alignment
*               ---------------------------------------------------------------
*
*               Within Makernote Type 3, Tag 0x2001 is the Ricoh Camera Info Sub-IFD
*               It has the following format:
*
*               Field           Size            Description
*               ----------------------------------------------------------------
*               Header          19 Bytes        "[Ricoh Camera Info]"
*               Unknown         1 Byte          Unknown field
*               IFD Data        Variable        NON-Standard IFD Data using Ricoh
*                                               Sub-IFD Tags with Motorola byte alignment
*                                               and has No final Next-IFD pointer
*               ---------------------------------------------------------------
*
*
*
*
* Author:       Evan Hunter
*
* Date:         30/7/2004
*
* Project:      JPEG Metadata
*
* Revision:     1.00
*
* URL:          http://electronics.ozhiker.com
*
* Copyright:    Copyright Evan Hunter 2004
*               This file may be used freely for non-commercial purposes.For
*               commercial uses please contact the author: evan@ozhiker.com
*
******************************************************************************/



// Add the parser and interpreter functions to the list of Makernote parsers and interpreters.

$GLOBALS['Makernote_Function_Array']['Read_Makernote_Tag'][] = "get_Ricoh_Makernote";
$GLOBALS['Makernote_Function_Array']['get_Makernote_Text_Value'][] = "get_Ricoh_Text_Value";
$GLOBALS['Makernote_Function_Array']['Interpret_Makernote_to_HTML'][] = "get_Ricoh_Makernote_Html";




/******************************************************************************
*
* Function:     get_Ricoh_Makernote
*
* Description:  Decodes the Makernote tag and returns the new tag with the decoded
*               information attached. Returns false if this is not a makernote
*               that can be processed with this script
*
* Parameters:   Makernote_Tag - the element of an EXIF array containing the
*                               makernote, as returned from get_EXIF_JPEG
*               EXIF_Array - the entire EXIF array containing the
*                            makernote, as returned from get_EXIF_JPEG, in
*                            case more information is required for decoding
*               filehnd - an open file handle for the file containing the
*                         makernote - does not have to be positioned at the
*                         start of the makernote
*               Make_Field - The contents of the EXIF Make field, to aid
*                            determining whether this script can decode
*                            the makernote
*
*
* Returns:      Makernote_Tag - the Makernote_Tag from the parameters, but
*                               modified to contain the decoded information
*               FALSE - If this script could not decode the makernote, or if
*                       an error occured in decoding
*
******************************************************************************/

function get_Ricoh_Makernote( $Makernote_Tag, $EXIF_Array, $filehnd, $Make_Field )
{
        // Check if the Make Field contains the word Ricoh
        if ( stristr( $Make_Field, "Ricoh" ) === FALSE )
        {
                // Ricoh not in the Maker field - abort
                return FALSE;
        }


        // Check if the Text Makernote header exists at the start of the Makernote
        if ( ( substr( $Makernote_Tag['Data'], 0, 2 ) === "Rv" ) ||
             ( substr( $Makernote_Tag['Data'], 0, 3 ) === "Rev" ) )
        {
                // This is a text makernote - Label it as such
                $Makernote_Tag['Makernote Type'] = "Ricoh Text";
                $Makernote_Tag['Makernote Tags'] = "None";
                $Makernote_Tag['Decoded'] = TRUE;

                // Return the new Makernote tag
                return $Makernote_Tag;

        }
        // Check if the Empty Makernote header exists at the start of the Makernote
        else if ( $Makernote_Tag['Data'] === str_repeat ( "\x00", strlen( $Makernote_Tag['Data'] )) )
        {
                // This is an Empty Makernote - Label it as such
                $Makernote_Tag['Makernote Type'] = "Ricoh Empty Makernote";
                $Makernote_Tag['Makernote Tags'] = "None";
                $Makernote_Tag['Decoded'] = TRUE;

                // Return the new Makernote tag
                return $Makernote_Tag;

        }
        // Check if the IFD Makernote header exists at the start of the Makernote
        else if ( ( substr( $Makernote_Tag['Data'], 0, 5 ) === "RICOH" ) ||
                  ( substr( $Makernote_Tag['Data'], 0, 5 ) === "Ricoh" ) )
        {
                //This is an IFD Makernote

                // Seek to the start of the IFD
                fseek($filehnd, $Makernote_Tag['Tiff Offset'] + $Makernote_Tag['Offset'] + 8 );

                // Ricoh Makernote always uses Motorola Byte Alignment
                $Makernote_Tag['ByteAlign'] = "MM";

                // Read the IFD(s) into an array
                $Makernote_Tag['Decoded Data'] = read_Multiple_IFDs( $filehnd, $Makernote_Tag['Tiff Offset'], $Makernote_Tag['ByteAlign'], "Ricoh" );

                // Save some information into the Tag element to aid interpretation
                $Makernote_Tag['Decoded'] = TRUE;
                $Makernote_Tag['Makernote Type'] = "Ricoh";
                $Makernote_Tag['Makernote Tags'] = "Ricoh";

                // Ricoh Makernotes can have a tag 0x2001 which is a Sub-IFD
                // Check if the tag exists
                if  ( ( $Makernote_Tag['Decoded Data'][0] !== FALSE ) &&
                      ( array_key_exists( 0x2001, $Makernote_Tag['Decoded Data'][0] ) ) )
                {
                        // Ricoh Sub-IFD tag exists - Process it

                        // Grab the Sub-IFD tag for easier processing
                        $SubIFD_Tag = &$Makernote_Tag['Decoded Data'][0][0x2001];

                        // Check if the Sub-IFD starts with the correct header
                        if ( substr( $SubIFD_Tag['Data'], 0, 19 ) === "[Ricoh Camera Info]" )
                        {
                                // Correct Header found

                                // Seek to the start of the Sub-IFD
                                fseek($filehnd, $Makernote_Tag['Tiff Offset'] + $SubIFD_Tag['Offset'] + 20 );

                                // Ricoh Makernote Sub-IFD always uses Motorola Byte Alignment
                                $SubIFD_Tag['ByteAlign'] = "MM";


                                // Read the IFD(s) into an array
                                $SubIFD_Tag['Data'] = read_Multiple_IFDs( $filehnd, $Makernote_Tag['Tiff Offset'], $SubIFD_Tag['ByteAlign'], "RicohSubIFD", False, False );

                                // Save some information into the Tag element to aid interpretation
                                $SubIFD_Tag['Decoded'] = TRUE;
                                $SubIFD_Tag['Makernote Type'] = "Ricoh";
                                $SubIFD_Tag['Makernote Tags'] = "RicohSubIFD";

                                // Change the tag type to a Sub-IFD so it is handled automatically for interpretation
                                $SubIFD_Tag['Type'] = "SubIFD";
                                $SubIFD_Tag['Tags Name'] = "RicohSubIFD";

                        }
                        else
                        {
                                // Couldn't find header of Sub-IFD - Probably corrupt
                                $SubIFD_Tag['Type'] = "String";
                                $SubIFD_Tag['Text Value'] = "Corrupted Ricoh Sub IFD";
                        }

                }

                // Return the new makernote tag
                return $Makernote_Tag;
        }
        else
        {
                // Unrecognised header for makernote - abort
                return FALSE;
        }

        // Shouldn't get here
        return False;
}

/******************************************************************************
* End of Function:     get_Ricoh_Makernote
******************************************************************************/







/******************************************************************************
*
* Function:     get_Ricoh_Makernote_Html
*
* Description:  Attempts to interpret a makernote into html. Returns false if
*               it is not a makernote that can be processed with this script
*
* Parameters:   Makernote_Tag - the element of an EXIF array containing the
*                               makernote, as returned from get_EXIF_JPEG
*               filename - the name of the JPEG file being processed ( used
*                          by scripts which display embedded thumbnails)
*
*
* Returns:      output - the html representing the makernote
*               FALSE - If this script could not interpret the makernote, or if
*                       an error occured in decoding
*
******************************************************************************/

function get_Ricoh_Makernote_Html( $Makernote_tag, $filename )
{

        // Check if this makernote is Ricoh IFD type
        if ( $Makernote_tag['Makernote Type'] == "Ricoh" )
        {
                // This is a Ricoh IFD makernote - interpret it
                return  interpret_IFD( $Makernote_tag['Decoded Data'][0], $filename );
        }
        // Check if this makernote is Ricoh Text type
        else if ( $Makernote_tag['Makernote Type'] == "Ricoh Text" )
        {
                // This is a Ricoh text makernote
                //  Construct the start of enclosing html for the text
                $output_str = "<table  class=\"EXIF_Table\"border=1><tr class=\"EXIF_Table_Row\"><td class=\"EXIF_Value_Cell\">";

                // Replace the semicolon dividers with line break html tags
                $output_str .= str_replace ( ";", "<BR>\n", $Makernote_tag['Data'] );

                // Close the html
                $output_str .= "</td></tr></table>";

                // Return the html
                return  $output_str;
        }
        // Check if this makernote is a Ricoh Empty makernote
        else if ( $Makernote_tag['Makernote Type'] == "Ricoh Empty Makernote" )
        {
                // Do Nothing
                return "";
        }
        else
        {
                // Don't recognise the Makernote type - not a Ricoh makernote
                return FALSE;
        }

        // shouldn't get here
        return FALSE;
}

/******************************************************************************
* End of Function:     get_Ricoh_Makernote_Html
******************************************************************************/








/******************************************************************************
*
* Function:     get_Ricoh_Text_Value
*
* Description:  Provides a text value for any tag marked as special for makernotes
*               that this script can decode. Returns false if this is not a makernote
*               that can be processed with this script
*
* Parameters:   Exif_Tag - the element of an the Makernote array containing the
*                          tag in question, as returned from get_Ricoh_Makernote
*               Tag_Definitions_Name - The name of the Tag Definitions group
*                                      within the global array IFD_Tag_Definitions
*
*
* Returns:      output - the text value for the tag
*               FALSE - If this script could not decode the makernote, or if
*                       an error occured in decoding
*
******************************************************************************/

function get_Ricoh_Text_Value( $Exif_Tag, $Tag_Definitions_Name )
{

        // Check that this tag uses the Ricoh tags, otherwise it can't be decoded here
        if ( $Tag_Definitions_Name == "Ricoh" )
        {

                // Process the tag acording to it's tag number, to produce a text value
                if ( $Exif_Tag['Tag Number'] == 0x0002 ) // Version tag
                {
                        $tmp = implode ( "\x00", $Exif_Tag['Data']);
                        return "\"" .HTML_UTF8_Escape( $tmp ) . "\" (" . bin2hex( $tmp ) . " hex)";
                }

        }

        // Unknown tag or tag definitions
        return FALSE;

}

/******************************************************************************
* End of Function:     get_Ricoh_Text_Value
******************************************************************************/











/******************************************************************************
* Global Variable:      IFD_Tag_Definitions, Ricoh
*
* Contents:     This global variable provides definitions of the known Ricoh
*               Makernote tags, indexed by their tag number.
*
******************************************************************************/

$GLOBALS[ "IFD_Tag_Definitions" ]["Ricoh"] = array(


0x0001 => array(        'Name' => "Makernote Data Type",
                        'Type' => "String" ),

0x0002 => array(        'Name' => "Version",
                        'Type' => "Special" ),

0x0e00 => array(        'Name' => "Print Image Matching Info",
                        'Type' => "PIM" ),

0x2001 => array(        'Name' => "Ricoh Camera Info Makernote Sub-IFD",
                        'Type' => "Special" ),

);

/******************************************************************************
* End of Global Variable:     IFD_Tag_Definitions, Ricoh
******************************************************************************/








/******************************************************************************
* Global Variable:      IFD_Tag_Definitions, RicohSubIFD
*
* Contents:     This global variable provides definitions of the known Ricoh
*               Camera Info Sub-IFD Makernote tags, indexed by their tag number.
*
******************************************************************************/

$GLOBALS[ "IFD_Tag_Definitions" ]["RicohSubIFD"] = array(

);

/******************************************************************************
* End of Global Variable:     IFD_Tag_Definitions, RicohSubIFD
******************************************************************************/






?>