#!/bin/bash

dotpi_audio_device_supported=(
  'default'
  'none'
  'headphones'
  'bluetooth'
  'hifiberry amp+'
  'hifiberry amp2'
  'hifiberry amp3'
  'hifiberry amp4 pro'
  'hifiberry amp4'
  'hifiberry beocreate'
  'hifiberry dac for raspberry pi 1'
  'hifiberry dac zero'
  'hifiberry dac+ adc pro'
  'hifiberry dac+ adc'
  'hifiberry dac+ dsp'
  'hifiberry dac+ light'
  'hifiberry dac+ rtc'
  'hifiberry dac+ standard'
  'hifiberry dac2 hd'
  'hifiberry digi+ pro'
  'hifiberry digi+'
  'hifiberry miniamp'
  'hifiberry pro'
  'iqaudio codec zero'
  'iqaudio dac pro'
  'iqaudio dac+'
  'iqaudio digiamp+'
  'raspberry pi codec zero'
  'raspberry pi dac pro'
  'raspberry pi dac+'
  'raspberry pi digiamp+'
  'raspiaudio mic+ v1'
  'raspiaudio mic+ v2'
  'raspiaudio ultra'
  'ue boom 2'
  'ue boom 3'
  'ue megaboom 2'
  'ue megaboom 3'
)

dotpi_audio_device_is_analog() {
  audio_device="${1:-$dotpi_audio_device}"
  case "$audio_device" in
    'headphones')
      return 0
      ;;
    *)
      return 1
      ;;
  esac
}

_dotpi_audio_device_get_options() {

  _echo_empty_option_error() {
    dotpi_echo_error "$1 requires a non-empty option argument."
  }

  # From http://mywiki.wooledge.org/BashFAQ/035

  while true ; do
    case $1 in

      -h|-\?|--help)
        _dotpi_usage    # Display a usage synopsis.
        return 0
        ;;

      -m|--model)       # Takes an option argument; ensure it has been specified.
        if [ -z "$2" ] ; then
            _dotpi_usage
            _echo_empty_option_error "$1"
            return 1
        else
            model="$2"
            shift
        fi
        ;;

      -c|--config)       # Takes an option argument; ensure it has been specified.
        if [ -z "$2" ] ; then
            _dotpi_usage
            _echo_empty_option_error "$1"
            return 1
        else
            config_file="$2"
            shift
        fi
        ;;

      --)              # End of all options.
        shift
        break
        ;;

      -?*) # Unknown
        _dotpi_usage
        dotpi_echo_error "Unknown option: $1"
        return 1
        ;;

      *)               # Default case: No more options, so break out of the loop.
        break

    esac

    shift
  done

}

dotpi_audio_device_model_normalise() {
  echo "$1" | tr '[:upper:]' '[:lower:]'
}

