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
|
# OSMPBF
https://github.com/openstreetmap/OSM-binary
Osmpbf is a Java/C++ library to read and write OpenStreetMap PBF files.
PBF (Protocol buffer Binary Format) is a binary file format for OpenStreetMap
data that uses Google Protocol Buffers as low-level storage.
For more information see https://wiki.openstreetmap.org/wiki/PBF_Format .
Note that this is a low-level library that does only part of the
encoding/decoding needed for actually writing/reading an OSM PBF file. For
something more complete see [libosmium](https://osmcode.org/libosmium/).
[](https://github.com/openstreetmap/OSM-binary/actions/workflows/c.yml)
[](https://github.com/openstreetmap/OSM-binary/actions/workflows/java.yml)
[](https://repology.org/project/libosmpbf/versions)
## Java Version
### Building with Maven
We publish the Java library to [Maven Central](https://mvnrepository.com/artifact/org.openstreetmap.pbf/osmpbf): 
```xml
<dependency>
<groupId>org.openstreetmap.pbf</groupId>
<artifactId>osmpbf</artifactId>
<version>${LATEST_VERSION}</version>
</dependency>
```
To build the Java library run:
```sh
mvn package
```
For a Java usage example, see
[`ReadFileTest`](https://github.com/openstreetmap/OSM-binary/blob/master/test.java/crosby/binary/ReadFileTest.java).
### Building with Ant
If you can not use Maven for some reason you can use the
[Ant](https://ant.apache.org/) instead:
```sh
ant
```
This will build `osmpbf.jar` in the main directory.
This build is also used for Debian packaging.
## C++ Version
To compile:
```sh
mkdir build && cd build
cmake ..
make
```
To install:
```sh
make install
```
There is a tool named osmpbf-outline that shows a debug output of the contents
of a PBF file. To run it:
```sh
tools/osmpbf-outline osm-file.osm.pbf
```
## Using the C++ Library
To include in your program use:
```c
#include <osmpbf/osmpbf.h>
```
and link with:
```
-pthread -lz -lprotobuf -losmpbf
```
## License
The .proto definition files and osmpbf.h are licensed under the MIT license.
The other source code is licensed under the LGPL v3+.
|
