search

jussi-kalliokoski / webmidi-issues

A test repo for importing the issues from bugzilla
0 stars 0 forks source link

MIDI API naming #38

Closed jussi-kalliokoski closed 11 years ago

jussi-kalliokoski commented 11 years ago

Originally reported on W3C Bugzilla ISSUE-17724 Mon, 09 Jul 2012 17:55:32 GMT Reported by Jussi Kalliokoski Assigned to This bug has no owner yet - up for the taking

Currently, we have MIDIDevice, MIDIInputDevice and MIDIOutputDevice which can be misleading as they don't necessarily relate to devices per se, but instead they can be just MIDI ports of a single device. There has been quite a lot of discussion about this on the list. (Maybe someone/me can add links later, I'm a bit in a hurry now)

I was thinking about simplifying this a bit; At first I thought about renaming MIDIDevice to MIDIInterface, but that can be misleading as well, because you can have multiple ports in a single interface, and sometimes MIDI controllers are referred to as MIDI interfaces. Hence I'd suggest the following:

MIDIDevice -> MIDIPort MIDIInputDevice -> MIDIInput MIDIOutputDevice -> MIDIOutput

Also, Dom pointed out that the 'device' prefix in the properties of the MIDIDevice interface may be redundant, so I'd suggest we drop that as well.

jussi-kalliokoski commented 11 years ago

Original comment by Chris Wilson on W3C Bugzilla. Tue, 10 Jul 2012 22:45:38 GMT

I think this might help clear up some confusion. I would suggest keeping "Port" as part of the name for the input and output ports, i.e.:

MIDIDevice -> MIDIPort MIDIInputDevice -> MIDIInputPort MIDIOutputDevice -> MIDIOutputPort

jussi-kalliokoski commented 11 years ago

Original comment by Jussi Kalliokoski on W3C Bugzilla. Sun, 12 Aug 2012 14:47:32 GMT

(In reply to comment #1)

I think this might help clear up some confusion. I would suggest keeping "Port" as part of the name for the input and output ports, i.e.:

MIDIDevice -> MIDIPort MIDIInputDevice -> MIDIInputPort MIDIOutputDevice -> MIDIOutputPort

Hmm, I decided to drop the "Port" suffix anyway as a MIDIInput/MIDIOutput can't really be anything other than a port in this case. Changes applied in: https://dvcs.w3.org/hg/audio/rev/df28ddef0c73

jussi-kalliokoski commented 11 years ago

Original comment by Jussi Kalliokoski on W3C Bugzilla. Sun, 12 Aug 2012 15:04:00 GMT

"device" prefixes removed:

(I forgot to include deviceType at the first attempt ;)

jussi-kalliokoski commented 11 years ago

Original comment by Olivier Thereaux on W3C Bugzilla. Mon, 13 Aug 2012 09:17:48 GMT

Sounds uncontroversial.

Marking as FIXED, will close within a week if there is no objection.

jussi-kalliokoski commented 11 years ago

Original comment by Chris Wilson on W3C Bugzilla. Mon, 13 Aug 2012 18:12:26 GMT

(In reply to comment #4)

Sounds uncontroversial.

Marking as FIXED, will close within a week if there is no objection.

I'm still not a fan of this naming. "MIDIInput" could be a representation of a port, it could be a buffer of data, ... I still think it is clearer if "Port" is appended on the Input and Output types. Do we have other examples of how types are described from elsewhere in the platform?

jussi-kalliokoski commented 11 years ago

Original comment by Chris Wilson on W3C Bugzilla. Wed, 17 Oct 2012 23:45:29 GMT

I withdraw my object.

jussi-kalliokoski commented 11 years ago

Original comment by Olivier Thereaux on W3C Bugzilla. Thu, 15 Nov 2012 08:27:48 GMT

(In reply to comment #6)

I withdraw my object.

Anything in particular convinced you?

It now seems we have reached consensus with no other objection in almost a month. Closing.

jussi-kalliokoski commented 11 years ago

Original comment by Chris Wilson on W3C Bugzilla. Thu, 15 Nov 2012 17:24:25 GMT

(In reply to comment #7)

(In reply to comment #6)

I withdraw my object.

Anything in particular convinced you?

Looking at it in practice, it's not quite as bad as I thought it would be. Still not my preferred pattern, but not worth fighting for alone.