improved library usability

Author: marci1175

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "silence-core"
-version = "0.1.8"
+version = "0.1.9"
 edition = "2021"
 description = "Core audio I/O abstractions for the silence crate."
 license = "Apache-2.0"

Cargo.toml

@@ -1,3 +1,6 @@
 //! Provides AV1 encoding for images.
 //! [AV1](https://en.wikipedia.org/wiki/AV1) (AOMedia Video 1) is a high efficiency video codec. It was originally made to transmit video calls.
 pub mod encoding;
+
+//Re-export the ravif crate.
+pub use ravif;

src/avif/mod.rs

@@ -8,6 +8,8 @@ use opencv::{
 
 //Reinport important functions
 pub use opencv::imgproc::{cvt_color_def, COLOR_BGR2RGB};
+//Re-export the opencv crate.
+pub use opencv;
 
 /// Webcam struct definition.
 /// The struct wraps the ```VideoCapture``` type, and has custom functions for it.

src/cam/mod.rs

@@ -1,7 +1,7 @@
 //! Traits, functions and type definitions for functioning audio I/O.
 //! The I/O feature provides types and functions for recording and playbacking audio aswell as handling the data.
 
-use cpal::{
+use ::cpal::{
     traits::{DeviceTrait, HostTrait},
     DefaultStreamConfigError, Device, Host, SupportedStreamConfig,
 };
@@ -15,16 +15,19 @@ pub type OutputDevice = Device;
 /// Wrapper type for differentiating [`OutputDevice`] from [`InputDevice`] granted the user passes them in right when creating an [`AudioDevice`].
 pub type InputDevice = Device;
 
+//Re-export the cpal crate.
+pub use cpal;
+
 /// The host's audio input and output devices.
 #[allow(missing_debug_implementations)]
-pub struct AudioDevice {
+pub struct HostDevice {
     /// The output device of the host.
     pub output: Option<OutputDevice>,
     /// The input device of the host.
     pub input: Option<InputDevice>,
 }
 
-impl AudioDevice {
+impl HostDevice {
     /// Creates a new [`AudioDevice`] instance.
     pub fn new(output: Option<Device>, input: Option<Device>) -> Self {
         Self { output, input }
@@ -52,8 +55,8 @@ impl AudioDevice {
 pub use cpal::{available_hosts, default_host, host_from_id};
 
 /// Get the default audio devices of the host. If one doesn't exist it will get initialized with `None`.
-pub fn get_audio_device(device: Host) -> AudioDevice {
-    AudioDevice {
+pub fn get_audio_device(device: Host) -> HostDevice {
+    HostDevice {
         input: device.default_input_device(),
         output: device.default_output_device(),
     }

src/io/mod.rs

@@ -4,6 +4,9 @@ use encode::EncoderType;
 pub mod decode;
 pub mod encode;
 
+/// Re-export the opus crate.
+pub use opus;
+
 /// The encoded sound packet.
 /// Contains useful information about the encoded packet.
 #[derive(Debug)]

src/opus/mod.rs

@@ -22,7 +22,7 @@ mod tests {
     };
 
     #[test]
-    fn encode() {
+    fn image_encode() {
         let mut webcam = cam::Webcam::new_def(CAP_ANY).unwrap();
         let (bytes, size) = webcam.get_frame().unwrap();
 
@@ -125,7 +125,7 @@ mod tests {
         )
         .unwrap();
 
-        let sound_packets = encode_samples_opus(encoder, &Into::<Vec<f32>>::into(sample), 20, channels).unwrap();
+        let sound_packets: Vec<crate::opus::SoundPacket> = encode_samples_opus(encoder, &Into::<Vec<f32>>::into(sample), 20, channels).unwrap();
 
         let decoder = create_opus_decoder(48000).unwrap();