osc js

osc-js

osc-js es una biblioteca Open Sound Control para aplicaciones JavaScript (módulo UMD para Node, Browser, etc.) con coincidencia de patrones de direcciones y manejo de etiquetas de tiempo. Envía mensajes a través de UDP , WebSocket o ambos (modo puente) y ofrece una API de complemento personalizable para protocolos de red.

Wiki | Uso básico | Documentación | API de complemento

Características

• Módulo UMD ejecutándose en Node.js, Electron, Chrome Apps, navegador o cualquier otro entorno JS
• Se puede utilizar con Webpack y Browserify.
• Definiciones de TypeScript
• Sin dependencias (excepto de ws en Node.js o entornos similares)
• Recibir información del remitente de los mensajes entrantes
• UDP integrado, soporte de red WebSocket como complementos
• Complemento de puente especial para facilitar la comunicación entre clientes UDP y WebSocket
• API de complemento para protocolos de red personalizados
• Con todas las especificaciones OSC 1.0
• Coincidencia de patrones de dirección OSC
• Paquetes OSC de tiempo crítico con etiquetas de tiempo
• Tipos de argumentos extendidos (no estándar)

Documentación

Lea más sobre osc-js y cómo usarlo en Wiki y Documentación.

Ejemplo

 const osc = new OSC ( )

osc . on ( '/param/density' , ( message , rinfo ) => {
  console . log ( message . args )
  console . log ( rinfo )
} )

osc . on ( '*' , message => {
  console . log ( message . args )
} )

osc . on ( '/{foo,bar}/*/param' , message => {
  console . log ( message . args )
} )

osc . on ( 'open' , ( ) => {
  const message = new OSC . Message ( '/test' , 12.221 , 'hello' )
  osc . send ( message )
} )

osc . open ( { port : 9000 } ) 

Instalación y uso

Instalación recomendada a través de npm: npm i osc-js o yarn add osc-js .

Importe la biblioteca const OSC = require('osc-js') o agregue el script lib/osc.js o lib/osc.min.js (versión minimizada) para usarlo en un navegador.

Complementos

osc-js ofrece una arquitectura de complemento para ampliar sus capacidades de red. La biblioteca viene con cuatro complementos integrados. Probablemente esto sea todo lo que necesita para una aplicación OSC:

• WebsocketClientPlugin (predeterminado)
• WebsocketServerPlugin
• DatagramPlugin para mensajería de red UDP
• BridgePlugin puente útil entre clientes WebSocket y UDP

La configuración y los ejemplos de cada complemento se pueden leer aquí: Wiki.

Ejemplo: servidor WebSocket

Registre el complemento al crear la instancia de OSC:

 const osc = new OSC ( { plugin : new OSC . WebsocketServerPlugin ( ) } )
osc . open ( ) // listening on 'ws://localhost:8080'

Ejemplo: OSC entre MaxMSP/PD/SC, etc. y su navegador

1. Escribe una página web sencilla. La biblioteca utilizará un cliente WebSocket de forma predeterminada.

 < button id =" send " > Send Message </ button >
< script type =" text/javascript " src =" lib/osc.min.js " > </ script >
< script type =" text/javascript " >
  var osc = new OSC ( ) ;
  osc . open ( ) ; // connect by default to ws://localhost:8080

  document . getElementById ( 'send' ) . addEventListener ( 'click' , ( ) => {
    var message = new OSC . Message ( '/test/random' , Math . random ( ) ) ;
    osc . send ( message ) ;
  } ) ;
</ script >

2. Escriba una aplicación Node (el "puente" entre sus clientes UDP y WebSocket).

 const OSC = require ( 'osc-js' )

const config = { udpClient : { port : 9129 } }
const osc = new OSC ( { plugin : new OSC . BridgePlugin ( config ) } )

osc . open ( ) // start a WebSocket server on port 8080

3. Cree su parche Max/MSP (o PD, SuperCollider, etc.).

 [udpreceive 9129] // incoming '/test/random' messages with random number

Soluciones personalizadas con API de complemento

Es posible escribir soluciones más sofisticadas para aplicaciones OSC sin perder la interfaz osc-js (incluido su manejo de mensajes, etc.). Lea la documentación de la API del complemento para obtener más información.

 class MyCustomPlugin {
  // ... read docs for implementation details
}

const osc = new OSC ( { plugin : MyCustomPlugin ( ) } )
osc . open ( )

osc . on ( '/test' , message => {
  // use event listener with your plugin
} )

Uso sin complementos

La biblioteca se puede utilizar sin las funciones mencionadas en caso de que necesite escribir y leer datos OSC binarios. Vea este ejemplo a continuación para usar la API de bajo nivel (aunque la biblioteca ya tiene una solución para manejar UDP como en este ejemplo):

 const dgram = require ( 'dgram' )
const OSC = require ( 'osc-js' )

const socket = dgram . createSocket ( 'udp4' )

// send a messsage via udp
const message = new OSC . Message ( '/some/path' , 21 )
const binary = message . pack ( )
socket . send ( new Buffer ( binary ) , 0 , binary . byteLength , 41234 , 'localhost' )

// receive a message via UDP
socket . on ( 'message' , data => {
  const msg = new OSC . Message ( )
  msg . unpack ( data )
  console . log ( msg . args )
} ) 

Desarrollo

osc-js usa Babel para soporte de ES6, ESDoc para documentación, Mocha + Chai para pruebas y Rollup para generar el módulo UMD.

Clona el repositorio e instala todas las dependencias:

 git clone [email protected]:adzialocha/osc-js.git
cd osc-js
npm install

Pruebas

npm run test para ejecutar las pruebas. npm run test:watch a las especificaciones de ejecución durante el desarrollo. Verifique el estilo del código con npm run lint .

Despliegue

npm run build para exportar el módulo UMD en la carpeta lib .

Colaboradores

• @adzialocha
• @davidgranstrom
• @elgiano
• @eliot-akira
• @JacobMuchow
• @PeterKey
• @yaxu
• @yojeek

ESDocs

npm run docs para generar una carpeta docs con archivos HTML que documentan la biblioteca. Léelos en línea aquí: https://adzialocha.github.io/osc-js

Licencia

Licencia MIT MIT