syntax = "proto2";

option java_package = "com.osm";
package osmpbf;

message HeaderBlock {
  optional HeaderBBox bbox = 1;

  /* Additional tags to aid in parsing this dataset */
  repeated string required_features = 4;
  repeated string optional_features = 5;

  optional string writingprogram = 16;
  optional string source = 17; // From the bbox field.

  /* Tags that allow continuing an Osmosis replication */

  // Replication timestamp, expressed in seconds since the epoch,
  // otherwise the same value as in the "timestamp=..." field
  // in the state.txt file used by Osmosis.
  optional int64 osmosis_replication_timestamp = 32;

  // Replication sequence number (sequenceNumber in state.txt).
  optional int64 osmosis_replication_sequence_number = 33;

  // Replication base URL (from Osmosis' configuration.txt file).
  optional string osmosis_replication_base_url = 34;
}

message HeaderBBox {
  required sint64 left = 1;
  required sint64 right = 2;
  required sint64 top = 3;
  required sint64 bottom = 4;
}

message PrimitiveBlock {
  required StringTable stringtable = 1;
  repeated PrimitiveGroup primitivegroup = 2;

  // Granularity, units of nanodegrees, used to store coordinates in this block.
  optional int32 granularity = 17 [default = 100];

  // Offset value between the output coordinates and the granularity grid in units of nanodegrees.
  optional int64 lat_offset = 19 [default = 0];
  optional int64 lon_offset = 20 [default = 0];

  // Granularity of dates, normally represented in units of milliseconds since the 1970 epoch.
  optional int32 date_granularity = 18 [default = 1000];
}

// Group of OSMPrimitives. All primitives in a group must be the same type.
message PrimitiveGroup {
  repeated Node nodes = 1;
  optional DenseNodes dense = 2;
  repeated Way ways = 3;
  repeated Relation relations = 4;
  repeated ChangeSet changesets = 5;
}

message StringTable {
  repeated bytes s = 1;
}

/* Optional metadata that may be included into each primitive. */
message Info {
  optional int32 version = 1 [default = -1];
  optional int64 timestamp = 2;
  optional int64 changeset = 3;
  optional int32 uid = 4;
  optional uint32 user_sid = 5; // String IDs

  // The visible flag is used to store history information. It indicates that
  // the current object version has been created by a delete operation on the
  // OSM API.
  // When a writer sets this flag, it MUST add a required_features tag with
  // value "HistoricalInformation" to the HeaderBlock.
  // If this flag is not available for some object it MUST be assumed to be
  // true if the file has the required_features tag "HistoricalInformation"
  // set.
  optional bool visible = 6;
}

/** Optional metadata that may be included into each primitive. Special dense format used in DenseNodes. */
message DenseInfo {
  repeated int32 version = 1 [packed = true];
  repeated sint64 timestamp = 2 [packed = true]; // DELTA coded
  repeated sint64 changeset = 3 [packed = true]; // DELTA coded
  repeated sint32 uid = 4 [packed = true]; // DELTA coded
  repeated sint32 user_sid = 5 [packed = true]; // String IDs for usernames. DELTA coded

  // The visible flag is used to store history information. It indicates that
  // the current object version has been created by a delete operation on the
  // OSM API.
  // When a writer sets this flag, it MUST add a required_features tag with
  // value "HistoricalInformation" to the HeaderBlock.
  // If this flag is not available for some object it MUST be assumed to be
  // true if the file has the required_features tag "HistoricalInformation"
  // set.
  repeated bool visible = 6 [packed = true];
}

// This is kept for backwards compatibility but not used anywhere.
message ChangeSet {
  required int64 id = 1;
}

message Node {
  required sint64 id = 1;

  // Parallel arrays.
  repeated uint32 keys = 2 [packed = true]; // String IDs.
  repeated uint32 vals = 3 [packed = true]; // String IDs.

  optional Info info = 4; // May be omitted in omitmeta

  required sint64 lat = 8;
  required sint64 lon = 9;
}

message DenseNodes {
  repeated sint64 id = 1 [packed = true]; // DELTA coded

  optional DenseInfo denseinfo = 5;

  repeated sint64 lat = 8 [packed = true]; // DELTA coded
  repeated sint64 lon = 9 [packed = true]; // DELTA coded

  // Special packing of keys and vals into one array. May be empty if all nodes in this block are tagless.
  repeated int32 keys_vals = 10 [packed = true];
}

message Way {
  required int64 id = 1;

  // Parallel arrays.
  repeated uint32 keys = 2 [packed = true];
  repeated uint32 vals = 3 [packed = true];

  optional Info info = 4;

  repeated sint64 refs = 8 [packed = true]; // DELTA coded

  // The following two fields are optional. They are only used in a special
  // format where node locations are also added to the ways. This makes the
  // files larger, but allows creating way geometries directly.
  //
  // If this is used, you MUST set the optional_features tag "LocationsOnWays"
  // and the number of values in refs, lat, and lon MUST be the same.
  repeated sint64 lat = 9 [packed = true]; // DELTA coded, optional
  repeated sint64 lon = 10 [packed = true]; // DELTA coded, optional
}

message Relation {
  enum MemberType {
    NODE = 0;
    WAY = 1;
    RELATION = 2;
  }

  required int64 id = 1;

  // Parallel arrays.
  repeated uint32 keys = 2 [packed = true];
  repeated uint32 vals = 3 [packed = true];

  optional Info info = 4;

  // Parallel arrays
  repeated int32 roles_sid = 8 [packed = true]; // This should have been defined as uint32 for consistency, but it is now too late to change it
  repeated sint64 memids = 9 [packed = true]; // DELTA encoded
  repeated MemberType types = 10 [packed = true];
}