react-native-audio-api/src/plugin/withAudioAPI.ts

react-native-audio-api provides system for controlling audio in React Native environment compatible with Web Audio API specification

import {
  AndroidConfig,
  ConfigPlugin,
  createRunOncePlugin,
  withAndroidManifest,
  withGradleProperties,
  withInfoPlist,
  withPodfile,
} from '@expo/config-plugins';
const pkg = require('react-native-audio-api/package.json');

interface Options {
  iosMicrophonePermission?: string;
  iosBackgroundMode: boolean;
  androidPermissions: string[];
  androidForegroundService: boolean;
  androidFSTypes: string[];
  disableFFmpeg: boolean;
  disableStaticExternalLibs: boolean;
}

const withDefaultOptions = (options: Partial<Options>): Options => {
  return {
    iosBackgroundMode: true,
    androidPermissions: [
      'android.permission.FOREGROUND_SERVICE',
      'android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK',
    ],
    androidForegroundService: true,
    androidFSTypes: ['mediaPlayback'],
    disableFFmpeg: false,
    disableStaticExternalLibs: false,
    ...options,
  };
};

const withBackgroundAudio: ConfigPlugin = (config) => {
  return withInfoPlist(config, (iosConfig) => {
    iosConfig.modResults.UIBackgroundModes = [
      ...Array.from(
        new Set([...(iosConfig.modResults.UIBackgroundModes ?? []), 'audio'])
      ),
    ];

    return iosConfig;
  });
};

const withIosMicrophonePermission: ConfigPlugin<Options> = (
  config,
  { iosMicrophonePermission }
) => {
  return withInfoPlist(config, (iosConfig) => {
    iosConfig.modResults.NSMicrophoneUsageDescription = iosMicrophonePermission;
    return iosConfig;
  });
};

const withAndroidPermissions: ConfigPlugin<Options> = (
  config,
  { androidPermissions }: Options
) => {
  return AndroidConfig.Permissions.withPermissions(config, androidPermissions);
};

const withForegroundService: ConfigPlugin<Options> = (
  config,
  { androidFSTypes }: Options
) => {
  return withAndroidManifest(config, (mod) => {
    const manifest = mod.modResults;
    const mainApplication =
      AndroidConfig.Manifest.getMainApplicationOrThrow(manifest);

    const SFTypes = androidFSTypes.join('|');

    const serviceElement = {
      $: {
        'android:name':
          'com.swmansion.audioapi.system.CentralizedForegroundService',
        'android:stopWithTask': 'true',
        'android:foregroundServiceType': SFTypes,
      },
      intentFilter: [],
    };

    if (!mainApplication.service) {
      mainApplication.service = [];
    }

    const existingServiceIndex = mainApplication.service.findIndex((service) =>
      service.$['android:name'].includes(serviceElement.$['android:name'])
    );

    if (existingServiceIndex !== -1) {
      mainApplication.service[existingServiceIndex] = serviceElement;
      return mod;
    }

    mainApplication.service.push(serviceElement);
    return mod;
  });
};

const withFFmpegConfig: ConfigPlugin<Options> = (config, options) => {
  const iosConf = withPodfile(config, (mod) => {
    let contents = mod.modResults.contents;
    const ffmpegRegex = /^.*ENV\['DISABLE_AUDIOAPI_FFMPEG'\].*$/gm;
    const podfileString = options.disableFFmpeg
      ? `ENV['DISABLE_AUDIOAPI_FFMPEG'] = '1'`
      : '';
    // No existing setting
    if (contents.search(ffmpegRegex) === -1) {
      if (options.disableFFmpeg) {
        if (contents.endsWith('\n')) {
          contents = `${contents}${podfileString}`;
        } else {
          contents = `${contents}\n${podfileString}`;
        }
        mod.modResults.contents = contents;
      }
    } else {
      // Existing setting found, will replace
      contents = contents.replace(ffmpegRegex, podfileString);
    }

    mod.modResults.contents = contents;
    return mod;
  });

  const finalConf = withGradleProperties(iosConf, (mod) => {
    const gradleProperties = mod.modResults;

    const existingIndex = gradleProperties.findIndex(
      (prop) => prop.type === 'property' && prop.key === 'disableAudioapiFFmpeg'
    );
    if (existingIndex !== -1) {
      gradleProperties.splice(existingIndex, 1);
    } else if (!options.disableFFmpeg) {
      // No existing setting and FFmpeg is enabled, do nothing.
      return mod;
    }

    if (options.disableFFmpeg) {
      gradleProperties.push({
        type: 'property',
        key: 'disableAudioapiFFmpeg',
        value: options.disableFFmpeg ? 'true' : 'false',
      });
    }

    return mod;
  });

  return finalConf;
};

const withStaticExternalLibsConfig: ConfigPlugin<Options> = (
  config,
  options
) => {
  const iosConf = withPodfile(config, (mod) => {
    let contents = mod.modResults.contents;
    const staticLibsRegex =
      /^.*ENV\['DISABLE_AUDIOAPI_STATIC_EXTERNAL_LIBS'\].*$/gm;
    const podfileString = options.disableStaticExternalLibs
      ? `ENV['DISABLE_AUDIOAPI_STATIC_EXTERNAL_LIBS'] = '1'`
      : '';
    // No existing setting
    if (contents.search(staticLibsRegex) === -1) {
      if (options.disableStaticExternalLibs) {
        if (contents.endsWith('\n')) {
          contents = `${contents}${podfileString}`;
        } else {
          contents = `${contents}\n${podfileString}`;
        }
        mod.modResults.contents = contents;
      }
    } else {
      // Existing setting found, will replace
      contents = contents.replace(staticLibsRegex, podfileString);
    }

    mod.modResults.contents = contents;
    return mod;
  });

  const finalConf = withGradleProperties(iosConf, (mod) => {
    const gradleProperties = mod.modResults;

    const existingIndex = gradleProperties.findIndex(
      (prop) =>
        prop.type === 'property' &&
        prop.key === 'disableAudioapiStaticExternalLibs'
    );
    if (existingIndex !== -1) {
      gradleProperties.splice(existingIndex, 1);
    } else if (!options.disableStaticExternalLibs) {
      // No existing setting and static external libs are enabled, do nothing.
      return mod;
    }

    if (options.disableStaticExternalLibs) {
      gradleProperties.push({
        type: 'property',
        key: 'disableAudioapiStaticExternalLibs',
        value: options.disableStaticExternalLibs ? 'true' : 'false',
      });
    }

    return mod;
  });

  return finalConf;
};

const withAudioAPI: ConfigPlugin<Options> = (config, optionsIn) => {
  const options = withDefaultOptions(optionsIn ?? {});

  if (options.iosBackgroundMode) {
    config = withBackgroundAudio(config);
  }

  config = withAndroidPermissions(config, options);

  if (options.androidForegroundService) {
    config = withForegroundService(config, options);
  }

  if (options.iosMicrophonePermission) {
    config = withIosMicrophonePermission(config, options);
  }

  if (options.disableFFmpeg !== undefined) {
    config = withFFmpegConfig(config, options);
  }

  if (options.disableStaticExternalLibs !== undefined) {
    config = withStaticExternalLibsConfig(config, options);
  }

  return config;
};

export default createRunOncePlugin(withAudioAPI, pkg.name, pkg.version);