src/media/audio/tools/signal_generator/signal_generator.h

// Copyright 2018 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.

#ifndef SRC_MEDIA_AUDIO_TOOLS_SIGNAL_GENERATOR_SIGNAL_GENERATOR_H_
#define SRC_MEDIA_AUDIO_TOOLS_SIGNAL_GENERATOR_SIGNAL_GENERATOR_H_

#include <fuchsia/media/cpp/fidl.h>
#include <lib/fit/function.h>
#include <lib/fzl/vmo-mapper.h>
#include <lib/sys/cpp/component_context.h>

#include "src/media/audio/lib/wav_writer/wav_writer.h"

namespace media::tools {

typedef enum {
  kOutputTypeNoise,
  kOutputTypeSine,
  kOutputTypeSquare,
  kOutputTypeSawtooth,
} OutputSignalType;
// TODO(mpuryear): refactor the signal-generation section to make it easier for new generators to be
// added.

class MediaApp {
 public:
  MediaApp(fit::closure quit_callback);

  void set_num_channels(uint32_t num_channels) { num_channels_ = num_channels; }
  void set_frame_rate(uint32_t frame_rate) { frame_rate_ = frame_rate; }
  void set_int16_format(bool use_int16) { use_int16_ = use_int16; }
  void set_int24_format(bool use_int24) { use_int24_ = use_int24; }

  void set_output_type(OutputSignalType output_type) { output_signal_type_ = output_type; }
  void set_frequency(double frequency) { frequency_ = frequency; }
  void set_amplitude(float amplitude) { amplitude_ = amplitude; }

  void set_duration(double duration_secs) { duration_secs_ = duration_secs; }
  double get_duration() { return duration_secs_; }

  void set_frames_per_payload(uint32_t frames_per_payload) {
    frames_per_payload_ = frames_per_payload;
  }
  void set_num_payload_buffers(uint32_t num_payload_buffers) {
    num_payload_buffers_ = num_payload_buffers;
  }

  void set_use_pts(bool use_pts) { use_pts_ = use_pts; }
  void set_pts_continuity_threshold(float pts_continuity_threshold) {
    set_continuity_threshold_ = true;
    pts_continuity_threshold_secs_ = pts_continuity_threshold;
  }

  void set_save_to_file(bool save_to_file) { save_to_file_ = save_to_file; }
  void set_save_file_name(std::string file_name) { file_name_ = file_name; }

  void set_stream_gain(float gain_db) {
    set_stream_gain_ = true;
    stream_gain_db_ = gain_db;
  }
  void set_stream_mute(bool mute) {
    set_stream_mute_ = true;
    stream_mute_ = mute;
  }

  void set_will_ramp_stream_gain() { ramp_stream_gain_ = true; }
  void set_ramp_duration_nsec(zx_duration_t duration_nsec) { ramp_duration_nsec_ = duration_nsec; }
  void set_ramp_target_gain_db(float gain_db) { ramp_target_gain_db_ = gain_db; }

  void set_system_gain(float gain_db) {
    set_system_gain_ = true;
    system_gain_db_ = gain_db;
  }
  void set_system_mute(bool system_mute) {
    set_system_mute_ = true;
    system_mute_ = system_mute;
  }

  void set_audio_policy(fuchsia::media::AudioOutputRoutingPolicy policy) {
    set_policy_ = true;
    audio_policy_ = policy;
  }

  void set_device_settings(bool settings_enabled) {
    set_device_settings_ = true;
    settings_enabled_ = settings_enabled;
  }

  void Run(sys::ComponentContext* app_context);

 private:
  bool ParameterRangeChecks();
  void SetupPayloadCoefficients();
  void DisplayConfigurationSettings();
  void AcquireAudioRenderer(sys::ComponentContext* app_context);
  void SetStreamType();

  zx_status_t CreateMemoryMapping();

  struct AudioPacket {
    fuchsia::media::StreamPacket stream_packet;
    fzl::VmoMapper* vmo;
  };
  AudioPacket CreateAudioPacket(uint64_t packet_num);
  void GenerateAudioForPacket(const AudioPacket& packet, uint64_t payload_num);
  template <typename SampleType>
  static void WriteAudioIntoBuffer(SampleType* audio_buffer, uint32_t num_frames,
                                   uint64_t frames_since_start, OutputSignalType signal_type,
                                   uint32_t num_chans, double frames_per_period, double amp_scalar);

  void SendPacket(uint64_t payload_num);
  void OnSendPacketComplete();

  void Shutdown();

  fit::closure quit_callback_;

  fuchsia::media::AudioRendererPtr audio_renderer_;
  fuchsia::media::audio::GainControlPtr gain_control_;

  std::vector<fzl::VmoMapper> payload_buffers_;

  uint32_t num_channels_;
  uint32_t frame_rate_;
  bool use_int16_ = false;
  bool use_int24_ = false;
  uint32_t sample_size_;
  uint32_t frame_size_;

  OutputSignalType output_signal_type_;

  double frequency_;
  double frames_per_period_;  // frame_rate_ / frequency_

  double amplitude_;         // Amplitude between 0.0 and 1.0 (full-scale).
  double amplitude_scalar_;  // Amp translated to container-specific magn.

  double duration_secs_;
  uint32_t frames_per_payload_;
  uint32_t num_payload_buffers_;

  bool use_pts_ = false;
  bool set_continuity_threshold_ = false;
  float pts_continuity_threshold_secs_;

  uint32_t payload_mapping_size_;
  uint32_t payload_size_;
  uint32_t payloads_per_mapping_;
  uint32_t total_num_mapped_payloads_;

  uint64_t total_frames_to_send_;
  uint64_t num_packets_to_send_;
  uint64_t num_packets_sent_ = 0u;
  uint64_t num_packets_completed_ = 0u;

  bool save_to_file_ = false;
  std::string file_name_;
  media::audio::WavWriter<> wav_writer_;
  bool wav_writer_is_initialized_ = false;

  bool set_stream_gain_ = false;
  float stream_gain_db_ = 0.0;
  bool set_stream_mute_ = false;
  bool stream_mute_ = false;

  bool ramp_stream_gain_ = false;
  float ramp_target_gain_db_ = 0.0;
  zx_duration_t ramp_duration_nsec_;

  bool set_system_gain_ = false;
  float system_gain_db_;
  bool set_system_mute_ = false;
  bool system_mute_ = false;

  bool set_policy_ = false;
  fuchsia::media::AudioOutputRoutingPolicy audio_policy_;

  bool set_device_settings_ = false;
  bool settings_enabled_ = true;
};

}  // namespace media::tools

#endif  // SRC_MEDIA_AUDIO_TOOLS_SIGNAL_GENERATOR_SIGNAL_GENERATOR_H_