<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!DOCTYPE bugzilla SYSTEM "https://www.w3.org/Bugs/Public/page.cgi?id=bugzilla.dtd">

<bugzilla version="5.0.4"
          urlbase="https://www.w3.org/Bugs/Public/"
          
          maintainer="sysbot+bugzilla@w3.org"
>

    <bug>
          <bug_id>17724</bug_id>
          
          <creation_ts>2012-07-09 17:55:32 +0000</creation_ts>
          <short_desc>MIDI API naming</short_desc>
          <delta_ts>2012-11-15 17:24:25 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>1</classification_id>
          <classification>Unclassified</classification>
          <product>AudioWG</product>
          <component>MIDI API</component>
          <version>unspecified</version>
          <rep_platform>PC</rep_platform>
          <op_sys>Linux</op_sys>
          <bug_status>CLOSED</bug_status>
          <resolution>FIXED</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard></status_whiteboard>
          <keywords></keywords>
          <priority>P2</priority>
          <bug_severity>normal</bug_severity>
          <target_milestone>TBD</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Jussi Kalliokoski">jussi.kalliokoski</reporter>
          <assigned_to name="This bug has no owner yet - up for the taking">dave.null</assigned_to>
          <cc>cwilso</cc>
    
    <cc>olivier.thereaux</cc>
          
          <qa_contact>public-audio</qa_contact>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>69741</commentid>
    <comment_count>0</comment_count>
    <who name="Jussi Kalliokoski">jussi.kalliokoski</who>
    <bug_when>2012-07-09 17:55:32 +0000</bug_when>
    <thetext>Currently, we have MIDIDevice, MIDIInputDevice and MIDIOutputDevice which can be misleading as they don&apos;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&apos;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&apos;d suggest the following:

MIDIDevice -&gt; MIDIPort
MIDIInputDevice -&gt; MIDIInput
MIDIOutputDevice -&gt; MIDIOutput

Also, Dom pointed out that the &apos;device&apos; prefix in the properties of the MIDIDevice interface may be redundant, so I&apos;d suggest we drop that as well.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>69818</commentid>
    <comment_count>1</comment_count>
    <who name="Chris Wilson">cwilso</who>
    <bug_when>2012-07-10 22:45:38 +0000</bug_when>
    <thetext>I think this might help clear up some confusion.  I would suggest keeping &quot;Port&quot; as part of the name for the input and output ports, i.e.:

MIDIDevice -&gt; MIDIPort
MIDIInputDevice -&gt; MIDIInputPort
MIDIOutputDevice -&gt; MIDIOutputPort</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>72086</commentid>
    <comment_count>2</comment_count>
    <who name="Jussi Kalliokoski">jussi.kalliokoski</who>
    <bug_when>2012-08-12 14:47:32 +0000</bug_when>
    <thetext>(In reply to comment #1)
&gt; I think this might help clear up some confusion.  I would suggest keeping
&gt; &quot;Port&quot; as part of the name for the input and output ports, i.e.:
&gt; 
&gt; MIDIDevice -&gt; MIDIPort
&gt; MIDIInputDevice -&gt; MIDIInputPort
&gt; MIDIOutputDevice -&gt; MIDIOutputPort

Hmm, I decided to drop the &quot;Port&quot; suffix anyway as a MIDIInput/MIDIOutput can&apos;t really be anything other than a port in this case. Changes applied in: https://dvcs.w3.org/hg/audio/rev/df28ddef0c73</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>72087</commentid>
    <comment_count>3</comment_count>
    <who name="Jussi Kalliokoski">jussi.kalliokoski</who>
    <bug_when>2012-08-12 15:04:00 +0000</bug_when>
    <thetext>&quot;device&quot; prefixes removed:
 * https://dvcs.w3.org/hg/audio/rev/8a31db30feb2
 * https://dvcs.w3.org/hg/audio/rev/6e7e48ed2d82

(I forgot to include deviceType at the first attempt ;)</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>72112</commentid>
    <comment_count>4</comment_count>
    <who name="Olivier Thereaux">olivier.thereaux</who>
    <bug_when>2012-08-13 09:17:48 +0000</bug_when>
    <thetext>Sounds uncontroversial. 

Marking as FIXED, will close within a week if there is no objection.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>72137</commentid>
    <comment_count>5</comment_count>
    <who name="Chris Wilson">cwilso</who>
    <bug_when>2012-08-13 18:12:26 +0000</bug_when>
    <thetext>(In reply to comment #4)
&gt; Sounds uncontroversial. 
&gt; 
&gt; Marking as FIXED, will close within a week if there is no objection.

I&apos;m still not a fan of this naming.  &quot;MIDIInput&quot; could be a representation of a port, it could be a buffer of data, ... I still think it is clearer if &quot;Port&quot; is appended on the Input and Output types.  Do we have other examples of how types are described from elsewhere in the platform?</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>76541</commentid>
    <comment_count>6</comment_count>
    <who name="Chris Wilson">cwilso</who>
    <bug_when>2012-10-17 23:45:29 +0000</bug_when>
    <thetext>I withdraw my object.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>78343</commentid>
    <comment_count>7</comment_count>
    <who name="Olivier Thereaux">olivier.thereaux</who>
    <bug_when>2012-11-15 08:27:48 +0000</bug_when>
    <thetext>(In reply to comment #6)
&gt; 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.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>78362</commentid>
    <comment_count>8</comment_count>
    <who name="Chris Wilson">cwilso</who>
    <bug_when>2012-11-15 17:24:25 +0000</bug_when>
    <thetext>(In reply to comment #7)
&gt; (In reply to comment #6)
&gt; &gt; I withdraw my object.
&gt; 
&gt; Anything in particular convinced you? 

Looking at it in practice, it&apos;s not quite as bad as I thought it would be.  Still not my preferred pattern, but not worth fighting for alone.</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>