Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document internal Audio Architecture #7896

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Document internal Audio Architecture #7896

wants to merge 1 commit into from
+243 −0

Conversation

MJacred
Copy link
Contributor

@MJacred MJacred commented Sep 9, 2023 •
edited
Loading

This is still a draft and I'm still collecting data / reading code - this might take the whole September.
If, at the end, there's too much detail, I'll move that to my own documentation.

Help / feedback is wanted, appreciated, liked and loved.

@MJacred MJacred force-pushed the audio-arch branch 6 times, most recently from ed896b5 to d2b5f75 Compare September 9, 2023 11:16
@Calinou Calinou added enhancement area:contributing Issues and PRs related to the Contributing/Development section of the documentation labels Nov 9, 2023
Calinou
Calinou reviewed Nov 9, 2023
View reviewed changes
contributing/development/core_and_modules/internal_audio_architecture.rst

3D audio techniques
-------------------

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a good idea to mention SPCAP, Camera3D doppler tracking and the audio panning properties here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy&pasted that as-is into the file for now. I'll write that part today.

@MJacred
Copy link
Contributor Author

MJacred commented Nov 29, 2023

Thanks for the feedback, @Calinou. I'll merge them in as soon as I can.

I reserved some time in the last week of the year to work on this PR (not sure if I'll find time before then).

AThousandShips
AThousandShips reviewed Nov 29, 2023
View reviewed changes
Copy link
Member

@AThousandShips AThousandShips left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some further style fixes

contributing/development/core_and_modules/internal_audio_architecture.rst Outdated Show resolved Hide resolved
contributing/development/core_and_modules/internal_audio_architecture.rst Outdated Show resolved Hide resolved
@MJacred
Copy link
Contributor Author

MJacred commented Dec 27, 2023

First draft of classes architecture. I still need to read more of the audio server class and check how I can incorporate Bus/AudioStreamPlaybackBusDetails and AudioStreamPlaybackListNode, and then resampler… and effects… And then find out how the microphone device reaches the microphone audio stream + capture/record effects.

audio-server-architecture

Here's the draw.io file, if so. wants to make suggestions (you can download the app here https://www.drawio.com/, the web version might also work):
audio-server-architecture.drawio.zip

@MJacred MJacred mentioned this pull request Dec 28, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AThousandShips AThousandShips AThousandShips left review comments

@Calinou Calinou Calinou left review comments

Assignees
No one assigned
Labels
area:contributing Issues and PRs related to the Contributing/Development section of the documentation enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@MJacred @Calinou @AThousandShips