Merge pull request #4353 from akhilender-bongirwar/feat/add-metadata-field

Author: JonnyBurger

packages/cli/src/benchmark.ts

@@ -50,6 +50,7 @@ const {
 	forSeamlessAacConcatenationOption,
 	publicPathOption,
 	publicDirOption,
+	metadataOption,
 } = BrowserSafeApis.options;
 
 const getValidConcurrency = (cliConcurrency: number | string | null) => {
@@ -382,6 +383,7 @@ export const benchmarkCommand = async (
 		},
 		true,
 	).value;
+	const metadata = metadataOption.getValue({commandLine: parsedCli}).value;
 
 	for (const composition of compositions) {
 		const {value: videoCodec, source: codecReason} = videoCodecOption.getValue(
@@ -490,6 +492,7 @@ export const benchmarkCommand = async (
 					compositionStart: 0,
 					onBrowserDownload,
 					onArtifact: () => undefined,
+					metadata,
 				},
 				(run, progress) => {
 					benchmarkProgress.update(

packages/cli/src/config/index.ts

@@ -68,6 +68,7 @@ import {
 	getKeyboardShortcutsEnabled,
 	setKeyboardShortcutsEnabled,
 } from './keyboard-shortcuts';
+import {getMetadata, setMetadata} from './metadata';
 import {setNumberOfSharedAudioTags} from './number-of-shared-audio-tags';
 import {getShouldOpenBrowser, setShouldOpenBrowser} from './open-browser';
 import {setOutputLocation} from './output-location';
@@ -502,6 +503,8 @@ type FlatConfig = RemotionConfigObject &
 		 * Set the amount of milliseconds after which the Player in the Studio will display a buffering UI after the Player has entered a buffer state.
 		 */
 		setBufferStateDelayInMilliseconds: (delay: number | null) => void;
+
+		setMetadata: (metadata: Record<string, string>) => void;
 		/**
 		 * @deprecated 'The config format has changed. Change `Config.Bundling.*()` calls to `Config.*()` in your config file.'
 		 */
@@ -598,6 +601,7 @@ export const Config: FlatConfig = {
 	setJpegQuality: jpegQualityOption.setConfig,
 	setStillImageFormat,
 	setVideoImageFormat,
+	setMetadata,
 	setEncodingMaxRate: encodingMaxRateOption.setConfig,
 	setEncodingBufferSize: encodingBufferSizeOption.setConfig,
 	setFrameRange,
@@ -664,6 +668,7 @@ export const ConfigInternals = {
 	getFfmpegOverrideFunction,
 	getHeight,
 	getWidth,
+	getMetadata,
 	getEntryPoint,
 	getWebpackPolling,
 	getShouldOpenBrowser,

packages/cli/src/config/metadata.ts

@@ -0,0 +1,9 @@
+let specifiedMetadata: Record<string, string>;
+
+export const setMetadata = (metadata: Record<string, string>): void => {
+	specifiedMetadata = metadata;
+};
+
+export const getMetadata = (): Record<string, string> => {
+	return specifiedMetadata;
+};

packages/cli/src/get-render-defaults.ts

@@ -106,6 +106,7 @@ export const getRenderDefaults = (): RenderDefaults => {
 	const disableWebSecurity = ConfigInternals.getChromiumDisableWebSecurity();
 	const ignoreCertificateErrors = ConfigInternals.getIgnoreCertificateErrors();
 	const userAgent = ConfigInternals.getChromiumUserAgent();
+	const metadata = ConfigInternals.getMetadata();
 
 	const maxConcurrency = RenderInternals.getMaxConcurrency();
 	const minConcurrency = RenderInternals.getMinConcurrency();
@@ -146,5 +147,6 @@ export const getRenderDefaults = (): RenderDefaults => {
 		numberOfGifLoops,
 		beepOnFinish,
 		forSeamlessAacConcatenation,
+		metadata,
 	};
 };

packages/cli/src/render-flows/render.ts

@@ -109,6 +109,7 @@ export const renderVideoFlow = async ({
 	forSeamlessAacConcatenation,
 	separateAudioTo,
 	publicPath,
+	metadata,
 }: {
 	remotionRoot: string;
 	fullEntryPoint: string;
@@ -162,6 +163,7 @@ export const renderVideoFlow = async ({
 	forSeamlessAacConcatenation: boolean;
 	separateAudioTo: string | null;
 	publicPath: string | null;
+	metadata: Record<string, string> | null;
 }) => {
 	const isVerbose = RenderInternals.isEqualOrBelowLogLevel(logLevel, 'verbose');
 
@@ -597,6 +599,7 @@ export const renderVideoFlow = async ({
 		compositionStart: 0,
 		onBrowserDownload,
 		onArtifact,
+		metadata: metadata ?? null,
 	});
 	if (!updatesDontOverwrite) {
 		updateRenderProgress({newline: true, printToConsole: true});

packages/cli/src/render-queue/process-video.ts

@@ -95,5 +95,6 @@ export const processVideoJob = async ({
 			job.type === 'video' ? job.forSeamlessAacConcatenation : false,
 		separateAudioTo: job.type === 'video' ? job.separateAudioTo : null,
 		publicPath: null,
+		metadata: job.metadata,
 	});
 };

packages/cli/src/render.tsx

@@ -37,6 +37,7 @@ const {
 	audioCodecOption,
 	publicPathOption,
 	publicDirOption,
+	metadataOption,
 } = BrowserSafeApis.options;
 
 export const render = async (
@@ -162,6 +163,7 @@ export const render = async (
 	const separateAudioTo = separateAudioOption.getValue({
 		commandLine: parsedCli,
 	}).value;
+	const metadata = metadataOption.getValue({commandLine: parsedCli}).value;
 	const publicPath = publicPathOption.getValue({commandLine: parsedCli}).value;
 
 	const chromiumOptions: ChromiumOptions = {
@@ -236,5 +238,6 @@ export const render = async (
 		forSeamlessAacConcatenation,
 		separateAudioTo,
 		publicPath,
+		metadata,
 	});
 };

packages/cloudrun/src/api/render-media-on-cloudrun.ts

@@ -58,6 +58,7 @@ type InternalRenderMediaOnCloudrun = {
 	indent: boolean;
 	logLevel: LogLevel;
 	downloadBehavior: DownloadBehavior;
+	metadata?: Record<string, string> | null;
 } & Partial<ToOptions<typeof BrowserSafeApis.optionsMap.renderMediaOnCloudRun>>;
 
 export type RenderMediaOnCloudrunInput = {
@@ -87,6 +88,7 @@ export type RenderMediaOnCloudrunInput = {
 	concurrency?: number | string | null;
 	preferLossless?: boolean;
 	downloadBehavior?: DownloadBehavior;
+	metadata?: Record<string, string> | null;
 } & Partial<ToOptions<typeof BrowserSafeApis.optionsMap.renderMediaOnCloudRun>>;
 
 const internalRenderMediaOnCloudrunRaw = async ({
@@ -129,6 +131,7 @@ const internalRenderMediaOnCloudrunRaw = async ({
 	offthreadVideoCacheSizeInBytes,
 	colorSpace,
 	downloadBehavior,
+	metadata,
 }: InternalRenderMediaOnCloudrun): Promise<
 	RenderMediaOnCloudrunOutput | CloudRunCrashResponse
 > => {
@@ -188,6 +191,7 @@ const internalRenderMediaOnCloudrunRaw = async ({
 		colorSpace: colorSpace ?? null,
 		clientVersion: VERSION,
 		downloadBehavior,
+		metadata: metadata ?? null,
 	};
 
 	const client = await getAuthClientForUrl(cloudRunEndpoint);
@@ -315,6 +319,7 @@ export const internalRenderMediaOnCloudrun = wrapWithErrorHandling(
  * @param params.concurrency A number or a string describing how many browser tabs should be opened. Default "50%".
  * @param params.enforceAudioTrack Render a silent audio track if there wouldn't be any otherwise.
  * @param params.preferLossless Uses a lossless audio codec, if one is available for the codec. If you set audioCodec, it takes priority over preferLossless.
+ * @param params.metadata Metadata to be attached to the output file.
  * @returns {Promise<RenderMediaOnCloudrunOutput>} See documentation for detailed structure
  */
 export const renderMediaOnCloudrun = ({
@@ -357,6 +362,7 @@ export const renderMediaOnCloudrun = ({
 	offthreadVideoCacheSizeInBytes,
 	colorSpace,
 	downloadBehavior,
+	metadata,
 }: RenderMediaOnCloudrunInput): Promise<
 	RenderMediaOnCloudrunOutput | CloudRunCrashResponse
 > => {
@@ -404,5 +410,6 @@ export const renderMediaOnCloudrun = ({
 		downloadBehavior: downloadBehavior ?? {
 			type: 'play-in-browser',
 		},
+		metadata: metadata ?? null,
 	});
 };

packages/cloudrun/src/api/render-still-on-cloudrun.ts

@@ -69,6 +69,7 @@ export type RenderStillOnCloudrunInput = Partial<OptionalParameters> &
  * @param params.forceHeight Overrides default composition height.
  * @param params.logLevel Level of logging that Cloud Run service should perform. Default "info".
  * @param params.delayRenderTimeoutInMilliseconds A number describing how long the render may take to resolve all delayRender() calls before it times out.
+ * @param params.metadata Metadata to be attached to the output file.
  * @returns {Promise<RenderStillOnCloudrunOutput>} See documentation for detailed structure
  */
 

packages/cloudrun/src/cli/commands/render/index.ts

@@ -34,6 +34,7 @@ const {
 	encodingBufferSizeOption,
 	delayRenderTimeoutInMillisecondsOption,
 	binariesDirectoryOption,
+	metadataOption,
 } = BrowserSafeApis.options;
 
 export const renderCommand = async (
@@ -276,6 +277,9 @@ ${downloadName ? `		Downloaded File = ${downloadName}` : ''}
 	const encodingBufferSize = encodingBufferSizeOption.getValue({
 		commandLine: CliInternals.parsedCli,
 	}).value;
+	const metadata = metadataOption.getValue({
+		commandLine: CliInternals.parsedCli,
+	}).value;
 
 	const res = await internalRenderMediaOnCloudrun({
 		cloudRunUrl,
@@ -320,6 +324,7 @@ ${downloadName ? `		Downloaded File = ${downloadName}` : ''}
 		colorSpace,
 		indent: false,
 		downloadBehavior: {type: 'play-in-browser'},
+		metadata,
 	});
 
 	if (res.type === 'crash') {