Пишем примитивное управление громкостью PC по локалке на NodeJS04.11.2024 16:31

Я, наверняка как и ты, дорогой {{ $username }}, люблю иногда посмотреть сериальчик с компа, лёжа на диване (не покупать же ради этого телек, в самом деле), благо размеры мониторов нынче позволяют. А ещё частенько приходится сталкиваться с фильмами, в которых гений-звукорежиссёр делает диалоги очень тихими, а эффекты наоборот громкими (даже в оригинальной озвучке встречается, но с переводами много чаще), из-за чего периодически приходится вскакивать и дёргать громкость на плеере или усилителе. Короче, после очередного саунд-агрессивного блокбастера, я решил что неплохо было б что-то с этим сделать. Необходимости дёргать BIOS удалённо у меня, слава богу, не стоит, так уж наверное мою проблему можно решить как-то и просто и интересно…

Поиск решения

Ok, какие варианты? Можно пойти по простому пути и поставить любой remote-control у которого есть клиент для мобилы и забить (AnyDesk, Remote Desktop, KiwiMote, тысячи их). Но это как-то не спортивно, не хочется ставить что-то лишнее на телефон, ну, а ещё у меня на компе и так практически круглыми сутками крутится NodeJS, так что как-то сам собой назрел вопрос «можно ли из ноды дёргать WinAPI». Оказалось что можно, но не так просто, как хотелось бы.

Если начать гуглить по вопросу, можно выяснить, что самый распространённый способ запустить сишный код на ноде заключается в использовании реализации foreigin function interface для Node — node-ffi, которая не обновлялась уже лет пять. Иногда ещё описываются варианты на чуть более новом аналогичном пакете ffi-napi (последнее обновление три года назад) или с помощью ещё какого-нибудь совсем редкого пакета работающего по аналогичному пути. Ещё есть вариант попробовать поставить пакет, заточенный сразу на управление звуком, чтобы не писать свой велосипед, например небезызвестный node-audio.

Проблема у всех вышеописанных способов в том, что они работают с помощью механизма Node Addons, т.е. для их работы в любом случае будет необходим node-gyp. Можно было б его и поставить, если бы у него не было проблем с седьмой виндой (даа-да, мне норм, проходите мимо), вот только для его установки, оказывается, ещё нужно ставить и «Visual C++ Build Environment» причём тоже не каждая версия подойдёт, а суммарно всё это обойдётся ещё более чем в 2 Гб места на диске (это при условии что вам всё-таки удастся продраться через остальные костыли установки node-gyp). Я, конечно, понимаю, что для крутых продвинутых современных IT-профессионалов какие-то жалкие 2 гига не проблема. А у кого-то просто винда новая (сочувствую), либо оно и так на компе стоит постоянно. Если вы как раз из таких, можете собственно сразу переходить к следующей главе.

Для меня же установка такого количества мусора в систему ради того чтоб подёргать регулятор громкости выглядит, мягко говоря, неадекватно.

Если у вас есть свой вариант решения, отличный от моего и без установки «VC++ Build Environment», пожалуйста расскажите в комментариях.

Немного ретроградского нытья

На самом деле, вариант который я опишу, будет полезен не только ретроградам, но также вероятно придётся по душе и любителям минималистичного быстрого ПО, так как это неплохой вариант запустить код без лишних костылей.

Короче, не буду дальше занимать ваше время, решение оказалось как в той шутке — »всегда найдётся азиат, который сделает лучше», тут тоже нашёлся китаец, написавший свою реализацию node-ffi на Rust. При этом работает оно без всякого node-gyp. Насколько я понимаю он делает билд под каждую систему самостоятельно перед публикацией в npm, но суть в том, что нам этого делать не придётся, а значит и node-gyp не нужен.

Называется пакет ffi-rs, и ставится он, что очевидно, командой

npm i ffi-rs

Ну и, собственно, всё дальше останется только написать библиотеку-прослойку для работы с WinAPI на сях.

Cишный код и ковыряния с WinAPI

Следующий вопрос — чем собственно компилить си, чтобы это было просто и универсально? Я знаю, что уже давно стандарт это Visual Studio, но так как я обычно пишу на сях для МК, студии у меня на компе нет. Путём перебора вариантов, я пришёл к тому, что оптимальный для меня в этом случае вариант это GCC, который мало весит, не ставит в систему лишнего хлама и отлично работает на семёрке. Загрузить можно, например вот тут. У меня уже давно стоит 11-я x64 версия, ею и воспользуюсь.

Не забудьте проверить что путь к бинарнику GCC есть в Path, чтоб удобно было запускать компилятор из любого места.

Я заранее извиняюсь перед всеми знатоками WinAPI и С++, мне последний раз приходилось что-то подобное писать лет десять назад, вполне возможно всё это можно (и нужно!) сделать проще и красивее, но для примера вполне сойдёт.

Код test.cpp с примером управления громкостью через WinAPI

