Confirmed users
1,982
edits
Media Debugging Tips: Difference between revisions
m
→Basic Media Playback Issues
m (clarify steps / formatting) |
|||
| (12 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
= Diagnosing and Reporting Media Playback Issues in Firefox = | = Diagnosing and Reporting Media Playback Issues in Firefox = | ||
== Basic Media Playback Issues == | == Reporting Basic Media Playback Issues == | ||
For starters, file a [https://bugzilla.mozilla.org/enter_bug.cgi?product=Core&component=Audio%2FVideo bug report] in Bugzilla describing the issue you've run into. Please include a URL to or sample of the audio or video you're experiencing issues with. | For starters, file a [https://bugzilla.mozilla.org/enter_bug.cgi?product=Core&component=Audio%2FVideo bug report] in Bugzilla describing the issue you've run into. Please include a URL to or sample of the audio or video you're experiencing issues with. Also please check the [https://firefox-source-docs.mozilla.org/devtools-user/web_console/ web developer console] for error messages related to media format issues. If you see messages here related to media playback errors, please add this information to your bug report. | ||
'''Share Your about:support Text''' | |||
# Open a tab and visit about:support | |||
# Click 'Copy Text to Clipboard' | |||
# Paste this text in your Bugzilla bug comment and post. | |||
When filing a Bugzilla bug, please post your about:support text. This provides a great deal of information about your graphics hardware, video hardware support, and much more. | When filing a Bugzilla bug, please post your about:support text. This provides a great deal of information about your graphics hardware, video hardware support, and much more. | ||
== Acceleration Support for Media == | |||
[[File:Hardware support information.png|thumb|center]] | |||
Currently you can inspect hardware acceleration support using [[about:support]] information. Page down to the Media section and check the 'Codec Support Information' section. If you feel this information does not reflect the capabilities of your device, please file a bug and include your about:support text. | |||
== Playback Performance Issues == | == Playback Performance Issues == | ||
| Line 22: | Line 27: | ||
==== Profiler Quick Start ==== | ==== Profiler Quick Start ==== | ||
# Visit https://profiler.firefox.com/ and enable the Profiler toolbar button. | |||
# Click the toolbar button down arrow and select 'Media' in the Settings drop down. | |||
# Open a tab and visit the page with the affected media content. | |||
# Click the Profiler toolbar main button to start recording. | |||
# Play the media until the issue you are seeing manifests. | |||
# Click the Profiler toolbar button again to stop recording. | |||
# When a new Profile tab opens, click the upload profile button on the upper right. | |||
# Copy the resulting profile URL and post this to your Bugzilla report. | |||
=== Youtube Stats For Nerds === | === Youtube Stats For Nerds === | ||
| Line 58: | Line 63: | ||
# Install [https://www.mozilla.org/en-US/firefox/channel/desktop/ 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 and open about:profiles. Create a [https://support.mozilla.org/en-US/kb/profile-manager-create-remove-switch-firefox-profiles new profile for testing purposes], and launch a browser using this profile. | # Install [https://www.mozilla.org/en-US/firefox/channel/desktop/ 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 and open about:profiles. Create a [https://support.mozilla.org/en-US/kb/profile-manager-create-remove-switch-firefox-profiles new profile for testing purposes], and launch a browser using this profile. | ||
# 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 Nightly 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. | # Once Firefox Nightly 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. For general information on how to use the profiler, visit the [https://profiler.firefox.com/docs/#/ Profiler documentation site]. | ||
'''Generating a Firefox Performance Profile with media logs''' | '''Generating a Firefox Performance Profile with media logs''' | ||
# Launch Firefox | # Launch Firefox with a clean profile. Use about:profiles for existing installs (see above). | ||
# | # In Firefox, open a tab and view <b>about:logging</b>. | ||
# In the 'Logging preset:' drop down select 'Media Playback' | # In the 'Logging preset:' drop down select 'Media Playback' | ||
# Click 'Start Logging' | # Click the 'Start Logging' button. (You are now recording a profile, the profiler toolbar toggle button should be selected automatically.) | ||
# Open a new tab for testing and view the media you are having an issue with. (After reproducing, DO NOT close this test tab yet.) | # Open a new tab for testing and view the media you are having an issue with. (After reproducing, <b>DO NOT</b> close this test tab yet.) | ||
# | # Switch to the about:logging tab, click 'Stop logging', and then close the test tab. | ||
# Within the profiler tab click the 'upload local profile' button | # Wait approximately 10 - 20 seconds for a new tab to automatically open containing the generated performance profile. | ||
# Within the upper-right side of the profiler tab click the 'upload local profile' button to initiate profile upload. Once the upload is complete, a drop down text edit 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. | # Share the URL of the profile for analysis with the engineer you are working with. | ||
| Line 76: | Line 81: | ||
=== Gecko Media Plugin Logging Collection === | === Gecko Media Plugin Logging Collection === | ||
For DRM content (Amazon | For DRM content playback issues (example sites: Amazon Video, Disney+, Hulu, Netflix, Spotify) it can be helpful to generate Encrypted Media Extensions (EME) related logging. EME logs are generated for the web page and the secure Gecko Media Plugin (GMP) module that handles DRM licensing and decryption. | ||
The steps to produce these logs are bit more involved compared to basic media playback logging but are worth the effort when tracking down DRM related issues. | |||
'''General testing setup steps''' | '''General testing setup steps''' | ||
# Install [https://www.mozilla.org/en-US/firefox/channel/desktop/ 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 and open about:profiles. Create a [https://support.mozilla.org/en-US/kb/profile-manager-create-remove-switch-firefox-profiles new profile for testing purposes], and launch a browser using this profile. | # Install [https://www.mozilla.org/en-US/firefox/channel/desktop/ 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 and open about:profiles. Create a [https://support.mozilla.org/en-US/kb/profile-manager-create-remove-switch-firefox-profiles new profile for testing purposes], and launch a browser using this profile. | ||
# 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 Nightly 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. For general information on how to use the profiler, visit the documentation site. | # Once Firefox Nightly 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. For general information on how to use the profiler, visit the [https://profiler.firefox.com/docs/#/ Profiler documentation site]. | ||
'''Generating a Firefox Profile with logs''' | '''Generating a Firefox Profile with logs''' | ||
# Launch Firefox | # Launch Firefox with a clean profile. Use about:profiles for existing installs (see above). | ||
# In | # In Firefox, open a tab and view <b>about:config</b>. | ||
# Enter <b>media.gmp.use-minimal-xpcom</b> in the upper edit, select the corresponding pref below, and set the pref value to <b>True</b>. | # Enter <b>media.gmp.use-minimal-xpcom</b> in the upper edit, select the corresponding pref below, and set the pref value to <b>True</b>. | ||
# Close the about:config tab | # Close the about:config tab and close Firefox. | ||
# Launch Firefox again using the same profile. | # Launch Firefox again using the same profile. | ||
# In | # In Firefox, open a tab and view <b>about:logging</b>. | ||
# Enter <b>timestamp,sync,GMP:5,EME:5</b> to the 'new log modules' text and click on 'Set Log Modules'. | # Enter <b>timestamp,sync,GMP:5,EME:5</b> to the 'new log modules' text and click on 'Set Log Modules'. | ||
# Under Output choose 'Logging to the Firefox Profiler' and check the 'Enable stack traces for log messages' checkbox. | # Under Output choose 'Logging to the Firefox Profiler' and check the 'Enable stack traces for log messages' checkbox. | ||
| Line 98: | Line 105: | ||
# Switch to the about:logging tab, click 'Stop logging', and then close the test tab. | # Switch to the about:logging tab, click 'Stop logging', and then close the test tab. | ||
# Wait approximately 10 - 20 seconds for a new tab to automatically open containing the generated performance profile. | # Wait approximately 10 - 20 seconds for a new tab to automatically open containing the generated performance profile. | ||
# Within the upper-right side of the profiler tab click the 'upload local profile' button to initiate profile upload. Once the upload is complete, a drop down | # Within the upper-right side of the profiler tab click the 'upload local profile' button to initiate profile upload. Once the upload is complete, a drop down text edit 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. | # Share the URL of the profile for analysis with the engineer you are working with. | ||