@siteed/expo-audio-studio 2.18.6 → 3.0.1

package/README.md

@@ -1,306 +1,22 @@
-# @siteed/expo-audio-studio
+# @siteed/expo-audio-studio (DEPRECATED)
 
-[![kandi X-Ray](https://kandi.openweaver.com/badges/xray.svg)](https://kandi.openweaver.com/typescript/siteed/expo-audio-studio)
-[![Version](https://img.shields.io/npm/v/@siteed/expo-audio-studio.svg)](https://www.npmjs.com/package/@siteed/expo-audio-studio)
-[![Dependency Status](https://img.shields.io/npm/dt/@siteed/expo-audio-studio.svg)](https://www.npmjs.com/package/@siteed/expo-audio-studio)
-[![License](https://img.shields.io/npm/l/@siteed/expo-audio-studio.svg)](https://www.npmjs.com/package/@siteed/expo-audio-studio)
+This package has been renamed to **@siteed/audio-studio**.
 
-<div align="center">
-  <p align="center">
-    <strong>Comprehensive audio studio library for React Native and Expo with recording, analysis, visualization, and streaming capabilities across iOS, Android, and web platforms.</strong>
-  </p>
-
-  <div style="display: flex; justify-content: center; gap: 20px; margin: 30px 0;">
-    <div>
-      <h3>iOS Demo</h3>
-      <img src="../../docs/ios.gif" alt="iOS Demo" width="280" />
-    </div>
-    <div>
-      <h3>Android Demo</h3>
-      <img src="../../docs/android.gif" alt="Android Demo" width="280" />
-    </div>
-  </div>
-
-  <div style="display: flex; flex-direction: column; align-items: center; margin-bottom: 20px;">
-    <p><strong>Try AudioPlayground: Complete audio processing app built with this library</strong></p>
-    <div style="display: flex; justify-content: center; gap: 20px; margin: 10px 0;">
-      <a href="https://apps.apple.com/app/audio-playground/id6739774966">
-        <img src="https://developer.apple.com/app-store/marketing/guidelines/images/badge-download-on-the-app-store.svg" alt="Download on the App Store" height="40" />
-      </a>
-      <a href="https://play.google.com/store/apps/details?id=net.siteed.audioplayground">
-        <img src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" alt="Get it on Google Play" height="40" />
-      </a>
-    </div>
-  </div>
-
-  <a href="https://deeeed.github.io/expo-audio-stream/playground" style="text-decoration:none;">
-    <div style="display:inline-block; padding:10px 20px; background-color:#007bff; color:white; border-radius:5px; font-size:16px;">
-      Try it in the Playground
-    </div>
-  </a>
-</div>
-
-**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)
-
-> **Note:** This package was formerly known as `@siteed/expo-audio-stream`. The name has been changed to better reflect the expanded capabilities beyond just audio streaming.
-
-## Features
-
-- Real-time audio streaming across iOS, Android, and web.
-- Audio input device detection and selection:
-  - List and select from available audio input devices
-  - View detailed device capabilities (sample rates, channels, bit depths)
-  - Support for Bluetooth, USB, and wired devices
-  - Automatic device management with fallback options
-  - Intelligent detection refresh for Bluetooth devices
-- 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
-- Zero-latency recording with preparation API:
-  - Pre-initialize audio recording to eliminate startup delay
-  - Prepare permissions, audio buffers, and sessions in advance
-  - Start recording instantly when needed
-- 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',
-});
-
-// Use the prepare API for zero-latency recording
-const { prepareRecording, startRecording, stopRecording } = useSharedAudioRecorder();
-
-// First prepare the recording - this initializes all resources
-await prepareRecording({
-  sampleRate: 44100,
-  channels: 2,
-  encoding: 'pcm_16bit'
-});
-
-// Later when needed, start instantly with no delay
-await startRecording(/* same config as prepare */);
-
-// 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-studio';
-
-// 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/).
-
-For developers interested in contributing or debugging the library, please see the [Contribution Guide](./CONTRIBUTE.md).
-
-## 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.
-
-### UI Components Package
-
-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:
+Please update your dependencies:
 
 ```bash
-# Install the UI components package
-npm install @siteed/expo-audio-ui
+# Remove the old package
+npm uninstall @siteed/expo-audio-studio
 
-# or with yarn
-yarn add @siteed/expo-audio-ui
+# Install the new package
+npm install @siteed/audio-studio
 ```
 
-This package includes:
-- Waveform visualizers
-- Audio recording controls
-- Playback components
-- Spectrogram displays
-- And more!
+Then update your imports:
 
-All components are built with React Native, Reanimated, and Skia for optimal performance across platforms.
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+```diff
+- import { ... } from '@siteed/expo-audio-studio';
++ import { ... } from '@siteed/audio-studio';
+```
 
----
-<sub>Created by [Arthur Breton](https://siteed.net) • See more projects at [siteed.net](https://siteed.net)</sub>
+This shim package re-exports everything from `@siteed/audio-studio` for backwards compatibility, but will be removed in a future release.

package/index.d.ts

@@ -0,0 +1 @@
+export * from '@siteed/audio-studio';

package/index.js

@@ -0,0 +1 @@
+module.exports = require('@siteed/audio-studio');

package/package.json

@@ -1,144 +1,15 @@
 {
     "name": "@siteed/expo-audio-studio",
-    "version": "2.18.6",
-    "description": "Comprehensive audio processing library for React Native and Expo with recording, analysis, visualization, and streaming capabilities across iOS, Android, and web",
+    "version": "3.0.1",
+    "description": "DEPRECATED - Use @siteed/audio-studio instead. This package re-exports @siteed/audio-studio for backwards compatibility.",
     "license": "MIT",
-    "type": "commonjs",
-    "main": "./build/cjs/index.js",
-    "module": "./build/esm/index.js",
-    "types": "./build/types/index.d.ts",
-    "expo": {
-        "plugin": "./app.plugin.js"
-    },
-    "author": "Arthur Breton <abreton@siteed.net> (https://github.com/deeeed)",
-    "homepage": "https://github.com/deeeed/expo-audio-stream/blob/main/packages/expo-audio-studio/README.md",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/deeeed/expo-audio-stream.git",
-        "directory": "packages/expo-audio-studio"
-    },
-    "bugs": {
-        "url": "https://github.com/deeeed/expo-audio-stream/issues"
-    },
-    "keywords": [
-        "react-native",
-        "expo",
-        "audio",
-        "recording",
-        "audio-analysis",
-        "audio-processing",
-        "audio-visualization",
-        "waveform",
-        "spectrogram",
-        "mel-spectrogram",
-        "mfcc",
-        "audio-features",
-        "audio-compression",
-        "opus",
-        "aac",
-        "pcm",
-        "wav",
-        "cross-platform",
-        "background-recording",
-        "audio-trimming",
-        "dual-stream"
-    ],
-    "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": "rimraf build && yarn build:types && yarn build:cjs && yarn build:esm && yarn build:plugin",
-        "build:cjs": "tsc -p tsconfig.cjs.json",
-        "build:esm": "tsc -p tsconfig.esm.json",
-        "build:types": "tsc -p tsconfig.types.json",
-        "build:plugin": "tsc --project plugin/tsconfig.json && cp plugin/build/index.js plugin/build/index.cjs",
-        "build:plugin:dev": "expo-module build plugin",
-        "build:dev": "expo-module build",
-        "clean": "expo-module clean && rimraf build plugin/build",
-        "lint": "expo-module lint",
-        "lint:fix": "expo-module lint --fix",
-        "test": "expo-module test",
-        "test:android": "yarn test:android:unit && yarn test:android:instrumented",
-        "test:android:unit": "cd ../../apps/playground/android && ./gradlew :siteed-expo-audio-studio:test",
-        "test:android:instrumented": "cd ../../apps/playground/android && ./gradlew :siteed-expo-audio-studio:connectedAndroidTest",
-        "test:android:unit:watch": "cd ../../apps/playground/android && ./gradlew :siteed-expo-audio-studio:test --continuous",
-        "test:ios": "cd ../../apps/playground/ios && xcodebuild -workspace AudioDevPlayground.xcworkspace -scheme AudioDevPlayground -destination 'platform=iOS Simulator,name=iPhone 15' build",
-        "test:coverage": "cd ../../apps/playground/android && ./gradlew :siteed-expo-audio-studio:jacocoTestReport",
-        "typecheck": "tsc --noEmit",
-        "docgen": "typedoc src/index.ts --plugin typedoc-plugin-markdown --readme none --out ../../documentation_site/docs/api-reference/API",
-        "prepare": "yarn build && node -e \"require('fs').renameSync('./plugin/build/index.d.ts', './plugin/build/index.d.cts')\"",
-        "prepublishOnly.disabled": "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",
-        "agent:test:unit": "yarn test:android:unit",
-        "agent:test:integration": "yarn test:android:instrumented",
-        "agent:compilation:check": "yarn typecheck && yarn build"
-    },
-    "devDependencies": {
-        "@expo/config-plugins": "~54.0.0",
-        "@expo/npm-proofread": "^1.0.1",
-        "@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": "~19.0.10",
-        "@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": "^54.0.0",
-        "expo-module-scripts": "^4.1.7",
-        "expo-modules-core": "~3.0.0",
-        "jest": "^29.7.0",
-        "prettier": "^3.2.5",
-        "react": "19.1.0",
-        "react-native": "0.81.5",
-        "rimraf": "^6.0.1",
-        "size-limit": "^11.1.4",
-        "ts-node": "^10.9.2",
-        "typedoc": "^0.27.4",
-        "typedoc-plugin-markdown": "~4.4.2",
-        "typescript": "~5.8.3"
-    },
-    "peerDependencies": {
-        "expo": ">=52.0.0",
-        "react": "*",
-        "react-native": "*"
+    "main": "index.js",
+    "types": "index.d.ts",
+    "dependencies": {
+        "@siteed/audio-studio": "*"
     },
     "publishConfig": {
         "access": "public",
         "registry": "https://registry.npmjs.org"
     }
-}
+}