Skip to content

Commit cebde9b

Browse files
blueimpblueimp
committed
Refactor EXIF and IPTC parsing.
Map EXIF private IFD tags into separate objects (Exif, GPSInfo, Interoperability). Store IPTC tag offsets as data.iptcOffsets. Add `getName` method to tag maps to retrieve the tag name for a given tag code. Add new options to include/exclude tags from parsing (includeExifTags, excludeExifTags, includeIptcTags, excludeIptcTags). Exclude EXIF MakerNote and IPTC ObjectPreviewData by default. Add link to thumbnail image for the demo.
1 parent 6d35b97 commit cebde9b

File tree

9 files changed

+911
-400
lines changed

9 files changed

+911
-400
lines changed

‎README.md‎

Lines changed: 125 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -429,8 +429,8 @@ is available.
429429
### Exif parser
430430

431431
If you include the Load Image Exif Parser extension, the argument passed to the
432-
callback for `parseMetaData` will contain the additional properties if Exif data
433-
could be found in the given image:
432+
callback for `parseMetaData` will contain the following additional properties if
433+
Exif data could be found in the given image:
434434

435435
- `exif`: The parsed Exif tags
436436
- `exifOffsets`: The parsed Exif tag offsets
@@ -451,26 +451,82 @@ var orientation = data.exif.get('Orientation')
451451
var orientationOffset = data.exifOffsets.get('Orientation')
452452
```
453453

454-
By default, the only available mapped names are `Orientation` and `Thumbnail`.
454+
By default, only the following names are mapped:
455+
456+
- `Orientation`
457+
- `Thumbnail`
458+
- `Exif`
459+
- `GPSInfo`
460+
- `Interoperability`
461+
455462
If you also include the Load Image Exif Map library, additional tag mappings
456-
become available, as well as two additional methods, `exif.getText()` and
457-
`exif.getAll()`:
463+
become available, as well as three additional methods:
464+
465+
- `exif.getText()`
466+
- `exif.getName()`
467+
- `exif.getAll()`
458468

459469
```js
460470
var flashText = data.exif.getText('Flash') // e.g.: 'Flash fired, auto mode',
461471

472+
var name = data.exif.getName(0x0112) // Orientation
473+
462474
// A map of all parsed tags with their mapped names/text as keys/values:
463475
var allTags = data.exif.getAll()
464476
```
465477

466478
The Exif parser also adds additional options for the parseMetaData method, to
467479
disable certain aspects of the parser:
468480

469-
- `disableExif`: Disables Exif parsing.
470-
- `disableExifThumbnail`: Disables parsing of the Exif Thumbnail.
471-
- `disableExifSub`: Disables parsing of the Exif Sub IFD.
472-
- `disableExifGps`: Disables parsing of the Exif GPS Info IFD.
473-
- `disableExifOffsets`: Disables storing Exif tag offsets
481+
- `disableExif`: Disables Exif parsing when `true`.
482+
- `disableExifThumbnail`: Disables parsing of Thumbnail data when `true`.
483+
- `disableExifOffsets`: Disables storing Exif tag offsets when `true`.
484+
- `includeExifTags`: A map of Exif tags to include for parsing (includes all but
485+
the excluded tags by default).
486+
- `excludeExifTags`: A map of Exif tags to exclude from parsing (defaults to
487+
exclude `Exif` `MakerNote`).
488+
489+
An example parsing only Orientation, Thumbnail and ExifVersion tags:
490+
491+
```js
492+
loadImage.parseMetaData(
493+
fileOrBlob,
494+
function (data) {
495+
console.log('Exif data: ', data.exif)
496+
},
497+
{
498+
includeExifTags: {
499+
0x0112: true, // Orientation
500+
0x0201: true, // JPEGInterchangeFormat (Thumbnail data offset)
501+
0x0202: true, // JPEGInterchangeFormatLength (Thumbnail data length)
502+
0x8769: {
503+
// ExifIFDPointer
504+
0x9000: true // ExifVersion
505+
}
506+
}
507+
}
508+
)
509+
```
510+
511+
An example excluding `Exif` `MakerNote` and `GPSInfo`:
512+
513+
```js
514+
loadImage.parseMetaData(
515+
fileOrBlob,
516+
function (data) {
517+
console.log('Exif data: ', data.exif)
518+
},
519+
{
520+
excludeExifTags: {
521+
0x8769: {
522+
// ExifIFDPointer
523+
0x927c: true // MakerNote
524+
},
525+
0x8825: true // GPSInfoIFDPointer
526+
}
527+
}
528+
)
529+
```
474530

475531
### Exif writer
476532

@@ -498,37 +554,87 @@ loadImage(
498554
### IPTC parser
499555

500556
If you include the Load Image IPTC Parser extension, the argument passed to the
501-
callback for `parseMetaData` will contain the additional property `iptc` if IPTC
502-
data could be found in the given image.
557+
callback for `parseMetaData` will contain the following additional properties if
558+
IPTC data could be found in the given image:
559+
560+
- `iptc`: The parsed IPTC tags
561+
- `iptcOffsets`: The parsed IPTC tag offsets
562+
503563
The `iptc` object stores the parsed IPTC tags:
504564

505565
```js
506-
var objectname = data.iptc[0x5]
566+
var objectname = data.iptc[5]
507567
```
508568

509-
It also provides an `iptc.get()` method to retrieve the tag value via the tag's
510-
mapped name:
569+
The `iptc` and `iptcOffsets` objects also provide a `get()` method to retrieve
570+
the tag value/offset via the tag's mapped name:
511571

512572
```js
513573
var objectname = data.iptc.get('ObjectName')
514574
```
515575

516-
By default, the only available mapped names are `ObjectName`.
576+
By default, only the following names are mapped:
577+
578+
- `ObjectName`
579+
517580
If you also include the Load Image IPTC Map library, additional tag mappings
518-
become available, as well as two additional methods, `iptc.getText()` and
519-
`iptc.getAll()`:
581+
become available, as well as three additional methods:
582+
583+
- `iptc.getText()`
584+
- `iptc.getName()`
585+
- `iptc.getAll()`
520586

521587
```js
522588
var keywords = data.iptc.getText('Keywords') // e.g.: ['Weather','Sky']
523589

