<a name="readme-top"></a>
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
<br />
<div align="center">
<h3 align="center">AV Merge</h3>
<p align="center">
A crate to merge video and audio based on rsmpeg (dynamic link with ffmpeg lib)
<br />
<a href="https://github.com/kingwingfly/avmux"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/kingwingfly/avmux">View Demo</a>
·
<a href="https://github.com/kingwingfly/avmux/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
·
<a href="https://github.com/kingwingfly/avmux/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
</p>
</div>
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>
## About The Project
This crate provides a simple way to merge video and audio files into a single output file. It uses the [rsmpeg](https://crates.io/crates/rsmpeg) library, which is a Rust binding for FFmpeg, to handle the underlying media processing.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Built With
* [![Rust][Rust]][Rust-url]
* [![rsmpeg][rsmpeg]][rsmpeg-url]
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Getting Started
### Prerequisites
* Install FFmpeg and its development libraries
* install pkg-config
See an [example GitHub workflow](https://github.com/kingwingfly/fav/blob/dev/.github/workflows/release.yaml).
### Importing the Crate
To use this crate in your Rust project, add the following to your `Cargo.toml`:
```toml
[dependencies]
# if you want to mux audio and video and re-encode, try version 0.2
avmux = { version = "0.2", features = ["aac", "hevc"] }
# if you just want to mux audio and video without re-encode, try version 0.1
avmux = { version = "0.1" }
```
NOTICE: version `0.2` hard-coded `nvenc` hwaccel as the encoder, which is non-free in FFmpeg's LICENSE.
(You **cannot** distribute the FFmpeg binary or library with nvenc enabled for commertial usage. If you need, feel free to fork and modify this crate.)
### Features
- **ffmpeg8/ffmpeg7/ffmpeg6/link_system_ffmpeg/link_vcpkg_ffmpeg**: same as it is in [rsmpeg](https://github.com/larksuite/rsmpeg/tree/master/doc)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Usage
```rust no_run
use avmux::*;
let video_file = VFile::new("input_video.mp4");
let audio_file = AFile::new("https://music.com/input_audio.mp3");
let output_file = VFile::new("output1.mp4");
(video_file, audio_file).mux(output_file, CodecConfig::default()).unwrap();
let file1 = AFile::new("testa.mp3");
let file2 = VFile::new("testv.mp4");
let output = VFile::new("output2.mp4");
(file1, file2)
.mux(
output,
CodecConfig::builder()
.vconf(VConf::builder().format(VFormat::H264).build())
.aconf(AConf::builder().format(AFormat::AAC).build())
.build(),
)
.unwrap();
```
_For more examples, please refer to the [Documentation](https://crates.io/avmux)_
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Roadmap
- [ ] Feature
See the [open issues](https://github.com/kingwingfly/avmux/issues) for a full list of proposed features (and known issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Contact
Louis - 836250617@qq.com
Project Link: [https://github.com/kingwingfly/avmux](https://github.com/kingwingfly/avmux)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Acknowledgments
* []()
<p align="right">(<a href="#readme-top">back to top</a>)</p>
[contributors-shield]: https://img.shields.io/github/contributors/kingwingfly/avmux.svg?style=for-the-badge
[contributors-url]: https://github.com/kingwingfly/avmux/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/kingwingfly/avmux.svg?style=for-the-badge
[forks-url]: https://github.com/kingwingfly/avmux/network/members
[stars-shield]: https://img.shields.io/github/stars/kingwingfly/avmux.svg?style=for-the-badge
[stars-url]: https://github.com/kingwingfly/avmux/stargazers
[issues-shield]: https://img.shields.io/github/issues/kingwingfly/avmux.svg?style=for-the-badge
[issues-url]: https://github.com/kingwingfly/avmux/issues
[license-shield]: https://img.shields.io/github/license/kingwingfly/avmux.svg?style=for-the-badge
[license-url]: https://github.com/kingwingfly/avmux/blob/master/LICENSE.txt
[Rust]: https://img.shields.io/badge/Rust-000000?style=for-the-badge&logo=Rust&logoColor=orange
[Rust-url]: https://www.rust-lang.org
[rsmpeg]: https://img.shields.io/badge/rsmpeg-000000?style=for-the-badge&logo=rsmpeg&logoColor=white
[rsmpeg-url]: https://crates.io/crates/rsmpeg