Port TBMv2-based media benchmark to Android

tools/perf/benchmarks/media.py

 # Copyright 2014 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 from core import perf_benchmark
 
 from telemetry import benchmark
 from telemetry.page import legacy_page_test
 from telemetry.timeline import chrome_trace_category_filter
 from telemetry.value import list_of_scalar_values
@@ skipping 34 matching lines @@
 class MediaToughVideoCases(perf_benchmark.PerfBenchmark):
   """Obtains media metrics for key user scenarios."""
   test = media.Media
   page_set = page_sets.ToughVideoCasesPageSet
 
   @classmethod
   def Name(cls):
     return 'media.tough_video_cases'
 
 
-@benchmark.Owner(emails=['johnchen@chromium.org', 'crouleau@chromium.org'],
-                 component='Internals>Media')
-@benchmark.Disabled('android')
-class MediaToughVideoCasesTBMv2(perf_benchmark.PerfBenchmark):
-  """Obtains media metrics using TBMv2.
-  Will eventually replace MediaToughVideoCases class."""
+class _MediaTBMv2Benchmark(perf_benchmark.PerfBenchmark):
   page_set = page_sets.ToughVideoCasesPageSet
 
   def CreateTimelineBasedMeasurementOptions(self):
     category_filter = chrome_trace_category_filter.ChromeTraceCategoryFilter()
 
     # 'toplevel' category provides CPU time slices used by # cpuTimeMetric.
     category_filter.AddIncludedCategory('toplevel')
 
     # 'rail' category is used by powerMetric to attribute different period of
     # time to different activities, such as video_animation, etc.
     category_filter.AddIncludedCategory('rail')
 
     options = timeline_based_measurement.Options(category_filter)
     options.config.enable_atrace_trace = True
     options.config.atrace_config.categories = ['sched']
     options.config.enable_battor_trace = True
     options.SetTimelineBasedMetrics(['powerMetric', 'cpuTimeMetric'])
     return options
 
+
+@benchmark.Owner(emails=['johnchen@chromium.org', 'crouleau@chromium.org'],
+                 component='Internals>Media')
+@benchmark.Disabled('android')
+class MediaToughVideoCasesTBMv2(_MediaTBMv2Benchmark):
+  """Obtains media metrics using TBMv2.
+  Will eventually replace MediaToughVideoCases class."""
+
   @classmethod
   def Name(cls):
     return 'media.tough_video_cases_tbmv2'
 
 
 # crbug.com/565180: Only include cases that don't report time_to_play
 @benchmark.Disabled('android')
 @benchmark.Owner(emails=['crouleau@chromium.org', 'videostack-eng@google.com'])
 class MediaExtra(perf_benchmark.PerfBenchmark):
   """Obtains extra media metrics for key user scenarios."""
@@ skipping 11 matching lines @@
   """Obtains media metrics under different network simulations."""
   test = media.Media
   page_set = page_sets.MediaCnsCasesPageSet
 
   @classmethod
   def Name(cls):
     return 'media.media_cns_cases'
 
 
 @benchmark.Disabled('l', 'android-webview')  # WebView: crbug.com/419689.
-class MediaAndroid(perf_benchmark.PerfBenchmark):
+class MediaAndroidToughVideoCases(perf_benchmark.PerfBenchmark):
   """Obtains media metrics for key user scenarios on Android."""
   test = media.Media
   tag = 'android'
   page_set = page_sets.ToughVideoCasesPageSet
   # Exclude is_4k and 50 fps media files (garden* & crowd*).
   options = {'story_tag_filter_exclude': 'is_4k,is_50fps'}
 
   @classmethod
   def ShouldDisable(cls, possible_browser):
     if possible_browser.platform.GetOSName() != "android":
       return True
     return cls.IsSvelte(possible_browser)
 
   @classmethod
   def Name(cls):
     return 'media.android.tough_video_cases'
 
 
+@benchmark.Owner(emails=['johnchen@chromium.org', 'crouleau@chromium.org'],
+                 component='Internals>Media')
+@benchmark.Disabled('l', 'android-webview')  # WebView: crbug.com/419689.
+class MediaAndroidToughVideoCasesTBMv2(_MediaTBMv2Benchmark):
+  """Obtains media metrics for key user scenarios on Android using TBMv2.
+  Will eventually replace MediaAndroidToughVideoCases class."""
+
+  tag = 'android'
+  # Exclude is_4k and 50 fps media files (garden* & crowd*).

[charliea (OOO until 10-5), 2017/03/27 17:16:22]

nit: I'm not sure how useful this comment is. The "options" reads pretty much
like English, and it seems like specifying the exact media files that are being
excluded only sets us up for this comment to get out of date in the future.
(same w/ same comment above)

+  options = {'story_tag_filter_exclude': 'is_4k,is_50fps'}
+
+  @classmethod
+  def ShouldDisable(cls, possible_browser):
+    if possible_browser.platform.GetOSName() != "android":

[charliea (OOO until 10-5), 2017/03/27 17:16:22]

You can get rid of this lineby putting:

@benchmark.Enabled('android') above
@benchmark.Disabled('l', 'android-webview')

Enabling this test on Android that way is more idiomatic for Telemetry tests

you can think of whether the benchmark runs as a sort of logical "and" between
all of the different possible places to enable/disable something: if the
platform is Android AND the platform is not "l" or "android-webview" AND the
"ShouldDisable" clause returns false, then run this benchmark

+      return True
+    return cls.IsSvelte(possible_browser)
+
+  @classmethod
+  def Name(cls):
+    return 'media.android.tough_video_cases_tbmv2'
+
+  def SetExtraBrowserOptions(self, options):
+    # By default, Chrome on Android disallows auto play of media.

[CalebRouleau, 2017/03/27 16:24:45]

To make this more clear:

"By default, Chrome on Android does not allow autoplay of media: it requires a
user gesture event to start a video. The following option works around that."

+    # The following option works around that.
+    options.AppendExtraBrowserArgs(
+        ['--disable-gesture-requirement-for-media-playback'])
+
+
 @benchmark.Enabled('chromeos')
 class MediaChromeOS4kOnly(perf_benchmark.PerfBenchmark):
   """Benchmark for media performance on ChromeOS using only is_4k test content.
   """
   test = media.Media
   tag = 'chromeOS4kOnly'
   page_set = page_sets.ToughVideoCasesPageSet
   options = {
       'story_tag_filter': 'is_4k',
       # Exclude is_50fps test files: crbug/331816
@@ skipping 32 matching lines @@
 
   @classmethod
   def Name(cls):
     return 'media.mse_cases'
 
   def SetExtraBrowserOptions(self, options):
     # Needed to allow XHR requests to return stream objects.
     options.AppendExtraBrowserArgs(
         ['--enable-experimental-web-platform-features',
          '--disable-gesture-requirement-for-media-playback'])