1251202 - Implement Default Audio Device Notifications for NPAPI plugins on Windows.

Status: RESOLVED FIXED

(Core Graveyard :: Plug-ins, enhancement, P2)

Description

[Bob Owen (:bobowen)]

Implement:

https://wiki.mozilla.org/NPAPI:DefaultAudioDeviceNotification

This proposal is to allow plugins instances that are running within a low integrity process on Windows 10 to still receive default audio device notifications.

Comment 1

[Kenneth Kim]

Would like to request status update and an ETA for this feature, if available.

Comment 2

[Chris Peterson [:cpeterson]]

Setting priority P2 because this bug blocks P2 bug 1253261.

Comment 3

[David Parks [:handyman]]

Attachment: npaudiotest.zip: Plugin that tests the default audio callbacks

This plugin logs default audio events that it receives using the API spec'ed here: https://wiki.mozilla.org/NPAPI:DefaultAudioDeviceNotification

Written as an STR:

0. Install this test plugin by building npaudiotest.sln to generate npaudiotest.dll or simply copying ntaudiotest.dll (a debug build) from the zip archive.  Place the dll in your profile's plugins folder.  (Press <WindowsKey>-R and enter %appdata%\Mozilla\Firefox\Profiles\ -- then find the relevant profile folder and access or create a 'plugins' subfolder there).

1. Launch Firefox 32-bit from the command line.

2. Open test.html (from the zip archive) in the browser.

3. Insert/remove a device that changes the default audio - e.g. a USB microphone.

EXPECTED RESULT:

The plugin will log the details of the new audio device to the console.

ACTUAL RESULT:

Nothing since the API isn't implemented.

---------------------

The plugin just printfs the default audio device changes to the console.  In order to see it register/unregister with the OS for these notifications, you need to turn on more logging.  Run Firefox with the log environment variable set for plugins:

MOZ_LOG=IPCPlugins:4,plugin:4

When the plugin starts, it logs a message like this:

[Main Thread]: D/IPCPlugins Registered for plugin audio device notification.

When the OS generates a new audio device notification, Firefox logs a message like this:

[Main Thread]: D/IPCPlugins Notifying 1 plugins of audio device change.

And the plugin itself writes a message like this:

NPAUDIOTEST: Received Default Audio Device Change Notification: (0,0,{0.0.0.00000000}.{df007fef-8548-4c8c-8b37-8903d2c5e0cd})

Finally, when the plugin is unregistered, we get a message like this:

[Main Thread]: D/IPCPlugins Unregistering for plugin audio device notification.

Comment 4

[David Parks [:handyman]]

Attachment: Implement default audio notification spec

(Bob, maybe another reviewer is appropriate as you already have one from me...?)

This implements the API.  Rather than bounce the message to the content process via the PluginInstanceParent/Child, it sends it to the chrome proc using the PluginModuleParent/Child.  This is because we may not want audio on the content proc in the future.

TESTS:
https://treeherder.mozilla.org/#/jobs?repo=try&revision=b5e38f20429b


Each interested plugin instance registers with its PluginModuleChild in its plugin process.  When the PMC has greater-than-zero registered instances, it tells its PluginModuleParent to register with a singleton that monitors the audio devices.  When no instances are registered then the singleton is destroyed to avoid overheard, as written in the spec.

Comment 5

[Jim Mathies [:jimm]]

Comment on attachment 8792549 [details] [diff] [review]
Implement default audio notification spec

Review of attachment 8792549 [details] [diff] [review]:
-----------------------------------------------------------------

::: dom/plugins/ipc/PluginInstanceChild.cpp
@@ +885,5 @@
> +    if (!mPluginIface->setvalue) {
> +        return NPERR_GENERIC_ERROR;
> +    }
> +    return mPluginIface->setvalue(GetNPP(), NPNVaudioDeviceChangeDetails, (void*)&details);
> +    NS_RUNTIMEABORT("NPP_SetValue_NPNVaudioDeviceChangeDetails is a Windows-only message");

nit - missing an #else here for other platforms

::: dom/plugins/ipc/PluginModuleChild.cpp
@@ +2571,5 @@
> +                          PluginInstanceChild* aInstance,
> +                          NPBool aShouldRegister)
> +{
> +#ifdef XP_WIN
> +  // Maintain a set of PluginInstanceChildren that we need to tell when the

nit - this file is double spaced indent

::: dom/plugins/ipc/PluginUtilsWin.cpp
@@ +89,5 @@
> +
> +    // Make sure that plugin is notified on the main thread.
> +    RefPtr<AudioDeviceChangedRunnable> runnable =
> +      new AudioDeviceChangedRunnable(&mAudioNotificationSet, changeDetails);
> +    NS_DispatchToMainThread(runnable);

do we expect this to show up on non main threads?

@@ +162,5 @@
> +    mIsRegistered = false;
> +  }
> +
> +  /*
> +   * True iff the notification server is set to report events to this object.

nit - iff

Comment 6

[David Parks [:handyman]]

Attachment: Implement default audio notification spec (r+ by jimm)

r+ed in comment 5
tests in comment 4

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/e7b723418cf1
Implement Default Audio Device Notifications for NPAPI plugins on Windows. r=jimm

Comment 8

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/e7b723418cf1

Comment 9

[Chris Peterson [:cpeterson]]

Adobe confirmed that Audio Device Notifications support will ship in the Flash Player's March release ("Webster").

Comment 12

[u534134]

Murch 2017?
No fast time Adobe. When will be an alternative to exclude Flash from the web?

Too much issue with Firefox recently and bugs take long time before be solved. 3 month in this case.

Comment 13

[u534134]

In Chrome all works fine. Seems user has to stop to use Firefox. In the last year many Flash issues and Firefox. The solution was always to use Chrome.

Is Adobe that have interest on made a working flash only on Chrome or is Firefox the issue for Adobe as they seems have many issue on Firefox and long, long time before BUGS are fixed?

I have to wait from now to march for can record online in flash application?
No word.

Always issue with Flash and Firefox, I love Firefox and I AM sad to see the solution all the time is to use Chrome because in Firefox long Flash bug time before a fix is released.

Is Firefox or is Adobe the problem?
I do not know.

Comment 14

[Chris Peterson [:cpeterson]]

(In reply to Marco from comment #13)
> I have to wait from now to march for can record online in flash application?

This microphone bug only affects 64-bit Firefox and Flash. In the meantime, you can 32-bit Firefox and Flash.