@siteed/expo-audio-stream 1.0.3 → 1.0.5

package/package.json

@@ -1,67 +1,74 @@
 {
-  "name": "@siteed/expo-audio-stream",
-  "version": "1.0.3",
-  "description": "stream audio crossplatform",
-  "license": "MIT",
-  "main": "build/index.js",
-  "types": "build/index.d.ts",
-  "author": "Arthur Breton <abreton@siteed.net> (https://github.com/deeeed)",
-  "homepage": "https://github.com/deeeed/expo-audio-stream#readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/deeeed/expo-audio-stream.git",
-    "directory": "packages/expo-audio-stream"
-  },
-  "bugs": {
-    "url": "https://github.com/deeeed/expo-audio-stream/issues"
-  },
-  "keywords": [
-    "react-native",
-    "expo",
-    "expo-audio-stream",
-    "ExpoAudioStream"
-  ],
-  "scripts": {
-    "build": "expo-module build",
-    "clean": "expo-module clean",
-    "lint": "expo-module lint",
-    "test": "expo-module test",
-    "prepare": "expo-module prepare",
-    "prepublishOnly": "expo-module prepublishOnly",
-    "expo-module": "expo-module",
-    "open:ios": "open -a \"Xcode\" ../../apps/playground/ios",
-    "open:android": "open -a \"Android Studio\" ../../apps/playground/android",
-    "size": "bundle-size && size-limit"
-  },
-  "devDependencies": {
-    "@expo/config-plugins": "^7.9.1",
-    "@size-limit/preset-big-lib": "^11.1.4",
-    "@types/debug": "^4.1.12",
-    "@types/node": "^20.12.7",
-    "@types/react": "^18.0.25",
-    "@typescript-eslint/eslint-plugin": "^7.7.0",
-    "@typescript-eslint/parser": "^7.7.0",
-    "bundle-size": "^1.1.5",
-    "eslint": "^8.56.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-config-universe": "^12.0.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-react": "^7.34.1",
-    "expo-module-scripts": "^3.5.2",
-    "expo-modules-core": "^1.12.19",
-    "prettier": "^3.2.5",
-    "react-native": "^0.74.3",
-    "size-limit": "^11.1.4"
-  },
-  "peerDependencies": {
-    "expo": "*",
-    "react": "*",
-    "react-native": "*"
-  },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
-  }
+    "name": "@siteed/expo-audio-stream",
+    "version": "1.0.5",
+    "description": "stream audio crossplatform",
+    "license": "MIT",
+    "main": "build/index.js",
+    "types": "build/index.d.ts",
+    "author": "Arthur Breton <abreton@siteed.net> (https://github.com/deeeed)",
+    "homepage": "https://github.com/deeeed/expo-audio-stream#readme",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/deeeed/expo-audio-stream.git",
+        "directory": "packages/expo-audio-stream"
+    },
+    "bugs": {
+        "url": "https://github.com/deeeed/expo-audio-stream/issues"
+    },
+    "keywords": [
+        "react-native",
+        "expo",
+        "expo-audio-stream",
+        "ExpoAudioStream"
+    ],
+    "scripts": {
+        "build": "expo-module build",
+        "clean": "expo-module clean",
+        "lint": "expo-module lint",
+        "test": "expo-module test",
+        "typecheck": "tsc --noEmit",
+        "prepare": "expo-module prepare",
+        "prepublishOnly": "expo-module prepublishOnly",
+        "expo-module": "expo-module",
+        "open:ios": "open -a \"Xcode\" ../../apps/playground/ios",
+        "open:android": "open -a \"Android Studio\" ../../apps/playground/android",
+        "size": "bundle-size && size-limit",
+        "release": "./publish.sh"
+    },
+    "devDependencies": {
+        "@expo/config-plugins": "^7.9.1",
+        "@size-limit/preset-big-lib": "^11.1.4",
+        "@types/jest": "^29.5.12",
+        "@types/node": "^20.12.7",
+        "@types/react": "^18.0.25",
+        "@typescript-eslint/eslint-plugin": "^7.7.0",
+        "@typescript-eslint/parser": "^7.7.0",
+        "bundle-size": "^1.1.5",
+        "eslint": "^8.56.0",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-config-universe": "^12.0.0",
+        "eslint-plugin-import": "^2.29.1",
+        "eslint-plugin-prettier": "^5.1.3",
+        "eslint-plugin-promise": "^6.1.1",
+        "eslint-plugin-react": "^7.34.1",
+        "expo-module-scripts": "^3.5.2",
+        "expo-modules-core": "^1.12.19",
+        "jest": "^29.7.0",
+        "prettier": "^3.2.5",
+        "react-native": "^0.74.3",
+        "size-limit": "^11.1.4",
+        "typescript": "^5.5.4"
+    },
+    "peerDependencies": {
+        "expo": "*",
+        "react": "*",
+        "react-native": "*"
+    },
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org"
+    },
+    "dependencies": {
+        "@siteed/react-native-logger": "^0.9.2"
+    }
 }

