Commit graph

891 commits

Author SHA1 Message Date
Petr Gladkikh
197390fc40 Update quickcheck, update tests 2024-11-13 03:53:29 +04:00
Petr Gladkikh
574b809549 Upgrade quickcheck, make tests more reliable 2024-11-13 00:10:48 +04:00
Petr Gladkikh
d2a5085404 Test experimental features and docs in CI
`cargo test --all-targets` excludes doc tests.

Experimental features are sometimes mutually exclusive with
the stable code.
2024-11-12 23:42:50 +04:00
Petr Gladkikh
6071f147ed Update test 2024-11-12 23:40:57 +04:00
Petr Gladkikh
5be291d364 Fix doc tests, update documentation 2024-11-12 23:40:47 +04:00
dvdsk
489e184a58
Revert "use CI to yank partially broken 0.20.0"
This reverts commit 073fdb17d8.
Its no longer needed in CI since the yank is done now
2024-11-08 01:58:21 +01:00
dvdsk
073fdb17d8
use CI to yank partially broken 0.20.0 2024-11-08 01:55:41 +01:00
dvdsk
f1eaaa4a63
release bugfix 0.20.1 2024-11-08 01:36:22 +01:00
dvdsk
be29a3f0fd
release 0.20 2024-11-08 00:00:17 +01:00
dvdsk
d346cfa65b
spelling 2024-10-17 23:08:59 +02:00
dvdsk
48408bcfa6
AGC: adds inner and inner_mut & uses those in example
This removes the use of AGC's experimental atomic bool controls in
favor of the already stable periodic_access method of control.

The disadvantage is that periodic_access is significantly more difficult
for most users to undestand. It requires understanding of how closures
work with ownership and threading primitives like Atomics & Arc.
2024-10-17 22:41:38 +02:00
David Kleingeld
71d9a6d222
Merge pull request #632 from UnknownSuperficialNight/feature/automatic-gain-control-example
Add AGC example
2024-10-17 22:21:15 +02:00
David Kleingeld
b394e551e6
Merge pull request #633 from joseluis/remove-thiserror
remove `thiserror` dependency, improves compile times and has little impact on readability.
2024-10-17 14:59:53 +02:00
joseLuís
1df14257ba remove thiserror dependency 2024-10-17 13:33:33 +02:00
dvdsk
a7f67b3eea
small language tweaks to speed docs 2024-10-10 02:14:25 +02:00
David Kleingeld
d1bd852b91
Merge pull request #630 from ugochukwu-850/Issue#566
Issue#566
2024-10-09 19:10:04 +02:00
ugochukwu-850
5e038a6e5a Resolution of comment on source speed documentation
I added docs on the effects of changing the speed on both total_duration and pitch on both the source.speed trait and sink set_speed functions .
This should help users understand what each function does
2024-10-09 18:01:34 +01:00
ugochukwu-850
bb341a5634 Resolution of comment on source speed documentation
I added docs on the effects of changing the speed on both total_duration and pitch on both the source.speed trait and sink set_speed functions .
This should help users understand what each function does
2024-10-09 17:59:25 +01:00
ugochukwu-850
b7b2aad564 Removed redundant comment on the speed trait function 2024-10-09 14:44:50 +01:00
ugochukwu-850
0b3d49ce08 Removed redundant comment on the speed trait function 2024-10-09 14:41:36 +01:00
ugochukwu-850
f73dbe317d Resolved comments 2024-10-09 13:14:23 +01:00
Ugochukwu Chizaram
5c893cf121
Merge branch 'RustAudio:master' into Issue#566 2024-10-08 18:34:00 +01:00
David Kleingeld
02933d4adf
Point to rustdoc book in CONTRIBUTING.md
Specifically request contributors to take a look at the documenting a component section.
2024-10-08 00:53:26 +02:00
Ugochukwu Chizaram
2d24977ee5 FMT issues fixed and moved some doc tags to the mod.rs function 2024-10-07 13:49:32 +01:00
David Kleingeld
a5a49fb5a2
Merge pull request #627 from UnknownSuperficialNight/add-contributing-guidelines
Add CONTRIBUTING Guidelines
2024-10-07 14:44:11 +02:00
UnknownSuperficialNight
34b5585061 Remove 'dep:' in Cargo.toml testing 2024-10-06 21:40:26 +13:00
UnknownSuperficialNight
ee980bc5cf Add automatic_gain_control to Cargo.toml examples 2024-10-06 16:14:49 +13:00
UnknownSuperficialNight
0b20274043 Add AGC example 2024-10-06 16:04:30 +13:00
UnknownSuperficialNight
ab66761e91 Rename Testing to Unit Tests 2024-10-06 15:38:31 +13:00
David Kleingeld
aee7ffb014
Merge pull request #631 from ugochukwu-850/issue#628
Issue#628: Fix total_duration malfunction after speed mutation
2024-10-05 15:08:35 +02:00
ugochukwu-850
4f751ac809 Removed redundant comment 2024-10-05 10:53:44 +01:00
ugochukwu-850
e33bd63bed Fix for total duration for speed mutation issue
Previously the total_duration function calculated the total duration by multiplying instead of deviding by the factor
Causing the total duration to increase as speed factors increased instead of the other way round .
I have fixed this
2024-10-05 10:37:33 +01:00
ugochukwu-850
20daf244db Added Note on the set_speed function of impact on pitch 2024-10-05 10:25:14 +01:00
ugochukwu-850
0144699ad7 Added documentation for Issues #566
Documented how playback speed mutation works and the effects with examples
2024-10-05 10:24:58 +01:00
UnknownSuperficialNight
0aa7f5e703 Merge: Integrate 'Integration Tests' from user dvdsk
- Incorporate Integration Tests contributed by dvdsk
- Add leading numbers to bullet points mistakenly commited without numbering
2024-10-05 15:24:58 +13:00
UnknownSuperficialNight
417d5a10b3 Merge branch 'add-contributing-guidelines' of https://github.com/UnknownSuperficialNight/rodio into add-contributing-guidelines 2024-10-05 15:09:10 +13:00
UnknownSuperficialNight
d57e410ca7 Add Contributing guide and Integration Test guidelines
- Link to CONTRIBUTING.md in project root
- New Integration Tests section:
  - Avoid sound output in tests
  - Tips for testing audio sources
  - Suggest examples for audible features
  - Note challenges in automated audio testing
