1 /*
2   ==============================================================================
3 
4    This file is part of the JUCE library.
5    Copyright (c) 2020 - Raw Material Software Limited
6 
7    JUCE is an open source library subject to commercial or open-source
8    licensing.
9 
10    The code included in this file is provided under the terms of the ISC license
11    http://www.isc.org/downloads/software-support-policy/isc-license. Permission
12    To use, copy, modify, and/or distribute this software for any purpose with or
13    without fee is hereby granted provided that the above copyright notice and
14    this permission notice appear in all copies.
15 
16    JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
17    EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
18    DISCLAIMED.
19 
20   ==============================================================================
21 */
22 
23 namespace juce
24 {
25 
26 //==============================================================================
27 /**
28     This helper class contains the necessary helper functions to generate
29     MIDI messages that are exclusive to MPE, such as defining the upper and lower
30     MPE zones and setting per-note and master pitchbend ranges.
31     You can then send them to your MPE device using MidiOutput::sendBlockOfMessagesNow.
32 
33     All other MPE messages like per-note pitchbend, pressure, and third
34     dimension, are ordinary MIDI messages that should be created using the MidiMessage
35     class instead. You just need to take care to send them to the appropriate
36     per-note MIDI channel.
37 
38     Note: If you are working with an MPEZoneLayout object inside your app,
39     you should not use the message sequences provided here. Instead, you should
40     change the zone layout programmatically with the member functions provided in the
41     MPEZoneLayout class itself. You should also make sure that the Expressive
42     MIDI zone layout of your C++ code and of the MPE device are kept in sync.
43 
44     @see MidiMessage, MPEZoneLayout
45 
46     @tags{Audio}
47 */
48 class JUCE_API  MPEMessages
49 {
50 public:
51     /** Returns the sequence of MIDI messages that, if sent to an Expressive
52         MIDI device, will set the lower MPE zone.
53     */
54     static MidiBuffer setLowerZone (int numMemberChannels = 0,
55                                     int perNotePitchbendRange = 48,
56                                     int masterPitchbendRange = 2);
57 
58     /** Returns the sequence of MIDI messages that, if sent to an Expressive
59         MIDI device, will set the upper MPE zone.
60     */
61     static MidiBuffer setUpperZone (int numMemberChannels = 0,
62                                     int perNotePitchbendRange = 48,
63                                     int masterPitchbendRange = 2);
64 
65     /** Returns the sequence of MIDI messages that, if sent to an Expressive
66         MIDI device, will set the per-note pitchbend range of the lower MPE zone.
67     */
68     static MidiBuffer setLowerZonePerNotePitchbendRange (int perNotePitchbendRange = 48);
69 
70     /** Returns the sequence of MIDI messages that, if sent to an Expressive
71         MIDI device, will set the per-note pitchbend range of the upper MPE zone.
72     */
73     static MidiBuffer setUpperZonePerNotePitchbendRange (int perNotePitchbendRange = 48);
74 
75     /** Returns the sequence of MIDI messages that, if sent to an Expressive
76         MIDI device, will set the master pitchbend range of the lower MPE zone.
77     */
78     static MidiBuffer setLowerZoneMasterPitchbendRange (int masterPitchbendRange = 2);
79 
80     /** Returns the sequence of MIDI messages that, if sent to an Expressive
81         MIDI device, will set the master pitchbend range of the upper MPE zone.
82     */
83     static MidiBuffer setUpperZoneMasterPitchbendRange (int masterPitchbendRange = 2);
84 
85     /** Returns the sequence of MIDI messages that, if sent to an Expressive
86         MIDI device, will clear the lower zone.
87     */
88     static MidiBuffer clearLowerZone();
89 
90     /** Returns the sequence of MIDI messages that, if sent to an Expressive
91         MIDI device, will clear the upper zone.
92     */
93     static MidiBuffer clearUpperZone();
94 
95     /** Returns the sequence of MIDI messages that, if sent to an Expressive
96         MIDI device, will clear the lower and upper zones.
97     */
98     static MidiBuffer clearAllZones();
99 
100     /** Returns the sequence of MIDI messages that, if sent to an Expressive
101         MIDI device, will reset the whole MPE zone layout of the
102         device to the layout passed in. This will first clear the current lower and upper
103         zones, then then set the zones contained in the passed-in zone layout, and set their
104         per-note and master pitchbend ranges to their current values.
105     */
106     static MidiBuffer setZoneLayout (MPEZoneLayout layout);
107 
108     /** The RPN number used for MPE zone layout messages.
109 
110         Pitchbend range messages (both per-note and master) are instead sent
111         on RPN 0 as in standard MIDI 1.0.
112     */
113     static const int zoneLayoutMessagesRpnNumber = 6;
114 };
115 
116 } // namespace juce
117