# Usage: sudo dotpi audio_device_select --model <model> [--config <config_file_path>]
# if --config is not provided, it will use the system default config file
dotpi_audio_device_select() (
  # sub-shell to keep everything local (functions and variables)

  _dotpi_command="$(basename -- "${FUNCNAME[0]:-"$0"}")"
  _dotpi_usage() {
    echo "Usage: ${_dotpi_command} --model <model> [--config <config_file_path>]"
  }

  # Initialize all the option variables.
  # This ensures we are not contaminated by variables from the environment.
  model=
  config_file=

  if ! _dotpi_audio_device_get_options "${@}" ; then
    return $?
  fi

  if [ -z "$model" ] ; then
    _dotpi_usage
    dotpi_echo_error "missing model option"
    return 1
  fi

  if [ -z "$config_file" ] ; then
    config_path="$(dotpi_system_get_bootfs_path)"
    if [ -z "$config_path" ] ; then
      dotpi_echo_error "Unable to get default system path for config file"
      _dotpi_usage
      return 1
    fi
    config_filename='config.txt'
    config_file="${config_path}/${config_filename}"
    dotpi_echo_warning "Using default config file ${config_file}"
  fi


  if ! [ -w "$config_file" ] ; then
    dotpi_echo_error "Unable to access config file ${config_file} for writing"
    return 1
  fi

  # lowercase everything
  model_normalised="$(dotpi_audio_device_model_normalise "$model")"

  case "$model_normalised" in

    ######## Generic devices

    'default')
      dotpi_echo_warning "Not installing a specific audio device, keeping defaults"
      ;;

    'none')
      _dotpi_audio_device_disable_all
      ;;

    'headphones')
      _dotpi_audio_device_select_headphones
      ;;

    'bluetooth')
      dotpi_echo_info "Installing generic bluetooth device"
      _dotpi_audio_device_select_bluetooth
      ;;

    ######## Specific devices

    # Raspberry
    # Cf. https://www.raspberrypi.com/documentation/accessories/audio.html#configuration

    'raspberry pi dac pro'|'iqaudio dac pro')
      dtoverlay=rpi-dacpro
      _dotpi_audio_device_select_raspberry_pi
      ;;

    'raspberry pi dac+'|'iqaudio dac+')
      dtoverlay='rpi-dacplus,auto_mute_amp'
      _dotpi_audio_device_select_raspberry_pi
      ;;

    'raspberry pi digiamp+'|'iqaudio digiamp+')
      dtoverlay='rpi-digiampplus,auto_mute_amp'
      _dotpi_audio_device_select_raspberry_pi
      ;;

    'raspberry pi codec zero'|'iqaudio codec zero')
      dtoverlay=rpi-codeczero
      _dotpi_audio_device_select_raspberry_pi
      ;;

    # HiFiBerry
    # Cf. https://www.hifiberry.com/docs/software/configuring-linux-3-18-x/

    'hifiberry dac for raspberry pi 1'|'hifiberry dac+ light'|'hifiberry dac zero'|'hifiberry miniamp'|'hifiberry beocreate'|'hifiberry dac+ dsp'|'hifiberry dac+ rtc')
      dtoverlay=hifiberry-dac
      _dotpi_audio_device_select_hifiberry
      ;;

    'hifiberry dac+ standard'|'hifiberry pro')
      dtoverlay=hifiberry-dacplus-std
      _dotpi_audio_device_select_hifiberry
      ;;

    'hifiberry dac2 hd')
      dtoverlay=hifiberry-dacplushd
      _dotpi_audio_device_select_hifiberry
      ;;

    'hifiberry dac+ adc')
      dtoverlay=hifiberry-dacplusadc
      _dotpi_audio_device_select_hifiberry
      ;;

    'hifiberry dac+ adc pro')
      dtoverlay=hifiberry-dacplusadcpro
      _dotpi_audio_device_select_hifiberry
      ;;

    'hifiberry digi+')
      dtoverlay=hifiberry-digi
      _dotpi_audio_device_select_hifiberry
      ;;

    'hifiberry digi+ pro')
      dtoverlay=hifiberry-digi-pro
      _dotpi_audio_device_select_hifiberry
      ;;

    'hifiberry amp+')
      dtoverlay=hifiberry-amp
      _dotpi_audio_device_select_hifiberry
      ;;

    'hifiberry amp3')
      dtoverlay=hifiberry-amp3
      _dotpi_audio_device_select_hifiberry
    ;;

    'hifiberry amp2'|'hifiberry amp4')
      dtoverlay=hifiberry-dacplus
      _dotpi_audio_device_select_hifiberry
      ;;

    'hifiberry amp4 pro')
      dtoverlay=hifiberry-amp4pro
      _dotpi_audio_device_select_hifiberry
      ;;

    'raspiaudio mic+ v1' | 'raspiaudio mic+ v2')
      dtoverlay=googlevoicehat-soundcard
      _dotpi_audio_device_select_raspiaudio
      ;;

    # Raspiaudio ULTRA (WM8960 codec, driver in kernel)
    # Cf. https://forum.raspiaudio.com/t/ultra-installation-guide/21
    'raspiaudio ultra')
      dtoverlay=wm8960-soundcard
      _dotpi_audio_device_select_raspiaudio
      ;;

    ####### Ultimate Ears (UE)

    'ue boom 2'|'ue boom 3'|'ue megaboom 2'|'ue megaboom 3')
      _dotpi_audio_device_select_bluetooth
      ;;


    ########### Unknown device

    *) # other
      _dotpi_usage
      dotpi_echo_error "Unknown audio device model: ${model}"
      return 1
      ;;

  esac

  # use xargs to unquote value
  model_project="$(dotpi_configuration_read \
                     --file "${DOTPI_ROOT}/etc/dotpi_environment_project.bash" \
                     --key dotpi_audio_device \
                     | xargs)"


  if [[ "$model_normalised" == "$(dotpi_audio_device_model_normalise "$model_project")" ]] ; then
    # no need to update environment
    return 0;
  fi

  dotpi_echo_warning 'Audio device model is specific to this instance'

  # comment setting in project
  dotpi_configuration_comment --file "${DOTPI_ROOT}/etc/dotpi_environment_project.bash" \
                            --key dotpi_audio_device

  # escape double-quote for now, to quote when writing later
  model_value="$(echo "$model" | dotpi_sed 's/"/\\"/g')"

  # write changed setting in instance
  # be sure to quote value
  dotpi_configuration_write --file "${DOTPI_ROOT}/etc/dotpi_environment_instance.bash" \
                            --key dotpi_audio_device \
                            --value \""${model_value}"\"
)

