Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename membraneframework/live_compositor -> software-mansion/live-compositor #651

Merged
merged 2 commits into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@

### 💥 Breaking changes

- Remove `forward_error_correction` option from RTP OPUS output. ([#615](https://github.com/membraneframework/live_compositor/pull/615) by [@wkozyra95](https://github.com/wkozyra95))
- Remove `forward_error_correction` option from RTP OPUS output. ([#615](https://github.com/software-mansion/live-compositor/pull/615) by [@wkozyra95](https://github.com/wkozyra95))

### ✨ New features

- Support DeckLink cards as an input. ([#587](https://github.com/membraneframework/live_compositor/pull/587), [#597](https://github.com/membraneframework/live_compositor/pull/597), [#598](https://github.com/membraneframework/live_compositor/pull/598), [#599](https://github.com/membraneframework/live_compositor/pull/599) by [@wkozyra95](https://github.com/wkozyra95))
- Add `LIVE_COMPOSITOR_INPUT_BUFFER_DURATION_MS` environment variable to control input stream buffer size. ([#600](https://github.com/membraneframework/live_compositor/pull/600) by [@wkozyra95](https://github.com/wkozyra95))
- Add endpoint for requesting keyframe on the output stream. ([#620](https://github.com/membraneframework/live_compositor/pull/620) by [@WojciechBarczynski](https://github.com/WojciechBarczynski))
- Support DeckLink cards as an input. ([#587](https://github.com/software-mansion/live-compositor/pull/587), [#597](https://github.com/software-mansion/live-compositor/pull/597), [#598](https://github.com/software-mansion/live-compositor/pull/598), [#599](https://github.com/software-mansion/live-compositor/pull/599) by [@wkozyra95](https://github.com/wkozyra95))
- Add `LIVE_COMPOSITOR_INPUT_BUFFER_DURATION_MS` environment variable to control input stream buffer size. ([#600](https://github.com/software-mansion/live-compositor/pull/600) by [@wkozyra95](https://github.com/wkozyra95))
- Add endpoint for requesting keyframe on the output stream. ([#620](https://github.com/software-mansion/live-compositor/pull/620) by [@WojciechBarczynski](https://github.com/WojciechBarczynski))

### 🐛 Bug fixes

- Fix input queueing when some of the inputs do not produce frames/samples . ([#625](https://github.com/membraneframework/live_compositor/pull/625) by [@wkozyra95](https://github.com/wkozyra95))
- Fix input queueing when some of the inputs do not produce frames/samples . ([#625](https://github.com/software-mansion/live-compositor/pull/625) by [@wkozyra95](https://github.com/wkozyra95))

## [v0.2.0](https://github.com/membraneframework/live_compositor/releases/tag/v0.2.0)
## [v0.2.0](https://github.com/software-mansion/live-compositor/releases/tag/v0.2.0)

Initial release
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ LiveCompositor supports Linux and macOS and can be used in 2 ways:

## Demos

https://github.com/membraneframework/live_compositor/assets/104033489/e6f5ba7c-ab05-4935-a42a-bc28c42fc895
https://github.com/software-mansion/live-compositor/assets/104033489/e6f5ba7c-ab05-4935-a42a-bc28c42fc895

This is just a sample of effects that you can achieve with LiveCompositor. It is a compilation of a few demo projects
written in TypeScript that you can find in [`demos`](./demos) directory.
Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

To release a new compositor version:

- Go to `Actions` -> [`package for release`](https://github.com/membraneframework/live_compositor/actions/workflows/package_for_release.yml) -> Trigger build on master using "Run workflow" drop-down menu.
- Go to `Actions` -> [`package for release`](https://github.com/software-mansion/live-compositor/actions/workflows/package_for_release.yml) -> Trigger build on master using "Run workflow" drop-down menu.
- Wait for a job to finish.
- Run `gh run list --workflow "package for release"` and find an ID of the workflow run that packaged release binaries. Running `./scripts/release.sh` without necessary environment variables will also display that list.
- Run
Expand Down
6 changes: 3 additions & 3 deletions demos/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/membraneframework/live_compositor.git"
"url": "git+https://github.com/software-mansion/live-compositor.git"
},
"author": "",
"license": "BUSL-1.1",
"bugs": {
"url": "https://github.com/membraneframework/live_compositor/issues"
"url": "https://github.com/software-mansion/live-compositor/issues"
},
"homepage": "https://github.com/membraneframework/live_compositor#readme",
"homepage": "https://github.com/software-mansion/live-compositor#readme",
"dependencies": {
"@types/fs-extra": "^11.0.2",
"@types/node": "^20.12.11",
Expand Down
8 changes: 4 additions & 4 deletions demos/utils/prepare_compositor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ export const COMPOSITOR_DIR = path.join(__dirname, '../.video_compositor');

const VERSION = 'v0.2.0-rc.5';

const COMPOSITOR_X86_64_LINUX_DOWNLOAD_URL = `https://github.com/membraneframework/live_compositor/releases/download/${VERSION}/video_compositor_linux_x86_64.tar.gz`;
const COMPOSITOR_ARM_LINUX_DOWNLOAD_URL = `https://github.com/membraneframework/live_compositor/releases/download/${VERSION}/video_compositor_linux_aarch64.tar.gz`;
const COMPOSITOR_X86_64_MAC_DOWNLOAD_URL = `https://github.com/membraneframework/live_compositor/releases/download/${VERSION}/video_compositor_darwin_x86_64.tar.gz`;
const COMPOSITOR_ARM_MAC_DOWNLOAD_URL = `https://github.com/membraneframework/live_compositor/releases/download/${VERSION}/video_compositor_darwin_aarch64.tar.gz`;
const COMPOSITOR_X86_64_LINUX_DOWNLOAD_URL = `https://github.com/software-mansion/live-compositor/releases/download/${VERSION}/video_compositor_linux_x86_64.tar.gz`;
const COMPOSITOR_ARM_LINUX_DOWNLOAD_URL = `https://github.com/software-mansion/live-compositor/releases/download/${VERSION}/video_compositor_linux_aarch64.tar.gz`;
const COMPOSITOR_X86_64_MAC_DOWNLOAD_URL = `https://github.com/software-mansion/live-compositor/releases/download/${VERSION}/video_compositor_darwin_x86_64.tar.gz`;
const COMPOSITOR_ARM_MAC_DOWNLOAD_URL = `https://github.com/software-mansion/live-compositor/releases/download/${VERSION}/video_compositor_darwin_aarch64.tar.gz`;

export async function ensureCompositorReadyAsync(): Promise<void> {
const versionFile = path.join(COMPOSITOR_DIR, '.version');
Expand Down
6 changes: 3 additions & 3 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ const config: Config = {

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'membraneframework', // Usually your GitHub org/user name.
projectName: 'live_compositor', // Usually your repo name.
organizationName: 'software-mansion', // Usually your GitHub org/user name.
projectName: 'live-compositor', // Usually your repo name.

onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',
Expand Down Expand Up @@ -101,7 +101,7 @@ const config: Config = {
'aria-label': 'Docs',
},
{
to: 'https://github.com/membraneframework/live_compositor',
to: 'https://github.com/software-mansion/live-compositor',
position: 'right',
className: 'navbar-github-link',
'aria-label': 'GitHub repository',
Expand Down
4 changes: 0 additions & 4 deletions docs/pages/concept/web.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ Furthermore, you can place other components on the website. We refer to this pro

Make sure you have a compositor version built with web renderer support. The web renderer introduces additional dependencies and significantly increases the size of the compositor binaries. To minimize that impact, we are supporting two versions of the compositor, one with web renderer support and one without it.

:::tip
You can view a working example [here](https://github.com/membraneframework/live_compositor/blob/master/examples/web_view.rs)
:::

## Embedding components

Embedding is a process of displaying child components on a website. You can define the child components in the `children` field of the web view.
Expand Down
12 changes: 6 additions & 6 deletions docs/pages/deployment/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ LiveCompositor can be deployed in various ways, depending on your platform, used

You can consider following options for LiveCompositor deployment:
- Using docker
- (recommended) Dockerfile with compositor without web rendering support [https://github.com/membraneframework/live_compositor/blob/master/build_tools/docker/slim.Dockerfile](https://github.com/membraneframework/live_compositor/blob/master/build_tools/docker/slim.Dockerfile)
- Dockerfile with compositor with web rendering support [https://github.com/membraneframework/live_compositor/blob/master/build_tools/docker/full.Dockerfile](https://github.com/membraneframework/live_compositor/blob/master/build_tools/docker/full.Dockerfile)
- (recommended) Dockerfile with compositor without web rendering support [https://github.com/software-mansion/live-compositor/blob/master/build_tools/docker/slim.Dockerfile](https://github.com/software-mansion/live-compositor/blob/master/build_tools/docker/slim.Dockerfile)
- Dockerfile with compositor with web rendering support [https://github.com/software-mansion/live-compositor/blob/master/build_tools/docker/full.Dockerfile](https://github.com/software-mansion/live-compositor/blob/master/build_tools/docker/full.Dockerfile)
- Standalone binaries
- Building [`github.com/membraneframework/live_compositor`](https://github.com/membraneframework/live_compositor) from source.
- Binaries from [GitHub releases](https://github.com/membraneframework/live_compositor/releases).
- Building [`github.com/software-mansion/live-compositor`](https://github.com/software-mansion/live-compositor) from source.
- Binaries from [GitHub releases](https://github.com/software-mansion/live-compositor/releases).
- As an element in a Membrane pipeline. [Learn more.](#membrane-framework-plugin)

## Requirements
Expand All @@ -25,8 +25,8 @@ environment variables. Full list of those variables can be found [here](./config
If you want to use a [`WebView`](../api/components/WebView.md) component in your scene definition you need to use binaries compiled
with web rendering support.
- When building from source you need to have `web_renderer` feature enabled (enabled by default).
- When using binaries from [GitHub releases](https://github.com/membraneframework/live_compositor/releases) use files with `_with_web_renderer_` in the name.
- When using Docker use [github.com/membraneframework/live_compositor/blob/master/build_tools/docker/full.Dockerfile](https://github.com/membraneframework/live_compositor/blob/master/build_tools/docker/full.Dockerfile)
- When using binaries from [GitHub releases](https://github.com/software-mansion/live-compositor/releases) use files with `_with_web_renderer_` in the name.
- When using Docker use [github.com/software-mansion/live-compositor/blob/master/build_tools/docker/full.Dockerfile](https://github.com/software-mansion/live-compositor/blob/master/build_tools/docker/full.Dockerfile)

:::warning
Keep in mind that using a browser for rendering might not be secure, especially if you use it to render untrusted websites
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/deployment/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Other platforms are not regularly tested, but compositor should also work on:

### Dockerfile

Dockerfile defines all software requirements. Configurations provided in [the compositor repo](https://github.com/membraneframework/live_compositor/tree/master/build_tools/docker)
Dockerfile defines all software requirements. Configurations provided in [the compositor repo](https://github.com/software-mansion/live-compositor/tree/master/build_tools/docker)
are written to work with both GPU and CPU based rendering. To use them in your own project, just copy
the Dockerfile and replace `COPY . /root/project` with an appropriate <nobr>`RUN git clone ...`</nobr> command.

Expand Down
8 changes: 4 additions & 4 deletions docs/pages/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ Live Compositor can be used standalone or as a part of a Membrane Framework mult
### Standalone

You can use LiveCompositor as a standalone multimedia server. The server can be started by:
- Building [`github.com/membraneframework/live_compositor`](https://github.com/membraneframework/live_compositor) from source.
- Using binaries from [GitHub releases](https://github.com/membraneframework/live_compositor/releases).
- Building [`github.com/software-mansion/live-compositor`](https://github.com/software-mansion/live-compositor) from source.
- Using binaries from [GitHub releases](https://github.com/software-mansion/live-compositor/releases).
- Using Docker
- (recommended) Dockerfile with compositor without web rendering support [https://github.com/membraneframework/live_compositor/blob/master/build_tools/docker/slim.Dockerfile](https://github.com/membraneframework/live_compositor/blob/master/build_tools/docker/slim.Dockerfile)
- Dockerfile with compositor with web rendering support [https://github.com/membraneframework/live_compositor/blob/master/build_tools/docker/full.Dockerfile](https://github.com/membraneframework/live_compositor/blob/master/build_tools/docker/full.Dockerfile)
- (recommended) Dockerfile with compositor without web rendering support [https://github.com/software-mansion/live-compositor/blob/master/build_tools/docker/slim.Dockerfile](https://github.com/software-mansion/live-compositor/blob/master/build_tools/docker/slim.Dockerfile)
- Dockerfile with compositor with web rendering support [https://github.com/software-mansion/live-compositor/blob/master/build_tools/docker/full.Dockerfile](https://github.com/software-mansion/live-compositor/blob/master/build_tools/docker/full.Dockerfile)

### Membrane Framework plugin

Expand Down
8 changes: 4 additions & 4 deletions docs/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ function HomepageHeader() {
'button button--secondary button--outline button--lg col col-6 margin--sm',
styles.hoverSecondary
)}
to="https://github.com/membraneframework/live_compositor">
to="https://github.com/software-mansion/live-compositor">
<IconContext.Provider value={{ style: { verticalAlign: 'middle' } }}>
<FaGithub style={{ marginRight: 5 }} />
View on GitHub
Expand Down Expand Up @@ -349,7 +349,7 @@ function StandaloneSever() {
styles.hoverSecondary,
styles.smallScreenFlexButton
)}
to="https://github.com/membraneframework/live_compositor/tree/master/build_tools/docker">
to="https://github.com/software-mansion/live-compositor/tree/master/build_tools/docker">
<IconContext.Provider value={{ style: { verticalAlign: 'middle' } }}>
<FaDocker style={{ marginRight: 5 }} />
Dockerfiles
Expand Down Expand Up @@ -445,7 +445,7 @@ function Licensing() {
<div className="card__body">
<p className={styles.grayText}>
LiveCompositor is licensed under{' '}
<Link to="https://github.com/membraneframework/live_compositor/blob/master/LICENSE">
<Link to="https://github.com/software-mansion/live-compositor/blob/master/LICENSE">
Business Source License 1.1
</Link>
</p>
Expand Down Expand Up @@ -505,7 +505,7 @@ function ContactUs() {
multiple multimedia projects, like Membrane Framework, Elixir WebRTC, FishJam, and
more. We also work on custom solutions for clients. Email us at{' '}
<Link to="mailto:[email protected]">[email protected]</Link> or contact us
via <Link to="https://membrane.stream/contact">this form</Link>.
via <Link to="https://swmansion.com/contact">this form</Link>.
</p>
</div>
</div>
Expand Down
Loading