diff --git a/50-nova-pro-wireless.rules b/50-nova-pro-wireless.rules new file mode 100644 index 0000000..79953c2 --- /dev/null +++ b/50-nova-pro-wireless.rules @@ -0,0 +1 @@ +SUBSYSTEMS=="usb", ATTRS{idVendor}=="1038", ATTRS{idProduct}=="12e0", TAG+="uaccess" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4153cd3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,287 @@ + EUROPEAN UNION PUBLIC LICENCE v. 1.2 + EUPL © the European Union 2007, 2016 + +This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined +below) which is provided under the terms of this Licence. Any use of the Work, +other than as authorised under this Licence is prohibited (to the extent such +use is covered by a right of the copyright holder of the Work). + +The Work is provided under the terms of this Licence when the Licensor (as +defined below) has placed the following notice immediately following the +copyright notice for the Work: + + Licensed under the EUPL + +or has expressed by any other means his willingness to license under the EUPL. + +1. Definitions + +In this Licence, the following terms have the following meaning: + +- ‘The Licence’: this Licence. + +- ‘The Original Work’: the work or software distributed or communicated by the + Licensor under this Licence, available as Source Code and also as Executable + Code as the case may be. + +- ‘Derivative Works’: the works or software that could be created by the + Licensee, based upon the Original Work or modifications thereof. This Licence + does not define the extent of modification or dependence on the Original Work + required in order to classify a work as a Derivative Work; this extent is + determined by copyright law applicable in the country mentioned in Article 15. + +- ‘The Work’: the Original Work or its Derivative Works. + +- ‘The Source Code’: the human-readable form of the Work which is the most + convenient for people to study and modify. + +- ‘The Executable Code’: any code which has generally been compiled and which is + meant to be interpreted by a computer as a program. + +- ‘The Licensor’: the natural or legal person that distributes or communicates + the Work under the Licence. + +- ‘Contributor(s)’: any natural or legal person who modifies the Work under the + Licence, or otherwise contributes to the creation of a Derivative Work. + +- ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of + the Work under the terms of the Licence. + +- ‘Distribution’ or ‘Communication’: any act of selling, giving, lending, + renting, distributing, communicating, transmitting, or otherwise making + available, online or offline, copies of the Work or providing access to its + essential functionalities at the disposal of any other natural or legal + person. + +2. Scope of the rights granted by the Licence + +The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, +sublicensable licence to do the following, for the duration of copyright vested +in the Original Work: + +- use the Work in any circumstance and for all usage, +- reproduce the Work, +- modify the Work, and make Derivative Works based upon the Work, +- communicate to the public, including the right to make available or display + the Work or copies thereof to the public and perform publicly, as the case may + be, the Work, +- distribute the Work or copies thereof, +- lend and rent the Work or copies thereof, +- sublicense rights in the Work or copies thereof. + +Those rights can be exercised on any media, supports and formats, whether now +known or later invented, as far as the applicable law permits so. + +In the countries where moral rights apply, the Licensor waives his right to +exercise his moral right to the extent allowed by law in order to make effective +the licence of the economic rights here above listed. + +The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to +any patents held by the Licensor, to the extent necessary to make use of the +rights granted on the Work under this Licence. + +3. Communication of the Source Code + +The Licensor may provide the Work either in its Source Code form, or as +Executable Code. If the Work is provided as Executable Code, the Licensor +provides in addition a machine-readable copy of the Source Code of the Work +along with each copy of the Work that the Licensor distributes or indicates, in +a notice following the copyright notice attached to the Work, a repository where +the Source Code is easily and freely accessible for as long as the Licensor +continues to distribute or communicate the Work. + +4. Limitations on copyright + +Nothing in this Licence is intended to deprive the Licensee of the benefits from +any exception or limitation to the exclusive rights of the rights owners in the +Work, of the exhaustion of those rights or of other applicable limitations +thereto. + +5. Obligations of the Licensee + +The grant of the rights mentioned above is subject to some restrictions and +obligations imposed on the Licensee. Those obligations are the following: + +Attribution right: The Licensee shall keep intact all copyright, patent or +trademarks notices and all notices that refer to the Licence and to the +disclaimer of warranties. The Licensee must include a copy of such notices and a +copy of the Licence with every copy of the Work he/she distributes or +communicates. The Licensee must cause any Derivative Work to carry prominent +notices stating that the Work has been modified and the date of modification. + +Copyleft clause: If the Licensee distributes or communicates copies of the +Original Works or Derivative Works, this Distribution or Communication will be +done under the terms of this Licence or of a later version of this Licence +unless the Original Work is expressly distributed only under this version of the +Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee +(becoming Licensor) cannot offer or impose any additional terms or conditions on +the Work or Derivative Work that alter or restrict the terms of the Licence. + +Compatibility clause: If the Licensee Distributes or Communicates Derivative +Works or copies thereof based upon both the Work and another work licensed under +a Compatible Licence, this Distribution or Communication can be done under the +terms of this Compatible Licence. For the sake of this clause, ‘Compatible +Licence’ refers to the licences listed in the appendix attached to this Licence. +Should the Licensee's obligations under the Compatible Licence conflict with +his/her obligations under this Licence, the obligations of the Compatible +Licence shall prevail. + +Provision of Source Code: When distributing or communicating copies of the Work, +the Licensee will provide a machine-readable copy of the Source Code or indicate +a repository where this Source will be easily and freely available for as long +as the Licensee continues to distribute or communicate the Work. + +Legal Protection: This Licence does not grant permission to use the trade names, +trademarks, service marks, or names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the copyright notice. + +6. Chain of Authorship + +The original Licensor warrants that the copyright in the Original Work granted +hereunder is owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each Contributor warrants that the copyright in the modifications he/she brings +to the Work are owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each time You accept the Licence, the original Licensor and subsequent +Contributors grant You a licence to their contributions to the Work, under the +terms of this Licence. + +7. Disclaimer of Warranty + +The Work is a work in progress, which is continuously improved by numerous +Contributors. It is not a finished work and may therefore contain defects or +‘bugs’ inherent to this type of development. + +For the above reason, the Work is provided under the Licence on an ‘as is’ basis +and without warranties of any kind concerning the Work, including without +limitation merchantability, fitness for a particular purpose, absence of defects +or errors, accuracy, non-infringement of intellectual property rights other than +copyright as stated in Article 6 of this Licence. + +This disclaimer of warranty is an essential part of the Licence and a condition +for the grant of any rights to the Work. + +8. Disclaimer of Liability + +Except in the cases of wilful misconduct or damages directly caused to natural +persons, the Licensor will in no event be liable for any direct or indirect, +material or moral, damages of any kind, arising out of the Licence or of the use +of the Work, including without limitation, damages for loss of goodwill, work +stoppage, computer failure or malfunction, loss of data or any commercial +damage, even if the Licensor has been advised of the possibility of such damage. +However, the Licensor will be liable under statutory product liability laws as +far such laws apply to the Work. + +9. Additional agreements + +While distributing the Work, You may choose to conclude an additional agreement, +defining obligations or services consistent with this Licence. However, if +accepting obligations, You may act only on your own behalf and on your sole +responsibility, not on behalf of the original Licensor or any other Contributor, +and only if You agree to indemnify, defend, and hold each Contributor harmless +for any liability incurred by, or claims asserted against such Contributor by +the fact You have accepted any warranty or additional liability. + +10. Acceptance of the Licence + +The provisions of this Licence can be accepted by clicking on an icon ‘I agree’ +placed under the bottom of a window displaying the text of this Licence or by +affirming consent in any other similar way, in accordance with the rules of +applicable law. Clicking on that icon indicates your clear and irrevocable +acceptance of this Licence and all of its terms and conditions. + +Similarly, you irrevocably accept this Licence and all of its terms and +conditions by exercising any rights granted to You by Article 2 of this Licence, +such as the use of the Work, the creation by You of a Derivative Work or the +Distribution or Communication by You of the Work or copies thereof. + +11. Information to the public + +In case of any Distribution or Communication of the Work by means of electronic +communication by You (for example, by offering to download the Work from a +remote location) the distribution channel or media (for example, a website) must +at least provide to the public the information requested by the applicable law +regarding the Licensor, the Licence and the way it may be accessible, concluded, +stored and reproduced by the Licensee. + +12. Termination of the Licence + +The Licence and the rights granted hereunder will terminate automatically upon +any breach by the Licensee of the terms of the Licence. + +Such a termination will not terminate the licences of any person who has +received the Work from the Licensee under the Licence, provided such persons +remain in full compliance with the Licence. + +13. Miscellaneous + +Without prejudice of Article 9 above, the Licence represents the complete +agreement between the Parties as to the Work. + +If any provision of the Licence is invalid or unenforceable under applicable +law, this will not affect the validity or enforceability of the Licence as a +whole. Such provision will be construed or reformed so as necessary to make it +valid and enforceable. + +The European Commission may publish other linguistic versions or new versions of +this Licence or updated versions of the Appendix, so far this is required and +reasonable, without reducing the scope of the rights granted by the Licence. New +versions of the Licence will be published with a unique version number. + +All linguistic versions of this Licence, approved by the European Commission, +have identical value. Parties can take advantage of the linguistic version of +their choice. + +14. Jurisdiction + +Without prejudice to specific agreement between parties, + +- any litigation resulting from the interpretation of this License, arising + between the European Union institutions, bodies, offices or agencies, as a + Licensor, and any Licensee, will be subject to the jurisdiction of the Court + of Justice of the European Union, as laid down in article 272 of the Treaty on + the Functioning of the European Union, + +- any litigation arising between other parties and resulting from the + interpretation of this License, will be subject to the exclusive jurisdiction + of the competent court where the Licensor resides or conducts its primary + business. + +15. Applicable Law + +Without prejudice to specific agreement between parties, + +- this Licence shall be governed by the law of the European Union Member State + where the Licensor has his seat, resides or has his registered office, + +- this licence shall be governed by Belgian law if the Licensor has no seat, + residence or registered office inside a European Union Member State. + +Appendix + +‘Compatible Licences’ according to Article 5 EUPL are: + +- GNU General Public License (GPL) v. 2, v. 3 +- GNU Affero General Public License (AGPL) v. 3 +- Open Software License (OSL) v. 2.1, v. 3.0 +- Eclipse Public License (EPL) v. 1.0 +- CeCILL v. 2.0, v. 2.1 +- Mozilla Public Licence (MPL) v. 2 +- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3 +- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for + works other than software +- European Union Public Licence (EUPL) v. 1.1, v. 1.2 +- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong + Reciprocity (LiLiQ-R+). + +The European Commission may update this Appendix to later versions of the above +licences without producing a new version of the EUPL, as long as they provide +the rights granted in Article 2 of this Licence and protect the covered Source +Code from exclusive appropriation. + +All other changes or additions to this Appendix require the production of a new +EUPL version. diff --git a/README.md b/README.md index 3002a85..ce8bb81 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,145 @@ -# nova-chatmix +# Arctis Nova Pro Wireless ChatMix on Linux + +### In this document + +1. [About this project](#about-this-project) +2. [Disclaimer](#disclaimer) +3. [My Findings](#my-findings) +4. [Usage](#usage) +5. [What's Next](#whats-next) +6. [License](#license) + +## About this project + +Some SteelSeries headsets have a feature called ChatMix where you can easily adjust game and chat audio volume on the headphones or dongle. + +In previous SteelSeries headsets ChatMix was always a hardware feature. It worked by providing 2 sound devices to the host, 1 for general audio and the other for chat audio. + +In newer generations of their headsets however, in particular the Arctis Nova Pro Wireless, this feature was taken out of the hardware itself, and made into a feature of their audio software called Sonar. + +Sonar of course only works on Windows (and requires a SteelSeries account!), so everyone using other platforms were shit out of luck, even though these headphones are far from cheap. + +Even though it is now a software feature, the hardware can still control it, but only when Sonar activated this feature on the base station. You can toggle between normal volume controls and ChatMix by pressing down on the volume dial on either the headset or base station. + +I used ChatMix a lot on my previous SteelSeries headset, and I want to be able to use it on this one, so I started looking into how I can control 2 virtual PipeWire sinks with the ChatMix controls. This project is the result. + +## Disclaimer + +THIS PROJECT HAS NO ASSOCIATION TO STEELSERIES, NOR IS IT IN ANY WAY SUPPORTED BY THEM. + +I AM NOT RESPONSIBLE FOR BRICKED/BROKEN DEVICES NOR DO I GUARANTEE IT WILL WORK FOR YOU. + +USING ANYTHING IN THIS PROJECT *MIGHT* VOID YOUR WARRANTY AND IS AT YOUR OWN RISK + +I started this project knowing nothing about USB (I still don't), so I might be overcomplicating everything. The scripts I created were quickly thrown together and don't really integrate with anything. I might try to improve this later, but I also might not, as it does work for me in it's current state. + +## My findings + +I started by installing SteelSeries GG and Sonar in a Windows 11 VM and passing through the base station USB device. On the (Linux) host I used Wireshark to see what happened when I enabled Sonar. + +This device uses USB HID events to both configure and receive data from the base station. I identified which ones enabled what features and tried activating these on Linux using the /dev/hidraw* device. See `commands.sh` for more information. + +I am on MCU firmware version `01.29.27` and DSP firmware version `00.03.82`. + +### Protocol description + +Again, I don't really know anything about USB, so I could be wrong about a lot of this, but this is the protocol as I understand it + +See `nova.py` for a commented example implementation. + +The controls and data output are on USB Interface 4 (`bInterfaceNumber=4`). This interface has 2 endpoint, 1 for sending data (`0x04`) and 1 for receiving data (`0x84`). + +The HID Data messages are structured as follows: + +- The first byte decides wether we are sending or receiving. `0x6` means we sent it, `0x7` means we received it from the base station +- The second byte specifies the parameter, eg. `73` (`0x49`) to enable ChatMix +- The next bytes contain the value for that parameter, some parameters use 1 byte, some use more. +- Because the message should be 64 bytes long, the unused bytes should all be `0` + +These are the parameters I have found: +
+*(There are quite a few more parameters, like sidetone and other settings, I just haven't documented those yet.)* + +| Option | Description | Parameters | Range | Notes | +| ------ | ----------- | ---------- | ----- | ----- | +| 73 | ChatMix State | - Boolean: State | 0-1 | +| 141 | Sonar Icon State | - Boolean: State | 0-1 | I think this only toggles the icon, but that could be wrong +| 37 | Volume Attenuation | - Integer: Attenuation | 0-56 | 0=max
56=mute | +| 69 | ChatMix Controls | - Integer: Game Volume
- Integer: Chat Volume | 0-100 | +| 46 | EQ Preset | - Integer: Preset | 0-18 | Preset 4 is the custom EQ profile +| 49 | Custom EQ Controls | - Integer: EQ Bar
- Integer: Value | 0-40 | On the base station the value ranges from -20 to 20 + +## Usage +For this project I created a simple Python program to both enable the controls and use them to control 2 virtual sound devices. + +### Dependencies +- Python 3 (I used 3.12, it may or may not work on older versions) +- PyUSB +- PipeWire +- pactl + +On Fedora 39 (assuming PipeWire is already setup) these can be installed with: +``` +sudo dnf install pulseaudio-utils python3 python3-pyusb +``` + +To be able to run the script as a non-root user, some udev rules need to be applied. This will allow regular users to access the base station USB device. + +Copy `50-nova-pro-wireless.rules` to `/etc/udev/rules.d` and reload udev rules: +``` +sudo cp 50-nova-pro-wireless.rules /etc/udev/rules.d/ + +sudo udevadm control --reload-rules +sudo udevadm trigger +``` + +You can now run the python script to use ChatMix. +This will create 2 virtual sound devices: +- NovaGame for game/general audio +- NovaChat for chat audio + +``` +python nova.py +``` + +This command does not generate any output, but the Sonar icon should now be visible on the base station. + +To use ChatMix select NovaGame as your main audio output, and select NovaChat as the output in your voice chat software of choice. + + +ChatMix should now work. You can toggle between volume and ChatMix by pressing the dial. + +### Use as a library + +You should also be able to use nova.py as a library. +
+Example: + +``` +from nova import NovaProWireless + +nova = NovaProWireless() +nova.enable_sonar_icon() +nova.enable_chatmix() + +# Output all received messages +nova.print_output(True) +``` + +## What's Next + +Currently none of this is very polished, it should work, but that's about it. I would like to make this a bit more integrated, so that it just works without having to run the python script every time. + +There are also some other projects that try to make headset features work on linux, for example [HeadsetControl](https://github.com/Sapd/HeadsetControl). I might want to try and get some of this implemented in there. + +I also want to figure out if this could be something that happens by default in PipeWire (or somewhere else). So that users of the headset don't need anything beside what already comes with their distribution. + +While I'd like to do these things, I don't yet know if I will. Even in the current state of the project, it does work for me, so while I'd like for this to be a temporary solution, it might just stay like this. + +If anyone else wants to work on these things, please do, I'd love to see it. + +## License + +This project is licensed under the EUROPEAN UNION PUBLIC LICENSE v. 1.2 (EUPL) + diff --git a/commands.sh b/commands.sh new file mode 100644 index 0000000..c504255 --- /dev/null +++ b/commands.sh @@ -0,0 +1,20 @@ +#!/bin/bash + +# These bytes enable certain features when sent to the hidraw device +# It does work without all the 0 padding, but wireshark will complain about misformed packets +CHATMIX_ENABLE="06490100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" +SONAR_ICON_ENABLE="068d0100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + +# Look in dmesg to get this. It should be the one related to input4 +HIDRAWDEV=/dev/hidraw2 + +# Send data to enable features +printf $CHATMIX_ENABLE | xxd -r -p - | tee $HIDRAWDEV +printf $SONAR_ICON_ENABLE | xxd -r -p - | tee $HIDRAWDEV + +# Example ids, you can get these with `lsusb` +BUS=1 +DEVICE=2 + +# Read events +usbhid-dump -s $BUS:$DEVICE -f -e stream \ No newline at end of file diff --git a/nova.py b/nova.py new file mode 100644 index 0000000..286d57e --- /dev/null +++ b/nova.py @@ -0,0 +1,156 @@ +#!/usr/bin/python3 + +# Licensed under the EUPL + +import subprocess + +from usb.core import find, USBTimeoutError + + +class NovaProWireless: + # USB IDs + VID = 0x1038 + PID = 0x12E0 + + # bInterfaceNumber + INTERFACE = 0x4 + + # bEndpointAddress + ENDPOINT_TX = 0x4 # EP 4 OUT + ENDPOINT_RX = 0x84 # EP 4 IN + + MSGLEN = 64 # Total USB packet is 128 bytes, data is last 64 bytes. + + # First byte controls data direction. + TX = 0x6 # To base station. + RX = 0x7 # From base station. + + # Second Byte + # This is a very limited list of options, you can control way more. I just haven't implemented those options (yet) + ## As far as I know, this only controls the icon. + OPT_SONAR_ICON = 141 + ## Enabling this options enables the ability to switch between volume and ChatMix. + OPT_CHATMIX_ENABLE = 73 + ## Volume controls, 1 byte + OPT_VOLUME = 37 + ## ChatMix controls, 2 bytes show and control game and chat volume. + OPT_CHATMIX = 69 + ## EQ controls, 2 bytes show and control which band and what value. + OPT_EQ = 49 + ## EQ preset controls, 1 byte sets and shows enabled preset. Preset 4 is the custom preset required for OPT_EQ. + OPT_EQ_PRESET = 46 + + # PipeWire Names + ## Name of digital sink. + ## PipeWire docs recommend the analog sink, but I've had better results with the digital one. Probably not actually, but whatever. + PW_ORIGINAL_SINK = ( + "alsa_output.usb-SteelSeries_Arctis_Nova_Pro_Wireless-00.7.iec958-stereo" + ) + ## Names of virtual sound devices + PW_GAME_SINK = "NovaGame" + PW_CHAT_SINK = "NovaChat" + + # Selects correct device, and makes sure we can control it + def __init__(self): + self.dev = find(idVendor=self.VID, idProduct=self.PID) + if self.dev is None: + raise ValueError("Device not found") + if self.dev.is_kernel_driver_active(self.INTERFACE): + self.dev.detach_kernel_driver(self.INTERFACE) + + # Takes a tuple of ints and turns it into bytes with the correct length padded with zeroes + def _create_msgdata(self, data: tuple[int]) -> bytes: + return bytes(data).ljust(self.MSGLEN, b"0") + + # Enables chatmix + def enable_chatmix(self): + self.dev.write( + self.ENDPOINT_TX, + self._create_msgdata((self.TX, self.OPT_CHATMIX_ENABLE, 1)), + ) + + # Enables Sonar Icon + def enable_sonar_icon(self): + self.dev.write( + self.ENDPOINT_TX, self._create_msgdata((self.TX, self.OPT_SONAR_ICON, 1)) + ) + + # Sets Volume + def set_volume(self, attenuation: int): + self.dev.write( + self.ENDPOINT_TX, + self._create_msgdata((self.TX, self.OPT_VOLUME, attenuation)), + ) + + # Sets EQ preset + def set_eq_preset(self, preset: int): + self.dev.write( + self.ENDPOINT_TX, + self._create_msgdata((self.TX, self.OPT_EQ_PRESET, preset)), + ) + + # Create virtual pipewire loopback sinks, and redirect them to the real headset sink + def _enable_virtual_sinks(self): + cmd = [ + "pw-loopback", + "-P", + self.PW_ORIGINAL_SINK, + "--capture-props=media.class=Audio/Sink", + "-n", + ] + subprocess.Popen(cmd + [self.PW_GAME_SINK]) + subprocess.Popen(cmd + [self.PW_CHAT_SINK]) + + # ChatMix implementation + # Continuously read from base station and ignore everything but ChatMix messages (OPT_CHATMIX) + # The .read method times out and returns an error. This error is catched and basically ignored. Timeout can be configured, but not turned off (I think). + def chatmix(self): + self._enable_virtual_sinks() + while True: + try: + msg = self.dev.read(self.ENDPOINT_RX, self.MSGLEN) + if msg[1] != self.OPT_CHATMIX: + continue + + # 4th and 5th byte contain ChatMix data + gamevol = msg[2] + chatvol = msg[3] + + # Set Volume using PulseAudio tools. Can be done with pure pipewire tools, but I didn't feel like it + cmd = ["pactl", "set-sink-volume"] + + # Actually change volume. Everytime you turn the dial, both volumes are set to the correct level + subprocess.Popen(cmd + [f"input.{self.PW_GAME_SINK}", f"{gamevol}%"]) + subprocess.Popen(cmd + [f"input.{self.PW_CHAT_SINK}", f"{chatvol}%"]) + # Ignore timeout. + except USBTimeoutError: + continue + + # Prints output from base station. `debug` argument enables raw output. + def print_output(self, debug: bool = False): + while True: + try: + msg = self.dev.read(self.ENDPOINT_RX, self.MSGLEN) + if debug: + print(msg) + match msg[1]: + case self.OPT_VOLUME: + print(f"Volume: -{msg[2]}") + case self.OPT_CHATMIX: + print(f"Game Volume: {msg[2]} - Chat Volume: {msg[3]}") + case self.OPT_EQ: + print(f"EQ: Bar: {msg[2]} - Value: {(msg[3] - 20) / 2}") + case self.OPT_EQ_PRESET: + print(f"EQ Preset: {msg[2]}") + case _: + print("Unknown Message") + except USBTimeoutError: + continue + + +# When run directly, just start the ChatMix implementation. (And activate the icon, just for fun) +if __name__ == "__main__": + nova = NovaProWireless() + nova.enable_sonar_icon() + nova.enable_chatmix() + nova.chatmix()