-
Notifications
You must be signed in to change notification settings - Fork 68
/
exif-read-data.xml
400 lines (391 loc) · 14.5 KB
/
exif-read-data.xml
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f57352dd7a678230f929e1bac0d4a9189631cf16 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.exif-read-data" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>exif_read_data</refname>
<refpurpose>
画像ファイルから <acronym>EXIF</acronym> ヘッダを読み込む
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>exif_read_data</methodname>
<methodparam><type class="union"><type>resource</type><type>string</type></type><parameter>file</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>required_sections</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>as_arrays</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>read_thumbnail</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
<function>exif_read_data</function> は、
画像ファイルから <acronym>EXIF</acronym>
ヘッダを読み込みます。この方法で、デジタルカメラが生成したメタデータを
読み込むことが可能です。
</para>
<para>
<acronym>EXIF</acronym> ヘッダは、デジタルカメラが作成した JPEG/TIFF
画像によく含まれています。しかし残念なことに、
そのタグ付けの方法はメーカーによって異なります。
したがって、特定の Exif ヘッダが常に存在すると仮定することはできません。
</para>
<para>
<literal>Height</literal> および <literal>Width</literal>
は、<function>getimagesize</function> と同じ方法で計算されます。
よって、これらの値は決してヘッダの一部として返してはいけません。
また、<literal>html</literal> は高さ/幅を表すテキスト文字列で、
通常の <acronym>HTML</acronym> の中で用いられます。
</para>
<para>
Exif ヘッダに著作権表示が含まれている場合、それ自身には 2 つの値を
含めることが可能です。Exif 2.10 のこの矛盾した規格に対応するため、
<literal>COMPUTED</literal> セクションは <literal>Copyright.Photographer</literal>
および <literal>Copyright.Editor</literal> の両方を返します。
また <literal>IFD0</literal> セクションには 2 つのエントリを NULL 文字で区切った
バイト配列を含めます。データ型が間違っている場合は最初のエントリのみを
かえします(Exif の通常の挙動)。<literal>COMPUTED</literal> には、元の著作権文字列あるいは
カンマで区切られた写真と編集者の著作権表示のどちらかを
<literal>Copyright</literal> エントリに含めることが可能です。
</para>
<para>
<literal>UserComment</literal> タグにも Copyright タグと同様の問題があります。ここにも
2 つの値を格納することが可能です。それは使用しているエンコーディングと
値自身の 2 つです。そうなると、<literal>IFD</literal> セクションにはエンコーディングのみを
含めるか、あるいはバイト配列を格納することになります。<literal>COMPUTED</literal> セクションは
<literal>UserCommentEncoding</literal> および <literal>UserComment</literal>
を両方格納することができます。<literal>UserComment</literal> はどちらの
場合でも有効なので、<literal>IFD0</literal> セクションではこちらを優先すべきです。
</para>
<para>
<function>exif_read_data</function> は、EXIF 仕様(<link
xlink:href="&url.exifspec;">&url.exifspec;</link>, 20 ページ)に基づいて
EXIF データタグの検証も行います。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem>
<para>
画像ファイルの位置。
ファイルのパス
(ストリームラッパーもいつもどおりサポートされています)
またはストリーム<type>resource</type>。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>required_sections</parameter></term>
<listitem>
<para>
結果の配列を作成するために存在する必要のあるセクションのカンマ区切り
リスト。要求されたセクションがひとつも見つからなかった場合の戻り値は
&false; となります。
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry>FILE</entry>
<entry>FileName, FileSize, FileDateTime, SectionsFound</entry>
</row>
<row>
<entry>COMPUTED</entry>
<entry>
html, Width, Height, IsColor, および他の取得可能なもの。Height および
Width は <function>getimagesize</function> と同じ方法で取得した
もので、その値はヘッダの一部ではありません。また、<literal>html</literal> は
通常の <acronym>HTML</acronym> 内で使用される height/width の
文字列です。
</entry>
</row>
<row>
<entry>ANY_TAG</entry>
<entry>タグを有するすべての情報。例えば <literal>IFD0</literal>, <literal>EXIF</literal>, ...</entry>
</row>
<row>
<entry>IFD0</entry>
<entry>
IFD0 のすべてのタグつきデータ。通常の画像ファイルでは、
ここに画像のサイズが含まれます。
</entry>
</row>
<row>
<entry>THUMBNAIL</entry>
<entry>
2 番目の <literal>IFD</literal> がある場合、ファイルにサムネイルが含まれている
可能性があります。埋め込まれたサムネイルに関するすべての
タグつき情報はこのセクションに格納されます。
</entry>
</row>
<row>
<entry>COMMENT</entry>
<entry>JPEG 画像のコメントヘッダ。</entry>
</row>
<row>
<entry>EXIF</entry>
<entry>
EXIF セクションは <literal>IFD0</literal> のサブセクションです。ここには
画像に関する詳細な情報が含まれています。これらのエントリの
ほとんどはデジタルカメラに関連するものです。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>as_arrays</parameter></term>
<listitem>
<para>
各セクションを配列とするかどうかを指定します。
<parameter>required_sections</parameter> の
<literal>COMPUTED</literal>、
<literal>THUMBNAIL</literal> および <literal>COMMENT</literal>
は常に配列となります。これは、これらのセクションに
含まれる値の名前が他のセクションと衝突する可能性があるからです。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>read_thumbnail</parameter></term>
<listitem>
<para>
&true; を指定すると、サムネイル本体を読み込みます。それ以外の場合は
タグつきデータのみを読み込みます。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
ヘッダ名がキー・ヘッダの内容が値となる連想配列を返します。
返されるデータがない場合は
<function>exif_read_data</function> は &false; を返します。
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
サポートされていないタグや、エラーが起きうる条件が指定された場合は、
<constant>E_WARNING</constant> かつ/または <constant>E_NOTICE</constant> が発生します。
警告が発生しても、この関数は対応する情報を全て読み取ろうとします。
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>required_sections</parameter> は、nullable になりました。
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
<parameter>file</parameter> パラメータは
ローカルファイルとストリームリソースを両方サポートするようになりました。
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
<para>
以下の EXIF フォーマットのサポートが追加されました:
<simplelist>
<member>Samsung</member>
<member>DJI</member>
<member>Panasonic</member>
<member>Sony</member>
<member>Pentax</member>
<member>Minolta</member>
<member>Sigma/Foveon</member>
<member>AGFA</member>
<member>Kyocera</member>
<member>Ricoh</member>
<member>Epson</member>
</simplelist>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>exif_read_data</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
echo "test1.jpg:<br />\n";
$exif = exif_read_data('tests/test1.jpg', 'IFD0');
echo $exif===false ? "No header data found.<br />\n" : "Image contains headers<br />\n";
$exif = exif_read_data('tests/test2.jpg', 0, true);
echo "test2.jpg:<br />\n";
foreach ($exif as $key => $section) {
foreach ($section as $name => $val) {
echo "$key.$name: $val<br />\n";
}
}
?>
]]>
</programlisting>
<para>
最初のコールは失敗します。画像がヘッダ情報を有していないためです。
</para>
&example.outputs.similar;
<screen role="php">
<![CDATA[
test1.jpg:
No header data found.
test2.jpg:
FILE.FileName: test2.jpg
FILE.FileDateTime: 1017666176
FILE.FileSize: 1240
FILE.FileType: 2
FILE.SectionsFound: ANY_TAG, IFD0, THUMBNAIL, COMMENT
COMPUTED.html: width="1" height="1"
COMPUTED.Height: 1
COMPUTED.Width: 1
COMPUTED.IsColor: 1
COMPUTED.ByteOrderMotorola: 1
COMPUTED.UserComment: Exif test image.
COMPUTED.UserCommentEncoding: ASCII
COMPUTED.Copyright: Photo (c) M.Boerger, Edited by M.Boerger.
COMPUTED.Copyright.Photographer: Photo (c) M.Boerger
COMPUTED.Copyright.Editor: Edited by M.Boerger.
IFD0.Copyright: Photo (c) M.Boerger
IFD0.UserComment: ASCII
THUMBNAIL.JPEGInterchangeFormat: 134
THUMBNAIL.JPEGInterchangeFormatLength: 523
COMMENT.0: Comment #1.
COMMENT.1: Comment #2.
COMMENT.2: Comment #3end
THUMBNAIL.JPEGInterchangeFormat: 134
THUMBNAIL.Thumbnail.Height: 1
THUMBNAIL.Thumbnail.Height: 1
]]>
</screen>
</example>
</para>
<para>
<example>
<title>PHP 7.2.0 で利用できるストリームを <function>exif_read_data</function> で使う例</title>
<programlisting role="php">
<![CDATA[
<?php
// Open a the file, this should be in binary mode
$fp = fopen('/path/to/image.jpg', 'rb');
if (!$fp) {
echo 'Error: Unable to open image for reading';
exit;
}
// Attempt to read the exif headers
$headers = exif_read_data($fp);
if (!$headers) {
echo 'Error: Unable to read exif headers';
exit;
}
// Print the 'COMPUTED' headers
echo 'EXIF Headers:' . PHP_EOL;
foreach ($headers['COMPUTED'] as $header => $value) {
printf(' %s => %s%s', $header, $value, PHP_EOL);
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen role="php">
<![CDATA[
EXIF Headers:
Height => 576
Width => 1024
IsColor => 1
ByteOrderMotorola => 0
ApertureFNumber => f/5.6
UserComment =>
UserCommentEncoding => UNDEFINED
Copyright => Denis
Thumbnail.FileType => 2
Thumbnail.MimeType => image/jpeg
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<link linkend="ref.mbstring">mbstring</link> が有効な場合、
exif はUnicodeを処理し、
<link linkend="ini.exif.decode-unicode-motorola">exif.decode_unicode_motorola</link> および
<link linkend="ini.exif.decode-unicode-intel">exif.decode_unicode_intel</link>
で指定された文字コードとして取り出そうとします。
exif 拡張モジュールはエンコーディングを自分自身で探そうとはしないので、
<function>exif_read_data</function> を呼ぶ前に、
これらの ini ディレクティブのうちのひとつに
どのエンコーディングをデコードに使うかを適切に設定するのはユーザーの責任です。
</para>
</note>
<note>
<para>
この関数にストリームを渡すために <parameter>file</parameter> を使った場合、
ストリームはシーク可能でなければなりません。
ファイルポインタの位置は、関数から戻った後でも変化しないことに注意してください。
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>exif_thumbnail</function></member>
<member><function>getimagesize</function></member>
<member><xref linkend="wrappers"/></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->