package/plugin/build/index.d.ts

@@ -1,4 +1,4 @@
-import { ConfigPlugin } from "@expo/config-plugins";
+import { ConfigPlugin } from '@expo/config-plugins';
 declare const withRecordingPermission: ConfigPlugin<{
     microphonePermission: string;
 }>;

package/plugin/build/index.js

@@ -1,26 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const config_plugins_1 = require("@expo/config-plugins");
-const MICROPHONE_USAGE = "Allow $(PRODUCT_NAME) to access your microphone";
+const MICROPHONE_USAGE = 'Allow $(PRODUCT_NAME) to access your microphone';
 const withRecordingPermission = (config, existingPerms) => {
     if (!existingPerms) {
-        console.warn("No previous permissions provided");
+        console.warn('No previous permissions provided');
     }
     config = (0, config_plugins_1.withInfoPlist)(config, (config) => {
-        config.modResults["NSMicrophoneUsageDescription"] = MICROPHONE_USAGE;
+        config.modResults['NSMicrophoneUsageDescription'] = MICROPHONE_USAGE;
         // Add audio to UIBackgroundModes to allow background audio recording
         const existingBackgroundModes = config.modResults.UIBackgroundModes || [];
-        if (!existingBackgroundModes.includes("audio")) {
-            existingBackgroundModes.push("audio");
+        if (!existingBackgroundModes.includes('audio')) {
+            existingBackgroundModes.push('audio');
         }
         config.modResults.UIBackgroundModes = existingBackgroundModes;
         return config;
     });
     config = (0, config_plugins_1.withAndroidManifest)(config, (config) => {
         const mainApplication = config_plugins_1.AndroidConfig.Manifest.getMainApplicationOrThrow(config.modResults);
-        config_plugins_1.AndroidConfig.Manifest.addMetaDataItemToMainApplication(mainApplication, "android.permission.RECORD_AUDIO", MICROPHONE_USAGE);
+        config_plugins_1.AndroidConfig.Manifest.addMetaDataItemToMainApplication(mainApplication, 'android.permission.RECORD_AUDIO', MICROPHONE_USAGE);
         // Add FOREGROUND_SERVICE permission for handling background recording
-        config_plugins_1.AndroidConfig.Manifest.addMetaDataItemToMainApplication(mainApplication, "android.permission.FOREGROUND_SERVICE", "This apps needs access to the foreground service to record audio in the background");
+        config_plugins_1.AndroidConfig.Manifest.addMetaDataItemToMainApplication(mainApplication, 'android.permission.FOREGROUND_SERVICE', 'This apps needs access to the foreground service to record audio in the background');
         return config;
     });
     return config;

package/plugin/src/index.ts

@@ -1,53 +1,53 @@
 import {
-  AndroidConfig,
-  ConfigPlugin,
-  withAndroidManifest,
-  withInfoPlist,
-} from "@expo/config-plugins";
+    AndroidConfig,
+    ConfigPlugin,
+    withAndroidManifest,
+    withInfoPlist,
+} from '@expo/config-plugins'
 
-const MICROPHONE_USAGE = "Allow $(PRODUCT_NAME) to access your microphone";
+const MICROPHONE_USAGE = 'Allow $(PRODUCT_NAME) to access your microphone'
 
 const withRecordingPermission: ConfigPlugin<{
-  microphonePermission: string;
+    microphonePermission: string
 }> = (config, existingPerms) => {
-  if (!existingPerms) {
-    console.warn("No previous permissions provided");
-  }
-  config = withInfoPlist(config, (config) => {
-    config.modResults["NSMicrophoneUsageDescription"] = MICROPHONE_USAGE;
-
-    // Add audio to UIBackgroundModes to allow background audio recording
-    const existingBackgroundModes = config.modResults.UIBackgroundModes || [];
-    if (!existingBackgroundModes.includes("audio")) {
-      existingBackgroundModes.push("audio");
+    if (!existingPerms) {
+        console.warn('No previous permissions provided')
     }
-    config.modResults.UIBackgroundModes = existingBackgroundModes;
-
-    return config;
-  });
-
-  config = withAndroidManifest(config, (config) => {
-    const mainApplication = AndroidConfig.Manifest.getMainApplicationOrThrow(
-      config.modResults,
-    );
-
-    AndroidConfig.Manifest.addMetaDataItemToMainApplication(
-      mainApplication,
-      "android.permission.RECORD_AUDIO",
-      MICROPHONE_USAGE,
-    );
-
-    // Add FOREGROUND_SERVICE permission for handling background recording
-    AndroidConfig.Manifest.addMetaDataItemToMainApplication(
-      mainApplication,
-      "android.permission.FOREGROUND_SERVICE",
-      "This apps needs access to the foreground service to record audio in the background",
-    );
-
-    return config;
-  });
-
-  return config;
-};
-
-export default withRecordingPermission;
+    config = withInfoPlist(config, (config) => {
+        config.modResults['NSMicrophoneUsageDescription'] = MICROPHONE_USAGE
+
+        // Add audio to UIBackgroundModes to allow background audio recording
+        const existingBackgroundModes =
+            config.modResults.UIBackgroundModes || []
+        if (!existingBackgroundModes.includes('audio')) {
+            existingBackgroundModes.push('audio')
+        }
+        config.modResults.UIBackgroundModes = existingBackgroundModes
+
+        return config
+    })
+
+    config = withAndroidManifest(config, (config) => {
+        const mainApplication =
+            AndroidConfig.Manifest.getMainApplicationOrThrow(config.modResults)
+
+        AndroidConfig.Manifest.addMetaDataItemToMainApplication(
+            mainApplication,
+            'android.permission.RECORD_AUDIO',
+            MICROPHONE_USAGE
+        )
+
+        // Add FOREGROUND_SERVICE permission for handling background recording
+        AndroidConfig.Manifest.addMetaDataItemToMainApplication(
+            mainApplication,
+            'android.permission.FOREGROUND_SERVICE',
+            'This apps needs access to the foreground service to record audio in the background'
+        )
+
+        return config
+    })
+
+    return config
+}
+
+export default withRecordingPermission

package/plugin/tsconfig.json

@@ -1,14 +1,9 @@
 {
-  "extends": "expo-module-scripts/tsconfig.plugin",
-  "compilerOptions": {
-    "outDir": "build",
-    "rootDir": "src"
-  },
-  "include": [
-    "./src",
-  ],
-  "exclude": [
-    "**/__mocks__/*",
-    "**/__tests__/*"
-  ]
-}
+    "extends": "expo-module-scripts/tsconfig.plugin",
+    "compilerOptions": {
+        "outDir": "build",
+        "rootDir": "src"
+    },
+    "include": ["./src"],
+    "exclude": ["**/__mocks__/*", "**/__tests__/*"]
+}

