Merge pull request #315 from IIIF/support_iiif_level1

Support iiif level1

src/iiif1_1tilesource.js

@@ -45,20 +45,49 @@
  */
 $.IIIF1_1TileSource = function( options ){
 
+
     $.extend( true, this, options );
 
-    if( !(this.height && this.width && this['@id'] ) ){
+
-        throw new Error('IIIF required parameters not provided.');
+    if ( !( this.height && this.width && this['@id'] ) ){
+        throw new Error( 'IIIF required parameters not provided.' );
     }
 
-    if ( !(this.tile_width && this.tile_height) ) {
+    if ( ( this.profile &&
-        // use the short dimension if there aren't tile sizes provided.
+        this.profile == "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level0" ) ){
-        options.tileSize = Math.min(this.height, this.width);
+        // what if not reporting a profile?
-    } else {
+        throw new Error( 'IIIF Image API 1.1 compliance level 1 or greater is required.' );
+    }
+
+    if ( this.tile_width ) {
         options.tileSize = this.tile_width;
+    } else if ( this.tile_height ) {
+        options.tileSize = this.tile_height;
+    } else {
+        // use the largest of tileOptions that is smaller than the short
+        // dimension
+
+        var shortDim = Math.min( this.height, this.width ),
+            tileOptions = [256,512,1024],
+            smallerTiles = [];
+
+            for ( var c = 0; c < tileOptions.length; c++ ) {
+                if ( tileOptions[c] <= shortDim ) {
+                    smallerTiles.push( tileOptions[c] );
+                }
+            }
+
+        if ( smallerTiles.length > 0 ) {
+            options.tileSize = Math.max.apply( null, smallerTiles );
+        } else {
+            // If we're smaller than 256, just use the short side.
+            options.tileSize = shortDim;
+        }
+        this.tile_width = options.tileSize;  // So that 'full' gets used for 
+        this.tile_height = options.tileSize; // the region below
     }
 
-    if (! options.maxLevel ) {
+    if ( !options.maxLevel ) {
         var mf = -1;
         var scfs = this.scale_factors || this.scale_factor;
         if ( scfs instanceof Array ) {
@@ -67,7 +96,7 @@ $.IIIF1_1TileSource = function( options ){
                 if ( !isNaN( cf ) && cf > mf ) { mf = cf; }
             }
         }
-        if ( mf < 0 ) { options.maxLevel = Number(Math.ceil(Math.log(Math.max(this.width, this.height), 2))); }
+        if ( mf < 0 ) { options.maxLevel = Number( Math.ceil( Math.log( Math.max( this.width, this.height ), 2 ) ) ); }
         else { options.maxLevel = mf; }
     }
 
@@ -82,13 +111,9 @@ $.extend( $.IIIF1_1TileSource.prototype, $.TileSource.prototype, /** @lends Open
      * @param {Object|Array} data
      * @param {String} optional - url
      */
-    supports: function( data, url ){
+    supports: function( data, url ) {
-        return data.profile && (
+        return ( data['@context'] &&
-            "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level0" == data.profile ||
+            data['@context'] == "http://library.stanford.edu/iiif/image-api/1.1/context.json" );
-            "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level1" == data.profile ||
-            "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level2" == data.profile ||
-            "http://library.stanford.edu/iiif/image-api/1.1/compliance.html" == data.profile
-        );
     },
 
     /**
@@ -124,6 +149,7 @@ $.extend( $.IIIF1_1TileSource.prototype, $.TileSource.prototype, /** @lends Open
     getTileUrl: function( level, x, y ){
 
         //# constants
+
         var IIIF_ROTATION = '0',
             IIIF_QUALITY = 'native.jpg',
 
@@ -131,32 +157,34 @@ $.extend( $.IIIF1_1TileSource.prototype, $.TileSource.prototype, /** @lends Open
             scale = Math.pow( 0.5, this.maxLevel - level ),
 
             //# image dimensions at this level
-            level_width = Math.ceil( this.width * scale ),
+            levelWidth = Math.ceil( this.width * scale ),
-            level_height = Math.ceil( this.height * scale ),
+            levelHeight = Math.ceil( this.height * scale ),
 
             //## iiif region
-            iiif_tile_size_width = Math.ceil( this.tileSize / scale ),
+            iiifTileSizeWidth = Math.ceil( this.tileSize / scale ),
-            iiif_tile_size_height = Math.ceil( this.tileSize / scale ),
+            iiifTileSizeHeight = Math.ceil( this.tileSize / scale ),
-            iiif_region,
+            iiifRegion,
-            iiif_tile_x,
+            iiifTileX,
-            iiif_tile_y,
+            iiifTileY,
-            iiif_tile_w,
+            iiifTileW,
-            iiif_tile_h,
+            iiifTileH,
-            iiif_size,
+            iiifSize,
             uri;
 
-        if ( level_width < this.tile_width && level_height < this.tile_height ){
+        if ( levelWidth < this.tile_width && levelHeight < this.tile_height ){
-            iiif_size = level_width + "," + level_height;
+            iiifSize = levelWidth + ",";
-            iiif_region = 'full';
+            iiifRegion = 'full';
         } else {
-            iiif_tile_x = x * iiif_tile_size_width;
+            iiifTileX = x * iiifTileSizeWidth;
-            iiif_tile_y = y * iiif_tile_size_height;
+            iiifTileY = y * iiifTileSizeHeight;
-            iiif_tile_w = Math.min( iiif_tile_size_width, this.width - iiif_tile_x );
+            iiifTileW = Math.min( iiifTileSizeWidth, this.width - iiifTileX );
-            iiif_tile_h = Math.min( iiif_tile_size_height, this.height - iiif_tile_y );
+            iiifTileH = Math.min( iiifTileSizeHeight, this.height - iiifTileY );
-            iiif_size = Math.ceil(iiif_tile_w * scale) + "," +  Math.ceil(iiif_tile_h * scale);
+
-            iiif_region = [ iiif_tile_x, iiif_tile_y, iiif_tile_w, iiif_tile_h ].join(',');
+            iiifSize = Math.ceil( iiifTileW * scale ) + ",";
+
+            iiifRegion = [ iiifTileX, iiifTileY, iiifTileW, iiifTileH ].join( ',' );
         }
-        uri = [ this['@id'], iiif_region, iiif_size, IIIF_ROTATION, IIIF_QUALITY ].join('/');
+        uri = [ this['@id'], iiifRegion, iiifSize, IIIF_ROTATION, IIIF_QUALITY ].join( '/' );
         return uri;
     }
   });

test/data/iiif_1_1_no_tiles_1048.json

@@ -0,0 +1,18 @@
+{
+  "profile": "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level1",
+  "height": 870,
+  "width": 1048,
+  "qualities": [
+    "native",
+    "color",
+    "grey",
+    "bitonal"
+  ],
+  "formats": [
+    "jpg",
+    "png",
+    "gif"
+  ],
+  "@context": "http://library.stanford.edu/iiif/image-api/1.1/context.json",
+  "@id": "http://localhost:8000/test/data/iiif_1_1_no_tiles_1048"
+}

test/data/iiif_1_1_no_tiles_255.json

@@ -0,0 +1,18 @@
+{
+  "profile": "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level1",
+  "height": 212,
+  "width": 255,
+  "qualities": [
+    "native",
+    "color",
+    "grey",
+    "bitonal"
+  ],
+  "formats": [
+    "jpg",
+    "png",
+    "gif"
+  ],
+  "@context": "http://library.stanford.edu/iiif/image-api/1.1/context.json",
+  "@id": "http://localhost:8000/test/data/iiif_1_1_no_tiles_255"
+}

test/data/iiif_1_1_no_tiles_384.json

@@ -0,0 +1,18 @@
+{
+  "profile": "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level1",
+  "height": 319,
+  "width": 384,
+  "qualities": [
+    "native",
+    "color",
+    "grey",
+    "bitonal"
+  ],
+  "formats": [
+    "jpg",
+    "png",
+    "gif"
+  ],
+  "@context": "http://library.stanford.edu/iiif/image-api/1.1/context.json",
+  "@id": "http://localhost:8000/test/data/iiif_1_1_no_tiles_384"
+}

test/data/iiif_1_1_no_tiles_768.json

@@ -1,7 +1,7 @@
 {
   "profile": "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level2",
-  "height": 850,
+  "height": 637,
-  "width": 1024,
+  "width": 768,
   "qualities": [
     "native",
     "color",
@@ -14,6 +14,5 @@
     "gif"
   ],
   "@context": "http://library.stanford.edu/iiif/image-api/1.1/context.json",
-  "@id": "http://localhost:8000/test/data/iiif_no_tiles"
+  "@id": "http://localhost:8000/test/data/iiif_1_1_no_tiles_768"
 }
-

test/data/iiif_1_1_tiled.json

@@ -24,5 +24,5 @@
     "gif"
   ],
   "@context": "http://library.stanford.edu/iiif/image-api/1.1/context.json",
-  "@id": "http://localhost:8000/test/data/iiif_1_1_files"
+  "@id": "http://localhost:8000/test/data/iiif_1_1_tiled"
 }

test/formats.js

@@ -77,12 +77,27 @@
 
     // ----------
     asyncTest('IIIF 1.1 JSON', function() {
-        testOpen('iiif1_1.json');
+        testOpen('iiif_1_1_tiled.json');
     });
 
-        // ----------
+    // ----------
-    asyncTest('IIIF No Tiles', function() {
+    asyncTest('IIIF No Tiles, Less than 256', function() {
-        testOpen('iiif_no_tiles.json');
+        testOpen('iiif_1_1_no_tiles_255.json');
+    });
+
+    // ----------
+    asyncTest('IIIF No Tiles, Bet. 256 and 512', function() {
+        testOpen('iiif_1_1_no_tiles_384.json');
+    });
+
+    // ----------
+    asyncTest('IIIF No Tiles, Bet. 512 and 1024', function() {
+        testOpen('iiif_1_1_no_tiles_768.json');
+    });
+
+    // ----------
+    asyncTest('IIIF No Tiles, Larger than 1024', function() {
+        testOpen('iiif_1_1_no_tiles_1048.json');
     });
 
 })();