#include 
#include 
#include 
#include 
#include 
#include 
#include 
#include 
#include 
#include  // Need to use PKEY_Device_FriendlyName
static const char VOLUME_RANGE_ERR[] = "Volume must be a fractional number ranging from 0 to 1";
static const char NO_ENDPOINTS_ERR[] = "No endpoints found.";
static const char OK_MSG[] = "Ok";

extern "C" int setVolume(double newVolume) {
  if (newVolume < 0 || newVolume > 1) {
    std::cout<EnumAudioEndpoints(eRender, DEVICE_STATE_ACTIVE,&pCollection);
  // ** use "eCapture" for microphones and "eRender" for speakers.
  hr = pCollection->GetCount(&count);
  if (count == 0) {
    std::cout << NO_ENDPOINTS_ERR << std::endl;
    return 2;
  }
  for (UINT i = 0; i < count; i++) {
    hr = pCollection->Item(i, &pEndpoint);
    hr = pEndpoint->GetId(&pwszID);
    IAudioEndpointVolume *endpointVolume = NULL;
    pEnumerator->GetDevice(pwszID, &pEndpoint);
    pEndpoint->Activate(__uuidof(IAudioEndpointVolume),CLSCTX_INPROC_SERVER, NULL, (LPVOID *)&endpointVolume);
    endpointVolume->SetMasterVolumeLevelScalar((float)newVolume, NULL);
    endpointVolume->Release();
  }
  return 0;
}

extern "C" void showDevices() {
  UINT numDevices = waveInGetNumDevs();
  std::cout << "Number of input devices: " << numDevices << std::endl;
  for (UINT i = 0; i < numDevices; i++) {
    WAVEINCAPS deviceInfo;
    if (waveInGetDevCaps(i, &deviceInfo, sizeof(deviceInfo)) == MMSYSERR_NOERROR) {
      std::cout << "Input device " << i << ": " << deviceInfo.szPname << std::endl;
      std::cout << "Channels: " << deviceInfo.wChannels << std::endl;
      std::cout << std::endl;
    }
  }
  numDevices = waveOutGetNumDevs();
  std::cout << "Number of output devices: " << numDevices << std::endl;
  for (UINT i = 0; i < numDevices; i++) {
    WAVEOUTCAPS deviceInfo;
    if (waveOutGetDevCaps(i, &deviceInfo, sizeof(deviceInfo)) == MMSYSERR_NOERROR) {
      std::cout << "Output device " << i << ": " << deviceInfo.szPname << std::endl;
      std::cout << "Channels: " << deviceInfo.wChannels << std::endl;
      std::cout << std::endl;
    }
  }
}

У старой версии ffi-rs, которую я использовал, почему-то возникала какая-то ошибка при попытке вернуть строку в качестве результата выполнения операции, в результате чего нода просто вылетала без каких-либо сообщений (скорее всего проблема была в несовпадении типов строк). Мне было лень разбираться в чём именно причина, тем более никаких внятных отчётов об ошибке при падении тогда не было, поэтому я просто использовал целочисленные коды в качестве результата. Возможно я просто что-то не так делал, а возможно это действительно какая-то ошибка, которая будет исправлена в будущих версиях. Как минимум, автор обещал добавить развернутые сообщения о падении, вероятно когда они будут, я исправлю код в своей версии.

Возможно я не прав, но, по идее, вся эта работа с устройствам такая костыльная только в семёрке, в новых форточках хотя и остались все эти легаси методы, уже давно должны быть варианты краше (аможет и в семёрке есть, просто я о них не знаю). А может и нет — как всегда буду рад дополнениям в камментах.

Собираем это в нужную нам DLL следующей командой (запускаем из каталога с исходником, что очевидно):

g++ -shared -o test.dll test.cpp -lole32 -lwinmm

lwinmm здесь нужна потому что мы в showDevices мы используем waveInGetNumDevs

Если вы всё сделали правильно, у вас теперь есть dll с необходимой функцией. Осталось всего лишь быстро набросать на JS сервер, который будет обрабатывать запросы на нужный порт и дёргать эту функцию.

Пример тривиального сервера на Express

const express = require('express');
const server = express();
const { load, RetType, ParamsType } = require('ffi-rs');
const EventLogger = require('node-windows').EventLogger;

const SERVER_PORT = 12345;
const logger = new EventLogger('New windows-event logger');

const messageCodes = {
  0: "Ok",
  1: "Volume must be a fractional number ranging from 0 to 1",
  2: "No endpoints found.",
  3: "Volume is not specified",
  5: "NodeJS AudioManager server start at port " + SERVER_PORT,
  42: "Something went wrong when tried using extern DLL (unknown error)",
};

// Add headers before the routes are defined
server.use(function (req, res, next) {
  res.setHeader('Access-Control-Allow-Origin', '*');
  // Возможно тут стоит добавить адрес компьютера на котором вы хотите запускать сервер для пущей безопасности
  res.setHeader('Access-Control-Allow-Methods', 'GET, POST');
  // Мы используем этот же сервер для хостинга веб-интерфейса
  res.setHeader('Access-Control-Allow-Headers', 'X-Requested-With, content-type');
  next();
});

server.use(express.json({ limit: '1mb' }));
server.use(express.static(__dirname + '/../public'));
// Возвращаем index.html из папки public при запросе http://127.0.0.1:SERVER_PORT/

server.post('/api/setvolume', function(request, response) {
  const input = request.body;
  let externalResult = 0;
  if (!input.hasOwnProperty('volume')) {
    response.status(422);
    response.send(messageCodes[3]);
    return;
  }
  const newVolume = parseFloat(input['volume']);
  if (isNaN(newVolume) || newVolume < 0 || newVolume > 1) {
    response.status(422);
    response.send(messageCodes[1]);
    return;
  }

  try {
    externalResult = load({
      library: __dirname + '/../test.dll', // path to the dynamic library file
      funcName: 'setVolume', // the name of the function to call
      retType: RetType.I32, // the return value type
      paramsType: [ParamsType.Double], // the parameter types
      paramsValue: [newVolume] // the actual parameter values
    });
  } catch(err) {
    logger.error('Something went wrong when tried using extern DLL: ' + err.name + ' ' + err.message, 42);
    console.error(err);
    response.send(err.message);
    return;
  }

  if (externalResult != 0) {
    console.error(messageCodes[externalResult]);
  }

  response.send(messageCodes[externalResult]);
});

server.listen(SERVER_PORT, () => {
  logger.info(messageCodes[5], 5); // Second param is event code, use your own
  console.log(messageCodes[5]);
  console.log('Open http://127.0.0.1:'+ SERVER_PORT +' in your browser');
});

Не забудьте поставить этот самый экспресс перед запуском, а также все необходимые библиотеки:

npm i express node-windows

Пакет node-windows опционален, я использую его чтобы установить эту программу в качестве службы и не запускать её руками каждый раз, а также для ведения логов в журнал винды. Для теста можете его не ставить, но не забудьте удалить также из кода сервера.

Код скрипта setup.js для установки в качестве службы

const path = require('path');
const Service = require('node-windows').Service;

// Создаем новый объект службы
const svc = new Service({
  name:'NodeJS AudioManager',
  description: 'NodeJS AudioManager as Windows Service',
  script: path.resolve(__dirname)+'\\server.js', // путь к приложению
  maxRetries: 10, // не перезапускать службу после 10 падений (защита от цикла)
});

// Слушаем событие 'install' и запускаем службу
svc.on('install',function(){
  svc.start();
});

// Устанавливаем службу
svc.install();

// Слушаем событие 'uninstall', пишем сообщение
svc.on('uninstall', function(){
  console.log('Uninstall complete.');
  console.log('The service exists: ', svc.exists);
});

// Удаляем службу
svc.uninstall();

Единственное, что осталось, это написать элементарную веб-морду, чтобы слать на сервер команды управления

Пример простейшего index.html для веб-морды

  
  
  
  
  
  
  
  
  

  


  

    
Control PC volume
    

      
    
  
  

При желании веб-морду можно нарисовать и посимпатичнее, добавить нажатие клавиши пробел чтобы остановить воспроизведение (иногда уже засыпаешь и лень вставать выключать сериал, а следующая серия включается автоматически), думаю вы без труда с этим справитесь, а моя цель была показать простой вариант выполнения запросов к WinAPI из NodeJS, надеюсь кому-то это пригодится.

Ну и, собственно, всё, останется закинуть нужные для вебморды файлы в папку public, скрипт сервера и установки в папку scripts, ну добавить в package.json нашего проекта раздел со скриптами:

Весь package.json, который у меня получился

{
  "name": "AudioManager",
  "version": "1.0.0",
  "description": "Control your computer's sound from any device on the network, without any additional applications.",
  "main": "server.js",
  "scripts": {
    "dev": "node scripts/server.js",
    "setup": "node scripts/setup.js",
    "uninstall": "node scripts/uninstall.js"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/Psychosynthesis/AudioManager.git"
  },
  "homepage": "https://github.com/Psychosynthesis/SimpleServer#readme",
  "author": "Nick G.",
  "license": "MIT",
  "dependencies": {
    "express": "^4.18.2",
    "ffi-rs": "^1.0.18",
    "node-windows": "^1.0.0-beta.8"
  }
}

Ну вот, собственно, и всё, можно запускать npm run setup из папке проекта и открывать в сети адрес компа, на котором запускаете, с учётом порта.

Обратите внимание! Я категорически не рекомендую использовать такой подход для реального управления вашим компьютером по сети. Как минимум сюда нужно добавить авторизацию, чтобы это было хотя бы похоже на нормальное решение. Компьютер на котором я это использую находится в сети без доступа к интернету.

Словом, всё написанное выше — исключительно чтобы показать, как удобно дёргать сишным кодом из NodeJS. Всем удачи!

© Habrahabr.ru