From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <ffmpeg-devel-bounces@ffmpeg.org>
Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100])
	by master.gitmailbox.com (Postfix) with ESMTP id 5D52948DC6
	for <ffmpegdev@gitmailbox.com>; Tue, 26 Mar 2024 23:08:40 +0000 (UTC)
Received: from [127.0.1.1] (localhost [127.0.0.1])
	by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 1606F68D6A8;
	Wed, 27 Mar 2024 01:08:18 +0200 (EET)
Received: from mail-yb1-f201.google.com (mail-yb1-f201.google.com
 [209.85.219.201])
 by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id B5C5A68D6A5
 for <ffmpeg-devel@ffmpeg.org>; Wed, 27 Mar 2024 01:08:09 +0200 (EET)
Received: by mail-yb1-f201.google.com with SMTP id
 3f1490d57ef6-dccc49ef73eso9031720276.2
 for <ffmpeg-devel@ffmpeg.org>; Tue, 26 Mar 2024 16:08:09 -0700 (PDT)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20230601; t=1711494488; x=1712099288;
 h=cc:to:from:subject:message-id:references:mime-version:in-reply-to
 :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to;
 bh=bXJEewB3fmHVFcWQAcIc27DgSjqSqPL+uAUCWz/71Yg=;
 b=Hhayq3BypaLkOK9F9wGUKukI+dSg0zxcd27nPElKa0TOhdU7UVdWZ4KlGw9a4H5vJ9
 2CNH3TJCbQcCHDYmpMHqHe2syZOi93uHF6+z0or5wGxaglJoDGauG3YxiZBK7KKrP+9a
 5FRsM3ju8kgoHYkToLt3PWuRco4R5V9UZ+hhlnjPsip0EkaO12a+BzcYPkDzXtBuWGxu
 3EuoLTZPy0CcLO8Yokq+DJHo52EbhM2hSEL6U8ESX8yMFQOFJ1I/TeS87QLZGAP2WvBF
 2V1QLv162iqVnlynYYyXhS4jt2adwMqnn68XDb1/Z+FsRejTWtzJU3l86/rFbWiOoyWE
 cf3w==
X-Gm-Message-State: AOJu0YyCFoGVUHEnYQG+ipQZ9O9FC/m8QJmM1eJoybxDETPSfq3P/WA9
 VPi4ygCWS1wBjY0ToOiopSn1rE59JMSm/rsNUS4bLGSAl/r5FxBoFF7UVO7nmsnLQq08GFnqxMi
 VR3ig0cXX775rJe7oHBsbwF3H9QVcq+fnBC/ZJdMRrpGyrg8FOsoGek+OU2+1CXskWyMr7cVhlC
 EqjNLbB84jAU+Su75Wg5kk+BhaqfpgazZf7Ju9Qz4Vow/i
X-Google-Smtp-Source: AGHT+IEQMRFxrrXebYo2iOxW7lAeBRrL33cM6zrLpnL636d2Ju0p152nGtGUAmsdaAl7fHCp/koF7lYBh2v3cQ==
X-Received: from asoulier-us.c.googlers.com
 ([fda3:e722:ac3:cc00:20:ed76:c0a8:f79])
 (user=asoulier job=sendgmr) by 2002:a05:6902:1b90:b0:dbe:a0c2:df25 with SMTP
 id ei16-20020a0569021b9000b00dbea0c2df25mr747415ybb.8.1711494488399; Tue, 26
 Mar 2024 16:08:08 -0700 (PDT)
Date: Tue, 26 Mar 2024 23:07:56 +0000
In-Reply-To: <20240326230757.282319-1-asoulier@google.com>
Mime-Version: 1.0
References: <20240326230757.282319-1-asoulier@google.com>
X-Mailer: git-send-email 2.44.0.396.g6e790dbe36-goog
Message-ID: <20240326230757.282319-4-asoulier@google.com>
To: ffmpeg-devel@ffmpeg.org
Subject: [FFmpeg-devel] [PATCH 4/5] doc: Add LC3/LC3plus muxer and encoder
 parameters documentation
X-BeenThere: ffmpeg-devel@ffmpeg.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: FFmpeg development discussions and patches <ffmpeg-devel.ffmpeg.org>
List-Unsubscribe: <https://ffmpeg.org/mailman/options/ffmpeg-devel>,
 <mailto:ffmpeg-devel-request@ffmpeg.org?subject=unsubscribe>
List-Archive: <https://ffmpeg.org/pipermail/ffmpeg-devel>
List-Post: <mailto:ffmpeg-devel@ffmpeg.org>
List-Help: <mailto:ffmpeg-devel-request@ffmpeg.org?subject=help>
List-Subscribe: <https://ffmpeg.org/mailman/listinfo/ffmpeg-devel>,
 <mailto:ffmpeg-devel-request@ffmpeg.org?subject=subscribe>
From: Antoine Soulier via ffmpeg-devel <ffmpeg-devel@ffmpeg.org>
Reply-To: FFmpeg development discussions and patches <ffmpeg-devel@ffmpeg.org>
Cc: Antoine Soulier <asoulier@google.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: ffmpeg-devel-bounces@ffmpeg.org
Sender: "ffmpeg-devel" <ffmpeg-devel-bounces@ffmpeg.org>
Archived-At: <https://master.gitmailbox.com/ffmpegdev/20240326230757.282319-4-asoulier@google.com/>
List-Archive: <https://master.gitmailbox.com/ffmpegdev/>
List-Post: <mailto:ffmpegdev@gitmailbox.com>

