Changes between Version 69 and Version 70 of rfc24_progressive_data_support

Timestamp:

Apr 8, 2009, 4:57:49 PM (15 years ago)

Author:

normanb

Comment:

--

rfc24_progressive_data_support

@@ -61 +61 @@
 [[Image(gdalsequence.PNG)]]
 
- 1. GDALGetDatasetDriver
+1.  GDALGetDatasetDriver
 
-   Fetch the driver to which this dataset relates.
- 1. Open
+Fetch the driver to which this dataset relates.
 
-   If the filename contained in the GDALOpenInfo object has a case insensitive URI scheme of jpip or jpips the JPIPKAKDataset is created and initialised, otherwise NULL is returned.
- 1. Initialize
+2. Open
 
-   Initialisation involves making an initial connection to the JPIP Server to establish a session and to retrieve the initial metadata about the image (ref. JPIP Sequence Diagram).[[BR]]
-   If the connection fails, the function returns false and the Open function returns NULL indicating that opening the dataset with this driver failed.[[BR]]
-   If the connection is successful, then subsequent requests to the JPIP server are made to retrieve all the available metadata about the image. Metadata items are set using the GDALMajorObject->SetMetadataItem in the "JPIP" domain.[[BR]]
-   If the metadata returned from the server includes GeoJP2 UUID box, or a GMLJP2 XML box then this metadata is parsed and sets the geographic metadata of this dataset.
- 1. GDALGetMetadata
+If the filename contained in the GDALOpenInfo object has a case insensitive URI scheme of jpip or jpips the JPIPKAKDataset is created and initialised, otherwise NULL is returned.
 
-   C API to JPIPKAKDataset->GetMetadata
- 1. GetMetadata
+3. Initialize
+
+Initialisation involves making an initial connection to the JPIP Server to establish a session and to retrieve the initial metadata about the image (ref. JPIP Sequence Diagram).
+
+If the connection fails, the function returns false and the Open function returns NULL indicating that opening the dataset with this driver failed.
+
+If the connection is successful, then subsequent requests to the JPIP server are made to retrieve all the available metadata about the image. Metadata items are set using the GDALMajorObject->SetMetadataItem in the "JPIP" domain.
+
+If the metadata returned from the server includes GeoJP2 UUID box, or a GMLJP2 XML box then this metadata is parsed and sets the geographic metadata of this dataset.
+
+4. GDALGetMetadata
+
+C API to JPIPKAKDataset->GetMetadata
+
+5. GetMetadata
+
 returns metadata for the "JPIP" domain, keys are "JPIP_NQUALITYLAYERS", "JPIP_NRESOLUTIONLEVELS", "JPIP_NCOMPS" and "JPIP_SPRECISION"
- 1. GDALEndAsyncRasterIO
+
+6. GDALEndAsyncRasterIO
+
 If the asynchronous raster IO is active and not required, the C API calls JPIPKAKDataset->EndAsyncRasterIO
- 1. EndAsyncRasterIO
+
+7. EndAsyncRasterIO
+
 The JPIPKAKAsyncRasterIO object is deleted
- 1. delete
- 1. GDALBeginAsyncRasterIO
+
+8. delete
+
+9. GDALBeginAsyncRasterIO
+
 C API to JPIPKAKDataset->BeginAsyncRasterIO
- 1. BeginAsyncRasterIO
+
+10. BeginAsyncRasterIO
+
 The client has set the requested view window at 1:1 and have optionally set the discard level, quality layers and thread priority metadata items.
- 1. Create
+
+11. Create
+
 Creates a JPIPKAKAsyncRasterIO Object
- 1. Start
+
+12. Start
+
 Configures the kakadu machinery and starts a background thread (if not already running) to communicate to the server the current view window request. The background thread results in the kdu_cache object being updated until the JPIP server sends an "End Of Response" (EOR) message for the current view window request.
- 1. GDALLockBuffer
+
+13. GDALLockBuffer
+
 C API to LockBuffer
- 1. LockBuffer
+
+14. LockBuffer
+
 Not implemented in JPIPKAKAsyncRasterIO, a lock is acquired in JPIPKAKAsyncRasterIO->GetNextUpdatedRegion
- 1. GDALGetNextUpdatedRegion
+
+15. GDALGetNextUpdatedRegion
+
 C API to GetNextUpdatedRegion
- 1. GetNextUpdatedRegion
+
+16. GetNextUpdatedRegion
+
 The function decompresses the available data to generate an image (according to the dataset buffer type set in JPIPKAKDataset->BeginAsyncRasterIO) The window width, height (at the requested discard level) decompressed is returned in the region pointer and can be rendered by the client. The status of the rendering operation is one of GARIO_PENDING, GARIO_UPDATE, GARIO_ERROR, GARIO_COMPLETE from the GDALAsyncStatusType structure. GARIO_UPDATE, GARIO_PENDING require more reads of GetNextUpdatedRegion to get the full image data, this is the progressive rendering of JPIP. GARIO_COMPLETE indicates the window is complete.
 
@@ -103 +132 @@
 
 The region passed into this function is passed by reference, and the caller can read this region when the result returns to find the region that has been decompressed. The image data is packed into the buffer, e.g. RGB if the region requested has 3 components.
- 1. GDALUnlockBuffer
+
+17. GDALUnlockBuffer
+
 C Api to UnlockBuffer
- 1. UnlockBuffer
+
+18. UnlockBuffer
+
 Not implemented in JPIPKAKAsyncRasterIO, a lock is acquired in JPIPKAKAsyncRasterIO->GetNextUpdatedRegion
- 1. Draw
+
+19. Draw
+
 Client renders image data
- 1. GDALLockBuffer
- 1. LockBuffer
- 1. GDALGetNextUpdatedRegion
- 1. GetNextUpdatedRegion
- 1. GDALUnlockBuffer
- 1. UnlockBuffer
- 1. Draw
+
+20. GDALLockBuffer
+
+21. LockBuffer
+
+22. GDALGetNextUpdatedRegion
+
+23. GetNextUpdatedRegion
+
+24. GDALUnlockBuffer
+
+# UnlockBuffer
+
+# Draw