/usr/include/osmium/output/pbf.hpp is in libosmium-dev 0.0~20111213-g7f3500a-1build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | #ifndef OSMIUM_OUTPUT_PBF_HPP
#define OSMIUM_OUTPUT_PBF_HPP
/*
Copyright 2011 Jochen Topf <jochen@topf.org> and others (see README).
This file is part of Osmium (https://github.com/joto/osmium).
Osmium is free software: you can redistribute it and/or modify it under the
terms of the GNU Lesser General Public License or (at your option) the GNU
General Public License as published by the Free Software Foundation, either
version 3 of the Licenses, or (at your option) any later version.
Osmium is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU Lesser General Public License and the GNU
General Public License for more details.
You should have received a copy of the Licenses along with Osmium. If not, see
<http://www.gnu.org/licenses/>.
*/
/*
About the .osm.pbf file format
This is an excerpt of <http://wiki.openstreetmap.org/wiki/PBF_Format>
The .osm.pbf format and it's derived formats (.osh.pbf and .osc.pbf) are encoded
using googles protobuf library for the low-level storage. They are constructed
by nesting data on two levels:
On the lower level the file is constructed using BlobHeaders and Blobs. A .osm.pbf
file contains multiple sequences of
1. a 4-byte header size, stored in network-byte-order
2. a BlobHeader of exactly this size
3. a Blob
The BlobHeader tells the reader about the type and size of the following Blob. The
Blob can contain data in raw or zlib-compressed form. After uncompressing the blob
it is treated differently depending on the type specified in the BlobHeader.
The contents of the Blob belongs to the higher level. It contains either an HeaderBlock
(type="OSMHeader") or an PrimitiveBlock (type="OSMData"). The file needs to have
at least one HeaderBlock before the first PrimitiveBlock.
The HeaderBlock contains meta-information like the writing program or a bbox. It may
also contain multiple "required features" that describe what kinds of input a
reading program needs to handle in order to fully understand the files' contents.
The PrimitiveBlock can store multiple types of objects (i.e. 5 nodes, 2 ways and
1 relation). It contains one or more PrimitiveGroup which in turn contain multiple
nodes, ways or relations. A PrimitiveGroup should only contain one kind of object.
There's a special kind of "object type" called dense-nodes. It is used to store nodes
in a very dense format, avoiding message overheads and using delta-encoding for nearly
all ids.
All Strings are stored as indexes to rows in a StringTable. The StringTable contains
one row for each used string, so strings that are used multiple times need to be
stored only once. The StringTable is sorted by usage-count, so the most often used
string is stored at index 1.
A simple outline of a .osm.pbf file could look like this:
4-bytes header size
BlobHeader
Blob
HeaderBlock
4-bytes header size
BlobHeader
Blob
PrimitiveBlock
StringTable
PrimitiveGroup
5 nodes
PrimitiveGroup
2 ways
PrimitiveGroup
1 relation
More complete outlines of real .osm.pbf files can be created using the osmpbf-outline tool:
<https://github.com/MaZderMind/OSM-binary/tree/osmpbf-outline>
*/
// netinet provides the network-byte-order conversion function
#include <netinet/in.h>
// the algorithm-lib contains the sort functions
#include <algorithm>
// math is used for round() in lonlat2int
#include <math.h>
#include <zlib.h>
#include <osmpbf/osmpbf.h>
// StringTable management
#include <osmium/utils/stringtable.hpp>
#include <osmium/utils/delta.hpp>
namespace Osmium {
namespace Output {
class PBF : public Base {
/**
* Maximum number of items in a primitive block.
*
* The uncompressed length of a Blob *should* be less
* than 16 megabytes and *must* be less than 32 megabytes.
*
* A block may contain any number of entities, as long as
* the size limits for the surrounding blob are obeyed.
* However, for simplicity, the current Osmosis (0.38)
* as well as Osmium implementation always
* uses at most 8k entities in a block.
*/
static const uint32_t max_block_contents = 8000;
/**
* The output buffer (block) will be filled to about
* 95% and then written to disk. This leaves more than
* enough space for the string table (which typically
* needs about 0.1 to 0.3% of the block size).
*/
static const int buffer_fill_percent = 95;
/**
* protobuf-struct of a Blob
*/
OSMPBF::Blob pbf_blob;
/**
* protobuf-struct of a BlobHeader
*/
OSMPBF::BlobHeader pbf_blob_header;
/**
* protobuf-struct of a HeaderBlock
*/
OSMPBF::HeaderBlock pbf_header_block;
/**
* protobuf-struct of a PrimitiveBlock
*/
OSMPBF::PrimitiveBlock pbf_primitive_block;
/**
* pointer to PrimitiveGroups inside the current PrimitiveBlock,
* used for writing nodes, ways or relations
*/
OSMPBF::PrimitiveGroup* pbf_nodes;
OSMPBF::PrimitiveGroup* pbf_ways;
OSMPBF::PrimitiveGroup* pbf_relations;
/**
* to flexibly handle multiple resolutions, the granularity, or
* resolution used for representing locations is adjustable in
* multiples of 1 nanodegree. The default scaling factor is 100
* nanodegrees, corresponding to about ~1cm at the equator.
* These is the current resolution of the OSM database.
*/
int m_location_granularity;
/**
* the granularity used for representing timestamps is also adjustable in
* multiples of 1 millisecond. The default scaling factor is 1000
* milliseconds, which is the current resolution of the OSM database.
*/
int m_date_granularity;
/**
* should nodes be serialized into the dense format?
*
* nodes can be encoded one of two ways, as a Node
* (m_use_dense_format = false) and a special dense format.
* In the dense format, all information is stored 'column wise',
* as an array of ID's, array of latitudes, and array of
* longitudes. Each column is delta-encoded. This reduces
* header overheads and allows delta-coding to work very effectively.
*/
bool m_use_dense_format;
/**
* should the PBF blobs contain zlib compressed data?
*
* the zlib compression is optional, it's possible to store the
* blobs in raw format. Disabling the compression can improve the
* writing speed a little but the output will be 2x to 3x bigger.
*/
bool m_use_compression;
/**
* While the .osm.pbf-format is able to carry all meta information, it is
* also able to omit this information to reduce size.
*/
bool m_should_add_metadata;
/**
* Should the visible flag be added on objects?
*/
bool m_add_visible;
/**
* counter used to quickly check the number of objects stored inside
* the current PrimitiveBlock. When the counter reaches max_block_contents
* the PrimitiveBlock is serialized into a Blob and flushed to the file.
*
* this check is performed in check_block_contents_counter() which is
* called once for each object.
*/
uint16_t primitive_block_contents;
uint32_t primitive_block_size;
// StringTable management
Osmium::StringTable string_table;
/// Buffer used while compressing blobs.
char m_compression_buffer[OSMPBF::max_uncompressed_blob_size];
/**
* These variables are used to calculate the
* delta-encoding while storing dense-nodes. It holds the last seen values
* from which the difference is stored into the protobuf.
*/
Delta<int64_t> m_delta_id;
Delta<int64_t> m_delta_lat;
Delta<int64_t> m_delta_lon;
Delta<int64_t> m_delta_timestamp;
Delta<int64_t> m_delta_changeset;
Delta<int64_t> m_delta_uid;
Delta<uint32_t> m_delta_user_sid;
///// Blob writing /////
/**
* Take a string and pack its contents.
*
* @param in String input.
* @return Number of bytes after compression.
*/
size_t zlib_compress(std::string &in) {
// zlib compression context
z_stream z;
// next byte to compress
z.next_in = (uint8_t*) in.c_str();
// number of bytes to compress
z.avail_in = in.size();
// place to store compressed bytes
z.next_out = (uint8_t*) m_compression_buffer;
// space for compressed data
z.avail_out = OSMPBF::max_uncompressed_blob_size;
// custom allocator functions - not used
z.zalloc = Z_NULL;
z.zfree = Z_NULL;
z.opaque = Z_NULL;
// initiate the compression
if (deflateInit(&z, Z_DEFAULT_COMPRESSION) != Z_OK) {
throw std::runtime_error("failed to init zlib stream");
}
// compress
if (deflate(&z, Z_FINISH) != Z_STREAM_END) {
throw std::runtime_error("failed to deflate zlib stream");
}
// finish compression
if (deflateEnd(&z) != Z_OK) {
throw std::runtime_error("failed to deinit zlib stream");
}
// print debug info about the compression
if (Osmium::debug()) {
std::cerr << "pack " << in.size() << " bytes to " << z.total_out << " bytes (1:" << (double)in.size() / z.total_out << ")" << std::endl;
}
// number of compressed bytes
return z.total_out;
}
/**
* Serialize a protobuf-message together into a Blob, optionally apply compression
* and write it together with a BlobHeader to the file.
*
* @param type Type-string used in the BlobHeader.
* @param msg Protobuf-message.
*/
void store_blob(const std::string &type, const google::protobuf::MessageLite &msg) {
// buffer to serialize the protobuf message to
std::string data;
// serialize the protobuf message to the string
msg.SerializeToString(&data);
if (use_compression()) {
// compress using zlib
size_t out = zlib_compress(data);
// set the compressed data on the Blob
pbf_blob.set_zlib_data(m_compression_buffer, out);
} else { // no compression
// print debug info about the raw data
if (Osmium::debug()) {
std::cerr << "store uncompressed " << data.size() << " bytes" << std::endl;
}
// just set the raw data on the Blob
pbf_blob.set_raw(data);
}
// set the size of the uncompressed data on the blob
pbf_blob.set_raw_size(data.size());
// clear the blob string
data.clear();
// serialize and clear the Blob
pbf_blob.SerializeToString(&data);
pbf_blob.Clear();
// set the header-type to the supplied string on the BlobHeader
pbf_blob_header.set_type(type);
// set the size of the serialized blob on the BlobHeader
pbf_blob_header.set_datasize(data.size());
// a place to serialize the BlobHeader to
std::string blobhead;
// serialize and clear the BlobHeader
pbf_blob_header.SerializeToString(&blobhead);
pbf_blob_header.Clear();
// the 4-byte size of the BlobHeader, transformed from Host- to Network-Byte-Order
uint32_t sz = htonl(blobhead.size());
// write to the file: the 4-byte BlobHeader-Size followed by the BlobHeader followed by the Blob
if (::write(get_fd(), &sz, sizeof(sz)) < 0) {
throw std::runtime_error("file error");
}
if (::write(get_fd(), blobhead.c_str(), blobhead.size()) < 0) {
throw std::runtime_error("file error");
}
if (::write(get_fd(), data.c_str(), data.size()) < 0) {
throw std::runtime_error("file error");
}
}
/**
* Before a PrimitiveBlock gets serialized, all interim StringTable-ids needs to be
* mapped to the associated real StringTable ids. This is done in this function.
*
* This function needs to know about the concrete structure of all item types to find
* all occurrences of string-ids.
*/
void map_string_ids() {
// test, if the node-block has been allocated
if (pbf_nodes) {
// iterate over all nodes, passing them to the map_common_string_ids function
for (int i=0, l=pbf_nodes->nodes_size(); i<l; i++) {
map_common_string_ids(pbf_nodes->mutable_nodes(i));
}
// test, if the node-block has a densenodes structure
if (pbf_nodes->has_dense()) {
// get a pointer to the densenodes structure
OSMPBF::DenseNodes* dense = pbf_nodes->mutable_dense();
// in the densenodes structure keys and vals are encoded in an intermixed
// array, individual nodes are seperated by a value of 0 (0 in the StringTable
// is always unused). String-ids of 0 are thus kept alone.
for (int i=0, l=dense->keys_vals_size(); i<l; i++) {
// map interim string-ids > 0 to real string ids
uint16_t sid = dense->keys_vals(i);
if (sid > 0) {
dense->set_keys_vals(i, string_table.map_string_id(sid));
}
}
// test if the densenodes block has meta infos
if (dense->has_denseinfo()) {
// get a pointer to the denseinfo structure
OSMPBF::DenseInfo* denseinfo = dense->mutable_denseinfo();
// iterate over all username string-ids
for (int i=0, l= denseinfo->user_sid_size(); i<l; i++) {
// map interim string-ids > 0 to real string ids
uint16_t user_sid = string_table.map_string_id(denseinfo->user_sid(i));
// delta encode the string-id
denseinfo->set_user_sid(i, m_delta_user_sid.update(user_sid));
}
}
}
}
// test, if the ways-block has been allocated
if (pbf_ways) {
// iterate over all ways, passing them to the map_common_string_ids function
for (int i=0, l=pbf_ways->ways_size(); i<l; i++) {
map_common_string_ids(pbf_ways->mutable_ways(i));
}
}
// test, if the relations-block has been allocated
if (pbf_relations) {
// iterate over all relations
for (int i=0, l=pbf_relations->relations_size(); i<l; i++) {
// get a pointer to the relation
OSMPBF::Relation* relation = pbf_relations->mutable_relations(i);
// pass them to the map_common_string_ids function
map_common_string_ids(relation);
// iterate over all relation members, mapping the interim string-ids
// of the role to real string ids
for (int mi=0, ml=relation->roles_sid_size(); mi<ml; mi++) {
relation->set_roles_sid(mi, string_table.map_string_id(relation->roles_sid(mi)));
}
}
}
}
/**
* a helper function used in map_string_ids to map common interim string-ids of the
* user name and all tags to real string ids.
*
* pbf_object_t is either OSMPBF::Node, OSMPBF::Way or OSMPBF::Relation.
*/
template <class pbf_object_t> void map_common_string_ids(pbf_object_t* in) {
// if the object has meta-info attached
if (in->has_info()) {
// map the interim-id of the user name to a real id
OSMPBF::Info* info = in->mutable_info();
info->set_user_sid(string_table.map_string_id(info->user_sid()));
}
// iterate over all tags and map the interim-ids of the key and the value to real ids
for (int i=0, l=in->keys_size(); i<l; i++) {
in->set_keys(i, string_table.map_string_id(in->keys(i)));
in->set_vals(i, string_table.map_string_id(in->vals(i)));
}
}
///// MetaData helper /////
/**
* convert a double lat or lon value to an int, respecting the current blocks granularity
*/
int64_t lonlat2int(double lonlat) {
return round(lonlat * OSMPBF::lonlat_resolution / location_granularity());
}
/**
* convert a timestamp to an int, respecting the current blocks granularity
*/
int64_t timestamp2int(time_t timestamp) {
return round(timestamp * ((double)1000 / date_granularity()));
}
/**
* helper function used in the write()-calls to apply common information from an osmium-object
* onto a pbf-object.
*
* pbf_object_t is either OSMPBF::Node, OSMPBF::Way or OSMPBF::Relation.
*/
template <class pbf_object_t> void apply_common_info(const shared_ptr<Osmium::OSM::Object const>& in, pbf_object_t* out) {
// set the object-id
out->set_id(in->id());
// iterate over all tags and set the keys and vals, recording the strings in the
// interim StringTable and storing the interim ids
Osmium::OSM::TagList::const_iterator end = in->tags().end();
for (Osmium::OSM::TagList::const_iterator it = in->tags().begin(); it != end; ++it) {
out->add_keys(string_table.record_string(it->key()));
out->add_vals(string_table.record_string(it->value()));
}
if (should_add_metadata()) {
// add an info-section to the pbf object and set the meta-info on it
OSMPBF::Info* out_info = out->mutable_info();
if (m_add_visible) {
out_info->set_visible(in->visible());
}
out_info->set_version(in->version());
out_info->set_timestamp(timestamp2int(in->timestamp()));
out_info->set_changeset(in->changeset());
out_info->set_uid(in->uid());
out_info->set_user_sid(string_table.record_string(in->user()));
}
}
///// High-Level Block writing /////
/**
* store the current pbf_header_block into a Blob and clear this struct afterwards.
*/
void store_header_block() {
if (Osmium::debug()) {
std::cerr << "storing header block" << std::endl;
}
store_blob("OSMHeader", pbf_header_block);
pbf_header_block.Clear();
}
/**
* store the interim StringTable to the current pbf_primitive_block, map all interim string ids
* to real StringTable ids and then store the current pbf_primitive_block into a Blob and clear
* this struct and all related pointers and maps afterwards.
*/
void store_primitive_block() {
if (Osmium::debug()) {
std::cerr << "storing primitive block with " << primitive_block_contents << " items" << std::endl;
}
// store the interim StringTable into the protobuf object
string_table.store_stringtable(pbf_primitive_block.mutable_stringtable());
// map all interim string ids to real ids
map_string_ids();
// store the Blob
store_blob("OSMData", pbf_primitive_block);
// clear the PrimitiveBlock struct
pbf_primitive_block.Clear();
// add empty StringTable entry at index 0
// StringTable index 0 is rserved as delimiter in the densenodes key/value list
// this line also ensures that there's always a valid StringTable
pbf_primitive_block.mutable_stringtable()->add_s("");
// set the granularity
pbf_primitive_block.set_granularity(location_granularity());
pbf_primitive_block.set_date_granularity(date_granularity());
// clear the interim StringTable and its id map
string_table.clear();
// reset the delta variables
m_delta_id.clear();
m_delta_lat.clear();
m_delta_lon.clear();
m_delta_timestamp.clear();
m_delta_changeset.clear();
m_delta_uid.clear();
m_delta_user_sid.clear();
// reset the contents-counter to zero
primitive_block_contents = 0;
primitive_block_size = 0;
// reset the node/way/relation pointers to NULL
pbf_nodes = NULL;
pbf_ways = NULL;
pbf_relations = NULL;
}
/**
* this little function checks primitive_block_contents counter against its maximum and calls
* store_primitive_block to flush the block to the disk when it's reached. It's also responsible
* for increasing this counter.
*
* this function also checks the estimated size of the current block and calls store_primitive_block
* when the estimated size reaches buffer_fill_percent of the maximum uncompressed blob size.
*/
void check_block_contents_counter() {
if (primitive_block_contents >= max_block_contents) {
store_primitive_block();
}
else if (primitive_block_size > (static_cast<uint32_t>(OSMPBF::max_uncompressed_blob_size) * buffer_fill_percent / 100)) {
if (Osmium::debug()) {
std::cerr << "storing primitive_block with only " << primitive_block_contents << " items, because its ByteSize (" << primitive_block_size << ") reached " <<
(static_cast<float>(primitive_block_size) / static_cast<float>(OSMPBF::max_uncompressed_blob_size) * 100.0) << "% of the maximum blob-size" << std::endl;
}
store_primitive_block();
}
primitive_block_contents++;
}
///// Block content writing /////
/**
* Add a node to the block.
*
* @param node The node to add.
*/
void write_node(const shared_ptr<Osmium::OSM::Node const>& node) {
// add a way to the group
OSMPBF::Node* pbf_node = pbf_nodes->add_nodes();
// copy the common meta-info from the osmium-object to the pbf-object
apply_common_info(node, pbf_node);
// modify lat & lon to integers, respecting the block's granularity and copy
// the ints to the pbf-object
pbf_node->set_lon(lonlat2int(node->get_lon()));
pbf_node->set_lat(lonlat2int(node->get_lat()));
}
/**
* Add a node to the block using DenseNodes.
*
* @param node The node to add.
*/
void write_dense_node(const shared_ptr<Osmium::OSM::Node const>& node) {
// add a DenseNodes-Section to the PrimitiveGroup
OSMPBF::DenseNodes* dense = pbf_nodes->mutable_dense();
// copy the id, delta encoded
dense->add_id(m_delta_id.update(node->id()));
// copy the longitude, delta encoded
dense->add_lon(m_delta_lon.update(lonlat2int(node->get_lon())));
// copy the latitude, delta encoded
dense->add_lat(m_delta_lat.update(lonlat2int(node->get_lat())));
// in the densenodes structure keys and vals are encoded in an intermixed
// array, individual nodes are seperated by a value of 0 (0 in the StringTable
// is always unused)
// so for three nodes the keys_vals array may look like this: 3 5 2 1 0 0 8 5
// the first node has two tags (3=>5 and 2=>1), the second node has does not
// have any tags and the third node has a single tag (8=>5)
Osmium::OSM::TagList::const_iterator end = node->tags().end();
for (Osmium::OSM::TagList::const_iterator it = node->tags().begin(); it != end; ++it) {
dense->add_keys_vals(string_table.record_string(it->key()));
dense->add_keys_vals(string_table.record_string(it->value()));
}
dense->add_keys_vals(0);
if (should_add_metadata()) {
// add a DenseInfo-Section to the PrimitiveGroup
OSMPBF::DenseInfo* denseinfo = dense->mutable_denseinfo();
denseinfo->add_version(node->version());
if (m_add_visible) {
denseinfo->add_visible(node->visible());
}
// copy the timestamp, delta encoded
denseinfo->add_timestamp(m_delta_timestamp.update(timestamp2int(node->timestamp())));
// copy the changeset, delta encoded
denseinfo->add_changeset(m_delta_changeset.update(node->changeset()));
// copy the user id, delta encoded
denseinfo->add_uid(m_delta_uid.update(node->uid()));
// record the user-name to the interim stringtable and copy the
// interim string-id to the pbf-object
denseinfo->add_user_sid(string_table.record_string(node->user()));
}
}
/**
* Add a way to the block.
*
* @param way The way to add.
*/
void write_way(const shared_ptr<Osmium::OSM::Way const>& way) {
// add a way to the group
OSMPBF::Way* pbf_way = pbf_ways->add_ways();
// copy the common meta-info from the osmium-object to the pbf-object
apply_common_info(way, pbf_way);
// last way-node-id used for delta-encoding
Delta<int64_t> delta_id;
// iterate over all way-nodes
for (int i=0, l = way->node_count(); i<l; i++) {
// copy the way-node-id, delta encoded
pbf_way->add_refs(delta_id.update(way->get_node_id(i)));
}
// count up blob size by the size of the Way
primitive_block_size += pbf_way->ByteSize();
}
/**
* Add a relation to the block.
*
* @param relation The relation to add.
*/
void write_relation(const shared_ptr<Osmium::OSM::Relation const>& relation) {
// add a relation to the group
OSMPBF::Relation* pbf_relation = pbf_relations->add_relations();
// copy the common meta-info from the osmium-object to the pbf-object
apply_common_info(relation, pbf_relation);
Delta<int64_t> delta_id;
// iterate over all relation-members
for (int i=0, l=relation->members().size(); i<l; i++) {
// save a pointer to the osmium-object representing the relation-member
const Osmium::OSM::RelationMember* mem = relation->get_member(i);
// record the relation-member role to the interim stringtable and copy the
// interim string-id to the pbf-object
pbf_relation->add_roles_sid(string_table.record_string(mem->role()));
// copy the relation-member-id, delta encoded
pbf_relation->add_memids(delta_id.update(mem->ref()));
// copy the relation-member-type, mapped to the OSMPBF enum
switch (mem->type()) {
case 'n':
pbf_relation->add_types(OSMPBF::Relation::NODE);
break;
case 'w':
pbf_relation->add_types(OSMPBF::Relation::WAY);
break;
case 'r':
pbf_relation->add_types(OSMPBF::Relation::RELATION);
break;
default:
throw std::runtime_error("Unknown relation member type: " + mem->type());
}
}
// count up blob size by the size of the Relation
primitive_block_size += pbf_relation->ByteSize();
}
public:
/**
* Create PBF output object from OSMFile.
*/
PBF(Osmium::OSMFile& file) : Base(file),
pbf_nodes(NULL),
pbf_ways(NULL),
pbf_relations(NULL),
m_location_granularity(pbf_primitive_block.granularity()),
m_date_granularity(pbf_primitive_block.date_granularity()),
m_use_dense_format(true),
m_use_compression(true),
m_should_add_metadata(true),
m_add_visible(file.has_multiple_object_versions()),
primitive_block_contents(0),
primitive_block_size(0),
string_table(),
m_compression_buffer(),
m_delta_id(),
m_delta_lat(),
m_delta_lon(),
m_delta_timestamp(),
m_delta_changeset(),
m_delta_uid(),
m_delta_user_sid() {
GOOGLE_PROTOBUF_VERIFY_VERSION;
}
/**
* getter to check whether the densenodes-feature is used
*/
bool use_dense_format() const {
return m_use_dense_format;
}
/**
* setter to set whether the densenodes-feature is used
*/
PBF& use_dense_format(bool flag) {
m_use_dense_format = flag;
return *this;
}
/**
* getter to check whether zlib-compression is used
*/
bool use_compression() const {
return m_use_compression;
}
/**
* setter to set whether zlib-compression is used
*/
PBF& use_compression(bool flag) {
m_use_compression = flag;
return *this;
}
/**
* getter to access the granularity
*/
int location_granularity() const {
return m_location_granularity;
}
/**
* setter to set the granularity
*/
PBF& location_granularity(int g) {
m_location_granularity = g;
return *this;
}
/**
* getter to access the date_granularity
*/
int date_granularity() const {
return m_date_granularity;
}
/**
* Set date granularity.
*/
PBF& date_granularity(int g) {
m_date_granularity = g;
return *this;
}
/**
* Getter to check whether metadata should be added.
*/
bool should_add_metadata() const {
return m_should_add_metadata;
}
/**
* Setter to set whether to add metadata.
*/
PBF& should_add_metadata(bool flag) {
m_should_add_metadata = flag;
return *this;
}
/**
* Initialize the writing process.
*
* This initializes the header-block, sets the required-features and
* the writing-program and adds the obligatory StringTable-Index 0.
*/
void init(Osmium::OSM::Meta& meta) {
if (Osmium::debug()) {
std::cerr << "pbf write init" << std::endl;
}
// add the schema version as required feature to the HeaderBlock
pbf_header_block.add_required_features("OsmSchema-V0.6");
// when the densenodes-feature is used, add DenseNodes as required feature
if (use_dense_format()) {
pbf_header_block.add_required_features("DenseNodes");
}
// when the resulting file will carry history information, add
// HistoricalInformation as required feature
if (m_file.get_type() == Osmium::OSMFile::FileType::History()) {
pbf_header_block.add_required_features("HistoricalInformation");
}
// set the writing program
pbf_header_block.set_writingprogram("Osmium (http://wiki.openstreetmap.org/wiki/Osmium)");
if (meta.bounds().defined()) {
OSMPBF::HeaderBBox* bbox = pbf_header_block.mutable_bbox();
bbox->set_left(meta.bounds().bl().lon() * OSMPBF::lonlat_resolution);
bbox->set_bottom(meta.bounds().bl().lat() * OSMPBF::lonlat_resolution);
bbox->set_right(meta.bounds().tr().lon() * OSMPBF::lonlat_resolution);
bbox->set_top(meta.bounds().tr().lat() * OSMPBF::lonlat_resolution);
}
store_header_block();
// add empty StringTable entry at index 0
// StringTable index 0 is reserved as delimiter in the densenodes key/value list
// this line also ensures that there's always a valid StringTable
pbf_primitive_block.mutable_stringtable()->add_s("");
// set the granularity
pbf_primitive_block.set_granularity(location_granularity());
pbf_primitive_block.set_date_granularity(date_granularity());
}
/**
* Add a node to the pbf.
*
* A call to this method won't write the node to the file directly but
* cache it for later bulk-writing. Calling write_final ensures that everything
* gets written and every file pointer is closed.
*/
void node(const shared_ptr<Osmium::OSM::Node const>& node) {
// first of we check the contents-counter which may flush the cached nodes to
// disk if the limit is reached. This call also increases the contents-counter
check_block_contents_counter();
if (Osmium::debug()) {
std::cerr << "node " << node->id() << " v" << node->version() << std::endl;
}
// if no PrimitiveGroup for nodes has been added, add one and save the pointer
if (!pbf_nodes) {
pbf_nodes = pbf_primitive_block.add_primitivegroup();
}
if (use_dense_format()) {
write_dense_node(node);
} else {
write_node(node);
}
}
/**
* Add a way to the pbf.
*
* A call to this method won't write the way to the file directly but
* cache it for later bulk-writing. Calling write_final ensures that everything
* gets written and every file pointer is closed.
*/
void way(const shared_ptr<Osmium::OSM::Way const>& way) {
// first of we check the contents-counter which may flush the cached ways to
// disk if the limit is reached. This call also increases the contents-counter
check_block_contents_counter();
if (Osmium::debug()) {
std::cerr << "way " << way->id() << " v" << way->version() << " with " << way->node_count() << " nodes" << std::endl;
}
// if no PrimitiveGroup for nodes has been added, add one and save the pointer
if (!pbf_ways) {
pbf_ways = pbf_primitive_block.add_primitivegroup();
}
write_way(way);
}
/**
* Add a relation to the pbf.
*
* A call to this method won't write the way to the file directly but
* cache it for later bulk-writing. Calling write_final ensures that everything
* gets written and every file pointer is closed.
*/
void relation(const shared_ptr<Osmium::OSM::Relation const>& relation) {
// first of we check the contents-counter which may flush the cached relations to
// disk if the limit is reached. This call also increases the contents-counter
check_block_contents_counter();
if (Osmium::debug()) {
std::cerr << "relation " << relation->id() << " v" << relation->version() << " with " << relation->members().size() << " members" << std::endl;
}
// if no PrimitiveGroup for relations has been added, add one and save the pointer
if (!pbf_relations) {
pbf_relations = pbf_primitive_block.add_primitivegroup();
}
write_relation(relation);
}
/**
* Finalize the writing process, flush any open primitive blocks to the file and
* close the file.
*/
void final() {
if (Osmium::debug()) {
std::cerr << "finishing" << std::endl;
}
// if the current block contains any elements, flush it to the protobuf
if (primitive_block_contents > 0) {
store_primitive_block();
}
m_file.close();
}
}; // class PBF
} // namespace Output
} // namespace Osmium
#endif // OSMIUM_OUTPUT_PBF_HPP
|