Initial checkin of media test matrix class, which will be used for media perf test later.

chrome/test/functional/media_test_matrix.py

Index: chrome/test/functional/media_test_matrix.py
diff --git a/chrome/test/functional/media_test_matrix.py b/chrome/test/functional/media_test_matrix.py
new file mode 100644
index 0000000000000000000000000000000000000000..630776df6f2d2085360467f3a4380b4247cf1ec8
--- /dev/null
+++ b/chrome/test/functional/media_test_matrix.py
@@ -0,0 +1,219 @@
+#!/usr/bin/python
+
+# Copyright (c) 2011 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.
+
+import csv
+import os
+import random
+
+NOT_AVAILABLE_STRING = 'not available'
+
+
+class MediaTestMatrix:
+  """This class reads video test matrix file and stores them.
+
+  Video test matrix contains different video titles as column and different
+  video codec (such as "webm" as columns. The matrix entry contains video
+  specification such as "320x240 50 fps VP8 / no audio 1 MBit/s PSNR 36.70"
+  or "not available". It also provides methods to generate information based
+  on the client's needs. For example, "video" tag or "audio" tag is returned
+  based on what kinds of media it is. This matrix is for managing different
+  kinds of media files in media testing.
+
+  TODO(imasaki@chromium.org): remove the code duplication in Generate methods.
+  """
+  # Video extensions such as "webm".
+  __exts = []
+  # Video specification dictionary of list of video descriptions
+  # (the key is video title).
+  __specs = {}
+  # Video titles such as "bear".
+  __video_titles = []
+  # Tag dictionary (the key is extension).
+  __tags = {}
+
+  def ReadData(self, csv_file):
+    """Reads CSV file and stores in list specs and extensions.
+
+    CSV file should have the following format:
+    "ext","tag","title1","title2",....
+    "0.webm", "video","description1","descrption2", "not available"
+    (when it is not available).
+
+    Args:
+      csv_file : CSV file name contains video matrix information described
+                 above.
+
+    Raises:
+      csv.Error if the number of columns is not the same as the number of
+        tiles.
+    """
+    # Clean up all data.
+    self.__exts = []
+    self.__specs = {}
+    self.__video_titles = []
+    self.__tags = {}
+    file = open(csv_file, 'rb')
+    reader = csv.reader(file)
+    for counter, row in enumerate(reader):
+      if counter == 0:
+        # First row is comment. So, skip it.
+        pass
+      elif counter == 1:
+        # Second row is for header (video titles).
+        for title in row[1:]:
+          self.__video_titles.append(title)
+          self.__specs[title] = []
+      else:
+        # Error checking is done here based on the number of titles
+        if len(self.__video_titles) != len(row) - 1:
+          print "Row %d should have %d columns but has %d columns" % (counter,
+            len(self.__video_titles), len(row))
+          raise csv.Error
+        # First column should contain extension.
+        self.__exts.append(row[0])
+        # Second column should contain tag (audio or video).
+        self.__tags[row[0]] = row[1]
+        for i in range(len(row) - 2):
+          self.__specs[self.__video_titles[i]].append(row[i + 2])
+    file.close()
+
+  def __GenerateMediaInfo(self, sub_type, name, media_test_matrix_home_url):
+    """Generate media information from matrix generated by CSV file.
+
+    Args:
+      sub_type: index of the extensions (rows in the CSV file).
+      name: the name of the video file (column name in the CSV file).
+      media_test_matrix_home_url: url of the matrix home that used
+        to generate link.
+
+    Returns:
+      a tuple of (info, url, link, tag, is_video, nickname).
+        info: description of the video (an entry in the matrix).
+        url: URL of the video or audio.
+        link: href tag for video or audio.
+        tag: a tag string can be used to display video or audio.
+        is_video: True if the file is video; False otherwise.
+        nickname: nickname of the video for presentation.
+    """
+    if name is 'none':
+      return
+    cur_video = name
+    # All videos are placed up to the rows (below 15th row).

[dennis_jeffrey, 2011/03/18 23:51:41]

I think we can remove this comment now that videos aren't restricted to being in
the first 15 rows.

[imasaki1, 2011/03/19 01:00:38]

Done.

+    is_video = self.__tags[self.__exts[sub_type]] == "video"

[dennis_jeffrey, 2011/03/18 23:51:41]

Use single quotes for strings:

'video'

[imasaki1, 2011/03/19 01:00:38]

Done.

