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

Remotion 5.0 #3750

Draft
wants to merge 21 commits into
base: main
Choose a base branch
from
Draft
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
24 changes: 12 additions & 12 deletions .github/workflows/push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ jobs:
- name: Cache turbo build setup
uses: actions/cache/restore@v4
with:
path: .turbo
path: .turbo
key: |
${{ runner.os }}-turbo-
- uses: actions/setup-node@v4
with:
node-version: 16
node-version: 18
cache: "pnpm"
- uses: oven-sh/setup-bun@v1
with:
Expand Down Expand Up @@ -56,12 +56,12 @@ jobs:
- name: Cache turbo build setup
uses: actions/cache/restore@v4
with:
path: .turbo
path: .turbo
key: |
${{ runner.os }}-turbo-
- uses: actions/setup-node@v4
with:
node-version: 16
node-version: 18
cache: "pnpm"
- uses: oven-sh/setup-bun@v1
with:
Expand Down Expand Up @@ -102,12 +102,12 @@ jobs:
- name: Cache turbo build setup
uses: actions/cache/restore@v4
with:
path: .turbo
path: .turbo
key: |
${{ runner.os }}-turbo-
- uses: actions/setup-node@v4
with:
node-version: 16
node-version: 18
cache: "pnpm"
- uses: oven-sh/setup-bun@v1
with:
Expand All @@ -128,15 +128,15 @@ jobs:
matrix:
include:
- os: ubuntu-latest
node_version: 16
node_version: 18
- os: windows-latest
node_version: 16
node_version: 18
- os: macos-latest
node_version: 16
node_version: 18
- os: macos-14
node_version: 16
node_version: 18
- os: ubuntu-latest
node_version: 20.5
node_version: 22
steps:
- uses: actions/checkout@v4
- uses: actions/setup-go@v5
Expand All @@ -152,7 +152,7 @@ jobs:
cache: "pnpm"
- name: Cache turbo build setup
uses: actions/cache@v4
with:
with:
path: .turbo
key: ${{ runner.os }}-turbo-${{ github.sha }}
restore-keys: |
Expand Down
46 changes: 26 additions & 20 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,55 @@
# Remotion License

