Add document for component submodules.

This commit also introduces a new feature for publishing "test_helper"
from the crate.

Cargo.toml

@@ -19,6 +19,7 @@ experimental = ["dep:nalgebra"]
 par = ["dep:crossbeam-channel"]
 fakesimd = []
 mimalloc = ["dep:mimalloc"]
+test_helper = ["dep:claxon", "dep:once_cell", "dep:rand", "dep:tempfile"]
 
 [dependencies]
 crc = "2.1"
@@ -32,6 +33,15 @@ seq-macro = "0.3"
 serde = { version = "1.0", features = ["derive"] }
 toml = "0.5"
 
+# Followings are pasted from "dev-dependencies" for "test_helper" feature,
+# that enables "test_helper" submodule in a release build. This is done for
+# doctest where "cargo test --doc" build the crate to be tested with a normal
+# config flags. There must be a better way to avoid this issue.
+claxon = { version = "0.4.3", optional = true }
+once_cell = { version = "1.10.0", optional = true }
+rand = { version = "0.8.5", optional = true }
+tempfile = { version = "3", optional = true }
+
 [dev-dependencies]
 bitvec = "1.0.0"
 claxon = "0.4.3"

README.md

@@ -56,7 +56,7 @@ std::fs::write("/dev/null", sink.as_byte_slice());
 
 // or you can only get a specific frame.
 let mut sink = flacenc::bitsink::ByteSink::new();
-flac_stream.frame(0).write(&mut sink);
+flac_stream.frame(0).unwrap().write(&mut sink);
 ```
 
 `samples` here is an interleaved sequence, e.g. in the caes with stereo inputs,

codehealth.sh

@@ -18,7 +18,7 @@ set -e
 rustup default nightly
 cargo rustc --release -- -D warnings
 cargo build --release
-cargo test
+cargo test --features test_helper,experimental,par
 cargo fmt --check
 cargo clippy --tests -- -D warnings
 cargo doc
@@ -33,5 +33,5 @@ rustup default stable
 cargo rustc --release --features "fakesimd" -- -D warnings
 cargo build --release --features "fakesimd"
 cargo clippy --tests --features "fakesimd"
-cargo test --features "fakesimd"
+cargo test --features "fakesimd,test_helper,experimental,par"
 rustup default nightly

src/coding.rs

@@ -468,10 +468,10 @@ impl StereoCodingHelper {
         );
 
         let (bits_l, bits_r, bits_m, bits_s) = (
-            indep.subframe(0).count_bits(),
-            indep.subframe(1).count_bits(),
-            ms_frame.subframe(0).count_bits(),
-            ms_frame.subframe(1).count_bits(),
+            indep.subframe(0).unwrap().count_bits(),
+            indep.subframe(1).unwrap().count_bits(),
+            ms_frame.subframe(0).unwrap().count_bits(),
+            ms_frame.subframe(1).unwrap().count_bits(),
         );
 
         let combinations = [
@@ -550,7 +550,7 @@ pub fn encode_fixed_size_frame(
     // A bit awkward, but this function is implemented by overwriting relevant
     // fields of `Frame` generated by `encode_frame`.
     let mut ret = encode_frame(config, framebuf, 0, stream_info);
-    ret.header_mut().enter_fixed_size_mode(frame_number as u32);
+    ret.header_mut().set_frame_number(frame_number as u32);
     ret
 }