+    file = os.path.join(cur_video, cur_video + self.__exts[sub_type])
+    # Specs were generated from CSV file in readFile().
+    info = self.__specs[cur_video][sub_type]
+    url = media_test_matrix_home_url + file
+    link = '<b><a href="%s">%s</a>&nbsp;&nbsp;%s</b>' % (url, file, info)
+    type = ['audio', 'video'][is_video]
+    tag_attr = 'id="v" controls autoplay playbackRate=1 loop valign=top'
+    tag = '<%s %s src="%s">' % (type, tag_attr, file)
+    nickname = cur_video + self.__exts[sub_type]
+    return (info, url, link, tag, is_video, nickname)
+
+  def GenerateRandomMediaInfo(self, number_of_tries=10,
+                              video_matrix_home_url=''):
+    """Generate random video info that can be used for playing this media.
+
+    Args:
+      video_only: True if generate random video only.
+      media_test_matrix_home_url: url of the matrix home that used
+        to generate link.
+
+    Returns:
+      a list of a tuples (info, url, link, tag, is_video, nickname).
+        info: description of the video (an entry in the matrix).
+        url: URL of the video/audio.
+        link: href tag for video or audio.
+        tag: a tag string can be used to display video or audio.
+        is_video: True if the file is video; False otherwise.
+        nickname: nickname of the video for presentation.
+    """
+    # Try number_of_tries times to find available video/audio.
+    for i in range(number_of_tries):
+      sub_type = random.randint(0, len(self.__exts))
+      name = self.__video_titles[random.randint(0, len(self.__video_titles)-1)]
+      (info, url, link, tag, is_video, nickname) = (
+          self.__GenerateMediaInfo(sub_type, name, video_matrix_home_url))
+      if NOT_AVAILABLE_STRING not in info:
+        return (info, url, link, tag, is_video, nickname)
+    # Gives up after that (very small chance).
+    return None
+
+  def GenerateAllMediaInfos(self, video_only, media_matrix_home_url=''):
+    """Generate all video infos that can be used for playing this media.
+
+    Args:
+      video_only: True if generate random video only (not audio).

[dennis_jeffrey, 2011/03/18 23:51:41]

Add a line here for the "media_matrix_home_url" arg.

[imasaki1, 2011/03/19 01:00:38]

Done.

+
+    Returns:
+      a list of a tuples (info, url, link, tag, is_video, nickname).
+        info: description of the video (an entry in the matrix).
+        url: URL of the video/audio.
+        link: href tag for video or audio.
+        tag: a tag string can be used to display video or audio.
+        is_video: True if the file is video; False otherwise.
+        nickname: nickname of the video for presentation (such as bear.webm).
+    """
+    video_infos = []

[dennis_jeffrey, 2011/03/18 23:51:41]

Since it looks like this function processes both video and audio (depending on
the "video_only" flag), maybe we should change the name of this variable to
something more general like "media_infos".

[imasaki1, 2011/03/19 01:00:38]

Done.

+
+    for i in range(0, len(self.__video_titles)-1):
+      name = self.__video_titles[i]
+      for sub_type in range(len(self.__exts)):
+        (info, url, link, tag, is_video, nickname) = (
+            self.__GenerateMediaInfo(sub_type, name, media_matrix_home_url))
+        if ((NOT_AVAILABLE_STRING not in info) and
+            ((not video_only) or (video_only and is_video))):
+          video_infos.append([info, url, link, tag, is_video, nickname])
+    return video_infos
+
+  def GenerateAllMediaInfosInCompactForm(self, video_only,
+                                         media_matrix_home_url=''):
+    """Generate all media information in compact form.
+
+    Compact form contains only url, nickname and tag.
+
+    Args:
+      video_only: True if generate random video only.

[dennis_jeffrey, 2011/03/18 23:51:41]

Need a line for the "media_matrix_home_url" arg.

[imasaki1, 2011/03/19 01:00:38]

Done.

+
+    Returns:
+      a list of a tuples (url, nickname, tag).
+        url: URL of the video/audio.
+        nickname: nickname of the video/audio for presentation
+                  (such as bear.webm).
+        tag: HTML5 tag for the video/audio.
+    """
+    video_infos = []

[dennis_jeffrey, 2011/03/18 23:51:41]

Similar comment as line 161 above.

[imasaki1, 2011/03/19 01:00:38]

Done.

+    for i in range(0, len(self.__video_titles)-1):
+      name = self.__video_titles[i]
+      for sub_type in range(len(self.__exts)):
+        (info, url, link, tag, is_video, nickname) = (
+            self.__GenerateMediaInfo(sub_type, name, media_matrix_home_url))
+        tag = ['audio', 'video'][is_video]
+        if ((not NOT_AVAILABLE_STRING in info) and
+            ((not video_only) or (video_only and is_video))):
+          video_infos.append([url, nickname, tag])
+    return video_infos
+
+  @staticmethod
+  def LookForMediaInfoInCompactFormByNickName(compact_list, target):
+    """Look for video by its nickname in the compact_list.
+
+    Args:
+      compact_list: a list generated by GenerateAllMediaInfosInCompactForm.
+      target: a target nickname string to look for.
+
+    Returns:
+      A tuple (info, url, link, tag, is_video, nickname) where nickname is

[dennis_jeffrey, 2011/03/18 23:51:41]

Since this function only returns (url, nickname, tag), we need to change the
comment here to reflect that.

[imasaki1, 2011/03/19 01:00:38]

Done.

+        a target string.
+        url: URL of the video/audio.
+        tag: HTML5 tag for the video/audio.
+        nickname: nickname of the video/audio for presentation

[dennis_jeffrey, 2011/03/18 23:51:41]

Swap the "nickname" and "tag" lines to match the order in which items are
specified in the tuple in line 219 below.

[imasaki1, 2011/03/19 01:00:38]

Done.

+                  (such as bear.webm).
+    """
+    for url, nickname, tag in compact_list:
+      if target == nickname:
+        return (url, nickname, tag)