Organize tough_video_cases by adding tags.

tools/perf/page_sets/tough_video_cases.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 telemetry.page import page as page_module
 from telemetry import story
 
+PAGE_TAGS_LIST = [

[johnchen, 2017/04/11 00:50:49]

Do we expect other modules to need access to this list? If not, the variable
name should start with "_".

[CalebRouleau, 2017/04/11 01:55:50]

Done.

[CalebRouleau, 2017/04/11 01:55:50]

Done.

+    # Audio codecs:
+    'pcm',
+    'mp3',
+    'aac',
+    'vorbis',
+    # Video codecs:
+    'theora'
+    'h264',
+    'vp8',
+    'vp9',
+    # Test types:
+    'audio_video',
+    'audio_only',
+    'video_only',
+    'looped_audio',
+    # Other filter tags:
+    'is_50fps',

[DaleCurtis, 2017/04/11 00:08:01]

Probably tags like 720p60, 2160p60, etc would be more descriptive. Long term I
don't think it's worth having a random 50fps test case here.

[CalebRouleau, 2017/04/11 00:26:50]

Agreed. I'm just organizing stuff up in this CL without removing anything. I
will delete this tag later on, but right now the benchmark file is depending on
it to work correctly.

The idea of having 720p60 as a tag is interesting. Would that be better than two
separate tags '720p' and '60fps'? Then you should be able to filter for tests
that are both 720p and 60fps... this is perhaps better discussed in the design
doc since I will not implement this in this CL.

[DaleCurtis, 2017/04/11 00:34:08]

Depends on if tag filtering is a regex or not. If you can say something like
720p* or *p60$, then it doesn't matter.

[CalebRouleau, 2017/04/11 01:55:50]

Yeah, that's true. I'll look into it further.

+    'is_4k',
+]
+
 
 class ToughVideoCasesPage(page_module.Page):
 
   def __init__(self, url, page_set, tags=None):
+    if tags:

[johnchen, 2017/04/11 00:50:49]

Probably makes more sense to make tags required now.

[CalebRouleau, 2017/04/11 01:55:50]

Done.

+      for tag in tags:

[nednguyen, 2017/04/11 00:04:02]

nits: for t in tags

I usually try to avoid variable names that are only different by a single suffix
since that can easily cause typo (especially in dynamic language like python).

[CalebRouleau, 2017/04/11 00:26:50]

I disagree in general with using single character names, but I will change if
you feel strongly about it.

[nednguyen, 2017/04/11 00:40:24]

