├── .gitignore ├── Cargo.toml ├── README.md ├── doc └── LICENSE.txt ├── examples ├── receive.rs └── send.rs └── src ├── broadcaster.rs ├── data.rs ├── lib.rs ├── receiver.rs ├── sender.rs └── util.rs /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by https://www.gitignore.io 2 | 3 | ### Rust ### 4 | # Compiled files 5 | *.o 6 | *.so 7 | *.rlib 8 | *.dll 9 | 10 | # Executables 11 | *.exe 12 | 13 | # Generated by Cargo 14 | /target/ 15 | 16 | #Ignored by Rust libraries 17 | Cargo.lock*.swp 18 | *.swp 19 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [project] 2 | name = "osc" 3 | version = "0.1.0" 4 | authors = [ "general.electrix@gmail.com" ] 5 | 6 | [lib] 7 | name = "osc" 8 | 9 | [dependencies] 10 | byteorder = "~0.4.2" 11 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | *This repository is no longer maintained. I'd recommend rosc instead, available on crates.io and at https://github.com/klingtnet/rosc . It provides more extensive support for the full OSC spec and is pretty much identical in implementation as this package in all important respects.* 2 | 3 | rust-osc 4 | ======== 5 | 6 | Library for sending and receiving OSC 1.0 streams over UDP. At the moment I have 7 | no plans for adding support for OSC 1.1 payloads, but there is already some skeleton 8 | support for them commented out in this code. This implementation leverages Rust's 9 | ADT for representing all the different classes of Osc arguments and messages as 10 | two enum types with variants. 11 | 12 | This was compiled and tested under Rust 1.6 stable as of February 2016. 13 | 14 | To compile the examples, compile src/osc-lib.rs into a library and tell the compiler 15 | to link to it. 16 | osc_sender_test.rs sends test data to the local host on port 7009, and 17 | osc_receiver_test.rs listens to that port to receive. Run the receiver in one 18 | shell session and then run the sender in another to verify everything works. 19 | 20 | This program is free software: you can redistribute it and/or modify 21 | it under the terms of the GNU General Public License as published by 22 | the Free Software Foundation, either version 3 of the License, or 23 | (at your option) any later version. 24 | 25 | This program is distributed in the hope that it will be useful, 26 | but WITHOUT ANY WARRANTY; without even the implied warranty of 27 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 28 | GNU General Public License for more details. 29 | 30 | You should have received a copy of the GNU General Public License 31 | along with this program. If not, see . 32 | 33 | (See doc/LICENSE.txt for a copy of the GPLv3.) 34 | -------------------------------------------------------------------------------- /doc/LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /examples/receive.rs: -------------------------------------------------------------------------------- 1 | extern crate osc; 2 | 3 | use osc::receiver::*; 4 | 5 | fn main() { 6 | 7 | let addr = "localhost:7009"; 8 | 9 | let receiver = OscReceiver::new(addr).unwrap(); 10 | 11 | loop { 12 | 13 | println!("trying to receive"); 14 | 15 | match receiver.recv(None) { 16 | Ok(o) => println!("contents: {:?}",o), 17 | Err(e) => println!("Error: {:?}", e) 18 | } 19 | 20 | } 21 | 22 | } 23 | -------------------------------------------------------------------------------- /examples/send.rs: -------------------------------------------------------------------------------- 1 | extern crate osc; 2 | 3 | use osc::sender::*; 4 | use osc::data::OscPacket::*; 5 | use osc::data::OscArg::*; 6 | 7 | fn main() { 8 | 9 | let local_addr = "localhost:7010"; 10 | let dest_addr = "localhost:7009"; 11 | 12 | let sender = OscSender::new(local_addr, dest_addr).unwrap(); 13 | 14 | let tests = vec!( 15 | OscMessage{ 16 | addr: "/test/addr/1".to_string(), 17 | args: vec!( OscInt(123), OscFloat(2.0), OscStr("I'm a string".to_string()), OscBlob(vec!(5u8, 10u8, 15u8)) ) 18 | }, 19 | OscMessage{ 20 | addr: "/test/addr/2".to_string(), 21 | args: vec!( OscInt(123456) ) 22 | }, 23 | OscBundle{ 24 | time_tag: (123,456), 25 | conts: vec!( OscMessage{addr: "/subaddr".to_string(), args: vec!(OscInt(789)) } ) 26 | }, 27 | OscBundle{ 28 | time_tag: (789,1001), 29 | conts: vec!( 30 | OscMessage{addr: "/subaddr".to_string(), args: vec!(OscInt(789)) }, 31 | OscBundle{ 32 | time_tag: (1,0), 33 | conts: vec!( OscMessage{addr: "/subsubaddr".to_string(), args: vec!(OscBlob(vec!(5u8, 10u8, 15u8, 20u8, 25u8)))}) 34 | } 35 | ) 36 | } 37 | ); 38 | 39 | for i in 0..5 { 40 | 41 | println!("trying to send"); 42 | 43 | match sender.send(tests[i % tests.len()].clone()) { 44 | Ok(_) => println!("send ok"), 45 | Err(e) => println!("Error: {}", e) 46 | } 47 | 48 | //std::io::timer::sleep(1000); 49 | } 50 | 51 | } 52 | -------------------------------------------------------------------------------- /src/broadcaster.rs: -------------------------------------------------------------------------------- 1 | extern crate time; 2 | 3 | /// THIS CODE HAS NOT BEEN PORTED TO MODERN (1.3.0) RUST YET. 4 | 5 | /// Create and run a new broadcaster, returning the sender used to broadcast a 6 | /// message to multiple consumers, and the control structure used to generate a 7 | /// new receiver for a consumer. 8 | /// 9 | /// # Example 10 | /// 11 | /// ``` 12 | /// let (bc, bc_ctrl) = broadcaster(); 13 | /// 14 | /// // Spawn some children that you would like to broadcast to: 15 | /// for i in range(0,10) { 16 | /// let rx = bc_ctrl.tune_in(); 17 | /// spawn(proc(){ 18 | /// loop { 19 | /// println!("task {} received {}", i, rx.recv()); 20 | /// } 21 | /// }); 22 | /// } 23 | /// 24 | /// // Send a message to all of them 25 | /// bc.send("hello, my children"); 26 | pub fn broadcaster() -> (Sender, BcCtrl) { 27 | 28 | // create the channels to send messages using this bc as well as to give it new consumers 29 | let (tx_bc, receiver) = channel(); 30 | let (tx_ctrl, ctrl_chan) = channel(); 31 | 32 | // spin up a task the BC will run in 33 | spawn(proc() { 34 | 35 | let mut senders: Vec> = Vec::new(); 36 | 37 | // keep track of whether or not the controller still exists 38 | let mut ctrl_alive = true; 39 | 40 | // transcieve! 41 | loop { 42 | 43 | let to_send: T; 44 | 45 | 46 | // block for a message to send, or kill the task if the sender has hung up 47 | match receiver.recv_opt() { 48 | Ok(v) => to_send = v, 49 | Err(_) => break 50 | } 51 | 52 | // check to see if we need to add any new consumers 53 | if ctrl_alive { 54 | loop { 55 | match ctrl_chan.try_recv() { 56 | Ok(c) => senders.push(c), 57 | // for now, do not kill the BC if the controller hangs up! 58 | // there may be use cases where we eliminate the controller 59 | // to prevent adding more consumers 60 | Err(e) if e == std::comm::Empty => break, 61 | Err(_) => { 62 | ctrl_alive = false; 63 | break 64 | } 65 | } 66 | } 67 | 68 | } 69 | 70 | 71 | // here in one step we broadcast and also remove channels which have hung up 72 | senders.retain(|chan| 73 | match chan.send_opt(to_send.clone()) { 74 | Ok(_) => true, 75 | Err(_) => false 76 | } 77 | ); 78 | } 79 | 80 | }); 81 | 82 | (tx_bc, BcCtrl{ctrl_chan: tx_ctrl}) 83 | } 84 | 85 | /// Helper object to request a new receiver from the broadcaster. 86 | pub struct BcCtrl{ 87 | ctrl_chan: Sender> 88 | } 89 | 90 | 91 | impl BcCtrl { 92 | 93 | /// Create a new receiver from the Broadcaster under control. 94 | pub fn tune_in(&self) -> Receiver { 95 | let (tx, rx) = channel(); 96 | self.ctrl_chan.send(tx); 97 | 98 | rx 99 | } 100 | } 101 | 102 | fn main() { 103 | 104 | let n = 1000u64; 105 | 106 | let (tx, ctrl) = broadcaster(); 107 | 108 | let t1 = time::precise_time_ns(); 109 | let t2 = time::precise_time_ns(); 110 | println!("{}", t2 - t1); 111 | 112 | let mut bigvec = Vec::new(); 113 | for i in range(0,100) { 114 | bigvec.push(i); 115 | } 116 | 117 | spawn(proc(){ 118 | for _ in range(0,n) { 119 | 120 | let tbvec = bigvec.clone(); 121 | std::io::timer::sleep(10); 122 | 123 | tx.send( (time::precise_time_ns(), tbvec) ); 124 | } 125 | }); 126 | 127 | for _ in range(0,10) { 128 | 129 | let rx = ctrl.tune_in(); 130 | 131 | spawn(proc(){ 132 | 133 | let mut ave = 0; 134 | 135 | for _ in range(0,n) { 136 | let (t_sent, bvec) = rx.recv(); 137 | let t_now = time::precise_time_ns(); 138 | ave += t_now - t_sent; 139 | bvec.len(); 140 | } 141 | 142 | println!("{} ns", ave / n) 143 | 144 | }); 145 | } 146 | 147 | println!("Dropping broadcaster control structure.") 148 | drop(ctrl); 149 | 150 | } 151 | -------------------------------------------------------------------------------- /src/data.rs: -------------------------------------------------------------------------------- 1 | //! Module that contains OSC data types and helper functions for handling those types. 2 | 3 | /// An Osc argument is an actual data payload - a number, string, or binary array. 4 | /// At present, this library only supports the Osc 1.0 required standard, not any 5 | /// of the optional types or the 1.1 standard. 6 | #[derive(Debug,Clone,PartialEq,PartialOrd)] 7 | pub enum OscArg { 8 | OscInt(i32), 9 | OscFloat(f32), 10 | OscStr(String), 11 | OscBlob(Vec) 12 | /* OSC 1.1 stuff 13 | OscInt64(i64), 14 | OscFloat64(f64), 15 | OscTime(OscTimeTag), 16 | OscSymbol(~str), 17 | OscChar(Ascii), 18 | OscColor((u8, u8, u8, u8)), 19 | OscMidi(MidiMessage), 20 | OscAssert(OscAssertion), 21 | OscArray(Vec) 22 | */ 23 | } 24 | use self::OscArg::*; 25 | 26 | // some placeholders for possible eventual OSC 1.1 support 27 | /* 28 | enum OscAssertion { 29 | True, 30 | False, 31 | Nil, 32 | Infinitum 33 | } 34 | 35 | struct MidiMessage { 36 | port_id: u8, 37 | status_byte: u8, 38 | data1: u8, 39 | data2: u8 40 | } 41 | */ 42 | 43 | /// Helper macro to check if an OscArg is a given type, produces a bool 44 | macro_rules! arg_is_type{ 45 | ($arg:ident, $targ_var:ident) => ( 46 | match $arg { 47 | $targ_var(_) => true, 48 | _ => false 49 | } 50 | ) 51 | } 52 | 53 | /// Helper macro to unwrap an OscArg as a given type, produces None if the types don't match 54 | macro_rules! unwrap_if{ 55 | ($arg:ident is $kind:ident) => ( 56 | match $arg { 57 | $kind(v) => Some(v), 58 | _ => None 59 | } 60 | ) 61 | } 62 | 63 | /// Type definition for a fixed-point OSC time tag. 64 | pub type OscTimeTag = (u32, u32); 65 | 66 | /// An OscPacket represents a single UDP packet sent or received. A packet is 67 | /// either a single OscMessage with an address and a list of arguments, or a 68 | /// OscBundle, essentialy a single packet with a timestamp containing multiple 69 | /// OscPackets inside with the intention to execute those packets simultaneously. 70 | #[derive(Debug,Clone,PartialEq,PartialOrd)] 71 | pub enum OscPacket { 72 | /// An OscMessage contains the destination address and list of OscArgs 73 | OscMessage{ 74 | addr: String, 75 | args: Vec 76 | }, 77 | /// A bundle is intended to synchronize multiple commands; essentially it 78 | /// bundles together multiple OSC packets 79 | OscBundle{ 80 | time_tag: OscTimeTag, 81 | conts: Vec 82 | } 83 | } 84 | use self::OscPacket::*; 85 | 86 | /// Find out if a packet contains a specified OSC address. 87 | pub fn packet_has_addr(packet: &OscPacket, addr_match: &str) -> bool { 88 | match *packet { 89 | OscMessage{ref addr, args: _} => addr_match == addr, 90 | OscBundle{time_tag: _, ref conts} => { 91 | for subpacket in conts.iter() { 92 | if packet_has_addr(subpacket, addr_match) { return true; } 93 | } 94 | false 95 | } 96 | } 97 | } 98 | 99 | /// Get the args associated with the given address; returns None if the given packet 100 | /// didn't contain the target address. 101 | pub fn get_args_with_addr(packet: OscPacket, addr_match: &str) -> Option> { 102 | 103 | match packet { 104 | OscMessage{addr, args} => { 105 | if addr_match == addr { 106 | Some(args) 107 | } 108 | else { 109 | None 110 | } 111 | }, 112 | OscBundle{ time_tag: _, conts} => { 113 | let mut arg_vec = Vec::new(); 114 | for subpacket in conts.into_iter() { 115 | match get_args_with_addr(subpacket, addr_match) { 116 | Some(a) => arg_vec.extend(a.into_iter()), 117 | None => () 118 | } 119 | } 120 | if arg_vec.is_empty() { 121 | return None; 122 | } 123 | Some(arg_vec) 124 | } 125 | } 126 | } 127 | 128 | #[test] 129 | fn test_packet_has_addr(){ 130 | let p1 = OscMessage{addr: "hello/test/address".to_string(), args: vec!(OscInt(0))}; 131 | let p2 = OscBundle{ 132 | time_tag: (0,1), 133 | conts: vec!( 134 | OscMessage{addr: "hello/another/test".to_string(), args: vec!(OscFloat(1.0))}, 135 | OscMessage{addr: "whatwhat/test/again".to_string(), args: vec!(OscStr("payload".to_string()))} 136 | ) 137 | }; 138 | 139 | assert!(packet_has_addr(&p1, "hello/test/address")); 140 | assert!(packet_has_addr(&p2, "hello/another/test")); 141 | assert!(packet_has_addr(&p2, "whatwhat/test/again")); 142 | 143 | assert!(! packet_has_addr(&p1, "ouch")); 144 | assert!(! packet_has_addr(&p2, "wooooo")); 145 | assert!(! packet_has_addr(&p2, "")); 146 | } 147 | 148 | #[test] 149 | fn test_get_args_with_addr(){ 150 | let p1 = OscMessage{addr: "hello/test/address".to_string(), args: vec!(OscInt(123), OscFloat(1.0), OscStr("I am a test string".to_string()))}; 151 | let p2 = OscBundle{ 152 | time_tag: (0,1), 153 | conts: vec!( 154 | OscMessage{addr: "hello/another/test".to_string(), args: vec!(OscFloat(3.0), OscFloat(1.5))}, 155 | OscMessage{addr: "whatwhat/test/again".to_string(), args: vec!(OscStr("payload".to_string()))} 156 | ) 157 | }; 158 | 159 | let p3 = OscBundle{ 160 | time_tag: (0,1), 161 | conts: vec!( 162 | OscMessage{addr: "double/addr/test".to_string(), args: vec!(OscFloat(3.0), OscFloat(1.5))}, 163 | OscMessage{addr: "double/addr/test".to_string(), args: vec!(OscStr("payload".to_string()))} 164 | ) 165 | }; 166 | 167 | assert_eq!(get_args_with_addr(p1.clone(), "hello/test/address"), Some(vec!(OscInt(123), OscFloat(1.0), OscStr("I am a test string".to_string())))); 168 | assert_eq!(get_args_with_addr(p1, "hello"), None); 169 | 170 | assert_eq!(get_args_with_addr(p2.clone(), "hello/another/test"), Some(vec!(OscFloat(3.0), OscFloat(1.5)))); 171 | assert_eq!(get_args_with_addr(p2.clone(), "whatwhat/test/again"), Some(vec!(OscStr("payload".to_string())))); 172 | assert_eq!(get_args_with_addr(p2.clone(), "whatwhat"), None); 173 | 174 | assert_eq!(get_args_with_addr(p3, "double/addr/test"), Some(vec!(OscFloat(3.0), OscFloat(1.5), OscStr("payload".to_string())))); 175 | } 176 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | #![crate_name = "osc"] 2 | 3 | // if you have made changes and are re-compiling, you may want to turn these warnings back on 4 | #![allow(unused_must_use)] 5 | #![allow(unused_imports)] 6 | 7 | #[macro_use] 8 | mod util; // must declare mods with macro exports in them before users! 9 | pub mod receiver; 10 | pub mod sender; 11 | #[macro_use] 12 | pub mod data; 13 | -------------------------------------------------------------------------------- /src/receiver.rs: -------------------------------------------------------------------------------- 1 | //! Module for receiving OSC over a UDP socket. 2 | 3 | extern crate std; 4 | extern crate byteorder; 5 | 6 | use std::net::UdpSocket; 7 | use std::net::SocketAddrV4; 8 | use std::net::ToSocketAddrs; 9 | 10 | use std::io::{Error, Result, BufReader, BufWriter}; 11 | use std::io::ErrorKind::{InvalidInput}; 12 | use std::str::*; 13 | use std::io::prelude::*; 14 | 15 | // support for reading raw binary streams into numbers, for testing 16 | use self::byteorder::{BigEndian, ReadBytesExt, WriteBytesExt}; 17 | use self::byteorder::Error::{Io, UnexpectedEOF}; 18 | 19 | use std::time::Duration; 20 | 21 | use data::*; 22 | use data::OscPacket::*; 23 | use data::OscArg::*; 24 | 25 | use sender::packet_to_buffer; 26 | 27 | use util::*; 28 | 29 | // Max size of UDP buffer; apparently 1536 is a common UDP MTU. 30 | const UDP_BUFFER_SIZE: usize = 1536; 31 | 32 | // static BUNDLE_ID: &'static str = "#bundle"; // perhaps we may want to use this some other day 33 | const BUNDLE_FIRST_CHAR: char = '#'; 34 | 35 | // smallest packet is a 0 character address (4 bytes) and a comma for type tag (4 bytes) 36 | const MIN_OSC_PACKET_SIZE: usize = 8; 37 | const PACKET_SIZE_ERR: &'static str = "Packet with less than 8 bytes."; 38 | 39 | // we may want to generalize this beyond UDP later 40 | /// Structure which contains the port used to receive Osc packets, and handles 41 | /// the task of interpreting those packets as valid Osc. 42 | pub struct OscReceiver { 43 | 44 | socket: UdpSocket 45 | 46 | } 47 | 48 | impl OscReceiver { 49 | 50 | /// Constructs a new OscReceiver using a socket address. Returns Err if an 51 | /// error occurred when trying to bind to the socket. 52 | pub fn new(addr: T) -> Result { 53 | match UdpSocket::bind(addr) { 54 | Ok(s) => Ok(OscReceiver{socket: s}), 55 | Err(e) => return Err(e), 56 | } 57 | } 58 | 59 | /// Receive a Osc packet. Blocks until a packet is available at the port. 60 | /// Can optionally specify a timeout on the blocking read. 61 | pub fn recv(&self, timeout: Option) -> Result { 62 | 63 | // initialize a receive buffer 64 | let buf = &mut[0; UDP_BUFFER_SIZE]; 65 | 66 | let packet_len; 67 | 68 | try!(self.socket.set_read_timeout(timeout)); 69 | 70 | match self.socket.recv_from(buf) { 71 | // ignoring source address from now, can bind it here if desired 72 | // if we didn't receive enough data, throw an error 73 | Ok((num, _)) if num < MIN_OSC_PACKET_SIZE => { 74 | return Err(Error::new(InvalidInput, PACKET_SIZE_ERR)); 75 | } 76 | // if we received at least 8 bytes, continue 77 | Ok((num, _)) => { 78 | packet_len = num; 79 | } 80 | // return an error if we encountered one 81 | Err(e) => { 82 | return Err(e); 83 | } 84 | } 85 | 86 | read_packet(&buf[..packet_len]) 87 | } 88 | } 89 | 90 | // interpret a buffer as an Osc packet; useful as bundles are recursive 91 | fn read_packet(buf: &[u8]) -> Result { 92 | if is_bundle(buf) { 93 | read_bundle(buf) 94 | } 95 | else { 96 | read_message(buf) 97 | } 98 | } 99 | 100 | // check if the message is a bundle by comparing the first character 101 | fn is_bundle(buf: &[u8]) -> bool { 102 | buf[0] as char == BUNDLE_FIRST_CHAR 103 | } 104 | 105 | // read the buffer as a bundle, assuming proper OSC formatting 106 | fn read_bundle(buf: &[u8]) -> Result { 107 | let mut reader = &mut BufReader::new(buf); 108 | 109 | // ignore 8 byte bundle ID string 110 | reader.take(8).read_to_end(&mut vec!());; 111 | 112 | // read the 64 bit time tag 113 | let (sec, frac_sec): OscTimeTag; 114 | 115 | match reader.read_u32::() { 116 | Ok(v) => sec = v, 117 | Err(Io(e)) => return Err(e), 118 | Err(UnexpectedEOF) => return Err(Error::new(InvalidInput, UnexpectedEOF)) 119 | } 120 | 121 | match reader.read_u32::() { 122 | Ok(v) => frac_sec = v, 123 | Err(Io(e)) => return Err(e), 124 | Err(UnexpectedEOF) => return Err(Error::new(InvalidInput, UnexpectedEOF)) 125 | } 126 | 127 | // now interpret the bundle contents 128 | let mut bundle_conts = Vec::new(); 129 | 130 | // until we're out of buffer, read elements 131 | let mut element_size: u32; 132 | loop { 133 | // get the length of the bundle element, should be a mult of 4 134 | match reader.read_i32::() { 135 | Ok(n) => element_size = n as u32, 136 | Err(Io(e)) => return Err(e), 137 | Err(UnexpectedEOF) => 138 | // End of bundle 139 | break 140 | } 141 | 142 | // try to read the specified length 143 | let vec = &mut Vec::new(); 144 | match reader.take(element_size as u64).read_to_end(vec) { 145 | Ok(num_read) => { 146 | if num_read == element_size as usize { 147 | // if we got a valid vector, interpret it as a Osc packet 148 | match read_packet(vec.as_ref()) { 149 | Ok(pack) => bundle_conts.push(pack), 150 | Err(e) => return Err(e) 151 | } 152 | } else { 153 | break 154 | } 155 | } 156 | _ => break 157 | } 158 | 159 | 160 | } 161 | 162 | Ok(OscBundle{time_tag: (sec, frac_sec), conts: bundle_conts}) 163 | } 164 | 165 | // interpret a byte array as an Osc message 166 | fn read_message(buf: &[u8]) -> Result { 167 | 168 | let mut reader = BufReader::new(buf); 169 | 170 | let addr: String; 171 | 172 | // get the address 173 | match read_null_term_string(&mut reader) { 174 | Ok(a) => { addr = a; }, 175 | Err(e) => { return Err(e); } 176 | } 177 | 178 | let tt_str: String; 179 | 180 | // now read the type tags 181 | match read_null_term_string(&mut reader) { 182 | Ok(tt) => { tt_str = tt; }, 183 | Err(e) => { return Err(e); } 184 | } 185 | 186 | // check to make sure the first char is a comma 187 | if tt_str.chars().nth(0) != Some(',') { 188 | return Err(Error::new(InvalidInput, "Missing type tag comma.")); 189 | } 190 | 191 | // now read the arguments 192 | let mut args = Vec::with_capacity(tt_str.len() - 1); 193 | 194 | // iterate over the args, skipping the comma ID 195 | for tt in tt_str.chars().skip(1) { 196 | match read_osc_arg(&mut reader, tt) { 197 | Ok(arg) => { args.push(arg); }, 198 | Err(e) => { return Err(e); } 199 | } 200 | } 201 | 202 | Ok(OscMessage{addr: addr, args: args}) 203 | } 204 | 205 | // Osc strings are null-terminated, we'll do this a lot 206 | fn read_null_term_string(reader: &mut BufReader<&[u8]>) -> Result { 207 | // read until null 208 | let m = &mut Vec::new(); 209 | match reader.read_until(0u8, m) { 210 | Ok(n) => { 211 | if n == 0 { 212 | return Err(Error::new(InvalidInput, "No string to read.")); 213 | } 214 | } 215 | Err(e) => return Err(e) 216 | } 217 | 218 | // Osc strings are always multiples of 4 bytes; read a few more if we didn't get a mult of 4 219 | reader.take(four_byte_pad(m.len()) as u64).read_to_end(&mut vec!()); 220 | 221 | m.pop(); // remove the trailing null 222 | // try to convert to a string 223 | match std::str::from_utf8(m.as_ref()) { 224 | Ok(a) => { 225 | Ok(String::from(a)) 226 | }, 227 | // return an error if we can't parse this as a string 228 | Err(e) => { 229 | Err(Error::new(InvalidInput, e)) 230 | } 231 | } 232 | } 233 | 234 | // read an osc argument based on a type tag 235 | fn read_osc_arg(reader: &mut BufReader<&[u8]>, type_tag: char) -> Result { 236 | 237 | match type_tag { 238 | 'i' => match reader.read_i32::() { 239 | Ok(v) => Ok(OscInt(v)), 240 | Err(Io(e)) => Err(e), 241 | Err(UnexpectedEOF) => return Err(Error::new(InvalidInput, UnexpectedEOF)) 242 | }, 243 | 'f' => match reader.read_f32::() { 244 | Ok(v) => Ok(OscFloat(v)), 245 | Err(Io(e)) => Err(e), 246 | Err(UnexpectedEOF) => return Err(Error::new(InvalidInput, UnexpectedEOF)) 247 | }, 248 | 's' => match read_null_term_string(reader) { 249 | Ok(v) => Ok(OscStr(v)), 250 | Err(e) => Err(e), 251 | }, 252 | 'b' => match read_blob(reader) { 253 | Ok(v) => Ok(OscBlob(v)), 254 | Err(e) => Err(e), 255 | }, 256 | _ => Err(Error::new(InvalidInput, format!("Invalid type tag {}", type_tag.to_string()) )) 257 | } 258 | } 259 | 260 | // read a blob 261 | fn read_blob(reader: &mut BufReader<&[u8]>) -> Result> { 262 | let len : u32; 263 | match reader.read_i32::() { 264 | Ok(v) => {len = v as u32;}, 265 | Err(Io(e)) => {return Err(e);}, 266 | Err(UnexpectedEOF) => return Err(Error::new(InvalidInput, UnexpectedEOF)) 267 | } 268 | 269 | let mut vec = Vec::new(); 270 | match reader.take(len as u64).read_to_end(&mut vec) { 271 | Ok(len) => { 272 | reader.consume(four_byte_pad(len)); 273 | Ok(vec) 274 | }, 275 | Err(e) => Err(e), 276 | } 277 | 278 | } 279 | 280 | // these tests would be a pain without the sender functions 281 | #[test] 282 | fn test_read_message(){ 283 | 284 | let tmess = OscMessage { 285 | addr: "/test/addr".to_string(), 286 | args: vec!( 287 | OscInt(123), 288 | OscFloat(1.23), 289 | OscStr("teststr".to_string()), 290 | OscBlob(vec!(0u8, 5u8, 10u8))) 291 | }; 292 | 293 | let buf = packet_to_buffer(tmess.clone()); 294 | let resmess = read_message(&buf[4..]).unwrap(); 295 | 296 | assert_eq!(tmess,resmess); 297 | } 298 | 299 | #[test] 300 | fn test_read_bundle(){ 301 | let a1 = OscInt(123); 302 | let a2 = OscFloat(0.0); 303 | let a3 = OscStr("abc".to_string()); 304 | let a4 = OscBlob(vec!(1u8, 2u8, 3u8, 4u8, 5u8)); 305 | 306 | let packet = OscBundle{ 307 | time_tag: (0,1), 308 | conts: vec!( 309 | OscMessage{ addr:"/t".to_string(), args: vec!(a1)}, 310 | OscBundle{ 311 | time_tag: (123,456), 312 | conts: vec!( 313 | OscMessage{ addr:"/a".to_string(), args: vec!(a2, a3)}, 314 | OscMessage{ addr:"/b".to_string(), args: vec!(a4)} 315 | ) 316 | } 317 | ) 318 | }; 319 | 320 | let buf = packet_to_buffer(packet.clone()); 321 | let res = read_bundle(&buf[4..]).unwrap(); 322 | 323 | assert_eq!(packet,res); 324 | } 325 | 326 | 327 | #[test] 328 | fn test_read_null_term_string(){ 329 | 330 | // remember that Osc strings are always multiples of 4 bytes! 331 | 332 | // simple case 333 | let buf1 = &[97u8, 98u8, 99u8, 0u8]; 334 | let mut reader1 = BufReader::new(&buf1[..]); 335 | assert_eq!(read_null_term_string(&mut reader1).unwrap(),"abc".to_string()); 336 | 337 | // multiple nulls and multiple calls 338 | let buf2 = &[97u8, 98u8, 0u8, 0u8, 99u8, 0u8]; 339 | let mut reader2 = BufReader::new(&buf2[..]); 340 | assert_eq!(read_null_term_string(&mut reader2).unwrap(),"ab".to_string()); 341 | assert_eq!(read_null_term_string(&mut reader2).unwrap(),"c".to_string()); 342 | assert!(read_null_term_string(&mut reader2).is_err()); 343 | 344 | 345 | // some corner cases 346 | let buf3 = []; 347 | let mut reader3 = BufReader::new(&buf3[..]); 348 | assert!(read_null_term_string(&mut reader3).is_err()); 349 | 350 | let buf4 = [0u8]; 351 | let mut reader4 = BufReader::new(&buf4[..]); 352 | assert_eq!(read_null_term_string(&mut reader4).unwrap(),"".to_string()); 353 | assert!(read_null_term_string(&mut reader4).is_err()); 354 | 355 | let buf5 = [0u8, 0u8, 0u8, 0u8, 0u8]; 356 | let mut reader5 = BufReader::new(&buf5[..]); 357 | assert_eq!(read_null_term_string(&mut reader5).unwrap(),"".to_string()); 358 | assert_eq!(read_null_term_string(&mut reader5).unwrap(),"".to_string()); 359 | assert!(read_null_term_string(&mut reader5).is_err()); 360 | } 361 | 362 | 363 | #[test] 364 | fn test_read_blob(){ 365 | 366 | let mut buf = BufWriter::new(vec!()); 367 | buf.write_i32::(9); 368 | buf.write( vec!(0u8, 1u8, 2u8, 3u8, 4u8, 5u8, 10u8, 15u8, 20u8, 0u8, 0u8, 0u8).as_ref() ); 369 | buf.flush(); 370 | 371 | let tbuf = buf.get_ref(); 372 | 373 | let mut treader = BufReader::new(tbuf.as_ref()); 374 | let mut teststr = String::new(); 375 | 376 | let res = read_blob(&mut treader).unwrap(); 377 | 378 | treader.read_to_string(&mut teststr); 379 | 380 | assert_eq!(res, vec!(0u8, 1u8, 2u8, 3u8, 4u8, 5u8, 10u8, 15u8, 20u8 )); 381 | assert_eq!(teststr.len(), 0usize); 382 | 383 | 384 | } 385 | -------------------------------------------------------------------------------- /src/sender.rs: -------------------------------------------------------------------------------- 1 | //! Module for sending OSC over a UDP socket. 2 | 3 | extern crate std; 4 | extern crate byteorder; 5 | 6 | use std::net::UdpSocket; 7 | use std::net::SocketAddrV4; 8 | use std::net::ToSocketAddrs; 9 | 10 | use std::io::{Result, BufWriter}; 11 | use self::byteorder::{BigEndian, WriteBytesExt}; 12 | 13 | use std::io::prelude::*; 14 | 15 | use data::*; 16 | use data::OscPacket::*; 17 | use data::OscArg::*; 18 | 19 | use util::*; 20 | 21 | // we may want to generalize this beyond UDP later 22 | /// Structure which contains the port used to send Osc packets, and handles 23 | /// the task of converting Rust Osc objects into valic Osc messages 24 | pub struct OscSender { 25 | 26 | socket: UdpSocket, 27 | dest: T 28 | 29 | } 30 | 31 | impl OscSender { 32 | 33 | /// Constructs a new OscSender using a local socket address and a destination 34 | /// address. Returns Err if an error occurred when trying to bind to the socket. 35 | pub fn new(local_addr: T, dest_addr: T) -> Result { 36 | match UdpSocket::bind(local_addr) { 37 | Ok(s) => Ok(OscSender{socket: s, dest: dest_addr}), 38 | Err(e) => return Err(e), 39 | } 40 | } 41 | 42 | 43 | /// Attempt to send a Rust OSC packet as an OSC UDP packet. 44 | pub fn send(&self, packet: OscPacket) -> Result { 45 | // note that we trim off the first four bytes, as they are the packet length 46 | // and the socket automatically calcs and sends that 47 | self.socket.send_to(&packet_to_buffer(packet)[4..], &self.dest) 48 | } 49 | 50 | 51 | } 52 | 53 | // convert an OscArg to its correpsonding type tag character 54 | fn arg_to_type_tag(arg: &OscArg) -> char { 55 | match *arg { 56 | OscInt(_) => 'i', 57 | OscFloat(_) => 'f', 58 | OscStr(_) => 's', 59 | OscBlob(_) => 'b' 60 | /* 61 | OscInt64(_) => 'h', 62 | OscFloat64(_) => 'd', 63 | OscTime(_) => 't', 64 | OscSymbol(_) => 'S', 65 | OscChar(_) => 'c', 66 | OscColor(_) => 'r', 67 | OscMidi(_) => 'm', 68 | OscAssert(a) => { 69 | match a { 70 | True => 'T', 71 | False => 'F', 72 | Nil => 'N', 73 | Infinitum => 'I' 74 | } 75 | }, 76 | // this was all nice and pretty until OscArray had to come fuck it all up 77 | // with OscArray I have to return a damn string instead of a char. lame. 78 | // this right here is enough reason to just support OSC 1.0 for now 79 | OscArray(v) => 80 | */ 81 | } 82 | } 83 | 84 | // format an Osc packet as a buffer of u8 85 | // first four bytes are size of payload in bytes, remainder is payload 86 | // this is public because it is VERY useful for receiver unit tests 87 | // and is itself tested 88 | pub fn packet_to_buffer(packet: OscPacket) -> Vec { 89 | 90 | let mut buf = Vec::new(); 91 | 92 | // write a placeholder for the payload size 93 | buf.write_i32::(0).unwrap(); 94 | 95 | 96 | match packet { 97 | OscMessage{ addr, args} => { 98 | 99 | //--- write the address string 100 | 101 | buf.write(to_osc_string(addr).as_bytes()).unwrap(); 102 | 103 | //--- write the string of type tags 104 | 105 | // starts with a comma 106 | buf.write(&[',' as u8]).unwrap(); 107 | 108 | // convert all the args to type tags and write them 109 | let tt_vec: Vec = args.iter().map(|a| arg_to_type_tag(a) as u8).collect(); 110 | buf.write( tt_vec.as_ref() ).unwrap(); 111 | 112 | // null-terminate type tag string 113 | buf.write(&[0u8]).unwrap(); 114 | 115 | // pad with nulls to obey osc string spec 116 | pad_with_null!(buf write args.len()+2); 117 | 118 | //--- write all the arguments 119 | 120 | for arg in args.into_iter() { 121 | write_arg(&mut buf, arg); 122 | } 123 | }, 124 | OscBundle{time_tag, conts} => { 125 | 126 | //--- write the bundle identifier string 127 | buf.write("#bundle\0".as_bytes()).unwrap(); 128 | 129 | //--- write the two parts of the time tag 130 | match time_tag { 131 | (sec, frac_sec) => { 132 | buf.write_u32::(sec).unwrap(); 133 | buf.write_u32::(frac_sec).unwrap(); 134 | } 135 | } 136 | 137 | //--- write each piece of the bundle payload, themselves Osc packets 138 | for packet in conts.into_iter() { 139 | buf.write(packet_to_buffer(packet).as_ref()).unwrap(); 140 | } 141 | } 142 | } 143 | 144 | //--- write the length of the full message payload 145 | 146 | // get rid of the old writer 147 | let size = buf.len(); 148 | 149 | // use a new writer to go back and write the size information 150 | BufWriter::new(&mut buf[..]).write_i32::( (size - 4) as i32).unwrap(); 151 | 152 | buf 153 | } 154 | 155 | // convert a string into a null-terminated, null-padded string 156 | // length must be a multiple of 4 bytes! 157 | fn to_osc_string(mut string: String) -> String { 158 | 159 | // add a null-terminator 160 | string.push('\0'); 161 | 162 | // pad with nulls 163 | for _ in 0usize..four_byte_pad(string.len()) { 164 | string.extend(&['\0']); 165 | } 166 | 167 | string 168 | } 169 | 170 | // write an OscArg using a given writer 171 | // it may be helpful later to redefine this as generic on a type that impl Writer 172 | fn write_arg(buf: &mut Vec, arg: OscArg) { 173 | match arg { 174 | OscInt(v) => { buf.write_i32::(v).unwrap(); }, 175 | OscFloat(v) => { buf.write_f32::(v).unwrap(); }, 176 | OscStr(v) => { buf.write(to_osc_string(v).as_bytes()).unwrap(); }, 177 | OscBlob(v) => { 178 | buf.write_i32::( v.len() as i32 ).unwrap(); 179 | buf.write(v.as_ref()).unwrap(); 180 | pad_with_null!(buf write v.len()); 181 | } 182 | } 183 | } 184 | 185 | // many possibilities here, just check a couple by hand 186 | #[test] 187 | fn test_packet_to_buffer_message() { 188 | 189 | let a1 = OscInt(123); 190 | let a2 = OscFloat(0.0); 191 | let a3 = OscStr("abc".to_string()); 192 | let a4 = OscBlob(vec!(1u8, 2u8, 3u8, 4u8, 5u8)); 193 | 194 | let mess = OscMessage{ 195 | addr: "/test/addr".to_string(), 196 | args: vec!(a1, a2, a3, a4) 197 | }; 198 | 199 | let buf = packet_to_buffer(mess); 200 | 201 | let mut tbuf = Vec::new(); 202 | tbuf.write_i32::(44); 203 | 204 | tbuf.write("/test/addr\0\0".as_bytes()); 205 | tbuf.write(",ifsb\0\0\0".as_bytes()); 206 | tbuf.write_i32::(123); 207 | tbuf.write_f32::(0.0); 208 | tbuf.write("abc\0".as_bytes()); 209 | tbuf.write_i32::(5); 210 | tbuf.write(vec!(1u8, 2u8, 3u8, 4u8, 5u8, 0u8, 0u8, 0u8).as_ref()); 211 | 212 | assert_eq!(buf, tbuf); 213 | } 214 | 215 | // many possibilities here, just check a couple by hand 216 | #[test] 217 | fn test_packet_to_buffer_bundle() { 218 | 219 | let a1 = OscInt(123); 220 | let a2 = OscFloat(0.0); 221 | let a3 = OscStr("abc".to_string()); 222 | let a4 = OscBlob(vec!(1u8, 2u8, 3u8, 4u8, 5u8)); 223 | 224 | let packet = OscBundle{ 225 | time_tag: (0,1), 226 | conts: vec!( 227 | OscMessage{ addr:"/t".to_string(), args: vec!(a1)}, 228 | OscBundle{ 229 | time_tag: (123,456), 230 | conts: vec!( 231 | OscMessage{ addr:"/a".to_string(), args: vec!(a2, a3)}, 232 | OscMessage{ addr:"/b".to_string(), args: vec!(a4)} 233 | ) 234 | } 235 | ) 236 | }; 237 | 238 | let res = packet_to_buffer(packet); 239 | 240 | 241 | let mut tbuf = Vec::new(); 242 | tbuf.write_i32::(96); // size of total packet 243 | 244 | tbuf.write("#bundle\0".as_bytes()); 245 | tbuf.write_u32::(0); 246 | tbuf.write_u32::(1); 247 | 248 | tbuf.write_i32::(12); // size of first bundle element 249 | tbuf.write("/t\0\0".as_bytes()); 250 | tbuf.write(",i\0\0".as_bytes()); 251 | tbuf.write_i32::(123); 252 | 253 | tbuf.write_i32::(60); // size of second bundle element 254 | 255 | tbuf.write("#bundle\0".as_bytes()); 256 | tbuf.write_u32::(123); 257 | tbuf.write_u32::(456); 258 | 259 | tbuf.write_i32::(16); // size of first bundle message 260 | tbuf.write("/a\0\0".as_bytes()); 261 | tbuf.write(",fs\0".as_bytes()); 262 | tbuf.write_f32::(0.0); 263 | tbuf.write("abc\0".as_bytes()); 264 | 265 | tbuf.write_i32::(20); // size of second bundle message 266 | tbuf.write("/b\0\0".as_bytes()); 267 | tbuf.write(",b\0\0".as_bytes()); 268 | tbuf.write_i32::(5); 269 | tbuf.write(vec!(1u8, 2u8, 3u8, 4u8, 5u8, 0u8, 0u8, 0u8).as_ref()); 270 | 271 | assert_eq!(tbuf, res); 272 | } 273 | 274 | 275 | #[test] 276 | fn test_to_osc_string() { 277 | 278 | let t0 = "a".to_string(); 279 | assert_eq!("a\0\0\0".to_string(),to_osc_string(t0)); 280 | 281 | let t1 = "hello".to_string(); 282 | assert_eq!("hello\0\0\0".to_string(),to_osc_string(t1)); 283 | 284 | let t2 = "".to_string(); 285 | assert_eq!("\0\0\0\0".to_string(),to_osc_string(t2)); 286 | } 287 | 288 | // there may be some pathological corner cases I haven't considered here 289 | #[test] 290 | fn test_write_arg(){ 291 | let mut buf = Vec::new(); 292 | 293 | let a1 = OscInt(123); 294 | let a2 = OscFloat(0.0); 295 | let a3 = OscStr("abc".to_string()); 296 | let a4 = OscBlob(vec!(1u8, 2u8, 3u8, 4u8, 5u8)); 297 | 298 | write_arg(&mut buf, a1); 299 | write_arg(&mut buf, a2); 300 | write_arg(&mut buf, a3); 301 | write_arg(&mut buf, a4); 302 | 303 | let mut tbuf = Vec::new(); 304 | tbuf.write_i32::(123); 305 | tbuf.write_f32::(0.0); 306 | tbuf.write("abc\0".as_bytes()); 307 | tbuf.write_i32::(5); 308 | tbuf.write(vec!(1u8, 2u8, 3u8, 4u8, 5u8, 0u8, 0u8, 0u8).as_ref()); 309 | 310 | assert_eq!(buf, tbuf); 311 | 312 | } 313 | 314 | -------------------------------------------------------------------------------- /src/util.rs: -------------------------------------------------------------------------------- 1 | /// calculate how many more bytes we need to make the argument a multiple of four 2 | pub fn four_byte_pad(len: usize) -> usize { 3 | let rem = len % 4; 4 | match rem { 5 | 0 => 0, 6 | v => 4 - v 7 | } 8 | } 9 | 10 | 11 | // helper macro for this commonly-needed operation 12 | macro_rules! pad_with_null { 13 | ($operator:ident $operation:ident $n:expr) => ( 14 | for _ in 0usize..four_byte_pad($n) { 15 | $operator.$operation(&[0u8]).unwrap(); 16 | } 17 | ) 18 | } --------------------------------------------------------------------------------