package/src/AudioAnalysis/AudioAnalysis.types.ts

@@ -4,82 +4,81 @@
  * Represents various audio features extracted from an audio signal.
  */
 export interface AudioFeatures {
-  energy: number; // The infinite integral of the squared signal, representing the overall energy of the audio.
-  mfcc: number[]; // Mel-frequency cepstral coefficients, describing the short-term power spectrum of a sound.
-  rms: number; // Root mean square value, indicating the amplitude of the audio signal.
-  minAmplitude: number; // Minimum amplitude value in the audio signal.
-  maxAmplitude: number; // Maximum amplitude value in the audio signal.
-  zcr: number; // Zero-crossing rate, indicating the rate at which the signal changes sign.
-  spectralCentroid: number; // The center of mass of the spectrum, indicating the brightness of the sound.
-  spectralFlatness: number; // Measure of the flatness of the spectrum, indicating how noise-like the signal is.
-  spectralRolloff: number; // The frequency below which a specified percentage (usually 85%) of the total spectral energy lies.
-  spectralBandwidth: number; // The width of the spectrum, indicating the range of frequencies present.
-  chromagram: number[]; // Chromagram, representing the 12 different pitch classes of the audio.
-  tempo: number; // Estimated tempo of the audio signal, measured in beats per minute (BPM).
-  hnr: number; // Harmonics-to-noise ratio, indicating the proportion of harmonics to noise in the audio signal.
+    energy: number // The infinite integral of the squared signal, representing the overall energy of the audio.
+    mfcc: number[] // Mel-frequency cepstral coefficients, describing the short-term power spectrum of a sound.
+    rms: number // Root mean square value, indicating the amplitude of the audio signal.
+    minAmplitude: number // Minimum amplitude value in the audio signal.
+    maxAmplitude: number // Maximum amplitude value in the audio signal.
+    zcr: number // Zero-crossing rate, indicating the rate at which the signal changes sign.
+    spectralCentroid: number // The center of mass of the spectrum, indicating the brightness of the sound.
+    spectralFlatness: number // Measure of the flatness of the spectrum, indicating how noise-like the signal is.
+    spectralRolloff: number // The frequency below which a specified percentage (usually 85%) of the total spectral energy lies.
+    spectralBandwidth: number // The width of the spectrum, indicating the range of frequencies present.
+    chromagram: number[] // Chromagram, representing the 12 different pitch classes of the audio.
+    tempo: number // Estimated tempo of the audio signal, measured in beats per minute (BPM).
+    hnr: number // Harmonics-to-noise ratio, indicating the proportion of harmonics to noise in the audio signal.
 }
 
 /**
  * Options to specify which audio features to extract.
  */
 export interface AudioFeaturesOptions {
-  energy?: boolean;
-  mfcc?: boolean;
-  rms?: boolean;
-  zcr?: boolean;
-  spectralCentroid?: boolean;
-  spectralFlatness?: boolean;
-  spectralRolloff?: boolean;
-  spectralBandwidth?: boolean;
-  chromagram?: boolean;
-  tempo?: boolean;
-  hnr?: boolean;
+    energy?: boolean
+    mfcc?: boolean
+    rms?: boolean
+    zcr?: boolean
+    spectralCentroid?: boolean
+    spectralFlatness?: boolean
+    spectralRolloff?: boolean
+    spectralBandwidth?: boolean
+    chromagram?: boolean
+    tempo?: boolean
+    hnr?: boolean
 }
 
 /**
  * Represents a single data point in the audio analysis.
  */
 export interface DataPoint {
-  id: number;
-  amplitude: number;
-  activeSpeech?: boolean;
-  dB?: number;
-  silent?: boolean;
-  features?: AudioFeatures;
-  startTime?: number;
-  endTime?: number;
-  // start / end position in bytes
-  startPosition?: number;
-  endPosition?: number;
-  // number of audio samples for this point (samples size depends on bit depth)
-  samples?: number;
-  // TODO: speaker detection
-  speaker?: number;
+    id: number
+    amplitude: number
+    activeSpeech?: boolean
+    dB?: number
+    silent?: boolean
+    features?: AudioFeatures
+    startTime?: number
+    endTime?: number
+    // start / end position in bytes
+    startPosition?: number
+    endPosition?: number
+    // number of audio samples for this point (samples size depends on bit depth)
+    samples?: number
+    // TODO: speaker detection
+    speaker?: number
 }
 
