diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e72bfdd --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/README.adoc b/README.adoc index 5405bb4..b97e8a0 100644 --- a/README.adoc +++ b/README.adoc @@ -1,16 +1,16 @@ -= Cyface Protocol Buffer Messages += Cyface Protobuf Messages This repository defines the Cyface Models as schemas such as Protocol Buffer Schemas. This allows to de-/serialize the Cyface Binary Data from in different programming languages. -For more details on Protocol Buffers (short: Protobuf) check out it's link:https://developers.google.com/protocol-buffers[documentation]. +For more details on Protocol Buffers (short: Protobuf) check out its link:https://developers.google.com/protocol-buffers[documentation]. == Message Format Definitions This is a collection of `.proto` files describe the data structure of the Cyface Models. -- This allows Protobuf to automatically de-/encode the the data from/to binary files. +- This allows Protobuf to automatically de-/encode the data from/to binary files. - Supports later extensions of the format with backward-compatibility - Following the link:https://developers.google.com/protocol-buffers/docs/style[Style Guide] @@ -30,7 +30,7 @@ Reminders from the documentation which need to be considered for future updates: - link:https://developers.google.com/protocol-buffers/docs/proto3#default[Default values] - - Scalar message fields, once parsed, cannot tell if a field was not set or set the the default value afterwards. + - Scalar message fields, once parsed, cannot tell if a field was not set or set the default value afterwards. - Default values are not serialized on the wire. - Keep this in mind when defining e.g. booleans, make sure you want that "default" `false` behavior on. @@ -47,7 +47,7 @@ Other message types: Generates serializer, deserializer, etc. in a chosen language, e.g. `.java` files for Java. -Java classes can be compiled with link:https://developers.google.com/protocol-buffers/docs/javatutorial#compiling-your-protocol-buffers[protoc] (Protocol Buffers `v3.17.0`): +Java classes can be compiled with link:https://developers.google.com/protocol-buffers/docs/javatutorial#compiling-your-protocol-buffers[protoc] (Protocol Buffers, version: see `protobufVersion` in `build.gradle`): protoc --java_out=./src/main/java/ src/main/protos/de/cyface/protos/model/measurement.proto @@ -62,13 +62,13 @@ However, the pre-compiled `JARs` are also published to the link:https://github.c Or you can download the `proto` link:protoc --java_out=./src/main/java/ src/main/protos/de/cyface/protos/model/measurement.proto[files] from this repository and then generate the classes using the link:https://github.com/google/protobuf-gradle-plugin[Gradle Plugin]. This is done in the link:https://github.com/cyface-de/android-backend[Cyface Android SDK] - check it out if you need an example. -The serializers encode the data in an efficient way, the decision process is documented link:https://cyface.atlassian.net/wiki/spaces/IM/pages/1535148033/Datenformat+bertragungsprotokoll+2021[internally]. +The serializers encode the data in an efficient way, the decision process is documented link:https://cyface.atlassian.net/wiki/spaces/IM/pages/1535148033/Datenformat+bertragungsprotokoll+API+V3[internally]. == Using the generated Code ____ -Protocol Buffers and Object Oriented Design Protocol buffer classes are basically dumb data holders (like structs in C); they don't make good first class citizens in an object model. If you want to add richer behavior to a generated class, the best way to do this is to wrap the generated protocol buffer class in an application-specific class. +Protocol Buffers and Object-Oriented Design Protocol buffer classes are basically dumb data holders (like structs in C); they don't make good first class citizens in an object model. If you want to add richer behavior to a generated class, the best way to do this is to wrap the generated protocol buffer class in an application-specific class. ____ link:https://developers.google.com/protocol-buffers/docs/javatutorial#builders[Source] @@ -76,6 +76,19 @@ link:https://developers.google.com/protocol-buffers/docs/javatutorial#builders[S [#_licensing] == Licensing -Copyright (C) 2021 Cyface GmbH - All Rights Reserved -Unauthorized copying of this file, via any medium is strictly prohibited -Proprietary and confidential +Copyright 2021-2022 Cyface GmbH + +This file is part of the Cyface Protobuf Messages. + +The Cyface Protobuf Messages is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +The Cyface Protobuf Messages 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with the Cyface Protobuf Messages. If not, see http://www.gnu.org/licenses/. diff --git a/build.gradle b/build.gradle index 34dc65c..a6e6f50 100644 --- a/build.gradle +++ b/build.gradle @@ -1,26 +1,26 @@ /* - * Copyright 2021 Cyface GmbH + * Copyright 2021-2022 Cyface GmbH * - * This file is part of the Cyface Protocol Buffer Messages. + * This file is part of the Cyface Protobuf Messages. * - * The Cyface Protocol Buffer Messages is free software: you can redistribute it and/or modify + * The Cyface Protobuf Messages is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * The Cyface Protocol Buffer Messages is distributed in the hope that it will be useful, + * The Cyface Protobuf Messages 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 General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with the Cyface Protocol Buffer Messages. If not, see . + * along with the Cyface Protobuf Messages. If not, see . */ /** * The root build gradle file. * * @author Armin Schnabel - * @version 1.0.0 + * @version 1.0.1 * @since 1.0.0 */ buildscript { @@ -35,12 +35,12 @@ plugins { id 'idea' id 'maven-publish' //noinspection SpellCheckingInspection - id 'com.github.johnrengelman.shadow' version '6.1.0' - id 'com.google.protobuf' version '0.8.16' + id 'com.github.johnrengelman.shadow' version '7.1.2' + id 'com.google.protobuf' version '0.8.18' } group = 'de.cyface' -version = '1.0.0' +version = '2.0.0' tasks.withType(JavaCompile) { options.encoding = 'UTF-8' @@ -51,14 +51,13 @@ tasks.withType(JavaCompile) { ext { commonsLangVersion = '3.12.0' - gradleWrapperVersion = '6.8.3' - protobufVersion = '3.17.0' + gradleWrapperVersion = '7.4.2' + protobufVersion = '3.21.1' // Versions of testing dependencies - junitVersion = '5.7.0' - mockitoVersion = '3.3.3' + junitVersion = '5.8.2' + mockitoVersion = '4.6.0' hamcrestVersion = '2.2' - flapdoodleVersion = '3.0.0' } wrapper { diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index e708b1c..41d9927 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 442d913..aa991fc 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index 4f906e0..1b6c787 100755 --- a/gradlew +++ b/gradlew @@ -1,7 +1,7 @@ -#!/usr/bin/env sh +#!/bin/sh # -# Copyright 2015 the original author or authors. +# Copyright © 2015-2021 the original authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -17,67 +17,101 @@ # ############################################################################## -## -## Gradle start up script for UN*X -## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# ############################################################################## # Attempt to set APP_HOME + # Resolve links: $0 may be a link -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac done -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` +APP_BASE_NAME=${0##*/} # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' # Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" +MAX_FD=maximum warn () { echo "$*" -} +} >&2 die () { echo echo "$*" echo exit 1 -} +} >&2 # OS specific support (must be 'true' or 'false'). cygwin=false msys=false darwin=false nonstop=false -case "`uname`" in - CYGWIN* ) - cygwin=true - ;; - Darwin* ) - darwin=true - ;; - MINGW* ) - msys=true - ;; - NONSTOP* ) - nonstop=true - ;; +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; esac CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar @@ -87,9 +121,9 @@ CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then # IBM's JDK on AIX uses strange locations for the executables - JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -98,7 +132,7 @@ Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else - JAVACMD="java" + JAVACMD=java which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. Please set the JAVA_HOME variable in your environment to match the @@ -106,80 +140,95 @@ location of your Java installation." fi # Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac fi -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -fi +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. # For Cygwin or MSYS, switch paths to Windows format before running java -if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - - JAVACMD=`cygpath --unix "$JAVACMD"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + # Now convert the arguments - kludge to limit ourselves to /bin/sh - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) fi - i=`expr $i + 1` + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg done - case $i in - 0) set -- ;; - 1) set -- "$args0" ;; - 2) set -- "$args0" "$args1" ;; - 3) set -- "$args0" "$args1" "$args2" ;; - 4) set -- "$args0" "$args1" "$args2" "$args3" ;; - 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; - esac fi -# Escape application args -save () { - for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done - echo " " -} -APP_ARGS=`save "$@"` +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# -# Collect all arguments for the java command, following the shell quoting and substitution rules -eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' exec "$JAVACMD" "$@" diff --git a/settings.gradle b/settings.gradle index 0426832..f9e8bf0 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,20 +1,20 @@ /* - * Copyright 2021 Cyface GmbH + * Copyright 2021-2022 Cyface GmbH * - * This file is part of the Cyface Protocol Buffer Messages. + * This file is part of the Cyface Protobuf Messages. * - * The Cyface Protocol Buffer Messages is free software: you can redistribute it and/or modify + * The Cyface Protobuf Messages is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * The Cyface Protocol Buffer Messages is distributed in the hope that it will be useful, + * The Cyface Protobuf Messages 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 General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with the Cyface Protocol Buffer Messages. If not, see . + * along with the Cyface Protobuf Messages. If not, see . */ //noinspection SpellCheckingInspection diff --git a/src/main/proto/de/cyface/protos/model/measurement.proto b/src/main/proto/de/cyface/protos/model/measurement.proto index fb23ce6..dfa88f5 100644 --- a/src/main/proto/de/cyface/protos/model/measurement.proto +++ b/src/main/proto/de/cyface/protos/model/measurement.proto @@ -1,8 +1,20 @@ /* - * Copyright (C) 2021 Cyface GmbH - All Rights Reserved + * Copyright 2021-2022 Cyface GmbH * - * Unauthorized copying of this file, via any medium is strictly prohibited - * Proprietary and confidential + * This file is part of the Cyface Protobuf Messages. + * + * The Cyface Protobuf Messages is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * The Cyface Protobuf Messages 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with the Cyface Protobuf Messages. If not, see . */ syntax = "proto3"; @@ -34,19 +46,17 @@ option java_multiple_files = true; * - The following fields are not repeating: formatVersion, locationsRecords, accelerations/r./d., capturingLog * - The following fields are expected less than 10 Hz: events, images, videos * - * author Armin Schnabel - * Version 1.0.0 + * @author Armin Schnabel + * @version 2.0.0 + * @since 1.0.0 */ message Measurement { /* * The API version of this `Measurement` message format. Messages with the same API-version are compatible. * - * Using `32bit` as we expect the version to be and within the range of an `integer`. - * - * The value is encoded in the `uint` ProtoBuf format as we expect the version to be positive. - * Negative numbers are supported but encoded inefficiently in `uint` this data type, compared to `sint`. + * Using `uint32` as this is the smallest number type in Protobuf and we expect the versions to be between 0 and 2^32. * - * The current format API version is `2`. + * The current format API version is `3`. */ uint32 format_version = 16; @@ -100,19 +110,26 @@ message Measurement { /* * This is a modified version of the message `Measurement` which allows to inject bytes from sensor data. - * This allows the Android SDK synchronization to merge the captured sensor data without parsing it. + * This allows the Android and iOS SDK synchronization to merge the captured sensor data without parsing it. + * Sample code: github.com/cyface-de/android-backend > ProtoTest > testMergeData() * - * The only change which was made is replacing the data type of the sensor data fields with `bytes`. + * The difference to the `Measurement` message is the data type of the sensor data fields (here: `bytes`). * * ATTENTION: Make sure this message is always compatible to the `Measurement` message! */ message MeasurementBytes { /* - * The current format of the binary format version is `2` + * The API version of this `Measurement` message format. Messages with the same API-version are compatible. + * + * Using `uint32` as this is the smallest number type in Protobuf and we expect the version to be between 0 and 2^32. + * + * The current format API version is `3`. */ uint32 format_version = 16; /* * Collection of geo-locations. + * + * We use a packed encoding here, so this is a non repeated field. */ LocationRecords location_records = 17; /* @@ -129,18 +146,27 @@ message MeasurementBytes { bytes directions_binary = 20; /* * Collection of events. + * + * We use `repeated` as we don't expect as many events as e.g. sensor points. + * If we decide to store high-frequent events later on we can use a field number < 16 which only requires 1 Byte. */ repeated Event events = 21; /* - * The image files are usually of FileType `JPG` (compressed) or `DNG` (raw). + * The image files, optionally collected during a measurement. Usually FileType `JPG` (compressed) or `DNG` (raw). + * + * We expect a similar image rates of 1 Hz or less, so a 2-Byte field number was chosen. + * + * The image size is kilo- or megabytes and, thus, field number encoding size is only a small fraction so `repeated` was chosen. */ repeated File images = 22; /* - * The video files are usually of FileType `MP4`. + * The video files, optionally collected during a measurement. Usually FileType `MP4`. + * + * When a measurement is paused and resumed, multiple video files are collected per measurement - thus, `repeated`. */ repeated File videos = 23; /* - * This field allows to attach this file which is usually a of FileType `CSV`. + * Log file which is optionally captured during images capturing. Usually FileType `CSV`. */ File capturing_log = 24; } @@ -149,6 +175,13 @@ message MeasurementBytes { * A message type which wraps the `Accelerations` batches captured in a `cyfa` file of a measurement. * * This allows to inject the bytes from a `cyfa` file on the client without parsing the data [DAT-642]. + * + * In case of creating a `cyfa` sensor data file by appending the bytes of one batch at a time (instead of + * just writing all batches at once), wrap each `Accelerations` batch with `AccelerationsBinary` by itself + * before appending the batch to the `cyfa` binary. This is sort of counter intuitive but ensures that the `Measurement` + * and `MeasurementBytes` messages are compatible. For further details see DAT-642 and the internal documentation on + * the Confluence page about the new data format and transmission protocol in the section about the binary code. + * Sample code see: github.com/cyface-de/serialization > Point3DSerializer > serialize() */ message AccelerationsBinary { /* @@ -160,9 +193,16 @@ message AccelerationsBinary { } /* - * A message type which wraps the `Accelerations` batches captured in a `cyfa` file of a measurement. + * A message type which wraps the `Rotations` batches captured in a `cyfr` file of a measurement. * - * This allows to inject the bytes from a `cyfa` file on the client without parsing the data [DAT-642]. + * This allows to inject the bytes from a `cyfr` file on the client without parsing the data [DAT-642]. + * + * In case of creating a `cyfr` sensor data file by appending the bytes of one batch at a time (instead of + * just writing all batches at once), wrap each `Rotations` batch with `RotationsBinary` by itself + * before appending the batch to the `cyfr` binary. This is sort of counter intuitive but ensures that the `Measurement` + * and `MeasurementBytes` messages are compatible. For further details see DAT-642 and the internal documentation on + * the Confluence page about the new data format and transmission protocol in the section about the binary code. + * Sample code see: github.com/cyface-de/serialization > Point3DSerializer > serialize() */ message RotationsBinary { /* @@ -174,9 +214,16 @@ message RotationsBinary { } /* - * A message type which wraps the `Accelerations` batches captured in a `cyfa` file of a measurement. + * A message type which wraps the `Directions` batches captured in a `cyfd` file of a measurement. * - * This allows to inject the bytes from a `cyfa` file on the client without parsing the data [DAT-642]. + * This allows to inject the bytes from a `cyfd` file on the client without parsing the data [DAT-642]. + * + * In case of creating a `cyfd` sensor data file by appending the bytes of one batch at a time (instead of + * just writing all batches at once), wrap each `Directions` batch with `DirectionsBinary` by itself + * before appending the batch to the `cyfd` binary. This is sort of counter intuitive but ensures that the `Measurement` + * and `MeasurementBytes` messages are compatible. For further details see DAT-642 and the internal documentation on + * the Confluence page about the new data format and transmission protocol in the section about the binary code. + * Sample code see: github.com/cyface-de/serialization > Point3DSerializer > serialize() */ message DirectionsBinary { /* @@ -211,37 +258,40 @@ message DirectionsBinary { message LocationRecords { /* * A Unix timestamp in milliseconds, in the offset/diff format. E.g.: 1234567890123,1000,1000,1000. + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * * Using `64bit` as the first timestamp is absolute and in milliseconds since 1970 and, thus, not an `integer`. * - * The value is encoded in the `uint` ProtoBuf format as we expect the timestamps to be in order (ascending). - * Negative numbers are supported but encoded inefficiently in `uint` this data type, compared to `sint`. + * The value is encoded in the `sint` ProtoBuf format to support cases where data points are collected in random order. + * Negative numbers are encoded more efficiently in this data type, compared to `int`. */ - repeated uint64 timestamp = 1; + repeated sint64 timestamp = 1; /* - * The coordinate-part, in the offset/diff format. E.g.: 51.012345,51.012300 => 51_012345,-45 + * The coordinate-part, in the offset/diff format. E.g.: 51.012345,51.012300,51.012301 => 51_012345,-45,1 + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * * Using `32bit` as the maximum value is the diff between -180 and +180 which is: 360_000_000 and within `integer` range. * * The value is encoded in the `sint` ProtoBuf format as the latitude can as likely decrease as increase (diff-format). - * Negative numbers are encoded more efficiently in this data type, compared to `uint`. + * Negative numbers are encoded more efficiently in this data type, compared to `int`. */ repeated sint32 latitude = 2; /* - * The coordinate-part, in the offset/diff format. E.g.: 13.012300,13.012345 => 13_012300,45 + * The coordinate-part, in the offset/diff format. E.g.: 13.012300,13.012345,13.012344 => 13_012300,45,-1 + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * * Using `32bit` as the maximum value is the diff between -90 and +90 which is: 180_000_000 and within `integer` range. * * The value is encoded in the `sint` ProtoBuf format as the longitude can as likely decrease as increase (diff-format). - * Negative numbers are encoded more efficiently in this data type, compared to `uint`. + * Negative numbers are encoded more efficiently in this data type, compared to `int`. */ repeated sint32 longitude = 3; @@ -266,6 +316,7 @@ message LocationRecords { message Elevation { /* * Elevation in cm above sea level, in the offset/diff format. E.g.: 480.0m, 481.0m, 480.5m => 480_00cm, 100cm, -50cm + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * @@ -273,7 +324,7 @@ message LocationRecords { * and the dead sea is ~ [8848m;-414m] so we should be good when teleporting between dry and comfy places on earth for a while. * * The value is encoded in the `sint` ProtoBuf format as the longitude can as likely decrease as increase (diff-format). - * Negative numbers are encoded more efficiently in this data type, compared to `uint`. + * Negative numbers are encoded more efficiently in this data type, compared to `int`. */ sint32 value = 1; @@ -286,14 +337,15 @@ message LocationRecords { } /* - * Accuracy in cm (absolute value must be >= 0), in the offset/diff format. E.g.: 13.0m, 12.5m => 13_00cm, -50cm + * Accuracy in cm (absolute value must be >= 0), in the offset/diff format. E.g.: 13.0,12.5,12.0[m] => 13_00cm,-50cm,-50cm + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * * Using `32bit` i.e. we support a diff value up to ~2*10^9 cm which is ~ 20.000 km. * * The value is encoded in the `sint` ProtoBuf format as the longitude can as likely decrease as increase (diff-format). - * Negative numbers are encoded more efficiently in this data type, compared to `uint`. + * Negative numbers are encoded more efficiently in this data type, compared to `int`. * * The likelihood of that accuracy to be correct is not stored as not all platforms provide this or provide this in different format. * For some platform this is static, i.e. we can retrieve this information from the osVersion/osType field. @@ -302,6 +354,7 @@ message LocationRecords { /* * Speed in cm/s (absolute value should be >= 0), in the offset/diff format. E.g.: 11.0m/s, 10.5m/s => 11_00 cm/s, -50cm/s + * I.e. the first absolute number and for all following numbers the difference to the previous number. * However, some platforms (Samsung?) recorded negative absolute speed values in the past. This is supported by the format. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. @@ -310,7 +363,7 @@ message LocationRecords { * As we capture the speed relative to the earth's rotation, we should be covering all manned aircraft, but not spacecrafts. * * The value is encoded in the `sint` ProtoBuf format as the longitude can as likely decrease as increase (diff-format). - * Negative numbers are encoded more efficiently in this data type, compared to `uint`. + * Negative numbers are encoded more efficiently in this data type, compared to `int`. */ repeated sint32 speed = 6; } @@ -332,19 +385,21 @@ message LocationRecords { message Accelerations { /* * A Unix timestamp in milliseconds, in the offset/diff format. E.g.: 1234567890123,1000,1000,1000. + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * * Using `64bit` as the first timestamp is absolute and in milliseconds since 1970 and, thus, not an `integer`. * - * The value is encoded in the `uint` ProtoBuf format as we expect the timestamps to be in order (ascending). - * Negative numbers are supported but encoded inefficiently in `uint` this data type, compared to `sint`. + * The value is encoded in the `sint` ProtoBuf format to support cases where data points are collected in random order. + * Negative numbers are encoded more efficiently in this data type, compared to `int`. */ - repeated uint64 timestamp = 1; + repeated sint64 timestamp = 1; /* * Acceleration value of one axis in mm/s^2, in the offset/diff format. E.g.: - * Absolute numbers: -9, 359, -4_820 => Offset-format: -9, +359, -5_179 + * Absolute numbers: -9, 359, -4_820 => Offset-format: -9, +368, -5_179 + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * @@ -357,7 +412,8 @@ message Accelerations { repeated sint32 x = 2; /* * Acceleration value of one axis in mm/s^2, in the offset/diff format. E.g.: - * Absolute numbers: -9, 359, -4_820 => Offset-format: -9, +359, -5_179 + * Absolute numbers: -9, 359, -4_820 => Offset-format: -9, +368, -5_179 + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * @@ -370,7 +426,8 @@ message Accelerations { repeated sint32 y = 3; /* * Acceleration value of one axis in mm/s^2, in the offset/diff format. E.g.: - * Absolute numbers: -9, 359, -4_820 => Offset-format: -9, +359, -5_179 + * Absolute numbers: -9, 359, -4_820 => Offset-format: -9, +368, -5_179 + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * @@ -401,19 +458,21 @@ message Accelerations { message Rotations { /* * A Unix timestamp in milliseconds, in the offset/diff format. E.g.: 1234567890123,1000,1000,1000. + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * * Using `64bit` as the first timestamp is absolute and in milliseconds since 1970 and, thus, not an `integer`. * - * The value is encoded in the `uint` ProtoBuf format as we expect the timestamps to be in order (ascending). - * Negative numbers are supported but encoded inefficiently in `uint` this data type, compared to `sint`. + * The value is encoded in the `sint` ProtoBuf format to support cases where data points are collected in random order. + * Negative numbers are encoded more efficiently in this data type, compared to `int`. */ - repeated uint64 timestamp = 1; + repeated sint64 timestamp = 1; /* * Rotation value of one axis in rad/1000s, in the offset/diff format. E.g.: * Absolute values: 83, -51, 4.367 => Offset-format: 83, -134, 4_418 + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * @@ -427,6 +486,7 @@ message Rotations { /* * Rotation value of one axis in rad/1000s, in the offset/diff format. E.g.: * Absolute values: 83, -51, 4.367 => Offset-format: 83, -134, 4_418 + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * @@ -440,6 +500,7 @@ message Rotations { /* * Rotation value of one axis in rad/1000s, in the offset/diff format. E.g.: * Absolute values: 83, -51, 4.367 => Offset-format: 83, -134, 4_418 + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * @@ -468,19 +529,21 @@ message Rotations { message Directions { /* * A Unix timestamp in milliseconds, in the offset/diff format. E.g.: 1234567890123,1000,1000,1000. + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * * Using `64bit` as the first timestamp is absolute and in milliseconds since 1970 and, thus, not an `integer`. * - * The value is encoded in the `uint` ProtoBuf format as we expect the timestamps to be in order (ascending). - * Negative numbers are supported but encoded inefficiently in `uint` this data type, compared to `sint`. + * The value is encoded in the `sint` ProtoBuf format to support cases where data points are collected in random order. + * Negative numbers are encoded more efficiently in this data type, compared to `int`. */ - repeated uint64 timestamp = 1; + repeated sint64 timestamp = 1; /* * Direction value of one axis in µT/100, in the offset/diff format. E.g.: * Absolute values: 67, -141, 42 => Offset-format: 67, -208, 183 + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * @@ -497,6 +560,7 @@ message Directions { /* * Direction value of one axis in µT/100, in the offset/diff format. E.g.: * Absolute values: 67, -141, 42 => Offset-format: 67, -208, 183 + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * @@ -513,6 +577,7 @@ message Directions { /* * Direction value of one axis in µT/100, in the offset/diff format. E.g.: * Absolute values: 67, -141, 42 => Offset-format: 67, -208, 183 + * I.e. the first absolute number and for all following numbers the difference to the previous number. * * The offset/diff format encodes the data more efficiently, as the `varint` encoding is used. * @@ -544,8 +609,7 @@ message Event { * * Using `64bit` as the timestamp is absolute and in milliseconds since 1970 and, thus, not in the `integer` range. * - * The value is encoded in the `uint` ProtoBuf format as we don't expect negative timestamps. - * Negative numbers are supported but encoded inefficiently in `uint` this data type, compared to `sint`. + * The value is encoded in the `uint` ProtoBuf format as we don't expect (and support) negative absolute timestamps. */ uint64 timestamp = 1; @@ -616,8 +680,7 @@ message File { * * Using `64bit` as the timestamp is absolute and in milliseconds since 1970 and, thus, not in the `integer` range. * - * The value is encoded in the `uint` ProtoBuf format as we don't expect negative timestamps. - * Negative numbers are supported but encoded inefficiently in `uint` this data type, compared to `sint`. + * The value is encoded in the `uint` ProtoBuf format as we don't expect (and support) negative absolute timestamps. */ uint64 timestamp = 16; diff --git a/src/test/java/de/cyface/protos/model/MeasurementOrBuilderTest.java b/src/test/java/de/cyface/protos/model/MeasurementOrBuilderTest.java index cddbaee..79b2fcf 100644 --- a/src/test/java/de/cyface/protos/model/MeasurementOrBuilderTest.java +++ b/src/test/java/de/cyface/protos/model/MeasurementOrBuilderTest.java @@ -1,8 +1,20 @@ /* - * Copyright (C) 2021 Cyface GmbH - All Rights Reserved + * Copyright 2021-2022 Cyface GmbH * - * Unauthorized copying of this file, via any medium is strictly prohibited - * Proprietary and confidential + * This file is part of the Cyface Protobuf Messages. + * + * The Cyface Protobuf Messages is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * The Cyface Protobuf Messages 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with the Cyface Protobuf Messages. If not, see . */ package de.cyface.protos.model;