[WebAPI] Midi Support added

[hamishwillee]

Acceptance Criteria

• The listed features are documented sufficiently on MDN
• BCD is updated
• Interactive example and data repos are updated if appropriate
• The content has been reviewed as needed

For folks helping with Firefox related documentation

• Set bugs to dev-doc-complete
• Add entry to Firefox release notes if feature is enabled in release
  or
• Add entry to Firefox experimental features page if feature is not yet enabled in release

Features to document

Related Gecko bugs

• FF97 1748647 - MIDI messages are delivered twice if the same port is opened twice
• FF98 Implement the WebMIDI API
• FF99 Enable WebMIDI (ship bug)

Other

[hamishwillee]

@Rumyra I've converted the WebMidi project notes into this issue. Right now my testing shows that it works on FF60 on windows, which is a bit odd because the implication of the thread is that support should appear in FF97. Anyway, as a result I'm querying what exactly is delivered in https://bugzilla.mozilla.org/show_bug.cgi?id=836897#c117.

Looking at this there are already some docs here: https://developer.mozilla.org/en-US/docs/Web/API/Web_MIDI_API. I expect the task here would be

• BCD
  • FF97 update - Firefox 97 adds support for Web MIDI behind a flag browser-compat-data#14874 (first part, confirming approach OK)
  • FF97 navigator.requestMidiAccess() update FF97 navigator.requestMIDIAccess() supported behind flag browser-compat-data#15152
  • FF99 Secure context - FF99 Navigator.requestMIDIAccess() - add secure context subfeature browser-compat-data#15256
  • FF99 Shipping - FF99 WebMIDI API released browser-compat-data#15257
  • FF is gated by site permission addon - FF WebMIDI gated by permission add on browser-compat-data#15331
  • Chromium secure context info, while we're here: Navigator.requestMIDIAccess - chrome secure context info browser-compat-data#15301
  • FF100 WebMIDI supported (FF99 backed out) browser-compat-data#15610
  • WebMidi in FF preview not FF100 browser-compat-data#16062
• Docs
  • Check spec against documented API to work out if it is complete - update as needed
    • Navigator.requestMidiAccess - Adding navigator.requestMIDIAccess page #13212
    • Fixes for secure_access - Nav requestmidi updates #13479
    • Remove experimental tagging from docs
    • Otherwise looks about right, except that the interfaces returned might be better documented in the properties.
  • Update with a live example (makes testing easier).
  • Maybe add link to this page, which makes a nice test tool: https://blog.karimratib.me/demos/sheetplayer/
• Release notes - Now planned for FF100
• Experimental features - should not be required - at least if this "really" does go in.
• dev-docs-complete - TBD
• Follow on - I did this FF WebMIDI gated by permission add on browser-compat-data#15331 but we should also add info about site permission addons to https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts

[hamishwillee]

Edited. As discussed, I will sort out the BCD, but everything else is for you @Rumyra . Of course you can shift things back to me if you want, and note that at time of writing this is not yet released in FF98. If it is released, not that this won't be for Android or iOS as no backends exist.

[hamishwillee]

@Rumyra OK, BCD for WebMidi for FF97 sorted in mdn/browser-compat-data#14874 - essentially we are considering to have been added "new" on behind a preference (ignoring previous dummy implementation) on FF. FF for android is still false, because a) preferences not set on android, b)there is no android backend.

So in FF98 the plan is that the preference will be removed. When that happens I intend to add a new entry for FF removing the preference. FF for Android will remain false until there is a backend.

Please ping me if you note that this has shipped in FF98 so I can do the next bit.

[Rumyra]

OK @hamishwillee thank you 👍 I'm going to move this to 'In Progress' as I plan to start work on the docs tomorrow

[Rumyra]

@hamishwillee could you update the bcd for navigator.requestMIDIAccess as per 97 above here: https://github.com/mdn/browser-compat-data/blob/main/api/Navigator.json#L3160

• page link (see pr above) files/en-us/web/api/navigator/requestmidiaccess/index.md
• spec link https://webaudio.github.io/web-midi-api/#dom-navigator-requestmidiaccess

[Rumyra]

NB it looks as though this will be rolled into FF99 - I plan to get the docs work done now, but I'll keep my eye on it release info 👍

[hamishwillee]

@Rumyra Excellent. BCD update in mdn/browser-compat-data#15152.

Excellent to get docs done and close this. Then we can start fresh on the release in (hopefully) FF99

[hamishwillee]

@Rumyra Further BCD update in FF99: https://bugzilla.mozilla.org/show_bug.cgi?id=1757153

[Rumyra]

Also https://bugzilla.mozilla.org/show_bug.cgi?id=1752906

[hamishwillee]

FYI @Rumyra

• I've done FF99 BCD work for the release and for adding secure context.
• Updated the docs a bit for secure context: Nav requestmidi updates #13479
• NOT yet removed experimental tagging from docs (but have in BCD). Figure we can wait on BCD before doing this.
• NOT done release note and removed from experimental features.

[Rumyra]

Thanks @hamishwillee :) - I've only just created a pr for the edits to 98 release notes and updating 99 & 100 - so it's probably best to wait for that to go through before updating anyway 👍

[hamishwillee]

Cool. I'm leaving to you, but I'll track the BCD stuff.

[hamishwillee]

@Rumyra Just FYI, and you might already have known this, but access to web midi is gated on a site permission add on. This is something I had not heard of. Some discussion here: https://bugzilla.mozilla.org/show_bug.cgi?id=1752906

[Rumyra]

Yes I am - thanks @hamishwillee - I think I'll tackle the events pages first (move to new format) but I want to update the api landing page - which I think will be a good page to explain this 👍

[Rumyra]

This is mostly done - I just need to go through each page & remove any experimental notes & add rel note

In regards to the list above:

Update with a live example (makes testing easier)

I don't think a live example would be useful here - the reader would need a midi device for it to make any sense.

Maybe add link to this page, which makes a nice test tool: https://blog.karimratib.me/demos/sheetplayer/

This doesn't actually use this api - Web MIDI just supports inputs from MIDI devices not the file format.

[Rumyra]

Looks like this is getting pushed to FF100 - I'll check properly tomorrow

[hamishwillee]

@Rumyra You were right https://bugzilla.mozilla.org/show_bug.cgi?id=1752906#c30 - FF100.

BCD updated -mdn/browser-compat-data#15610 - I am assuming you will let me know if anything more is required of me on this one :-)

[Rumyra]

Amazing @hamishwillee - that was precisely the thing that was needed. Luckily I hadn't done the rel note yet so I'll just push the few last tasks for this to this coming month 👍

[Rumyra]

Update! This is going into 'beta or earlier' which means it's in beta and nightly where it will stay until ready (which I'm sure might not be long, but also won't be 100 & possibly not 101 see https://bugzilla.mozilla.org/show_bug.cgi?id=1765894 ). I guess there's no way in bcd to have that kind of info as it needs a release number - unless we add a note. Happy for thoughts @hamishwillee @queengooborg

[queengooborg]

BCD actually does have a way to represent this! We added "preview" as a possible value for the version, which means "available in beta/nightly".

[hamishwillee]

Yes, BCD fixed in mdn/browser-compat-data#16062

[Rumyra]

Star @hamishwillee thank you!

[Rumyra]

I'm going to add a note to the Experiemental Features page which will mean the work on this is primarily done - we can add a release note when it comes out of preview 👍

[Rumyra]

Still on hold so closing and will re-open once it comes around again 👍