+export type AmplitudeAlgorithm = 'peak' | 'rms'
+
 /**
  * Represents the complete data from the audio analysis.
  */
-export interface AudioAnalysisData {
-  pointsPerSecond: number; // How many consolidated value per second
-  durationMs: number; // Duration of the audio in milliseconds
-  bitDepth: number; // Bit depth of the audio
-  samples: number; // Size of the audio in bytes
-  numberOfChannels: number; // Number of audio channels
-  sampleRate: number; // Sample rate of the audio
-  dataPoints: DataPoint[]; // Array of data points from the analysis.
-  amplitudeRange: {
-    min: number;
-    max: number;
-  };
-  // TODO: speaker detection
-  speakerChanges?: {
-    timestamp: number; // Timestamp of the speaker change in milliseconds.
-    speaker: number; // Speaker identifier.
-  }[];
+export interface AudioAnalysis {
+    pointsPerSecond: number // How many consolidated value per second
+    durationMs: number // Duration of the audio in milliseconds
+    bitDepth: number // Bit depth of the audio
+    samples: number // Size of the audio in bytes
+    numberOfChannels: number // Number of audio channels
+    sampleRate: number // Sample rate of the audio
+    dataPoints: DataPoint[] // Array of data points from the analysis.
+    amplitudeAlgorithm: AmplitudeAlgorithm // Algorithm used to calculate amplitude values.
+    amplitudeRange: {
+        min: number
+        max: number
+    }
+    // TODO: speaker detection
+    speakerChanges?: {
+        timestamp: number // Timestamp of the speaker change in milliseconds.
+        speaker: number // Speaker identifier.
+    }[]
 }
 
-export interface AudioAnalysisEventPayload {
-  analysis: AudioAnalysisData;
-  visualizationDuration: number;
-}