APM Quality Generator, noise generator and evaluation score workers factory + echo noise generator

webrtc/modules/audio_processing/test/py_quality_assessment/apm_quality_assessment.py

 #!/usr/bin/env python
 # Copyright (c) 2017 The WebRTC project authors. All Rights Reserved.
 #
 # Use of this source code is governed by a BSD-style license
 # that can be found in the LICENSE file in the root of the source
 # tree. An additional intellectual property rights grant can be found
 # in the file PATENTS.  All contributing project authors may
 # be found in the AUTHORS file in the root of the source tree.
 
 """Perform APM module quality assessment on one or more input files using one or
    more audioproc_f configuration files and one or more noise generators.
 
 Usage: apm_quality_assessment.py -i audio1.wav [audio2.wav ...]
                                  -c cfg1.json [cfg2.json ...]
                                  -n white [echo ...]
                                  -e audio_level [polqa ...]
                                  -o /path/to/output
 """
 
 import argparse
 import logging
+import os
 import sys
 
 import quality_assessment.eval_scores as eval_scores
 import quality_assessment.noise_generation as noise_generation
 import quality_assessment.simulation as simulation
 
 _NOISE_GENERATOR_CLASSES = noise_generation.NoiseGenerator.REGISTERED_CLASSES
 _NOISE_GENERATORS_NAMES = _NOISE_GENERATOR_CLASSES.keys()
 _EVAL_SCORE_WORKER_CLASSES = eval_scores.EvaluationScore.REGISTERED_CLASSES
 _EVAL_SCORE_WORKER_NAMES = _EVAL_SCORE_WORKER_CLASSES.keys()
@@ skipping 24 matching lines @@
                       help='custom list of evaluation scores to use',
                       choices=_EVAL_SCORE_WORKER_NAMES,
                       default=_EVAL_SCORE_WORKER_NAMES)
 
   parser.add_argument('-o', '--output_dir', required=False,
                       help=('base path to the output directory in which the '
                             'output wav files and the evaluation outcomes '
                             'are saved'),
                       default='output')
 
+  default_polqa_path = None if 'POLQA_PATH' not in os.environ else (
+      os.environ['POLQA_PATH'])
+  parser.add_argument('--polqa_path', nargs='+',
+                      required=default_polqa_path is None,
+                      help='path to the POLQA tool',
+                      default=default_polqa_path)
+
+  default_air_db_path = None if 'AECHEN_IR_DATABASE_PATH' not in (
+      os.environ) else os.environ['AECHEN_IR_DATABASE_PATH']
+  parser.add_argument('--air_db_path', nargs='+',
+                      required=default_air_db_path is None,
+                      help='path to the Aechen IR database',
+                      default=default_air_db_path)
+

[AleBzk, 2017/03/06 11:29:53]

@kjellander: the environment variable, if defined, is now only used as default
for the shell arguments

[kjellander_webrtc, 2017/03/09 07:49:31]

That's better, but I'd still like to never even attempt to read an environment
variable though. I understand it's annoying to have to pass these flags every
time and that's why you want to define an environment variable. How about just
having a sensible default path instead, and eliminate the environment variable
access entirely?

[AleBzk, 2017/03/09 11:31:19]

Done. Now both paths are required and with no default. See the changes in
apm_quality_assessment.sh taking into account that the script is a sample
customizable script provided with the tool. Still, I defined a default path in
case the environment vars are not defined. But again, taking care of the paths
will be up to the user and now the Python code does not depend anymore on any
environment var.

[kjellander_webrtc, 2017/03/09 14:05:41]

Thanks! Environment variables are the cause of much evil in development and
infrastructure. That's why I'm so heavily against them.

   return parser
 
 
 def main():
   # TODO(alessiob): level = logging.INFO once debugged.
   logging.basicConfig(level=logging.DEBUG)
 
   parser = _instance_arguments_parser()
   args = parser.parse_args()
 
-  simulator = simulation.ApmModuleSimulator()
+  simulator = simulation.ApmModuleSimulator(
+      aechen_ir_database_path=args.air_db_path,
+      polqa_tool_path=args.polqa_path)

[AleBzk, 2017/03/06 11:29:53]

@kjellander: the required paths are now passed to the APM simulator

   simulator.run(
       config_filepaths=args.config_files,
       input_filepaths=args.input_files,
       noise_generator_names=args.noise_generators,
       eval_score_names=args.eval_scores,
       output_dir=args.output_dir)
 
   sys.exit(0)
 
 
 if __name__ == '__main__':
   main()