2024-10-05 15:06:27 +13:00
github-actions[bot]
dd3e8de93a
Contributing.md adds section on integration tests, improve new source section
Specifically notes some example tests and how they test. Also mentions
sometimes you just have to listen, recommends adding example for that.

Author:    dvdsk <noreply@davidsk.dev>
Date:      Sat Oct 5 02:06:39 2024 +0200
2024-10-05 02:34:44 +02:00
UnknownSuperficialNight
b6a90594aa Remove 'Ensure code quality' 2024-10-05 02:34:56 +13:00
UnknownSuperficialNight
dc85fe8045 Update testing guidelines in CONTRIBUTING.md
- Encourage use of temporary unit tests during development
- Clarify that rough, non-comprehensive tests are acceptable
- Allow inclusion of temporary tests in pull requests
- Explain rationale for removing tests before final merge:
  - Easier refactoring
  - Reduced necessity due to Rust's type system
- Maintain instruction to run tests with 'cargo test'
2024-10-05 02:32:13 +13:00
UnknownSuperficialNight
41db8554fb Add guidelines for TDD, PR workflow, and optimization
- Start with tests for new features
- Open draft PR after initial functionality
- Refactor, benchmark, and optimize
- Offer support for test creation
2024-10-05 00:10:37 +13:00
UnknownSuperficialNight
c19faddd32 Add 'Useful External Resources' Section 2024-10-04 23:56:03 +13:00
UnknownSuperficialNight
400dfe5a6e Add Rust performance book mention 2024-10-04 23:52:22 +13:00
UnknownSuperficialNight
c0066f9445 Updates a few changes 2024-10-04 17:07:38 +13:00
UnknownSuperficialNight
8c9f2faa00 Init commit of CONTRIBUTING.md 2024-10-04 16:39:30 +13:00
github-actions[bot]
6f2518eb1f
adds draft for new release announcement 2024-10-04 02:19:44 +02:00
David Kleingeld
c29fa1b8b9
Merge pull request #621 from UnknownSuperficialNight/feature/automatic-gain-control
Add Automatic Gain Control
2024-10-03 13:38:04 +02:00
UnknownSuperficialNight
bdbc159eab Remove experimental bench comment 2024-10-03 01:19:46 +13:00
UnknownSuperficialNight
5ce1fff779 Added non-atomic is_enabled() 2024-10-03 01:13:20 +13:00
UnknownSuperficialNight
f8cf3c555c Added getters 2024-10-03 01:06:37 +13:00