Skip to content

feat(audio): support LPCM and fix waveform distortion #1574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 8, 2025
Merged

feat(audio): support LPCM and fix waveform distortion #1574

merged 1 commit into from
Jun 8, 2025

Conversation

edisonmartinsmkt
Copy link
Contributor

@edisonmartinsmkt edisonmartinsmkt commented Jun 8, 2025 •
edited by sourcery-ai bot
Loading

This update adds automatic detection and conversion of LPCM (Linear PCM) audio files — a format commonly generated by Google Text-to-Speech — ensuring proper sample rate and compatibility.

✅ The following formats were tested and confirmed working:
m4a, mp3, mp4, wav, opus, oga, ogg, and lpcm.

🧪 During testing, the resulting audio files consistently displayed waveform previews (waves) on WhatsApp for Android, iOS, and Web.

Summary by Sourcery

Support automatic detection and conversion of LPCM audio streams in the WhatsApp integration to fix distorted waveforms and ensure cross-platform compatibility.

New Features:

  • Automatically detect LPCM audio URLs and apply raw PCM ffmpeg settings for conversion

Bug Fixes:

  • Fix waveform distortion in WhatsApp audio previews by correctly handling LPCM streams

Build:

  • Add 'audio-decode' dependency to enable LPCM processing

@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Jun 8, 2025 •
edited
Loading

Reviewer's Guide

Introduces automatic detection and handling of LPCM audio streams in the WhatsApp integration by adjusting the ffmpeg invocation when encountering raw PCM input, and adds a new dependency to support LPCM decoding.

Sequence Diagram for LPCM Audio Processing

sequenceDiagram
    participant AudioSource
    participant BaileysStartupService
    participant FFMpegProcess as ffmpeg

    AudioSource->>BaileysStartupService: Provides audio (e.g., URL to .lpcm file)
    BaileysStartupService->>BaileysStartupService: isLpcm = checkAudioFormat(audio)
    alt isLpcm is true
        BaileysStartupService->>BaileysStartupService: Log "Detected LPCM input"
        BaileysStartupService->>FFMpegProcess: Initialize with LPCM settings (s16le, 24000Hz, 1ch)
    else isLpcm is false
        BaileysStartupService->>FFMpegProcess: Initialize with default settings for other formats
    end
    BaileysStartupService->>FFMpegProcess: Set output to ogg/libopus, no video
    FFMpegProcess->>BaileysStartupService: Processed audio stream (OGG/Opus)
    BaileysStartupService-->>AudioSource: Returns processed OGG audio stream
Loading

Updated Class Diagram for BaileysStartupService

classDiagram
  class ChannelStartupService {
    %% Base class placeholder
  }
  class BaileysStartupService {
    -logger: Logger
    +processAudio(audio: string | Buffer) : Promise~PassThrough~
  }
  BaileysStartupService --|> ChannelStartupService
Loading

File-Level Changes

Change Details Files
Detect and convert LPCM audio streams before transcoding
  • Added isLpcm flag by matching .lpcm URLs
  • Introduced conditional ffmpeg.inputFormat and inputOptions for raw PCM
  • Wrapped ffmpeg invocation in a variable to apply LPCM-specific settings
 src/api/integrations/channel/whatsapp/whatsapp.baileys.service.ts
Add audio-decode package to dependencies
  • Bumped package.json with "audio-decode": "^2.2.3"
 package.json
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@DavidsonGomes DavidsonGomes merged commit 9e1f9cb into EvolutionAPI:develop Jun 8, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@edisonmartinsmkt @DavidsonGomes