feat: initial GDAL Utils support - Githubissues

telus-agcg / ffi-gdal

MIT License

80 stars 2 forks source link

feat: initial GDAL Utils support #79

Closed oleksii-leonov closed 6 months ago

oleksii-leonov commented 7 months ago

Very basic support for GDAL Utilities (https://gdal.org/api/gdal_utils.html).

gdal_utils.h provides C API for GDAL Utils (gdalinfo, gdalwarp, gdal_translate, etc).

Python bindings have it (gdal.Warp, gdal.Translate, etc). Those utils are quite useful and it would be great to have them in Ruby.

Notes:

This PR implements only GDALInfo and GDALTranslate as a proof-of-concept. However, I plan to add other utils as well.
~~I am not very comfortable with FFI and GDAL C API pointers. Feel free to comment and advise if there is a better way to do things.~~
I intentionally do not expose GDALInfoOptions in rubyfied API. From my point of view, having to create and manage the lifecycle of the GDALInfoOption object would be a chore for the user. The user just needs to pass an array of strings.
It would be cool to add valgrind to the specs to ensure that we do not leak memory (the RGeo gem uses valgrind in the specs for this purpose).

oleksii-leonov commented 6 months ago

@tindron , thank you!

I will try to update this PR to implement all other Utils this weekend (and do some more fine-tuning).

oleksii-leonov commented 6 months ago

@tindron @turboladen

All GDAL Utils added to FFI mappings.
Ruby-fied wrapper implemented for:
- gdalinfo (GDALInfo, GDALInfoOption)
- gdal_translate (GDALTranslate, GDALTranslateOption)
- gdalwarp (GDALWarp, GDAPWarpAppOption)
- ogr2ogr (GDALVectorTranslate, GDALVectorTranslateOption)
- wrappers for other utils will be implemented later (this PR is already too big)
Extended YARD docs added for Ruby-fied wrapped GDAL Utils.
Progress callback functions have not been added yet (e.g. GDALWarpAppOptionsSetProgress). Will be done later.

oleksii-leonov commented 6 months ago

@tindron @turboladen

This one is ready to merge.

oleksii-leonov commented 6 months ago

Added:

gdal_rasterize (GDALRasterize)
gdal_grid (GDALGrid)
gdaldem (GDALDEMProcessing)

oleksii-leonov commented 6 months ago

Added:

nearblack (GDALNearblack)

oleksii-leonov commented 6 months ago

@tindron @turboladen

This PR is ready (and we are already using this code in production).

There are a couple of utils left to add (GDALFootrptint, etc.) to fully cover all utils available via the GDAL C API. But I would prefer to do it in separate PRs. This PR is already quite big, and I will need to add newer versions of GDAL 3.7-3.9 to CI first (as some utils require GDAL 3.7-3.9).