Media Debugging Tips: Difference between revisions

Media Debugging Tips (view source)

Revision as of 21:14, 31 July 2023

2,486 bytes added , 31 July 2023

edits drm

Jmathies

Confirmed users

1,982

edits

@@ Line 61: / Line 61: @@
 For DRM content (Amazon Prime, Netflix) it can be helpful to generate EME related logging. The steps to produce these logs are bit more involved compared to basic media playback logging but are worth the effort when tracking down these types of issues. Try these steps:<br/>
-) Open a command console and browse to your install location for Firefox.<br/>
+The 'GMP' and 'EME' moz log modules are useful when debugging streaming service  related issues. Generating these logs is a bit involved though.
-) Enter 'set MOZ_DISABLE_GMP_SANDBOX=1' in the console<br/>
-) Launch Firefox from the command console (firefox.exe (return))<br/>
-) In the browser, open a tab and visit about:logging<br/>
-) Enter 'GMP:5,EME:5' in the 'new log modules' text edit and click on 'Set Log Modules'<br/>
-) Under Output choose 'Logging to a file' and choose a suitable temp path and then click 'Set Log File'.<br/>
+Logs are generated for both the browser and gmp child processes. When debugging on Windows, the gmp sandbox needs to be disabled for the logging feature to access the file system (see below).
+<br/>
+Platform Specifics
+* On Windows, Firefox will install by default under C:\Program Files\Firefox Nightly.
+General testing setup steps -
+<br/>
+# Install Firefox Nightly on the test device and open the browser. The test device should be a clean system that has not had Firefox installed on it prior. If the test device does have existing Firefox installs, open Firefox Nightly using the command line console and use the -p command line parameter. This will open the profile manager window. Create a new profile for testing purposes, which can be deleted after testing is complete. On Mac, …<br/>On Linux, …<br/>
+# Once Firefox is open and running in a clean profile, check for browser updates via the Help menu -> About option. If there are browser updates available, apply them and then restart the browser.
+# Once Firefox is open and running in a clean profile with updates applied, open a tab and visit https://profiler.firefox.com/ and enable the Firefox Profiler Button. In the dropdown menu on the button, select the 'Media' setting. Close Firefox Nightly. (For general information on how to use the profiler, visit the documentation site.)
+Generating a Firefox Profile with logs -
+<br/>
+# Open a command line console and browse to the install location for Firefox Nightly.
+# On Windows, enter 'set MOZ_DISABLE_GMP_SANDBOX=1'(return)
+# Launch Firefox using a clean profile from the command console (firefox.exe (return) or firefox.exe -p (return))
+In the browser, open a tab and view about:logging
+# Enter 'timestamp,sync,GMP:5,EME:5' in the 'new log modules' text edit and click on 'Set Log Modules'
+# Under Output choose 'Logging to the Firefox Profiler' and check the 'Enable stack traces for log messages' checkbox.
+# Open an additional tab and visit a Widevine test site (http://shaka-player-demo.appspot.com/) or log into a streaming provider like Netflix.
+# In about:logging, click the 'Start Logging' button, then click the Firefox Profiler toolbar button to start recording. (The button should highlight when a recording is taking place.)
+# Return to the test site and play a stream past a point where the issue occurs.
+# Close the test tab, and click the Firefox Profiler toolbar button to stop recording.
+# Wait approximately 10 - 20 seconds for a new tab to open containing the profile.
+# Within the profiler tab click the 'upload local p[rofile' button on the upper right side of the tab. Once the upload is complete, a drop down menu will open displaying the URL of the profile. Select this text and copy it.
+# Share the URL of the profile for analysis with the engineer you are working with.
 In the temp dir, you should get two logs (something like 'emelog.txt-child.23884.moz_log' and 'emelog.txt-main.23435.moz_log'). Post these to your Bugzilla report.