Skip to content

Commit

Permalink
Readme update and github actions fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
pixsperdavid committed Jul 25, 2024
1 parent 858fcdb commit 260c45e
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 17 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Build

on:
push:
branches: [ main, develop ]
branches: [ main ]
pull_request:
branches: [ main ]

Expand All @@ -18,7 +18,7 @@ jobs:
os: [windows-latest, macOS-latest]

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
with:
submodules: recursive
fetch-depth: 0
Expand All @@ -30,7 +30,7 @@ jobs:
run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}

- name: Upload built package binaries
uses: actions/upload-artifact@v2
uses: actions/upload-artifact@v4
with:
name: ${{ matrix.os }} binaries
path: externals/**/*.*
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ build
externals
.idea
.DS_Store
/cmake-build-debug
/cmake-build-release
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
<img alt="jit.ndi" src="https://raw.githubusercontent.com/pixsper/jit.ndi/develop/icon.png" width="200" height="200">

Extensions for sending/receiving video and audio using the [Newtek NDI®](https://ndi.tv/) protocol in [Cycling 74's Max](https://cycling74.com/products/max/)
Extensions for sending/receiving video and audio using the [NDI®](https://ndi.video/) protocol in [Cycling 74's Max](https://cycling74.com/products/max/)

## Overview

The [NewTek NDI®](https://ndi.tv/) protocol allows high-quality, high-performance, low-latency streaming of video and audio over a local network. jit.ndi provides a pair of objects to interface this protocol with the Max/Jitter environment, allowing sending/receiving of jitter matrices and MSP signals to/from any other device supporting NDI.
The [NDI®](https://ndi.video/) protocol allows high-quality, high-performance, low-latency streaming of video and audio over a local network. jit.ndi provides a pair of objects to interface this protocol with the Max/Jitter environment, allowing sending/receiving of jitter matrices and MSP signals to/from any other device supporting NDI.

## Features
- NDI 5.0 compatible (runtime is dynamically loaded so will work with any installed compatible NDI version)
- NDI 6.0 compatible (runtime is dynamically loaded so will work with any installed compatible NDI version)
- Send/receive 2D jitter matrices of any size. 3-plane RGB and 4-plane RGBA both supported.
- YUV mode for high-performance usage.
- Send/receive unlimited number of audio channels.
- Objects can set/report preview/program tally status on a video source.

## Requirements
- Max 8 (64-bit) - Windows or Mac (Intel/Apple Silicon)
- Newtek NDI® Runtime - [Windows](http://new.tk/NDIRedistV5) or [Mac](http://new.tk/NDIRedistV5Apple)
- [NewTek NDI® Tools](https://ndi.tv/tools/) - Required if using NDI-HX equipment (such as the [NewTek NDI®|HX Camera app](https://www.newtek.com/software/ndi-camera/)) (and also useful for testing)
- NDI® Runtime - [Windows](http://ndi.link/NDIRedistV6) or [Mac](http://ndi.link/NDIRedistV6Apple)
- [NDI® Tools](https://ndi.video/tools/) - Required if using NDI-HX equipment (such as the [NDI HX Camera app](https://ndi.video/tools/ndi-hx-camera/)) (and also useful for testing)

## License
jit.ndi is licensed under LGPL 3.0. This means you are free to use the objects in any commercial/non-commercial project but any changes to the source code must be released under the same license.
Expand All @@ -29,10 +29,10 @@ jit.ndi is licensed under LGPL 3.0. This means you are free to use the objects i
Help patchers and Max documentation metadata included in the package.

## Copyright
jit.ndi Copyright (C) 2022 Pixsper Ltd.
jit.ndi Copyright (C) 2024 Pixsper Ltd.
www.pixsper.com

NDI® is a registered trademark of NewTek, Inc
https://ndi.tv/
NDI® is a trademark of Vizrt NDI AB. ©2023
https://ndi.video/

Includes [yxml](https://dev.yorhel.nl/yxml) (C) 2013-2014 Yoran Heling
2 changes: 1 addition & 1 deletion source/jit.ndi/jit.ndi.receive~/jit.ndi.receive.c
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// This file is part of jit.ndi https://github.com/pixsper/jit.ndi
// Copyright (c) 2022 Pixsper Ltd.
// Copyright (c) 2024 Pixsper Ltd.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
Expand Down
2 changes: 1 addition & 1 deletion source/jit.ndi/jit.ndi.receive~/max.jit.ndi.receive~.c
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// This file is part of jit.ndi https://github.com/pixsper/jit.ndi
// Copyright (c) 2022 Pixsper Ltd.
// Copyright (c) 2024 Pixsper Ltd.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
Expand Down
2 changes: 1 addition & 1 deletion source/jit.ndi/jit.ndi.send~/jit.ndi.send.c
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// This file is part of jit.ndi https://github.com/pixsper/jit.ndi
// Copyright (c) 2022 Pixsper Ltd.
// Copyright (c) 2024 Pixsper Ltd.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
Expand Down
2 changes: 1 addition & 1 deletion source/jit.ndi/jit.ndi.send~/max.jit.ndi.send~.c
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// This file is part of jit.ndi https://github.com/pixsper/jit.ndi
// Copyright (c) 2022 Pixsper Ltd.
// Copyright (c) 2024 Pixsper Ltd.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
Expand Down
2 changes: 1 addition & 1 deletion source/jit.ndi/ndi_runtime.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//
// This file is part of jit.ndi https://github.com/pixsper/jit.ndi
// Copyright (c) 2022 Pixsper Ltd.
// Copyright (c) 2024 Pixsper Ltd.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
Expand Down
2 changes: 1 addition & 1 deletion source/jit.ndi/version.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
#define JIT_NDI_VERSION_MINOR 3
#define JIT_NDI_VERSION_BUGFIX 1

#define JIT_NDI_COPYRIGHT "Copyright (C) 2022 Pixsper Ltd."
#define JIT_NDI_COPYRIGHT "Copyright (C) 2024 Pixsper Ltd."

#endif

0 comments on commit 260c45e

Please sign in to comment.