documentation tweaks (OR->AND, and comments on MIDI event ordering)

git-svn-id: svn+ssh://jackaudio.org/trunk/jack@4052 0c269be4-1314-0410-8aa9-9f06e86f4224

configure.ac

@@ -61,8 +61,8 @@ dnl micro version = incremented when implementation-only
 dnl                 changes are made
 dnl ---
 JACK_MAJOR_VERSION=0
-JACK_MINOR_VERSION=119
-JACK_MICRO_VERSION=0
+JACK_MINOR_VERSION=120
+JACK_MICRO_VERSION=1
 
 dnl ---
 dnl HOWTO: updating the jack protocol version

drivers/a2j/Makefile.am

@@ -14,4 +14,3 @@ a2j_in_la_LDFLAGS = -module -avoid-version @OS_LDFLAGS@
 a2j_in_la_SOURCES = input_client.c $(a2j_common_sources)
 
 noinst_HEADERS = a2j.h list.h port.h port_hash.h port_thread.h
-

jack/midiport.h

@@ -106,6 +106,10 @@ jack_midi_max_event_size(void* port_buffer) JACK_OPTIONAL_WEAK_EXPORT;
  * messages interspersed with other messages (realtime messages are fine
  * when they occur on their own, like other messages).
  *
+ * Events must be written in order, sorted by their sample offsets.
+ * JACK will not sort the events for you, and will refuse to store 
+ * out-of-order events.
+ *
  * @param port_buffer Buffer to write event to.
  * @param time Sample offset of event.
  * @param data_size Length of event's raw data in bytes.
@@ -122,8 +126,17 @@ jack_midi_event_reserve(void           *port_buffer,
  *
  * This function is simply a wrapper for @ref jack_midi_event_reserve
  * which writes the event data into the space reserved in the buffer.
- * The same restrictions on the MIDI data apply.
- * 
+ *
+ * Clients must not write more than
+ * @a data_size bytes into this buffer.  Clients must write normalised
+ * MIDI data to the port - no running status and no (1-byte) realtime
+ * messages interspersed with other messages (realtime messages are fine
+ * when they occur on their own, like other messages).
+ *
+ * Events must be written in order, sorted by their sample offsets.
+ * JACK will not sort the events for you, and will refuse to store 
+ * out-of-order events.
+ *
  * @param port_buffer Buffer to write event to.
  * @param time Sample offset of event.
  * @param data Message data to be written.

jack/types.h

@@ -384,7 +384,7 @@ typedef void (*JackInfoShutdownCallback)(jack_status_t code, const char* reason,
 typedef float jack_default_audio_sample_t;
 
 /**
- *  A port has a set of flags that are formed by OR-ing together the
+ *  A port has a set of flags that are formed by AND-ing together the
  *  desired values from the list below. The flags "JackPortIsInput" and
  *  "JackPortIsOutput" are mutually exclusive and it is an error to use
  *  them both.

libjack/port.c

@@ -577,6 +577,7 @@ jack_port_type_buffer_size (jack_port_type_info_t* port_type_info, jack_nframes_
 		* sizeof (jack_default_audio_sample_t)
 		* nframes;
 }
+
 int
 jack_port_tie (jack_port_t *src, jack_port_t *dst)