_dotpi_audio_device_disable_all() (
  exception_family="$1"

  if [[ "$exception_family" = "" ]] ; then
    dotpi_echo_info "Disabling all audio devices"
  else
    dotpi_echo_info "Disabling all audio devices except ${exception_family}"
  fi

  if [[ ! "$exception_family" = "headphones" ]] ; then
    _dotpi_audio_device_disable_headphones
  fi

  if [[ ! "$exception_family" = "hdmi" ]] ; then
    _dotpi_audio_device_disable_hdmi
  fi

  if [[ ! "$exception_family" = "raspberry_pi" ]] ; then
    _dotpi_audio_device_disable_raspberry_pi
  fi

  if [[ ! "$exception_family" = "hifiberry" ]] ; then
    _dotpi_audio_device_disable_hifiberry
  fi

  if [[ ! "$exception_family" = "raspiaudio" ]] ; then
    _dotpi_audio_device_disable_raspiaudio
  fi

)

_dotpi_audio_device_select_headphones() (
  dotpi_echo_info "Installing Headphones (default) audio device"

  _dotpi_audio_device_disable_all headphones

  # un-comment  dtparam=audio as it must be set first
  # (setting at the end the the file fails)
  pattern="$(dotpi_configuration_get_pattern --prefix "# dtparam=audio")"
  perl -pe "s/${pattern}/"'dtparam=audio=on/' -i -- "$config_file"
)

_dotpi_audio_device_select_bluetooth() (
  _dotpi_audio_device_disable_all bluetooth
  bluetoothctl power off
  rfkill unblock all
  sudo bluetoothctl power on
)

_dotpi_audio_device_select_raspberry_pi() (
  dotpi_echo_info "Configuring Raspberry Pi audio device '${model}'"

  _dotpi_audio_device_disable_all raspberry_pi

  mkdir -p "$(dirname -- "$config_file")"
  cat >> "$config_file" << EOF

# dotpi: overlay for audio device '${model}'
dtoverlay=${dtoverlay}

EOF
)


_dotpi_audio_device_select_hifiberry() (
  dotpi_echo_info "Configuring HiFiBerry audio device '${model}'"

  _dotpi_audio_device_disable_all hifiberry

  mkdir -p "$(dirname -- "$config_file")"
  cat >> "$config_file" << EOF

# dotpi: overlay for audio device '${model}'
dtoverlay=${dtoverlay}

EOF
)

_dotpi_audio_device_select_raspiaudio() (
  dotpi_echo_info "Configuring Raspiaudio device '${model}'"

  _dotpi_audio_device_disable_all raspiaudio

  mkdir -p "$(dirname -- "$config_file")"
  cat >> "$config_file" << EOF

# dotpi: overlay for audio device '${model}'
dtoverlay=${dtoverlay}

EOF
)

