├── LICENSE
├── README.md
├── midiXParser-example
└── midiXparser-example.ino
├── midiXParser-tests
├── makefile
├── test-data.h
├── test-group10.h
├── test-group20.h
├── test-mxp.cpp
└── test-utils.h
├── midiXparser.cpp
└── midiXparser.h
/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 |
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 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # midiXparser
2 | A small footprint midi parser class
3 |
4 |
5 | The midiXparser class allows to create rapidily "low level" midi parsers with a small footprint in your applications.
6 | It is platform agnostic so can be used with the Arduino platform or with any c++ compiler.
7 |
8 | midiXParser class has a full midi specs coverage, including running status and sysex, and do not rely on serial ports.
9 | You can pass a byte coming from an array (as done in demo sketch) or even a file.
10 |
11 | The demo sketch contains many tests to validate midiXparser features you can use as examples for your own code.
12 |
13 | ### Examples
14 |
15 | #### Declare a parser with a filter on Note off/ Note on
16 |
17 | #include
18 |
19 | midiXparser midiParser1, midiParser2;
20 |
21 | void setup()
22 | {
23 | Serial.begin(31250);
24 | midiParser1.setMidiMsgFilter( midiXparser::channelVoiceMsgTypeMsk );
25 | // We create a second parser here for the demo,
26 | // but this could be added to the filter of the 1st one to produce the same result.
27 | // By testing the midi status byte at getMidiMsg()[0]
28 |
29 | midiParser2.setMidiMsgFilter(midiXparser::realTimeMsgTypeMsk );
30 |
31 | }
32 |
33 | void loop()
34 | {
35 | if ( Serial.available() ) {
36 |
37 | byte receivedByte = Serial.read();
38 |
39 | if ( midiParser1.parse( receivedByte ) ) { // Do we received a channel voice msg ?
40 |
41 | // Echo the note received
42 | if ( midiParser1.isMidiStatus(midiXparser::noteOffStatus) || midiParser1.isMidiStatus(midiXparser::noteOnStatus) ) {
43 | delay(200);
44 | Serial.write(midiParser1.getMidiMsg(),midiParser1.getMidiMsgLen());
45 | }
46 | }
47 |
48 | if ( midiParser2.parse( receivedByte ) ) {
49 | // Do something for realtime msg....
50 |
51 | }
52 |
53 | }
54 |
55 | #### Capture sysex messages with no buffering
56 |
57 | midiXparser midiParser;
58 | midiParser..setMidiMsgFilter( midiXparser::sysExMsgTypeMsk);
59 |
60 | loop()
61 | {
62 | if ( Serial.available() && ( midiParser.parse( Serial.read() ) {
63 |
64 | if ( midiParser->getMidiMsgType() == midiXparser::sysExMsgType ) {
65 | // Do something for sysex message END
66 | (...)
67 | } else
68 |
69 | if ( midiParser->isSysexMode() && midiParser->isByteCaptured() {
70 | // Do something for sysex data (storing, on the fly process...)
71 | }
72 | }
73 | }
74 |
75 | ### Methods
76 |
77 | #### bool parse(byte readByte)
78 | Parse a byte and return true if a complete midi message was detected, according to the filters set.
79 | This method is also used for sysex end of message. The parse method will never return true for a sysex error.
80 | You have to check isSysexError() for an incomplete messsages, eventually.
81 |
82 | #### uint8_t *getMidiMsg()
83 | Get a pointer on the parsed midi message.
84 |
85 | #### uint8_t getMidiMsgLen()
86 | Return the length of the last parsed message, including parsed sysex mssages.
87 | Return 0 if the parse method does not return true at the last call.
88 |
89 | #### unsigned getSysExMsgLen() ;
90 | Return the length of a sysex message, whithout SOX and EOX, complete or not.
91 |
92 | #### byte getByte()
93 | Return the last byte parsed.
94 |
95 | #### bool isSysExMode()
96 | Return true if the last call to the parse method has entering into system exclusive mode.
97 | This method can be used in combination with the IsByteCaptured method to process sysex flows
98 | on the fly, without buffering.
99 |
100 | #### bool wasSysExMode()
101 | Return true if the last call to the parse method has stopped the sysex mode, because of EOX or an sysex error.
102 |
103 | #### bool isSysExError()
104 | Return true if the last call to the parse method has detected an abnormal end of sysex,
105 | generally a midi status (a byte >= 0x80) no beeing the EOX byte.
106 |
107 | #### bool isByteCaptured()
108 | Return true if the last byte parsed is belonging to a current midi message.
109 | Return false if filter doesn't match, or the parsed byte is not belonging to e midi message.
110 |
111 | #### bool isMidiStatus(enum midiStatusValue)
112 | Return true if the last parsed message is matching the midi status.
113 | Sysex messages are ignored and return always false, at it has no sense here
114 |
115 | #### uint8_t getMidiMsgType()
116 | Return the type of the last parsed midi message.
117 | Types are defined by the following enumeration :
118 | . midiXparser::noneMsgType
119 | . midiXparser::channelVoiceMsgType
120 | . midiXparser::systemCommonMsgType
121 | . midiXparser::realTimeMsgType
122 | . midiXparser::sysExMsgType
123 |
124 | #### uint8_t getMidiCurrentMsgType() ;
125 | Return the type of midi message being currenlty parsed.
126 | Types are defined by the following enumeration :
127 | . midiXparser::noneMsgType
128 | . midiXparser::channelVoiceMsgType
129 | . midiXparser::systemCommonMsgType
130 | . midiXparser::realTimeMsgType
131 | . midiXparser::sysExMsgType
132 |
133 | #### STATIC uint8_t getMidiStatusMsgLen(uint8_t midiStatus)
134 | Return the standard length of a midi status. Midi status are defined
135 | by the following enumaration :
136 |
137 | CHANNEL VOICE
138 | . midiXparser::noteOffStatus
139 | . midiXparser::noteOnStatus
140 | . midiXparser::polyKeyPressureStatus
141 | . midiXparser::controlChangeStatus
142 | . midiXparser::programChangeStatus
143 | . midiXparser::channelPressureStatus
144 | . midiXparser::pitchBendStatus
145 |
146 | SYSTEM COMMON
147 | . midiXparser::soxStatus
148 | . midiXparser::midiTimeCodeStatus
149 | . midiXparser::songPosPointerStatus
150 | . midiXparser::songSelectStatus
151 | . midiXparser::reserved1Status
152 | . midiXparser::reserved2Status
153 | . midiXparser::tuneRequestStatus
154 | . midiXparser::eoxStatus
155 |
156 | REAL TIME
157 | . midiXparser::timingClockStatus
158 | . midiXparser::reserved3Status
159 | . midiXparser::startStatus
160 | . midiXparser::continueStatus
161 | . midiXparser::stopStatus
162 | . midiXparser::reserved4Status
163 | . midiXparser::activeSensingStatus
164 | . midiXparser::systemResetStatus
165 |
166 | #### STATIC uint8_t getMidiStatusMsgType(uint8_t midiStatus)
167 | . Return the msg type of a midi status (see also getMidiMsgType)
168 |
169 | #### void setMidiMsgFilter(uint8_t midiMsgTypeMaskValues)
170 | Filter is defined by combining the getMidiMsgType mask with a BINARY OR. For example
171 | "channelVoiceMsgTypeMsk | systemCommonMsgTypeMsk".
172 | By default no filter is applied. You must explicitely set a filter before parsing.
173 |
174 |
--------------------------------------------------------------------------------
/midiXParser-example/midiXparser-example.ino:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | midXparser
4 | A small footprint midi parser.
5 | Copyright (C) 2017/2018 by The KikGen labs.
6 |
7 | EXAMPLE SKETCH
8 |
9 | Permission to use, copy, modify, distribute, and sell this
10 | software and its documentation for any purpose is hereby granted
11 | without fee, provided that the above copyright notice appear in
12 | all copies and that both that the copyright notice and this
13 | permission notice and warranty disclaimer appear in supporting
14 | documentation, and that the name of the author not be used in
15 | advertising or publicity pertaining to distribution of the
16 | software without specific, written prior permission.
17 |
18 | The author disclaim all warranties with regard to this
19 | software, including all implied warranties of merchantability
20 | and fitness. In no event shall the author be liable for any
21 | special, indirect or consequential damages or any damages
22 | whatsoever resulting from loss of use, data or profits, whether
23 | in an action of contract, negligence or other tortious action,
24 | arising out of or in connection with the use or performance of
25 | this software.
26 |
27 | Licence : GPL V3.
28 | */
29 |
30 | #include
31 |
32 | midiXparser midiParser1, midiParser2;
33 |
34 | void setup()
35 | {
36 | Serial.begin(31250);
37 | midiParser1.setMidiMsgFilter( midiXparser::channelVoiceMsgTypeMsk );
38 | // We create a second parser here for the demo,
39 | // but this could be added to the filter of the 1st one to produce the same result.
40 | // By testing the midi status byte at getMidiMsg()[0]
41 |
42 | midiParser2.setMidiMsgFilter(midiXparser::realTimeMsgTypeMsk );
43 |
44 | }
45 |
46 | void loop()
47 | {
48 | if ( Serial.available() ) {
49 |
50 | byte receivedByte = Serial.read();
51 |
52 | if ( midiParser1.parse( receivedByte ) ) { // Do we received a channel voice msg ?
53 |
54 | // Echo the note received
55 | if ( midiParser1.isMidiStatus(midiXparser::noteOffStatus) || midiParser1.isMidiStatus(midiXparser::noteOnStatus) ) {
56 | delay(200);
57 | Serial.write(midiParser1.getMidiMsg(),midiParser1.getMidiMsgLen());
58 | }
59 | }
60 |
61 | if ( midiParser2.parse( receivedByte ) ) {
62 | // Do something for realtime msg....
63 |
64 | }
65 |
66 | }
67 | }
68 |
--------------------------------------------------------------------------------
/midiXParser-tests/makefile:
--------------------------------------------------------------------------------
1 | CXX = g++
2 | CXXFLAGS = -Wall -g -std=gnu++11
3 |
4 | SRCS = test-mxp.cpp ../midiXparser.cpp
5 | OBJS = ${SRCS:.cpp=.o}
6 | HEADERS = ../midiXparser.h
7 |
8 | MAIN = tst-midixparser
9 |
10 | all: clean ${MAIN}
11 | @echo Tests for $(MAIN) was succefully compiled
12 |
13 | ${MAIN}: ${OBJS}
14 | ${CXX} ${CXXFLAGS} ${OBJS} -o ${MAIN}
15 |
16 | .cpp.o:
17 | ${CXX} ${CXXFLAGS} -c $< -o $@
18 |
19 | clean:
20 | ${RM} ${PROGS} ${OBJS} *.o *~.
21 |
--------------------------------------------------------------------------------
/midiXParser-tests/test-data.h:
--------------------------------------------------------------------------------
1 | uint8_t dummyMsg1[] = {
2 | 0XFA,
3 | 0x90,0x3A,0x77,
4 | 0x80,0x3A,0XF8,0x77,
5 | 0x91,0x3B,0x64,
6 | 0x81,0x3B,0x64,
7 | 0x92,0x3C,0x70,
8 | 0xFB,0xF6,
9 | 0x82,0x3C,0x70,
10 | 0xA0,0XF8,0x64,0x7F,
11 | 0xB1,0x64,0x7F,
12 | 0xC2,0x18,
13 | 0xC2,0x20,
14 | 0x7F, // Running status
15 | 0xFC,
16 | 0xD0,0x64,0x7F,
17 | 0xE2,0x64,0x7F,
18 | 0x41,0x42, // Running status
19 | 0xFE
20 | } ;
21 |
22 | uint8_t dummyMsg2[] = {
23 | 0xF0,0x77,0x77,0x78,
24 | 0xF8,
25 | 0x40,0x41,0x42,0x43,0xF7,
26 | 0xF0,0x41,0x77,0x78,
27 | 0xF8,
28 | 0x40,0xF7,
29 | 0xF0,0x77,0x77,0x77,
30 | 0xF8,
31 | 0x0,0x1,0x2,
32 | 0xF8,
33 | 0X44,0xF7,
34 | 0xF0,0x77,0x77,0x77,
35 | 0xF8,
36 | 0x0,0x1,0x2,
37 | 0xF8,
38 | 0x80,0x50,0x40,
39 | 0xF0,0x77,0x77,0x77,
40 | 0xF8,
41 | 0x40,0x41,0x42,0x43,
42 | 0xF8,
43 | 0X44,0xF7,
44 | 0xF0,0x77,0x77,
45 | 0xF0,0x0B,'H','E','L','L','O',0xF7} ;
46 |
--------------------------------------------------------------------------------
/midiXParser-tests/test-group10.h:
--------------------------------------------------------------------------------
1 | void test10a() {
2 | // ****************************************************
3 | header("10a","Default settings - no filters & no channel ");
4 |
5 | uint8_t * dummy = dummyMsg1;
6 | unsigned dummySize = sizeof(dummyMsg1);
7 | bool pass=false;
8 |
9 | midiXparser midiParser;
10 |
11 | pass = midiCounterTests(&midiParser,dummy,dummySize,
12 | 0 , // expMsgCount,
13 | 0 , // expCapturedBytes,
14 | 0 , // expSysExMsgCount,
15 | 0 , // expSysExErrorCount,
16 | 0 ); // expSysExLen
17 |
18 | footer(pass);
19 | if (!pass) serializer(&midiParser,dummy,dummySize );
20 | }
21 |
22 | void test10b() {
23 |
24 | // ****************************************************
25 | header("10b","All msg - All channels ");
26 |
27 | uint8_t * dummy = dummyMsg1;
28 | unsigned dummySize = sizeof(dummyMsg1);
29 | bool pass=false;
30 |
31 | midiXparser midiParser;
32 | midiParser.setMidiMsgFilter( midiXparser::allMsgTypeMsk );
33 |
34 | pass = midiCounterTests(&midiParser,dummy,dummySize,
35 | 22 , // expMsgCount,
36 | dummySize, // expCapturedBytes,
37 | 0 , // expSysExMsgCount,
38 | 0 , // expSysExErrorCount,
39 | 0 ); // expSysExLen
40 |
41 | footer(pass);
42 | if (!pass) serializer(&midiParser,dummy,dummySize );
43 | }
44 |
45 | void test10m() {
46 | // ****************************************************
47 | header("10m","Top level filter - channelVoiceMsgTypeMsk ");
48 |
49 | uint8_t * dummy = dummyMsg1;
50 | unsigned dummySize = sizeof(dummyMsg1);
51 | bool pass=false;
52 |
53 | midiXparser midiParser;
54 | midiParser.setMidiMsgFilter( midiXparser::channelVoiceMsgTypeMsk );
55 |
56 | pass = midiCounterTests(&midiParser,dummy,dummySize,
57 | 15 , // expMsgCount,
58 | 37, // expCapturedBytes,
59 | 0 , // expSysExMsgCount,
60 | 0 , // expSysExErrorCount,
61 | 0 ); // expSysExLen
62 |
63 | footer(pass);
64 | if (!pass) serializer(&midiParser,dummy,dummySize );
65 | }
66 |
67 | void test10n() {
68 | // ****************************************************
69 | header("10n","Top level filter-systemCommonMsgTypeMsk All Ch");
70 |
71 | uint8_t * dummy = dummyMsg1;
72 | unsigned dummySize = sizeof(dummyMsg1);
73 | bool pass=false;
74 |
75 | midiXparser midiParser;
76 | midiParser.setMidiMsgFilter( midiXparser::systemCommonMsgTypeMsk );
77 |
78 | pass = midiCounterTests(&midiParser,dummy,dummySize,
79 | 1 , // expMsgCount,
80 | 1, // expCapturedBytes,
81 | 0 , // expSysExMsgCount,
82 | 0 , // expSysExErrorCount,
83 | 0 ); // expSysExLen
84 |
85 | footer(pass);
86 | if (!pass) serializer(&midiParser,dummy,dummySize );
87 | }
88 |
89 | void test10o() {
90 | // ****************************************************
91 | header("10o","Top level filter-realTimeMsgTypeMsk All Ch");
92 |
93 | uint8_t * dummy = dummyMsg1;
94 | unsigned dummySize = sizeof(dummyMsg1);
95 | bool pass=false;
96 |
97 | midiXparser midiParser;
98 | midiParser.setMidiMsgFilter( midiXparser::realTimeMsgTypeMsk );
99 |
100 | pass = midiCounterTests(&midiParser,dummy,dummySize,
101 | 6 , // expMsgCount,
102 | 6, // expCapturedBytes,
103 | 0 , // expSysExMsgCount,
104 | 0 , // expSysExErrorCount,
105 | 0 ); // expSysExLen
106 |
107 | footer(pass);
108 | if (!pass) serializer(&midiParser,dummy,dummySize );
109 | }
110 |
111 | void test10p() {
112 | // ****************************************************
113 | header("10p","Top level filter-sysExMsgTypeMsk on the fly All Ch");
114 |
115 | uint8_t * dummy = dummyMsg2;
116 | unsigned dummySize = sizeof(dummyMsg2);
117 | bool pass=false;
118 |
119 | midiXparser midiParser;
120 | midiParser.setMidiMsgFilter( midiXparser::sysExMsgTypeMsk );
121 |
122 | pass = midiCounterTests(&midiParser,dummy,dummySize,
123 | 5 , // expMsgCount,
124 | 52, // expCapturedBytes,
125 | 5 , // expSysExMsgCount,
126 | 2 , // expSysExErrorCount,
127 | 40 ); // expSysExLen
128 |
129 | footer(pass);
130 | if (!pass) serializer(&midiParser,dummy,dummySize );
131 | }
132 |
133 | void test10q() {
134 | // ****************************************************
135 | header("10q","Top level filter realTime only mixed sysex All Ch");
136 |
137 | uint8_t * dummy = dummyMsg2;
138 | unsigned dummySize = sizeof(dummyMsg2);
139 | bool pass=false;
140 |
141 | midiXparser midiParser;
142 | midiParser.setMidiMsgFilter( midiXparser::realTimeMsgTypeMsk );
143 |
144 | pass = midiCounterTests(&midiParser,dummy,dummySize,
145 | 8 , // expMsgCount,
146 | 8, // expCapturedBytes,
147 | 0 , // expSysExMsgCount,
148 | 0 , // expSysExErrorCount,
149 | 0 ); // expSysExLen
150 |
151 | footer(pass);
152 | if (!pass) serializer(&midiParser,dummy,dummySize );
153 | }
154 |
--------------------------------------------------------------------------------
/midiXParser-tests/test-group20.h:
--------------------------------------------------------------------------------
1 | void test20a() {
2 |
3 | // ****************************************************
4 | header("20a","Program change check content ");
5 |
6 | uint8_t dummy[] = {0xB1,0x62,0x7F,0xC2,0x64,0xC2,0x24,0xB1,0x18,0x7F};
7 | unsigned dummySize = sizeof(dummy);
8 | bool pass=false;
9 |
10 | midiXparser midiParser;
11 | midiParser.setMidiMsgFilter( midiXparser::channelVoiceMsgTypeMsk );
12 |
13 | pass = midiCounterTests(&midiParser,dummy,dummySize,
14 | 4 , // expMsgCount,
15 | 10 , // expCapturedBytes,
16 | 0 , // expSysExMsgCount,
17 | 0 , // expSysExErrorCount,
18 | 0 );// expSysExLen
19 |
20 | pass = pass && midiCheckContent(&midiParser,dummy,dummySize);
21 |
22 | footer(pass);
23 | if (!pass) serializer(&midiParser,dummy,dummySize );
24 | }
25 |
26 | void test20b() {
27 | header("20b","isMidiStatus validation ");
28 | uint8_t dummy[] = {
29 | 0x83, 0x40,0x40,
30 | 0x94, 0x40,0x40,
31 | 0xB2, 0x40,0x40,
32 | 0xC0, 0x40,0x40,
33 | 0XF8,
34 | 0xF2,0X01,0X01,
35 | 0xF0,0x01,0x02,0xF7,
36 | };
37 |
38 | unsigned dummySize = sizeof(dummy);
39 | bool pass=false;
40 | midiXparser midiParser;
41 | midiParser.setMidiMsgFilter( midiXparser::allMsgTypeMsk );
42 | uint8_t count = 0;
43 |
44 | for ( uint8_t i=0 ; i< dummySize ; i++ ) {
45 | if ( midiParser.parse(dummy[i]) ) {
46 | if ( midiParser.isMidiStatus(midiXparser::noteOffStatus ) ) count++;
47 | if ( midiParser.isMidiStatus(midiXparser::controlChangeStatus ) ) count++;
48 | if ( midiParser.isMidiStatus(midiXparser::timingClockStatus ) ) count++;
49 | if ( midiParser.isMidiStatus(midiXparser::songPosPointerStatus ) ) count++;
50 | if ( midiParser.isMidiStatus(midiXparser::soxStatus ) ) count++;
51 | if ( midiParser.isMidiStatus(midiXparser::eoxStatus ) ) count++;
52 | }
53 | }
54 |
55 | pass = ( count == 4 ) ;
56 | footer(pass);
57 | if (!pass) serializer(&midiParser,dummy,dummySize );
58 |
59 | }
60 | void test21b() {
61 |
62 |
63 | }
64 |
65 | void test20c() {
66 |
67 | }
68 | void test20d() {
69 |
70 |
71 | }
72 |
73 | void test20e() {
74 |
75 | }
76 |
77 | void test20f() {
78 |
79 | // ****************************************************
80 | header("20f","SYSEX - Special case F0 F7 ");
81 |
82 | uint8_t dummy[] = {0xF0, 0XF7};
83 | unsigned dummySize = sizeof(dummy);
84 | bool pass=false;
85 |
86 | midiXparser midiParser;
87 | midiParser.setMidiMsgFilter( midiXparser::allMsgTypeMsk );
88 |
89 | pass = midiCounterTests(&midiParser,dummy,dummySize,
90 | 1 , // expMsgCount,
91 | 2, // expCapturedBytes,
92 | 1 , // expSysExMsgCount,
93 | 0 , // expSysExErrorCount,
94 | 0 );// expSysExLen
95 |
96 | pass = pass && midiCheckContent(&midiParser,dummy,dummySize);
97 |
98 | footer(pass);
99 | if (!pass) serializer(&midiParser,dummy,dummySize );
100 | }
101 |
102 | void test20g() {
103 |
104 | // ****************************************************
105 | header("20g","SYSEX - Special case F0 41 F7 ");
106 |
107 | uint8_t dummy[] = {0xF0, 0x41,0XF7};
108 | unsigned dummySize = sizeof(dummy);
109 | bool pass=false;
110 |
111 | midiXparser midiParser;
112 | midiParser.setMidiMsgFilter( midiXparser::allMsgTypeMsk );
113 |
114 | pass = midiCounterTests(&midiParser,dummy,dummySize,
115 | 1 , // expMsgCount,
116 | 3 , // expCapturedBytes,
117 | 1 , // expSysExMsgCount,
118 | 0 , // expSysExErrorCount,
119 | 1 );// expSysExLen
120 |
121 | pass = pass && midiCheckContent(&midiParser,dummy,dummySize);
122 |
123 | footer(pass);
124 | if (!pass) serializer(&midiParser,dummy,dummySize );
125 | }
126 |
127 | void test20h() {
128 |
129 | // ****************************************************
130 | header("20h","SYSEX Error with one byte ");
131 |
132 | uint8_t dummy[] = {0xF0, 1,2,3,4,5,0XF8,0xF6,0xF8 };
133 | unsigned dummySize = sizeof(dummy);
134 | bool pass=false;
135 |
136 | midiXparser midiParser;
137 | midiParser.setMidiMsgFilter( midiXparser::allMsgTypeMsk );
138 |
139 | pass = midiCounterTests(&midiParser,dummy,dummySize,
140 | 3 , // expMsgCount,
141 | 9 , // expCapturedBytes,
142 | 0 , // expSysExMsgCount,
143 | 1 , // expSysExErrorCount,
144 | 5 );// expSysExLen
145 |
146 | //pass = pass && midiCheckContent(&midiParser,dummy,dummySize);
147 |
148 | footer(pass);
149 | if (!pass) serializer(&midiParser,dummy,dummySize );
150 | }
151 |
152 | void test20i() {
153 |
154 | // ****************************************************
155 | header("20i","Parse repeated SYSEX Error - notes on/off on the fly");
156 |
157 | uint8_t dummy[] = {0xF0, 1,2,3,4,5,
158 | 0xF0, 1,2,3,4,5,0xF7, // error 1 - msg 1
159 | 0xF7, // error 2
160 | 0xF0, 1,2,3,4,5, // error 3
161 | 0x90,0x3A,0x64,0x80,0x3A,0x40, //
162 | 0x90,0x3A,0x64,0x80,0x3A,0x40, // msg 5
163 | 0xF0, // error 4
164 | 0x90,0x3A,0x64,0x80,0x3A,0x40, //
165 | 0x90,0x3A,0x64,0x80,0x3A,0x40,
166 | 0x90,0xF7,0x3A,0x64,0x80,0x3A,0x40,
167 | 0x90,0x3A,0x64,0x80,0x3A,0x40, // msg 13
168 | 0xF7,0xF0,0xF0, 1,2,3,4,5, // error 5
169 | 0x90,0x3A,0x64,0x80,0x3A,0x40, // error 6 - msg 15
170 | 0x90,0x3A,0x64,1,2,3, 0xF0 , 4,
171 | 0x80,0x3A,0x40,1,2, 0xF7 ,3,4
172 | };
173 | unsigned dummySize = sizeof(dummy);
174 | bool pass=false;
175 |
176 | midiXparser midiParser;
177 | midiParser.setMidiMsgFilter( midiXparser::allMsgTypeMsk );
178 |
179 | pass = midiCounterTests(&midiParser,dummy,dummySize,
180 | 18 , // expMsgCount,
181 | 84, // expCapturedBytes,
182 | 1 , // expSysExMsgCount,
183 | 10 , // expSysExErrorCount,
184 | 21 ); // expSysExLen
185 |
186 | //pass = pass && midiCheckContent(&midiParser,dummy,dummySize);
187 |
188 | footer(pass);
189 | if (!pass) serializer(&midiParser,dummy,dummySize );
190 | }
191 |
--------------------------------------------------------------------------------
/midiXParser-tests/test-mxp.cpp:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | midXparser
4 | A small footprint midi parser.
5 | Copyright (C) 2017/2018 by The KikGen labs.
6 |
7 | Validation TESTS
8 |
9 | Permission to use, copy, modify, distribute, and sell this
10 | software and its documentation for any purpose is hereby granted
11 | without fee, provided that the above copyright notice appear in
12 | all copies and that both that the copyright notice and this
13 | permission notice and warranty disclaimer appear in supporting
14 | documentation, and that the name of the author not be used in
15 | advertising or publicity pertaining to distribution of the
16 | software without specific, written prior permission.
17 |
18 | The author disclaim all warranties with regard to this
19 | software, including all implied warranties of merchantability
20 | and fitness. In no event shall the author be liable for any
21 | special, indirect or consequential damages or any damages
22 | whatsoever resulting from loss of use, data or profits, whether
23 | in an action of contract, negligence or other tortious action,
24 | arising out of or in connection with the use or performance of
25 | this software.
26 |
27 | Licence : MIT.
28 | */
29 |
30 | #include
31 | #include
32 |
33 | #include "../midiXparser.h"
34 | #include "test-utils.h"
35 | #include "test-data.h"
36 | #include "test-group10.h"
37 | #include "test-group20.h"
38 |
39 | int main() {
40 |
41 | printf("\n============================================================================\n");
42 | printf("midiXparser class TESTS\n");
43 | printf("============================================================================\n\n");
44 |
45 | test10a(); test10b();
46 | //test10c(); test10d(); test10e(); test10f(); test10g();
47 | //test10h(); test10i(); test10j(); test10k(); test10l();
48 | test10m(); test10n();
49 | test10o(); test10p(); test10q();
50 |
51 | test20a(); test20b();
52 | //test21b(); test20c(); test20d(); test20e();
53 | test20f(); test20g(); test20h(); test20i();
54 |
55 | printf("\n======================== END OF TESTS ======================================\n\n");
56 | }
57 |
--------------------------------------------------------------------------------
/midiXParser-tests/test-utils.h:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | midXparser
4 | A small footprint midi parser.
5 | Copyright (C) 2017/2018 by The KikGen labs.
6 |
7 | Validation TESTS - UTILITIES
8 |
9 | Permission to use, copy, modify, distribute, and sell this
10 | software and its documentation for any purpose is hereby granted
11 | without fee, provided that the above copyright notice appear in
12 | all copies and that both that the copyright notice and this
13 | permission notice and warranty disclaimer appear in supporting
14 | documentation, and that the name of the author not be used in
15 | advertising or publicity pertaining to distribution of the
16 | software without specific, written prior permission.
17 |
18 | The author disclaim all warranties with regard to this
19 | software, including all implied warranties of merchantability
20 | and fitness. In no event shall the author be liable for any
21 | special, indirect or consequential damages or any damages
22 | whatsoever resulting from loss of use, data or profits, whether
23 | in an action of contract, negligence or other tortious action,
24 | arising out of or in connection with the use or performance of
25 | this software.
26 |
27 | Licence :GPL V3.
28 | */
29 |
30 | void header(char const *title, char const * subTitle) ;
31 | void footer(bool pass);
32 | void serializer(midiXparser *midiParser,uint8_t dummy[], unsigned dummySize ) ;
33 | bool midiCounterTests(
34 | midiXparser *midiParser,
35 | uint8_t * dummy,
36 | const unsigned dummySize,
37 | const unsigned expMsgCount,
38 | const unsigned expCapturedBytes,
39 | const unsigned expSysExMsgCount,
40 | const unsigned expSysExErrorCount,
41 | const unsigned expSysExLen
42 | );
43 | bool midiCheckContent(midiXparser *midiParser,uint8_t * dummy,const unsigned dummySize);
44 |
45 | bool midiCounterTests(
46 | midiXparser *midiParser,
47 | uint8_t * dummy,
48 | const unsigned dummySize,
49 | const unsigned expMsgCount,
50 | const unsigned expCapturedBytes,
51 | const unsigned expSysExMsgCount,
52 | const unsigned expSysExErrorCount,
53 | const unsigned expSysExLen
54 | ) {
55 |
56 | bool pass=false;
57 | unsigned msgCount = 0;
58 | unsigned capturedBytesCount = 0;
59 | unsigned noCapturedBytesCount = 0;
60 | unsigned sysExMsgCount = 0;
61 | unsigned sysExErrorCount = 0;
62 | unsigned sysExLen = 0;
63 |
64 | for (unsigned i = 0; i< dummySize ; i++ ) {
65 | if ( midiParser->parse( dummy[i] ) ) {
66 | msgCount++ ;
67 | }
68 | if ( midiParser->wasSysExMode() ) {
69 | sysExLen += midiParser->getSysExMsgLen();
70 | if ( midiParser->isSysExError() )
71 | sysExErrorCount++;
72 | else
73 | sysExMsgCount++;
74 | }
75 |
76 | if ( midiParser->isByteCaptured() ) capturedBytesCount++ ;
77 | else noCapturedBytesCount++;
78 | }
79 | //printf(" msgcount %d msgcountsys %d sysexlen %d syx err %d cap %d ",msgCount, sysExMsgCount,sysExLen,sysExErrorCount,capturedBytesCount);
80 |
81 | pass = ( msgCount == expMsgCount &&
82 | capturedBytesCount == expCapturedBytes &&
83 | sysExMsgCount == expSysExMsgCount &&
84 | sysExLen == expSysExLen &&
85 | dummySize == ( capturedBytesCount + noCapturedBytesCount)
86 | );
87 | return pass;
88 | }
89 |
90 |
91 | bool midiCheckContent(midiXparser *midiParser,uint8_t * dummy,const unsigned dummySize) {
92 | bool m = false;
93 | unsigned j = 0;
94 | uint8_t msg[64];
95 |
96 | for (unsigned i = 0; i< dummySize ; i++ ) {
97 | m = midiParser->parse( dummy[i] ) ;
98 | if ( midiParser->isByteCaptured() ) {
99 | msg[j++] = midiParser->getByte();
100 | }
101 | if ( m ) break ;
102 | if ( midiParser->isSysExError() ) break;
103 | }
104 |
105 | if ( ! midiParser->isSysExError() && !m ) return false;
106 |
107 |
108 | for (unsigned i = 0; i getMidiMsg()[i],msg[i]);
111 | return false;
112 | }
113 | }
114 |
115 | return true;
116 |
117 | }
118 |
119 | void header(char const *title, char const * subTitle) {
120 | printf("----------------------------------------------------------------------------\n");
121 | printf("TEST %s : %s", title, subTitle);
122 | }
123 |
124 | void footer(bool pass) {
125 | if (pass)
126 | printf(" PASS \n");
127 | else
128 | printf(" *** FAIL ***\n");
129 | printf("----------------------------------------------------------------------------\n");
130 | }
131 |
132 |
133 | void serializer(midiXparser *midiParser,uint8_t dummy[], unsigned dummySize ) {
134 |
135 | const int cr=6;
136 | int nl =0;
137 | unsigned capturedbytescount = 0;
138 | unsigned nocapturedbytescount = 0;
139 | unsigned msgcount = 0;
140 |
141 | unsigned sysexlen = 0;
142 | unsigned sysexmsgcount = 0;
143 | unsigned sysexerrorcount = 0;
144 |
145 | unsigned sx = 0;
146 | uint8_t sxmsg[64];
147 |
148 | for (unsigned i = 0; i< dummySize ; i++ ) {
149 |
150 | bool msg = midiParser->parse( dummy[i] );
151 | if (msg) msgcount++ ;
152 |
153 | printf(" %2x ",dummy[i]);
154 |
155 | if ( midiParser->isByteCaptured()) {
156 | printf("c");
157 | capturedbytescount++ ;
158 | if ( midiParser->isSysExMode() && dummy[i] != 0xF0) sxmsg[sx++] = midiParser->getByte();
159 |
160 | } else {
161 | printf(" ");
162 | nocapturedbytescount++;
163 | }
164 |
165 | if( midiParser->isSysExMode()) printf("x");else printf(" ");
166 |
167 | if( midiParser->isSysExError()) {
168 | printf("e");
169 | sysexerrorcount++;
170 | }
171 | else printf(" ");
172 |
173 | printf(" |");
174 |
175 | if ( ++nl >= cr ) { printf("\n"); nl = 0 ; }
176 |
177 | if (msg || midiParser->isSysExError() ) {
178 |
179 | if ( nl < cr )
180 | printf("\n");
181 |
182 | nl = 0;
183 |
184 | if ( midiParser->wasSysExMode() ) {
185 | if ( midiParser->isSysExError() ) printf("** ERROR **" );
186 | else { sysexmsgcount++; }
187 | sysexlen += midiParser->getSysExMsgLen();
188 |
189 | printf("SYSEX MSG (len = %d) = [", midiParser->getSysExMsgLen() );
190 | for (unsigned j = 0 ; j < sx ; j++) {
191 | printf("%2x," , sxmsg[j] );
192 | }
193 | sx = 0;
194 | printf("]\n");
195 |
196 | }
197 | if ( msg && midiParser->getMidiMsgType() != midiXparser::sysExMsgTypeMsk) {
198 | printf("MIDI MSG = [%2X",midiParser->getMidiMsg()[0]);
199 | if (midiParser->getMidiMsgLen() >=2) { printf(",%2x",midiParser->getMidiMsg()[1]);}
200 | if (midiParser->getMidiMsgLen() ==3) { printf(",%2x",midiParser->getMidiMsg()[2]);}
201 | printf("]\n");
202 | }
203 | printf("\n");
204 | }
205 | }
206 | printf("\nStream length : %d\n",dummySize);
207 | printf("Number of midi messages found : %d\n",msgcount);
208 | printf("Number of valid SysEx msg found : %d\n",sysexmsgcount);
209 | printf("Number of sysex errors : %d\n",sysexerrorcount);
210 | printf("Total length of sysex messages : %d\n",sysexlen);
211 | printf("Number of bytes captured : %d\n",capturedbytescount);
212 | printf("Number of bytes non captured : %d\n",nocapturedbytescount);
213 |
214 | printf("--------------------------- END OF DUMP ------------------------------------\n");
215 | }
216 |
--------------------------------------------------------------------------------
/midiXparser.cpp:
--------------------------------------------------------------------------------
1 | /*
2 | midXparser
3 | A small footprint midi parser.
4 | Copyright (C) 2017/2018 by The KikGen labs.
5 |
6 | HEADER CLASS FILE - METHODS
7 |
8 | Permission to use, copy, modify, distribute, and sell this
9 | software and its documentation for any purpose is hereby granted
10 | without fee, provided that the above copyright notice appear in
11 | all copies and that both that the copyright notice and this
12 | permission notice and warranty disclaimer appear in supporting
13 | documentation, and that the name of the author not be used in
14 | advertising or publicity pertaining to distribution of the
15 | software without specific, written prior permission.
16 |
17 | The author disclaim all warranties with regard to this
18 | software, including all implied warranties of merchantability
19 | and fitness. In no event shall the author be liable for any
20 | special, indirect or consequential damages or any damages
21 | whatsoever resulting from loss of use, data or profits, whether
22 | in an action of contract, negligence or other tortious action,
23 | arising out of or in connection with the use or performance of
24 | this software.
25 |
26 | Licence : GPL V3.
27 | */
28 |
29 | #include "midiXparser.h"
30 | #include
31 | #include
32 | const uint8_t midiXparser::m_systemCommonMsglen[]={
33 | // SYSTEM COMMON
34 | 0, // soxStatus = 0XF0,
35 | 2, // midiTimeCodeStatus = 0XF1,
36 | 3, // songPosPointerStatus = 0XF2,
37 | 2, // songSelectStatus = 0XF3,
38 | 0, // reserved1Status = 0XF4,
39 | 0, // reserved2Status = 0XF5,
40 | 1, // tuneRequestStatus = 0XF6,
41 | 0 // eoxStatus = 0XF7,
42 | };
43 |
44 | const uint8_t midiXparser::m_channelVoiceMsgMsglen[]={
45 | 3, // noteOffStatus = 0X80,
46 | 3, // noteOnStatus = 0X90,
47 | 3, // polyKeyPressureStatus = 0XA0,
48 | 3, // controlChangeStatus = 0XB0,
49 | 2, // programChangeStatus = 0XC0,
50 | 2, // channelPressureStatus = 0XD0,
51 | 3, // pitchBendStatus = 0XE0,
52 | };
53 |
54 | // Constructors
55 | midiXparser::midiXparser() {
56 |
57 | };
58 |
59 | // Give the current sysex state,
60 | bool midiXparser::isSysExMode() { return m_sysExMode ;}
61 |
62 | bool midiXparser::wasSysExMode() {
63 | return ( ( m_readByte == eoxStatus && m_isByteCaptured ) || m_sysExError );
64 | }
65 |
66 | // Give the status of the last SYSEX transmission.
67 | bool midiXparser::isSysExError() { return m_sysExError ;}
68 |
69 | // Used to check if the last byte parsed was captured
70 | bool midiXparser::isByteCaptured() { return m_isByteCaptured; }
71 |
72 | // Check the midi status of a non sysex parsed midi msg
73 | bool midiXparser::isMidiStatus(midiStatusValue midiStatus) {
74 |
75 | if ( m_midiParsedMsgType == noneMsgTypeMsk ) return false; // Only if a parsed msg exists
76 |
77 | // Channel voice msg
78 | if ( m_midiParsedMsgType == channelVoiceMsgTypeMsk ) return ( ( m_midiMsg[0] & 0xF0 ) == (uint8_t)midiStatus ) ;
79 | // System Common msg
80 | if ( m_midiParsedMsgType == systemCommonMsgTypeMsk ) return ( m_midiMsg[0] == (uint8_t)midiStatus ) ;
81 | // realtime msg
82 | if ( m_midiParsedMsgType == realTimeMsgTypeMsk ) return ( m_midiMsgRealTime == (uint8_t)midiStatus) ;
83 |
84 | return false;
85 | }
86 |
87 | // Return the type of the last parsed midi message
88 | uint8_t midiXparser::getMidiMsgType() { return m_midiParsedMsgType; }
89 |
90 | // Return the type of the currently parsed midi message
91 | uint8_t midiXparser::getMidiCurrentMsgType() { return m_midiCurrentMsgType; }
92 |
93 | // Return the type of a midi status (cf enum)
94 | uint8_t midiXparser::getMidiStatusMsgTypeMsk(uint8_t midiStatus) {
95 |
96 | if (midiStatus >= 0xF8 ) return realTimeMsgTypeMsk;
97 | if (midiStatus == 0XF7 || midiStatus == 0xF0 ) return sysExMsgTypeMsk;
98 | if (midiStatus >= 0xF0 ) return systemCommonMsgTypeMsk;
99 | if (midiStatus >= 0x80 ) return channelVoiceMsgTypeMsk;
100 |
101 | return noneMsgTypeMsk ;
102 | }
103 |
104 | // Return the len of the last parsed midi message, including sysex
105 | uint8_t midiXparser::getMidiMsgLen() {
106 | if (m_midiParsedMsgType == sysExMsgTypeMsk ) return getSysExMsgLen() ;
107 | if (m_midiParsedMsgType == realTimeMsgTypeMsk ) return 1 ;
108 | if (m_midiParsedMsgType == channelVoiceMsgTypeMsk ) return m_channelVoiceMsgMsglen[ (getMidiMsg()[0] >> 4) - 8 ] ;
109 | if (m_midiParsedMsgType == systemCommonMsgTypeMsk ) return m_systemCommonMsglen[getMidiMsg()[0] & 0x0F] ;
110 |
111 | return 0;
112 | }
113 |
114 | // Return the len of a midistatus message (cf enum)
115 | // Nb: SOX or EOX return always 0.
116 |
117 | uint8_t midiXparser::getMidiStatusMsgLen(uint8_t midiStatus) {
118 | if (midiStatus >= 0xF8 ) return 1;
119 | if (midiStatus >= 0xF0 ) return m_systemCommonMsglen[midiStatus & 0x0F];
120 | if (midiStatus >= 0x80 ) return m_channelVoiceMsgMsglen[ (midiStatus >> 4) - 8 ];
121 | return 0 ;
122 | }
123 |
124 | // Return the len of the last Sysex msg.
125 | // This persists until the next sysex.
126 | unsigned midiXparser::getSysExMsgLen() { return m_sysExMsgLen ;}
127 |
128 | // Return the parsed message buffered
129 | uint8_t * midiXparser::getMidiMsg() {
130 |
131 | switch (m_midiParsedMsgType) {
132 | case realTimeMsgTypeMsk:
133 | return &m_midiMsgRealTime;
134 | break;
135 | case sysExMsgTypeMsk:
136 | return (uint8_t*) NULL;
137 | break;
138 | }
139 |
140 | return m_midiMsg ;
141 | }
142 |
143 | // Get the last byte parsed
144 | byte midiXparser::getByte() { return m_readByte ;}
145 |
146 | // Set filter mask all/none for all midi Msg including Sysex
147 | // For Sysex, the "on the fly" mode is activated by default
148 | // To change that, you must call explicitly setSysExFilter again.
149 | void midiXparser::setMidiMsgFilter(uint8_t midiMsgTypeFilterMsk) {
150 | m_midiMsgTypeFilterMsk = midiMsgTypeFilterMsk;
151 | }
152 |
153 | //////////////////////////////////////////////////////////////////////////////
154 | // midiXParser MIDI PARSER
155 | //----------------------------------------------------------------------------
156 | // The main method.
157 | // It parses midi byte per byte and return true if a message is matching filters.
158 | // Set also the byte capture flag if a byte belong to a filtered message.
159 | //////////////////////////////////////////////////////////////////////////////
160 | bool midiXparser::parse(byte readByte) {
161 |
162 | // Store the passed byte so it can be sent back to serial
163 | // if not captured
164 | m_readByte = readByte;
165 | m_isByteCaptured = false;
166 | m_sysExError = false; // Clear any previous sysex error
167 |
168 | // MIDI Message status are starting at 0x80
169 | if ( readByte >= 0x80 )
170 | {
171 |
172 | // Check filters.
173 | m_isByteCaptured = (m_midiMsgTypeFilterMsk & getMidiStatusMsgTypeMsk(readByte) );
174 |
175 | // SysEx can be terminated abnormally with a midi status.
176 | // We must check that before applying filters.
177 | if ( m_sysExMode && m_readByte < 0xF7 ) {
178 | m_sysExError = true;
179 | m_sysExMode = false;
180 | m_sysExMsgLen = m_sysExindexMsgLen;
181 | }
182 |
183 | // Real time messages must be processed as transparent for all other status
184 | if ( readByte >= 0xF8 ) {
185 | m_midiParsedMsgType = realTimeMsgTypeMsk;
186 | // NB : m_midiCurrentMsgType can't be used as real time can be mixed with
187 | // channel voice msg.
188 | m_midiMsgRealTime = readByte;
189 | return m_isByteCaptured;
190 | }
191 |
192 | // Running status not possible at this point
193 | m_runningStatusPossible=false;
194 |
195 | // Reset current msg type and msg len
196 | m_midiCurrentMsgType = noneMsgTypeMsk;
197 | m_indexMsgLen = m_expectedMsgLen = 0;
198 |
199 | // Apply filter
200 | if (!m_isByteCaptured) return false;
201 |
202 | // Start SYSEX ---------------------------------------------------------
203 |
204 | // END OF Sysex.
205 | if ( readByte == eoxStatus ) {
206 | m_sysExMsgLen = m_sysExindexMsgLen;
207 | if (m_sysExMode ) {
208 | m_midiParsedMsgType = sysExMsgTypeMsk;
209 | m_sysExMode = false;
210 | return true;
211 | } // Isolated EOX without SOX.
212 | m_sysExMsgLen = 0;
213 | m_sysExError = true;
214 | m_midiCurrentMsgType = sysExMsgTypeMsk;
215 | return false;
216 | }
217 |
218 | // Start SYSEX
219 | if ( readByte == soxStatus ) {
220 | m_sysExMode = true;
221 | m_sysExindexMsgLen = 0;
222 | m_midiCurrentMsgType = sysExMsgTypeMsk;
223 | return false;
224 | }
225 | // Start midi msg ------------------------------------------------------
226 |
227 | // get the len of the midi msg to parse minus status
228 | m_midiMsg[0] = readByte;
229 | m_expectedMsgLen = getMidiStatusMsgLen(readByte) ;
230 | m_indexMsgLen = m_expectedMsgLen - 1;
231 |
232 | // Channel messages between 0x80 and 0xEF -------------------------------
233 | if ( readByte <= 0xEF ) {
234 | m_midiCurrentMsgType = channelVoiceMsgTypeMsk;
235 | }
236 |
237 | // System common messages between 0xF0 and 0xF7 -------------------------
238 | // but SOX / EOX
239 | else {
240 | m_midiCurrentMsgType = systemCommonMsgTypeMsk;
241 | // Case of 1 byte len midi msg (Tune request)
242 | if ( m_indexMsgLen == 0 ) {
243 | m_midiParsedMsgType = m_midiCurrentMsgType;
244 | return true;
245 | }
246 | }
247 | }
248 |
249 | // Midi Data from 00 to 0X7F ----------------------------------------------
250 | else {
251 |
252 | // Capture the SYSEX message if filter is set
253 | // If m_sysExBufferSize is 0, do not store
254 | if (m_sysExMode ) {
255 | m_sysExindexMsgLen++;
256 | m_isByteCaptured = true;
257 | return false;
258 | }
259 |
260 | // "Pure" midi message data
261 | // check if Running status set and if so, generate a true midi channel msg with
262 | // the previous one. Possible only if filters matchs.
263 | if (m_runningStatusPossible) {
264 | m_indexMsgLen = m_expectedMsgLen-1;
265 | m_runningStatusPossible = false;
266 | }
267 |
268 | // Len was set only if filters matched before
269 | if ( m_indexMsgLen ) {
270 |
271 | m_midiMsg[m_expectedMsgLen-m_indexMsgLen] = readByte;
272 | m_isByteCaptured = true;
273 | m_indexMsgLen -- ;
274 | // Message complete ?
275 | // Enable running status if it is a message channel.
276 | if (m_indexMsgLen == 0) {
277 | m_midiParsedMsgType = m_midiCurrentMsgType;
278 | if (m_midiParsedMsgType == channelVoiceMsgTypeMsk) {
279 | m_runningStatusPossible = true;
280 | }
281 | return true;
282 | }
283 | }
284 |
285 | } // Midi data from 00 to 0X7F
286 |
287 | // All other data here are purely ignored.
288 | // In respect of the MIDI specifications.
289 |
290 | return false;
291 | }
292 |
--------------------------------------------------------------------------------
/midiXparser.h:
--------------------------------------------------------------------------------
1 | /*
2 |
3 | midXparser
4 | A small footprint midi parser.
5 | Copyright (C) 2017/2018 by The KikGen labs.
6 |
7 | HEADER CLASS FILE
8 |
9 | Permission to use, copy, modify, distribute, and sell this
10 | software and its documentation for any purpose is hereby granted
11 | without fee, provided that the above copyright notice appear in
12 | all copies and that both that the copyright notice and this
13 | permission notice and warranty disclaimer appear in supporting
14 | documentation, and that the name of the author not be used in
15 | advertising or publicity pertaining to distribution of the
16 | software without specific, written prior permission.
17 |
18 | The author disclaim all warranties with regard to this
19 | software, including all implied warranties of merchantability
20 | and fitness. In no event shall the author be liable for any
21 | special, indirect or consequential damages or any damages
22 | whatsoever resulting from loss of use, data or profits, whether
23 | in an action of contract, negligence or other tortious action,
24 | arising out of or in connection with the use or performance of
25 | this software.
26 |
27 | Licence : GPL V3.
28 | */
29 | #pragma once
30 |
31 | #ifndef midiXparser_h
32 | #define midiXparser_h
33 |
34 | #if ARDUINO
35 | #include
36 | #else
37 | #include
38 | typedef uint8_t byte;
39 | #endif
40 | #include
41 |
42 | class midiXparser {
43 | uint8_t m_midiMsg[3];
44 | uint8_t m_midiMsgRealTime; // Used for real time only
45 | uint8_t m_indexMsgLen = 0;
46 | uint8_t m_expectedMsgLen = 0;
47 | bool m_sysExMode = false;
48 | bool m_sysExError = false;
49 | unsigned m_sysExMsgLen = 0;
50 | unsigned m_sysExindexMsgLen = 0;
51 | bool m_isByteCaptured=false;
52 | byte m_readByte = 0;
53 | bool m_runningStatusPossible=false;
54 | uint8_t m_midiMsgTypeFilterMsk = noneMsgTypeMsk;
55 | uint8_t m_midiParsedMsgType = noneMsgTypeMsk;
56 | uint8_t m_midiCurrentMsgType = noneMsgTypeMsk;
57 |
58 | static const uint8_t m_systemCommonMsglen[8];
59 | static const uint8_t m_channelVoiceMsgMsglen[7];
60 |
61 |
62 |
63 | public:
64 | // Midi messages type
65 | enum midiMsgTypeMaskValue {
66 | noneMsgTypeMsk = 0B0000,
67 | channelVoiceMsgTypeMsk = 0B0001,
68 | systemCommonMsgTypeMsk = 0B0010,
69 | realTimeMsgTypeMsk = 0B0100,
70 | sysExMsgTypeMsk = 0B1000,
71 | allMsgTypeMsk = 0B1111
72 | };
73 |
74 | enum midiStatusValue {
75 | // CHANNEL VOICE
76 | noteOffStatus = 0X80,
77 | noteOnStatus = 0X90,
78 | polyKeyPressureStatus = 0XA0,
79 | controlChangeStatus = 0XB0,
80 | programChangeStatus = 0XC0,
81 | channelPressureStatus = 0XD0,
82 | pitchBendStatus = 0XE0,
83 | // SYSTEM COMMON
84 | soxStatus = 0XF0,
85 | midiTimeCodeStatus = 0XF1,
86 | songPosPointerStatus = 0XF2,
87 | songSelectStatus = 0XF3,
88 | reserved1Status = 0XF4,
89 | reserved2Status = 0XF5,
90 | tuneRequestStatus = 0XF6,
91 | eoxStatus = 0XF7,
92 | // REAL TIME
93 | timingClockStatus = 0XF8,
94 | reserved3Status = 0XF9,
95 | startStatus = 0XFA,
96 | continueStatus = 0XFB,
97 | stopStatus = 0XFC,
98 | reserved4Status = 0XFD,
99 | activeSensingStatus = 0XFE,
100 | systemResetStatus = 0XFF
101 | };
102 |
103 | // Constructor
104 | midiXparser();
105 |
106 | // Methods
107 | bool isSysExMode() ;
108 | bool wasSysExMode() ;
109 | bool isSysExError();
110 | bool isByteCaptured() ;
111 | bool isMidiStatus(midiStatusValue );
112 | uint8_t getMidiMsgType() ;
113 | uint8_t getMidiCurrentMsgType() ;
114 | uint8_t getMidiMsgLen();
115 | uint8_t * getMidiMsg();
116 | byte getByte() ;
117 | unsigned getSysExMsgLen() ;
118 | void setMidiMsgFilter(uint8_t );
119 | bool parse(byte );
120 | static uint8_t getMidiStatusMsgTypeMsk(uint8_t ) ;
121 | static uint8_t getMidiStatusMsgLen(uint8_t );
122 |
123 | };
124 |
125 |
126 |
127 | #endif
128 |
--------------------------------------------------------------------------------