Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yashraj-n/audium

🎤 Encode Audio with custom messages
https://github.com/yashraj-n/audium

audio encode python python3 wav

Last synced: 4 days ago
JSON representation

🎤 Encode Audio with custom messages

Awesome Lists containing this project

README

        



audium-banner








🎤 Encode Audio with custom message


Introduction  • 
Installation  • 
Usage  • 
Documentation  • 
Issue?

# Introduction
Audium is tool to encode custom data to a `.wav` file.
You can:
- Encode and Decode data with key
- Read/Save Data to file
- Much more...

## Installation
##### Clone the Repository
```bash
git clone https://github.com/yashraj-n/audium
```
##### Change Directory
```bash
cd audium
```
##### Install Dependencies
```bash
pip install -r requirements.txt
```

## Usage
To Encode:

```
audium encode -f green -k 'An Apple A day keeps doctor away' -d "I like apples"
```
To Decode:

```
audium decode -f green -k 'An Apple A day keeps doctor away'
```

## Documentation
##### Help Command
Use audium --help to get all the commands
```bash
$ audium --help
usage: Audium [-h] -f AUDIOFILE [-d [DATA]] [-df DATAFILE] [-k [KEY]] [-v [VERBOSE]] [-of [OUTPUTFILE]] {encode,decode}

Encode and decode audio files

positional arguments:
{encode,decode} Method to use

options:
-h, --help show this help message and exit
-f AUDIOFILE, --audiofile AUDIOFILE
Name of the audio file to encode/decode
-d [DATA], --data [DATA]
Data to encode
-df DATAFILE, --datafile DATAFILE
File containing data to encode
-k [KEY], --key [KEY]
Key to use for encryption/decryption
-v [VERBOSE], --verbose [VERBOSE]
Verbose output
-of [OUTPUTFILE], --outputfile [OUTPUTFILE]
Name of the output file

By @yashraj-n
```
You only need to provide filename and method in CLI


Options in `[]` are Optional and are not required

## Issue
This repository is maintained actively, so if you face any issue please raise an issue.

Liked the work ?


Give the repository a star :-)

## License

MIT License