├── .gitignore ├── LICENSE ├── README.rst ├── midi ├── __init__.py ├── midi.py ├── types.py └── utils.py ├── setup.py └── tests ├── __init__.py ├── test_connector_object.py ├── test_message_object.py └── test_message_types.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Pycharm 2 | .idea/* 3 | 4 | # Byte-compiled / optimized / DLL files 5 | __pycache__/ 6 | *.py[cod] 7 | *$py.class 8 | 9 | guidelines-update.txt 10 | 11 | # C extensions 12 | *.so 13 | 14 | # Distribution / packaging 15 | .Python 16 | env/ 17 | build/ 18 | develop-eggs/ 19 | dist/ 20 | downloads/ 21 | eggs/ 22 | .eggs/ 23 | lib/ 24 | lib64/ 25 | parts/ 26 | sdist/ 27 | var/ 28 | *.egg-info/ 29 | .installed.cfg 30 | *.egg 31 | 32 | # PyInstaller 33 | # Usually these files are written by a python script from a template 34 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 35 | *.manifest 36 | *.spec 37 | 38 | # Installer logs 39 | pip-log.txt 40 | pip-delete-this-directory.txt 41 | 42 | # Unit test / coverage reports 43 | htmlcov/ 44 | .tox/ 45 | .coverage 46 | .coverage.* 47 | .cache 48 | nosetests.xml 49 | coverage.xml 50 | *,cover 51 | .hypothesis/ 52 | 53 | # Translations 54 | *.mo 55 | *.pot 56 | 57 | # Django stuff: 58 | *.log 59 | local_settings.py 60 | 61 | # Flask stuff: 62 | instance/ 63 | .webassets-cache 64 | 65 | # Scrapy stuff: 66 | .scrapy 67 | 68 | # Sphinx documentation 69 | docs/_build/ 70 | 71 | # PyBuilder 72 | target/ 73 | 74 | # IPython Notebook 75 | .ipynb_checkpoints 76 | 77 | # pyenv 78 | .python-version 79 | 80 | # celery beat schedule file 81 | celerybeat-schedule 82 | 83 | # dotenv 84 | .env 85 | 86 | # virtualenv 87 | venv/ 88 | ENV/ 89 | 90 | # Spyder project settings 91 | .spyderproject 92 | 93 | # Rope project settings 94 | .ropeproject 95 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | py-midi 2 | ======= 3 | 4 | **Simply send and receive MIDI messages using Python3.** 5 | 6 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY. 7 | 8 | **Warning: To use with Python3 only**. The library doesn't work with Python2. 9 | 10 | 1. Purpose 11 | ----------- 12 | 13 | This Python3 library has been made in order to communicate easily with any MIDI devices. The only requirement is to have a serial 14 | interface on your machine. It's on this interface that you must connect MIDI cables to establish a communication between your 15 | machine and the MIDI devices. 16 | 17 | The py-midi library allows users to build and/or read MIDI messages without having to worry on formating them before sending and/or after receiving. 18 | 19 | MIDI (Musical Instrument Digital Interface) is a standard used for making easy for instruments, computers and other electronic devices 20 | to communicate. 21 | 22 | This library is able to deal with any kind of MIDI messages, on any of the 16 possible channels (for channel-type messages) or with any kind of SysEx messages. 23 | 24 | For more details on the MIDI standard, see Wikipedia MIDI page https://en.wikipedia.org/wiki/MIDI 25 | 26 | 2. Installation 27 | --------------- 28 | Easily install the package using `pip`:: 29 | 30 | $ pip3 install py-midi 31 | 32 | Then you can import the package to your program: 33 | 34 | .. code-block:: python 35 | 36 | >>> import midi 37 | 38 | 39 | 3. Getting started 40 | ------------------- 41 | 42 | Creates an interface between your program and the serial port of the machine. You instanciate by giving the path to the serial port. Example: 43 | 44 | .. code-block:: python 45 | 46 | >>> from midi import MidiConnector 47 | >>> conn = MidiConnector('/dev/serial0') # path to use on RaspberryPi 3 48 | 49 | If you don't want the ``MidiConnector.read()`` method to block forever if it receives nothing, use the keyword argument **timeout** to set up a maximum duration (seconds) of blocking: 50 | 51 | .. code-block:: python 52 | 53 | >>> conn = MidiConnector('/dev/serial0', timeout=5) 54 | 55 | The ``timeout`` kwarg is only used for reading, not for writing. 56 | 57 | To send a MIDI message, you first need to instantiate a ``MidiMessageType``. There are 8 differents types of MIDI message. Here they are, with there instanciation parameters: 58 | 59 | * ``NoteOff(note_number, velocity)`` 60 | * ``NoteOn(note_number, velocity)`` 61 | * ``PolyphonicAftertouch(note_number, pressure)`` 62 | * ``ChannelAftertouch(pressure)`` 63 | * ``ControlChange(control_number, value)`` 64 | * ``ProgramChange(program_number)`` 65 | * ``PitchWheel(lsbyte, msbyte)`` 66 | * ``SysEx(manufacturer_id, data1, data2..., dataN)`` 67 | 68 | **NOTE** 69 | All instanciation parameters must be included within [0, 127] except for ``SysEx`` data (0 to 255) or ``ProgramChange``' number (1 to 128). 70 | 71 | Example: create a type ``ControlChange``: 72 | 73 | .. code-block:: python 74 | 75 | >>> from midi import ControlChange 76 | >>> cc = ControlChange(100, 127) 77 | 78 | Now build the full message, providing a channel: 79 | 80 | .. code-block:: python 81 | 82 | >>> from midi import Message 83 | >>> msg = Message(cc, channel=1) 84 | 85 | You can access the attributes of your message directly: 86 | 87 | .. code-block:: python 88 | 89 | >>> msg.control_number 90 | 100 91 | >>> msg.value 92 | 127 93 | 94 | Send the message to MIDI OUT, using the connector: 95 | 96 | .. code-block:: python 97 | 98 | >>> conn.write(msg) # returns the number of bytes sent 99 | 3 100 | 101 | ------- 102 | 103 | For reading messages received via MIDI IN, use the method ``read()`` as follow: 104 | 105 | .. code-block:: python 106 | 107 | >>> msg = conn.read() # read on ANY channel by default 108 | >>> # Pretend to receive a ProgramChange message, on channel 2 109 | >>> msg 110 | Message(ProgramChange(35), 2) 111 | >>> msg.channel 112 | 2 113 | >>> msg.type 114 | ProgramChange(35) 115 | >>> msg.program_number 116 | 35 117 | 118 | By default, the connector's ``read()`` method reads in OMNI mode. To specify a channel, add the channel number as a parameter: 119 | 120 | .. code-block:: python 121 | 122 | >>> msg = conn.read(8) # read only on channel 8, ignore the rest 123 | 124 | As per the MIDI standard, there are 16 channels you can read from, numbered from 1 to 16. 125 | -------------------------------------------------------------------------------- /midi/__init__.py: -------------------------------------------------------------------------------- 1 | from .midi import Message, MidiConnector 2 | from .types import (NoteOff, NoteOn, PolyphonicAftertouch, 3 | ControlChange, ProgramChange, ChannelAftertouch, PitchBend, 4 | SysEx 5 | ) -------------------------------------------------------------------------------- /midi/midi.py: -------------------------------------------------------------------------------- 1 | # !/usr/bin/env python3 2 | 3 | from serial import Serial 4 | 5 | from .types import SysEx, MidiMessageType 6 | from .utils import (build_message_from_sequence, get_channel_from_status, 7 | get_message_type_number_from_status, get_status_value) 8 | 9 | 10 | class MessageAttribute: 11 | """A descriptor to access a message attributes directly.""" 12 | def __init__(self, name): 13 | self.name = name 14 | 15 | def __set__(self, instance, value): 16 | raise TypeError('"{}" is a read-only attribute.'.format(self.name)) 17 | 18 | def __get__(self, instance, owner): 19 | if instance is None: 20 | return self 21 | return getattr(instance.type, self.name) 22 | 23 | 24 | class Message: 25 | """A complete MIDI message object. 26 | 27 | Args 28 | ==== 29 | type (MidiMessageType): see types.py 30 | channel (int): from 1 to 16. Only if not SysEx message. 31 | 32 | Example: 33 | >>> from midi.types import NoteOn 34 | >>> msg = Message(NoteOn(82, 127), 1) 35 | 36 | Attributes: 37 | - type: the type of message (ControlChange, NoteOn, , ProgramChange, etc...) 38 | - channel: MIDI channel used for sending/reading messages (from 1 to 16) 39 | 40 | You can also access the attributes of the different message types, eg, for 41 | ControlChange, you can call 42 | >>> msg.velocity 43 | or 44 | >>> msg.value 45 | (see help(midi.types) for more details) 46 | """ 47 | def __init__(self, message_type, channel=0): 48 | assert isinstance(message_type, MidiMessageType), TypeError( 49 | 'First parameter must be an instance of MidiMessageType.' 50 | ) 51 | if not isinstance(message_type, SysEx): 52 | assert 1 <= channel <= 16, \ 53 | "'channel' parameter must be an integer from 1 to 16." 54 | self.type = message_type 55 | self.channel = channel 56 | self._content = None 57 | self._link_attributes() 58 | 59 | def __repr__(self): 60 | return "Message({}, channel={})".format(self.type, self.channel) 61 | 62 | def __len__(self): 63 | return len(self.content) 64 | 65 | def __getitem__(self, index): 66 | return self.content[index] 67 | 68 | def _get_content(self): 69 | status = self._get_status_value() 70 | content = [status, self.type.data1] 71 | if isinstance(self.type, SysEx): 72 | content.extend([data for data in self.type.data]) 73 | content.append(0xf7) # End of SysEx message 74 | elif self.type.data2 is not None: 75 | content.append(self.type.data2) 76 | 77 | return content 78 | 79 | def _get_status_value(self): 80 | """Return the status value of the current message. 81 | 82 | Except for SysEx, the first four bits represent the MIDI message 83 | type. The last 4 bits represents the channel number, from 0 to 15. 84 | """ 85 | if isinstance(self.type, SysEx): 86 | status = 0xf0 87 | else: 88 | status = get_status_value(self.type.__class__, self._channel) 89 | 90 | return status 91 | 92 | def _link_attributes(self): 93 | """Link attributes of self.type directly to object. 94 | 95 | This allows, for instance, to access the 'velocity' attribute of a 96 | NoteOn type message directly from the Message instance itself. 97 | """ 98 | from .utils import TYPES_ATTRIBUTES 99 | attributes = {a for attr in TYPES_ATTRIBUTES.values() 100 | for a in attr if hasattr(self.type, a)} 101 | for attr in attributes: 102 | setattr(self.__class__, attr, MessageAttribute(attr)) 103 | 104 | @property 105 | def _channel(self): 106 | """Internal channel value, from 0 to 15.""" 107 | return self.channel - 1 108 | 109 | @property 110 | def content(self): 111 | if self._content is None: 112 | self._content = self._get_content() 113 | return self._content 114 | 115 | @property 116 | def bytes_content(self): 117 | return [bytes([c]) for c in self.content] 118 | 119 | @property 120 | def status(self): 121 | return self.content[0] 122 | 123 | 124 | class MidiConnector: 125 | """Interface object between program and machine's serial port. 126 | 127 | Args 128 | ==== 129 | port (str): path to the machine's serial interface, eg '/dev/serial0' 130 | on a RaspberryPi3 131 | 132 | baudrate (int): default to 31250, and should not be changed. 133 | This is the standard baudrate, used by all MIDI devices. 134 | 135 | timeout (float, optional): if you *don't want* the read() method 136 | to block for ever when waiting for a message, use a timeout to set up a 137 | maximum duration of blocking. The timeout is only used for reading, not 138 | writing. 139 | """ 140 | def __init__(self, port, baudrate=31250, timeout=None, **kwargs): 141 | self.port = port 142 | self.baudrate = baudrate 143 | self.timeout = timeout 144 | self.__connector = Serial( 145 | port=self.port, baudrate=self.baudrate, timeout=self.timeout) 146 | 147 | if kwargs.get('test', False): 148 | # We provide a fake read function when testing 149 | self.__read_byte = kwargs.get('read_func') 150 | else: 151 | self.__read_byte = self.__connector.read 152 | 153 | def __repr__(self): 154 | return "MidiConnector('{}', baudrate={}, timeout={})".format( 155 | self.port, self.baudrate, self.timeout) 156 | 157 | def read(self, channel=None): 158 | """Return a MIDI message from the bytes it reads. 159 | 160 | If 'channel' is specified, return only message(s) received on the given 161 | channel. Otherwise, read in "omni" mode and return any MIDI message 162 | received. 163 | 164 | If self.timeout is not None, return nothing if the timeout is reached 165 | before receiving a message. By default, self.timeout is None, so 166 | self.read() will block as long as necessary, until receiving a message. 167 | """ 168 | if channel is None: 169 | omni = True 170 | else: 171 | assert 1 <= channel <= 16, \ 172 | "'channel' parameter must be an integer from 1 to 16." 173 | omni = False 174 | 175 | msg = [None, None, None] 176 | sysex = False 177 | for i in range(len(msg)): 178 | raw_byte = self.__read_byte() 179 | if not raw_byte: 180 | return 181 | byte_value = ord(raw_byte) 182 | msg[i] = byte_value 183 | if msg[1] is not None: 184 | type_number = get_message_type_number_from_status(msg[0]) 185 | if type_number in (0xc, 0xd): 186 | # either a PC message or Channel Aftertouch: 187 | # they carry only 2 bytes, not 3 188 | break 189 | elif type_number == 0xf: # SysEx message 190 | sysex = True 191 | msg[2] = [] 192 | while True: 193 | raw_byte = self.__read_byte() 194 | byte_value = ord(raw_byte) 195 | if byte_value != 0xf7: 196 | msg[2].append(byte_value) 197 | else: # end of SysEx data 198 | break 199 | break 200 | 201 | from_channel = get_channel_from_status(msg[0]) 202 | if omni or channel == from_channel or sysex: 203 | return build_message_from_sequence(msg) 204 | 205 | def write(self, message): 206 | """Send MIDI message, and return the number of bytes transmitted. 207 | 208 | Args 209 | ==== 210 | message (midi.Message): message to send via MIDI port. 211 | """ 212 | assert isinstance(message, Message), TypeError( 213 | "Argument 'message' must be type Message ({} given).".format( 214 | (type(message)))) 215 | 216 | for byte in message.bytes_content: 217 | self.__connector.write(byte) 218 | 219 | return len(message) 220 | -------------------------------------------------------------------------------- /midi/types.py: -------------------------------------------------------------------------------- 1 | # !/usr/bin/env python3 2 | 3 | 4 | class MidiMessageType: 5 | """Parent class to inherit all message types from.""" 6 | def __new__(cls, *args, **kwargs): 7 | if cls.__name__ == 'MidiMessageType': 8 | raise RuntimeError('You must instanciate children classes.') 9 | instance = super().__new__(cls) 10 | return instance 11 | 12 | def __init__(self, data1, data2=None, internal=False): 13 | self._internal = internal 14 | self._type = self.__class__.__name__ 15 | self._build(data1, data2) 16 | 17 | if self._type == 'ProgramChange' and not internal: 18 | # MIDI standard numbers the PCs from 1 to 128. 19 | # Therefore, we need to decrement the number in order 20 | # to have the actual 7 bits value. When the message 21 | # is built with internal builder – ie from connector.read() – 22 | # the actual number is already correct. 23 | assert 1 <= data1 <= 128 24 | self._data1 = data1 - 1 25 | else: 26 | assert 0 <= data1 <= 127 27 | self._data1 = data1 28 | 29 | if data2 is not None: 30 | if self._type == 'SysEx': 31 | assert all(0 <= data <= 255 for data in data2) 32 | else: 33 | assert 0 <= data2 <= 127 34 | self._data2 = data2 35 | 36 | def _build(self, *args): 37 | from .utils import TYPES_ATTRIBUTES 38 | for index, attr in enumerate(TYPES_ATTRIBUTES[self.__class__]): 39 | setattr(self, attr, args[index]) 40 | 41 | def __repr__(self): 42 | name = self.__class__.__name__ 43 | if self._data2 is not None: 44 | return '{}({}, {})'.format(name, self._data1, self._data2) 45 | elif name == 'ProgramChange': 46 | # Increment data_1 to have the MIDI program number, from 47 | # 1 to 128. 48 | return '{}({})'.format(name, self._data1 + 1) 49 | return '{}({})'.format(name, self._data1) 50 | 51 | @property 52 | def data1(self): 53 | return self._data1 54 | 55 | @property 56 | def data2(self): 57 | return self._data2 58 | 59 | 60 | class NoteOff(MidiMessageType): 61 | """MIDI message type Note Off""" 62 | 63 | 64 | class NoteOn(MidiMessageType): 65 | """MIDI message type Note On.""" 66 | 67 | 68 | class PolyphonicAftertouch(MidiMessageType): 69 | """MIDI message type Polyphonic Aftertouch. 70 | 71 | This type of message is not so common when reading, because it is 72 | expansive to build on a keyboard. It requires on sigle sensor per key. 73 | Often, Channel Aftertouch is prefered, as it sets a global pressure level 74 | for every key. 75 | """ 76 | 77 | 78 | class ChannelAftertouch(MidiMessageType): 79 | """MIDI message type Channel Aftertouch.""" 80 | 81 | 82 | class ControlChange(MidiMessageType): 83 | """MIDI message type Control Change.""" 84 | 85 | 86 | class ProgramChange(MidiMessageType): 87 | """MIDI message type Program Change.""" 88 | 89 | 90 | class PitchBend(MidiMessageType): 91 | """MIDI message type Pitch Wheel.""" 92 | 93 | 94 | class SysEx(MidiMessageType): 95 | """MIDI message type SysEx. 96 | 97 | SysEx are used for device-specific data transfer. You can basicaly transfer 98 | any data in this type of message. 99 | 100 | The only required argument is the ID (each device manufacturer has its own 101 | ID, eg Yamaha (id 43), Roland (id 41) ...) 102 | 103 | Once you specified the ID, you can add as many data as you need to the 104 | message. 105 | 106 | Example 107 | ======= 108 | Build a message specific to Yamaha devices, with data [255, 0, 127, 54] 109 | (in this order) 110 | >>> sysex = SysEx(43, 255, 0, 127, 54) 111 | """ 112 | def __init__(self, manufacturer_id, *args): 113 | if not args: 114 | raise TypeError('Missing data args to build SysEx.') 115 | self.data = list(args) 116 | super().__init__(manufacturer_id, self.data) 117 | -------------------------------------------------------------------------------- /midi/utils.py: -------------------------------------------------------------------------------- 1 | from .types import (NoteOff, NoteOn, PolyphonicAftertouch, 2 | ControlChange, ProgramChange, ChannelAftertouch, PitchBend, 3 | SysEx) 4 | 5 | TYPES_NUMBER = { 6 | NoteOff: 0x8, NoteOn: 0x9, PolyphonicAftertouch: 0xa, ControlChange: 0xb, 7 | ProgramChange: 0xc, ChannelAftertouch: 0xd, PitchBend: 0xe, SysEx: 0xf 8 | } 9 | 10 | NUMBERS_TYPE = {v: k for k, v in TYPES_NUMBER.items()} 11 | 12 | TYPES_ATTRIBUTES = { 13 | NoteOff: ['note_number', 'velocity'], 14 | NoteOn: ['note_number', 'velocity'], 15 | PolyphonicAftertouch: ['note_number', 'pressure'], 16 | ControlChange: ['control_number', 'value'], 17 | ProgramChange: ['program_number'], 18 | ChannelAftertouch: ['pressure'], 19 | PitchBend: ['lsbyte', 'msbyte'], 20 | SysEx: ['manufacturer_id', 'data'] 21 | } 22 | 23 | 24 | class MessageBuilder: 25 | """An internal object used to build a Message when reading.""" 26 | def __init__(self, status, data1, data2): 27 | assert 128 <= status <= 255, 'Bad status value.' 28 | self.status = status 29 | self.data1 = data1 30 | self.data2 = data2 31 | self._message = None 32 | 33 | @property 34 | def type_number(self): 35 | return get_message_type_number_from_status(self.status) 36 | 37 | @property 38 | def channel(self): 39 | return get_channel_from_status(self.status) 40 | 41 | @property 42 | def message(self): 43 | if self._message is None: 44 | self._message = self._build() 45 | return self._message 46 | 47 | def _build(self): 48 | from .midi import Message 49 | 50 | midi_type = NUMBERS_TYPE[self.type_number] 51 | if self.data2 is not None: 52 | message_type = midi_type(self.data1, self.data2, internal=True) 53 | else: 54 | message_type = midi_type(self.data1, internal=True) 55 | 56 | if isinstance(message_type, NoteOn) and message_type.data2 == 0: 57 | # NoteOn with velocity = 0 are in fact NoteOff 58 | message_type = NoteOff(message_type.data1, message_type.data2) 59 | 60 | return Message(message_type, self.channel) 61 | 62 | 63 | def get_channel_from_status(status): 64 | """Return the 4 least important bits of status byte. 65 | 66 | According to MIDI standard, channels are numbered from 1 to 16, whereas 67 | the actual bits go from 0 to 15. 68 | """ 69 | channel = status & 0xf 70 | return channel + 1 71 | 72 | 73 | def get_message_type_number_from_status(status): 74 | """Return the 4 most important bits of status byte.""" 75 | return status >> 4 76 | 77 | 78 | def get_status_value(message_type, channel): 79 | """Return the value of the status byte. 80 | 81 | The first 4 bits represent the message type, the 4 last represent the 82 | channel. 83 | """ 84 | type_number = TYPES_NUMBER[message_type] 85 | first_nibble = type_number << 4 86 | return first_nibble + channel 87 | 88 | 89 | def build_message_from_sequence(sequence): 90 | """Return a MIDI Message object from a sequence of bytes value.""" 91 | sequence = list(sequence) 92 | assert len(sequence) <= 3, 'Sequence must contain maximum 3 items.' 93 | builder = MessageBuilder(*sequence) 94 | return builder.message 95 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """Setup tool for the package Py-midi 2 | Created by Edouard Theron 3 | Febuary 2017 4 | """ 5 | 6 | from setuptools import setup, find_packages 7 | from codecs import open 8 | from os import path 9 | 10 | here = path.abspath(path.dirname(__file__)) 11 | 12 | with open(path.join(here, 'README.rst'), encoding='utf-8') as f: 13 | long_description = f.read() 14 | 15 | setup( 16 | name='py-midi', 17 | version='2.0.1', 18 | description='A package for sending and receiving MIDI messages easily.', 19 | long_description=long_description, 20 | url='https://github.com/edthrn/py-midi', 21 | author='ed', 22 | author_email='edtheron@hey.com', 23 | license='GNU', 24 | classifiers=[ 25 | 'Development Status :: 4 - Beta', 26 | 'Intended Audience :: Developers', 27 | 'License :: OSI Approved :: GNU General Public License (GPL)', 28 | 'Topic :: Software Development :: Build Tools', 29 | 'Programming Language :: Python :: 3', 30 | 'Programming Language :: Python :: 3.3', 31 | 'Programming Language :: Python :: 3.4', 32 | 'Programming Language :: Python :: 3.5', 33 | ], 34 | keywords='package library midi music digital serial interface', 35 | packages=find_packages(), 36 | install_requires=['pyserial'], 37 | ) 38 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/edthrn/py-midi/60ba0e8b418ef5e28357be71e81a6b9e1ca5fc99/tests/__init__.py -------------------------------------------------------------------------------- /tests/test_connector_object.py: -------------------------------------------------------------------------------- 1 | from unittest.mock import patch, call, Mock 2 | 3 | import pytest 4 | 5 | from midi.midi import MidiConnector, Message 6 | from midi.types import NoteOff 7 | 8 | 9 | def get_bytes(integer): 10 | assert isinstance(integer, int) 11 | return integer.to_bytes(1, 'big') 12 | 13 | @pytest.fixture 14 | def message(): 15 | note_off = NoteOff(35, 127) 16 | return Message(note_off, 1) 17 | 18 | 19 | @pytest.fixture 20 | def midi_bytes(): 21 | values = [220, 100, 35] 22 | return [get_bytes(value) for value in values] 23 | 24 | 25 | @patch('midi.midi.Serial', autospec=True) 26 | def test_write(mock_serial, message): 27 | """Check if 'write' method from serial.Serial is called as expected.""" 28 | conn = MidiConnector('/path/to/serial/port') 29 | 30 | conn.write(message) 31 | 32 | expected_calls = [call().write(data) for data in message.bytes_content] 33 | assert mock_serial.method_calls == expected_calls 34 | 35 | 36 | @patch('midi.midi.Serial', autospec=True) 37 | def test_read_standard(mock_serial): 38 | """3 bytes expected""" 39 | reader = Mock() 40 | reader.side_effect = [bytes([value]) for value in [128, 35, 65]] 41 | conn = MidiConnector('/path/to/serial/port', test=True, read_func=reader) 42 | 43 | message = conn.read() 44 | 45 | assert isinstance(message, Message) 46 | assert isinstance(message.type, NoteOff) 47 | assert message.channel == 1 48 | assert message.note_number == 35 49 | assert message.velocity == 65 -------------------------------------------------------------------------------- /tests/test_message_object.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | 3 | from midi.midi import Message 4 | from midi.types import NoteOff, SysEx 5 | from midi.utils import get_status_value 6 | 7 | 8 | @pytest.fixture 9 | def note_off_msg(): 10 | note_off = NoteOff(10, 100) 11 | return Message(note_off, 1) 12 | 13 | 14 | @pytest.fixture 15 | def sysex_msg(): 16 | """A SysEx message with 4 bytes of random data with manufacturer ID #35.""" 17 | sysex = SysEx(35, 0x12, 0xac, 0x9a, 0x8d) 18 | return Message(sysex) 19 | 20 | 21 | def test_message_content(note_off_msg): 22 | assert len(note_off_msg) == 3 23 | assert note_off_msg[0] == 128 # status byte of NoteOff sent on channel 1 24 | assert note_off_msg[1] == 10 25 | assert note_off_msg[2] == 100 26 | 27 | assert note_off_msg.content == [128, 10, 100] 28 | assert note_off_msg.bytes_content == [bytes([c]) 29 | for c in note_off_msg.content] 30 | 31 | assert not hasattr(note_off_msg, 'control_number') 32 | assert hasattr(note_off_msg, 'note_number') 33 | assert hasattr(note_off_msg, 'velocity') 34 | assert note_off_msg.note_number == note_off_msg[1] 35 | assert note_off_msg.velocity == note_off_msg[2] 36 | 37 | 38 | 39 | def test_sysex_content(sysex_msg): 40 | assert len(sysex_msg) == 7 # ID + 4 bytes of data + start byte + end byte 41 | assert sysex_msg[0] == 0xf0 # SysEx start byte 42 | assert sysex_msg[1] == 35 43 | assert sysex_msg[-1] == 0xf7 # SysEx end byte 44 | -------------------------------------------------------------------------------- /tests/test_message_types.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | 3 | from midi.types import (NoteOff, NoteOn, PolyphonicAftertouch, 4 | ControlChange, ChannelAftertouch, ProgramChange, 5 | PitchBend, SysEx, MidiMessageType) 6 | 7 | 8 | @pytest.fixture 9 | def note_off(): 10 | return NoteOff(10, 120) 11 | 12 | 13 | @pytest.fixture 14 | def note_on(): 15 | return NoteOn(20, 110) 16 | 17 | 18 | @pytest.fixture 19 | def polyphonic_aftertouch(): 20 | return PolyphonicAftertouch(30, 50) 21 | 22 | 23 | @pytest.fixture 24 | def control_change(): 25 | return ControlChange(72, 40) 26 | 27 | 28 | @pytest.fixture 29 | def channel_aftertouch(): 30 | return ChannelAftertouch(90) 31 | 32 | 33 | @pytest.fixture 34 | def program_change(): 35 | return ProgramChange(1) 36 | 37 | 38 | @pytest.fixture 39 | def pitch_bend(): 40 | return PitchBend(127, 64) 41 | 42 | 43 | @pytest.fixture 44 | def sysex(): 45 | return SysEx(35, 120, 255, 90) 46 | 47 | 48 | def test_note_off(note_off): 49 | assert isinstance(note_off, MidiMessageType) 50 | assert note_off.data1 == note_off.note_number == 10 51 | assert note_off.data2 == note_off.velocity == 120 52 | assert not hasattr(note_off, 'value') 53 | 54 | 55 | def test_note_on(note_on): 56 | assert isinstance(note_on, MidiMessageType) 57 | assert note_on.data1 == note_on.note_number == 20 58 | assert note_on.data2 == note_on.velocity == 110 59 | assert not hasattr(note_on, 'value') 60 | 61 | 62 | def test_polyphonic_aftertouch(polyphonic_aftertouch): 63 | assert isinstance(polyphonic_aftertouch, MidiMessageType) 64 | assert polyphonic_aftertouch.data1 == polyphonic_aftertouch.note_number == 30 65 | assert polyphonic_aftertouch.data2 == polyphonic_aftertouch.pressure == 50 66 | assert not hasattr(note_on, 'value') 67 | 68 | 69 | def test_control_change(control_change): 70 | assert isinstance(control_change, MidiMessageType) 71 | assert control_change.data1 == control_change.control_number == 72 72 | assert control_change.data2 == control_change.value == 40 73 | assert not hasattr(control_change, 'velocity') 74 | 75 | 76 | def test_channel_aftertouch(channel_aftertouch): 77 | assert isinstance(channel_aftertouch, MidiMessageType) 78 | assert channel_aftertouch.data1 == channel_aftertouch.pressure == 90 79 | assert channel_aftertouch.data2 is None 80 | 81 | 82 | def test_program_change(program_change): 83 | assert isinstance(program_change, MidiMessageType) 84 | assert program_change.data1 == 0 # program_number - 1 85 | assert program_change.data2 is None 86 | assert program_change.program_number == 1 87 | 88 | 89 | def test_pitch_bend(pitch_bend): 90 | assert isinstance(pitch_bend, MidiMessageType) 91 | assert pitch_bend.data1 == pitch_bend.lsbyte == 127 92 | assert pitch_bend.data2 == pitch_bend.msbyte == 64 93 | 94 | 95 | def test_sysex(sysex): 96 | assert isinstance(sysex, MidiMessageType) 97 | assert sysex.data1 == sysex.manufacturer_id == 35 98 | assert sysex.data2 == [120, 255, 90] --------------------------------------------------------------------------------