@siteed/expo-audio-stream 0.1.0 → 0.2.0

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "@siteed/expo-audio-stream",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "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": "https://github.com/deeeed/expo-audio-stream",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/deeeed/expo-audio-stream.git"
+  },
   "bugs": {
     "url": "https://github.com/deeeed/expo-audio-stream/issues"
   },
@@ -31,11 +34,13 @@
   },
   "dependencies": {
     "base-64": "^1.0.0",
+    "debug": "^4.3.4",
     "expo-file-system": "^16.0.9"
   },
   "devDependencies": {
     "@expo/config-plugins": "^7.9.1",
     "@release-it/conventional-changelog": "^8.0.1",
+    "@types/debug": "^4.1.12",
     "@types/react": "^18.0.25",
     "@typescript-eslint/eslint-plugin": "^7.7.0",
     "@typescript-eslint/parser": "^7.7.0",
@@ -56,6 +61,7 @@
     "react-native": "*"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
   }
 }

package/src/ExpoAudioStream.types.ts

@@ -5,21 +5,30 @@ export interface AudioEventPayload {
   from: number,
   deltaSize: number,
   totalSize: number,
+  mimeType: string;
   streamUuid: string,
 };
 
+export interface AudioStreamResult {
+  fileUri: string;
+  duration: number;
+  size: number;
+  mimeType: string;
+}
+
 export interface AudioStreamStatus {
   isRecording: boolean;
   isPaused: boolean;
   duration: number;
   size: number;
   interval: number;
+  mimeType: string;
 }
 
 export interface RecordingOptions {
   // TODO align Android and IOS options
-  sampleRate?: number;
-  channelConfig?: number; // numberOfChannel
-  audioFormat?: number; // bitDepth (ENCODING_PCM_16BIT --> 2)
+  // sampleRate?: number;
+  // channelConfig?: number; // numberOfChannel
+  // audioFormat?: number; // bitDepth (ENCODING_PCM_16BIT --> 2)
   interval?: number;
 }

package/src/ExpoAudioStreamModule.web.ts

@@ -1,6 +1,8 @@
 import { EventEmitter } from "expo-modules-core";
-import { AudioEventPayload, RecordingOptions } from "./ExpoAudioStream.types";
+import { AudioEventPayload, AudioStreamResult, RecordingOptions } from "./ExpoAudioStream.types";
+import debug from 'debug';
 
