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 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168
|
/******************************************************************************
* $Id$
*
* Project: GDAL Core
* Purpose: GDAL Core C/Public declarations.
* Author: Frank Warmerdam, warmerdam@pobox.com
*
******************************************************************************
* Copyright (c) 1998, 2002 Frank Warmerdam
* Copyright (c) 2007-2014, Even Rouault <even dot rouault at spatialys.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
****************************************************************************/
#ifndef GDAL_H_INCLUDED
#define GDAL_H_INCLUDED
/**
* \file gdal.h
*
* Public (C callable) GDAL entry points.
*/
#ifndef DOXYGEN_SKIP
#if defined(GDAL_COMPILATION)
#define DO_NOT_DEFINE_GDAL_DATE_NAME
#endif
#include "gdal_version.h"
#include "cpl_port.h"
#include "cpl_error.h"
#include "cpl_progress.h"
#include "cpl_virtualmem.h"
#include "cpl_minixml.h"
#include "ogr_api.h"
#endif
#include <stdbool.h>
#include <stdint.h>
/* -------------------------------------------------------------------- */
/* Significant constants. */
/* -------------------------------------------------------------------- */
CPL_C_START
/*! Pixel data types */
typedef enum
{
/*! Unknown or unspecified type */ GDT_Unknown = 0,
/*! Eight bit unsigned integer */ GDT_Byte = 1,
/*! Sixteen bit unsigned integer */ GDT_UInt16 = 2,
/*! Sixteen bit signed integer */ GDT_Int16 = 3,
/*! Thirty two bit unsigned integer */ GDT_UInt32 = 4,
/*! Thirty two bit signed integer */ GDT_Int32 = 5,
/*! 64 bit unsigned integer (GDAL >= 3.5)*/ GDT_UInt64 = 12,
/*! 64 bit signed integer (GDAL >= 3.5)*/ GDT_Int64 = 13,
/*! Thirty two bit floating point */ GDT_Float32 = 6,
/*! Sixty four bit floating point */ GDT_Float64 = 7,
/*! Complex Int16 */ GDT_CInt16 = 8,
/*! Complex Int32 */ GDT_CInt32 = 9,
/* TODO?(#6879): GDT_CInt64 */
/*! Complex Float32 */ GDT_CFloat32 = 10,
/*! Complex Float64 */ GDT_CFloat64 = 11,
GDT_TypeCount = 14 /* maximum type # + 1 */
} GDALDataType;
int CPL_DLL CPL_STDCALL GDALGetDataTypeSize(GDALDataType); // Deprecated.
int CPL_DLL CPL_STDCALL GDALGetDataTypeSizeBits(GDALDataType eDataType);
int CPL_DLL CPL_STDCALL GDALGetDataTypeSizeBytes(GDALDataType);
int CPL_DLL CPL_STDCALL GDALDataTypeIsComplex(GDALDataType);
int CPL_DLL CPL_STDCALL GDALDataTypeIsInteger(GDALDataType);
int CPL_DLL CPL_STDCALL GDALDataTypeIsFloating(GDALDataType);
int CPL_DLL CPL_STDCALL GDALDataTypeIsSigned(GDALDataType);
const char CPL_DLL *CPL_STDCALL GDALGetDataTypeName(GDALDataType);
GDALDataType CPL_DLL CPL_STDCALL GDALGetDataTypeByName(const char *);
GDALDataType CPL_DLL CPL_STDCALL GDALDataTypeUnion(GDALDataType, GDALDataType);
GDALDataType CPL_DLL CPL_STDCALL GDALDataTypeUnionWithValue(GDALDataType eDT,
double dValue,
int bComplex);
GDALDataType CPL_DLL CPL_STDCALL GDALFindDataType(int nBits, int bSigned,
int bFloating, int bComplex);
GDALDataType CPL_DLL CPL_STDCALL GDALFindDataTypeForValue(double dValue,
int bComplex);
double CPL_DLL GDALAdjustValueToDataType(GDALDataType eDT, double dfValue,
int *pbClamped, int *pbRounded);
GDALDataType CPL_DLL CPL_STDCALL GDALGetNonComplexDataType(GDALDataType);
int CPL_DLL CPL_STDCALL GDALDataTypeIsConversionLossy(GDALDataType eTypeFrom,
GDALDataType eTypeTo);
/**
* status of the asynchronous stream
*/
typedef enum
{
GARIO_PENDING = 0,
GARIO_UPDATE = 1,
GARIO_ERROR = 2,
GARIO_COMPLETE = 3,
GARIO_TypeCount = 4
} GDALAsyncStatusType;
const char CPL_DLL *CPL_STDCALL GDALGetAsyncStatusTypeName(GDALAsyncStatusType);
GDALAsyncStatusType CPL_DLL CPL_STDCALL
GDALGetAsyncStatusTypeByName(const char *);
/*! Flag indicating read/write, or read-only access to data. */
typedef enum
{
/*! Read only (no update) access */ GA_ReadOnly = 0,
/*! Read/write access. */ GA_Update = 1
} GDALAccess;
/*! Read/Write flag for RasterIO() method */
typedef enum
{
/*! Read data */ GF_Read = 0,
/*! Write data */ GF_Write = 1
} GDALRWFlag;
/* NOTE: values are selected to be consistent with GDALResampleAlg of
* alg/gdalwarper.h */
/** RasterIO() resampling method.
* @since GDAL 2.0
*/
typedef enum
{
/*! Nearest neighbour */ GRIORA_NearestNeighbour = 0,
/*! Bilinear (2x2 kernel) */ GRIORA_Bilinear = 1,
/*! Cubic Convolution Approximation (4x4 kernel) */ GRIORA_Cubic = 2,
/*! Cubic B-Spline Approximation (4x4 kernel) */ GRIORA_CubicSpline = 3,
/*! Lanczos windowed sinc interpolation (6x6 kernel) */ GRIORA_Lanczos = 4,
/*! Average */ GRIORA_Average = 5,
/*! Mode (selects the value which appears most often of all the sampled
points) */
GRIORA_Mode = 6,
/*! Gauss blurring */ GRIORA_Gauss = 7,
/* NOTE: values 8 to 13 are reserved for max,min,med,Q1,Q3,sum */
/*! @cond Doxygen_Suppress */
GRIORA_RESERVED_START = 8,
GRIORA_RESERVED_END = 13,
/*! @endcond */
/** RMS: Root Mean Square / Quadratic Mean.
* For complex numbers, applies on the real and imaginary part
* independently.
*/
GRIORA_RMS = 14,
/*! @cond Doxygen_Suppress */
GRIORA_LAST = GRIORA_RMS
/*! @endcond */
} GDALRIOResampleAlg;
/* NOTE to developers: only add members, and if so edit INIT_RASTERIO_EXTRA_ARG
*/
/** Structure to pass extra arguments to RasterIO() method,
* must be initialized with INIT_RASTERIO_EXTRA_ARG
* @since GDAL 2.0
*/
typedef struct
{
/*! Version of structure (to allow future extensions of the structure) */
int nVersion;
/*! Resampling algorithm */
GDALRIOResampleAlg eResampleAlg;
/*! Progress callback */
GDALProgressFunc pfnProgress;
/*! Progress callback user data */
void *pProgressData;
/*! Indicate if dfXOff, dfYOff, dfXSize and dfYSize are set.
Mostly reserved from the VRT driver to communicate a more precise
source window. Must be such that dfXOff - nXOff < 1.0 and
dfYOff - nYOff < 1.0 and nXSize - dfXSize < 1.0 and nYSize - dfYSize
< 1.0 */
int bFloatingPointWindowValidity;
/*! Pixel offset to the top left corner. Only valid if
* bFloatingPointWindowValidity = TRUE */
double dfXOff;
/*! Line offset to the top left corner. Only valid if
* bFloatingPointWindowValidity = TRUE */
double dfYOff;
/*! Width in pixels of the area of interest. Only valid if
* bFloatingPointWindowValidity = TRUE */
double dfXSize;
/*! Height in pixels of the area of interest. Only valid if
* bFloatingPointWindowValidity = TRUE */
double dfYSize;
} GDALRasterIOExtraArg;
#ifndef DOXYGEN_SKIP
#define RASTERIO_EXTRA_ARG_CURRENT_VERSION 1
#endif
/** Macro to initialize an instance of GDALRasterIOExtraArg structure.
* @since GDAL 2.0
*/
#define INIT_RASTERIO_EXTRA_ARG(s) \
do \
{ \
(s).nVersion = RASTERIO_EXTRA_ARG_CURRENT_VERSION; \
(s).eResampleAlg = GRIORA_NearestNeighbour; \
(s).pfnProgress = CPL_NULLPTR; \
(s).pProgressData = CPL_NULLPTR; \
(s).bFloatingPointWindowValidity = FALSE; \
} while (0)
/*! Types of color interpretation for raster bands. */
typedef enum
{
/*! Undefined */ GCI_Undefined = 0,
/*! Greyscale */ GCI_GrayIndex = 1,
/*! Paletted (see associated color table) */ GCI_PaletteIndex = 2,
/*! Red band of RGBA image */ GCI_RedBand = 3,
/*! Green band of RGBA image */ GCI_GreenBand = 4,
/*! Blue band of RGBA image */ GCI_BlueBand = 5,
/*! Alpha (0=transparent, 255=opaque) */ GCI_AlphaBand = 6,
/*! Hue band of HLS image */ GCI_HueBand = 7,
/*! Saturation band of HLS image */ GCI_SaturationBand = 8,
/*! Lightness band of HLS image */ GCI_LightnessBand = 9,
/*! Cyan band of CMYK image */ GCI_CyanBand = 10,
/*! Magenta band of CMYK image */ GCI_MagentaBand = 11,
/*! Yellow band of CMYK image */ GCI_YellowBand = 12,
/*! Black band of CMYK image */ GCI_BlackBand = 13,
/*! Y Luminance */ GCI_YCbCr_YBand = 14,
/*! Cb Chroma */ GCI_YCbCr_CbBand = 15,
/*! Cr Chroma */ GCI_YCbCr_CrBand = 16,
/*! Max current value (equals to GCI_YCbCr_CrBand currently) */ GCI_Max = 16
} GDALColorInterp;
const char CPL_DLL *GDALGetColorInterpretationName(GDALColorInterp);
GDALColorInterp CPL_DLL GDALGetColorInterpretationByName(const char *pszName);
/*! Types of color interpretations for a GDALColorTable. */
typedef enum
{
/*! Grayscale (in GDALColorEntry.c1) */ GPI_Gray = 0,
/*! Red, Green, Blue and Alpha in (in c1, c2, c3 and c4) */ GPI_RGB = 1,
/*! Cyan, Magenta, Yellow and Black (in c1, c2, c3 and c4)*/ GPI_CMYK = 2,
/*! Hue, Lightness and Saturation (in c1, c2, and c3) */ GPI_HLS = 3
} GDALPaletteInterp;
const char CPL_DLL *GDALGetPaletteInterpretationName(GDALPaletteInterp);
/* "well known" metadata items. */
/** Metadata item for dataset that indicates the spatial interpretation of a
* pixel */
#define GDALMD_AREA_OR_POINT "AREA_OR_POINT"
/** Value for GDALMD_AREA_OR_POINT that indicates that a pixel represents an
* area */
#define GDALMD_AOP_AREA "Area"
/** Value for GDALMD_AREA_OR_POINT that indicates that a pixel represents a
* point */
#define GDALMD_AOP_POINT "Point"
/* -------------------------------------------------------------------- */
/* GDAL Specific error codes. */
/* */
/* error codes 100 to 299 reserved for GDAL. */
/* -------------------------------------------------------------------- */
#ifndef DOXYGEN_SKIP
#define CPLE_WrongFormat CPL_STATIC_CAST(CPLErrorNum, 200)
#endif
/* -------------------------------------------------------------------- */
/* Define handle types related to various internal classes. */
/* -------------------------------------------------------------------- */
/** Opaque type used for the C bindings of the C++ GDALMajorObject class */
typedef void *GDALMajorObjectH;
/** Opaque type used for the C bindings of the C++ GDALDataset class */
typedef void *GDALDatasetH;
/** Opaque type used for the C bindings of the C++ GDALRasterBand class */
typedef void *GDALRasterBandH;
/** Opaque type used for the C bindings of the C++ GDALDriver class */
typedef void *GDALDriverH;
/** Opaque type used for the C bindings of the C++ GDALColorTable class */
typedef void *GDALColorTableH;
/** Opaque type used for the C bindings of the C++ GDALRasterAttributeTable
* class */
typedef void *GDALRasterAttributeTableH;
/** Opaque type used for the C bindings of the C++ GDALAsyncReader class */
typedef void *GDALAsyncReaderH;
/** Opaque type used for the C bindings of the C++ GDALRelationship class
* @since GDAL 3.6
*/
typedef void *GDALRelationshipH;
/** Type to express pixel, line or band spacing. Signed 64 bit integer. */
typedef GIntBig GSpacing;
/** Enumeration giving the class of a GDALExtendedDataType.
* @since GDAL 3.1
*/
typedef enum
{
/** Numeric value. Based on GDALDataType enumeration */
GEDTC_NUMERIC,
/** String value. */
GEDTC_STRING,
/** Compound data type. */
GEDTC_COMPOUND
} GDALExtendedDataTypeClass;
/** Enumeration giving the subtype of a GDALExtendedDataType.
* @since GDAL 3.4
*/
typedef enum
{
/** None. */
GEDTST_NONE,
/** JSon. Only applies to GEDTC_STRING */
GEDTST_JSON
} GDALExtendedDataTypeSubType;
/** Opaque type for C++ GDALExtendedDataType */
typedef struct GDALExtendedDataTypeHS *GDALExtendedDataTypeH;
/** Opaque type for C++ GDALEDTComponent */
typedef struct GDALEDTComponentHS *GDALEDTComponentH;
/** Opaque type for C++ GDALGroup */
typedef struct GDALGroupHS *GDALGroupH;
/** Opaque type for C++ GDALMDArray */
typedef struct GDALMDArrayHS *GDALMDArrayH;
/** Opaque type for C++ GDALAttribute */
typedef struct GDALAttributeHS *GDALAttributeH;
/** Opaque type for C++ GDALDimension */
typedef struct GDALDimensionHS *GDALDimensionH;
/* ==================================================================== */
/* Registration/driver related. */
/* ==================================================================== */
/** Long name of the driver */
#define GDAL_DMD_LONGNAME "DMD_LONGNAME"
/** URL (relative to http://gdal.org/) to the help page of the driver */
#define GDAL_DMD_HELPTOPIC "DMD_HELPTOPIC"
/** MIME type handled by the driver. */
#define GDAL_DMD_MIMETYPE "DMD_MIMETYPE"
/** Extension handled by the driver. */
#define GDAL_DMD_EXTENSION "DMD_EXTENSION"
/** Connection prefix to provide as the file name of the open function.
* Typically set for non-file based drivers. Generally used with open options.
* @since GDAL 2.0
*/
#define GDAL_DMD_CONNECTION_PREFIX "DMD_CONNECTION_PREFIX"
/** List of (space separated) extensions handled by the driver.
* @since GDAL 2.0
*/
#define GDAL_DMD_EXTENSIONS "DMD_EXTENSIONS"
/** XML snippet with creation options. */
#define GDAL_DMD_CREATIONOPTIONLIST "DMD_CREATIONOPTIONLIST"
/** XML snippet with multidimensional dataset creation options.
* @since GDAL 3.1
*/
#define GDAL_DMD_MULTIDIM_DATASET_CREATIONOPTIONLIST \
"DMD_MULTIDIM_DATASET_CREATIONOPTIONLIST"
/** XML snippet with multidimensional group creation options.
* @since GDAL 3.1
*/
#define GDAL_DMD_MULTIDIM_GROUP_CREATIONOPTIONLIST \
"DMD_MULTIDIM_GROUP_CREATIONOPTIONLIST"
/** XML snippet with multidimensional dimension creation options.
* @since GDAL 3.1
*/
#define GDAL_DMD_MULTIDIM_DIMENSION_CREATIONOPTIONLIST \
"DMD_MULTIDIM_DIMENSION_CREATIONOPTIONLIST"
/** XML snippet with multidimensional array creation options.
* @since GDAL 3.1
*/
#define GDAL_DMD_MULTIDIM_ARRAY_CREATIONOPTIONLIST \
"DMD_MULTIDIM_ARRAY_CREATIONOPTIONLIST"
/** XML snippet with multidimensional array open options.
* @since GDAL 3.6
*/
#define GDAL_DMD_MULTIDIM_ARRAY_OPENOPTIONLIST \
"DMD_MULTIDIM_ARRAY_OPENOPTIONLIST"
/** XML snippet with multidimensional attribute creation options.
* @since GDAL 3.1
*/
#define GDAL_DMD_MULTIDIM_ATTRIBUTE_CREATIONOPTIONLIST \
"DMD_MULTIDIM_ATTRIBUTE_CREATIONOPTIONLIST"
/** XML snippet with open options.
* @since GDAL 2.0
*/
#define GDAL_DMD_OPENOPTIONLIST "DMD_OPENOPTIONLIST"
/** List of (space separated) raster data types support by the
* Create()/CreateCopy() API. */
#define GDAL_DMD_CREATIONDATATYPES "DMD_CREATIONDATATYPES"
/** List of (space separated) vector field types support by the CreateField()
* API.
* @since GDAL 2.0
* */
#define GDAL_DMD_CREATIONFIELDDATATYPES "DMD_CREATIONFIELDDATATYPES"
/** List of (space separated) vector field sub-types support by the
* CreateField() API.
* @since GDAL 2.3
* */
#define GDAL_DMD_CREATIONFIELDDATASUBTYPES "DMD_CREATIONFIELDDATASUBTYPES"
/** Capability set by a driver that exposes Subdatasets.
*
* This capability reflects that a raster driver supports child layers, such as
* NetCDF or multi-table raster Geopackages.
*
* See GDAL_DCAP_MULTIPLE_VECTOR_LAYERS for a similar capability flag
* for vector drivers.
*/
#define GDAL_DMD_SUBDATASETS "DMD_SUBDATASETS"
/** Capability set by a driver that implements the Open() API. */
#define GDAL_DCAP_OPEN "DCAP_OPEN"
/** Capability set by a driver that implements the Create() API.
*
* If GDAL_DCAP_CREATE is set, but GDAL_DCAP_CREATECOPY not, a generic
* CreateCopy() implementation is available and will use the Create() API of
* the driver.
* So to test if some CreateCopy() implementation is available, generic or
* specialize, test for both GDAL_DCAP_CREATE and GDAL_DCAP_CREATECOPY.
*/
#define GDAL_DCAP_CREATE "DCAP_CREATE"
/** Capability set by a driver that implements the CreateMultidimensional() API.
*
* @since GDAL 3.1
*/
#define GDAL_DCAP_CREATE_MULTIDIMENSIONAL "DCAP_CREATE_MULTIDIMENSIONAL"
/** Capability set by a driver that implements the CreateCopy() API.
*
* If GDAL_DCAP_CREATECOPY is not defined, but GDAL_DCAP_CREATE is set, a
* generic CreateCopy() implementation is available and will use the Create()
* API of the driver. So to test if some CreateCopy() implementation is
* available, generic or specialize, test for both GDAL_DCAP_CREATE and
* GDAL_DCAP_CREATECOPY.
*/
#define GDAL_DCAP_CREATECOPY "DCAP_CREATECOPY"
/** Capability set by a driver that implements the CreateCopy() API, but with
* multidimensional raster as input and output.
*
* @since GDAL 3.1
*/
#define GDAL_DCAP_CREATECOPY_MULTIDIMENSIONAL "DCAP_CREATECOPY_MULTIDIMENSIONAL"
/** Capability set by a driver that supports multidimensional data.
* @since GDAL 3.1
*/
#define GDAL_DCAP_MULTIDIM_RASTER "DCAP_MULTIDIM_RASTER"
/** Capability set by a driver that can copy over subdatasets. */
#define GDAL_DCAP_SUBCREATECOPY "DCAP_SUBCREATECOPY"
/** Capability set by a driver that can read/create datasets through the VSI*L
* API. */
#define GDAL_DCAP_VIRTUALIO "DCAP_VIRTUALIO"
/** Capability set by a driver having raster capability.
* @since GDAL 2.0
*/
#define GDAL_DCAP_RASTER "DCAP_RASTER"
/** Capability set by a driver having vector capability.
* @since GDAL 2.0
*/
#define GDAL_DCAP_VECTOR "DCAP_VECTOR"
/** Capability set by a driver having geographical network model capability.
* @since GDAL 2.1
*/
#define GDAL_DCAP_GNM "DCAP_GNM"
/** Capability set by a driver that can create layers.
* @since GDAL 3.6
*/
#define GDAL_DCAP_CREATE_LAYER "DCAP_CREATE_LAYER"
/** Capability set by a driver that can delete layers.
* @since GDAL 3.6
*/
#define GDAL_DCAP_DELETE_LAYER "DCAP_DELETE_LAYER"
/** Capability set by a driver that can create fields.
* @since GDAL 3.6
*/
#define GDAL_DCAP_CREATE_FIELD "DCAP_CREATE_FIELD"
/** Capability set by a driver that can delete fields.
* @since GDAL 3.6
*/
#define GDAL_DCAP_DELETE_FIELD "DCAP_DELETE_FIELD"
/** Capability set by a driver that can reorder fields.
* @since GDAL 3.6
*/
#define GDAL_DCAP_REORDER_FIELDS "DCAP_REORDER_FIELDS"
/** List of (space separated) flags support by the OGRLayer::AlterFieldDefn()
* API.
*
* Supported values are "Name", "Type", "WidthPrecision", "Nullable", "Default",
* "Unique" and "Domain", corresponding respectively to the ALTER_NAME_FLAG,
* ALTER_TYPE_FLAG, ALTER_WIDTH_PRECISION_FLAG, ALTER_NULLABLE_FLAG,
* ALTER_DEFAULT_FLAG, ALTER_UNIQUE_FLAG, and ALTER_DOMAIN_FLAG flags.
*
* Note that advertizing one of these flags doesn't necessarily mean that
* all modifications of the corresponding property can be made. For example,
* altering the field type may be restricted by the current type of the field,
* etc.
*
* @since GDAL 3.6
*/
#define GDAL_DMD_ALTER_FIELD_DEFN_FLAGS "GDAL_DMD_ALTER_FIELD_DEFN_FLAGS"
/** Capability set by a driver that can create fields with NOT NULL constraint.
* @since GDAL 2.0
*/
#define GDAL_DCAP_NOTNULL_FIELDS "DCAP_NOTNULL_FIELDS"
/** Capability set by a driver that can create fields with UNIQUE constraint.
* @since GDAL 3.2
*/
#define GDAL_DCAP_UNIQUE_FIELDS "DCAP_UNIQUE_FIELDS"
/** Capability set by a driver that can create fields with DEFAULT values.
* @since GDAL 2.0
*/
#define GDAL_DCAP_DEFAULT_FIELDS "DCAP_DEFAULT_FIELDS"
/** Capability set by a driver that can create geometry fields with NOT NULL
* constraint.
* @since GDAL 2.0
*/
#define GDAL_DCAP_NOTNULL_GEOMFIELDS "DCAP_NOTNULL_GEOMFIELDS"
/** Capability set by a non-spatial driver having no support for geometries.
* E.g. non-spatial vector drivers (e.g. spreadsheet format drivers) do not
* support geometries, and accordingly will have this capability present.
* @since GDAL 2.3
*/
#define GDAL_DCAP_NONSPATIAL "DCAP_NONSPATIAL"
/** Capability set by a driver that can support curved geometries.
* @since GDAL 3.6
*/
#define GDAL_DCAP_CURVE_GEOMETRIES "DCAP_CURVE_GEOMETRIES"
/** Capability set by a driver that can support measured geometries.
*
* @since GDAL 3.6
*/
#define GDAL_DCAP_MEASURED_GEOMETRIES "DCAP_MEASURED_GEOMETRIES"
/** Capability set by a driver that can support the Z dimension for geometries.
*
* @since GDAL 3.6
*/
#define GDAL_DCAP_Z_GEOMETRIES "DCAP_Z_GEOMETRIES"
/** List of (space separated) flags which reflect the geometry handling behavior
* of a driver.
*
* Supported values are currently:
*
* - "EquatesMultiAndSingleLineStringDuringWrite" and
* "EquatesMultiAndSinglePolygonDuringWrite". These flags indicate that the
* driver does not differentiate between single-part and multi-part linestring
* and polygon geometries when writing features respectively.
*
* @since GDAL 3.6
*/
#define GDAL_DMD_GEOMETRY_FLAGS "GDAL_DMD_GEOMETRY_FLAGS"
/** Capability set by drivers which support feature styles.
* @since GDAL 2.3
*/
#define GDAL_DCAP_FEATURE_STYLES "DCAP_FEATURE_STYLES"
/** Capability set by drivers which support storing/retrieving coordinate epoch
* for dynamic CRS
* @since GDAL 3.4
*/
#define GDAL_DCAP_COORDINATE_EPOCH "DCAP_COORDINATE_EPOCH"
/** Capability set by drivers for formats which support multiple vector layers.
*
* Note: some GDAL drivers expose "virtual" layer support while the underlying
* formats themselves do not. This capability is only set for drivers of formats
* which have a native concept of multiple vector layers (such as GeoPackage).
*
* @since GDAL 3.4
*/
#define GDAL_DCAP_MULTIPLE_VECTOR_LAYERS "DCAP_MULTIPLE_VECTOR_LAYERS"
/** Capability set by drivers for formats which support reading field domains.
*
* @since GDAL 3.5
*/
#define GDAL_DCAP_FIELD_DOMAINS "DCAP_FIELD_DOMAINS"
/** Capability set by drivers for formats which support reading table
* relationships.
*
* @since GDAL 3.6
*/
#define GDAL_DCAP_RELATIONSHIPS "DCAP_RELATIONSHIPS"
/** Capability set by drivers for formats which support creating table
* relationships.
* @since GDAL 3.6
*/
#define GDAL_DCAP_CREATE_RELATIONSHIP "DCAP_CREATE_RELATIONSHIP"
/** Capability set by drivers for formats which support deleting table
* relationships.
* @since GDAL 3.6
*/
#define GDAL_DCAP_DELETE_RELATIONSHIP "DCAP_DELETE_RELATIONSHIP"
/** Capability set by drivers for formats which support updating existing table
* relationships.
* @since GDAL 3.6
*/
#define GDAL_DCAP_UPDATE_RELATIONSHIP "DCAP_UPDATE_RELATIONSHIP"
/** List of (space separated) flags indicating the features of relationships are
* supported by the driver.
*
* Supported values are:
*
* - "OneToOne": supports one-to-one relationships, see
* GDALRelationshipCardinality::GRC_ONE_TO_ONE
* - "OneToMany": supports one-to-many relationships, see
* GDALRelationshipCardinality::GRC_ONE_TO_MANY
* - "ManyToOne": supports many-to-one relationships, see
* GDALRelationshipCardinality::GRC_MANY_TO_ONE
* - "ManyToMany": supports many-to-many relationships, see
* GDALRelationshipCardinality::GRC_MANY_TO_MANY
* - "Composite": supports composite relationship types, see
* GDALRelationshipType::GRT_COMPOSITE
* - "Association": supports association relationship types, see
* GDALRelationshipType::GRT_ASSOCIATION
* - "Aggregation": supports aggregation relationship types, see
* GDALRelationshipType::GRT_AGGREGATION
* - "MultipleFieldKeys": multiple fields can be used for relationship keys. If
* not present then only a single field name can be used.
* - "ForwardPathLabel": supports forward path labels
* - "BackwardPathLabel": supports backward path labels
*
* @since GDAL 3.6
*/
#define GDAL_DMD_RELATIONSHIP_FLAGS "GDAL_DMD_RELATIONSHIP_FLAGS"
/** Capability set by drivers for formats which support renaming vector layers.
*
* @since GDAL 3.5
*/
#define GDAL_DCAP_RENAME_LAYERS "DCAP_RENAME_LAYERS"
/** List of (space separated) field domain types support by the AddFieldDomain()
* API.
*
* Supported values are Coded, Range and Glob, corresponding to the
* OGRFieldDomainType::OFDT_CODED, OGRFieldDomainType::OFDT_RANGE, and
* OGRFieldDomainType::OFDT_GLOB field domain types respectively.
*
* @since GDAL 3.5
*/
#define GDAL_DMD_CREATION_FIELD_DOMAIN_TYPES "DMD_CREATION_FIELD_DOMAIN_TYPES"
/** List of (space separated) flags support by the
* OGRLayer::AlterGeomFieldDefn() API.
*
* Supported values are "Name", "Type", "Nullable", "SRS", "CoordinateEpoch",
* corresponding respectively to the ALTER_GEOM_FIELD_DEFN_NAME_FLAG,
* ALTER_GEOM_FIELD_DEFN_TYPE_FLAG, ALTER_GEOM_FIELD_DEFN_NULLABLE_FLAG,
* ALTER_GEOM_FIELD_DEFN_SRS_FLAG, ALTER_GEOM_FIELD_DEFN_SRS_COORD_EPOCH_FLAG
* flags. Note that advertizing one of these flags doesn't necessarily mean that
* all modifications of the corresponding property can be made. For example,
* altering the geometry type may be restricted by the type of the geometries in
* the field, or changing the nullable state to non-nullable is not possible if
* null geometries are present, etc.
*
* @since GDAL 3.6
*/
#define GDAL_DMD_ALTER_GEOM_FIELD_DEFN_FLAGS "DMD_ALTER_GEOM_FIELD_DEFN_FLAGS"
/** List of (space separated) SQL dialects supported by the driver.
*
* The default SQL dialect for the driver will always be the first listed value.
*
* Standard values are:
*
* - "OGRSQL": the OGR SQL dialect, see
* https://gdal.org/user/ogr_sql_dialect.html
* - "SQLITE": the SQLite dialect, see
* https://gdal.org/user/sql_sqlite_dialect.html
* - "NATIVE": for drivers with an RDBMS backend this value indicates that the
* SQL will be passed directly to that database backend, and therefore the
* RDBMS' native dialect will be used
*
* Other dialect values may also be present for some drivers (for some of them,
* the query string to use might not even by SQL but a dedicated query
* language). For further details on their interpretation, see the documentation
* for the respective driver.
*
* @since GDAL 3.6
*/
#define GDAL_DMD_SUPPORTED_SQL_DIALECTS "DMD_SUPPORTED_SQL_DIALECTS"
/** Value for GDALDimension::GetType() specifying the X axis of a horizontal
* CRS.
* @since GDAL 3.1
*/
#define GDAL_DIM_TYPE_HORIZONTAL_X "HORIZONTAL_X"
/** Value for GDALDimension::GetType() specifying the Y axis of a horizontal
* CRS.
* @since GDAL 3.1
*/
#define GDAL_DIM_TYPE_HORIZONTAL_Y "HORIZONTAL_Y"
/** Value for GDALDimension::GetType() specifying a vertical axis.
* @since GDAL 3.1
*/
#define GDAL_DIM_TYPE_VERTICAL "VERTICAL"
/** Value for GDALDimension::GetType() specifying a temporal axis.
* @since GDAL 3.1
*/
#define GDAL_DIM_TYPE_TEMPORAL "TEMPORAL"
/** Value for GDALDimension::GetType() specifying a parametric axis.
* @since GDAL 3.1
*/
#define GDAL_DIM_TYPE_PARAMETRIC "PARAMETRIC"
#define GDsCAddRelationship \
"AddRelationship" /**< Dataset capability for supporting AddRelationship() \
(at least partially) */
#define GDsCDeleteRelationship \
"DeleteRelationship" /**< Dataset capability for supporting \
DeleteRelationship()*/
#define GDsCUpdateRelationship \
"UpdateRelationship" /**< Dataset capability for supporting \
UpdateRelationship()*/
void CPL_DLL CPL_STDCALL GDALAllRegister(void);
GDALDatasetH CPL_DLL CPL_STDCALL
GDALCreate(GDALDriverH hDriver, const char *, int, int, int, GDALDataType,
CSLConstList) CPL_WARN_UNUSED_RESULT;
GDALDatasetH CPL_DLL CPL_STDCALL GDALCreateCopy(GDALDriverH, const char *,
GDALDatasetH, int, CSLConstList,
GDALProgressFunc,
void *) CPL_WARN_UNUSED_RESULT;
GDALDriverH CPL_DLL CPL_STDCALL GDALIdentifyDriver(const char *pszFilename,
CSLConstList papszFileList);
GDALDriverH CPL_DLL CPL_STDCALL GDALIdentifyDriverEx(
const char *pszFilename, unsigned int nIdentifyFlags,
const char *const *papszAllowedDrivers, const char *const *papszFileList);
GDALDatasetH CPL_DLL CPL_STDCALL
GDALOpen(const char *pszFilename, GDALAccess eAccess) CPL_WARN_UNUSED_RESULT;
GDALDatasetH CPL_DLL CPL_STDCALL GDALOpenShared(const char *, GDALAccess)
CPL_WARN_UNUSED_RESULT;
/* Note: we define GDAL_OF_READONLY and GDAL_OF_UPDATE to be on purpose */
/* equals to GA_ReadOnly and GA_Update */
/** Open in read-only mode.
* Used by GDALOpenEx().
* @since GDAL 2.0
*/
#define GDAL_OF_READONLY 0x00
/** Open in update mode.
* Used by GDALOpenEx().
* @since GDAL 2.0
*/
#define GDAL_OF_UPDATE 0x01
/** Allow raster and vector drivers to be used.
* Used by GDALOpenEx().
* @since GDAL 2.0
*/
#define GDAL_OF_ALL 0x00
/** Allow raster drivers to be used.
* Used by GDALOpenEx().
* @since GDAL 2.0
*/
#define GDAL_OF_RASTER 0x02
/** Allow vector drivers to be used.
* Used by GDALOpenEx().
* @since GDAL 2.0
*/
#define GDAL_OF_VECTOR 0x04
/** Allow gnm drivers to be used.
* Used by GDALOpenEx().
* @since GDAL 2.1
*/
#define GDAL_OF_GNM 0x08
/** Allow multidimensional raster drivers to be used.
* Used by GDALOpenEx().
* @since GDAL 3.1
*/
#define GDAL_OF_MULTIDIM_RASTER 0x10
#ifndef DOXYGEN_SKIP
#define GDAL_OF_KIND_MASK 0x1E
#endif
/** Open in shared mode.
* Used by GDALOpenEx().
* @since GDAL 2.0
*/
#define GDAL_OF_SHARED 0x20
/** Emit error message in case of failed open.
* Used by GDALOpenEx().
* @since GDAL 2.0
*/
#define GDAL_OF_VERBOSE_ERROR 0x40
/** Open as internal dataset. Such dataset isn't registered in the global list
* of opened dataset. Cannot be used with GDAL_OF_SHARED.
*
* Used by GDALOpenEx().
* @since GDAL 2.0
*/
#define GDAL_OF_INTERNAL 0x80
/** Let GDAL decide if a array-based or hashset-based storage strategy for
* cached blocks must be used.
*
* GDAL_OF_DEFAULT_BLOCK_ACCESS, GDAL_OF_ARRAY_BLOCK_ACCESS and
* GDAL_OF_HASHSET_BLOCK_ACCESS are mutually exclusive.
*
* Used by GDALOpenEx().
* @since GDAL 2.1
*/
#define GDAL_OF_DEFAULT_BLOCK_ACCESS 0
/** Use a array-based storage strategy for cached blocks.
*
* GDAL_OF_DEFAULT_BLOCK_ACCESS, GDAL_OF_ARRAY_BLOCK_ACCESS and
* GDAL_OF_HASHSET_BLOCK_ACCESS are mutually exclusive.
*
* Used by GDALOpenEx().
* @since GDAL 2.1
*/
#define GDAL_OF_ARRAY_BLOCK_ACCESS 0x100
/** Use a hashset-based storage strategy for cached blocks.
*
* GDAL_OF_DEFAULT_BLOCK_ACCESS, GDAL_OF_ARRAY_BLOCK_ACCESS and
* GDAL_OF_HASHSET_BLOCK_ACCESS are mutually exclusive.
*
* Used by GDALOpenEx().
* @since GDAL 2.1
*/
#define GDAL_OF_HASHSET_BLOCK_ACCESS 0x200
#ifndef DOXYGEN_SKIP
/* Reserved for a potential future alternative to GDAL_OF_ARRAY_BLOCK_ACCESS
* and GDAL_OF_HASHSET_BLOCK_ACCESS */
#define GDAL_OF_RESERVED_1 0x300
/** Mask to detect the block access method */
#define GDAL_OF_BLOCK_ACCESS_MASK 0x300
#endif
GDALDatasetH CPL_DLL CPL_STDCALL GDALOpenEx(
const char *pszFilename, unsigned int nOpenFlags,
const char *const *papszAllowedDrivers, const char *const *papszOpenOptions,
const char *const *papszSiblingFiles) CPL_WARN_UNUSED_RESULT;
int CPL_DLL CPL_STDCALL GDALDumpOpenDatasets(FILE *);
GDALDriverH CPL_DLL CPL_STDCALL GDALGetDriverByName(const char *);
int CPL_DLL CPL_STDCALL GDALGetDriverCount(void);
GDALDriverH CPL_DLL CPL_STDCALL GDALGetDriver(int);
GDALDriverH CPL_DLL CPL_STDCALL GDALCreateDriver(void);
void CPL_DLL CPL_STDCALL GDALDestroyDriver(GDALDriverH);
int CPL_DLL CPL_STDCALL GDALRegisterDriver(GDALDriverH);
void CPL_DLL CPL_STDCALL GDALDeregisterDriver(GDALDriverH);
void CPL_DLL CPL_STDCALL GDALDestroyDriverManager(void);
#ifndef DOXYGEN_SKIP
void CPL_DLL GDALDestroy(void);
#endif
CPLErr CPL_DLL CPL_STDCALL GDALDeleteDataset(GDALDriverH, const char *);
CPLErr CPL_DLL CPL_STDCALL GDALRenameDataset(GDALDriverH,
const char *pszNewName,
const char *pszOldName);
CPLErr CPL_DLL CPL_STDCALL GDALCopyDatasetFiles(GDALDriverH,
const char *pszNewName,
const char *pszOldName);
int CPL_DLL CPL_STDCALL
GDALValidateCreationOptions(GDALDriverH, CSLConstList papszCreationOptions);
/* The following are deprecated */
const char CPL_DLL *CPL_STDCALL GDALGetDriverShortName(GDALDriverH);
const char CPL_DLL *CPL_STDCALL GDALGetDriverLongName(GDALDriverH);
const char CPL_DLL *CPL_STDCALL GDALGetDriverHelpTopic(GDALDriverH);
const char CPL_DLL *CPL_STDCALL GDALGetDriverCreationOptionList(GDALDriverH);
/* ==================================================================== */
/* GDAL_GCP */
/* ==================================================================== */
/** Ground Control Point */
typedef struct
{
/** Unique identifier, often numeric */
char *pszId;
/** Informational message or "" */
char *pszInfo;
/** Pixel (x) location of GCP on raster */
double dfGCPPixel;
/** Line (y) location of GCP on raster */
double dfGCPLine;
/** X position of GCP in georeferenced space */
double dfGCPX;
/** Y position of GCP in georeferenced space */
double dfGCPY;
/** Elevation of GCP, or zero if not known */
double dfGCPZ;
} GDAL_GCP;
void CPL_DLL CPL_STDCALL GDALInitGCPs(int, GDAL_GCP *);
void CPL_DLL CPL_STDCALL GDALDeinitGCPs(int, GDAL_GCP *);
GDAL_GCP CPL_DLL *CPL_STDCALL GDALDuplicateGCPs(int, const GDAL_GCP *);
int CPL_DLL CPL_STDCALL GDALGCPsToGeoTransform(
int nGCPCount, const GDAL_GCP *pasGCPs, double *padfGeoTransform,
int bApproxOK) CPL_WARN_UNUSED_RESULT;
int CPL_DLL CPL_STDCALL GDALInvGeoTransform(double *padfGeoTransformIn,
double *padfInvGeoTransformOut)
CPL_WARN_UNUSED_RESULT;
void CPL_DLL CPL_STDCALL GDALApplyGeoTransform(double *, double, double,
double *, double *);
void CPL_DLL GDALComposeGeoTransforms(const double *padfGeoTransform1,
const double *padfGeoTransform2,
double *padfGeoTransformOut);
/* ==================================================================== */
/* major objects (dataset, and, driver, drivermanager). */
/* ==================================================================== */
char CPL_DLL **CPL_STDCALL GDALGetMetadataDomainList(GDALMajorObjectH hObject);
char CPL_DLL **CPL_STDCALL GDALGetMetadata(GDALMajorObjectH, const char *);
CPLErr CPL_DLL CPL_STDCALL GDALSetMetadata(GDALMajorObjectH, CSLConstList,
const char *);
const char CPL_DLL *CPL_STDCALL GDALGetMetadataItem(GDALMajorObjectH,
const char *, const char *);
CPLErr CPL_DLL CPL_STDCALL GDALSetMetadataItem(GDALMajorObjectH, const char *,
const char *, const char *);
const char CPL_DLL *CPL_STDCALL GDALGetDescription(GDALMajorObjectH);
void CPL_DLL CPL_STDCALL GDALSetDescription(GDALMajorObjectH, const char *);
/* ==================================================================== */
/* GDALDataset class ... normally this represents one file. */
/* ==================================================================== */
/** Name of driver metadata item for layer creation option list */
#define GDAL_DS_LAYER_CREATIONOPTIONLIST "DS_LAYER_CREATIONOPTIONLIST"
GDALDriverH CPL_DLL CPL_STDCALL GDALGetDatasetDriver(GDALDatasetH);
char CPL_DLL **CPL_STDCALL GDALGetFileList(GDALDatasetH);
void CPL_DLL CPL_STDCALL GDALClose(GDALDatasetH);
int CPL_DLL CPL_STDCALL GDALGetRasterXSize(GDALDatasetH);
int CPL_DLL CPL_STDCALL GDALGetRasterYSize(GDALDatasetH);
int CPL_DLL CPL_STDCALL GDALGetRasterCount(GDALDatasetH);
GDALRasterBandH CPL_DLL CPL_STDCALL GDALGetRasterBand(GDALDatasetH, int);
CPLErr CPL_DLL CPL_STDCALL GDALAddBand(GDALDatasetH hDS, GDALDataType eType,
CSLConstList papszOptions);
GDALAsyncReaderH CPL_DLL CPL_STDCALL GDALBeginAsyncReader(
GDALDatasetH hDS, int nXOff, int nYOff, int nXSize, int nYSize, void *pBuf,
int nBufXSize, int nBufYSize, GDALDataType eBufType, int nBandCount,
int *panBandMap, int nPixelSpace, int nLineSpace, int nBandSpace,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
void CPL_DLL CPL_STDCALL GDALEndAsyncReader(GDALDatasetH hDS,
GDALAsyncReaderH hAsynchReaderH);
CPLErr CPL_DLL CPL_STDCALL GDALDatasetRasterIO(
GDALDatasetH hDS, GDALRWFlag eRWFlag, int nDSXOff, int nDSYOff,
int nDSXSize, int nDSYSize, void *pBuffer, int nBXSize, int nBYSize,
GDALDataType eBDataType, int nBandCount, int *panBandCount, int nPixelSpace,
int nLineSpace, int nBandSpace) CPL_WARN_UNUSED_RESULT;
CPLErr CPL_DLL CPL_STDCALL GDALDatasetRasterIOEx(
GDALDatasetH hDS, GDALRWFlag eRWFlag, int nDSXOff, int nDSYOff,
int nDSXSize, int nDSYSize, void *pBuffer, int nBXSize, int nBYSize,
GDALDataType eBDataType, int nBandCount, int *panBandCount,
GSpacing nPixelSpace, GSpacing nLineSpace, GSpacing nBandSpace,
GDALRasterIOExtraArg *psExtraArg) CPL_WARN_UNUSED_RESULT;
CPLErr CPL_DLL CPL_STDCALL GDALDatasetAdviseRead(
GDALDatasetH hDS, int nDSXOff, int nDSYOff, int nDSXSize, int nDSYSize,
int nBXSize, int nBYSize, GDALDataType eBDataType, int nBandCount,
int *panBandCount, CSLConstList papszOptions);
const char CPL_DLL *CPL_STDCALL GDALGetProjectionRef(GDALDatasetH);
OGRSpatialReferenceH CPL_DLL GDALGetSpatialRef(GDALDatasetH);
CPLErr CPL_DLL CPL_STDCALL GDALSetProjection(GDALDatasetH, const char *);
CPLErr CPL_DLL GDALSetSpatialRef(GDALDatasetH, OGRSpatialReferenceH);
CPLErr CPL_DLL CPL_STDCALL GDALGetGeoTransform(GDALDatasetH, double *);
CPLErr CPL_DLL CPL_STDCALL GDALSetGeoTransform(GDALDatasetH, double *);
int CPL_DLL CPL_STDCALL GDALGetGCPCount(GDALDatasetH);
const char CPL_DLL *CPL_STDCALL GDALGetGCPProjection(GDALDatasetH);
OGRSpatialReferenceH CPL_DLL GDALGetGCPSpatialRef(GDALDatasetH);
const GDAL_GCP CPL_DLL *CPL_STDCALL GDALGetGCPs(GDALDatasetH);
CPLErr CPL_DLL CPL_STDCALL GDALSetGCPs(GDALDatasetH, int, const GDAL_GCP *,
const char *);
CPLErr CPL_DLL GDALSetGCPs2(GDALDatasetH, int, const GDAL_GCP *,
OGRSpatialReferenceH);
void CPL_DLL *CPL_STDCALL GDALGetInternalHandle(GDALDatasetH, const char *);
int CPL_DLL CPL_STDCALL GDALReferenceDataset(GDALDatasetH);
int CPL_DLL CPL_STDCALL GDALDereferenceDataset(GDALDatasetH);
int CPL_DLL CPL_STDCALL GDALReleaseDataset(GDALDatasetH);
CPLErr CPL_DLL CPL_STDCALL GDALBuildOverviews(GDALDatasetH, const char *, int,
const int *, int, const int *,
GDALProgressFunc,
void *) CPL_WARN_UNUSED_RESULT;
CPLErr CPL_DLL CPL_STDCALL GDALBuildOverviewsEx(
GDALDatasetH, const char *, int, const int *, int, const int *,
GDALProgressFunc, void *, CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
void CPL_DLL CPL_STDCALL GDALGetOpenDatasets(GDALDatasetH **hDS, int *pnCount);
int CPL_DLL CPL_STDCALL GDALGetAccess(GDALDatasetH hDS);
void CPL_DLL CPL_STDCALL GDALFlushCache(GDALDatasetH hDS);
CPLErr CPL_DLL CPL_STDCALL GDALCreateDatasetMaskBand(GDALDatasetH hDS,
int nFlags);
CPLErr CPL_DLL CPL_STDCALL GDALDatasetCopyWholeRaster(
GDALDatasetH hSrcDS, GDALDatasetH hDstDS, CSLConstList papszOptions,
GDALProgressFunc pfnProgress, void *pProgressData) CPL_WARN_UNUSED_RESULT;
CPLErr CPL_DLL CPL_STDCALL GDALRasterBandCopyWholeRaster(
GDALRasterBandH hSrcBand, GDALRasterBandH hDstBand,
const char *const *constpapszOptions, GDALProgressFunc pfnProgress,
void *pProgressData) CPL_WARN_UNUSED_RESULT;
CPLErr CPL_DLL GDALRegenerateOverviews(GDALRasterBandH hSrcBand,
int nOverviewCount,
GDALRasterBandH *pahOverviewBands,
const char *pszResampling,
GDALProgressFunc pfnProgress,
void *pProgressData);
CPLErr CPL_DLL GDALRegenerateOverviewsEx(GDALRasterBandH hSrcBand,
int nOverviewCount,
GDALRasterBandH *pahOverviewBands,
const char *pszResampling,
GDALProgressFunc pfnProgress,
void *pProgressData,
CSLConstList papszOptions);
int CPL_DLL GDALDatasetGetLayerCount(GDALDatasetH);
OGRLayerH CPL_DLL GDALDatasetGetLayer(GDALDatasetH, int);
OGRLayerH CPL_DLL GDALDatasetGetLayerByName(GDALDatasetH, const char *);
int CPL_DLL GDALDatasetIsLayerPrivate(GDALDatasetH, int);
OGRErr CPL_DLL GDALDatasetDeleteLayer(GDALDatasetH, int);
OGRLayerH CPL_DLL GDALDatasetCreateLayer(GDALDatasetH, const char *,
OGRSpatialReferenceH,
OGRwkbGeometryType, CSLConstList);
OGRLayerH CPL_DLL GDALDatasetCopyLayer(GDALDatasetH, OGRLayerH, const char *,
CSLConstList);
void CPL_DLL GDALDatasetResetReading(GDALDatasetH);
OGRFeatureH CPL_DLL GDALDatasetGetNextFeature(GDALDatasetH hDS,
OGRLayerH *phBelongingLayer,
double *pdfProgressPct,
GDALProgressFunc pfnProgress,
void *pProgressData);
int CPL_DLL GDALDatasetTestCapability(GDALDatasetH, const char *);
OGRLayerH CPL_DLL GDALDatasetExecuteSQL(GDALDatasetH, const char *,
OGRGeometryH, const char *);
OGRErr CPL_DLL GDALDatasetAbortSQL(GDALDatasetH);
void CPL_DLL GDALDatasetReleaseResultSet(GDALDatasetH, OGRLayerH);
OGRStyleTableH CPL_DLL GDALDatasetGetStyleTable(GDALDatasetH);
void CPL_DLL GDALDatasetSetStyleTableDirectly(GDALDatasetH, OGRStyleTableH);
void CPL_DLL GDALDatasetSetStyleTable(GDALDatasetH, OGRStyleTableH);
OGRErr CPL_DLL GDALDatasetStartTransaction(GDALDatasetH hDS, int bForce);
OGRErr CPL_DLL GDALDatasetCommitTransaction(GDALDatasetH hDS);
OGRErr CPL_DLL GDALDatasetRollbackTransaction(GDALDatasetH hDS);
void CPL_DLL GDALDatasetClearStatistics(GDALDatasetH hDS);
char CPL_DLL **GDALDatasetGetFieldDomainNames(GDALDatasetH, CSLConstList)
CPL_WARN_UNUSED_RESULT;
OGRFieldDomainH CPL_DLL GDALDatasetGetFieldDomain(GDALDatasetH hDS,
const char *pszName);
bool CPL_DLL GDALDatasetAddFieldDomain(GDALDatasetH hDS,
OGRFieldDomainH hFieldDomain,
char **ppszFailureReason);
bool CPL_DLL GDALDatasetDeleteFieldDomain(GDALDatasetH hDS, const char *pszName,
char **ppszFailureReason);
bool CPL_DLL GDALDatasetUpdateFieldDomain(GDALDatasetH hDS,
OGRFieldDomainH hFieldDomain,
char **ppszFailureReason);
char CPL_DLL **GDALDatasetGetRelationshipNames(GDALDatasetH, CSLConstList)
CPL_WARN_UNUSED_RESULT;
GDALRelationshipH CPL_DLL GDALDatasetGetRelationship(GDALDatasetH hDS,
const char *pszName);
bool CPL_DLL GDALDatasetAddRelationship(GDALDatasetH hDS,
GDALRelationshipH hRelationship,
char **ppszFailureReason);
bool CPL_DLL GDALDatasetDeleteRelationship(GDALDatasetH hDS,
const char *pszName,
char **ppszFailureReason);
bool CPL_DLL GDALDatasetUpdateRelationship(GDALDatasetH hDS,
GDALRelationshipH hRelationship,
char **ppszFailureReason);
/* ==================================================================== */
/* GDALRasterBand ... one band/channel in a dataset. */
/* ==================================================================== */
/* Note: the only user of SRCVAL() was frmts/vrt/pixelfunctions.cpp and we no */
/* longer use it. */
/**
* SRCVAL - Macro which may be used by pixel functions to obtain
* a pixel from a source buffer.
*/
#define SRCVAL(papoSource, eSrcType, ii) \
(eSrcType == GDT_Byte \
? CPL_REINTERPRET_CAST(const GByte *, papoSource)[ii] \
: (eSrcType == GDT_Float32 \
? CPL_REINTERPRET_CAST(const float *, papoSource)[ii] \
: (eSrcType == GDT_Float64 \
? CPL_REINTERPRET_CAST(const double *, papoSource)[ii] \
: (eSrcType == GDT_Int32 \
? CPL_REINTERPRET_CAST(const GInt32 *, \
papoSource)[ii] \
: (eSrcType == GDT_UInt16 \
? CPL_REINTERPRET_CAST(const GUInt16 *, \
papoSource)[ii] \
: (eSrcType == GDT_Int16 \
? CPL_REINTERPRET_CAST( \
const GInt16 *, \
papoSource)[ii] \
: (eSrcType == GDT_UInt32 \
? CPL_REINTERPRET_CAST( \
const GUInt32 *, \
papoSource)[ii] \
: (eSrcType == GDT_CInt16 \
? CPL_REINTERPRET_CAST( \
const GInt16 \
*, \
papoSource)[( \
ii)*2] \
: (eSrcType == \
GDT_CInt32 \
? CPL_REINTERPRET_CAST( \
const GInt32 \
*, \
papoSource) \
[(ii)*2] \
: (eSrcType == \
GDT_CFloat32 \
? CPL_REINTERPRET_CAST( \
const float \
*, \
papoSource) \
[(ii)*2] \
: (eSrcType == \
GDT_CFloat64 \
? CPL_REINTERPRET_CAST( \
const double \
*, \
papoSource) \
[(ii)*2] \
: 0)))))))))))
/** Type of functions to pass to GDALAddDerivedBandPixelFunc.
* @since GDAL 2.2 */
typedef CPLErr (*GDALDerivedPixelFunc)(void **papoSources, int nSources,
void *pData, int nBufXSize,
int nBufYSize, GDALDataType eSrcType,
GDALDataType eBufType, int nPixelSpace,
int nLineSpace);
/** Type of functions to pass to GDALAddDerivedBandPixelFuncWithArgs.
* @since GDAL 3.4 */
typedef CPLErr (*GDALDerivedPixelFuncWithArgs)(
void **papoSources, int nSources, void *pData, int nBufXSize, int nBufYSize,
GDALDataType eSrcType, GDALDataType eBufType, int nPixelSpace,
int nLineSpace, CSLConstList papszFunctionArgs);
GDALDataType CPL_DLL CPL_STDCALL GDALGetRasterDataType(GDALRasterBandH);
void CPL_DLL CPL_STDCALL GDALGetBlockSize(GDALRasterBandH, int *pnXSize,
int *pnYSize);
CPLErr CPL_DLL CPL_STDCALL GDALGetActualBlockSize(GDALRasterBandH,
int nXBlockOff,
int nYBlockOff, int *pnXValid,
int *pnYValid);
CPLErr CPL_DLL CPL_STDCALL GDALRasterAdviseRead(GDALRasterBandH hRB,
int nDSXOff, int nDSYOff,
int nDSXSize, int nDSYSize,
int nBXSize, int nBYSize,
GDALDataType eBDataType,
CSLConstList papszOptions);
CPLErr CPL_DLL CPL_STDCALL GDALRasterIO(GDALRasterBandH hRBand,
GDALRWFlag eRWFlag, int nDSXOff,
int nDSYOff, int nDSXSize, int nDSYSize,
void *pBuffer, int nBXSize, int nBYSize,
GDALDataType eBDataType,
int nPixelSpace,
int nLineSpace) CPL_WARN_UNUSED_RESULT;
CPLErr CPL_DLL CPL_STDCALL GDALRasterIOEx(
GDALRasterBandH hRBand, GDALRWFlag eRWFlag, int nDSXOff, int nDSYOff,
int nDSXSize, int nDSYSize, void *pBuffer, int nBXSize, int nBYSize,
GDALDataType eBDataType, GSpacing nPixelSpace, GSpacing nLineSpace,
GDALRasterIOExtraArg *psExtraArg) CPL_WARN_UNUSED_RESULT;
CPLErr CPL_DLL CPL_STDCALL GDALReadBlock(GDALRasterBandH, int, int,
void *) CPL_WARN_UNUSED_RESULT;
CPLErr CPL_DLL CPL_STDCALL GDALWriteBlock(GDALRasterBandH, int, int,
void *) CPL_WARN_UNUSED_RESULT;
int CPL_DLL CPL_STDCALL GDALGetRasterBandXSize(GDALRasterBandH);
int CPL_DLL CPL_STDCALL GDALGetRasterBandYSize(GDALRasterBandH);
GDALAccess CPL_DLL CPL_STDCALL GDALGetRasterAccess(GDALRasterBandH);
int CPL_DLL CPL_STDCALL GDALGetBandNumber(GDALRasterBandH);
GDALDatasetH CPL_DLL CPL_STDCALL GDALGetBandDataset(GDALRasterBandH);
GDALColorInterp
CPL_DLL CPL_STDCALL GDALGetRasterColorInterpretation(GDALRasterBandH);
CPLErr CPL_DLL CPL_STDCALL GDALSetRasterColorInterpretation(GDALRasterBandH,
GDALColorInterp);
GDALColorTableH CPL_DLL CPL_STDCALL GDALGetRasterColorTable(GDALRasterBandH);
CPLErr CPL_DLL CPL_STDCALL GDALSetRasterColorTable(GDALRasterBandH,
GDALColorTableH);
int CPL_DLL CPL_STDCALL GDALHasArbitraryOverviews(GDALRasterBandH);
int CPL_DLL CPL_STDCALL GDALGetOverviewCount(GDALRasterBandH);
GDALRasterBandH CPL_DLL CPL_STDCALL GDALGetOverview(GDALRasterBandH, int);
double CPL_DLL CPL_STDCALL GDALGetRasterNoDataValue(GDALRasterBandH, int *);
int64_t CPL_DLL CPL_STDCALL GDALGetRasterNoDataValueAsInt64(GDALRasterBandH,
int *);
uint64_t CPL_DLL CPL_STDCALL GDALGetRasterNoDataValueAsUInt64(GDALRasterBandH,
int *);
CPLErr CPL_DLL CPL_STDCALL GDALSetRasterNoDataValue(GDALRasterBandH, double);
CPLErr CPL_DLL CPL_STDCALL GDALSetRasterNoDataValueAsInt64(GDALRasterBandH,
int64_t);
CPLErr CPL_DLL CPL_STDCALL GDALSetRasterNoDataValueAsUInt64(GDALRasterBandH,
uint64_t);
CPLErr CPL_DLL CPL_STDCALL GDALDeleteRasterNoDataValue(GDALRasterBandH);
char CPL_DLL **CPL_STDCALL GDALGetRasterCategoryNames(GDALRasterBandH);
CPLErr CPL_DLL CPL_STDCALL GDALSetRasterCategoryNames(GDALRasterBandH,
CSLConstList);
double CPL_DLL CPL_STDCALL GDALGetRasterMinimum(GDALRasterBandH,
int *pbSuccess);
double CPL_DLL CPL_STDCALL GDALGetRasterMaximum(GDALRasterBandH,
int *pbSuccess);
CPLErr CPL_DLL CPL_STDCALL GDALGetRasterStatistics(
GDALRasterBandH, int bApproxOK, int bForce, double *pdfMin, double *pdfMax,
double *pdfMean, double *pdfStdDev);
CPLErr CPL_DLL CPL_STDCALL
GDALComputeRasterStatistics(GDALRasterBandH, int bApproxOK, double *pdfMin,
double *pdfMax, double *pdfMean, double *pdfStdDev,
GDALProgressFunc pfnProgress, void *pProgressData);
CPLErr CPL_DLL CPL_STDCALL GDALSetRasterStatistics(GDALRasterBandH hBand,
double dfMin, double dfMax,
double dfMean,
double dfStdDev);
GDALMDArrayH
CPL_DLL GDALRasterBandAsMDArray(GDALRasterBandH) CPL_WARN_UNUSED_RESULT;
const char CPL_DLL *CPL_STDCALL GDALGetRasterUnitType(GDALRasterBandH);
CPLErr CPL_DLL CPL_STDCALL GDALSetRasterUnitType(GDALRasterBandH hBand,
const char *pszNewValue);
double CPL_DLL CPL_STDCALL GDALGetRasterOffset(GDALRasterBandH, int *pbSuccess);
CPLErr CPL_DLL CPL_STDCALL GDALSetRasterOffset(GDALRasterBandH hBand,
double dfNewOffset);
double CPL_DLL CPL_STDCALL GDALGetRasterScale(GDALRasterBandH, int *pbSuccess);
CPLErr CPL_DLL CPL_STDCALL GDALSetRasterScale(GDALRasterBandH hBand,
double dfNewOffset);
CPLErr CPL_DLL CPL_STDCALL GDALComputeRasterMinMax(GDALRasterBandH hBand,
int bApproxOK,
double adfMinMax[2]);
CPLErr CPL_DLL CPL_STDCALL GDALFlushRasterCache(GDALRasterBandH hBand);
CPLErr CPL_DLL CPL_STDCALL GDALGetRasterHistogram(
GDALRasterBandH hBand, double dfMin, double dfMax, int nBuckets,
int *panHistogram, int bIncludeOutOfRange, int bApproxOK,
GDALProgressFunc pfnProgress, void *pProgressData)
/*! @cond Doxygen_Suppress */
CPL_WARN_DEPRECATED("Use GDALGetRasterHistogramEx() instead")
/*! @endcond */
;
CPLErr CPL_DLL CPL_STDCALL GDALGetRasterHistogramEx(
GDALRasterBandH hBand, double dfMin, double dfMax, int nBuckets,
GUIntBig *panHistogram, int bIncludeOutOfRange, int bApproxOK,
GDALProgressFunc pfnProgress, void *pProgressData);
CPLErr CPL_DLL CPL_STDCALL
GDALGetDefaultHistogram(GDALRasterBandH hBand, double *pdfMin, double *pdfMax,
int *pnBuckets, int **ppanHistogram, int bForce,
GDALProgressFunc pfnProgress, void *pProgressData)
/*! @cond Doxygen_Suppress */
CPL_WARN_DEPRECATED("Use GDALGetDefaultHistogramEx() instead")
/*! @endcond */
;
CPLErr CPL_DLL CPL_STDCALL
GDALGetDefaultHistogramEx(GDALRasterBandH hBand, double *pdfMin, double *pdfMax,
int *pnBuckets, GUIntBig **ppanHistogram, int bForce,
GDALProgressFunc pfnProgress, void *pProgressData);
CPLErr CPL_DLL CPL_STDCALL GDALSetDefaultHistogram(GDALRasterBandH hBand,
double dfMin, double dfMax,
int nBuckets,
int *panHistogram)
/*! @cond Doxygen_Suppress */
CPL_WARN_DEPRECATED("Use GDALSetDefaultHistogramEx() instead")
/*! @endcond */
;
CPLErr CPL_DLL CPL_STDCALL GDALSetDefaultHistogramEx(GDALRasterBandH hBand,
double dfMin, double dfMax,
int nBuckets,
GUIntBig *panHistogram);
int CPL_DLL CPL_STDCALL GDALGetRandomRasterSample(GDALRasterBandH, int,
float *);
GDALRasterBandH CPL_DLL CPL_STDCALL GDALGetRasterSampleOverview(GDALRasterBandH,
int);
GDALRasterBandH CPL_DLL CPL_STDCALL
GDALGetRasterSampleOverviewEx(GDALRasterBandH, GUIntBig);
CPLErr CPL_DLL CPL_STDCALL GDALFillRaster(GDALRasterBandH hBand,
double dfRealValue,
double dfImaginaryValue);
CPLErr CPL_DLL CPL_STDCALL GDALComputeBandStats(
GDALRasterBandH hBand, int nSampleStep, double *pdfMean, double *pdfStdDev,
GDALProgressFunc pfnProgress, void *pProgressData);
CPLErr CPL_DLL GDALOverviewMagnitudeCorrection(GDALRasterBandH hBaseBand,
int nOverviewCount,
GDALRasterBandH *pahOverviews,
GDALProgressFunc pfnProgress,
void *pProgressData);
GDALRasterAttributeTableH CPL_DLL CPL_STDCALL
GDALGetDefaultRAT(GDALRasterBandH hBand);
CPLErr CPL_DLL CPL_STDCALL GDALSetDefaultRAT(GDALRasterBandH,
GDALRasterAttributeTableH);
CPLErr CPL_DLL CPL_STDCALL GDALAddDerivedBandPixelFunc(
const char *pszName, GDALDerivedPixelFunc pfnPixelFunc);
CPLErr CPL_DLL CPL_STDCALL GDALAddDerivedBandPixelFuncWithArgs(
const char *pszName, GDALDerivedPixelFuncWithArgs pfnPixelFunc,
const char *pszMetadata);
GDALRasterBandH CPL_DLL CPL_STDCALL GDALGetMaskBand(GDALRasterBandH hBand);
int CPL_DLL CPL_STDCALL GDALGetMaskFlags(GDALRasterBandH hBand);
CPLErr CPL_DLL CPL_STDCALL GDALCreateMaskBand(GDALRasterBandH hBand,
int nFlags);
bool CPL_DLL GDALIsMaskBand(GDALRasterBandH hBand);
/** Flag returned by GDALGetMaskFlags() to indicate that all pixels are valid */
#define GMF_ALL_VALID 0x01
/** Flag returned by GDALGetMaskFlags() to indicate that the mask band is
* valid for all bands */
#define GMF_PER_DATASET 0x02
/** Flag returned by GDALGetMaskFlags() to indicate that the mask band is
* an alpha band */
#define GMF_ALPHA 0x04
/** Flag returned by GDALGetMaskFlags() to indicate that the mask band is
* computed from nodata values */
#define GMF_NODATA 0x08
/** Flag returned by GDALGetDataCoverageStatus() when the driver does not
* implement GetDataCoverageStatus(). This flag should be returned together
* with GDAL_DATA_COVERAGE_STATUS_DATA */
#define GDAL_DATA_COVERAGE_STATUS_UNIMPLEMENTED 0x01
/** Flag returned by GDALGetDataCoverageStatus() when there is (potentially)
* data in the queried window. Can be combined with the binary or operator
* with GDAL_DATA_COVERAGE_STATUS_UNIMPLEMENTED or
* GDAL_DATA_COVERAGE_STATUS_EMPTY */
#define GDAL_DATA_COVERAGE_STATUS_DATA 0x02
/** Flag returned by GDALGetDataCoverageStatus() when there is nodata in the
* queried window. This is typically identified by the concept of missing block
* in formats that supports it.
* Can be combined with the binary or operator with
* GDAL_DATA_COVERAGE_STATUS_DATA */
#define GDAL_DATA_COVERAGE_STATUS_EMPTY 0x04
int CPL_DLL CPL_STDCALL GDALGetDataCoverageStatus(GDALRasterBandH hBand,
int nXOff, int nYOff,
int nXSize, int nYSize,
int nMaskFlagStop,
double *pdfDataPct);
/* ==================================================================== */
/* GDALAsyncReader */
/* ==================================================================== */
GDALAsyncStatusType CPL_DLL CPL_STDCALL GDALARGetNextUpdatedRegion(
GDALAsyncReaderH hARIO, double dfTimeout, int *pnXBufOff, int *pnYBufOff,
int *pnXBufSize, int *pnYBufSize);
int CPL_DLL CPL_STDCALL GDALARLockBuffer(GDALAsyncReaderH hARIO,
double dfTimeout);
void CPL_DLL CPL_STDCALL GDALARUnlockBuffer(GDALAsyncReaderH hARIO);
/* -------------------------------------------------------------------- */
/* Helper functions. */
/* -------------------------------------------------------------------- */
int CPL_DLL CPL_STDCALL GDALGeneralCmdLineProcessor(int nArgc,
char ***ppapszArgv,
int nOptions);
void CPL_DLL CPL_STDCALL GDALSwapWords(void *pData, int nWordSize,
int nWordCount, int nWordSkip);
void CPL_DLL CPL_STDCALL GDALSwapWordsEx(void *pData, int nWordSize,
size_t nWordCount, int nWordSkip);
void CPL_DLL CPL_STDCALL GDALCopyWords(const void *CPL_RESTRICT pSrcData,
GDALDataType eSrcType,
int nSrcPixelOffset,
void *CPL_RESTRICT pDstData,
GDALDataType eDstType,
int nDstPixelOffset, int nWordCount);
void CPL_DLL CPL_STDCALL GDALCopyWords64(
const void *CPL_RESTRICT pSrcData, GDALDataType eSrcType,
int nSrcPixelOffset, void *CPL_RESTRICT pDstData, GDALDataType eDstType,
int nDstPixelOffset, GPtrDiff_t nWordCount);
void CPL_DLL GDALCopyBits(const GByte *pabySrcData, int nSrcOffset,
int nSrcStep, GByte *pabyDstData, int nDstOffset,
int nDstStep, int nBitCount, int nStepCount);
void CPL_DLL GDALDeinterleave(const void *pSourceBuffer, GDALDataType eSourceDT,
int nComponents, void **ppDestBuffer,
GDALDataType eDestDT, size_t nIters);
int CPL_DLL CPL_STDCALL GDALLoadWorldFile(const char *, double *);
int CPL_DLL CPL_STDCALL GDALReadWorldFile(const char *, const char *, double *);
int CPL_DLL CPL_STDCALL GDALWriteWorldFile(const char *, const char *,
double *);
int CPL_DLL CPL_STDCALL GDALLoadTabFile(const char *, double *, char **, int *,
GDAL_GCP **);
int CPL_DLL CPL_STDCALL GDALReadTabFile(const char *, double *, char **, int *,
GDAL_GCP **);
int CPL_DLL CPL_STDCALL GDALLoadOziMapFile(const char *, double *, char **,
int *, GDAL_GCP **);
int CPL_DLL CPL_STDCALL GDALReadOziMapFile(const char *, double *, char **,
int *, GDAL_GCP **);
const char CPL_DLL *CPL_STDCALL GDALDecToDMS(double, const char *, int);
double CPL_DLL CPL_STDCALL GDALPackedDMSToDec(double);
double CPL_DLL CPL_STDCALL GDALDecToPackedDMS(double);
/* Note to developers : please keep this section in sync with ogr_core.h */
#ifndef GDAL_VERSION_INFO_DEFINED
#ifndef DOXYGEN_SKIP
#define GDAL_VERSION_INFO_DEFINED
#endif
const char CPL_DLL *CPL_STDCALL GDALVersionInfo(const char *);
#endif
#ifndef GDAL_CHECK_VERSION
int CPL_DLL CPL_STDCALL GDALCheckVersion(int nVersionMajor, int nVersionMinor,
const char *pszCallingComponentName);
/** Helper macro for GDALCheckVersion()
@see GDALCheckVersion()
*/
#define GDAL_CHECK_VERSION(pszCallingComponentName) \
GDALCheckVersion(GDAL_VERSION_MAJOR, GDAL_VERSION_MINOR, \
pszCallingComponentName)
#endif
/*! @cond Doxygen_Suppress */
#ifdef GDAL_COMPILATION
#define GDALExtractRPCInfoV1 GDALExtractRPCInfo
#else
#define GDALRPCInfo GDALRPCInfoV2
#define GDALExtractRPCInfo GDALExtractRPCInfoV2
#endif
/* Deprecated: use GDALRPCInfoV2 */
typedef struct
{
double dfLINE_OFF; /*!< Line offset */
double dfSAMP_OFF; /*!< Sample/Pixel offset */
double dfLAT_OFF; /*!< Latitude offset */
double dfLONG_OFF; /*!< Longitude offset */
double dfHEIGHT_OFF; /*!< Height offset */
double dfLINE_SCALE; /*!< Line scale */
double dfSAMP_SCALE; /*!< Sample/Pixel scale */
double dfLAT_SCALE; /*!< Latitude scale */
double dfLONG_SCALE; /*!< Longitude scale */
double dfHEIGHT_SCALE; /*!< Height scale */
double adfLINE_NUM_COEFF[20]; /*!< Line Numerator Coefficients */
double adfLINE_DEN_COEFF[20]; /*!< Line Denominator Coefficients */
double adfSAMP_NUM_COEFF[20]; /*!< Sample/Pixel Numerator Coefficients */
double adfSAMP_DEN_COEFF[20]; /*!< Sample/Pixel Denominator Coefficients */
double dfMIN_LONG; /*!< Minimum longitude */
double dfMIN_LAT; /*!< Minimum latitude */
double dfMAX_LONG; /*!< Maximum longitude */
double dfMAX_LAT; /*!< Maximum latitude */
} GDALRPCInfoV1;
/*! @endcond */
/** Structure to store Rational Polynomial Coefficients / Rigorous Projection
* Model. See http://geotiff.maptools.org/rpc_prop.html */
typedef struct
{
double dfLINE_OFF; /*!< Line offset */
double dfSAMP_OFF; /*!< Sample/Pixel offset */
double dfLAT_OFF; /*!< Latitude offset */
double dfLONG_OFF; /*!< Longitude offset */
double dfHEIGHT_OFF; /*!< Height offset */
double dfLINE_SCALE; /*!< Line scale */
double dfSAMP_SCALE; /*!< Sample/Pixel scale */
double dfLAT_SCALE; /*!< Latitude scale */
double dfLONG_SCALE; /*!< Longitude scale */
double dfHEIGHT_SCALE; /*!< Height scale */
double adfLINE_NUM_COEFF[20]; /*!< Line Numerator Coefficients */
double adfLINE_DEN_COEFF[20]; /*!< Line Denominator Coefficients */
double adfSAMP_NUM_COEFF[20]; /*!< Sample/Pixel Numerator Coefficients */
double adfSAMP_DEN_COEFF[20]; /*!< Sample/Pixel Denominator Coefficients */
double dfMIN_LONG; /*!< Minimum longitude */
double dfMIN_LAT; /*!< Minimum latitude */
double dfMAX_LONG; /*!< Maximum longitude */
double dfMAX_LAT; /*!< Maximum latitude */
/* Those fields should be at the end. And all above fields should be the
* same as in GDALRPCInfoV1 */
double dfERR_BIAS; /*!< Bias error */
double dfERR_RAND; /*!< Random error */
} GDALRPCInfoV2;
/*! @cond Doxygen_Suppress */
int CPL_DLL CPL_STDCALL GDALExtractRPCInfoV1(CSLConstList, GDALRPCInfoV1 *);
/*! @endcond */
int CPL_DLL CPL_STDCALL GDALExtractRPCInfoV2(CSLConstList, GDALRPCInfoV2 *);
/* ==================================================================== */
/* Color tables. */
/* ==================================================================== */
/** Color tuple */
typedef struct
{
/*! gray, red, cyan or hue */
short c1;
/*! green, magenta, or lightness */
short c2;
/*! blue, yellow, or saturation */
short c3;
/*! alpha or blackband */
short c4;
} GDALColorEntry;
GDALColorTableH CPL_DLL CPL_STDCALL GDALCreateColorTable(GDALPaletteInterp)
CPL_WARN_UNUSED_RESULT;
void CPL_DLL CPL_STDCALL GDALDestroyColorTable(GDALColorTableH);
GDALColorTableH CPL_DLL CPL_STDCALL GDALCloneColorTable(GDALColorTableH);
GDALPaletteInterp
CPL_DLL CPL_STDCALL GDALGetPaletteInterpretation(GDALColorTableH);
int CPL_DLL CPL_STDCALL GDALGetColorEntryCount(GDALColorTableH);
const GDALColorEntry CPL_DLL *CPL_STDCALL GDALGetColorEntry(GDALColorTableH,
int);
int CPL_DLL CPL_STDCALL GDALGetColorEntryAsRGB(GDALColorTableH, int,
GDALColorEntry *);
void CPL_DLL CPL_STDCALL GDALSetColorEntry(GDALColorTableH, int,
const GDALColorEntry *);
void CPL_DLL CPL_STDCALL GDALCreateColorRamp(GDALColorTableH hTable,
int nStartIndex,
const GDALColorEntry *psStartColor,
int nEndIndex,
const GDALColorEntry *psEndColor);
/* ==================================================================== */
/* Raster Attribute Table */
/* ==================================================================== */
/** Field type of raster attribute table */
typedef enum
{
/*! Integer field */ GFT_Integer,
/*! Floating point (double) field */ GFT_Real,
/*! String field */ GFT_String
} GDALRATFieldType;
/** Field usage of raster attribute table */
typedef enum
{
/*! General purpose field. */ GFU_Generic = 0,
/*! Histogram pixel count */ GFU_PixelCount = 1,
/*! Class name */ GFU_Name = 2,
/*! Class range minimum */ GFU_Min = 3,
/*! Class range maximum */ GFU_Max = 4,
/*! Class value (min=max) */ GFU_MinMax = 5,
/*! Red class color (0-255) */ GFU_Red = 6,
/*! Green class color (0-255) */ GFU_Green = 7,
/*! Blue class color (0-255) */ GFU_Blue = 8,
/*! Alpha (0=transparent,255=opaque)*/ GFU_Alpha = 9,
/*! Color Range Red Minimum */ GFU_RedMin = 10,
/*! Color Range Green Minimum */ GFU_GreenMin = 11,
/*! Color Range Blue Minimum */ GFU_BlueMin = 12,
/*! Color Range Alpha Minimum */ GFU_AlphaMin = 13,
/*! Color Range Red Maximum */ GFU_RedMax = 14,
/*! Color Range Green Maximum */ GFU_GreenMax = 15,
/*! Color Range Blue Maximum */ GFU_BlueMax = 16,
/*! Color Range Alpha Maximum */ GFU_AlphaMax = 17,
/*! Maximum GFU value (equals to GFU_AlphaMax+1 currently) */ GFU_MaxCount
} GDALRATFieldUsage;
/** RAT table type (thematic or athematic)
* @since GDAL 2.4
*/
typedef enum
{
/*! Thematic table type */ GRTT_THEMATIC,
/*! Athematic table type */ GRTT_ATHEMATIC
} GDALRATTableType;
GDALRasterAttributeTableH CPL_DLL CPL_STDCALL
GDALCreateRasterAttributeTable(void) CPL_WARN_UNUSED_RESULT;
void CPL_DLL CPL_STDCALL
GDALDestroyRasterAttributeTable(GDALRasterAttributeTableH);
int CPL_DLL CPL_STDCALL GDALRATGetColumnCount(GDALRasterAttributeTableH);
const char CPL_DLL *CPL_STDCALL GDALRATGetNameOfCol(GDALRasterAttributeTableH,
int);
GDALRATFieldUsage CPL_DLL CPL_STDCALL
GDALRATGetUsageOfCol(GDALRasterAttributeTableH, int);
GDALRATFieldType CPL_DLL CPL_STDCALL
GDALRATGetTypeOfCol(GDALRasterAttributeTableH, int);
int CPL_DLL CPL_STDCALL GDALRATGetColOfUsage(GDALRasterAttributeTableH,
GDALRATFieldUsage);
int CPL_DLL CPL_STDCALL GDALRATGetRowCount(GDALRasterAttributeTableH);
const char CPL_DLL *CPL_STDCALL
GDALRATGetValueAsString(GDALRasterAttributeTableH, int, int);
int CPL_DLL CPL_STDCALL GDALRATGetValueAsInt(GDALRasterAttributeTableH, int,
int);
double CPL_DLL CPL_STDCALL GDALRATGetValueAsDouble(GDALRasterAttributeTableH,
int, int);
void CPL_DLL CPL_STDCALL GDALRATSetValueAsString(GDALRasterAttributeTableH, int,
int, const char *);
void CPL_DLL CPL_STDCALL GDALRATSetValueAsInt(GDALRasterAttributeTableH, int,
int, int);
void CPL_DLL CPL_STDCALL GDALRATSetValueAsDouble(GDALRasterAttributeTableH, int,
int, double);
int CPL_DLL CPL_STDCALL
GDALRATChangesAreWrittenToFile(GDALRasterAttributeTableH hRAT);
CPLErr CPL_DLL CPL_STDCALL GDALRATValuesIOAsDouble(
GDALRasterAttributeTableH hRAT, GDALRWFlag eRWFlag, int iField,
int iStartRow, int iLength, double *pdfData);
CPLErr CPL_DLL CPL_STDCALL
GDALRATValuesIOAsInteger(GDALRasterAttributeTableH hRAT, GDALRWFlag eRWFlag,
int iField, int iStartRow, int iLength, int *pnData);
CPLErr CPL_DLL CPL_STDCALL GDALRATValuesIOAsString(
GDALRasterAttributeTableH hRAT, GDALRWFlag eRWFlag, int iField,
int iStartRow, int iLength, CSLConstList papszStrList);
void CPL_DLL CPL_STDCALL GDALRATSetRowCount(GDALRasterAttributeTableH, int);
CPLErr CPL_DLL CPL_STDCALL GDALRATCreateColumn(GDALRasterAttributeTableH,
const char *, GDALRATFieldType,
GDALRATFieldUsage);
CPLErr CPL_DLL CPL_STDCALL GDALRATSetLinearBinning(GDALRasterAttributeTableH,
double, double);
int CPL_DLL CPL_STDCALL GDALRATGetLinearBinning(GDALRasterAttributeTableH,
double *, double *);
CPLErr CPL_DLL CPL_STDCALL GDALRATSetTableType(
GDALRasterAttributeTableH hRAT, const GDALRATTableType eInTableType);
GDALRATTableType CPL_DLL CPL_STDCALL
GDALRATGetTableType(GDALRasterAttributeTableH hRAT);
CPLErr CPL_DLL CPL_STDCALL
GDALRATInitializeFromColorTable(GDALRasterAttributeTableH, GDALColorTableH);
GDALColorTableH CPL_DLL CPL_STDCALL
GDALRATTranslateToColorTable(GDALRasterAttributeTableH, int nEntryCount);
void CPL_DLL CPL_STDCALL GDALRATDumpReadable(GDALRasterAttributeTableH, FILE *);
GDALRasterAttributeTableH CPL_DLL CPL_STDCALL
GDALRATClone(const GDALRasterAttributeTableH);
void CPL_DLL *CPL_STDCALL GDALRATSerializeJSON(GDALRasterAttributeTableH)
CPL_WARN_UNUSED_RESULT;
int CPL_DLL CPL_STDCALL GDALRATGetRowOfValue(GDALRasterAttributeTableH, double);
void CPL_DLL CPL_STDCALL GDALRATRemoveStatistics(GDALRasterAttributeTableH);
/* -------------------------------------------------------------------- */
/* Relationships */
/* -------------------------------------------------------------------- */
/** Cardinality of relationship.
*
* @since GDAL 3.6
*/
typedef enum
{
/** One-to-one */
GRC_ONE_TO_ONE,
/** One-to-many */
GRC_ONE_TO_MANY,
/** Many-to-one */
GRC_MANY_TO_ONE,
/** Many-to-many */
GRC_MANY_TO_MANY,
} GDALRelationshipCardinality;
/** Type of relationship.
*
* @since GDAL 3.6
*/
typedef enum
{
/** Composite relationship */
GRT_COMPOSITE,
/** Association relationship */
GRT_ASSOCIATION,
/** Aggregation relationship */
GRT_AGGREGATION,
} GDALRelationshipType;
GDALRelationshipH CPL_DLL GDALRelationshipCreate(const char *, const char *,
const char *,
GDALRelationshipCardinality);
void CPL_DLL CPL_STDCALL GDALDestroyRelationship(GDALRelationshipH);
const char CPL_DLL *GDALRelationshipGetName(GDALRelationshipH);
GDALRelationshipCardinality
CPL_DLL GDALRelationshipGetCardinality(GDALRelationshipH);
const char CPL_DLL *GDALRelationshipGetLeftTableName(GDALRelationshipH);
const char CPL_DLL *GDALRelationshipGetRightTableName(GDALRelationshipH);
const char CPL_DLL *GDALRelationshipGetMappingTableName(GDALRelationshipH);
void CPL_DLL GDALRelationshipSetMappingTableName(GDALRelationshipH,
const char *);
char CPL_DLL **GDALRelationshipGetLeftTableFields(GDALRelationshipH);
char CPL_DLL **GDALRelationshipGetRightTableFields(GDALRelationshipH);
void CPL_DLL GDALRelationshipSetLeftTableFields(GDALRelationshipH,
CSLConstList);
void CPL_DLL GDALRelationshipSetRightTableFields(GDALRelationshipH,
CSLConstList);
char CPL_DLL **GDALRelationshipGetLeftMappingTableFields(GDALRelationshipH);
char CPL_DLL **GDALRelationshipGetRightMappingTableFields(GDALRelationshipH);
void CPL_DLL GDALRelationshipSetLeftMappingTableFields(GDALRelationshipH,
CSLConstList);
void CPL_DLL GDALRelationshipSetRightMappingTableFields(GDALRelationshipH,
CSLConstList);
GDALRelationshipType CPL_DLL GDALRelationshipGetType(GDALRelationshipH);
void CPL_DLL GDALRelationshipSetType(GDALRelationshipH, GDALRelationshipType);
const char CPL_DLL *GDALRelationshipGetForwardPathLabel(GDALRelationshipH);
void CPL_DLL GDALRelationshipSetForwardPathLabel(GDALRelationshipH,
const char *);
const char CPL_DLL *GDALRelationshipGetBackwardPathLabel(GDALRelationshipH);
void CPL_DLL GDALRelationshipSetBackwardPathLabel(GDALRelationshipH,
const char *);
const char CPL_DLL *GDALRelationshipGetRelatedTableType(GDALRelationshipH);
void CPL_DLL GDALRelationshipSetRelatedTableType(GDALRelationshipH,
const char *);
/* ==================================================================== */
/* GDAL Cache Management */
/* ==================================================================== */
void CPL_DLL CPL_STDCALL GDALSetCacheMax(int nBytes);
int CPL_DLL CPL_STDCALL GDALGetCacheMax(void);
int CPL_DLL CPL_STDCALL GDALGetCacheUsed(void);
void CPL_DLL CPL_STDCALL GDALSetCacheMax64(GIntBig nBytes);
GIntBig CPL_DLL CPL_STDCALL GDALGetCacheMax64(void);
GIntBig CPL_DLL CPL_STDCALL GDALGetCacheUsed64(void);
int CPL_DLL CPL_STDCALL GDALFlushCacheBlock(void);
/* ==================================================================== */
/* GDAL virtual memory */
/* ==================================================================== */
CPLVirtualMem CPL_DLL *GDALDatasetGetVirtualMem(
GDALDatasetH hDS, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize,
int nYSize, int nBufXSize, int nBufYSize, GDALDataType eBufType,
int nBandCount, int *panBandMap, int nPixelSpace, GIntBig nLineSpace,
GIntBig nBandSpace, size_t nCacheSize, size_t nPageSizeHint,
int bSingleThreadUsage, CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
CPLVirtualMem CPL_DLL *GDALRasterBandGetVirtualMem(
GDALRasterBandH hBand, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize,
int nYSize, int nBufXSize, int nBufYSize, GDALDataType eBufType,
int nPixelSpace, GIntBig nLineSpace, size_t nCacheSize,
size_t nPageSizeHint, int bSingleThreadUsage,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
CPLVirtualMem CPL_DLL *
GDALGetVirtualMemAuto(GDALRasterBandH hBand, GDALRWFlag eRWFlag,
int *pnPixelSpace, GIntBig *pnLineSpace,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
/**! Enumeration to describe the tile organization */
typedef enum
{
/*! Tile Interleaved by Pixel: tile (0,0) with internal band interleaved by
pixel organization, tile (1, 0), ... */
GTO_TIP,
/*! Band Interleaved by Tile : tile (0,0) of first band, tile (0,0) of
second band, ... tile (1,0) of first band, tile (1,0) of second band, ...
*/
GTO_BIT,
/*! Band SeQuential : all the tiles of first band, all the tiles of
following band... */
GTO_BSQ
} GDALTileOrganization;
CPLVirtualMem CPL_DLL *GDALDatasetGetTiledVirtualMem(
GDALDatasetH hDS, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize,
int nYSize, int nTileXSize, int nTileYSize, GDALDataType eBufType,
int nBandCount, int *panBandMap, GDALTileOrganization eTileOrganization,
size_t nCacheSize, int bSingleThreadUsage,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
CPLVirtualMem CPL_DLL *GDALRasterBandGetTiledVirtualMem(
GDALRasterBandH hBand, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize,
int nYSize, int nTileXSize, int nTileYSize, GDALDataType eBufType,
size_t nCacheSize, int bSingleThreadUsage,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
/* ==================================================================== */
/* VRTPansharpenedDataset class. */
/* ==================================================================== */
GDALDatasetH CPL_DLL GDALCreatePansharpenedVRT(
const char *pszXML, GDALRasterBandH hPanchroBand, int nInputSpectralBands,
GDALRasterBandH *pahInputSpectralBands) CPL_WARN_UNUSED_RESULT;
/* =================================================================== */
/* Misc API */
/* ==================================================================== */
CPLXMLNode CPL_DLL *
GDALGetJPEG2000Structure(const char *pszFilename,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
/* ==================================================================== */
/* Multidimensional API_api */
/* ==================================================================== */
GDALDatasetH CPL_DLL
GDALCreateMultiDimensional(GDALDriverH hDriver, const char *pszName,
CSLConstList papszRootGroupOptions,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
GDALExtendedDataTypeH CPL_DLL GDALExtendedDataTypeCreate(GDALDataType eType)
CPL_WARN_UNUSED_RESULT;
GDALExtendedDataTypeH CPL_DLL GDALExtendedDataTypeCreateString(
size_t nMaxStringLength) CPL_WARN_UNUSED_RESULT;
GDALExtendedDataTypeH CPL_DLL GDALExtendedDataTypeCreateStringEx(
size_t nMaxStringLength,
GDALExtendedDataTypeSubType eSubType) CPL_WARN_UNUSED_RESULT;
GDALExtendedDataTypeH CPL_DLL GDALExtendedDataTypeCreateCompound(
const char *pszName, size_t nTotalSize, size_t nComponents,
const GDALEDTComponentH *comps) CPL_WARN_UNUSED_RESULT;
void CPL_DLL GDALExtendedDataTypeRelease(GDALExtendedDataTypeH hEDT);
const char CPL_DLL *GDALExtendedDataTypeGetName(GDALExtendedDataTypeH hEDT);
GDALExtendedDataTypeClass CPL_DLL
GDALExtendedDataTypeGetClass(GDALExtendedDataTypeH hEDT);
GDALDataType CPL_DLL
GDALExtendedDataTypeGetNumericDataType(GDALExtendedDataTypeH hEDT);
size_t CPL_DLL GDALExtendedDataTypeGetSize(GDALExtendedDataTypeH hEDT);
size_t CPL_DLL
GDALExtendedDataTypeGetMaxStringLength(GDALExtendedDataTypeH hEDT);
GDALEDTComponentH CPL_DLL *
GDALExtendedDataTypeGetComponents(GDALExtendedDataTypeH hEDT,
size_t *pnCount) CPL_WARN_UNUSED_RESULT;
void CPL_DLL GDALExtendedDataTypeFreeComponents(GDALEDTComponentH *components,
size_t nCount);
int CPL_DLL GDALExtendedDataTypeCanConvertTo(GDALExtendedDataTypeH hSourceEDT,
GDALExtendedDataTypeH hTargetEDT);
int CPL_DLL GDALExtendedDataTypeEquals(GDALExtendedDataTypeH hFirstEDT,
GDALExtendedDataTypeH hSecondEDT);
GDALExtendedDataTypeSubType CPL_DLL
GDALExtendedDataTypeGetSubType(GDALExtendedDataTypeH hEDT);
GDALEDTComponentH CPL_DLL
GDALEDTComponentCreate(const char *pszName, size_t nOffset,
GDALExtendedDataTypeH hType) CPL_WARN_UNUSED_RESULT;
void CPL_DLL GDALEDTComponentRelease(GDALEDTComponentH hComp);
const char CPL_DLL *GDALEDTComponentGetName(GDALEDTComponentH hComp);
size_t CPL_DLL GDALEDTComponentGetOffset(GDALEDTComponentH hComp);
GDALExtendedDataTypeH CPL_DLL GDALEDTComponentGetType(GDALEDTComponentH hComp)
CPL_WARN_UNUSED_RESULT;
GDALGroupH CPL_DLL GDALDatasetGetRootGroup(GDALDatasetH hDS)
CPL_WARN_UNUSED_RESULT;
void CPL_DLL GDALGroupRelease(GDALGroupH hGroup);
const char CPL_DLL *GDALGroupGetName(GDALGroupH hGroup);
const char CPL_DLL *GDALGroupGetFullName(GDALGroupH hGroup);
char CPL_DLL **
GDALGroupGetMDArrayNames(GDALGroupH hGroup,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
GDALMDArrayH CPL_DLL
GDALGroupOpenMDArray(GDALGroupH hGroup, const char *pszMDArrayName,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
GDALMDArrayH CPL_DLL GDALGroupOpenMDArrayFromFullname(
GDALGroupH hGroup, const char *pszMDArrayName,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
GDALMDArrayH CPL_DLL GDALGroupResolveMDArray(
GDALGroupH hGroup, const char *pszName, const char *pszStartingPoint,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
char CPL_DLL **
GDALGroupGetGroupNames(GDALGroupH hGroup,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
GDALGroupH CPL_DLL
GDALGroupOpenGroup(GDALGroupH hGroup, const char *pszSubGroupName,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
GDALGroupH CPL_DLL GDALGroupOpenGroupFromFullname(
GDALGroupH hGroup, const char *pszMDArrayName,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
char CPL_DLL **
GDALGroupGetVectorLayerNames(GDALGroupH hGroup,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
OGRLayerH CPL_DLL
GDALGroupOpenVectorLayer(GDALGroupH hGroup, const char *pszVectorLayerName,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
GDALDimensionH CPL_DLL *
GDALGroupGetDimensions(GDALGroupH hGroup, size_t *pnCount,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
GDALAttributeH CPL_DLL GDALGroupGetAttribute(
GDALGroupH hGroup, const char *pszName) CPL_WARN_UNUSED_RESULT;
GDALAttributeH CPL_DLL *
GDALGroupGetAttributes(GDALGroupH hGroup, size_t *pnCount,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
CSLConstList CPL_DLL GDALGroupGetStructuralInfo(GDALGroupH hGroup);
GDALGroupH CPL_DLL
GDALGroupCreateGroup(GDALGroupH hGroup, const char *pszSubGroupName,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
GDALDimensionH CPL_DLL GDALGroupCreateDimension(
GDALGroupH hGroup, const char *pszName, const char *pszType,
const char *pszDirection, GUInt64 nSize,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
GDALMDArrayH CPL_DLL GDALGroupCreateMDArray(
GDALGroupH hGroup, const char *pszName, size_t nDimensions,
GDALDimensionH *pahDimensions, GDALExtendedDataTypeH hEDT,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
GDALAttributeH CPL_DLL GDALGroupCreateAttribute(
GDALGroupH hGroup, const char *pszName, size_t nDimensions,
const GUInt64 *panDimensions, GDALExtendedDataTypeH hEDT,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
void CPL_DLL GDALMDArrayRelease(GDALMDArrayH hMDArray);
const char CPL_DLL *GDALMDArrayGetName(GDALMDArrayH hArray);
const char CPL_DLL *GDALMDArrayGetFullName(GDALMDArrayH hArray);
GUInt64 CPL_DLL GDALMDArrayGetTotalElementsCount(GDALMDArrayH hArray);
size_t CPL_DLL GDALMDArrayGetDimensionCount(GDALMDArrayH hArray);
GDALDimensionH CPL_DLL *
GDALMDArrayGetDimensions(GDALMDArrayH hArray,
size_t *pnCount) CPL_WARN_UNUSED_RESULT;
GDALExtendedDataTypeH CPL_DLL GDALMDArrayGetDataType(GDALMDArrayH hArray)
CPL_WARN_UNUSED_RESULT;
int CPL_DLL GDALMDArrayRead(GDALMDArrayH hArray, const GUInt64 *arrayStartIdx,
const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
GDALExtendedDataTypeH bufferDatatype,
void *pDstBuffer, const void *pDstBufferAllocStart,
size_t nDstBufferllocSize);
int CPL_DLL GDALMDArrayWrite(GDALMDArrayH hArray, const GUInt64 *arrayStartIdx,
const size_t *count, const GInt64 *arrayStep,
const GPtrDiff_t *bufferStride,
GDALExtendedDataTypeH bufferDatatype,
const void *pSrcBuffer,
const void *psrcBufferAllocStart,
size_t nSrcBufferllocSize);
int CPL_DLL GDALMDArrayAdviseRead(GDALMDArrayH hArray,
const GUInt64 *arrayStartIdx,
const size_t *count);
int CPL_DLL GDALMDArrayAdviseReadEx(GDALMDArrayH hArray,
const GUInt64 *arrayStartIdx,
const size_t *count,
CSLConstList papszOptions);
GDALAttributeH CPL_DLL GDALMDArrayGetAttribute(
GDALMDArrayH hArray, const char *pszName) CPL_WARN_UNUSED_RESULT;
GDALAttributeH CPL_DLL *
GDALMDArrayGetAttributes(GDALMDArrayH hArray, size_t *pnCount,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
GDALAttributeH CPL_DLL GDALMDArrayCreateAttribute(
GDALMDArrayH hArray, const char *pszName, size_t nDimensions,
const GUInt64 *panDimensions, GDALExtendedDataTypeH hEDT,
CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
const void CPL_DLL *GDALMDArrayGetRawNoDataValue(GDALMDArrayH hArray);
double CPL_DLL GDALMDArrayGetNoDataValueAsDouble(GDALMDArrayH hArray,
int *pbHasNoDataValue);
int64_t CPL_DLL GDALMDArrayGetNoDataValueAsInt64(GDALMDArrayH hArray,
int *pbHasNoDataValue);
uint64_t CPL_DLL GDALMDArrayGetNoDataValueAsUInt64(GDALMDArrayH hArray,
int *pbHasNoDataValue);
int CPL_DLL GDALMDArraySetRawNoDataValue(GDALMDArrayH hArray, const void *);
int CPL_DLL GDALMDArraySetNoDataValueAsDouble(GDALMDArrayH hArray,
double dfNoDataValue);
int CPL_DLL GDALMDArraySetNoDataValueAsInt64(GDALMDArrayH hArray,
int64_t nNoDataValue);
int CPL_DLL GDALMDArraySetNoDataValueAsUInt64(GDALMDArrayH hArray,
uint64_t nNoDataValue);
int CPL_DLL GDALMDArraySetScale(GDALMDArrayH hArray, double dfScale);
int CPL_DLL GDALMDArraySetScaleEx(GDALMDArrayH hArray, double dfScale,
GDALDataType eStorageType);
double CPL_DLL GDALMDArrayGetScale(GDALMDArrayH hArray, int *pbHasValue);
double CPL_DLL GDALMDArrayGetScaleEx(GDALMDArrayH hArray, int *pbHasValue,
GDALDataType *peStorageType);
int CPL_DLL GDALMDArraySetOffset(GDALMDArrayH hArray, double dfOffset);
int CPL_DLL GDALMDArraySetOffsetEx(GDALMDArrayH hArray, double dfOffset,
GDALDataType eStorageType);
double CPL_DLL GDALMDArrayGetOffset(GDALMDArrayH hArray, int *pbHasValue);
double CPL_DLL GDALMDArrayGetOffsetEx(GDALMDArrayH hArray, int *pbHasValue,
GDALDataType *peStorageType);
GUInt64 CPL_DLL *GDALMDArrayGetBlockSize(GDALMDArrayH hArray, size_t *pnCount);
int CPL_DLL GDALMDArraySetUnit(GDALMDArrayH hArray, const char *);
const char CPL_DLL *GDALMDArrayGetUnit(GDALMDArrayH hArray);
int CPL_DLL GDALMDArraySetSpatialRef(GDALMDArrayH, OGRSpatialReferenceH);
OGRSpatialReferenceH CPL_DLL GDALMDArrayGetSpatialRef(GDALMDArrayH hArray);
size_t CPL_DLL *GDALMDArrayGetProcessingChunkSize(GDALMDArrayH hArray,
size_t *pnCount,
size_t nMaxChunkMemory);
CSLConstList CPL_DLL GDALMDArrayGetStructuralInfo(GDALMDArrayH hArray);
GDALMDArrayH CPL_DLL GDALMDArrayGetView(GDALMDArrayH hArray,
const char *pszViewExpr);
GDALMDArrayH CPL_DLL GDALMDArrayTranspose(GDALMDArrayH hArray,
size_t nNewAxisCount,
const int *panMapNewAxisToOldAxis);
GDALMDArrayH CPL_DLL GDALMDArrayGetUnscaled(GDALMDArrayH hArray);
GDALMDArrayH CPL_DLL GDALMDArrayGetMask(GDALMDArrayH hArray,
CSLConstList papszOptions);
GDALDatasetH CPL_DLL GDALMDArrayAsClassicDataset(GDALMDArrayH hArray,
size_t iXDim, size_t iYDim);
CPLErr CPL_DLL GDALMDArrayGetStatistics(
GDALMDArrayH hArray, GDALDatasetH, int bApproxOK, int bForce,
double *pdfMin, double *pdfMax, double *pdfMean, double *pdfStdDev,
GUInt64 *pnValidCount, GDALProgressFunc pfnProgress, void *pProgressData);
int CPL_DLL GDALMDArrayComputeStatistics(GDALMDArrayH hArray, GDALDatasetH,
int bApproxOK, double *pdfMin,
double *pdfMax, double *pdfMean,
double *pdfStdDev,
GUInt64 *pnValidCount,
GDALProgressFunc, void *pProgressData);
GDALMDArrayH CPL_DLL GDALMDArrayGetResampled(GDALMDArrayH hArray,
size_t nNewDimCount,
const GDALDimensionH *pahNewDims,
GDALRIOResampleAlg resampleAlg,
OGRSpatialReferenceH hTargetSRS,
CSLConstList papszOptions);
GDALMDArrayH CPL_DLL *
GDALMDArrayGetCoordinateVariables(GDALMDArrayH hArray,
size_t *pnCount) CPL_WARN_UNUSED_RESULT;
void CPL_DLL GDALReleaseArrays(GDALMDArrayH *arrays, size_t nCount);
int CPL_DLL GDALMDArrayCache(GDALMDArrayH hArray, CSLConstList papszOptions);
void CPL_DLL GDALAttributeRelease(GDALAttributeH hAttr);
void CPL_DLL GDALReleaseAttributes(GDALAttributeH *attributes, size_t nCount);
const char CPL_DLL *GDALAttributeGetName(GDALAttributeH hAttr);
const char CPL_DLL *GDALAttributeGetFullName(GDALAttributeH hAttr);
GUInt64 CPL_DLL GDALAttributeGetTotalElementsCount(GDALAttributeH hAttr);
size_t CPL_DLL GDALAttributeGetDimensionCount(GDALAttributeH hAttr);
GUInt64 CPL_DLL *
GDALAttributeGetDimensionsSize(GDALAttributeH hAttr,
size_t *pnCount) CPL_WARN_UNUSED_RESULT;
GDALExtendedDataTypeH CPL_DLL GDALAttributeGetDataType(GDALAttributeH hAttr)
CPL_WARN_UNUSED_RESULT;
GByte CPL_DLL *GDALAttributeReadAsRaw(GDALAttributeH hAttr,
size_t *pnSize) CPL_WARN_UNUSED_RESULT;
void CPL_DLL GDALAttributeFreeRawResult(GDALAttributeH hAttr, GByte *raw,
size_t nSize);
const char CPL_DLL *GDALAttributeReadAsString(GDALAttributeH hAttr);
int CPL_DLL GDALAttributeReadAsInt(GDALAttributeH hAttr);
double CPL_DLL GDALAttributeReadAsDouble(GDALAttributeH hAttr);
char CPL_DLL **
GDALAttributeReadAsStringArray(GDALAttributeH hAttr) CPL_WARN_UNUSED_RESULT;
int CPL_DLL *GDALAttributeReadAsIntArray(GDALAttributeH hAttr, size_t *pnCount)
CPL_WARN_UNUSED_RESULT;
double CPL_DLL *
GDALAttributeReadAsDoubleArray(GDALAttributeH hAttr,
size_t *pnCount) CPL_WARN_UNUSED_RESULT;
int CPL_DLL GDALAttributeWriteRaw(GDALAttributeH hAttr, const void *, size_t);
int CPL_DLL GDALAttributeWriteString(GDALAttributeH hAttr, const char *);
int CPL_DLL GDALAttributeWriteStringArray(GDALAttributeH hAttr, CSLConstList);
int CPL_DLL GDALAttributeWriteInt(GDALAttributeH hAttr, int);
int CPL_DLL GDALAttributeWriteDouble(GDALAttributeH hAttr, double);
int CPL_DLL GDALAttributeWriteDoubleArray(GDALAttributeH hAttr, const double *,
size_t);
void CPL_DLL GDALDimensionRelease(GDALDimensionH hDim);
void CPL_DLL GDALReleaseDimensions(GDALDimensionH *dims, size_t nCount);
const char CPL_DLL *GDALDimensionGetName(GDALDimensionH hDim);
const char CPL_DLL *GDALDimensionGetFullName(GDALDimensionH hDim);
const char CPL_DLL *GDALDimensionGetType(GDALDimensionH hDim);
const char CPL_DLL *GDALDimensionGetDirection(GDALDimensionH hDim);
GUInt64 CPL_DLL GDALDimensionGetSize(GDALDimensionH hDim);
GDALMDArrayH CPL_DLL GDALDimensionGetIndexingVariable(GDALDimensionH hDim)
CPL_WARN_UNUSED_RESULT;
int CPL_DLL GDALDimensionSetIndexingVariable(GDALDimensionH hDim,
GDALMDArrayH hArray);
CPL_C_END
#endif /* ndef GDAL_H_INCLUDED */
|