@siteed/expo-audio-stream 2.1.0 → 2.2.0

package/README.md

@@ -1,5 +1,30 @@
 # @siteed/expo-audio-stream
 
+> ## ⚠️ Package Renamed
+> 
+> **This package has been renamed to [@siteed/expo-audio-studio](https://www.npmjs.com/package/@siteed/expo-audio-studio) to better reflect its expanded capabilities beyond just audio streaming.**
+>
+> While this package will continue to work as a compatibility wrapper, we recommend migrating to the new package name for future updates and improvements.
+>
+> ```bash
+> # Install the new package
+> npm install @siteed/expo-audio-studio
+> 
+> # or with yarn
+> yarn add @siteed/expo-audio-studio
+> ```
+>
+> **All imports should be updated from:**
+> ```typescript
+> import { ... } from '@siteed/expo-audio-stream';
+> ```
+> **To:**
+> ```typescript
+> import { ... } from '@siteed/expo-audio-studio';
+> ```
+>
+> The API remains identical, so this is the only change required.
+
 [![kandi X-Ray](https://kandi.openweaver.com/badges/xray.svg)](https://kandi.openweaver.com/typescript/siteed/expo-audio-stream)
 [![Version](https://img.shields.io/npm/v/@siteed/expo-audio-stream.svg)](https://www.npmjs.com/package/@siteed/expo-audio-stream)
 [![Dependency Status](https://img.shields.io/npm/dt/@siteed/expo-audio-stream.svg)](https://www.npmjs.com/package/@siteed/expo-audio-stream)
@@ -7,7 +32,7 @@
 
 <div align="center">
   <p align="center">
-    <strong>Comprehensive library designed to facilitate real-time audio processing and streaming across iOS, Android, and web platforms, with support for dual-stream recording and audio compression.</strong>
+    <strong>This package now serves as a compatibility wrapper for @siteed/expo-audio-studio.</strong>
   </p>
 
   <div style="display: flex; justify-content: center; gap: 20px; margin: 30px 0;">
@@ -31,233 +56,26 @@
 **Give it a GitHub star 🌟, if you found this repo useful.**
 [![GitHub stars](https://img.shields.io/github/stars/deeeed/expo-audio-stream.svg?style=social&label=Star&maxAge=2592000)](https://github.com/deeeed/expo-audio-stream)
 
-## Features
-
-- Real-time audio streaming across iOS, Android, and web.
-- Dual-stream recording capabilities:
-  - Simultaneous raw PCM and compressed audio recording
-  - Compression formats: OPUS or AAC
-  - Configurable bitrate for compressed audio
-  - Optimized storage for both high-quality and compressed formats
-- Intelligent interruption handling:
-  - Automatic pause/resume during phone calls
-  - Configurable automatic resumption
-  - Detailed interruption event callbacks
-- Configurable intervals for audio buffer receipt.
-- Automated microphone permissions setup in managed Expo projects.
-- Background audio recording on iOS.
-- Audio features extraction during recording.
-- Consistent WAV PCM recording format across all platforms.
-- Keep recording active while app is in background
-- Rich notification system for recording status:
-  - Android: Live waveform visualization in notifications
-  - Android: Fully customizable notification appearance and actions
-  - iOS: Media player integration
-- Advanced audio analysis capabilities:
-  - Mel spectrogram generation for machine learning and visualization
-  - Comprehensive audio feature extraction (MFCC, spectral features, etc.)
-  - Lightweight waveform preview generation
-- Precision audio manipulation:
-  - Advanced audio splitting and trimming API
-  - Support for trimming multiple segments in a single operation
-  - Ability to keep or remove specific time ranges
-- Complete ecosystem:
-  - Full-featured AudioPlayground application showcasing advanced API usage
-  - Ready-to-use UI components via [@siteed/expo-audio-ui](https://github.com/deeeed/expo-audio-stream/tree/main/packages/expo-audio-ui) package
-  - Visualizations, waveforms, and audio controls that can be directly incorporated into your app
-
-## Audio Analysis Features
-
-Extract powerful audio features for advanced audio processing and visualization:
-
-```typescript
-// Extract audio analysis with specific features enabled
-const analysis = await extractAudioAnalysis({
-  fileUri: 'path/to/recording.wav',
-  features: {
-    energy: true,     // Overall energy of the audio
-    rms: true,        // Root mean square (amplitude)
-    zcr: true,        // Zero-crossing rate
-    mfcc: true,       // Mel-frequency cepstral coefficients
-    spectralCentroid: true,  // Brightness of sound
-    tempo: true,      // Estimated BPM
-  }
-});
-```
-
-### Available Audio Features
-
-- **Basic Analysis**: RMS, energy, amplitude range, zero-crossing rate
-- **Spectral Features**: Spectral centroid, flatness, rolloff, bandwidth
-- **Advanced Analysis**: 
-  - MFCC (Mel-frequency cepstral coefficients)
-  - Chromagram (pitch class representation)
-  - Mel Spectrogram
-  - Harmonics-to-noise ratio
-  - Tempo estimation
-  - Pitch detection
-
-### Use Cases
-
-- Visualize audio waveforms with detailed metrics
-- Implement speech recognition preprocessing
-- Create music analysis applications
-- Build audio fingerprinting systems
-- Develop voice activity detection
-
-## API Overview
-
-The library provides several specialized APIs for different audio processing needs:
-
-### Recording and Playback
-
-- **useAudioRecorder**: Hook for recording audio with configurable quality settings
-- **AudioRecorderProvider**: Context provider for sharing recording state across components
-- **useSharedAudioRecorder**: Hook to access shared recording state from any component
-
-```typescript
-// Start a new recording with configuration
-const { startRecording, stopRecording, isRecording, recordingUri } = useAudioRecorder({
-  audioQuality: 'high',
-  sampleRate: 44100,
-  numberOfChannels: 2,
-  bitDepth: 16,
-  outputFormat: 'wav',
-});
-
-// Share recording state across components
-const AudioApp = () => (
-  <AudioRecorderProvider>
-    <RecordButton />
-    <AudioVisualizer />
-  </AudioRecorderProvider>
-);
-```
-
-### Audio Analysis
-
-- **extractAudioAnalysis**: Extract comprehensive audio features for detailed analysis
-- **extractPreview**: Generate lightweight waveform data for visualization
-- **extractAudioData**: Extract raw PCM data for custom processing
-- **extractRawWavAnalysis**: Analyze WAV files without decoding, preserving original PCM values
-
-```typescript
-// Extract detailed audio analysis with feature extraction
-const analysis = await extractAudioAnalysis({
-  fileUri: 'path/to/recording.wav',
-  features: { rms: true, zcr: true, mfcc: true }
-});
-
-// Generate a lightweight waveform preview
-const preview = await extractPreview({
-  fileUri: 'path/to/recording.wav',
-  pointsPerSecond: 50
-});
-
-// Extract raw PCM data for custom processing
-const audioData = await extractAudioData({
-  fileUri: 'path/to/recording.wav',
-  includeWavHeader: true
-});
-```
-
-#### Choosing the Right Audio Analysis Method
-
-| Method | Purpose | Performance | Use When |
-|--------|---------|-------------|----------|
-| `extractAudioAnalysis` | Comprehensive audio feature extraction | Medium-Heavy | You need detailed audio features like MFCC, spectral features |
-| `extractPreview` | Lightweight waveform visualization | Very Light | You only need amplitude data for visualization |
-| `extractAudioData` | Raw PCM data extraction | Medium | You need the raw audio data for custom processing |
-| `extractRawWavAnalysis` | WAV analysis without decoding | Light | You want to analyze WAV files while preserving original values |
-| `extractMelSpectrogram` | Mel spectrogram generation | Heavy | You need frequency-domain representation for ML or visualization |
-
-### Specialized Audio Processing
-
-- **extractMelSpectrogram**: Generate mel spectrogram for audio visualization or ML models
-- **trimAudio**: Trim audio files with precision, supporting multiple segments and formats
-
-```typescript
-// Generate mel spectrogram for audio visualization or ML models
-const melSpectrogram = await extractMelSpectrogram({
-  fileUri: 'path/to/recording.wav',
-  windowSizeMs: 25,
-  hopLengthMs: 10,
-  nMels: 40
-});
-
-// Trim audio files with precision
-const trimmedAudio = await trimAudio({
-  fileUri: 'path/to/recording.wav',
-  startTimeMs: 1000,
-  endTimeMs: 5000,
-  outputFormat: { format: 'wav' }
-});
-
-// Trim multiple segments from an audio file
-const compiledAudio = await trimAudio({
-  fileUri: 'path/to/recording.wav',
-  mode: 'keep',
-  ranges: [
-    { startTimeMs: 1000, endTimeMs: 5000 },
-    { startTimeMs: 10000, endTimeMs: 15000 }
-  ]
-});
-```
-
-### Utility Functions
-
-- **convertPCMToFloat32**: Convert PCM data to Float32Array for processing
-- **getWavFileInfo**: Extract metadata from WAV files
-- **writeWavHeader**: Create WAV headers for raw PCM data
-
-### Low-Level Access
-
-For advanced use cases, the library provides direct access to the native module:
-
-```typescript
-import { ExpoAudioStreamModule } from '@siteed/expo-audio-stream';
-
-// Access platform-specific functionality
-const status = await ExpoAudioStreamModule.status();
-const permissions = await ExpoAudioStreamModule.getPermissionsAsync();
-```
-
-## Documentation
-
-For detailed documentation, please refer to the [Getting Started Guide](https://deeeed.github.io/expo-audio-stream/docs/).
-
-## Companion Resources
-
-### AudioPlayground Application
-
-The repository includes a complete AudioPlayground application that demonstrates advanced usage of the API. This playground serves as both a demonstration and a learning resource:
-
-- Interactive examples of all major API features
-- Real-time audio visualization and analysis
-- Code samples you can directly reference for your own implementation
-
-Try it online at [https://deeeed.github.io/expo-audio-stream/playground](https://deeeed.github.io/expo-audio-stream/playground) or run it locally from the repository.
+## Why the name change?
 
-### UI Components Package
+The library has evolved significantly beyond its initial focus on audio streaming. It now provides a comprehensive suite of audio tools including:
 
-The [@siteed/expo-audio-ui](https://github.com/deeeed/expo-audio-stream/tree/main/packages/expo-audio-ui) package provides ready-to-use UI components for audio applications:
+- Advanced audio recording capabilities
+- Audio analysis and feature extraction
+- Waveform visualization
+- Audio trimming and manipulation
+- Mel spectrogram generation
+- And much more
 
-```bash
-# Install the UI components package
-npm install @siteed/expo-audio-ui
+The new name, "Audio Studio," better represents this expanded functionality as a complete audio processing toolkit.
 
-# or with yarn
-yarn add @siteed/expo-audio-ui
-```
+## Migration
 
-This package includes:
-- Waveform visualizers
-- Audio recording controls
-- Playback components
-- Spectrogram displays
-- And more!
+The migration process is simple:
 
-All components are built with React Native, Reanimated, and Skia for optimal performance across platforms.
+1. Install the new package: `yarn add @siteed/expo-audio-studio`
+2. Update your imports to use the new package name
+3. That's it! The API remains identical
 
 ## License
 

package/build/index.d.ts

@@ -1,15 +1,11 @@
-import { extractRawWavAnalysis, extractAudioAnalysis } from './AudioAnalysis/extractAudioAnalysis';
-import { extractAudioData } from './AudioAnalysis/extractAudioData';
-import { extractMelSpectrogram } from './AudioAnalysis/extractMelSpectrogram';
-import { extractPreview } from './AudioAnalysis/extractPreview';
-import { AudioRecorderProvider, useSharedAudioRecorder } from './AudioRecorder.provider';
-import ExpoAudioStreamModule from './ExpoAudioStreamModule';
-import { trimAudio } from './trimAudio';
-import { useAudioRecorder } from './useAudioRecorder';
-export * from './utils/convertPCMToFloat32';
-export * from './utils/getWavFileInfo';
-export * from './utils/writeWavHeader';
-export { AudioRecorderProvider, ExpoAudioStreamModule, extractRawWavAnalysis, extractAudioAnalysis, extractPreview, trimAudio, extractAudioData, extractMelSpectrogram, useAudioRecorder, useSharedAudioRecorder, };
-export type * from './AudioAnalysis/AudioAnalysis.types';
-export type * from './ExpoAudioStream.types';
-//# sourceMappingURL=index.d.ts.map
+/**
+* @siteed/expo-audio-stream
+*
+* DEPRECATED: This package has been renamed to @siteed/expo-audio-studio
+* This file serves as a compatibility wrapper that re-exports everything from the new package.
+*
+* Please update your imports to use @siteed/expo-audio-studio directly.
+*/
+import * as ExpoAudioStudio from '@siteed/expo-audio-studio';
+export * from '@siteed/expo-audio-studio';
+export default ExpoAudioStudio;

package/build/index.js

@@ -1,14 +1,44 @@
-// src/index.ts
-import { extractRawWavAnalysis, extractAudioAnalysis, } from './AudioAnalysis/extractAudioAnalysis';
-import { extractAudioData } from './AudioAnalysis/extractAudioData';
-import { extractMelSpectrogram } from './AudioAnalysis/extractMelSpectrogram';
-import { extractPreview } from './AudioAnalysis/extractPreview';
-import { AudioRecorderProvider, useSharedAudioRecorder, } from './AudioRecorder.provider';
-import ExpoAudioStreamModule from './ExpoAudioStreamModule';
-import { trimAudio } from './trimAudio';
-import { useAudioRecorder } from './useAudioRecorder';
-export * from './utils/convertPCMToFloat32';
-export * from './utils/getWavFileInfo';
-export * from './utils/writeWavHeader';
-export { AudioRecorderProvider, ExpoAudioStreamModule, extractRawWavAnalysis, extractAudioAnalysis, extractPreview, trimAudio, extractAudioData, extractMelSpectrogram, useAudioRecorder, useSharedAudioRecorder, };
-//# sourceMappingURL=index.js.map
+"use strict";
+/**
+* @siteed/expo-audio-stream
+*
+* DEPRECATED: This package has been renamed to @siteed/expo-audio-studio
+* This file serves as a compatibility wrapper that re-exports everything from the new package.
+*
+* Please update your imports to use @siteed/expo-audio-studio directly.
+*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ExpoAudioStudio = __importStar(require("@siteed/expo-audio-studio"));
+// Display deprecation warning
+console.warn('@siteed/expo-audio-stream is deprecated and will be removed in a future version. ' +
+    'Please migrate to @siteed/expo-audio-studio, which provides the same functionality with additional features.');
+// Re-export everything from the new package
+__exportStar(require("@siteed/expo-audio-studio"), exports);
+// For backward compatibility with default imports
+exports.default = ExpoAudioStudio;

package/package.json

@@ -1,111 +1,50 @@
 {
-  "name": "@siteed/expo-audio-stream",
-  "version": "2.1.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/blob/main/packages/expo-audio-stream/README.md",
-  "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"
-  ],
-  "files": [
-    "src",
-    "android",
-    "ios",
-    "cpp",
-    "plugin",
-    "app.plugin.js",
-    "LICENSE",
-    "CHANGELOG.md",
-    "generated",
-    "expo-module.config.json",
-    "README.md",
-    "package.json",
-    "*.podspec",
-    "build",
-    "!ios/build",
-    "!android/build",
-    "!android/gradle",
-    "!android/gradlew",
-    "!android/gradlew.bat",
-    "!android/local.properties",
-    "!**/__tests__",
-    "!**/__fixtures__",
-    "!**/__mocks__",
-    "!**/.*"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "build:plugin": "tsc --build plugin/tsconfig.json",
-    "build:plugin:dev": "expo-module build plugin",
-    "build:dev": "expo-module build",
-    "clean": "expo-module clean && rimraf plugin/build",
-    "lint": "expo-module lint",
-    "test": "expo-module test",
-    "typecheck": "tsc --noEmit",
-    "docgen": "typedoc src/index.ts --plugin typedoc-plugin-markdown --readme none --out ../../documentation_site/docs/api-reference/API",
-    "prepare": "yarn build && yarn build:plugin",
-    "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": "~9.0.0",
-    "@siteed/publisher": "^0.4.18",
-    "@size-limit/preset-big-lib": "^11.1.4",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.12.7",
-    "@types/react": "~18.3.12",
-    "@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": "^52.0.27",
-    "expo-module-scripts": "^4.0.2",
-    "jest": "^29.7.0",
-    "prettier": "^3.2.5",
-    "react-native": "0.76.6",
-    "rimraf": "^6.0.1",
-    "size-limit": "^11.1.4",
-    "ts-node": "^10.9.2",
-    "typedoc": "^0.27.4",
-    "typedoc-plugin-markdown": "^4.3.2",
-    "typescript": "~5.3.3"
-  },
-  "peerDependencies": {
-    "expo": "*",
-    "react": "*",
-    "react-native": "*"
-  },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
-  },
-  "dependencies": {
-    "@siteed/design-system": "^0.35.1",
-    "crc-32": "^1.2.2",
-    "expo-modules-core": "~2.1.4"
-  }
-}
+    "name": "@siteed/expo-audio-stream",
+    "version": "2.2.0",
+    "description": "DEPRECATED: Use @siteed/expo-audio-studio instead. This package now serves as a compatibility wrapper.",
+    "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/blob/main/packages/expo-audio-stream/README.md",
+    "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",
+        "audio",
+        "deprecated"
+    ],
+    "files": [
+        "src",
+        "build",
+        "LICENSE",
+        "README.md",
+        "package.json"
+    ],
+    "scripts": {
+        "build": "tsc",
+        "prepare": "yarn build"
+    },
+    "peerDependencies": {
+        "expo": "*",
+        "react": "*",
+        "react-native": "*"
+    },
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org"
+    },
+    "dependencies": {
+        "@siteed/expo-audio-studio": "2.1.1"
+    },
+    "devDependencies": {
+        "typescript": "~5.3.3"
+    }
+}

package/src/index.ts

@@ -1,36 +1,22 @@
-// src/index.ts
+ /**
+ * @siteed/expo-audio-stream
+ * 
+ * DEPRECATED: This package has been renamed to @siteed/expo-audio-studio
+ * This file serves as a compatibility wrapper that re-exports everything from the new package.
+ * 
+ * Please update your imports to use @siteed/expo-audio-studio directly.
+ */
 
-import {
-    extractRawWavAnalysis,
-    extractAudioAnalysis,
-} from './AudioAnalysis/extractAudioAnalysis'
-import { extractAudioData } from './AudioAnalysis/extractAudioData'
-import { extractMelSpectrogram } from './AudioAnalysis/extractMelSpectrogram'
-import { extractPreview } from './AudioAnalysis/extractPreview'
-import {
-    AudioRecorderProvider,
-    useSharedAudioRecorder,
-} from './AudioRecorder.provider'
-import ExpoAudioStreamModule from './ExpoAudioStreamModule'
-import { trimAudio } from './trimAudio'
-import { useAudioRecorder } from './useAudioRecorder'
+import * as ExpoAudioStudio from '@siteed/expo-audio-studio';
 
-export * from './utils/convertPCMToFloat32'
-export * from './utils/getWavFileInfo'
-export * from './utils/writeWavHeader'
+// Display deprecation warning
+console.warn(
+  '@siteed/expo-audio-stream is deprecated and will be removed in a future version. ' +
+  'Please migrate to @siteed/expo-audio-studio, which provides the same functionality with additional features.'
+);
 
-export {
-    AudioRecorderProvider,
-    ExpoAudioStreamModule,
-    extractRawWavAnalysis,
-    extractAudioAnalysis,
-    extractPreview,
-    trimAudio,
-    extractAudioData,
-    extractMelSpectrogram,
-    useAudioRecorder,
-    useSharedAudioRecorder,
-}
+// Re-export everything from the new package
+export * from '@siteed/expo-audio-studio';
 
-export type * from './AudioAnalysis/AudioAnalysis.types'
-export type * from './ExpoAudioStream.types'
+// For backward compatibility with default imports
+export default ExpoAudioStudio;