| // Copyright 2013 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. |
| |
| #include "base/environment.h" |
| #include "base/file_util.h" |
| #include "base/path_service.h" |
| #include "base/process/launch.h" |
| #include "base/strings/string_split.h" |
| #include "base/strings/stringprintf.h" |
| #include "base/test/test_timeouts.h" |
| #include "base/time/time.h" |
| #include "chrome/browser/chrome_notification_types.h" |
| #include "chrome/browser/infobars/infobar.h" |
| #include "chrome/browser/infobars/infobar_service.h" |
| #include "chrome/browser/media/media_stream_infobar_delegate.h" |
| #include "chrome/browser/media/webrtc_browsertest_base.h" |
| #include "chrome/browser/media/webrtc_browsertest_common.h" |
| #include "chrome/browser/profiles/profile.h" |
| #include "chrome/browser/ui/browser.h" |
| #include "chrome/browser/ui/browser_tabstrip.h" |
| #include "chrome/browser/ui/tabs/tab_strip_model.h" |
| #include "chrome/common/chrome_switches.h" |
| #include "chrome/test/base/in_process_browser_test.h" |
| #include "chrome/test/base/ui_test_utils.h" |
| #include "chrome/test/ui/ui_test.h" |
| #include "content/public/browser/notification_service.h" |
| #include "content/public/test/browser_test_utils.h" |
| #include "net/test/embedded_test_server/embedded_test_server.h" |
| #include "net/test/python_utils.h" |
| #include "testing/perf/perf_test.h" |
| |
| static const base::FilePath::CharType kFrameAnalyzerExecutable[] = |
| #if defined(OS_WIN) |
| FILE_PATH_LITERAL("frame_analyzer.exe"); |
| #else |
| FILE_PATH_LITERAL("frame_analyzer"); |
| #endif |
| |
| static const base::FilePath::CharType kArgbToI420ConverterExecutable[] = |
| #if defined(OS_WIN) |
| FILE_PATH_LITERAL("rgba_to_i420_converter.exe"); |
| #else |
| FILE_PATH_LITERAL("rgba_to_i420_converter"); |
| #endif |
| |
| static const char kHomeEnvName[] = |
| #if defined(OS_WIN) |
| "HOMEPATH"; |
| #else |
| "HOME"; |
| #endif |
| |
| // The working dir should be in the user's home folder. |
| static const base::FilePath::CharType kWorkingDirName[] = |
| FILE_PATH_LITERAL("webrtc_video_quality"); |
| static const base::FilePath::CharType kReferenceYuvFileName[] = |
| FILE_PATH_LITERAL("reference_video.yuv"); |
| static const base::FilePath::CharType kCapturedYuvFileName[] = |
| FILE_PATH_LITERAL("captured_video.yuv"); |
| static const base::FilePath::CharType kStatsFileName[] = |
| FILE_PATH_LITERAL("stats.txt"); |
| static const char kMainWebrtcTestHtmlPage[] = |
| "/webrtc/webrtc_jsep01_test.html"; |
| static const char kCapturingWebrtcHtmlPage[] = |
| "/webrtc/webrtc_video_quality_test.html"; |
| static const int kVgaWidth = 640; |
| static const int kVgaHeight = 480; |
| |
| // If you change the port number, don't forget to modify video_extraction.js |
| // too! |
| static const char kPyWebSocketPortNumber[] = "12221"; |
| |
| // Test the video quality of the WebRTC output. |
| // |
| // Prerequisites: This test case must run on a machine with a virtual webcam |
| // that plays video from the reference file located in <the running user's home |
| // folder>/kWorkingDirName/kReferenceYuvFileName. |
| // |
| // You must also compile the chromium_builder_webrtc target before you run this |
| // test to get all the tools built. |
| // |
| // The external compare_videos.py script also depends on two external |
| // executables which must be located in the PATH when running this test. |
| // * zxing (see the CPP version at https://code.google.com/p/zxing) |
| // * ffmpeg 0.11.1 or compatible version (see http://www.ffmpeg.org) |
| // |
| // The test case will launch a custom binary (peerconnection_server) which will |
| // allow two WebRTC clients to find each other. |
| // |
| // The test also runs several other custom binaries - rgba_to_i420 converter and |
| // frame_analyzer. Both tools can be found under third_party/webrtc/tools. The |
| // test also runs a stand alone Python implementation of a WebSocket server |
| // (pywebsocket) and a barcode_decoder script. |
| class WebrtcVideoQualityBrowserTest : public WebRtcTestBase { |
| public: |
| WebrtcVideoQualityBrowserTest() |
| : pywebsocket_server_(0), |
| environment_(base::Environment::Create()) {} |
| |
| virtual void SetUpInProcessBrowserTestFixture() OVERRIDE { |
| PeerConnectionServerRunner::KillAllPeerConnectionServersOnCurrentSystem(); |
| } |
| |
| virtual void SetUpCommandLine(CommandLine* command_line) OVERRIDE { |
| // This test expects real device handling and requires a real webcam / audio |
| // device; it will not work with fake devices. |
| EXPECT_FALSE( |
| command_line->HasSwitch(switches::kUseFakeDeviceForMediaStream)) |
| << "You cannot run this test with fake devices."; |
| |
| // The video playback will not work without a GPU, so force its use here. |
| command_line->AppendSwitch(switches::kUseGpuInTests); |
| } |
| |
| bool HasAllRequiredResources() { |
| if (!base::PathExists(GetWorkingDir())) { |
| LOG(ERROR) << "Cannot find the working directory for the reference video " |
| "and the temporary files:" << GetWorkingDir().value(); |
| return false; |
| } |
| base::FilePath reference_file = |
| GetWorkingDir().Append(kReferenceYuvFileName); |
| if (!base::PathExists(reference_file)) { |
| LOG(ERROR) << "Cannot find the reference file to be used for video " |
| << "quality comparison: " << reference_file.value(); |
| return false; |
| } |
| return true; |
| } |
| |
| bool StartPyWebSocketServer() { |
| base::FilePath path_pywebsocket_dir = |
| GetSourceDir().Append(FILE_PATH_LITERAL("third_party/pywebsocket/src")); |
| base::FilePath pywebsocket_server = path_pywebsocket_dir.Append( |
| FILE_PATH_LITERAL("mod_pywebsocket/standalone.py")); |
| base::FilePath path_to_data_handler = |
| GetSourceDir().Append(FILE_PATH_LITERAL("chrome/test/functional")); |
| |
| if (!base::PathExists(pywebsocket_server)) { |
| LOG(ERROR) << "Missing pywebsocket server."; |
| return false; |
| } |
| if (!base::PathExists(path_to_data_handler)) { |
| LOG(ERROR) << "Missing data handler for pywebsocket server."; |
| return false; |
| } |
| |
| AppendToPythonPath(path_pywebsocket_dir); |
| |
| // Note: don't append switches to this command since it will mess up the |
| // -u in the python invocation! |
| CommandLine pywebsocket_command(CommandLine::NO_PROGRAM); |
| EXPECT_TRUE(GetPythonCommand(&pywebsocket_command)); |
| |
| pywebsocket_command.AppendArgPath(pywebsocket_server); |
| pywebsocket_command.AppendArg("-p"); |
| pywebsocket_command.AppendArg(kPyWebSocketPortNumber); |
| pywebsocket_command.AppendArg("-d"); |
| pywebsocket_command.AppendArgPath(path_to_data_handler); |
| |
| LOG(INFO) << "Running " << pywebsocket_command.GetCommandLineString(); |
| return base::LaunchProcess(pywebsocket_command, base::LaunchOptions(), |
| &pywebsocket_server_); |
| } |
| |
| bool ShutdownPyWebSocketServer() { |
| return base::KillProcess(pywebsocket_server_, 0, false); |
| } |
| |
| // Ensures we didn't get any errors asynchronously (e.g. while no javascript |
| // call from this test was outstanding). |
| // TODO(phoglund): this becomes obsolete when we switch to communicating with |
| // the DOM message queue. |
| void AssertNoAsynchronousErrors(content::WebContents* tab_contents) { |
| EXPECT_EQ("ok-no-errors", |
| ExecuteJavascript("getAnyTestFailures()", tab_contents)); |
| } |
| |
| void EstablishCall(content::WebContents* from_tab, |
| content::WebContents* to_tab) { |
| EXPECT_EQ("ok-peerconnection-created", |
| ExecuteJavascript("preparePeerConnection()", from_tab)); |
| EXPECT_EQ("ok-added", ExecuteJavascript("addLocalStream()", from_tab)); |
| EXPECT_EQ("ok-negotiating", ExecuteJavascript("negotiateCall()", from_tab)); |
| |
| // Ensure the call gets up on both sides. |
| EXPECT_TRUE(PollingWaitUntil( |
| "getPeerConnectionReadyState()", "active", from_tab)); |
| EXPECT_TRUE(PollingWaitUntil( |
| "getPeerConnectionReadyState()", "active", to_tab)); |
| } |
| |
| void HangUp(content::WebContents* from_tab) { |
| EXPECT_EQ("ok-call-hung-up", ExecuteJavascript("hangUp()", from_tab)); |
| } |
| |
| void WaitUntilHangupVerified(content::WebContents* tab_contents) { |
| EXPECT_TRUE(PollingWaitUntil( |
| "getPeerConnectionReadyState()", "no-peer-connection", tab_contents)); |
| } |
| |
| // Runs the RGBA to I420 converter on the video in |capture_video_filename|, |
| // which should contain frames of size |width| x |height|. |
| // |
| // The rgba_to_i420_converter is part of the webrtc_test_tools target which |
| // should be build prior to running this test. The resulting binary should |
| // live next to Chrome. |
| bool RunARGBtoI420Converter(int width, |
| int height, |
| const base::FilePath& captured_video_filename) { |
| base::FilePath path_to_converter = base::MakeAbsoluteFilePath( |
| GetBrowserDir().Append(kArgbToI420ConverterExecutable)); |
| |
| if (!base::PathExists(path_to_converter)) { |
| LOG(ERROR) << "Missing ARGB->I420 converter: should be in " |
| << path_to_converter.value(); |
| return false; |
| } |
| |
| CommandLine converter_command(path_to_converter); |
| converter_command.AppendSwitchPath("--frames_dir", GetWorkingDir()); |
| converter_command.AppendSwitchPath("--output_file", |
| captured_video_filename); |
| converter_command.AppendSwitchASCII("--width", |
| base::StringPrintf("%d", width)); |
| converter_command.AppendSwitchASCII("--height", |
| base::StringPrintf("%d", height)); |
| |
| // We produce an output file that will later be used as an input to the |
| // barcode decoder and frame analyzer tools. |
| LOG(INFO) << "Running " << converter_command.GetCommandLineString(); |
| std::string result; |
| bool ok = base::GetAppOutput(converter_command, &result); |
| LOG(INFO) << "Output was:\n\n" << result; |
| return ok; |
| } |
| |
| // Compares the |captured_video_filename| with the |reference_video_filename|. |
| // |
| // The barcode decoder decodes the captured video containing barcodes overlaid |
| // into every frame of the video (produced by rgba_to_i420_converter). It |
| // produces a set of PNG images and a |stats_file| that maps each captured |
| // frame to a frame in the reference video. The frames should be of size |
| // |width| x |height|. |
| // All measurements calculated are printed as perf parsable numbers to stdout. |
| bool CompareVideosAndPrintResult( |
| int width, |
| int height, |
| const base::FilePath& captured_video_filename, |
| const base::FilePath& reference_video_filename, |
| const base::FilePath& stats_file) { |
| |
| base::FilePath path_to_analyzer = base::MakeAbsoluteFilePath( |
| GetBrowserDir().Append(kFrameAnalyzerExecutable)); |
| base::FilePath path_to_compare_script = GetSourceDir().Append( |
| FILE_PATH_LITERAL("third_party/webrtc/tools/compare_videos.py")); |
| |
| if (!base::PathExists(path_to_analyzer)) { |
| LOG(ERROR) << "Missing frame analyzer: should be in " |
| << path_to_analyzer.value(); |
| return false; |
| } |
| if (!base::PathExists(path_to_compare_script)) { |
| LOG(ERROR) << "Missing video compare script: should be in " |
| << path_to_compare_script.value(); |
| return false; |
| } |
| |
| // Note: don't append switches to this command since it will mess up the |
| // -u in the python invocation! |
| CommandLine compare_command(CommandLine::NO_PROGRAM); |
| EXPECT_TRUE(GetPythonCommand(&compare_command)); |
| |
| compare_command.AppendArgPath(path_to_compare_script); |
| compare_command.AppendArg("--label=VGA"); |
| compare_command.AppendArg("--ref_video"); |
| compare_command.AppendArgPath(reference_video_filename); |
| compare_command.AppendArg("--test_video"); |
| compare_command.AppendArgPath(captured_video_filename); |
| compare_command.AppendArg("--frame_analyzer"); |
| compare_command.AppendArgPath(path_to_analyzer); |
| compare_command.AppendArg("--yuv_frame_width"); |
| compare_command.AppendArg(base::StringPrintf("%d", width)); |
| compare_command.AppendArg("--yuv_frame_height"); |
| compare_command.AppendArg(base::StringPrintf("%d", height)); |
| compare_command.AppendArg("--stats_file"); |
| compare_command.AppendArgPath(stats_file); |
| |
| LOG(INFO) << "Running " << compare_command.GetCommandLineString(); |
| std::string output; |
| bool ok = base::GetAppOutput(compare_command, &output); |
| // Print to stdout to ensure the perf numbers are parsed properly by the |
| // buildbot step. |
| printf("Output was:\n\n%s\n", output.c_str()); |
| return ok; |
| } |
| |
| base::FilePath GetWorkingDir() { |
| std::string home_dir; |
| environment_->GetVar(kHomeEnvName, &home_dir); |
| base::FilePath::StringType native_home_dir(home_dir.begin(), |
| home_dir.end()); |
| return base::FilePath(native_home_dir).Append(kWorkingDirName); |
| } |
| |
| PeerConnectionServerRunner peerconnection_server_; |
| |
| private: |
| base::FilePath GetSourceDir() { |
| base::FilePath source_dir; |
| PathService::Get(base::DIR_SOURCE_ROOT, &source_dir); |
| return source_dir; |
| } |
| |
| base::FilePath GetBrowserDir() { |
| base::FilePath browser_dir; |
| EXPECT_TRUE(PathService::Get(base::DIR_MODULE, &browser_dir)); |
| return browser_dir; |
| } |
| |
| base::ProcessHandle pywebsocket_server_; |
| scoped_ptr<base::Environment> environment_; |
| }; |
| |
| IN_PROC_BROWSER_TEST_F(WebrtcVideoQualityBrowserTest, |
| MANUAL_TestVGAVideoQuality) { |
| ASSERT_TRUE(HasAllRequiredResources()); |
| ASSERT_TRUE(embedded_test_server()->InitializeAndWaitUntilReady()); |
| ASSERT_TRUE(StartPyWebSocketServer()); |
| ASSERT_TRUE(peerconnection_server_.Start()); |
| |
| ui_test_utils::NavigateToURL( |
| browser(), embedded_test_server()->GetURL(kMainWebrtcTestHtmlPage)); |
| content::WebContents* left_tab = |
| browser()->tab_strip_model()->GetActiveWebContents(); |
| GetUserMediaAndAccept(left_tab); |
| |
| chrome::AddBlankTabAt(browser(), -1, true); |
| content::WebContents* right_tab = |
| browser()->tab_strip_model()->GetActiveWebContents(); |
| ui_test_utils::NavigateToURL( |
| browser(), embedded_test_server()->GetURL(kCapturingWebrtcHtmlPage)); |
| GetUserMediaAndAccept(right_tab); |
| |
| ConnectToPeerConnectionServer("peer 1", left_tab); |
| ConnectToPeerConnectionServer("peer 2", right_tab); |
| |
| EstablishCall(left_tab, right_tab); |
| |
| AssertNoAsynchronousErrors(left_tab); |
| AssertNoAsynchronousErrors(right_tab); |
| |
| // Poll slower here to avoid flooding the log with messages: capturing and |
| // sending frames take quite a bit of time. |
| int polling_interval_msec = 1000; |
| |
| EXPECT_TRUE(PollingWaitUntil( |
| "doneFrameCapturing()", "done-capturing", right_tab, |
| polling_interval_msec)); |
| |
| HangUp(left_tab); |
| WaitUntilHangupVerified(left_tab); |
| WaitUntilHangupVerified(right_tab); |
| |
| AssertNoAsynchronousErrors(left_tab); |
| AssertNoAsynchronousErrors(right_tab); |
| |
| EXPECT_TRUE(PollingWaitUntil( |
| "haveMoreFramesToSend()", "no-more-frames", right_tab, |
| polling_interval_msec)); |
| |
| RunARGBtoI420Converter( |
| kVgaWidth, kVgaHeight, GetWorkingDir().Append(kCapturedYuvFileName)); |
| ASSERT_TRUE( |
| CompareVideosAndPrintResult(kVgaWidth, |
| kVgaHeight, |
| GetWorkingDir().Append(kCapturedYuvFileName), |
| GetWorkingDir().Append(kReferenceYuvFileName), |
| GetWorkingDir().Append(kStatsFileName))); |
| |
| ASSERT_TRUE(peerconnection_server_.Stop()); |
| ASSERT_TRUE(ShutdownPyWebSocketServer()); |
| } |