590+
var name = data.iptc.getName(5) // ObjectName
591+
524592
// A map of all parsed tags with their mapped names/text as keys/values:
525593
var allTags = data.iptc.getAll()
526594
```
527595

528596
The IPTC parser also adds additional options for the parseMetaData method, to
529597
disable certain aspects of the parser:
530598

531-
- `disableIptc`: Disables IPTC parsing.
599+
- `disableIptc`: Disables IPTC parsing when true.
600+
- `disableIptcOffsets`: Disables storing IPTC tag offsets when `true`.
601+
- `includeIptcTags`: A map of IPTC tags to include for parsing (includes all but
602+
the excluded tags by default).
603+
- `excludeIptcTags`: A map of IPTC tags to exclude from parsing (defaults to
604+
exclude `ObjectPreviewData`).
605+
606+
An example parsing only the `ObjectName` tag:
607+
608+
```js
609+
loadImage.parseMetaData(
610+
fileOrBlob,
611+
function (data) {
612+
console.log('IPTC data: ', data.iptc)
613+
},
614+
{
615+
includeIptcTags: {
616+
5: true // ObjectName
617+
}
618+
}
619+
)
620+
```
621+
622+
An example excluding `ApplicationRecordVersion` and `ObjectPreviewData`:
623+
624+
```js
625+
loadImage.parseMetaData(
626+
fileOrBlob,
627+
function (data) {
628+
console.log('IPTC data: ', data.iptc)
629+
},
630+
{
631+
excludeIptcTags: {
632+
0: true, // ApplicationRecordVersion
633+
202: true // ObjectPreviewData
634+
}
635+
}
636+
)
637+
```
532638

533639
## License
534640

‎css/demo.css‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ table {
4141
word-wrap: break-word;
4242
table-layout: fixed;
4343
border-collapse: collapse;
44+
margin-bottom: 20px;
4445
}
4546
tr {
4647
background: #fff;
@@ -55,6 +56,7 @@ td {
5556
}
5657
#result,
5758
#thumbnail {
59+
margin-bottom: 20px;
5860
padding: 20px;
5961
background: #fff;
6062
color: #222;

‎index.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,10 @@ <h2>Result</h2>
9696
</div>
9797
<div id="exif" style="display: none;">
9898
<h3>Exif meta data</h3>
99-
<p id="thumbnail" style="display: none;"></p>
100-
<table></table>
99+
<div id="thumbnail" style="display: none;"></div>
101100
</div>
102101
<div id="iptc" style="display: none;">
103102
<h3>IPTC meta data</h3>
104-
<table></table>
105103
</div>
106104

107105
<script src="js/vendor/canvas-to-blob.js"></script>

‎js/demo/demo.js‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,16 @@ $(function () {
2929
* @param {object} tags Tags object
3030
*/
3131
function displayTagData(node, tags) {
32-
var table = node.find('table').empty()
32+
var table = $('<table>')
3333
var row = $('<tr></tr>')
3434
var cell = $('<td></td>')
3535
var prop
3636
for (prop in tags) {
3737
if (Object.prototype.hasOwnProperty.call(tags, prop)) {
38+
if (typeof tags[prop] === 'object') {
39+
displayTagData(node, tags[prop])
40+
continue
41+
}
3842
table.append(
3943
row
4044
.clone()
@@ -43,7 +47,7 @@ $(function () {
4347
)
4448
}
4549
}
46-
node.show()
50+
node.append(table).show()
4751
}
4852

4953
/**
@@ -55,11 +59,15 @@ $(function () {
5559
*/
5660
function displayThumbnailImage(node, thumbnail, options) {
5761
if (thumbnail) {
58-
thumbNode.empty()
62+
var link = $('<a>')
63+
.attr('href', loadImage.createObjectURL(thumbnail))
64+
.attr('download', 'thumbnail.jpg')
65+
.appendTo(node)
5966
loadImage(
6067
thumbnail,
6168
function (img) {
62-
node.append(img).show()
69+
link.append(img)
70+
node.show()
6371
},
6472
options
6573
)
@@ -136,9 +144,9 @@ $(function () {
136144
orientation: true,
137145
meta: true
138146
}
139-
exifNode.hide()
140-
iptcNode.hide()
141-
thumbNode.hide()
147+
exifNode.hide().find('table').remove()
148+
iptcNode.hide().find('table').remove()
149+
thumbNode.hide().empty()
142150
if (!loadImage(file, updateResults, options)) {
143151
result
144152
.children()

0 commit comments

Comments
 (0)