+const log =  debug("expo-audio-stream:useAudioRecording");
 class ExpoAudioStreamWeb extends EventEmitter {
     mediaRecorder: MediaRecorder | null;
     audioChunks: Blob[];
@@ -17,10 +19,10 @@ class ExpoAudioStreamWeb extends EventEmitter {
     constructor() {
         const mockNativeModule = {
             addListener: (eventName: string) => {
-                console.log(`Web addListener called for ${eventName}`);
+                // Not used on web
             },
             removeListeners: (count: number) => {
-                console.log(`Web removeListeners called, count: ${count}`);
+                // Not used on web
             }
         };
         super(mockNativeModule); // Pass the mock native module to the parent class
@@ -64,6 +66,8 @@ class ExpoAudioStreamWeb extends EventEmitter {
         this.pausedTime = 0;
         this.lastEmittedSize = 0;
         this.streamUuid = this.generateUUID(); // Generate a UUID for the new recording session
+        const fileUri = `${this.streamUuid}.webm`;
+        return fileUri;
     }
 
     // Setup listeners for the MediaRecorder
@@ -80,7 +84,7 @@ class ExpoAudioStreamWeb extends EventEmitter {
 
         this.mediaRecorder.onstop = () => {
             this.isRecording = false;
-            console.log('Recording stopped', this.audioChunks);
+            log('Recording stopped', this.audioChunks);
         };
 
         this.mediaRecorder.onpause = () => {
@@ -94,9 +98,10 @@ class ExpoAudioStreamWeb extends EventEmitter {
     }
 
     emitAudioEvent(data: Blob) {
-        const fileUri = `${this.streamUuid}.pcm`;
+        const fileUri = `${this.streamUuid}.webm`;
         const audioEventPayload: AudioEventPayload = {
             fileUri: fileUri,
+            mimeType: 'audio/webm',
             from: this.lastEmittedSize,  // Since this might be continuously streaming, adjust accordingly
             deltaSize: data.size,
             totalSize: this.currentSize,
@@ -117,12 +122,18 @@ class ExpoAudioStreamWeb extends EventEmitter {
     }
 
     // Stop recording
-    async stopRecording() {
-        console.debug('Stopping recording', this);
+    async stopRecording(): Promise<AudioStreamResult | null> {
         this.mediaRecorder?.stop();
         this.isRecording = false;
         this.currentDuration = (Date.now() - this.recordingStartTime) / 1000;
-        return this.currentDuration;
+        const result: AudioStreamResult = {
+            fileUri: `${this.streamUuid}.webm`,
+            duration: this.currentDuration,
+            size: this.currentSize,
+            mimeType: 'audio/webm',
+        }
+
+        return result;
     }
 
     // Pause recording

package/src/index.ts

@@ -8,11 +8,6 @@ import { useAudioRecorder } from './useAudioRecording';
 
 const emitter = new EventEmitter(ExpoAudioStreamModule ?? NativeModulesProxy.ExpoAudioStream);
 
-// Function to get the recording duration
-export function getRecordingDuration(): Promise<number> {
-  return ExpoAudioStreamModule.getRecordingDuration();
-}
-
 export function listAudioFiles(): Promise<string[]> {
   return ExpoAudioStreamModule.listAudioFiles();
 }
@@ -21,9 +16,8 @@ export function clearAudioFiles(): Promise<void> {
   return ExpoAudioStreamModule.clearAudioFiles();
 }
 
-export function addChangeListener(listener: (event: AudioEventPayload) => void): Subscription {
+export function addAudioEventListener(listener: (event: AudioEventPayload) => void): Subscription {
   return emitter.addListener<AudioEventPayload>('AudioData', listener);
 }
 
-
 export { AudioEventPayload, useAudioRecorder };

package/src/useAudioRecording.ts

@@ -2,16 +2,19 @@ import { NativeModulesProxy, EventEmitter, type Subscription, Platform } from 'e
 
 import { useCallback, useEffect, useState } from "react";
 import ExpoAudioStreamModule from './ExpoAudioStreamModule';
-import { AudioEventPayload, AudioStreamStatus, RecordingOptions } from "./ExpoAudioStream.types";
-import { addChangeListener } from '.';
+import { AudioEventPayload, AudioStreamResult, AudioStreamStatus, RecordingOptions } from "./ExpoAudioStream.types";
+import { addAudioEventListener } from '.';
 import * as FileSystem from 'expo-file-system';
 import { decode as atob } from 'base-64';
+import debug from 'debug';
 
 const emitter = new EventEmitter(ExpoAudioStreamModule ?? NativeModulesProxy.ExpoAudioStream);
 
+const log =  debug("expo-audio-stream:useAudioRecording");
+
 interface UseAudioRecorderState {
-    startRecording: (_: RecordingOptions) => Promise<void>;
-    stopRecording: () => Promise<number>;
+    startRecording: (_: RecordingOptions) => Promise<string | null>;
+    stopRecording: () => Promise<AudioStreamResult | null>;
     pauseRecording: () => void;
     isRecording: boolean;
     isPaused: boolean;
@@ -19,6 +22,7 @@ interface UseAudioRecorderState {
     size: number;      // Size in bytes of the recorded audio
 }
 
+
 export function useAudioRecorder({onAudioStream}: {onAudioStream?: (buffer: Blob) => void}): UseAudioRecorderState {
     const [isRecording, setIsRecording] = useState(false);
     const [isPaused, setIsPaused] = useState(false);
@@ -40,34 +44,43 @@ export function useAudioRecorder({onAudioStream}: {onAudioStream?: (buffer: Blob
 
 
   useEffect(() => {
-    const subscribe = addChangeListener(async ({fileUri, deltaSize, totalSize, from, streamUuid, encoded, buffer}) => {
-        console.debug(`Received audio event:`, {fileUri, deltaSize, totalSize, from, streamUuid, encodedLength: encoded?.length})
+    const subscribe = addAudioEventListener(async ({fileUri, deltaSize, totalSize, from, streamUuid, encoded, mimeType, buffer}) => {
+        log(`Received audio event:`, {fileUri, deltaSize, totalSize, mimeType, from, streamUuid, encodedLength: encoded?.length})
         if(deltaSize > 0) {
-            // Fetch the audio data from the fileUri
-            const options = {
-                encoding: FileSystem.EncodingType.Base64,
-                position: from,
-                length: deltaSize,
-              };
-
+            // Coming from native ( ios / android ) otherwise buffer is set
               if(Platform.OS !== 'web') {
                 // Read the audio file as a base64 string for comparison
                 try {
-                    const base64Content = await FileSystem.readAsStringAsync(fileUri, options);
-                    const binaryData = atob(base64Content);
+                    // convert encoded string to binary data
+                    const binaryData = atob(encoded);
                     const content = new Uint8Array(binaryData.length);
                     for (let i = 0; i < binaryData.length; i++) {
-                    content[i] = binaryData.charCodeAt(i);
+                        content[i] = binaryData.charCodeAt(i);
                     }
+                    const audioBlob = new Blob([content], { type: mimeType });
+
+                    // Below code is optional, used to compare encoded data to audio on file system
+                    // Fetch the audio data from the fileUri
+                    // const options = {
+                    //     encoding: FileSystem.EncodingType.Base64,
+                    //     position: from,
+                    //     length: deltaSize,
+                    // };
+                    // const base64Content = await FileSystem.readAsStringAsync(fileUri, options);
+                    // const binaryData = atob(base64Content);
+                    // const content = new Uint8Array(binaryData.length);
+                    // for (let i = 0; i < binaryData.length; i++) {
+                    // content[i] = binaryData.charCodeAt(i);
+                    // }
+                    // const audioBlob = new Blob([content], { type: 'application/octet-stream' }); // Create a Blob from the byte array
+                    // console.debug(`Read audio file (len: ${content.length}) vs ${deltaSize}`)
 
-                    // TODO: get the filetype based on audio setting and encoding
-                    const audioBlob = new Blob([content], { type: 'application/octet-stream' }); // Create a Blob from the byte array
-                    console.debug(`Read audio file (len: ${content.length}) vs ${deltaSize}`)
                     onAudioStream?.(audioBlob);
                 } catch (error) {
                     console.error('Error reading audio file:', error);
                 }
             } else if(buffer) {
+                // Coming from web
                 onAudioStream?.(buffer);
             }
         }
@@ -77,57 +90,37 @@ export function useAudioRecorder({onAudioStream}: {onAudioStream?: (buffer: Blob
 
 
     const startRecording = useCallback(async (recordingOptions: RecordingOptions) => {
-        if (!isRecording) {
-            setIsRecording(true);
-            setIsPaused(false);
-            setSize(0);
-            setDuration(0);
-            const startTime = Date.now();
-
-            console.log(`module shims`, ExpoAudioStreamModule)
-            try {
-                console.log(`start recoding`, recordingOptions)
-                await ExpoAudioStreamModule.startRecording(recordingOptions);
-
-            } catch (error) {
-                console.error('Error starting recording:', error);
-                setIsRecording(false);
-            }
-        }
-    }, [isRecording]);
-
-    const stopRecording = useCallback(async (): Promise<number> => {
-        if (isRecording) {
+        setIsRecording(true);
+        setIsPaused(false);
+        setSize(0);
+        setDuration(0);
+        try {
+            log(`start recoding`, recordingOptions)
+            const fileUrl = await ExpoAudioStreamModule.startRecording(recordingOptions);
+
+            return fileUrl;
+        } catch (error) {
+            console.error('Error starting recording:', error);
             setIsRecording(false);
-            setIsPaused(false);
-            try {
-                const recordedDuration = await ExpoAudioStreamModule.stopRecording();
-                setDuration(recordedDuration);
-                return recordedDuration;
-            } catch (error) {
-                console.error('Error stopping recording:', error);
-                return 0;
-            }
         }
-        return 0;
-    }, [isRecording]);
-
-    const pauseRecording = useCallback(() => {
-        if (isRecording) {
-            ExpoAudioStreamModule.stopRecording().catch(console.error);
+    }, []);
+
+    const stopRecording = useCallback(async () => {
+        setIsRecording(false);
+        setIsPaused(false);
+        const result: AudioStreamResult = await ExpoAudioStreamModule.stopRecording();
+        return result;
+    }, []);
+
+    const pauseRecording = useCallback(async () => {
+        try {
+            await ExpoAudioStreamModule.stopRecording()
             setIsPaused(true);
             setIsRecording(false);
+        } catch (error) {
+            console.error('Error pausing recording:', error);
         }
-    }, [isRecording]);
-
-    // Cleanup listener on unmount to prevent memory leaks
-    useEffect(() => {
-        return () => {
-            if (isRecording) {
-                ExpoAudioStreamModule.stopRecording().catch(console.error);
-            }
-        };
-    }, [isRecording]);
+    }, []);
 
     return {
         startRecording,

package/yarn-error.log

@@ -1,72 +0,0 @@
-Arguments: 
-  /Users/arthurbreton/.asdf/installs/nodejs/18.19.1/bin/node /Users/arthurbreton/.cache/node/corepack/yarn/1.22.19/bin/yarn.js
-
-PATH: 
-  /Users/arthurbreton/.asdf/plugins/nodejs/shims:/Users/arthurbreton/.asdf/installs/nodejs/18.19.1/.npm/bin:/Users/arthurbreton/.asdf/installs/nodejs/18.19.1/bin:/Users/arthurbreton/.docker/bin:/Users/arthurbreton/.asdf/shims:/opt/homebrew/opt/asdf/libexec/bin:/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/local/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/appleinternal/bin:/opt/X11/bin:/Library/Apple/usr/bin:/Applications/Wireshark.app/Contents/MacOS:/opt/homebrew/opt/libpq/bin:/Users/arthurbreton/Library/Android/sdk/platform-tools:/Users/arthurbreton/.docker/bin:/opt/homebrew/bin:/opt/homebrew/sbin:/Users/arthurbreton/.cargo/bin:/anaconda3/bin:/Users/arthurbreton/.foundry/bin:/opt/homebrew/anaconda3/bin
-
-Yarn version: 
-  1.22.19
-
-Node version: 
-  18.19.1
-
-Platform: 
-  darwin arm64
-
-Trace: 
-  SyntaxError: /Users/arthurbreton/Library/Caches/Yarn/v6/npm-xcode-3.0.1-3efb62aac641ab2c702458f9a0302696146aa53c-integrity/node_modules/xcode/package.json: Unexpected end of JSON input
-      at JSON.parse (<anonymous>)
-      at /Users/arthurbreton/.cache/node/corepack/yarn/1.22.19/lib/cli.js:1629:59
-      at Generator.next (<anonymous>)
-      at step (/Users/arthurbreton/.cache/node/corepack/yarn/1.22.19/lib/cli.js:310:30)
-      at /Users/arthurbreton/.cache/node/corepack/yarn/1.22.19/lib/cli.js:321:13
-
-npm manifest: 
-  {
-    "name": "expo-audio-stream",
-    "version": "0.1.0",
-    "description": "stream audio crossplatform",
-    "main": "build/index.js",
-    "types": "build/index.d.ts",
-    "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\" example/ios",
-      "open:android": "open -a \"Android Studio\" example/android"
-    },
-    "keywords": [
-      "react-native",
-      "expo",
-      "expo-audio-stream",
-      "ExpoAudioStream"
-    ],
-    "repository": "https://github.com/deeeed/expo-audio-stream",
-    "bugs": {
-      "url": "https://github.com/deeeed/expo-audio-stream/issues"
-    },
-    "author": "Arthur Breton <abreton@siteed.net> (https://github.com/deeeed)",
-    "license": "MIT",
-    "homepage": "https://github.com/deeeed/expo-audio-stream#readme",
-    "dependencies": {},
-    "devDependencies": {
-      "@types/react": "^18.0.25",
-      "expo-module-scripts": "^3.4.1",
-      "expo-modules-core": "^1.11.12"
-    },
-    "peerDependencies": {
-      "expo": "*",
-      "react": "*",
-      "react-native": "*"
-    }
-  }
-
-yarn manifest: 
-  No manifest
-
-Lockfile: 
-  No lockfile