_dotpi_audio_device_disable_headphones() (
  dotpi_echo_info "Disabling headphones"
  # disable internal audio device
  dotpi_configuration_comment --file "$config_file" --key 'dtparam=audio'
)

_dotpi_audio_device_disable_hdmi() (
  dotpi_echo_info "Disabling HDMI audio"
  # disable HDMI audio

  # new systems
  pattern="$(dotpi_configuration_get_pattern --prefix "dtoverlay=vc4-kms-v3d")"
  perl -pe "s/${pattern}/"'${1}${2},noaudio/' -i -- "$config_file"

  # old systems
  pattern="$(dotpi_configuration_get_pattern --prefix "dtoverlay=vc4-fkms-v3d")"
  perl -pe "s/${pattern}/"'${1}${2},audio=off/' -i -- "$config_file"
)

_dotpi_audio_device_disable_raspberry_pi() (
  dotpi_echo_info "Disabling Raspberry Pi audio"

  # disable hifiberry
  pattern="$(dotpi_configuration_get_pattern --prefix "dtoverlay=rpi-")"
  perl -pe "s/${pattern}/"'${1}# ${2}${3}/' -i -- "$config_file"
)

_dotpi_audio_device_disable_hifiberry() (
  dotpi_echo_info "Disabling HiFiBerry audio"

  # disable hifiberry
  pattern="$(dotpi_configuration_get_pattern --prefix "dtoverlay=hifiberry-")"
  perl -pe "s/${pattern}/"'${1}# ${2}${3}/' -i -- "$config_file"
)

_dotpi_audio_device_disable_raspiaudio() (
  dotpi_echo_info "Disabling Raspiaudio"

  # disable Mic+ (googlevoicehat) and ULTRA (wm8960)
  for overlay in googlevoicehat-soundcard wm8960-soundcard ; do
    pattern="$(dotpi_configuration_get_pattern --prefix "dtoverlay=${overlay}")"
    perl -pe "s/${pattern}/"'${1}# ${2}${3}/' -i -- "$config_file"
  done
)

_dotpi_audio_device_volume_set_alsa() (
  amixer -- sset "$control" "$volume"
  alsactl store

  if [[ "$volume" ==  "$dotpi_audio_volume" ]] ; then
    # no change to write
    return 0
  fi

  # comment setting in project
  dotpi_configuration_comment --file "${DOTPI_ROOT}/etc/dotpi_environment_project.bash" \
                              --key dotpi_audio_volume

  # escape double-quote for now, to quote when writing later
  model_value="$(echo "$model" | dotpi_sed 's/"/\\"/g')"

  # write changed setting in instance
  dotpi_configuration_write --file "${DOTPI_ROOT}/etc/dotpi_environment_instance.bash" \
                            --key dotpi_audio_volume \
                            --value "$volume"
)

