Skip to content

README: add decode CLI example #14

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

Open
Artoria2e5 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

README: add decode CLI example #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ A library for convert PCM to tencent silk files.
### CLI

```shell
ffmpeg -y -i $INPUT -acodec pcm_s16le -f s16le -ac 1 tmp.pcm
# encode
ffmpeg -y -i "$INPUT" -acodec pcm_s16le -f s16le -ac 1 tmp.pcm
silk_codec pts -i tmp.pcm -s $HZ -o out.silk
Comment on lines +28 to 29
Copy link

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with the quoting of "$INPUT", consider also quoting "$HZ" to follow shell best practices. While numeric variables are less prone to issues, consistent quoting improves code maintainability and prevents potential issues with unexpected values.

Copilot uses AI. Check for mistakes.
```

Expand All @@ -41,6 +42,13 @@ Output #0, s16le, to 'pipe:':
It is $HZ
```

```shell
# decode
HZ=24000
silk_codec stp -i "$INPUT" -o tmp.pcm -s $HZ
ffmpeg -y -ar $HZ -f s16le -i tmp.pcm -o out.wav
Comment on lines +48 to +49
Copy link

Copilot AI Dec 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with the quoting of "$INPUT", consider also quoting "$HZ" in both commands to follow shell best practices and maintain consistency throughout the documentation.

Copilot uses AI. Check for mistakes.
```

### Java

[![Maven Central](https://img.shields.io/maven-central/v/io.github.kasukusakura/silk-codec.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.github.kasukusakura%22%20AND%20a:%22silk-codec%22)
Expand Down