Signed-off-by: Antoine Soulier <asoulier@google.com>
---
 doc/encoders.texi         | 57 +++++++++++++++++++++++++++++++++++++++
 doc/general_contents.texi | 11 +++++++-
 doc/muxers.texi           |  6 +++++
 3 files changed, 73 insertions(+), 1 deletion(-)

diff --git a/doc/encoders.texi b/doc/encoders.texi
index 7c223ed74c..0719ba13cc 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -814,6 +814,63 @@ ffmpeg -i input.wav -c:a libfdk_aac -profile:a aac_he -b:a 64k output.m4a
 @end example
 @end itemize
 
+@anchor{liblc3-enc}
+@section liblc3
+
+liblc3 LC3 (Low Complexity Communication Codec) encoder wrapper.
+
+Requires the presence of the liblc3 headers and library during configuration.
+You need to explicitly configure the build with @code{--enable-liblc3}.
+
+This encoder has support for the Bluetooth SIG LC3 codec for the LE Audio
+protocol, and the following features of LC3plus:
+@itemize @minus
+@item
+Frame duration of 2.5 and 5ms.
+@item
+High-Resolution mode, 48 KHz, and 96 kHz sampling rates.
+@end itemize
+
+For more information see the liblc3 project at
+@url{https://github.com/google/liblc3}.
+
+@subsection Options
+
+The following options are mapped on the shared FFmpeg codec options.
+
+@table @option
+@item b
+Set the bit rate in bits/s. This will determine the fixed size of the encoded
+frames, for a selected frame duration.
+
+@item ar
+Set the audio sampling rate (in Hz).
+
+@item channels
+Set the number of audio channels.
+
+@item frame_duration
+Set the audio frame duration in milliseconds. Default value is 10ms.
+Allowed frame durations are 2.5ms, 5ms, 7.5ms and 10ms.
+LC3 (Bluetooth LE Audio), allows 7.5ms and 10ms; and LC3plus 2.5ms, 5ms
+and 10ms.
+
+The 10ms frame duration is available in LC3 and LC3 plus standard.
+In this mode, the produced bitstream can be referenced either as LC3 or LC3plus.
+
+@item high_resolution
+Enable the high-resolution mode if set to 1. The high-resolution mode is
+available with all LC3plus frame durations and for a sampling rate 48 KHz,
+and 96 KHz.
+
+The encoder automatically turns off this mode at lower sampling rates and
+activates it at 96 KHz.
+
+This mode should be preferred at high bitrates. In this mode, the audio
+bandwidth is always up to the Nyquist frequency, compared to LC3 at 48 KHz,
+which limits the bandwidth to 20 KHz.
+@end table
+
 @anchor{libmp3lame}
 @section libmp3lame
 
diff --git a/doc/general_contents.texi b/doc/general_contents.texi
index f269cbd1a9..e7cf4f8239 100644
--- a/doc/general_contents.texi
+++ b/doc/general_contents.texi
@@ -237,6 +237,14 @@ Go to @url{http://sourceforge.net/projects/opencore-amr/} and follow the
 instructions for installing the library.
 Then pass @code{--enable-libfdk-aac} to configure to enable it.
 
+@subsection LC3 library
+
+FFmpeg can make use of the Google LC3 library for LC3 decoding & encoding.
+
+Go to @url{https://github.com/google/liblc3/} and follow the instructions for
+installing the library.
+Then pass @code{--enable-liblc3} to configure to enable it.
+
 @section OpenH264
 
 FFmpeg can make use of the OpenH264 library for H.264 decoding and encoding.
@@ -1300,7 +1308,8 @@ following image formats are supported:
     @tab encoding and decoding supported through external library libilbc
 @item IMC (Intel Music Coder)  @tab     @tab  X
 @item Interplay ACM            @tab     @tab  X
-@item MACE (Macintosh Audio Compression/Expansion) 3:1  @tab     @tab  X
+@item LC3                    @tab E  @tab  E
+    @tab supported through external library liblc3
 @item MACE (Macintosh Audio Compression/Expansion) 6:1  @tab     @tab  X
 @item Marian's A-pac audio     @tab     @tab  X
 @item MI-SC4 (Micronas SC-4 Audio)  @tab     @tab  X
diff --git a/doc/muxers.texi b/doc/muxers.texi
index a10a8e216f..9687746c30 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -2612,6 +2612,12 @@ WebDAV server every second:
 ffmpeg -f x11grab -framerate 1 -i :0.0 -q:v 6 -update 1 -protocol_opts method=PUT http://example.com/desktop.jpg
 @end example
 
+@section lc3
+Bluetooth SIG Low Complexity Communication Codec audio (LC3), or
+ETSI TS 103 634 Low Complexity Communication Codec plus (LC3plus).
+
+This muxer accepts a single @code{lc3} audio stream.
+
 @section matroska
 
 Matroska container muxer.
-- 
2.44.0.396.g6e790dbe36-goog

_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".