✨ NEW "Magic" module - allows to control efficient and easy sessions! by TurboAnonym · Pull Request #42 · AndreMiras/pycaw

TurboAnonym · 2021-05-01T12:30:33Z

old idea:
the setup will create an executable linking to pycaw.tools.app_mixer.
you can launch this mixer by using pycaw-app-mixer or pip -m pycaw.tools.app_mixer
this tool allows to change the volume and view changes to sessions.

This is what I was talking about ;)

AndreMiras

Yeah I know it's WIP, but I couldn't help it.
Looking good already!
Made some early comments 😃

AndreMiras · 2021-05-01T13:38:47Z

setup.py

    'comtypes', 'enum34;python_version<"3.4"', 'psutil', 'future']
 setup(name='pycaw',
-      version='20190904',
+      version='20210501',


Ouch I haven't released for all this time!
I would not bump this as part as the PR.
And that's a good reminder for me to make a release soon actually 😅

haha 😂

yeah of course- with all these brand new features 🤩

by the way: do you think we could just drop the python2 support?
I see a lot of big packages doing that... wouldn't it be time for that?

Yeah I've been wondering for Python 2 so I'm glad you ask.
Python 2 officially retired January last year I think https://pythonclock.org/
I think we can release this version to be the last to support Python 2 and then drop it straight after that.

hmmm does this mean ALL the new features need to be py2 compatible 😅

That's a good question, but new examples are already not Python2 compatible right?
I'll try to release this week or weekend, hold your horses 😄

Honestly i have no clue what works in Python 2 or not 😇 (I have never used it ^^)
... besides the obvious like print() and f strings.

So i guess its not quite 100% compatible...

I would be in for #team_lazy and drop the py2 support now 😂 its 2021!
We could leave the legacy release on github or something...

pycaw/tools/app_mixer/README.md

pycaw/tools/app_mixer/app_controll_and_gui.py

pycaw/tools/app_mixer/callbacks_and_manager.py

pycaw/tools/app_mixer/launch.py

TurboAnonym

Thank you (really!) for all the feedback!

It helps a lot improving my coding ^^

pycaw/tools/app_mixer/launch.py

TurboAnonym · 2021-05-01T18:09:40Z

setup.py

    'comtypes', 'enum34;python_version<"3.4"', 'psutil', 'future']
 setup(name='pycaw',
-      version='20190904',
+      version='20210501',


haha 😂

yeah of course- with all these brand new features 🤩

by the way: do you think we could just drop the python2 support?
I see a lot of big packages doing that... wouldn't it be time for that?

TurboAnonym · 2021-05-02T22:56:09Z

I split the functionality into a new module named magic 😇

This is a simple example:

import pycaw.magic !

The new Magic module allows to easy access and control the sessions of apps without headache!

example for MagicApp

from pycaw.magic import MagicApp

def changed(volume):
	print("Callback")
	print(volume)

m = MagicApp("msedge.exe", volume_callback=changed)

# start app for example now and play something!
# of course it would also work if app was already running.
time.sleep(6)

print(m.state)
print(m.volume)

m.volume = 0.6
m.mute = True

the pycaw session mixer is implemeted via the

MagicSession

AndreMiras

Just gave it a first quick look even though it's WIP.
But maybe the magic module should come in another PR as current changes are big enough and already provide value.
What do you think?

AndreMiras · 2021-05-03T13:39:39Z

pycaw/magic.py

@@ -0,0 +1,563 @@
+"""


I'm sure you will write unit tests for this new module, right? 😅 🙏

hmm i started writing an example... that should do the trick in general right? ... of course not with msedge ... but similar

pycaw/magic.py

TurboAnonym · 2021-05-03T15:42:57Z

"But maybe the magic module should come in another PR as current changes are big enough and already provide value.
What do you think?"

its more like in reverse ... the initial idea for the pull was to create a pycaw-app-mixer but now it depends on the magic module...
(i splitted it up and added more functionality)

so i guess i will drop the pycaw-app-mixer for now and this pull will be for the magic module.

I am contributing so much because i was searching for something like the magic module.
The closest to that was the initial pycaw. At first i didnt thought that a 'magic' way would ever exist to easily control the app volume - but here we are. The pycaw-app-mixer is more a fun by-product wich helped me understand windows audio sessions.

My total goal is for the magic module to support:

for now:

to control one or multiple sessions by app.exe (MagicApp)
to register for each new session a wrapper to be able to do something like the pycaw-app-mixer (MagicSession)

later:

to control the main speaker (not impl.)
to control a custom device (also mics) by name (not impl.)

... and this all easily without (much) knowledge about: com (sta, mta) windows audio sessions and the callbacks and interfaces and so on.

TurboAnonym · 2021-05-04T12:19:59Z

@AndreMiras can you please give me your opinion on the TODOS in the code? ;)

Heres a simplified sketch - how the magic module works.

high resolution as pdf:
1Magic.pdf

AndreMiras

Nice work, it looks pretty good.
I hope you don't mind I made few more comments.
Also I'd rather have the CI pass green before merging anything

examples/magic_app_example.py

pycaw/magic.py

TurboAnonym · 2021-05-15T13:33:58Z

There is now only one big problem left.

... And I cant really solve it - I bypassed it.

it has to do with all the
# XXX remove old session:
comments in the code.

The problem is: How to really "remove" an expired session.

When a session makes the callback OnStateChanged with AudioSessionState.Expired it should be ideally removed afterwards, so no ressources get wasted. But I could only implement the first step: to session.unregister_notification()

I then tried to remove any references to the _MagicRootSession which would result in releasing connected COMObjects like ._ctl2 (the <POINTER(IAudioSessionControl2)/>).
As soon as I released the final reference from the IAudioSessionControl2 via a callback the program broke. Broke in terms of no further COM callbacks where received... setting the volume would still work. I think I encountered a deadlock ...

From my still little understanding of COM, it has to do with keeping references and dont release them during a callback.

As it is stated in https://docs.microsoft.com/en-us/windows/win32/api/audiopolicy/nn-audiopolicy-iaudiosessionevents:

The client should never call the IAudioSessionControl::UnregisterAudioSessionNotification method during an event callback.
The client should never release the final reference on a WASAPI object during an event callback.

more lecture here ...
https://docs.microsoft.com/en-us/windows/win32/api/audiopolicy/nf-audiopolicy-iaudiosessioncontrol-unregisteraudiosessionnotification

bypass with a trash:

My idea was to implement a "trash" solution and keep in here references to deleted magic_root_sessions.
But emptying the trash (and thus releasing <POINTER(IAudioSessionControl2)/>) wont work in ANY callback, not even MagicManager.OnSessionCreated().

So in the current state the trash gets only emptied when the script is closed or when the user calls explicitly MagicManager.empty_trash()

I dont think that this is ideal. But it works. (even with 150 trashed sessions)

More details:

You can easily deactivate my "trash" solution by commenting:

MagicManager.remove_session ->
cls.expired_magic_root_sessions.add(magic_root_session)

Note:
There is a slight difference in the callback behavior, when the "trash" solution is deactivated:
When using MagicManager.magic_session(MagicSession) I enconter the deadlock after:

close a session -> start a session -> deadlock

When using MagicApp mode or MagicManager.activate_magic() (without MagicSession)

close a session -> deadlock

AndreMiras

Left one last minor comment even though I think it looks good enough for a merge.
And also another thing that's important to me is to have at least some basic tests for the magic.py module. Since this is now part of the library I think it should be tested, specially since it has quite some logic.
I understand it's not an easy one, so I'm happy to help in that and also do it in a follow up PR.
But I wouldn't usually merge code with that amount of logic and no unit tests

pycaw/magic.py

Magic: ------ The new Magic module allows to easily access and control the sessions of apps without headache! example for MagicApp --- import time from pycaw.magic import MagicApp def changed(volume): print("callback: ", volume) m = MagicApp({"msedge.exe", "app.exe"}, volume_callback=changed) while m.state is None: print(f"Not present: {m}") time.sleep(2) print(f"App session: {str(m.state)}") print(m.mute) print(m.volume) m.volume = 0.6 time.sleep(3) m.mute = True print(m.mute) print(m.volume) ---

TurboAnonym · 2021-05-16T13:05:12Z

Nice ;)
All done for this pull requests I guess ;)

I added with this push 'advanced_volume_callbacks', cleaned up some code comments and renamed some internal variables.
And made use of this 'guard clause pattern' thingy ... (thanks for the info ^^)

If you find something feel free to leave a comment ;)

See you in the next PR for unit testing.

TurboAnonym · 2021-05-16T15:03:48Z

One last thing:

i want to create a new issue regarding #42 (comment)
but i feel like there a way to many opened - yet solved issues.
Can you please close the solved ones, so feature requests and new issues dont get lost? 😇

AndreMiras

Thanks for the hard work and thanks for addressing all the comment.
I still have hope for unit tests in some (near?) future

TurboAnonym · 2021-05-16T19:08:19Z

😉

#45

gitagogaming · 2022-02-14T21:06:47Z

First off, want to say thank you very much for this addition, its a huge help!

I do see its possible to get any potential application volumes,

I was wondering if it is possible to get a callback on the default audio cable set inside of windows as well, so when the default audio levels change or mute I can know.

gitagogaming · 2022-02-16T23:23:08Z

Also I've taken notice that MagicManager.MagicSession doesnt appear to be capturing all the proper processes?
is this due to there not being any available callback from windows?

Is there some way for me to add a new session?
This below allows me to get the proper sessions, but no callback is enabled.

global_states = []
sessions = AudioUtilities.GetAllSessions()
old_volume_list=[]
running = True
for s in sessions:
    if s not in global_states:
        try:
            global_states.append(s.Process.name())
        except AttributeError:
            pass
if old_volume_list != global_states:
    print( global_states)
    old_volume_list = global_states

AndreMiras reviewed May 1, 2021

View reviewed changes

TurboAnonym commented May 1, 2021

View reviewed changes

TurboAnonym force-pushed the develop branch from 14591fa to f9853b1 Compare May 1, 2021 19:25

TurboAnonym changed the title ~~✨ Added pycaw-app-mixer tool to controll live audio sessions~~ ✨ Added pycaw-app-mixer tool to control live audio sessions May 1, 2021

TurboAnonym force-pushed the develop branch 3 times, most recently from d218a7a to da58f0c Compare May 2, 2021 22:53

TurboAnonym force-pushed the develop branch from da58f0c to 457e396 Compare May 2, 2021 22:58

AndreMiras reviewed May 3, 2021

View reviewed changes

TurboAnonym force-pushed the develop branch from c4ff42c to aacae7f Compare May 3, 2021 21:39

TurboAnonym changed the title ~~✨ Added pycaw-app-mixer tool to control live audio sessions~~ ✨ NEW "Magic" module - allows to control efficient and easy sessions! May 4, 2021

TurboAnonym requested a review from AndreMiras May 4, 2021 15:30

TurboAnonym force-pushed the develop branch from aacae7f to 1b97851 Compare May 13, 2021 15:38

AndreMiras reviewed May 14, 2021

View reviewed changes

TurboAnonym force-pushed the develop branch 4 times, most recently from 221b4ec to 1296f8e Compare May 15, 2021 13:26

TurboAnonym marked this pull request as ready for review May 15, 2021 13:48

AndreMiras approved these changes May 16, 2021

View reviewed changes

pycaw/magic.py Outdated Show resolved Hide resolved

TurboAnonym force-pushed the develop branch from 1296f8e to b07833b Compare May 16, 2021 12:57

AndreMiras approved these changes May 16, 2021

View reviewed changes

AndreMiras merged commit 1afa3b8 into AndreMiras:develop May 16, 2021

Conversation

TurboAnonym commented May 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AndreMiras left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TurboAnonym left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TurboAnonym commented May 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

import pycaw.magic !

MagicSession

Uh oh!

AndreMiras left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

TurboAnonym commented May 3, 2021

Uh oh!

TurboAnonym commented May 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AndreMiras left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TurboAnonym commented May 15, 2021

There is now only one big problem left.

... And I cant really solve it - I bypassed it.

The problem is: How to really "remove" an expired session.

bypass with a trash:

More details:

Uh oh!

AndreMiras left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TurboAnonym commented May 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

TurboAnonym commented May 1, 2021 •

edited

Loading

TurboAnonym commented May 2, 2021 •

edited

Loading

TurboAnonym commented May 4, 2021 •

edited

Loading

TurboAnonym commented May 16, 2021 •

edited

Loading

TurboAnonym commented May 16, 2021 •

edited

Loading

gitagogaming commented Feb 14, 2022 •

edited

Loading

gitagogaming commented Feb 16, 2022 •

edited

Loading