dotpi_audio_device_init() (

  if [[ -z "$dotpi_audio_device" ]] ; then
    dotpi_echo_warning "dotpi_audio_device not set, keeping default audio device"
    return 0
  fi

  model_normalised="$(dotpi_audio_device_model_normalise "$dotpi_audio_device")"

  # hardware
    case "$model_normalised" in
      'raspberry pi codec zero'|'iqaudio codec zero')

      usr_repository="raspberrypi/Pi-Codec"
      usr_directory="${DOTPI_ROOT}/usr/${usr_repository}"

      # clone once to be able to init offline
      if ! [[ -d "${usr_directory}" ]] ; then
        mkdir -p "${usr_directory}"
        git clone "https://github.com/${usr_repository}.git" "${usr_directory}" || {
          dotpi_echo_error "Unable to clone repository ${usr_repository}"
          return 1
        }
      fi

      alsactl restore -f "${usr_directory}/Codec_Zero_StereoMIC_record_and_HP_playback.state"
      ;;

    'raspiaudio ultra')

      usr_repository="RASPIAUDIO/ULTRA"
      usr_directory="${DOTPI_ROOT}/usr/${usr_repository}"

      # clone once to be able to init offline
      if ! [[ -d "${usr_directory}" ]] ; then
        mkdir -p "${usr_directory}"
        git clone "https://github.com/${usr_repository}.git" "${usr_directory}" || {
          dotpi_echo_error "Unable to clone repository ${usr_repository}"
          return 1
        }
      fi

      # routes DAC to headphones and speakers, onboard mics to ADC
      alsactl restore -f "${usr_directory}/headphones.alsa"
      ;;

    esac

  # alsa
  case "$model_normalised" in

    'headphones')

      amixer -D sysdefault sset -- 'PCM' 'on'
      amixer -D sysdefault sset -- 'PCM' '0dB'
      alsactl store
    ;;

    'raspberry pi dac pro'|'iqaudio dac pro' \
    | 'raspberry pi dac+'|'iqaudio dac+' \
    | 'raspberry pi digiamp+'|'iqaudio digiamp+' \
    | 'raspberry pi codec zero'|'iqaudio codec zero')

      amixer -D sysdefault sset -- 'Headphone' 'on'
      amixer -D sysdefault sset -- 'Headphone' '0dB'

      amixer -D sysdefault sset -- 'Lineout' 'on'
      amixer -D sysdefault sset -- 'Lineout' '0dB'

      alsactl store
    ;;

    'raspiaudio mic+ v1' | 'raspiaudio mic+ v2')

      # no controller for device, use default 'Master' control
      amixer sset -- 'Master' 'on'
      amixer sset -- 'Master' '80%'

      alsactl store
      ;;

  esac

)

# set and store volume for the current audio device
dotpi_audio_device_volume_set() (
  volume="$1"

  model="$dotpi_audio_device"
  # lowercase everything
  model_normalised="$(dotpi_audio_device_model_normalise "$model")"

  case "$model_normalised" in

    ####### Generic devices

    'headphones')
      control='PCM'
      _dotpi_audio_device_volume_set_alsa
      ;;

    'bluetooth')
      dotpi_audio_bluetooth_destination_volume_set "$volume"
      ;;


    ####### Specific devices

    # HiFiBerry
    # Cf. https://www.hifiberry.com/docs/archive/mixer-controls-on-the-hifiberry-boards/


    'hifiberry dac+ dsp'|'hifiberry dac+ rtc'|'hifiberry dac+ standard'|'hifiberry amp2'|'hifiberry dac+ adc'|'hifiberry dac+ adc pro'|'hifiberry amp3')
      control='Digital'
      _dotpi_audio_device_volume_set_alsa
      ;;

    'hifiberry dac2 hd')
      control='DAC'
      _dotpi_audio_device_volume_set_alsa
      ;;

    'hifiberry amp+'|'hifiberry amp4'|'hifiberry amp4 pro')
      control='Master'
      _dotpi_audio_device_volume_set_alsa
      ;;

    'raspiaudio mic+ v1' | 'raspiaudio mic+ v2')
      control='Master'
      _dotpi_audio_device_volume_set_alsa
      ;;

    'raspiaudio ultra')
      # WM8960 DAC digital volume, acts on both headphones and speakers
      control='Playback'
      _dotpi_audio_device_volume_set_alsa
      ;;


    ####### Ultimate Ears (UE)

    'ue boom 2'|'ue boom 3'|'ue megaboom 2'|'ue megaboom 3')
      dotpi_audio_bluetooth_destination_volume_set "$volume"
      ;;

    ########### Unknown device

    *) # other
      dotpi_echo_error "Unable to set volume for unknown audio device model: ${model}"
      return 1
      ;;


  esac
)

# restore volume for the current audio device
dotpi_audio_device_volume_init() (
  if [[ -z "$dotpi_audio_volume" ]] ; then
    dotpi_echo_warning "dotpi_audio_volume not set, keeping default volume"
    return 0
  fi

  destination_volume="$dotpi_audio_volume"
  dotpi_audio_device_volume_set "$destination_volume"
)