Using single character for counter or iterator is ok
(https://google.github.io/styleguide/pyguide.html?showone=Naming#Naming). I
would prefer doing so to avoid possible typo.   

[CalebRouleau, 2017/04/11 01:55:50]

Just because they say you don't have to avoid it doesn't mean it is recommended.
I still disagree, but this isn't worth arguing over. I changed it to t.

+        assert tag in PAGE_TAGS_LIST
     super(ToughVideoCasesPage, self).__init__(
         url=url, page_set=page_set, tags=tags)
 
   def LoopMixedAudio(self, action_runner):
     action_runner.PlayMedia(selector='#background_audio',
                             playing_event_timeout_in_seconds=60)
     action_runner.LoopMedia(loop_count=50, selector='#mixed_audio')
 
   def LoopSingleAudio(self, action_runner):
     action_runner.LoopMedia(loop_count=50, selector='#single_audio')
@@ skipping 17 matching lines @@
     # Seek to after the play-head location.
     action_runner.SeekMedia(seconds=9, timeout_in_seconds=timeout,
                             label='seek_cold')
 
 
 class Page1(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page1, self).__init__(
       url='file://tough_video_cases/video.html?src=crowd.wav&type=audio',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['pcm', 'audio_only'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page2(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page2, self).__init__(
       url='file://tough_video_cases/video.html?src=crowd.ogg&type=audio',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['vorbis', 'audio_only'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page3(ToughVideoCasesPage):
 
+  # Note that ffprobe reports about this file:
+  # "[ogg @ 0x31a3ba0] Broken file, keyframe not correctly marked."
+  # This media file should probably be removed or replaced.
   def __init__(self, page_set):
     super(Page3, self).__init__(
       url='file://tough_video_cases/video.html?src=crowd1080.ogv',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['is_50fps', 'theora', 'vorbis', 'audio_video'])
 
     self.add_browser_metrics = True
-    self.is_50fps = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page4(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page4, self).__init__(
       url='file://tough_video_cases/video.html?src=crowd1080.webm',
-      page_set=page_set, tags=['is_50fps'])
+      page_set=page_set,
+      tags=['is_50fps', 'vp8', 'vorbis', 'audio_video'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page5(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page5, self).__init__(
       url='file://tough_video_cases/video.html?src=crowd2160.ogv',
-      page_set=page_set, tags=['is_4k', 'is_50fps'])
+      page_set=page_set,
+      tags=['is_4k', 'is_50fps', 'theora', 'vorbis', 'audio_video'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page6(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page6, self).__init__(
       url='file://tough_video_cases/video.html?src=crowd2160.webm',
-      page_set=page_set, tags=['is_4k', 'is_50fps'])
+      page_set=page_set,
+      tags=['is_4k', 'is_50fps', 'vp8', 'vorbis', 'audio_video'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page7(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page7, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.ogg&type=audio',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['vorbis', 'audio_only'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page8(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page8, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.wav&type=audio',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['pcm', 'audio_only'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page9(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page9, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.ogv',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['theora', 'vorbis', 'audio_video'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page10(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page10, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.webm',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['vp8', 'vorbis', 'audio_video'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page11(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page11, self).__init__(
       url='file://tough_video_cases/video.html?src=crowd1080.mp4',
-      page_set=page_set, tags=['is_50fps'])
+      page_set=page_set,
+      tags=['is_50fps', 'h264', 'aac', 'audio_video'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page12(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page12, self).__init__(
       url='file://tough_video_cases/video.html?src=crowd2160.mp4',
-      page_set=page_set, tags=['is_4k', 'is_50fps'])
+      page_set=page_set,
+      tags=['is_4k', 'is_50fps', 'h264', 'aac', 'audio_video'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page13(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page13, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.mp3&type=audio',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['mp3', 'audio_only'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page14(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page14, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.mp4',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['h264', 'aac', 'audio_video'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page15(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page15, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.m4a&type=audio',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['aac', 'audio_only'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page16(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page16, self).__init__(
       url='file://tough_video_cases/video.html?src=garden2_10s.webm',
-      page_set=page_set, tags=['is_4k'])
+      page_set=page_set,
+      tags=['is_4k', 'vp8', 'vorbis', 'audio_video'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page17(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page17, self).__init__(
       url='file://tough_video_cases/video.html?src=garden2_10s.mp4',
-      page_set=page_set, tags=['is_4k'])
+      page_set=page_set,
+      tags=['is_4k', 'h264', 'aac', 'audio_video'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page18(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page18, self).__init__(
       url='file://tough_video_cases/video.html?src=garden2_10s.ogv',
-      page_set=page_set, tags=['is_4k'])
+      page_set=page_set,
+      tags=['is_4k', 'theora', 'vorbis', 'audio_video'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 
 class Page19(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page19, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.ogg&type=audio',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['vorbis', 'audio'])
 
     self.skip_basic_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.SeekBeforeAndAfterPlayhead(action_runner)
 
 
 class Page20(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page20, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.wav&type=audio',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['pcm', 'audio_only'])
 
     self.skip_basic_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.SeekBeforeAndAfterPlayhead(action_runner)
 
 
 class Page21(ToughVideoCasesPage):
 
+  # Note that ffprobe reports about this file:
+  # "[ogg @ 0x39adba0] Broken file, keyframe not correctly marked."
+  # This media file should probably be removed or replaced.
   def __init__(self, page_set):
     super(Page21, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.ogv',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['theora', 'vorbis', 'audio_video'])
 
     self.skip_basic_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.SeekBeforeAndAfterPlayhead(action_runner)
 
 
 class Page22(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page22, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.webm',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['vp8', 'vorbis', 'audio_video'])
 
     self.skip_basic_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.SeekBeforeAndAfterPlayhead(action_runner)
 
 
 class Page23(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page23, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.mp3&type=audio',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['mp3', 'audio_only'])
 
     self.skip_basic_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.SeekBeforeAndAfterPlayhead(action_runner)
 
 
 class Page24(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page24, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.mp4',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['h264', 'aac', 'audio_video'])
 
     self.skip_basic_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.SeekBeforeAndAfterPlayhead(action_runner)
 
 
 class Page25(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page25, self).__init__(
       url='file://tough_video_cases/video.html?src=garden2_10s.webm',
-      page_set=page_set, tags=['is_4k'])
+      page_set=page_set,
+      tags=['is_4k', 'vp8', 'vorbis', 'audio_video'])
 
     self.skip_basic_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.SeekBeforeAndAfterPlayhead(action_runner)
 
 
 class Page26(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page26, self).__init__(
       url='file://tough_video_cases/video.html?src=garden2_10s.mp4',
-      page_set=page_set, tags=['is_4k'])
+      page_set=page_set,
+      tags=['is_4k', 'h264', 'aac', 'audio_video'])
 
     self.skip_basic_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.SeekBeforeAndAfterPlayhead(action_runner)
 
 
 class Page27(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page27, self).__init__(
       url='file://tough_video_cases/video.html?src=garden2_10s.ogv',
-      page_set=page_set, tags=['is_4k'])
+      page_set=page_set,
+      tags=['is_4k', 'theora', 'vorbis', 'audio_video'])
 
     self.skip_basic_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.SeekBeforeAndAfterPlayhead(action_runner)
 
 
 class Page28(ToughVideoCasesPage):
 
+  # This page tests looping a single audio track.
   def __init__(self, page_set):
     super(Page28, self).__init__(
       url='file://tough_video_cases/audio_playback.html?id=single_audio',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['pcm', 'looping_audio'])
 
     self.skip_basic_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.LoopSingleAudio(action_runner)
 
 
 class Page29(ToughVideoCasesPage):
 
+  # This page tests looping an audio track and playing another in the
+  # background.
   def __init__(self, page_set):
     super(Page29, self).__init__(
       url='file://tough_video_cases/audio_playback.html?id=mixed_audio',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['pcm', 'looping_audio'])
 
     self.skip_basic_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.LoopMixedAudio(action_runner)
 
 class Page30(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page30, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.vp9.webm',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['vp9', 'opus', 'audio_video'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 class Page31(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page31, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.vp9.webm',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['vp9', 'opus', 'audio_video'])
 
     self.skip_basic_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.SeekBeforeAndAfterPlayhead(action_runner)
 
 class Page32(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page32, self).__init__(
       url='file://tough_video_cases/video.html?src=crowd1080_vp9.webm',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['vp9', 'video_only'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 class Page33(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page33, self).__init__(
       url='file://tough_video_cases/video.html?src=crowd1080_vp9.webm',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['vp9', 'video_only'])
 
     self.skip_basic_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.SeekBeforeAndAfterPlayhead(action_runner)
 
 class Page34(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page34, self).__init__(
       url='file://tough_video_cases/video.html?src=crowd720_vp9.webm',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['vp9', 'video_only'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 class Page35(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page35, self).__init__(
       url='file://tough_video_cases/video.html?src=crowd720_vp9.webm',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['vp9', 'video_only'])
 
     self.skip_basic_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.SeekBeforeAndAfterPlayhead(action_runner)
 
 class Page36(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page36, self).__init__(
       url=('file://tough_video_cases/video.html?src='
            'smpte_3840x2160_60fps_vp9.webm'),
-      page_set=page_set, tags=['is_4k'])
+      page_set=page_set,
+      tags=['is_4k', 'vp9', 'video_only'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.SeekBeforeAndAfterPlayhead(action_runner,
                                     action_timeout_in_seconds=120)
 
 class Page37(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page37, self).__init__(
       url='file://tough_video_cases/video.html?src=crowd1080_vp9.webm&canvas=true',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['vp9', 'video_only'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 class Page38(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page38, self).__init__(
       url='file://tough_video_cases/video.html?src=tulip2.mp4&canvas=true',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['h264', 'aac', 'audio_video'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.SeekBeforeAndAfterPlayhead(action_runner)
 
 class Page39(ToughVideoCasesPage):
 
   def __init__(self, page_set):
     super(Page39, self).__init__(
       url='file://tough_video_cases/video.html?src=garden2_10s.webm&canvas=true',
-      page_set=page_set, tags=['is_4k'])
+      page_set=page_set,
+      tags=['is_4k', 'vp8', 'vorbis', 'audio_video'])
 
     self.add_browser_metrics = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 class Page40(ToughVideoCasesPage):
 
+  # Note that ffprobe reports about this file:
+  # "[ogg @ 0x31a3ba0] Broken file, keyframe not correctly marked."
+  # This media file should probably be removed or replaced.
   def __init__(self, page_set):
     super(Page40, self).__init__(
       url='file://tough_video_cases/video.html?src=crowd1080.ogv&canvas=true',
-      page_set=page_set)
+      page_set=page_set,
+      tags=['is_50fps', 'theora', 'vorbis', 'audio_video'])
 
     self.add_browser_metrics = True
-    self.is_50fps = True
 
   def RunPageInteractions(self, action_runner):
     self.PlayAction(action_runner)
 
 class ToughVideoCasesPageSet(story.StorySet):
   """
   Description: Video Stack Perf benchmark that report time_to_play.
   """
   def __init__(self):
     super(ToughVideoCasesPageSet, self).__init__(
@@ skipping 42 matching lines @@
     self.AddStory(Page23(self))
     self.AddStory(Page24(self))
     self.AddStory(Page25(self))
     self.AddStory(Page26(self))
     self.AddStory(Page27(self))
     self.AddStory(Page28(self))
     self.AddStory(Page29(self))
     self.AddStory(Page31(self))
     self.AddStory(Page33(self))
     self.AddStory(Page35(self))