├── vccli
├── rc
│ └── vccli.ico
├── CMakeLists.txt
├── Volume.hpp
├── util.hpp
├── AudioAPI.hpp
└── vccli.cpp
├── .gitmodules
├── .gitignore
├── CMakeLists.txt
├── README.md
├── CMakePresets.json
├── .github
└── workflows
│ └── GenerateRelease.yml
└── LICENSE
/vccli/rc/vccli.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/radj307/volume-control-cli/HEAD/vccli/rc/vccli.ico
--------------------------------------------------------------------------------
/.gitmodules:
--------------------------------------------------------------------------------
1 | [submodule "307lib"]
2 | path = 307lib
3 | url = https://github.com/radj307/307lib
4 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | CMakeLists.txt.user
2 | CMakeCache.txt
3 | CMakeFiles
4 | CMakeScripts
5 | Testing
6 | Makefile
7 | cmake_install.cmake
8 | install_manifest.txt
9 | compile_commands.json
10 | CTestTestfile.cmake
11 | _deps
12 |
13 | #Ignore thumbnails created by Windows
14 | Thumbs.db
15 | #Ignore files built by Visual Studio
16 | *.obj
17 | *.exe
18 | *.pdb
19 | *.user
20 | *.aps
21 | *.pch
22 | *.vspscc
23 | *_i.c
24 | *_p.c
25 | *.ncb
26 | *.suo
27 | *.tlb
28 | *.tlh
29 | *.bak
30 | *.cache
31 | *.ilk
32 | *.log
33 | [Bb]in
34 | [Dd]ebug*/
35 | *.lib
36 | *.sbr
37 | obj/
38 | [Rr]elease*/
39 | _ReSharper*/
40 | [Tt]est[Rr]esult*
41 | .vs/
42 | #Nuget packages folder
43 | packages/
44 | out/
45 | vccli/rc/version.h
46 | vccli/rc/vccli.rc
47 |
--------------------------------------------------------------------------------
/CMakeLists.txt:
--------------------------------------------------------------------------------
1 | # VolumeControlCLI
2 | cmake_minimum_required(VERSION 3.20)
3 |
4 | if (NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/307lib") # Make sure 307lib submodule exists before we get unhelpful error messages
5 | message(FATAL_ERROR
6 | "\n"
7 | "Missing '307lib' submodule! Before continuing, open a terminal in '${CMAKE_CURRENT_SOURCE_DIR}' and execute the following command:\n"
8 | " `git submodule update --init --recursive`")
9 | endif()
10 |
11 | list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/307lib/307modules")
12 |
13 | set(ENV{VolumeControlCLI_VERSION} "0.0.0")
14 | include(VersionTag)
15 | GET_VERSION_TAG("${CMAKE_CURRENT_SOURCE_DIR}" VolumeControlCLI)
16 |
17 | project("VolumeControlCLI" VERSION "${VolumeControlCLI_VERSION}" LANGUAGES CXX)
18 |
19 | add_subdirectory("307lib")
20 | add_subdirectory("vccli")
21 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | 
3 | 
4 |
5 |
6 | ***
7 |
8 | Commandline app-specific volume control utility for Windows.
9 |
10 | This is the commandline version of **[Volume Control](https://github.com/radj307/volume-control)**, which adds fully configurable & extensible hotkeys for controlling the mixer volume level of specific apps *(and much more)*.
11 |
12 |
13 | ## Features
14 |
15 | - Supports both Audio Input & Audio Output Devices
16 | - Supports changing the volume/mute state of specific processes
17 | - View the ProcessId & ProcessName of all active audio sessions
18 | - Interactive device/session queries (`-Q`|`--query`)
19 | - Custom flexible GNU-style syntax
20 | - Supports minimal I/O for shell scripts (`-q`|`--quiet`)
21 | - Built-in documentation (`vccli -h`)
22 |
23 |
24 | ## Installation
25 |
26 | 1. Download the [latest release](https://github.com/radj307/vccli).
27 | 2. Extract to a directory of your choice.
28 |
29 | > ### :warning: Important
30 | > If you want to be able to call `vccli` from any working directory without specifying the full path, you'll have to add the directory where you placed `vccli.exe` to [your PATH environment variable](https://stackoverflow.com/a/44272417/8705305).
31 | > Once you've done that, restart your terminal emulator to refresh its environment & you'll be able to call `vccli` from anywhere.
32 |
33 | ## Usage
34 |
35 | Run `vccli -h` in a terminal to see the built-in usage guide & the most up-to-date documentation.
36 |
--------------------------------------------------------------------------------
/CMakePresets.json:
--------------------------------------------------------------------------------
1 | {
2 | "version": 3,
3 | "configurePresets": [
4 | {
5 | "name": "windows-base",
6 | "hidden": true,
7 | "generator": "Ninja",
8 | "binaryDir": "${sourceDir}/out/build/${presetName}",
9 | "installDir": "${sourceDir}/out/install/${presetName}",
10 | "cacheVariables": {
11 | "CMAKE_C_COMPILER": "cl.exe",
12 | "CMAKE_CXX_COMPILER": "cl.exe"
13 | },
14 | "condition": {
15 | "type": "equals",
16 | "lhs": "${hostSystemName}",
17 | "rhs": "Windows"
18 | }
19 | },
20 | {
21 | "name": "x64-debug",
22 | "displayName": "x64 Debug",
23 | "inherits": "windows-base",
24 | "architecture": {
25 | "value": "x64",
26 | "strategy": "external"
27 | },
28 | "cacheVariables": {
29 | "CMAKE_BUILD_TYPE": "Debug",
30 | "vccli_DBGMODE": "/ZI"
31 | }
32 | },
33 | {
34 | "name": "x64-unittest",
35 | "displayName": "x64 UnitTests",
36 | "inherits": "x64-debug",
37 | "cacheVariables": {
38 | "BUILD_TESTING": true
39 | }
40 | },
41 | {
42 | "name": "x64-release",
43 | "displayName": "x64 Release",
44 | "inherits": "x64-debug",
45 | "cacheVariables": {
46 | "CMAKE_BUILD_TYPE": "Release"
47 | }
48 | },
49 | {
50 | "name": "x86-debug",
51 | "displayName": "x86 Debug",
52 | "inherits": "windows-base",
53 | "architecture": {
54 | "value": "x86",
55 | "strategy": "external"
56 | },
57 | "cacheVariables": {
58 | "CMAKE_BUILD_TYPE": "Debug",
59 | "vccli_DBGMODE": "/ZI"
60 | }
61 | },
62 | {
63 | "name": "x86-unittest",
64 | "displayName": "x86 UnitTests",
65 | "inherits": "x86-debug",
66 | "cacheVariables": {
67 | "BUILD_TESTING": true
68 | }
69 | },
70 | {
71 | "name": "x86-release",
72 | "displayName": "x86 Release",
73 | "inherits": "x86-debug",
74 | "cacheVariables": {
75 | "CMAKE_BUILD_TYPE": "Release"
76 | }
77 | }
78 | ]
79 | }
80 |
--------------------------------------------------------------------------------
/vccli/CMakeLists.txt:
--------------------------------------------------------------------------------
1 | # VolumeControlCLI/vccli
2 | cmake_minimum_required(VERSION 3.20)
3 |
4 | # Get headers & source files
5 | file(GLOB HEADERS
6 | RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}"
7 | CONFIGURE_DEPENDS
8 | "*.h*"
9 | )
10 | file(GLOB SRCS
11 | RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}"
12 | CONFIGURE_DEPENDS
13 | "*.c*"
14 | )
15 |
16 | # Create resources:
17 | set(vccli_rc_dir "${CMAKE_CURRENT_SOURCE_DIR}/rc")
18 |
19 | include(VersionTag)
20 | MAKE_VERSION_HEADER("${vccli_rc_dir}/version.h" vccli "${VolumeControlCLI_VERSION}")
21 |
22 | if (WIN32) # Windows-specific resources:
23 | include(ResourceMaker)
24 | MAKE_STRINGRC_ICON(vccli_rc_icon "${vccli_rc_dir}/vccli.ico")
25 | MAKE_STRINGRC_VERSIONINFO(vccli_rc_versioninfo
26 | "${VolumeControlCLI_VERSION}"
27 | "GNU General Public License v3"
28 | "radj307"
29 | "Volume Control CLI"
30 | "Windows commandline utility that can mute/unmute/change the volume of specific processes."
31 | )
32 | set(vccli_rc_file "${vccli_rc_dir}/vccli.rc")
33 | MAKE_RESOURCE("${vccli_rc_file}" "${vccli_rc_icon}" "${vccli_rc_versioninfo}")
34 | endif()
35 |
36 |
37 |
38 | include(FetchContent)
39 | FetchContent_Declare(
40 | doctest
41 | GIT_REPOSITORY https://github.com/doctest/doctest.git
42 | GIT_TAG v2.4.9
43 | )
44 | FetchContent_MakeAvailable(doctest)
45 |
46 |
47 |
48 |
49 | # Create executable
50 | add_executable(vccli "${SRCS}" "${vccli_rc_dir}/version.h" "${vccli_rc_file}")
51 |
52 | set_property(TARGET vccli PROPERTY CXX_STANDARD 20)
53 | set_property(TARGET vccli PROPERTY CXX_STANDARD_REQUIRED ON)
54 | set_property(TARGET vccli PROPERTY POSITION_INDEPENDENT_CODE ON)
55 |
56 | if (MSVC)
57 | target_compile_options(vccli PRIVATE "/Zc:__cplusplus" "/Zc:preprocessor" "${vccli_DBGMODE}")
58 | endif()
59 |
60 | target_sources(vccli PRIVATE "${HEADERS}")
61 |
62 | target_link_libraries(vccli PRIVATE TermAPI optlib doctest)
63 |
64 | # Create an installation target:
65 | include(PackageInstaller)
66 | INSTALL_EXECUTABLE(vccli "${CMAKE_INSTALL_PREFIX}/")
67 |
68 |
69 | if(BUILD_TESTING)
70 | include(CTest)
71 | enable_testing()
72 | target_compile_definitions(vccli PUBLIC DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN)
73 | include(doctestAddTests)
74 | doctest_discover_tests(vccli)
75 | else()
76 | target_compile_definitions(vccli PUBLIC DOCTEST_CONFIG_DISABLE)
77 | endif()
78 |
79 |
--------------------------------------------------------------------------------
/vccli/Volume.hpp:
--------------------------------------------------------------------------------
1 | #pragma once
2 | #include
3 |
4 | #define WIN32_LEAN_AND_MEAN
5 | #include
6 | #include
7 | #include
8 | #include
9 |
10 | #include
11 |
12 | namespace vccli {
13 | /// @brief GUID to use as 'context' parameter in setter functions.
14 | inline static constexpr GUID default_context{};
15 |
16 | struct Volume {
17 | std::string resolved_name, identifier;
18 | EDataFlow flow_type;
19 |
20 | constexpr Volume(std::string const& resolved_name, std::string const& identifier, const EDataFlow flow_type) : resolved_name{ resolved_name }, identifier{ identifier }, flow_type{ flow_type } {}
21 | virtual ~Volume() = default;
22 |
23 | virtual bool getMuted() const = 0;
24 | virtual void setMuted(const bool) const = 0;
25 | virtual void mute() const
26 | {
27 | setMuted(true);
28 | }
29 | virtual void unmute() const
30 | {
31 | setMuted(false);
32 | }
33 |
34 | virtual float getVolume() const = 0;
35 | virtual void setVolume(const float&) const = 0;
36 | virtual void incrementVolume(const float& amount) const
37 | {
38 | auto level{ getVolume() + amount };
39 | if (level > 1.0f)
40 | level = 0.0f;
41 | setVolume(level);
42 | }
43 | virtual void decrementVolume(const float& amount) const
44 | {
45 | auto level{ getVolume() - amount };
46 | if (level < 0.0f)
47 | level = 0.0f;
48 | setVolume(level);
49 | }
50 |
51 | virtual float getVolumeScaled(const std::pair& scale = { 0.0f, 100.0f }) const
52 | {
53 | return math::scale(getVolume(), { 0.0f, 1.0f }, scale);
54 | }
55 | virtual void setVolumeScaled(const float& level, const std::pair& scale = { 0.0f, 100.0f }) const
56 | {
57 | setVolume(math::scale(level, scale, { 0.0f, 1.0f }));
58 | }
59 |
60 | virtual constexpr std::optional type_name() const = 0;
61 | constexpr std::string getFlowTypeName() const { return DataFlowToString(this->flow_type); }
62 |
63 | template T>
64 | constexpr bool is_derived_type() const
65 | {
66 | return typeid(*this) == typeid(T);
67 | }
68 | };
69 |
70 | template T>
71 | struct VolumeController : Volume {
72 | protected:
73 | using base = VolumeController;
74 |
75 | T* vol;
76 |
77 | constexpr VolumeController(T* vol, std::string const& resolved_name, std::string const& identifier, const EDataFlow flow_type) : Volume(resolved_name, identifier, flow_type), vol{ vol } {}
78 |
79 | public:
80 | virtual ~VolumeController()
81 | {
82 | if (this->vol) ((IUnknown*)this->vol)->Release();
83 | }
84 | };
85 |
86 | struct ApplicationVolume : public VolumeController {
87 | std::string dev_id, sessionIdentifier, sessionInstanceIdentifier;
88 |
89 | constexpr ApplicationVolume(ISimpleAudioVolume* vol, std::string const& resolved_name, const DWORD pid, const EDataFlow flow_type, std::string const& deviceID, std::string const& sessionIdentifier, std::string const& sessionInstanceIdentifier) : base(vol, resolved_name, std::to_string(pid), flow_type), dev_id{ deviceID }, sessionIdentifier{ sessionIdentifier }, sessionInstanceIdentifier{ sessionInstanceIdentifier } {}
90 |
91 | bool getMuted() const override
92 | {
93 | BOOL muted;
94 | vol->GetMute(&muted);
95 | return static_cast(muted);
96 | }
97 | void setMuted(const bool state) const override
98 | {
99 | vol->SetMute(static_cast(state), &default_context);
100 | }
101 |
102 | float getVolume() const override
103 | {
104 | float level;
105 | vol->GetMasterVolume(&level);
106 | return level;
107 | }
108 | void setVolume(const float& level) const override
109 | {
110 | vol->SetMasterVolume(level, &default_context);
111 | }
112 | constexpr std::optional type_name() const override
113 | {
114 | return{ "Session" };
115 | }
116 | };
117 |
118 | struct EndpointVolume : VolumeController {
119 | bool isDefault;
120 |
121 | constexpr EndpointVolume(IAudioEndpointVolume* vol, std::string const& resolved_name, std::string const& dGuid, const EDataFlow flow_type, const bool isDefault) : base(vol, resolved_name, dGuid, flow_type), isDefault{ isDefault } {}
122 |
123 | bool getMuted() const override
124 | {
125 | BOOL isMuted;
126 | vol->GetMute(&isMuted);
127 | return static_cast(isMuted);
128 | }
129 | void setMuted(const bool state) const override
130 | {
131 | vol->SetMute(static_cast(state), &default_context);
132 | }
133 |
134 | float getVolume() const override
135 | {
136 | float level;
137 | vol->GetMasterVolumeLevelScalar(&level);
138 | return level;
139 | }
140 | void setVolume(const float& level) const override
141 | {
142 | vol->SetMasterVolumeLevelScalar(level, &default_context);
143 | }
144 | constexpr std::optional type_name() const override
145 | {
146 | return{ "Device" };
147 | }
148 | };
149 | }
150 |
--------------------------------------------------------------------------------
/.github/workflows/GenerateRelease.yml:
--------------------------------------------------------------------------------
1 | name: Generate Release
2 |
3 | on:
4 | push:
5 | tags: [ '*.*.*' ]
6 | workflow_dispatch:
7 | inputs:
8 | name:
9 | description: 'Release Name'
10 | required: false
11 | default: ''
12 | type: string
13 | tag:
14 | description: 'Tag'
15 | required: false
16 | default: ''
17 | type: string
18 | is-draft:
19 | description: 'Draft'
20 | required: false
21 | default: false
22 | type: boolean
23 | is-prerelease:
24 | description: 'Pre-Release'
25 | required: false
26 | default: false
27 | type: boolean
28 | autogenerate:
29 | description: 'Autogenerate Release Notes'
30 | required: false
31 | default: false
32 | type: boolean
33 | body:
34 | description: 'Description'
35 | required: false
36 | default: ''
37 |
38 | env:
39 | # [PROJECT_NAME]
40 | # Currently this is used for the following scenarios:
41 | # - Build Subdirectory Name
42 | # - Archive Name Prefix
43 | PROJECT_NAME: 'vccli'
44 | # [BINARY_NAME]
45 | # The name of the binary executable file, excluding extensions.
46 | # If this is blank, the value specified by '$PROJECT_NAME' is used instead. (See the 'Configure Environment' step.)
47 | BINARY_NAME: ''
48 | BUILD_TYPE: Release
49 | GET_VERSION_NUMBER_ARGS: "--version --quiet"
50 |
51 | jobs:
52 | create-binaries:
53 | runs-on: ${{matrix.os}}
54 | strategy:
55 | matrix:
56 | os: [ windows-latest ]
57 | fail-fast: true
58 |
59 | steps:
60 | # Check out the repository
61 | - uses: actions/checkout@v3
62 | with:
63 | submodules: recursive
64 | fetch-depth: 0
65 |
66 | # Set up platform dependencies
67 | # Ninja
68 | - uses: seanmiddleditch/gha-setup-ninja@master
69 | # MSVC (Windows)
70 | - if: ${{ runner.os == 'Windows' }}
71 | uses: ilammy/msvc-dev-cmd@v1
72 | # gcc-10 g++-10 zip unzip (Linux)
73 | - if: ${{ runner.os == 'Linux' }}
74 | run: sudo apt-get update && sudo apt-get install gcc-10 g++-10 zip unzip -y
75 |
76 |
77 | # Configure CMake Cache
78 | # Windows
79 | - name: Configure CMake (Windows)
80 | if: ${{ runner.os == 'Windows' }}
81 | run: cmake -B '${{github.workspace}}/build' -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -G Ninja
82 | # Linux/macOS
83 | - name: Configure CMake (Linux/macOS)
84 | if: ${{ runner.os != 'Windows' }}
85 | run: cmake -B '${{github.workspace}}/build' -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -G Ninja
86 | env:
87 | CC: gcc-10
88 | CXX: g++-10
89 |
90 | # Build Binary
91 | - name: Build
92 | run: cmake --build '${{github.workspace}}/build' --config '${{env.BUILD_TYPE}}'
93 |
94 | # Create Packaged Release Archive
95 | # Windows
96 | - name: Create Archive (Windows)
97 | if: ${{ runner.os == 'Windows' }}
98 | run: |
99 | cd "${{github.workspace}}/build/${{env.PROJECT_NAME}}"
100 | Compress-Archive "${{env.BINARY_NAME || env.PROJECT_NAME}}.exe" "${{env.PROJECT_NAME}}-$(.\${{env.PROJECT_NAME}} ${{env.GET_VERSION_NUMBER_ARGS}})-Windows.zip"
101 | shell: powershell
102 | # Linux / macOS
103 | - name: Create Archive (Linux/macOS)
104 | if: ${{ runner.os != 'Windows' }}
105 | run: |
106 | cd "${{github.workspace}}/build/${{env.PROJECT_NAME}}"
107 | zip -T9 "${{env.PROJECT_NAME}}-$(./${{env.PROJECT_NAME}} ${{env.GET_VERSION_NUMBER_ARGS}})-${{runner.os}}.zip" "${{env.BINARY_NAME || env.PROJECT_NAME}}"
108 | shell: bash
109 |
110 | # Upload Artifact
111 | - name: Upload Artifact
112 | uses: actions/upload-artifact@v2
113 | with:
114 | name: latest-${{runner.os}}
115 | path: '${{github.workspace}}/build/${{env.PROJECT_NAME}}/*.zip'
116 | #:create-binaries
117 |
118 | create-release:
119 | needs: create-binaries
120 | runs-on: ubuntu-latest
121 |
122 | steps:
123 | # Download Artifacts
124 | - name: 'Download Build Artifacts'
125 | uses: actions/download-artifact@v2
126 |
127 | # Retrieve the latest git tag if this was triggered by a tag
128 | - name: 'Get Release Tag'
129 | id: get_version
130 | run: |
131 | if [ "${{github.event.inputs.tag}}" == "" ]; then TAG="${GITHUB_REF/refs\/tags\//}"; else TAG="${{github.event.inputs.tag}}" ; fi
132 | echo ::set-output name=VERSION::$TAG
133 | echo ::set-output name=NAME::"Release $TAG"
134 |
135 | # Stage downloaded build artifacts for deployment
136 | - name: 'Stage Archives'
137 | run: |
138 | cd ${{github.workspace}}
139 | if mv ./latest-*/* ./ ; then ls -lAgh ; else ls -lAghR ; fi
140 | shell: bash
141 |
142 | # Upload Release
143 | - name: 'Create Release'
144 | #if: ${{ github.event_name == 'workflow_dispatch' }}
145 | uses: softprops/action-gh-release@v1
146 | with:
147 | draft: ${{ github.event.inputs.is-draft || false }}
148 | prerelease: ${{ github.event.inputs.is-prerelease || false }}
149 | tag_name: ${{ steps.get_version.outputs.VERSION }}
150 | name: ${{ steps.get_version.outputs.NAME }}
151 | generate_release_notes: ${{ github.event.inputs.autogenerate || true }}
152 | body: ${{ github.event.inputs.body || '' }}
153 | fail_on_unmatched_files: true
154 | files: ${{github.workspace}}/*.zip
155 | #:create-release
156 |
--------------------------------------------------------------------------------
/vccli/util.hpp:
--------------------------------------------------------------------------------
1 | #pragma once
2 | #include
3 | #include
4 |
5 | #include
6 | #include
7 | #include
8 | #include
9 | #include
10 | #include
11 | #include
12 | #include
13 | #include
14 |
15 | #include
16 |
17 | #define WIN32_LEAN_AND_MEAN
18 | #include
19 | #include
20 | #include
21 | #include
22 | #include
23 | #include
24 | #include
25 |
26 | namespace vccli {
27 | /// @brief ( std::wstring <=> std::string ) converter object with UTF8/UTF16 (Windows) encoding.
28 | inline static std::wstring_convert, wchar_t> w_converter;
29 |
30 | /**
31 | * @brief Uses the FormatMessage function to get a description of the given error code.
32 | * @param err The error ID number; either an HRESULT or another type of windows system error code.
33 | * @returns String containing a description of the error.
34 | */
35 | template
36 | WINCONSTEXPR std::string GetErrorMessageFrom(T const& err)
37 | {
38 | LPVOID lpMsgBuf{};
39 | FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, NULL, static_cast(err), MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPTSTR)&lpMsgBuf, 0, NULL);
40 | return{ (char*)lpMsgBuf };
41 | }
42 |
43 | TEST_CASE("GetErrorMessageFrom")
44 | {
45 | CHECK(GetErrorMessageFrom(0) == "The operation completed successfully.\r\n");
46 | }
47 |
48 | /**
49 | * @brief Compares two given strings by comparing them as extentionless filenames using case-insensitive matching.
50 | * @param l Left-side comparison string
51 | * @param r Right-side comparison string
52 | * @returns true when the extentionless filename of l is equal to the extentionless filename of r; otherwise false.
53 | */
54 | bool CompareProcessName(std::string const& l, std::string const& r)
55 | {
56 | return str::tolower(std::filesystem::path{ l }.replace_extension().generic_string()) == str::tolower(std::filesystem::path{ r }.replace_extension().generic_string());
57 | }
58 |
59 | inline std::optional GetProcessNameFrom(DWORD const& pid)
60 | {
61 | if (HANDLE hProc = OpenProcess(PROCESS_QUERY_LIMITED_INFORMATION, FALSE, pid)) {
62 | DWORD len{ 260 };
63 | CHAR sbuf[260];
64 | if (QueryFullProcessImageNameA(hProc, PROCESS_NAME_NATIVE, sbuf, &len) != 0) {
65 | CloseHandle(hProc);
66 | return std::filesystem::path{ sbuf }.filename().replace_extension().generic_string();
67 | }
68 | else {
69 | const auto hr{ GetLastError() };
70 | CloseHandle(hProc);
71 | throw make_exception("GetProcessName failed: ", GetErrorMessageFrom(hr), " (code: ", hr, ')');
72 | }
73 | }
74 | return std::nullopt;
75 | }
76 |
77 | inline std::string getSessionInstanceIdentifier(IAudioSessionControl2* session)
78 | {
79 | LPWSTR sbuf;
80 | session->GetSessionInstanceIdentifier(&sbuf);
81 | return w_converter.to_bytes(sbuf);
82 | }
83 | inline std::string getSessionIdentifier(IAudioSessionControl2* session)
84 | {
85 | LPWSTR sbuf;
86 | session->GetSessionIdentifier(&sbuf);
87 | return w_converter.to_bytes(sbuf);
88 | }
89 |
90 | inline std::string getDeviceID(IMMDevice* dev)
91 | {
92 | LPWSTR sbuf;
93 | dev->GetId(&sbuf);
94 | return w_converter.to_bytes(sbuf);
95 | }
96 | /**
97 | * @brief Retrieves the specified property value from the given device's property store.
98 | * @param dev The IMMDevice to retrieve properties from.
99 | * @param pkey The PROPERTYKEY structure to target.
100 | * @returns PROPVARIANT
101 | */
102 | inline PROPVARIANT getDeviceProperty(IMMDevice* dev, const PROPERTYKEY& pkey)
103 | {
104 | PROPVARIANT pv{};
105 | if (IPropertyStore* properties; dev->OpenPropertyStore(STGM_READ, &properties) == S_OK) {
106 | properties->GetValue(pkey, &pv);
107 | properties->Release();
108 | }
109 | return pv;
110 | }
111 | /**
112 | * @brief Retrieve the name of the given device from its properties.
113 | *\n PKEY_DeviceInterface_FriendlyName
114 | * @param dev The IMMDevice to retrieve properties from.
115 | * @returns std::string
116 | */
117 | inline std::string getDeviceFriendlyName(IMMDevice* dev)
118 | {
119 | return w_converter.to_bytes(getDeviceProperty(dev, PKEY_DeviceInterface_FriendlyName).pwszVal);
120 | }
121 | /**
122 | * @brief Retrieve the name of the given device from its properties.
123 | *\n PKEY_Device_FriendlyName
124 | * @param dev The IMMDevice to retrieve properties from.
125 | * @returns std::string
126 | */
127 | inline std::string getDeviceName(IMMDevice* dev)
128 | {
129 | return w_converter.to_bytes(getDeviceProperty(dev, PKEY_Device_FriendlyName).pwszVal);
130 | }
131 | /**
132 | * @brief Retrieve the description of the given device from its properties.
133 | *\n PKEY_Device_DeviceDesc
134 | * @param dev The IMMDevice to retrieve properties from.
135 | * @returns std::string
136 | */
137 | inline std::string getDeviceDesc(IMMDevice* dev)
138 | {
139 | return w_converter.to_bytes(getDeviceProperty(dev, PKEY_Device_DeviceDesc).pwszVal);
140 | }
141 | /**
142 | * @brief Queries the given device to determine whether it is an input or output device.
143 | * @param dev The IMMDevice to query.
144 | * @returns EDataFlow
145 | */
146 | inline EDataFlow getDeviceDataFlow(IMMDevice* dev)
147 | {
148 | IMMEndpoint* endpoint;
149 | dev->QueryInterface(&endpoint);
150 | EDataFlow flow;
151 | endpoint->GetDataFlow(&flow);
152 | endpoint->Release();
153 | return flow;
154 | }
155 | /**
156 | * @brief Convert the given EDataFlow enumeration to a string representation.
157 | * @param dataflow An EDataFlow enum value.
158 | * @returns std::string
159 | */
160 | constexpr std::string DataFlowToString(EDataFlow const& dataflow)
161 | {
162 | switch (dataflow) {
163 | case EDataFlow::eRender:
164 | return "Output";
165 | case EDataFlow::eCapture:
166 | return "Input";
167 | case EDataFlow::eAll:
168 | return "In/Out";
169 | default:
170 | return{};
171 | }
172 | }
173 | }
174 |
--------------------------------------------------------------------------------
/vccli/AudioAPI.hpp:
--------------------------------------------------------------------------------
1 | #pragma once
2 | #include "util.hpp"
3 | #include "Volume.hpp"
4 |
5 | #include
6 | #include
7 |
8 | #define $release(var) var->Release(); var = nullptr;
9 |
10 | namespace vccli {
11 | struct basic_info {
12 | virtual ~basic_info() = default;
13 | friend std::ostream& operator<<(std::ostream& os, const basic_info&) { return os; }
14 | };
15 |
16 | struct DeviceInfo : basic_info {
17 | std::string dname, dguid;
18 | EDataFlow flow;
19 | bool isDefault;
20 |
21 | constexpr DeviceInfo(std::string const& DNAME, std::string const& DGUID, const EDataFlow flow, const bool isDefault) : dname{ DNAME }, dguid{ DGUID }, flow{ flow }, isDefault{ isDefault } {}
22 |
23 | std::optional type_name() const { return "Device"; }
24 | };
25 | struct ProcessInfo : DeviceInfo {
26 | DWORD pid;
27 | std::string pname, suid, sguid;
28 |
29 | constexpr ProcessInfo(std::string const& PNAME, const DWORD PID, const EDataFlow flow, std::string const& SUID, std::string const& SGUID, std::string const& DGUID, std::string const& DNAME, const bool isDefaultDevice)
30 | : DeviceInfo(DNAME, DGUID, flow, false), pid{ PID }, pname{ PNAME }, suid{ SUID }, sguid{ SGUID }
31 | {
32 | }
33 |
34 | };
35 |
36 | struct ProcessInfoLookup {
37 | using pInfo_t = std::pair;
38 | using pInfo_list_t = std::vector;
39 | pInfo_list_t vec;
40 |
41 | constexpr ProcessInfoLookup(pInfo_list_t&& vec) : vec{ std::move(vec) } {}
42 | constexpr ProcessInfoLookup(pInfo_list_t const& vec) : vec{ vec } {}
43 |
44 | constexpr std::optional operator()(std::string pName, const bool ignoreCase = true) const
45 | {
46 | if (ignoreCase)
47 | pName = str::tolower(pName);
48 | for (const auto& it : vec)
49 | if ((!ignoreCase && it.second == pName) || (ignoreCase && str::tolower(it.second) == pName))
50 | return it;
51 | return std::nullopt;
52 | }
53 | constexpr std::optional operator()(DWORD const& pid) const
54 | {
55 | for (const auto& it : vec)
56 | if (it.first == pid)
57 | return it;
58 | return std::nullopt;
59 | }
60 | };
61 |
62 | class AudioAPI {
63 | #pragma region Internal
64 | static IMMDeviceEnumerator* getDeviceEnumerator()
65 | {
66 | IMMDeviceEnumerator* deviceEnumerator{};
67 | if (const auto& hr{ CoCreateInstance(__uuidof(MMDeviceEnumerator), NULL, CLSCTX_INPROC_SERVER, __uuidof(IMMDeviceEnumerator), (void**)&deviceEnumerator) }; hr != S_OK)
68 | throw make_exception(GetErrorMessageFrom(hr), " (code ", hr, ')');
69 | return{ deviceEnumerator };
70 | }
71 | #pragma endregion Internal
72 |
73 | static ProcessInfoLookup::pInfo_list_t GetAudioProcessLookup(EDataFlow flow = EDataFlow::eAll, ERole role = ERole::eMultimedia)
74 | {
75 | ProcessInfoLookup::pInfo_list_t vec;
76 |
77 | auto deviceEnumerator{ getDeviceEnumerator() };
78 |
79 | IMMDeviceCollection* devices;
80 | deviceEnumerator->EnumAudioEndpoints(flow, role, &devices);
81 |
82 | UINT count;
83 | devices->GetCount(&count);
84 |
85 | static constexpr IID iid_IAudioSessionManager2{ __uuidof(IAudioSessionManager2) };
86 |
87 | IMMDevice* dev;
88 | IAudioSessionManager2* devManager{};
89 | IAudioSessionEnumerator* sessionEnumerator{};
90 | IAudioSessionControl* sessionControl{};
91 | IAudioSessionControl2* sessionControl2{};
92 |
93 | for (UINT i{ 0u }; i < count; ++i) {
94 | devices->Item(i, &dev);
95 |
96 | dev->Activate(iid_IAudioSessionManager2, 0, NULL, (void**)&devManager);
97 | devManager->GetSessionEnumerator(&sessionEnumerator);
98 |
99 | int sessionCount;
100 | sessionEnumerator->GetCount(&sessionCount);
101 |
102 | vec.reserve(vec.size() + sessionCount);
103 |
104 | for (int i{ 0 }; i < sessionCount; ++i) {
105 | sessionEnumerator->GetSession(i, &sessionControl);
106 |
107 | sessionControl->QueryInterface(&sessionControl2);
108 |
109 | DWORD pid;
110 | sessionControl2->GetProcessId(&pid);
111 |
112 | if (std::any_of(vec.begin(), vec.end(), [&pid](auto&& pair) -> bool { return pair.first == pid; }))
113 | continue;
114 |
115 | if (const auto& pName{ GetProcessNameFrom(pid) }; pName.has_value())
116 | vec.emplace_back(std::make_pair(pid, pName.value()));
117 |
118 | sessionControl->Release();
119 | sessionControl2->Release();
120 | }
121 |
122 | sessionEnumerator->Release();
123 | devManager->Release();
124 | dev->Release();
125 | }
126 |
127 | devices->Release();
128 | deviceEnumerator->Release();
129 |
130 | vec.shrink_to_fit();
131 | return vec;
132 | }
133 | static ProcessInfoLookup::pInfo_list_t GetAudioProcessLookupSorted(const std::function, std::pair)>& sorting_predicate, EDataFlow flow = EDataFlow::eAll, ERole role = ERole::eMultimedia)
134 | {
135 | std::vector> vec{ GetAudioProcessLookup(flow, role) };
136 | std::sort(vec.begin(), vec.end(), sorting_predicate);
137 | return vec;
138 | }
139 | static ProcessInfoLookup::pInfo_list_t GetAudioProcessLookupSorted(EDataFlow flow = EDataFlow::eAll, ERole role = ERole::eMultimedia)
140 | {
141 | return GetAudioProcessLookupSorted(std::less>{}, flow, role);
142 | }
143 |
144 | public:
145 | static IMMDevice* getDevice(const std::string& device_id)
146 | {
147 | const auto& deviceEnumerator{ getDeviceEnumerator() };
148 |
149 | IMMDevice* dev;
150 | IMMDeviceCollection* devices;
151 | deviceEnumerator->EnumAudioEndpoints(EDataFlow::eRender, ERole::eMultimedia, &devices);
152 |
153 | UINT count;
154 | devices->GetCount(&count);
155 |
156 | LPWSTR sbuf{};
157 |
158 | for (UINT i{ 0u }; i < count; ++i) {
159 | devices->Item(i, &dev);
160 |
161 | if (dev->GetId(&sbuf) == S_OK && w_converter.to_bytes(sbuf) == device_id) {
162 | devices->Release();
163 | deviceEnumerator->Release();
164 |
165 | return dev;
166 | }
167 | }
168 |
169 | devices->Release();
170 | deviceEnumerator->Release();
171 |
172 | return nullptr;
173 | }
174 | static IMMDevice* getDefaultDevice()
175 | {
176 | auto* deviceEnumerator{ getDeviceEnumerator() };
177 |
178 | IMMDevice* dev;
179 | deviceEnumerator->GetDefaultAudioEndpoint(EDataFlow::eRender, ERole::eMultimedia, &dev);
180 |
181 | deviceEnumerator->Release();
182 |
183 | return dev;
184 | }
185 | static std::string getDeviceName(std::string const& devID)
186 | {
187 | auto* deviceEnumerator{ getDeviceEnumerator() };
188 | IMMDevice* dev;
189 | deviceEnumerator->GetDevice(w_converter.from_bytes(devID).c_str(), &dev);
190 | $release(deviceEnumerator);
191 | std::string name{ getDeviceFriendlyName(dev) };
192 | $release(dev);
193 | return name;
194 | }
195 |
196 | static std::vector GetAllAudioProcesses(EDataFlow flow = EDataFlow::eAll, ERole role = ERole::eMultimedia)
197 | {
198 | std::vector vec;
199 |
200 | auto deviceEnumerator{ getDeviceEnumerator() };
201 | IMMDevice* dev;
202 |
203 | std::string defDevIDIn{}, defDevIDOut{};
204 | deviceEnumerator->GetDefaultAudioEndpoint(EDataFlow::eRender, ERole::eMultimedia, &dev);
205 | defDevIDOut = getDeviceID(dev);
206 | $release(dev);
207 | deviceEnumerator->GetDefaultAudioEndpoint(EDataFlow::eCapture, ERole::eMultimedia, &dev);
208 | defDevIDIn = getDeviceID(dev);
209 | $release(dev);
210 |
211 | IMMDeviceCollection* devices;
212 | deviceEnumerator->EnumAudioEndpoints(flow, role, &devices);
213 |
214 | UINT count;
215 | devices->GetCount(&count);
216 |
217 | static constexpr IID iid_IAudioSessionManager2{ __uuidof(IAudioSessionManager2) };
218 |
219 | IAudioSessionManager2* devManager{};
220 | IAudioSessionEnumerator* sessionEnumerator{};
221 | IAudioSessionControl* sessionControl{};
222 | IAudioSessionControl2* sessionControl2{};
223 |
224 | for (UINT i{ 0u }; i < count; ++i) {
225 | devices->Item(i, &dev);
226 |
227 | dev->Activate(iid_IAudioSessionManager2, 0, NULL, (void**)&devManager);
228 | devManager->GetSessionEnumerator(&sessionEnumerator);
229 |
230 | int sessionCount;
231 | sessionEnumerator->GetCount(&sessionCount);
232 |
233 | vec.reserve(vec.size() + sessionCount);
234 | const auto& devName{ getDeviceFriendlyName(dev) };
235 | const auto& devID{ getDeviceID(dev) };
236 | const auto& devFlow{ getDeviceDataFlow(dev) };
237 |
238 | for (int i{ 0 }; i < sessionCount; ++i) {
239 | sessionEnumerator->GetSession(i, &sessionControl);
240 |
241 | sessionControl->QueryInterface(&sessionControl2);
242 |
243 | DWORD pid;
244 | sessionControl2->GetProcessId(&pid);
245 |
246 | if (const auto& pName{ GetProcessNameFrom(pid) }; pName.has_value())
247 | vec.emplace_back(ProcessInfo{ pName.value(), pid, devFlow, getSessionIdentifier(sessionControl2), getSessionInstanceIdentifier(sessionControl2), devID, devName, devID == defDevIDIn || devID == defDevIDOut });
248 |
249 | sessionControl->Release();
250 | sessionControl2->Release();
251 | }
252 |
253 | sessionEnumerator->Release();
254 | devManager->Release();
255 | dev->Release();
256 | }
257 |
258 | devices->Release();
259 | deviceEnumerator->Release();
260 |
261 | vec.shrink_to_fit();
262 | return vec;
263 | }
264 | static std::vector GetAllAudioProcessesSorted(const std::function& sorting_predicate, EDataFlow flow = EDataFlow::eAll, ERole role = ERole::eMultimedia)
265 | {
266 | auto vec{ GetAllAudioProcesses(flow, role) };
267 | std::sort(vec.begin(), vec.end(), sorting_predicate);
268 | return vec;
269 | }
270 | static std::vector GetAllAudioProcessesSorted(EDataFlow flow = EDataFlow::eAll, ERole role = ERole::eMultimedia)
271 | {
272 | const auto& nSorter{ std::less() };
273 | return GetAllAudioProcessesSorted([&nSorter](ProcessInfo const& l, ProcessInfo const& r) -> bool { return static_cast(l.flow) < static_cast(r.flow) && nSorter(l.pid, r.pid); }, flow, role);
274 | }
275 |
276 | static std::vector GetAllAudioDevices(EDataFlow flow = EDataFlow::eAll, ERole role = ERole::eMultimedia)
277 | {
278 | IMMDeviceEnumerator* deviceEnumerator{ getDeviceEnumerator() };
279 | IMMDevice* dev;
280 |
281 | std::wstring defaultOutputDevID, defaultInputDevID;
282 | LPWSTR sbuf;
283 |
284 | // Get default output device id
285 | deviceEnumerator->GetDefaultAudioEndpoint(EDataFlow::eRender, role, &dev);
286 | dev->GetId(&sbuf);
287 | defaultOutputDevID = sbuf;
288 | dev->Release();
289 | // Get default input device id
290 | deviceEnumerator->GetDefaultAudioEndpoint(EDataFlow::eCapture, role, &dev);
291 | dev->GetId(&sbuf);
292 | defaultInputDevID = sbuf;
293 | dev->Release();
294 |
295 | IMMDeviceCollection* devices;
296 | deviceEnumerator->EnumAudioEndpoints(flow, role, &devices);
297 | deviceEnumerator->Release();
298 |
299 | UINT count;
300 | devices->GetCount(&count);
301 |
302 | std::vector vec;
303 | vec.reserve(count);
304 |
305 | for (UINT i{ 0 }; i < count; ++i) {
306 | devices->Item(i, &dev);
307 |
308 | dev->GetId(&sbuf);
309 | const std::wstring devID{ sbuf };
310 |
311 | vec.emplace_back(DeviceInfo{ getDeviceFriendlyName(dev), w_converter.to_bytes(devID), getDeviceDataFlow(dev), devID == defaultInputDevID || devID == defaultOutputDevID });
312 |
313 | dev->Release();
314 | }
315 |
316 | devices->Release();
317 |
318 | vec.shrink_to_fit();
319 | return vec;
320 | }
321 | static std::vector GetAllAudioDevicesSorted(const std::function& sorting_predicate, EDataFlow flow = EDataFlow::eAll, ERole role = ERole::eMultimedia)
322 | {
323 | auto devices{ GetAllAudioDevices(flow, role) };
324 | std::sort(devices.begin(), devices.end(), sorting_predicate);
325 | return devices;
326 | }
327 | static std::vector GetAllAudioDevicesSorted(EDataFlow flow = EDataFlow::eAll, ERole role = ERole::eMultimedia)
328 | {
329 | const auto& sSorter{ std::less() };
330 | return GetAllAudioDevicesSorted([&sSorter](DeviceInfo const& l, DeviceInfo const& r) -> bool { return static_cast(l.flow) < static_cast(r.flow) && sSorter(l.dname, r.dname); }, flow, role);
331 | }
332 |
333 | /// @brief Gets the appropriate volume control object for the given string.
334 | static std::unique_ptr getObject(const std::string& target_id, const bool fuzzy, EDataFlow const& deviceFlowFilter, const bool defaultDevIsOutput = true)
335 | {
336 | auto target_id_lower{ str::tolower(target_id) };
337 | if (fuzzy)
338 | target_id_lower = str::trim(target_id_lower);
339 |
340 | const auto& compare_target_id_to{ [&target_id_lower, &fuzzy](std::string const& s) -> bool {
341 | return (target_id_lower == (fuzzy ? str::trim(s) : s)) || (fuzzy && s.find(str::trim(target_id_lower)) != std::string::npos);
342 | } };
343 |
344 | std::unique_ptr object{ nullptr };
345 |
346 | IMMDeviceEnumerator* deviceEnumerator{ getDeviceEnumerator() };
347 | IMMDevice* dev;
348 |
349 | if (target_id.empty()) {
350 | // DEFAULT DEVICE:
351 | EDataFlow defaultDevFlow{ deviceFlowFilter };
352 | if (defaultDevFlow == EDataFlow::eAll) //< we can't request a default 'eAll' device; select input or output
353 | defaultDevFlow = (defaultDevIsOutput ? EDataFlow::eRender : EDataFlow::eCapture);
354 |
355 | deviceEnumerator->GetDefaultAudioEndpoint(defaultDevFlow, ERole::eMultimedia, &dev);
356 | $release(deviceEnumerator);
357 | IAudioEndpointVolume* endpoint{};
358 | dev->Activate(__uuidof(IAudioEndpointVolume), CLSCTX_INPROC_SERVER, NULL, (void**)&endpoint);
359 | const auto& devName{ getDeviceFriendlyName(dev) };
360 | const auto& deviceID{ getDeviceID(dev) };
361 | $release(dev);
362 |
363 | return std::make_unique(endpoint, devName, deviceID, defaultDevFlow, true);
364 | } // Else we have an actual target ID to find
365 |
366 | // Check if we have a valid PID
367 | std::optional target_pid;
368 | if (std::all_of(target_id.begin(), target_id.end(), str::stdpred::isdigit))
369 | target_pid = str::stoul(target_id);
370 |
371 | // Enumerate all devices of the specified I/O type(s):
372 | IMMDeviceCollection* devices;
373 | deviceEnumerator->EnumAudioEndpoints(deviceFlowFilter, ERole::eMultimedia, &devices);
374 | $release(deviceEnumerator)
375 |
376 | UINT count;
377 | devices->GetCount(&count);
378 |
379 | for (UINT i{ 0u }; object == nullptr && i < count; ++i) {
380 | devices->Item(i, &dev);
381 |
382 | LPWSTR sbuf;
383 | dev->GetId(&sbuf);
384 | std::string deviceID{ w_converter.to_bytes(sbuf) };
385 |
386 | const auto& deviceName{ getDeviceFriendlyName(dev) };
387 | const auto& deviceFlow{ getDeviceDataFlow(dev) };
388 |
389 | // Check if this device is a match
390 | if (!target_pid.has_value() && (compare_target_id_to(str::tolower(deviceID)) || compare_target_id_to(str::tolower(deviceName)))) {
391 | IAudioEndpointVolume* endpointVolume{};
392 | dev->Activate(__uuidof(IAudioEndpointVolume), CLSCTX_INPROC_SERVER, NULL, (void**)&endpointVolume);
393 | object = std::make_unique(endpointVolume, deviceName, deviceID, deviceFlow, isDefaultDevice(dev));
394 | }
395 | else { // Check for matching sessions on this device:
396 | IAudioSessionManager2* mgr{};
397 | dev->Activate(__uuidof(IAudioSessionManager2), 0, NULL, (void**)&mgr);
398 |
399 | IAudioSessionEnumerator* sessionEnumerator;
400 | mgr->GetSessionEnumerator(&sessionEnumerator);
401 | $release(mgr);
402 |
403 | IAudioSessionControl* sessionControl;
404 | IAudioSessionControl2* sessionControl2;
405 | ISimpleAudioVolume* sessionVolumeControl;
406 |
407 | // Enumerate all audio sessions on this device:
408 | int sessionCount;
409 | sessionEnumerator->GetCount(&sessionCount);
410 |
411 | for (int j{ 0 }; j < sessionCount; ++j) {
412 | sessionEnumerator->GetSession(j, &sessionControl);
413 |
414 | sessionControl->QueryInterface(&sessionControl2);
415 | $release(sessionControl);
416 |
417 | DWORD pid;
418 | sessionControl2->GetProcessId(&pid);
419 |
420 | const auto& pname{ GetProcessNameFrom(pid) };
421 | const auto& suid{ getSessionIdentifier(sessionControl2) }, & sguid{ getSessionInstanceIdentifier(sessionControl2) };
422 |
423 | // Check if this session is a match:
424 | if ((pname.has_value() && compare_target_id_to(str::tolower(pname.value()))) || (target_pid.has_value() && target_pid.value() == pid) || compare_target_id_to(suid) || compare_target_id_to(sguid)) {
425 | sessionControl2->QueryInterface(&sessionVolumeControl);
426 | $release(sessionControl2);
427 | object = std::make_unique(sessionVolumeControl, pname.value(), pid, deviceFlow, deviceID, suid, sguid);
428 | break; //< break from session enumeration loop
429 | }
430 | $release(sessionControl2);
431 | } //< end session enumeration loop
432 | $release(sessionEnumerator)
433 | }
434 | $release(dev);
435 | }
436 | $release(devices);
437 |
438 | return object;
439 | }
440 | static std::vector> getObjects(const std::string& target_id, const bool fuzzy, EDataFlow const& deviceFlowFilter, const bool defaultDevIsOutput = true)
441 | {
442 | auto target_id_lower{ str::tolower(target_id) };
443 | if (fuzzy)
444 | target_id_lower = str::trim(target_id_lower);
445 |
446 | const auto& compare_target_id_to{ [&target_id_lower, &fuzzy](std::string const& s) -> bool {
447 | return (target_id_lower == (fuzzy ? str::trim(s) : s)) || (fuzzy && s.find(str::trim(target_id_lower)) != std::string::npos);
448 | } };
449 |
450 | std::vector> objects;
451 | objects.reserve(1);
452 |
453 | IMMDeviceEnumerator* deviceEnumerator{ getDeviceEnumerator() };
454 | IMMDevice* dev;
455 |
456 | if (target_id.empty()) {
457 | // DEFAULT DEVICE:
458 | EDataFlow defaultDevFlow{ deviceFlowFilter };
459 | if (defaultDevFlow == EDataFlow::eAll) //< we can't request a default 'eAll' device; select input or output
460 | defaultDevFlow = (defaultDevIsOutput ? EDataFlow::eRender : EDataFlow::eCapture);
461 |
462 | deviceEnumerator->GetDefaultAudioEndpoint(defaultDevFlow, ERole::eMultimedia, &dev);
463 | $release(deviceEnumerator);
464 | IAudioEndpointVolume* endpoint{};
465 | dev->Activate(__uuidof(IAudioEndpointVolume), CLSCTX_INPROC_SERVER, NULL, (void**)&endpoint);
466 | const auto& devName{ getDeviceFriendlyName(dev) };
467 | const auto& deviceID{ getDeviceID(dev) };
468 | $release(dev);
469 |
470 | objects.emplace_back(std::make_unique(endpoint, devName, deviceID, defaultDevFlow, true));
471 | return objects;
472 | } // Else we have an actual target ID to find
473 |
474 | // Check if we have a valid PID
475 | std::optional target_pid;
476 | if (std::all_of(target_id.begin(), target_id.end(), str::stdpred::isdigit))
477 | target_pid = str::stoul(target_id);
478 |
479 | // Enumerate all devices of the specified I/O type(s):
480 | IMMDeviceCollection* devices;
481 | deviceEnumerator->EnumAudioEndpoints(deviceFlowFilter, ERole::eMultimedia, &devices);
482 | $release(deviceEnumerator)
483 |
484 | UINT count;
485 | devices->GetCount(&count);
486 |
487 | objects.reserve(count);
488 |
489 | for (UINT i{ 0u }; i < count; ++i) {
490 | devices->Item(i, &dev);
491 |
492 | LPWSTR sbuf;
493 | dev->GetId(&sbuf);
494 | std::string deviceID{ w_converter.to_bytes(sbuf) };
495 |
496 | const auto& deviceName{ getDeviceFriendlyName(dev) };
497 | const auto& deviceFlow{ getDeviceDataFlow(dev) };
498 |
499 | // Check if this device is a match
500 | if (!target_pid.has_value() && (compare_target_id_to(str::tolower(deviceID)) || compare_target_id_to(str::tolower(deviceName)))) {
501 | IAudioEndpointVolume* endpointVolume{};
502 | dev->Activate(__uuidof(IAudioEndpointVolume), CLSCTX_INPROC_SERVER, NULL, (void**)&endpointVolume);
503 | objects.emplace_back(std::make_unique(endpointVolume, deviceName, deviceID, deviceFlow, isDefaultDevice(dev)));
504 | }
505 | else { // Check for matching sessions on this device:
506 | IAudioSessionManager2* mgr{};
507 | dev->Activate(__uuidof(IAudioSessionManager2), 0, NULL, (void**)&mgr);
508 |
509 | IAudioSessionEnumerator* sessionEnumerator;
510 | mgr->GetSessionEnumerator(&sessionEnumerator);
511 | $release(mgr);
512 |
513 | IAudioSessionControl* sessionControl;
514 | IAudioSessionControl2* sessionControl2;
515 | ISimpleAudioVolume* sessionVolumeControl;
516 |
517 | // Enumerate all audio sessions on this device:
518 | int sessionCount;
519 | sessionEnumerator->GetCount(&sessionCount);
520 |
521 | for (int j{ 0 }; j < sessionCount; ++j) {
522 | sessionEnumerator->GetSession(j, &sessionControl);
523 |
524 | sessionControl->QueryInterface(&sessionControl2);
525 | $release(sessionControl);
526 |
527 | DWORD pid;
528 | sessionControl2->GetProcessId(&pid);
529 |
530 | const auto& pname{ GetProcessNameFrom(pid) };
531 | const auto& suid{ getSessionIdentifier(sessionControl2) }, & sguid{ getSessionInstanceIdentifier(sessionControl2) };
532 |
533 | // Check if this session is a match:
534 | if ((pname.has_value() && compare_target_id_to(str::tolower(pname.value()))) || (target_pid.has_value() && target_pid.value() == pid) || compare_target_id_to(suid) || compare_target_id_to(sguid)) {
535 | sessionControl2->QueryInterface(&sessionVolumeControl);
536 | $release(sessionControl2);
537 | objects.emplace_back(std::make_unique(sessionVolumeControl, pname.value(), pid, deviceFlow, deviceID, suid, sguid));
538 | break; //< break from session enumeration loop
539 | }
540 | $release(sessionControl2);
541 | } //< end session enumeration loop
542 | $release(sessionEnumerator)
543 | }
544 | $release(dev);
545 | }
546 | $release(devices);
547 |
548 | objects.shrink_to_fit();
549 | return objects;
550 | }
551 |
552 | static bool isDefaultDevice(IMMDevice* dev)
553 | {
554 | const auto& devID{ getDeviceID(dev) };
555 | IMMDeviceEnumerator* deviceEnumerator{ getDeviceEnumerator() };
556 | bool isDefault{ false };
557 | IMMDevice* tmp;
558 | std::string tmpID{};
559 | deviceEnumerator->GetDefaultAudioEndpoint(EDataFlow::eRender, ERole::eMultimedia, &tmp);
560 | tmpID = getDeviceID(tmp);
561 | tmp->Release();
562 | if (tmpID == devID)
563 | isDefault = true;
564 | else {
565 | deviceEnumerator->GetDefaultAudioEndpoint(EDataFlow::eCapture, ERole::eMultimedia, &tmp);
566 | tmpID = getDeviceID(tmp);
567 | tmp->Release();
568 | if (tmpID == devID)
569 | isDefault = true;
570 | }
571 | deviceEnumerator->Release();
572 | return isDefault;
573 | }
574 | /**
575 | * @brief Resolves the given identifier to a process ID by searching for it in a snapshot.
576 | * @param identifier A process name or process ID.
577 | * @returns The process ID of the target process; or 0 if the process doesn't exist. If the process WAS found in the snapshot but is NOT still active, returns 0.
578 | */
579 | static std::optional ResolveProcessIdentifier(const std::string& identifier, const std::function& comp = CompareProcessName, EDataFlow flow = EDataFlow::eRender, ERole role = ERole::eMultimedia)
580 | {
581 | if (std::all_of(identifier.begin(), identifier.end(), str::stdpred::isdigit))
582 | return str::stoul(identifier); //< return ID casted to a number
583 | else {
584 | ProcessInfoLookup lookup{ GetAudioProcessLookup(flow, role) };
585 | if (const auto& pInfo{ lookup(identifier, true) }; pInfo.has_value()) {
586 | return pInfo.value().first;
587 | }
588 | }
589 | return std::nullopt;
590 | }
591 | };
592 | }
593 |
--------------------------------------------------------------------------------
/vccli/vccli.cpp:
--------------------------------------------------------------------------------
1 | #include "rc/version.h"
2 | #include "AudioAPI.hpp"
3 |
4 | #include
5 | #include
6 |
7 | #include
8 |
9 | struct PrintHelp {
10 | friend std::ostream& operator<<(std::ostream& os, const PrintHelp& h)
11 | {
12 | return os
13 | << "vccli v" << vccli_VERSION_EXTENDED << '\n'
14 | << " Volume Control CLI allows you to control audio endpoints (Devices) & audio sessions (Sessions) from the commandline.\n"
15 | << '\n'
16 | << "USAGE:\n"
17 | << " vccli [TARGET] [OPTIONS]" << '\n'
18 | << '\n'
19 | << " The '[TARGET]' field determines which device or session to target with commands, and accepts a variety of inputs:" << '\n'
20 | << " - Device ID (DGUID) Selects an audio device using the string representation of its GUID." << '\n'
21 | << " - Device Name (DNAME) Selects an audio device using its controller interface's name." << '\n'
22 | << " - Process ID (PID) Selects a specific audio session using a known process ID number." << '\n'
23 | << " - Process Name (PNAME) Selects a specific audio session using a process name." << '\n'
24 | << " - Session Identifier (SUID) Selects any audio session with the given Session Identifier." << '\n'
25 | << " - Session Instance Identifier (SGUID) Selects a specific audio session using its Session Instance Identifier." << '\n'
26 | << " - Blank Gets the default audio endpoint for the type specified by '-d'|'--dev'." << '\n'
27 | << '\n'
28 | << " Certain device endpoint names (DNAME) that are built-in to Windows contain trailing whitespace, such as" << '\n'
29 | << " 'USB Audio Codec '; keep this in mind when searching for devices by name, and/or use the ('-f'|'--fuzzy') option." << '\n'
30 | << '\n'
31 | << "OPTIONS:\n"
32 | << " -h, --help Shows this help display, then exits." << '\n'
33 | << " --version Prints the current version number, then exits." << '\n'
34 | << " -q, --quiet Show only minimal console output for getters; don't show any console output for setters." << '\n'
35 | << " -n, --no-color Disables ANSI color sequences; this option is implied when '-q'|'--quiet' is specified." << '\n'
36 | << " -d, --dev Selects input or output devices. When targeting an endpoint, this determines the type" << '\n'
37 | << " of device to use; when targeting a session, limits the search to devices of this type." << '\n'
38 | << " -f, --fuzzy Fuzzy search; allows partial matches instead of requiring a full match." << '\n'
39 | << " -e, --extended Shows additional fields when used with the query or list options." << '\n'
40 | << '\n'
41 | << "OPTIONS - Modes, Getters, & Setters:\n"
42 | << " -Q, --query Shows information about the specified TARGET if it exists; otherwise shows an error." << '\n'
43 | << " -l, --list Prints a list (sorted by PID) of all processes with an active audio session, then exits." << '\n'
44 | << " -L, --list-dev Prints a list of all audio endpoints that aren't unplugged or disabled, then exits." << '\n'
45 | << " -v, --volume [0-100] Gets or sets (when a number is specified) the volume of the target." << '\n'
46 | << " -I, --increment <0-100> Increments the volume of the target by the specified number." << '\n'
47 | << " -D, --decrement <0-100> Decrements the volume of the target by the specified number." << '\n'
48 | << " -m, --is-muted [true|false] Gets or sets (when a boolean is specified) the mute state of the target." << '\n'
49 | << " -M, --mute Mutes the target. (Equivalent to '-m=true'|'--is-muted=true')" << '\n'
50 | << " -U, --unmute Unmutes the target. (Equivalent to '-m=false'|'--is-muted=false')" << '\n'
51 | ;
52 | }
53 | };
54 |
55 | // Define exception type "except_showhelp":
56 | $DefineExcept(showhelp)
57 |
58 | // Globals:
59 | static bool quiet{ false };
60 | static bool extended{ false };
61 |
62 | enum class COLOR {
63 | HEADER,
64 | VALUE,
65 | HIGHLIGHT,
66 | LOWLIGHT,
67 | WARN,
68 | ERR,
69 | DEVICE,
70 | SESSION,
71 | INPUT,
72 | OUTPUT,
73 | };
74 | term::palette colors{
75 | std::make_pair(COLOR::HEADER, term::setcolor(term::make_sequence(color::FormatFlag::Bold))),
76 | std::make_pair(COLOR::VALUE, color::setcolor(1, 4, 1)),
77 | std::make_pair(COLOR::HIGHLIGHT, color::cyan),
78 | std::make_pair(COLOR::LOWLIGHT, color::light_gray),
79 | std::make_pair(COLOR::WARN, color::yellow),
80 | std::make_pair(COLOR::ERR, color::orange),
81 | std::make_pair(COLOR::DEVICE, color::setcolor(term::make_sequence(color::setcolor(color::lighter_purple), color::FormatFlag::Bold))),
82 | std::make_pair(COLOR::SESSION, color::light_blue),
83 | std::make_pair(COLOR::INPUT, color::pink),
84 | std::make_pair(COLOR::OUTPUT, color::setcolor(4, 4, 0)),
85 | };
86 | size_t MARGIN_WIDTH{ 12ull };
87 |
88 | // Forward Declarations:
89 | inline std::string getTargetAndValidateParams(const opt3::ArgManager&);
90 | inline EDataFlow getTargetDataFlow(const opt3::ArgManager&);
91 | inline void handleVolumeArgs(const opt3::ArgManager&, const vccli::Volume*);
92 | inline void handleMuteArgs(const opt3::ArgManager&, const vccli::Volume*);
93 |
94 |
95 | /**
96 | * @struct VolumeObjectPrinter
97 | * @brief Stream functor that pretty-prints a vccli::Volume object.
98 | */
99 | struct VolumeObjectPrinter {
100 | vccli::Volume* obj;
101 |
102 | /**
103 | * @brief Creates a new VolumeObjectPrinter instance with the given Volume object pointer.
104 | * @param obj A pointer to a valid Volume object to print.
105 | */
106 | constexpr VolumeObjectPrinter(vccli::Volume* obj) : obj{ obj } {}
107 |
108 | friend std::ostream& operator<<(std::ostream& os, const VolumeObjectPrinter& p)
109 | {
110 | if (p.obj) {
111 | const bool is_session{ p.obj->is_derived_type() }, is_device{ !is_session };
112 |
113 | if (quiet) {
114 | if (extended) {
115 | os
116 | << (is_session ? 'P' : 'D') << "NAME: " << p.obj->resolved_name << '\n'
117 | << (is_session ? "P" : "DGU") << "ID: " << p.obj->identifier << '\n'
118 | << "TYPENAME: " << p.obj->type_name().value() << '\n'
119 | << "DATAFLOW: " << p.obj->getFlowTypeName() << '\n'
120 | << "VOLUME: " << p.obj->getVolumeScaled() << '\n'
121 | << "IS_MUTED: " << std::boolalpha << p.obj->getMuted() << std::noboolalpha << '\n'
122 | ;
123 | if (is_session) {
124 | auto* app = (vccli::ApplicationVolume*)p.obj;
125 | os
126 | << "SUID: " << app->sessionIdentifier << '\n'
127 | << "SGUID: " << app->sessionInstanceIdentifier << '\n';
128 | }
129 | else if (is_device)
130 | os << "IS_DEFAULT: " << std::boolalpha << ((vccli::EndpointVolume*)p.obj)->isDefault << std::noboolalpha << '\n';
131 | }
132 | else os << p.obj->type_name().value_or("null");
133 | }
134 | else {
135 | const auto& typecolor{ is_session ? COLOR::SESSION : COLOR::DEVICE };
136 | os
137 | << " " << colors(typecolor) << p.obj->resolved_name << colors() << '\n'
138 | << "Typename: " << colors(typecolor) << p.obj->type_name().value_or("null") << colors();
139 | if (is_device && ((vccli::EndpointVolume*)p.obj)->isDefault) os << ' ' << colors(COLOR::LOWLIGHT) << "(Default)" << colors() << '\n';
140 | if (is_session)
141 | os << '\n'
142 | << "PID: " << colors(COLOR::LOWLIGHT) << p.obj->identifier << colors() << '\n';
143 | os
144 | << "Direction: " << colors(p.obj->flow_type == EDataFlow::eRender ? COLOR::OUTPUT : COLOR::INPUT) << p.obj->getFlowTypeName() << colors() << '\n'
145 | << "Volume: " << colors(COLOR::VALUE) << p.obj->getVolumeScaled() << colors() << '\n'
146 | << "Muted: " << colors(COLOR::VALUE) << std::boolalpha << p.obj->getMuted() << std::noboolalpha << colors() << '\n'
147 | ;
148 |
149 | if (extended) {
150 | if (is_session) {
151 | auto* app{ (vccli::ApplicationVolume*)p.obj };
152 | os
153 | << "Session ID: " << colors(COLOR::VALUE) << app->sessionIdentifier << colors() << '\n'
154 | << "Instance ID: " << colors(COLOR::VALUE) << app->sessionInstanceIdentifier << colors() << '\n'
155 | ;
156 | }
157 | }
158 | }
159 | }
160 | return os;
161 | }
162 | };
163 |
164 | namespace vccli_operators {
165 | inline constexpr auto SEP{ ';' };
166 | inline constexpr auto COLSZ_DNAME{ 30 };
167 | inline constexpr auto COLSZ_DGUID{ 57 };
168 | inline constexpr auto COLSZ_IO{ 9 };
169 | inline constexpr auto COLSZ_DEFAULT{ 9 };
170 |
171 | inline std::ostream& operator<<(std::ostream& os, const vccli::DeviceInfo& di)
172 | { // DEVICE INFO
173 | using namespace vccli;
174 |
175 | if (quiet) {
176 | os
177 | << di.dname << SEP
178 | << DataFlowToString(di.flow) << SEP
179 | << std::boolalpha << di.isDefault << std::noboolalpha;
180 | if (extended)
181 | os << SEP << di.dguid;
182 | }
183 | else {
184 | const auto& flow_s{ DataFlowToString(di.flow) };
185 | const auto& def_s{ str::stringify(std::boolalpha, di.isDefault) };
186 | os
187 | << colors(COLOR::DEVICE) << di.dname << colors() << indent(COLSZ_DNAME, di.dname.size())
188 | << colors(COLOR::VALUE) << flow_s << colors() << indent(COLSZ_IO, flow_s.size())
189 | << colors(COLOR::LOWLIGHT) << def_s << colors();
190 | if (extended) os
191 | << indent(COLSZ_DEFAULT, def_s.size()) << di.dguid;
192 | }
193 | return os;
194 | }
195 |
196 | inline constexpr auto COLSZ_PNAME{ 24 };
197 | inline constexpr auto COLSZ_PID{ 10 };
198 |
199 | inline std::ostream& operator<<(std::ostream& os, const vccli::ProcessInfo& pi)
200 | { // PROCESS INFO
201 | using namespace vccli;
202 |
203 | if (quiet) {
204 | os
205 | << pi.pid << SEP
206 | << pi.pname << SEP
207 | ;
208 | }
209 | else {
210 | const auto& flow_s{ DataFlowToString(pi.flow) };
211 | const auto& pid_s{ std::to_string(pi.pid) };
212 | os
213 | << '[' << colors(COLOR::SESSION) << pid_s << colors() << ']' << indent(COLSZ_PID, pid_s.size() + 2)
214 | << colors(COLOR::SESSION) << pi.pname << colors() << indent(COLSZ_PNAME, pi.pname.size())
215 | ;
216 | }
217 |
218 | os << static_cast(pi);
219 |
220 | if (extended) {
221 | if (quiet) os
222 | << SEP
223 | << pi.suid << SEP
224 | << pi.sguid
225 | ;
226 | else os
227 | << indent(2)
228 | << colors(COLOR::DEVICE) << pi.dguid << colors() << SEP
229 | << pi.suid << SEP
230 | << pi.sguid
231 | ;
232 | }
233 | return os;
234 | }
235 |
236 | template T>
237 | struct InfoLister {
238 | std::vector vec;
239 |
240 | InfoLister(std::vector&& vec) : vec{ std::forward>(vec) } {}
241 |
242 | friend std::ostream& operator<<(std::ostream& os, const InfoLister& p)
243 | {
244 | std::vector columns;
245 |
246 | if (quiet) {
247 | if constexpr (std::same_as) {
248 | os << "DNAME" << SEP << "I/O" << SEP << "IS_DEFAULT";
249 | if (extended) os << SEP << "DGUID";
250 | }
251 | else if constexpr (std::same_as) {
252 | os << "PID" << SEP << "PNAME" << SEP << "DNAME" << SEP << "I/O" << SEP << "IS_DEFAULT";
253 | if (extended) os << SEP << "DGUID" << SEP << "SUID" << SEP << "SGUID";
254 | }
255 | }
256 | else {
257 | if constexpr (std::same_as) {
258 | os
259 | << colors(COLOR::HEADER)
260 | << "Device Name (DNAME)" << indent(COLSZ_DNAME - 19)
261 | << "I/O" << indent(COLSZ_IO - 3)
262 | << "Default";
263 | ;
264 | if (extended) os << indent(COLSZ_DEFAULT - 7) << "Device ID (DGUID)";
265 | }
266 | else if constexpr (std::same_as) {
267 | os
268 | << colors(COLOR::HEADER)
269 | << "PID" << indent(COLSZ_PID - 3)
270 | << "Process Name (PNAME)" << indent(COLSZ_PNAME - 20)
271 | << "Device Name (DNAME)" << indent(COLSZ_DNAME - 19)
272 | << "I/O" << indent(COLSZ_IO - 3)
273 | << "Default";
274 | if (extended) os << indent(COLSZ_DEFAULT - 7)
275 | << "Device ID (DGUID)" << indent(COLSZ_DGUID - 17)
276 | << "Session ID" << SEP
277 | << "Instance ID";
278 | os << colors();
279 | }
280 | }
281 | os << "\n\n";
282 |
283 | for (const auto& obj : p.vec)
284 | os << obj << '\n';
285 |
286 | return os;
287 | }
288 | };
289 | }
290 |
291 | template T>
292 | vccli_operators::InfoLister make_printable_list(std::vector&& vec)
293 | {
294 | return vccli_operators::InfoLister{ std::forward>(vec) };
295 | }
296 |
297 |
298 |
299 | int main(const int argc, char** argv)
300 | {
301 | using namespace vccli;
302 | int rc{ 0 };
303 | try {
304 | opt3::ArgManager args{ argc, argv,
305 | opt3::make_template(opt3::CaptureStyle::Optional, 'v', "volume"),
306 | opt3::make_template(opt3::CaptureStyle::Optional, 'm', "mute", "muted", "is-muted"),
307 | opt3::make_template(opt3::CaptureStyle::Required, 'I', "increment"),
308 | opt3::make_template(opt3::CaptureStyle::Required, 'D', "decrement"),
309 | opt3::make_template(opt3::CaptureStyle::Required, 'd', "dev"),
310 | };
311 |
312 | // handle important general args
313 | quiet = args.check_any('q', "quiet");
314 | colors.setActive(!quiet && !args.check_any('n', "no-color"));
315 | extended = args.check_any('e', "extended");
316 |
317 | if (args.empty() || args.check_any('h', "help")) {
318 | std::cout << PrintHelp{};
319 | return 0;
320 | }
321 | else if (args.checkopt("version")) {
322 | if (!quiet) std::cout << "vccli v";
323 | std::cout << vccli_VERSION_EXTENDED << '\n';
324 | return 0;
325 | }
326 |
327 | // Get the target string
328 | const std::string target{ getTargetAndValidateParams(args) };
329 | EDataFlow flow{ getTargetDataFlow(args) };
330 |
331 | // Initialize Windows API
332 | if (const auto& hr{ CoInitializeEx(NULL, COINIT::COINIT_MULTITHREADED) }; hr != S_OK)
333 | throw make_exception("Failed to initialize COM interface with error code ", hr, ": '", GetErrorMessageFrom(hr), "'!");
334 |
335 | // Get controller:
336 | const auto& targetControllers{ AudioAPI::getObjects(target, args.check_any('f', "fuzzy"), flow) };
337 |
338 | if (targetControllers.empty())
339 | throw make_exception(
340 | "Couldn't locate anything matching the given search term!\n",
341 | indent(10), colors(COLOR::HEADER), "Search Term", colors(), ": ", colors(COLOR::ERR), target, colors(), '\n',
342 | indent(10), colors(COLOR::HEADER), "Device Filter", colors(), ": ", colors(COLOR::ERR), DataFlowToString(flow), colors()
343 | );
344 |
345 | const bool
346 | listSessions{ args.check_any('l', "list") },
347 | listDevices{ args.check_any('L', "list-dev") };
348 |
349 | // -Q | --query
350 | if (args.check_any('Q', "query")) {
351 | bool fst{ true };
352 | for (const auto& it : targetControllers) {
353 | if (fst) fst = false;
354 | else std::cout << '\n';
355 | std::cout << VolumeObjectPrinter(it.get());
356 | }
357 | }
358 | // list
359 | else if (listSessions || listDevices) {
360 | // -l | --list
361 | if (listSessions) {
362 | std::cout << make_printable_list(AudioAPI::GetAllAudioProcessesSorted(flow));
363 | if (listDevices) std::cout << '\n';
364 | }
365 | // -L | --list-dev
366 | if (listDevices)
367 | std::cout << make_printable_list(AudioAPI::GetAllAudioDevicesSorted(flow));
368 | }
369 | // Non-blocking options:
370 | else {
371 | for (const auto& it : targetControllers) {
372 | // Handle Volume Args:
373 | handleVolumeArgs(args, it.get());
374 |
375 | // Handle Mute Args:
376 | handleMuteArgs(args, it.get());
377 | }
378 | }
379 |
380 | } catch (const showhelp& ex) {
381 | std::cerr << PrintHelp{} << '\n' << colors.get_fatal() << ex.what() << '\n';
382 | rc = 1;
383 | } catch (const std::exception& ex) {
384 | std::cerr << colors.get_fatal() << ex.what() << '\n';
385 | rc = 1;
386 | } catch (...) {
387 | std::cerr << colors.get_fatal() << "An undefined exception occurred!" << '\n';
388 | rc = 1;
389 | }
390 | // Uninitialize Windows API
391 | CoUninitialize();
392 | return rc;
393 | }
394 |
395 | // Definitions:
396 | inline std::string getTargetAndValidateParams(const opt3::ArgManager& args)
397 | {
398 | auto params{ args.getv_all() };
399 | if (params.empty()) return{};
400 | // Copy & pop the first parameter from the vector
401 | std::string target{ params.front() };
402 | params.erase(params.begin());
403 | // If there are any additional parameters, throw
404 | if (!params.empty()) throw make_custom_exception("Unexpected Arguments: ", str::join(params, ", "));
405 | return target;
406 | }
407 |
408 | inline EDataFlow getTargetDataFlow(const opt3::ArgManager& args)
409 | {
410 | if (const auto& dev{ args.getv_any('d', "dev", "device") }; dev.has_value()) {
411 | std::string v{ str::tolower(dev.value()) };
412 | if (str::equalsAny(v, "i", "in", "input", "rec", "record", "recording"))
413 | return EDataFlow::eCapture;
414 | else if (str::equalsAny(v, "o", "out", "output", "play", "playback"))
415 | return EDataFlow::eRender;
416 | else throw make_exception("Invalid Device Flow State: ", v, " ; (expected i/in/input/rec/record/recording || o/out/output/play/playback)!");
417 | }
418 | else return EDataFlow::eAll;
419 | }
420 | inline void handleVolumeArgs(const opt3::ArgManager& args, const vccli::Volume* controller)
421 | {
422 | const auto& increment{ args.getv_any('I', "increment") }, & decrement{ args.getv_any('D', "decrement") };
423 | if (increment.has_value() && decrement.has_value())
424 | throw make_exception("Conflicting Options Specified: ", colors(COLOR::ERR), "-I", colors(), '|', colors(COLOR::ERR), "--increment", colors(), " && ", colors(COLOR::ERR), "-D", colors(), '|', colors(COLOR::ERR), "--decrement", colors());
425 | else if (increment.has_value()) {
426 | const auto& value{ increment.value() };
427 | if (!std::all_of(value.begin(), value.end(), str::stdpred::isdigit))
428 | throw make_exception("Invalid Number Specified: ", value);
429 | if (controller->getVolumeScaled() == 100.0f) {
430 | if (!quiet) std::cout << "Volume is" << indent(MARGIN_WIDTH, 10ull) << colors(COLOR::WARN) << "100" << colors() << '\n';
431 | }
432 | else {
433 | controller->incrementVolume(str::stof(value) / 100.0f);
434 | if (!quiet) std::cout << "Volume =" << indent(MARGIN_WIDTH, 9ull) << colors(COLOR::VALUE) << static_cast(controller->getVolumeScaled()) << colors() << " (+" << colors(COLOR::VALUE) << value << colors() << ')' << '\n';
435 | }
436 | }
437 | else if (decrement.has_value()) {
438 | const auto& value{ decrement.value() };
439 | if (!std::all_of(value.begin(), value.end(), str::stdpred::isdigit))
440 | throw make_exception("Invalid Number Specified: ", value);
441 | if (controller->getVolumeScaled() == 0.0f) {
442 | if (!quiet) std::cout << "Volume is" << indent(MARGIN_WIDTH, 10ull) << colors(COLOR::WARN) << "0" << colors() << '\n';
443 | }
444 | else {
445 | controller->decrementVolume(str::stof(value) / 100.0f);
446 | if (!quiet) std::cout << "Volume =" << indent(MARGIN_WIDTH, 9ull) << colors(COLOR::VALUE) << static_cast(controller->getVolumeScaled()) << colors() << " (-" << colors(COLOR::VALUE) << value << colors() << ')' << '\n';
447 | }
448 | }
449 |
450 | if (const auto& arg{ args.get_any('v', "volume") }; arg.has_value()) {
451 | if (const auto& captured{ arg.value().getValue() }; captured.has_value()) {
452 | // Set
453 | const auto& value{ captured.value() };
454 | if (!std::all_of(value.begin(), value.end(), str::stdpred::isdigit))
455 | throw make_exception("Invalid Number Specified: ", value);
456 | float tgtVolume{ str::stof(captured.value()) };
457 | if (tgtVolume > 100.0f)
458 | tgtVolume = 100.0f;
459 | else if (tgtVolume < 0.0f)
460 | tgtVolume = 0.0f;
461 | if (controller->getVolumeScaled() == tgtVolume) {
462 | if (!quiet) std::cout << "Volume is" << indent(MARGIN_WIDTH, 9ull) << colors(COLOR::WARN) << static_cast(tgtVolume) << colors() << '\n';
463 | }
464 | else {
465 | controller->setVolumeScaled(tgtVolume);
466 | if (!quiet) std::cout << "Volume =" << indent(MARGIN_WIDTH, 8ull) << colors(COLOR::VALUE) << static_cast(tgtVolume) << colors() << '\n';
467 | }
468 | }
469 | else {
470 | // Get
471 | if (!quiet) std::cout << "Volume:" << indent(MARGIN_WIDTH, 7ull) << colors(COLOR::VALUE);
472 | std::cout << str::stringify(std::fixed, std::setprecision(0), controller->getVolume() * 100.0f);
473 | if (!quiet) std::cout << colors() << '\n';
474 | }
475 | }
476 | }
477 | inline void handleMuteArgs(const opt3::ArgManager& args, const vccli::Volume* controller)
478 | {
479 | const bool
480 | mute{ args.check_any('M', "mute") },
481 | unmute{ args.check_any('U', "unmute") };
482 |
483 | if (mute && unmute)
484 | throw make_exception("Conflicting Options Specified: ", colors(COLOR::ERR), "-m", colors(), '|', colors(COLOR::ERR), "--mute", colors(), " && ", colors(COLOR::ERR), "-u", colors(), '|', colors(COLOR::ERR), "--unmute", colors());
485 | else if (mute) {
486 | if (controller->getMuted() == true) {
487 | if (!quiet) std::cout << "Muted is" << indent(MARGIN_WIDTH, 8ull) << colors(COLOR::WARN) << "true" << colors() << '\n';
488 | }
489 | else {
490 | controller->mute();
491 | if (!quiet) std::cout << "Muted =" << indent(MARGIN_WIDTH, 7ull) << colors(COLOR::VALUE) << "true" << colors() << '\n';
492 | }
493 | }
494 | else if (unmute) {
495 | if (controller->getMuted() == false) {
496 | if (!quiet) std::cout << "Muted is" << indent(MARGIN_WIDTH, 8ull) << colors(COLOR::WARN) << "false" << colors() << '\n';
497 | }
498 | else {
499 | controller->unmute();
500 | if (!quiet) std::cout << "Muted =" << indent(MARGIN_WIDTH, 7ull) << colors(COLOR::VALUE) << "false" << colors() << '\n';
501 | }
502 | }
503 |
504 | if (const auto& arg{ args.get_any('m', "is-muted") }; arg.has_value()) {
505 | if (const auto& captured{ arg.value().getValue() }; captured.has_value()) {
506 | if (mute || unmute) throw make_exception("Conflicting Options Specified: ", colors(COLOR::ERR), "-M", colors(), '|', colors(COLOR::ERR), "--is-muted", colors(COLOR::ERR), " && (", colors(COLOR::ERR), "-m", colors(), '|', colors(COLOR::ERR), "--mute", colors(), " || ", colors(COLOR::ERR), "-u", colors(), '|', colors(COLOR::ERR), "--unmute", colors(), ')');
507 | // Set
508 | const auto& value{ str::trim(captured.value()) };
509 | if (str::equalsAny(value, "true", "1", "on")) {
510 | if (controller->getMuted() == true) {
511 | if (!quiet) std::cout << "Muted is" << indent(MARGIN_WIDTH, 8ull) << colors(COLOR::WARN) << "true" << colors() << '\n';
512 | }
513 | else {
514 | controller->mute();
515 | if (!quiet) std::cout << "Muted =" << indent(MARGIN_WIDTH, 7ull) << colors(COLOR::VALUE) << "true" << colors() << '\n';
516 | }
517 | }
518 | else if (str::equalsAny(value, "false", "0", "off")) {
519 | if (controller->getMuted() == false) {
520 | if (!quiet) std::cout << "Muted is" << indent(MARGIN_WIDTH, 8ull) << colors(COLOR::WARN) << "false" << colors() << '\n';
521 | }
522 | else {
523 | controller->unmute();
524 | if (!quiet) std::cout << "Muted =" << indent(MARGIN_WIDTH, 7ull) << colors(COLOR::VALUE) << "false" << colors() << '\n';
525 | }
526 | }
527 | else throw make_exception("Invalid Argument Specified: '", colors(COLOR::ERR), captured.value(), colors(), "'; Expected a boolean value ('", colors(COLOR::ERR), "true", colors(), "'/'", colors(COLOR::ERR), "false", colors(), "')!");
528 | }
529 | else {
530 | // Get
531 | if (!quiet) std::cout << "Is Muted:" << indent(MARGIN_WIDTH, 9ull) << colors(COLOR::VALUE);
532 | std::cout << str::stringify(std::boolalpha, controller->getMuted());
533 | if (!quiet) std::cout << colors() << '\n';
534 | }
535 | }
536 | }
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------