In Remotion 5.0, the license will slightly change. [View the changes here](https://github.com/remotion-dev/remotion/pull/3750).
Depending on the type of your legal entity, you are granted permission to use the Remotion Software ("Remotion" or "Software") for your project. Individuals and small companies are allowed to use the Software to create media assets (e.g., videos and images) for free (even commercially), while a Company License is required for for-profit organizations and groups of individuals of a certain size. This two-tier system was designed to ensure funding for this Software while still allowing the source code to be available and the program to be free for most. Read below for the exact license description.

---

Depending on the type of your legal entity, you are granted permission to use Remotion for your project. Individuals and small companies are allowed to use Remotion to create videos for free (even commercial), while a company license is required for for-profit organizations of a certain size. This two-tier system was designed to ensure funding for this project while still allowing the source code to be available and the program to be free for most. Read below for the exact terms of use.

- [Free license](#free-license)
- [Company license](#company-license)

## Free license
- [Free License](#free-license)
- [Company License](#company-license)

Copyright © 2024 [Remotion](https://www.remotion.dev)

## Free License

### Eligibility

You are eligible to use Remotion for free if you are:

- an individual
- a for-profit organization with up to 3 employees
- an individual using the Software for personal use
- an organization or team of individuals with up to 3 people
- a non-profit or not-for-profit organization
- evaluating whether Remotion is a good fit, and are not yet using it in a commercial way
- evaluating whether Remotion is a good fit, and you are not yet using it in a commercial way

### Allowed use cases

Permission is hereby granted, free of charge, to any person eligible for the "Free license", to use the software non-commercially or commercially for the purpose of creating videos and images and to modify the software to their own liking, for the purpose of fulfilling their custom use case or to contribute bug fixes or improvements back to Remotion.
Permission is hereby granted, free of charge, to any person eligible for the "Free License", to use Remotion non-commercially or commercially for the purpose of creating media assets (e.g. videos and images) and to modify the Software to their own liking, for the purpose of fulfilling their custom use case or to contribute bug fixes or improvements back to Remotion.

### Disallowed use cases

It is not allowed to copy or modify Remotion code for the purpose of selling, renting, licensing, relicensing, or sublicensing your own derivate of Remotion.
It is not allowed to copy or modify Remotion source-code for the purpose of selling, renting, licensing, relicensing, or sublicensing your own derivate of Remotion.

### Warranty notice

The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the author or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
The Software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of

- merchantability,
- fitness for a particular purpose, and
- non-infringement.

In no event shall the author or copyright holders be liable for any claims, damages or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection and use of Remotion.

### Support

Support is provided on a best-we-can-do basis via GitHub Issues and Discord.
Support is provided on a best-we-can-do basis via [GitHub Issues](https://github.com/remotion-dev/remotion/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) and [Discord](https://www.remotion.dev/discord).

## Company License

You are required to obtain a Company License to use Remotion if you are not within the group of entities eligible for a Free License. The Company License will enable you to use the Remotion Software for the allowed use cases specified in the Free License, and give you access to prioritized support ([Support Policy](https://www.remotion.dev/docs/support)).

## Company license
Visit [remotion.pro](https://www.remotion.pro/license) for pricing and to buy a Company License.

You are required to obtain a company license to use Remotion if you are not within the group of entities eligible for a free license. This license will enable you to use Remotion for the allowed use cases specified in the free license, and give you access to prioritized support (read the [Support Policy](https://www.remotion.dev/docs/support)).
### Terms and Conditions

Visit [remotion.pro](https://www.remotion.pro/license) for pricing and to buy a license.
Company License Users are required to accept the legally binding [Terms and Conditions](https://www.remotion.pro/terms) to use the Remotion Software.

### FAQs

Are you not sure whether you need a company license because of an edge case? Here are some [frequently asked questions](https://www.remotion.pro/faq).
Are you not sure whether you need a Company License because of an edge case? Here are [frequently asked questions](https://www.remotion.pro/faq).
2 changes: 1 addition & 1 deletion packages/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
"@remotion/skia": "workspace:*",
"react": "18.3.1",
"react-dom": "18.3.1",
"zod": "3.22.3"
"zod": "3.23.8"
},
"keywords": [
"remotion",
Expand Down
2 changes: 1 addition & 1 deletion packages/cloudrun/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"@remotion/renderer": "workspace:*",
"google-auth-library": "^8.7.0",
"remotion": "workspace:*",
"zod": "3.22.3"
"zod": "3.23.8"
},
"devDependencies": {
"@remotion/compositor-linux-x64-gnu": "workspace:*",
Expand Down
4 changes: 2 additions & 2 deletions packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@
"react-dom": ">=16.8.0"
},
"devDependencies": {
"@testing-library/react": "14.0.0",
"@testing-library/react": "15.0.7",
"@happy-dom/global-registrator": "14.5.1",
"happy-dom": "14.5.1",
"jsdom": "21.1.0",
"react": "18.3.1",
"react-dom": "18.3.1",
"vitest": "0.31.1",
"webpack": "5.94.0",
"zod": "3.22.3"
"zod": "3.23.8"
},
"keywords": [
"remotion",
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/test/render-hook.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ interface RenderHookOptions<Props> {
*
* @see https://testing-library.com/docs/react-testing-library/api/#wrapper
*/
wrapper?: React.JSXElementConstructor<{children: React.ReactElement}>;
wrapper?: React.JSXElementConstructor<{children: React.ReactNode}>;
}

export function renderHook<Result, Props>(
Expand Down
34 changes: 23 additions & 11 deletions packages/core/src/test/series.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ test('Basic series test', () => {
</WrapSequenceContext>,
);
expect(outerHTML).toBe(
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div>third 0</div></div>',
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div>third 0</div></div></div>',
);
});

Expand Down Expand Up @@ -106,7 +106,7 @@ test('Should support fragments', () => {
);

expect(outerHtml).not.toBe(
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div>second 1</div></div>',
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div>second 1</div></div></div>',
);
});
test('Should not allow foreign elements', () => {
Expand All @@ -133,7 +133,7 @@ test('Should allow layout prop', () => {
</WrapSequenceContext>,
);
expect(outerHTML).toBe(
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div>first 0</div></div>',
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div>first 0</div></div></div>',
);

const outerHTML2 = renderForFrame(
Expand All @@ -146,7 +146,9 @@ test('Should allow layout prop', () => {
</Series>
</WrapSequenceContext>,
);
expect(outerHTML2).toBe('<div>first 0</div>');
expect(outerHTML2).toBe(
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div>first 0</div></div>',
);
});
test('Should render nothing after the end', () => {
const outerHTML = renderForFrame(
Expand All @@ -159,7 +161,9 @@ test('Should render nothing after the end', () => {
</Series>
</WrapSequenceContext>,
);
expect(outerHTML).toBe('');
expect(outerHTML).toBe(
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"></div>',
);
});
test('Should throw if invalid or no duration provided', () => {
expect(() => {
Expand Down Expand Up @@ -205,7 +209,7 @@ test('Should allow whitespace', () => {
);

expect(outerHtml).toBe(
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div>second 1</div></div>',
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div>second 1</div></div></div>',
);
});
test('Handle empty Series.Sequence', () => {
Expand Down Expand Up @@ -238,7 +242,9 @@ test('Should allow negative overlap prop', () => {
</Series>
</WrapSequenceContext>,
);
expect(outerHTML).toBe('<div>first 4</div><div>second 0</div>');
expect(outerHTML).toBe(
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div>first 4</div><div>second 0</div></div>',
);
});

test('Should allow positive overlap prop', () => {
Expand All @@ -255,7 +261,9 @@ test('Should allow positive overlap prop', () => {
</Series>
</WrapSequenceContext>,
);
expect(outerHTML).toBe('');
expect(outerHTML).toBe(
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"></div>',
);
});

test('Should disallow NaN as offset prop', () => {
Expand Down Expand Up @@ -320,7 +328,9 @@ test('Should cascade negative offset props', () => {
</Series>
</WrapSequenceContext>,
);
expect(outerHTML).toBe('<div>third 0</div>');
expect(outerHTML).toBe(
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div>third 0</div></div>',
);
});

test('Should cascade positive offset props', () => {
Expand All @@ -340,7 +350,9 @@ test('Should cascade positive offset props', () => {
</Series>
</WrapSequenceContext>,
);
expect(outerHTML).toBe('<div>third 0</div>');
expect(outerHTML).toBe(
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div>third 0</div></div>',
);
});

test('Allow durationInFrames as Infinity for last Series.Sequence', () => {
Expand All @@ -361,7 +373,7 @@ test('Allow durationInFrames as Infinity for last Series.Sequence', () => {
</WrapSequenceContext>,
);
expect(outerHTML).toBe(
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div>third 0</div></div>',
'<div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div style="position:absolute;top:0;left:0;right:0;bottom:0;width:100%;height:100%;display:flex"><div>third 0</div></div></div>',
);
});

Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/v5-flag.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export const ENABLE_V5_BREAKING_CHANGES = false as const;
export const ENABLE_V5_BREAKING_CHANGES = true as const;
11 changes: 5 additions & 6 deletions packages/docs/docs/5-0-migration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
image: /generated/articles-docs-5-0-migration.png
id: 5-0-migration
title: v5.0 Migration
crumb: "Version Upgrade"
crumb: 'Version Upgrade'
---

:::note
Expand Down Expand Up @@ -48,7 +48,6 @@ A common footgun was the render was not working as intended because the input pr

**Required action**: Review the visualization of your audio. If unsatisfactory, revert to the old behavior by setting `optimizeFor: "accuracy"`.


## TransitionSeries does not support `layout="none"` anymore

Having a [TransitionSeries](/docs/transitions/transitionseries) with `layout="none"` is not supported anymore.
Expand All @@ -58,13 +57,13 @@ It never made sense to have this prop as transitioned elements need to be positi

## Zod should be upgraded to 3.23.8

Remotion previously used the types of Zod 3.22.3. With Remotion 5.0, the types of 3.23.8 are used.
Remotion previously used the types of Zod 3.22.3. With Remotion 5.0, the types of 3.23.8 are used.

**Required action**: If you use Zod, Upgrade Zod to 3.23.8.

## `measureSpring()` does not accept `from` and `to` options anymore

The values passed in there did not influence the calculation at all. Therefore we removed those options.
The values passed in there did not influence the calculation at all. Therefore we removed those options.

**Required action**: Remove the `from` and `to` options from your code.

Expand All @@ -82,9 +81,10 @@ Use `logLevel` instead.
## `diskSizeInMb` is now 10240 by default

For Remotion Lambda, the default disk size is now 10240 MB.
This will add a miniscule cost to your renders technically, but will lead to more reliable and faster renders, since Chrome is less likely to run out of disk cache.
This will add a miniscule cost to your renders technically, but will lead to more reliable and faster renders, since Chrome is less likely to run out of disk cache.

**Required actions**:

- If you want to keep the old behavior, set `diskSizeInMb: 2048`, explicitly.
- If your Lambda function name is hardcoded to include `disk2048mb`, unhardcode it and use `speculateFunctionName()` to get the correct name.

Expand All @@ -97,4 +97,3 @@ Besides wording changes, there are two effective changes in this license:
- Contractors also count towards team size. Previously, a company could only work with contractors and never have to get a company license.
- The company license is bound to our [terms and conditions](https://www.remotion.pro/terms) that will be introduced with Remotion 5.0.
Previously, our terms were generated by a Terms and conditions generator and did not make sense. We wrote the terms and conditions to properly define how we currently handle our licensing business and policies.

8 changes: 6 additions & 2 deletions packages/docs/docs/measure-spring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,20 @@ _optional_

The spring configuration that you pass to [spring()](/docs/spring#config).

### `from?`
### ~`from?`~

_optional - default: `0`_

Removed in `v5.0.0`. The value has no effect on the spring duration.

The initial value of the animation.

### `to?`
### ~`to?`~

_optional - default: `1`_

Removed in `v5.0.0`. The value has no effect on the spring duration.

The end value of the animation. Note that depending on the parameters, spring animations may overshoot the target a bit, before they bounce back to their final target.

## See also
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
"three": "0.158.0",
"uuid": "^8.3.2",
"vitest": "0.31.1",
"zod": "3.22.3"
"zod": "3.23.8"
},
"devDependencies": {
"@tsconfig/docusaurus": "^1.0.5",
Expand Down
Loading
Loading