Allow to override ffmpeg path and options#41007

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.

Sign up for GitHub

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

Closed
Éloi Rivard (azmeuk) wants to merge 1 commit into from
Closed

Allow to override ffmpeg path and options #41007

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 36 additions & 0 deletions docs/src/api/params.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,10 @@ When set to `minimal`, only record information necessary for routing from HAR. T
- `duration` ?<[float]> How long each annotation is displayed in milliseconds. Defaults to `500`.
- `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the action title overlay. Defaults to `"top-right"`.
- `fontSize` ?<[int]> Font size of the action title in pixels. Defaults to `24`.
- `ffmpegExecutable` ?<[path]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
- `ffmpegOptions` ?<[string]> Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `fps` differs.
- `fps` ?<[int]> Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.
- `outputExtension` ?<[string]> Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make
sure to await [`method: BrowserContext.close`] for videos to be saved.
Expand All@@ -851,6 +855,34 @@ Dimensions of the recorded videos. If not specified the size will be equal to `v
scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.
Actual picture of each page will be scaled down if necessary to fit the specified size.

## context-option-recordvideo-ffmpegexecutable
* langs: csharp, java, python
- alias-python: record_video_ffmpeg_executable
- `recordVideoFfmpegExecutable` <[path]>

Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.

## context-option-recordvideo-ffmpegoptions
* langs: csharp, java, python
- alias-python: record_video_ffmpeg_options
- `recordVideoFfmpegOptions` <[string]>

Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `recordVideoSize`, and for setting `-r <fps>` before `-i pipe:0` to match `recordVideoFps` — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `recordVideoFps` differs.

## context-option-recordvideo-fps
* langs: csharp, java, python
- alias-python: record_video_fps
- `recordVideoFps` <[int]>

Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `recordVideoFfmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `recordVideoFfmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.

## context-option-recordvideo-outputextension
* langs: csharp, java, python
- alias-python: record_video_output_extension
- `recordVideoOutputExtension` <[string]>

Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

## context-option-proxy
- `proxy` <[Object]>
* alias: Proxy
Expand DownExpand Up@@ -1075,6 +1107,10 @@ between the same pixel in compared images, between zero (strict) and one (lax),
- %%-context-option-recordvideo-%%
- %%-context-option-recordvideo-dir-%%
- %%-context-option-recordvideo-size-%%
- %%-context-option-recordvideo-ffmpegexecutable-%%
- %%-context-option-recordvideo-ffmpegoptions-%%
- %%-context-option-recordvideo-fps-%%
- %%-context-option-recordvideo-outputextension-%%
- %%-context-option-strict-%%
- %%-context-option-service-worker-policy-%%

Expand Down
4 changes: 4 additions & 0 deletions docs/src/test-api/class-testoptions.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -648,6 +648,10 @@ export default defineConfig({
- `level` ?<[TestAnnotationLevel]<"file"|"test"|"step">> Level of the detail to include about the current test.
- `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the test information overlay. Defaults to `"top-left"`.
- `fontSize` ?<[int]> Font size of the test information in pixels. Defaults to `14`.
- `ffmpegExecutable` ?<[string]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright.
- `ffmpegOptions` ?<[string]> Full ffmpeg command line replacing Playwright's default encoder pipeline. See [`option: BrowserType.launchPersistentContext.recordVideo`] for the semantics.
- `fps` ?<[int]> Frame rate. Defaults to `25`.
- `outputExtension` ?<[string]> Output container extension without leading `.`. Defaults to `webm`.

Whether to record video for each test. Defaults to `'off'`.
* `'off'`: Do not record video.
Expand Down
140 changes: 140 additions & 0 deletions packages/playwright-client/types/types.d.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10499,6 +10499,34 @@ export interface Browser {
*/
fontSize?: number;
};

/**
* Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
* support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
*/
ffmpegExecutable?: string;

/**
* Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
* default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
* -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
* match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
* when `fps` differs.
*/
ffmpegOptions?: string;

/**
* Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
* `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
* yourself to match it. Defaults to `25`.
*/
fps?: number;

/**
* Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
* your ffmpeg binary to record in a different format.
*/
outputExtension?: string;
};

/**
Expand DownExpand Up@@ -15947,6 +15975,34 @@ export interface BrowserType<Unused = {}> {
*/
fontSize?: number;
};

/**
* Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
* support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
*/
ffmpegExecutable?: string;

/**
* Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
* default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
* -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
* match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
* when `fps` differs.
*/
ffmpegOptions?: string;

/**
* Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
* `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
* yourself to match it. Defaults to `25`.
*/
fps?: number;

/**
* Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
* your ffmpeg binary to record in a different format.
*/
outputExtension?: string;
};

/**
Expand DownExpand Up@@ -22518,6 +22574,34 @@ export interface Electron {
*/
fontSize?: number;
};

/**
* Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
* support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
*/
ffmpegExecutable?: string;

/**
* Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
* default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
* -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
* match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
* when `fps` differs.
*/
ffmpegOptions?: string;

/**
* Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
* `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
* yourself to match it. Defaults to `25`.
*/
fps?: number;

/**
* Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
* your ffmpeg binary to record in a different format.
*/
outputExtension?: string;
};

/**
Expand DownExpand Up@@ -23206,6 +23290,34 @@ export interface AndroidDevice {
*/
fontSize?: number;
};

/**
* Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
* support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
*/
ffmpegExecutable?: string;

/**
* Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
* default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
* -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
* match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
* when `fps` differs.
*/
ffmpegOptions?: string;

/**
* Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
* `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
* yourself to match it. Defaults to `25`.
*/
fps?: number;

/**
* Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
* your ffmpeg binary to record in a different format.
*/
outputExtension?: string;
};

/**
Expand DownExpand Up@@ -24386,6 +24498,34 @@ export interface BrowserContextOptions {
*/
fontSize?: number;
};

/**
* Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
* support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
*/
ffmpegExecutable?: string;

/**
* Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
* default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
* -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
* match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
* when `fps` differs.
*/
ffmpegOptions?: string;

/**
* Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
* `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
* yourself to match it. Defaults to `25`.
*/
fps?: number;

/**
* Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
* your ffmpeg binary to record in a different format.
*/
outputExtension?: string;
};

/**
Expand Down
10 changes: 7 additions & 3 deletions packages/playwright-core/src/client/browserContext.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -544,8 +544,13 @@ async function prepareStorageState(platform: Platform, storageState: string | Se
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
if (options.extraHTTPHeaders)
network.validateHeaders(options.extraHTTPHeaders);
const { recordVideo, ...rest } = options;
const recordVideoForWire = recordVideo ? {
...recordVideo,
dir: recordVideo.dir ? platform.path().resolve(recordVideo.dir) : recordVideo.dir,
} : undefined;
const contextParams: channels.BrowserNewContextParams = {
...options,
...rest,
viewport: options.viewport === null ? undefined : options.viewport,
noDefaultViewport: options.viewport === null,
extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
Expand All@@ -557,9 +562,8 @@ export async function prepareBrowserContextParams(platform: Platform, options: B
contrast: options.contrast === null ? 'no-override' : options.contrast,
acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
recordVideo: recordVideoForWire,
};
if (contextParams.recordVideo && contextParams.recordVideo.dir)
contextParams.recordVideo.dir = platform.path().resolve(contextParams.recordVideo.dir);
return contextParams;
}

Expand Down
20 changes: 20 additions & 0 deletions packages/playwright-core/src/protocol/validator.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,10 @@ scheme.AndroidDeviceLaunchBrowserParams = tObject({
fontSize: tOptional(tInt),
cursor: tOptional(tEnum(['none', 'pointer'])),
})),
ffmpegExecutable: tOptional(tString),
ffmpegOptions: tOptional(tString),
fps: tOptional(tInt),
outputExtension: tOptional(tString),
})),
strictSelectors: tOptional(tBoolean),
serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -494,6 +498,10 @@ scheme.BrowserNewContextParams = tObject({
fontSize: tOptional(tInt),
cursor: tOptional(tEnum(['none', 'pointer'])),
})),
ffmpegExecutable: tOptional(tString),
ffmpegOptions: tOptional(tString),
fps: tOptional(tInt),
outputExtension: tOptional(tString),
})),
strictSelectors: tOptional(tBoolean),
serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -571,6 +579,10 @@ scheme.BrowserNewContextForReuseParams = tObject({
fontSize: tOptional(tInt),
cursor: tOptional(tEnum(['none', 'pointer'])),
})),
ffmpegExecutable: tOptional(tString),
ffmpegOptions: tOptional(tString),
fps: tOptional(tInt),
outputExtension: tOptional(tString),
})),
strictSelectors: tOptional(tBoolean),
serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -670,6 +682,10 @@ scheme.BrowserContextInitializer = tObject({
fontSize: tOptional(tInt),
cursor: tOptional(tEnum(['none', 'pointer'])),
})),
ffmpegExecutable: tOptional(tString),
ffmpegOptions: tOptional(tString),
fps: tOptional(tInt),
outputExtension: tOptional(tString),
})),
strictSelectors: tOptional(tBoolean),
serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -1074,6 +1090,10 @@ scheme.BrowserTypeLaunchPersistentContextParams = tObject({
fontSize: tOptional(tInt),
cursor: tOptional(tEnum(['none', 'pointer'])),
})),
ffmpegExecutable: tOptional(tString),
ffmpegOptions: tOptional(tString),
fps: tOptional(tInt),
outputExtension: tOptional(tString),
})),
strictSelectors: tOptional(tBoolean),
serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand Down
10 changes: 9 additions & 1 deletion packages/playwright-core/src/server/dispatchers/browserDispatcher.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,8 +60,16 @@ export class BrowserDispatcher extends Dispatcher<Browser, channels.BrowserChann
}

async newContext(params: channels.BrowserNewContextParams, progress: Progress): Promise<channels.BrowserNewContextResult> {
if (params.recordVideo && this._object.attribution.playwright.options.isServer)
if (params.recordVideo && this._object.attribution.playwright.options.isServer) {
params.recordVideo.dir = undefined;
// Same rationale as `dir`: a remote client must not be able to inject
// arbitrary ffmpeg arguments — or pick an arbitrary executable — on the
// server (it would allow arbitrary file reads/writes and process
// invocation via filters / inputs / external binaries).
params.recordVideo.ffmpegExecutable = undefined;
params.recordVideo.ffmpegOptions = undefined;
params.recordVideo.outputExtension = undefined;
}

if (!this._options.isolateContexts) {
const context = await this._object.newContext(progress, params);
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Allow to override ffmpeg path and options#41007

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.

 Sign up for GitHub

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

 Closed

Éloi Rivard (azmeuk)
wants to merge
1
commit into

from

 Closed


Allow to override ffmpeg path and options
#41007
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


36 changes: 36 additions & 0 deletions
docs/src/api/params.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,10 @@ When set to `minimal`, only record information necessary for routing from HAR. T
 - `duration` ?<[float]> How long each annotation is displayed in milliseconds. Defaults to `500`.
 - `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the action title overlay. Defaults to `"top-right"`.
 - `fontSize` ?<[int]> Font size of the action title in pixels. Defaults to `24`.
 - `ffmpegExecutable` ?<[path]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 - `ffmpegOptions` ?<[string]> Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `fps` differs.
 - `fps` ?<[int]> Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.
 - `outputExtension` ?<[string]> Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make
sure to await [`method: BrowserContext.close`] for videos to be saved.
Expand All@@ -851,6 +855,34 @@ Dimensions of the recorded videos. If not specified the size will be equal to `v
scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.
Actual picture of each page will be scaled down if necessary to fit the specified size.

## context-option-recordvideo-ffmpegexecutable
* langs: csharp, java, python
 - alias-python: record_video_ffmpeg_executable
- `recordVideoFfmpegExecutable` <[path]>

Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.

## context-option-recordvideo-ffmpegoptions
* langs: csharp, java, python
 - alias-python: record_video_ffmpeg_options
- `recordVideoFfmpegOptions` <[string]>

Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `recordVideoSize`, and for setting `-r <fps>` before `-i pipe:0` to match `recordVideoFps` — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `recordVideoFps` differs.

## context-option-recordvideo-fps
* langs: csharp, java, python
 - alias-python: record_video_fps
- `recordVideoFps` <[int]>

Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `recordVideoFfmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `recordVideoFfmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.

## context-option-recordvideo-outputextension
* langs: csharp, java, python
 - alias-python: record_video_output_extension
- `recordVideoOutputExtension` <[string]>

Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

## context-option-proxy
- `proxy` <[Object]>
 * alias: Proxy
Expand DownExpand Up@@ -1075,6 +1107,10 @@ between the same pixel in compared images, between zero (strict) and one (lax),
- %%-context-option-recordvideo-%%
- %%-context-option-recordvideo-dir-%%
- %%-context-option-recordvideo-size-%%
- %%-context-option-recordvideo-ffmpegexecutable-%%
- %%-context-option-recordvideo-ffmpegoptions-%%
- %%-context-option-recordvideo-fps-%%
- %%-context-option-recordvideo-outputextension-%%
- %%-context-option-strict-%%
- %%-context-option-service-worker-policy-%%

Expand Down

4 changes: 4 additions & 0 deletions
docs/src/test-api/class-testoptions.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -648,6 +648,10 @@ export default defineConfig({
 - `level` ?<[TestAnnotationLevel]<"file"|"test"|"step">> Level of the detail to include about the current test.
 - `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the test information overlay. Defaults to `"top-left"`.
 - `fontSize` ?<[int]> Font size of the test information in pixels. Defaults to `14`.
 - `ffmpegExecutable` ?<[string]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright.
 - `ffmpegOptions` ?<[string]> Full ffmpeg command line replacing Playwright's default encoder pipeline. See [`option: BrowserType.launchPersistentContext.recordVideo`] for the semantics.
 - `fps` ?<[int]> Frame rate. Defaults to `25`.
 - `outputExtension` ?<[string]> Output container extension without leading `.`. Defaults to `webm`.

Whether to record video for each test. Defaults to `'off'`.
* `'off'`: Do not record video.
Expand Down

140 changes: 140 additions & 0 deletions
packages/playwright-client/types/types.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10499,6 +10499,34 @@ export interface Browser {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -15947,6 +15975,34 @@ export interface BrowserType<Unused = {}> {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -22518,6 +22574,34 @@ export interface Electron {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -23206,6 +23290,34 @@ export interface AndroidDevice {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -24386,6 +24498,34 @@ export interface BrowserContextOptions {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand Down

10 changes: 7 additions & 3 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -544,8 +544,13 @@ async function prepareStorageState(platform: Platform, storageState: string | Se
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
 if (options.extraHTTPHeaders)
 network.validateHeaders(options.extraHTTPHeaders);
 const { recordVideo, ...rest } = options;
 const recordVideoForWire = recordVideo ? {
 ...recordVideo,
 dir: recordVideo.dir ? platform.path().resolve(recordVideo.dir) : recordVideo.dir,
 } : undefined;
 const contextParams: channels.BrowserNewContextParams = {
 ...options,
 ...rest,
 viewport: options.viewport === null ? undefined : options.viewport,
 noDefaultViewport: options.viewport === null,
 extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
Expand All@@ -557,9 +562,8 @@ export async function prepareBrowserContextParams(platform: Platform, options: B
 contrast: options.contrast === null ? 'no-override' : options.contrast,
 acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
 clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
 recordVideo: recordVideoForWire,
 };
 if (contextParams.recordVideo && contextParams.recordVideo.dir)
 contextParams.recordVideo.dir = platform.path().resolve(contextParams.recordVideo.dir);
 return contextParams;
}

Expand Down

20 changes: 20 additions & 0 deletions
packages/playwright-core/src/protocol/validator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,10 @@ scheme.AndroidDeviceLaunchBrowserParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -494,6 +498,10 @@ scheme.BrowserNewContextParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -571,6 +579,10 @@ scheme.BrowserNewContextForReuseParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -670,6 +682,10 @@ scheme.BrowserContextInitializer = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -1074,6 +1090,10 @@ scheme.BrowserTypeLaunchPersistentContextParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand Down

10 changes: 9 additions & 1 deletion
packages/playwright-core/src/server/dispatchers/browserDispatcher.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,8 +60,16 @@ export class BrowserDispatcher extends Dispatcher<Browser, channels.BrowserChann
 }

 async newContext(params: channels.BrowserNewContextParams, progress: Progress): Promise<channels.BrowserNewContextResult> {
 if (params.recordVideo && this._object.attribution.playwright.options.isServer)
 if (params.recordVideo && this._object.attribution.playwright.options.isServer) {
 params.recordVideo.dir = undefined;
 // Same rationale as `dir`: a remote client must not be able to inject
 // arbitrary ffmpeg arguments — or pick an arbitrary executable — on the
 // server (it would allow arbitrary file reads/writes and process
 // invocation via filters / inputs / external binaries).
 params.recordVideo.ffmpegExecutable = undefined;
 params.recordVideo.ffmpegOptions = undefined;
 params.recordVideo.outputExtension = undefined;
 }

 if (!this._options.isolateContexts) {
 const context = await this._object.newContext(progress, params);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Allow to override ffmpeg path and options#41007

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.

 Sign up for GitHub

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

 Closed

Éloi Rivard (azmeuk)
wants to merge
1
commit into

from

 Closed


Allow to override ffmpeg path and options
#41007
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


36 changes: 36 additions & 0 deletions
docs/src/api/params.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,10 @@ When set to `minimal`, only record information necessary for routing from HAR. T
 - `duration` ?<[float]> How long each annotation is displayed in milliseconds. Defaults to `500`.
 - `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the action title overlay. Defaults to `"top-right"`.
 - `fontSize` ?<[int]> Font size of the action title in pixels. Defaults to `24`.
 - `ffmpegExecutable` ?<[path]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 - `ffmpegOptions` ?<[string]> Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `fps` differs.
 - `fps` ?<[int]> Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.
 - `outputExtension` ?<[string]> Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make
sure to await [`method: BrowserContext.close`] for videos to be saved.
Expand All@@ -851,6 +855,34 @@ Dimensions of the recorded videos. If not specified the size will be equal to `v
scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.
Actual picture of each page will be scaled down if necessary to fit the specified size.

## context-option-recordvideo-ffmpegexecutable
* langs: csharp, java, python
 - alias-python: record_video_ffmpeg_executable
- `recordVideoFfmpegExecutable` <[path]>

Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.

## context-option-recordvideo-ffmpegoptions
* langs: csharp, java, python
 - alias-python: record_video_ffmpeg_options
- `recordVideoFfmpegOptions` <[string]>

Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `recordVideoSize`, and for setting `-r <fps>` before `-i pipe:0` to match `recordVideoFps` — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `recordVideoFps` differs.

## context-option-recordvideo-fps
* langs: csharp, java, python
 - alias-python: record_video_fps
- `recordVideoFps` <[int]>

Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `recordVideoFfmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `recordVideoFfmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.

## context-option-recordvideo-outputextension
* langs: csharp, java, python
 - alias-python: record_video_output_extension
- `recordVideoOutputExtension` <[string]>

Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

## context-option-proxy
- `proxy` <[Object]>
 * alias: Proxy
Expand DownExpand Up@@ -1075,6 +1107,10 @@ between the same pixel in compared images, between zero (strict) and one (lax),
- %%-context-option-recordvideo-%%
- %%-context-option-recordvideo-dir-%%
- %%-context-option-recordvideo-size-%%
- %%-context-option-recordvideo-ffmpegexecutable-%%
- %%-context-option-recordvideo-ffmpegoptions-%%
- %%-context-option-recordvideo-fps-%%
- %%-context-option-recordvideo-outputextension-%%
- %%-context-option-strict-%%
- %%-context-option-service-worker-policy-%%

Expand Down

4 changes: 4 additions & 0 deletions
docs/src/test-api/class-testoptions.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -648,6 +648,10 @@ export default defineConfig({
 - `level` ?<[TestAnnotationLevel]<"file"|"test"|"step">> Level of the detail to include about the current test.
 - `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the test information overlay. Defaults to `"top-left"`.
 - `fontSize` ?<[int]> Font size of the test information in pixels. Defaults to `14`.
 - `ffmpegExecutable` ?<[string]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright.
 - `ffmpegOptions` ?<[string]> Full ffmpeg command line replacing Playwright's default encoder pipeline. See [`option: BrowserType.launchPersistentContext.recordVideo`] for the semantics.
 - `fps` ?<[int]> Frame rate. Defaults to `25`.
 - `outputExtension` ?<[string]> Output container extension without leading `.`. Defaults to `webm`.

Whether to record video for each test. Defaults to `'off'`.
* `'off'`: Do not record video.
Expand Down

140 changes: 140 additions & 0 deletions
packages/playwright-client/types/types.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10499,6 +10499,34 @@ export interface Browser {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -15947,6 +15975,34 @@ export interface BrowserType<Unused = {}> {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -22518,6 +22574,34 @@ export interface Electron {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -23206,6 +23290,34 @@ export interface AndroidDevice {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -24386,6 +24498,34 @@ export interface BrowserContextOptions {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand Down

10 changes: 7 additions & 3 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -544,8 +544,13 @@ async function prepareStorageState(platform: Platform, storageState: string | Se
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
 if (options.extraHTTPHeaders)
 network.validateHeaders(options.extraHTTPHeaders);
 const { recordVideo, ...rest } = options;
 const recordVideoForWire = recordVideo ? {
 ...recordVideo,
 dir: recordVideo.dir ? platform.path().resolve(recordVideo.dir) : recordVideo.dir,
 } : undefined;
 const contextParams: channels.BrowserNewContextParams = {
 ...options,
 ...rest,
 viewport: options.viewport === null ? undefined : options.viewport,
 noDefaultViewport: options.viewport === null,
 extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
Expand All@@ -557,9 +562,8 @@ export async function prepareBrowserContextParams(platform: Platform, options: B
 contrast: options.contrast === null ? 'no-override' : options.contrast,
 acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
 clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
 recordVideo: recordVideoForWire,
 };
 if (contextParams.recordVideo && contextParams.recordVideo.dir)
 contextParams.recordVideo.dir = platform.path().resolve(contextParams.recordVideo.dir);
 return contextParams;
}

Expand Down

20 changes: 20 additions & 0 deletions
packages/playwright-core/src/protocol/validator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,10 @@ scheme.AndroidDeviceLaunchBrowserParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -494,6 +498,10 @@ scheme.BrowserNewContextParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -571,6 +579,10 @@ scheme.BrowserNewContextForReuseParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -670,6 +682,10 @@ scheme.BrowserContextInitializer = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -1074,6 +1090,10 @@ scheme.BrowserTypeLaunchPersistentContextParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand Down

10 changes: 9 additions & 1 deletion
packages/playwright-core/src/server/dispatchers/browserDispatcher.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,8 +60,16 @@ export class BrowserDispatcher extends Dispatcher<Browser, channels.BrowserChann
 }

 async newContext(params: channels.BrowserNewContextParams, progress: Progress): Promise<channels.BrowserNewContextResult> {
 if (params.recordVideo && this._object.attribution.playwright.options.isServer)
 if (params.recordVideo && this._object.attribution.playwright.options.isServer) {
 params.recordVideo.dir = undefined;
 // Same rationale as `dir`: a remote client must not be able to inject
 // arbitrary ffmpeg arguments — or pick an arbitrary executable — on the
 // server (it would allow arbitrary file reads/writes and process
 // invocation via filters / inputs / external binaries).
 params.recordVideo.ffmpegExecutable = undefined;
 params.recordVideo.ffmpegOptions = undefined;
 params.recordVideo.outputExtension = undefined;
 }

 if (!this._options.isolateContexts) {
 const context = await this._object.newContext(progress, params);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Allow to override ffmpeg path and options#41007

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.

 Sign up for GitHub

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

 Closed

Éloi Rivard (azmeuk)
wants to merge
1
commit into

from

 Closed


Allow to override ffmpeg path and options
#41007
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


36 changes: 36 additions & 0 deletions
docs/src/api/params.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,10 @@ When set to `minimal`, only record information necessary for routing from HAR. T
 - `duration` ?<[float]> How long each annotation is displayed in milliseconds. Defaults to `500`.
 - `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the action title overlay. Defaults to `"top-right"`.
 - `fontSize` ?<[int]> Font size of the action title in pixels. Defaults to `24`.
 - `ffmpegExecutable` ?<[path]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 - `ffmpegOptions` ?<[string]> Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `fps` differs.
 - `fps` ?<[int]> Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.
 - `outputExtension` ?<[string]> Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make
sure to await [`method: BrowserContext.close`] for videos to be saved.
Expand All@@ -851,6 +855,34 @@ Dimensions of the recorded videos. If not specified the size will be equal to `v
scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.
Actual picture of each page will be scaled down if necessary to fit the specified size.

## context-option-recordvideo-ffmpegexecutable
* langs: csharp, java, python
 - alias-python: record_video_ffmpeg_executable
- `recordVideoFfmpegExecutable` <[path]>

Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.

## context-option-recordvideo-ffmpegoptions
* langs: csharp, java, python
 - alias-python: record_video_ffmpeg_options
- `recordVideoFfmpegOptions` <[string]>

Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `recordVideoSize`, and for setting `-r <fps>` before `-i pipe:0` to match `recordVideoFps` — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `recordVideoFps` differs.

## context-option-recordvideo-fps
* langs: csharp, java, python
 - alias-python: record_video_fps
- `recordVideoFps` <[int]>

Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `recordVideoFfmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `recordVideoFfmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.

## context-option-recordvideo-outputextension
* langs: csharp, java, python
 - alias-python: record_video_output_extension
- `recordVideoOutputExtension` <[string]>

Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

## context-option-proxy
- `proxy` <[Object]>
 * alias: Proxy
Expand DownExpand Up@@ -1075,6 +1107,10 @@ between the same pixel in compared images, between zero (strict) and one (lax),
- %%-context-option-recordvideo-%%
- %%-context-option-recordvideo-dir-%%
- %%-context-option-recordvideo-size-%%
- %%-context-option-recordvideo-ffmpegexecutable-%%
- %%-context-option-recordvideo-ffmpegoptions-%%
- %%-context-option-recordvideo-fps-%%
- %%-context-option-recordvideo-outputextension-%%
- %%-context-option-strict-%%
- %%-context-option-service-worker-policy-%%

Expand Down

4 changes: 4 additions & 0 deletions
docs/src/test-api/class-testoptions.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -648,6 +648,10 @@ export default defineConfig({
 - `level` ?<[TestAnnotationLevel]<"file"|"test"|"step">> Level of the detail to include about the current test.
 - `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the test information overlay. Defaults to `"top-left"`.
 - `fontSize` ?<[int]> Font size of the test information in pixels. Defaults to `14`.
 - `ffmpegExecutable` ?<[string]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright.
 - `ffmpegOptions` ?<[string]> Full ffmpeg command line replacing Playwright's default encoder pipeline. See [`option: BrowserType.launchPersistentContext.recordVideo`] for the semantics.
 - `fps` ?<[int]> Frame rate. Defaults to `25`.
 - `outputExtension` ?<[string]> Output container extension without leading `.`. Defaults to `webm`.

Whether to record video for each test. Defaults to `'off'`.
* `'off'`: Do not record video.
Expand Down

140 changes: 140 additions & 0 deletions
packages/playwright-client/types/types.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10499,6 +10499,34 @@ export interface Browser {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -15947,6 +15975,34 @@ export interface BrowserType<Unused = {}> {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -22518,6 +22574,34 @@ export interface Electron {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -23206,6 +23290,34 @@ export interface AndroidDevice {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -24386,6 +24498,34 @@ export interface BrowserContextOptions {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand Down

10 changes: 7 additions & 3 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -544,8 +544,13 @@ async function prepareStorageState(platform: Platform, storageState: string | Se
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
 if (options.extraHTTPHeaders)
 network.validateHeaders(options.extraHTTPHeaders);
 const { recordVideo, ...rest } = options;
 const recordVideoForWire = recordVideo ? {
 ...recordVideo,
 dir: recordVideo.dir ? platform.path().resolve(recordVideo.dir) : recordVideo.dir,
 } : undefined;
 const contextParams: channels.BrowserNewContextParams = {
 ...options,
 ...rest,
 viewport: options.viewport === null ? undefined : options.viewport,
 noDefaultViewport: options.viewport === null,
 extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
Expand All@@ -557,9 +562,8 @@ export async function prepareBrowserContextParams(platform: Platform, options: B
 contrast: options.contrast === null ? 'no-override' : options.contrast,
 acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
 clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
 recordVideo: recordVideoForWire,
 };
 if (contextParams.recordVideo && contextParams.recordVideo.dir)
 contextParams.recordVideo.dir = platform.path().resolve(contextParams.recordVideo.dir);
 return contextParams;
}

Expand Down

20 changes: 20 additions & 0 deletions
packages/playwright-core/src/protocol/validator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,10 @@ scheme.AndroidDeviceLaunchBrowserParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -494,6 +498,10 @@ scheme.BrowserNewContextParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -571,6 +579,10 @@ scheme.BrowserNewContextForReuseParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -670,6 +682,10 @@ scheme.BrowserContextInitializer = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -1074,6 +1090,10 @@ scheme.BrowserTypeLaunchPersistentContextParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand Down

10 changes: 9 additions & 1 deletion
packages/playwright-core/src/server/dispatchers/browserDispatcher.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,8 +60,16 @@ export class BrowserDispatcher extends Dispatcher<Browser, channels.BrowserChann
 }

 async newContext(params: channels.BrowserNewContextParams, progress: Progress): Promise<channels.BrowserNewContextResult> {
 if (params.recordVideo && this._object.attribution.playwright.options.isServer)
 if (params.recordVideo && this._object.attribution.playwright.options.isServer) {
 params.recordVideo.dir = undefined;
 // Same rationale as `dir`: a remote client must not be able to inject
 // arbitrary ffmpeg arguments — or pick an arbitrary executable — on the
 // server (it would allow arbitrary file reads/writes and process
 // invocation via filters / inputs / external binaries).
 params.recordVideo.ffmpegExecutable = undefined;
 params.recordVideo.ffmpegOptions = undefined;
 params.recordVideo.outputExtension = undefined;
 }

 if (!this._options.isolateContexts) {
 const context = await this._object.newContext(progress, params);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Allow to override ffmpeg path and options#41007

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.

 Sign up for GitHub

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

 Closed

Éloi Rivard (azmeuk)
wants to merge
1
commit into

from

 Closed


Allow to override ffmpeg path and options
#41007
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


36 changes: 36 additions & 0 deletions
docs/src/api/params.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,10 @@ When set to `minimal`, only record information necessary for routing from HAR. T
 - `duration` ?<[float]> How long each annotation is displayed in milliseconds. Defaults to `500`.
 - `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the action title overlay. Defaults to `"top-right"`.
 - `fontSize` ?<[int]> Font size of the action title in pixels. Defaults to `24`.
 - `ffmpegExecutable` ?<[path]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 - `ffmpegOptions` ?<[string]> Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `fps` differs.
 - `fps` ?<[int]> Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.
 - `outputExtension` ?<[string]> Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make
sure to await [`method: BrowserContext.close`] for videos to be saved.
Expand All@@ -851,6 +855,34 @@ Dimensions of the recorded videos. If not specified the size will be equal to `v
scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.
Actual picture of each page will be scaled down if necessary to fit the specified size.

## context-option-recordvideo-ffmpegexecutable
* langs: csharp, java, python
 - alias-python: record_video_ffmpeg_executable
- `recordVideoFfmpegExecutable` <[path]>

Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.

## context-option-recordvideo-ffmpegoptions
* langs: csharp, java, python
 - alias-python: record_video_ffmpeg_options
- `recordVideoFfmpegOptions` <[string]>

Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `recordVideoSize`, and for setting `-r <fps>` before `-i pipe:0` to match `recordVideoFps` — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `recordVideoFps` differs.

## context-option-recordvideo-fps
* langs: csharp, java, python
 - alias-python: record_video_fps
- `recordVideoFps` <[int]>

Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `recordVideoFfmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `recordVideoFfmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.

## context-option-recordvideo-outputextension
* langs: csharp, java, python
 - alias-python: record_video_output_extension
- `recordVideoOutputExtension` <[string]>

Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

## context-option-proxy
- `proxy` <[Object]>
 * alias: Proxy
Expand DownExpand Up@@ -1075,6 +1107,10 @@ between the same pixel in compared images, between zero (strict) and one (lax),
- %%-context-option-recordvideo-%%
- %%-context-option-recordvideo-dir-%%
- %%-context-option-recordvideo-size-%%
- %%-context-option-recordvideo-ffmpegexecutable-%%
- %%-context-option-recordvideo-ffmpegoptions-%%
- %%-context-option-recordvideo-fps-%%
- %%-context-option-recordvideo-outputextension-%%
- %%-context-option-strict-%%
- %%-context-option-service-worker-policy-%%

Expand Down

4 changes: 4 additions & 0 deletions
docs/src/test-api/class-testoptions.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -648,6 +648,10 @@ export default defineConfig({
 - `level` ?<[TestAnnotationLevel]<"file"|"test"|"step">> Level of the detail to include about the current test.
 - `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the test information overlay. Defaults to `"top-left"`.
 - `fontSize` ?<[int]> Font size of the test information in pixels. Defaults to `14`.
 - `ffmpegExecutable` ?<[string]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright.
 - `ffmpegOptions` ?<[string]> Full ffmpeg command line replacing Playwright's default encoder pipeline. See [`option: BrowserType.launchPersistentContext.recordVideo`] for the semantics.
 - `fps` ?<[int]> Frame rate. Defaults to `25`.
 - `outputExtension` ?<[string]> Output container extension without leading `.`. Defaults to `webm`.

Whether to record video for each test. Defaults to `'off'`.
* `'off'`: Do not record video.
Expand Down

140 changes: 140 additions & 0 deletions
packages/playwright-client/types/types.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10499,6 +10499,34 @@ export interface Browser {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -15947,6 +15975,34 @@ export interface BrowserType<Unused = {}> {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -22518,6 +22574,34 @@ export interface Electron {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -23206,6 +23290,34 @@ export interface AndroidDevice {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -24386,6 +24498,34 @@ export interface BrowserContextOptions {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand Down

10 changes: 7 additions & 3 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -544,8 +544,13 @@ async function prepareStorageState(platform: Platform, storageState: string | Se
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
 if (options.extraHTTPHeaders)
 network.validateHeaders(options.extraHTTPHeaders);
 const { recordVideo, ...rest } = options;
 const recordVideoForWire = recordVideo ? {
 ...recordVideo,
 dir: recordVideo.dir ? platform.path().resolve(recordVideo.dir) : recordVideo.dir,
 } : undefined;
 const contextParams: channels.BrowserNewContextParams = {
 ...options,
 ...rest,
 viewport: options.viewport === null ? undefined : options.viewport,
 noDefaultViewport: options.viewport === null,
 extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
Expand All@@ -557,9 +562,8 @@ export async function prepareBrowserContextParams(platform: Platform, options: B
 contrast: options.contrast === null ? 'no-override' : options.contrast,
 acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
 clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
 recordVideo: recordVideoForWire,
 };
 if (contextParams.recordVideo && contextParams.recordVideo.dir)
 contextParams.recordVideo.dir = platform.path().resolve(contextParams.recordVideo.dir);
 return contextParams;
}

Expand Down

20 changes: 20 additions & 0 deletions
packages/playwright-core/src/protocol/validator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,10 @@ scheme.AndroidDeviceLaunchBrowserParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -494,6 +498,10 @@ scheme.BrowserNewContextParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -571,6 +579,10 @@ scheme.BrowserNewContextForReuseParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -670,6 +682,10 @@ scheme.BrowserContextInitializer = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -1074,6 +1090,10 @@ scheme.BrowserTypeLaunchPersistentContextParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand Down

10 changes: 9 additions & 1 deletion
packages/playwright-core/src/server/dispatchers/browserDispatcher.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,8 +60,16 @@ export class BrowserDispatcher extends Dispatcher<Browser, channels.BrowserChann
 }

 async newContext(params: channels.BrowserNewContextParams, progress: Progress): Promise<channels.BrowserNewContextResult> {
 if (params.recordVideo && this._object.attribution.playwright.options.isServer)
 if (params.recordVideo && this._object.attribution.playwright.options.isServer) {
 params.recordVideo.dir = undefined;
 // Same rationale as `dir`: a remote client must not be able to inject
 // arbitrary ffmpeg arguments — or pick an arbitrary executable — on the
 // server (it would allow arbitrary file reads/writes and process
 // invocation via filters / inputs / external binaries).
 params.recordVideo.ffmpegExecutable = undefined;
 params.recordVideo.ffmpegOptions = undefined;
 params.recordVideo.outputExtension = undefined;
 }

 if (!this._options.isolateContexts) {
 const context = await this._object.newContext(progress, params);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Allow to override ffmpeg path and options#41007

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.

 Sign up for GitHub

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

 Closed

Éloi Rivard (azmeuk)
wants to merge
1
commit into

from

 Closed


Allow to override ffmpeg path and options
#41007
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


36 changes: 36 additions & 0 deletions
docs/src/api/params.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,10 @@ When set to `minimal`, only record information necessary for routing from HAR. T
 - `duration` ?<[float]> How long each annotation is displayed in milliseconds. Defaults to `500`.
 - `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the action title overlay. Defaults to `"top-right"`.
 - `fontSize` ?<[int]> Font size of the action title in pixels. Defaults to `24`.
 - `ffmpegExecutable` ?<[path]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 - `ffmpegOptions` ?<[string]> Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `fps` differs.
 - `fps` ?<[int]> Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.
 - `outputExtension` ?<[string]> Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make
sure to await [`method: BrowserContext.close`] for videos to be saved.
Expand All@@ -851,6 +855,34 @@ Dimensions of the recorded videos. If not specified the size will be equal to `v
scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.
Actual picture of each page will be scaled down if necessary to fit the specified size.

## context-option-recordvideo-ffmpegexecutable
* langs: csharp, java, python
 - alias-python: record_video_ffmpeg_executable
- `recordVideoFfmpegExecutable` <[path]>

Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.

## context-option-recordvideo-ffmpegoptions
* langs: csharp, java, python
 - alias-python: record_video_ffmpeg_options
- `recordVideoFfmpegOptions` <[string]>

Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `recordVideoSize`, and for setting `-r <fps>` before `-i pipe:0` to match `recordVideoFps` — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `recordVideoFps` differs.

## context-option-recordvideo-fps
* langs: csharp, java, python
 - alias-python: record_video_fps
- `recordVideoFps` <[int]>

Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `recordVideoFfmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `recordVideoFfmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.

## context-option-recordvideo-outputextension
* langs: csharp, java, python
 - alias-python: record_video_output_extension
- `recordVideoOutputExtension` <[string]>

Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

## context-option-proxy
- `proxy` <[Object]>
 * alias: Proxy
Expand DownExpand Up@@ -1075,6 +1107,10 @@ between the same pixel in compared images, between zero (strict) and one (lax),
- %%-context-option-recordvideo-%%
- %%-context-option-recordvideo-dir-%%
- %%-context-option-recordvideo-size-%%
- %%-context-option-recordvideo-ffmpegexecutable-%%
- %%-context-option-recordvideo-ffmpegoptions-%%
- %%-context-option-recordvideo-fps-%%
- %%-context-option-recordvideo-outputextension-%%
- %%-context-option-strict-%%
- %%-context-option-service-worker-policy-%%

Expand Down

4 changes: 4 additions & 0 deletions
docs/src/test-api/class-testoptions.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -648,6 +648,10 @@ export default defineConfig({
 - `level` ?<[TestAnnotationLevel]<"file"|"test"|"step">> Level of the detail to include about the current test.
 - `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the test information overlay. Defaults to `"top-left"`.
 - `fontSize` ?<[int]> Font size of the test information in pixels. Defaults to `14`.
 - `ffmpegExecutable` ?<[string]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright.
 - `ffmpegOptions` ?<[string]> Full ffmpeg command line replacing Playwright's default encoder pipeline. See [`option: BrowserType.launchPersistentContext.recordVideo`] for the semantics.
 - `fps` ?<[int]> Frame rate. Defaults to `25`.
 - `outputExtension` ?<[string]> Output container extension without leading `.`. Defaults to `webm`.

Whether to record video for each test. Defaults to `'off'`.
* `'off'`: Do not record video.
Expand Down

140 changes: 140 additions & 0 deletions
packages/playwright-client/types/types.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10499,6 +10499,34 @@ export interface Browser {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -15947,6 +15975,34 @@ export interface BrowserType<Unused = {}> {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -22518,6 +22574,34 @@ export interface Electron {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -23206,6 +23290,34 @@ export interface AndroidDevice {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -24386,6 +24498,34 @@ export interface BrowserContextOptions {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand Down

10 changes: 7 additions & 3 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -544,8 +544,13 @@ async function prepareStorageState(platform: Platform, storageState: string | Se
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
 if (options.extraHTTPHeaders)
 network.validateHeaders(options.extraHTTPHeaders);
 const { recordVideo, ...rest } = options;
 const recordVideoForWire = recordVideo ? {
 ...recordVideo,
 dir: recordVideo.dir ? platform.path().resolve(recordVideo.dir) : recordVideo.dir,
 } : undefined;
 const contextParams: channels.BrowserNewContextParams = {
 ...options,
 ...rest,
 viewport: options.viewport === null ? undefined : options.viewport,
 noDefaultViewport: options.viewport === null,
 extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
Expand All@@ -557,9 +562,8 @@ export async function prepareBrowserContextParams(platform: Platform, options: B
 contrast: options.contrast === null ? 'no-override' : options.contrast,
 acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
 clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
 recordVideo: recordVideoForWire,
 };
 if (contextParams.recordVideo && contextParams.recordVideo.dir)
 contextParams.recordVideo.dir = platform.path().resolve(contextParams.recordVideo.dir);
 return contextParams;
}

Expand Down

20 changes: 20 additions & 0 deletions
packages/playwright-core/src/protocol/validator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,10 @@ scheme.AndroidDeviceLaunchBrowserParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -494,6 +498,10 @@ scheme.BrowserNewContextParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -571,6 +579,10 @@ scheme.BrowserNewContextForReuseParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -670,6 +682,10 @@ scheme.BrowserContextInitializer = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -1074,6 +1090,10 @@ scheme.BrowserTypeLaunchPersistentContextParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand Down

10 changes: 9 additions & 1 deletion
packages/playwright-core/src/server/dispatchers/browserDispatcher.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,8 +60,16 @@ export class BrowserDispatcher extends Dispatcher<Browser, channels.BrowserChann
 }

 async newContext(params: channels.BrowserNewContextParams, progress: Progress): Promise<channels.BrowserNewContextResult> {
 if (params.recordVideo && this._object.attribution.playwright.options.isServer)
 if (params.recordVideo && this._object.attribution.playwright.options.isServer) {
 params.recordVideo.dir = undefined;
 // Same rationale as `dir`: a remote client must not be able to inject
 // arbitrary ffmpeg arguments — or pick an arbitrary executable — on the
 // server (it would allow arbitrary file reads/writes and process
 // invocation via filters / inputs / external binaries).
 params.recordVideo.ffmpegExecutable = undefined;
 params.recordVideo.ffmpegOptions = undefined;
 params.recordVideo.outputExtension = undefined;
 }

 if (!this._options.isolateContexts) {
 const context = await this._object.newContext(progress, params);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Allow to override ffmpeg path and options#41007

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.

 Sign up for GitHub

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

 Closed

Éloi Rivard (azmeuk)
wants to merge
1
commit into

from

 Closed


Allow to override ffmpeg path and options
#41007
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


36 changes: 36 additions & 0 deletions
docs/src/api/params.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,10 @@ When set to `minimal`, only record information necessary for routing from HAR. T
 - `duration` ?<[float]> How long each annotation is displayed in milliseconds. Defaults to `500`.
 - `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the action title overlay. Defaults to `"top-right"`.
 - `fontSize` ?<[int]> Font size of the action title in pixels. Defaults to `24`.
 - `ffmpegExecutable` ?<[path]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 - `ffmpegOptions` ?<[string]> Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `fps` differs.
 - `fps` ?<[int]> Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.
 - `outputExtension` ?<[string]> Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make
sure to await [`method: BrowserContext.close`] for videos to be saved.
Expand All@@ -851,6 +855,34 @@ Dimensions of the recorded videos. If not specified the size will be equal to `v
scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.
Actual picture of each page will be scaled down if necessary to fit the specified size.

## context-option-recordvideo-ffmpegexecutable
* langs: csharp, java, python
 - alias-python: record_video_ffmpeg_executable
- `recordVideoFfmpegExecutable` <[path]>

Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.

## context-option-recordvideo-ffmpegoptions
* langs: csharp, java, python
 - alias-python: record_video_ffmpeg_options
- `recordVideoFfmpegOptions` <[string]>

Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `recordVideoSize`, and for setting `-r <fps>` before `-i pipe:0` to match `recordVideoFps` — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `recordVideoFps` differs.

## context-option-recordvideo-fps
* langs: csharp, java, python
 - alias-python: record_video_fps
- `recordVideoFps` <[int]>

Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `recordVideoFfmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `recordVideoFfmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.

## context-option-recordvideo-outputextension
* langs: csharp, java, python
 - alias-python: record_video_output_extension
- `recordVideoOutputExtension` <[string]>

Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

## context-option-proxy
- `proxy` <[Object]>
 * alias: Proxy
Expand DownExpand Up@@ -1075,6 +1107,10 @@ between the same pixel in compared images, between zero (strict) and one (lax),
- %%-context-option-recordvideo-%%
- %%-context-option-recordvideo-dir-%%
- %%-context-option-recordvideo-size-%%
- %%-context-option-recordvideo-ffmpegexecutable-%%
- %%-context-option-recordvideo-ffmpegoptions-%%
- %%-context-option-recordvideo-fps-%%
- %%-context-option-recordvideo-outputextension-%%
- %%-context-option-strict-%%
- %%-context-option-service-worker-policy-%%

Expand Down

4 changes: 4 additions & 0 deletions
docs/src/test-api/class-testoptions.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -648,6 +648,10 @@ export default defineConfig({
 - `level` ?<[TestAnnotationLevel]<"file"|"test"|"step">> Level of the detail to include about the current test.
 - `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the test information overlay. Defaults to `"top-left"`.
 - `fontSize` ?<[int]> Font size of the test information in pixels. Defaults to `14`.
 - `ffmpegExecutable` ?<[string]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright.
 - `ffmpegOptions` ?<[string]> Full ffmpeg command line replacing Playwright's default encoder pipeline. See [`option: BrowserType.launchPersistentContext.recordVideo`] for the semantics.
 - `fps` ?<[int]> Frame rate. Defaults to `25`.
 - `outputExtension` ?<[string]> Output container extension without leading `.`. Defaults to `webm`.

Whether to record video for each test. Defaults to `'off'`.
* `'off'`: Do not record video.
Expand Down

140 changes: 140 additions & 0 deletions
packages/playwright-client/types/types.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10499,6 +10499,34 @@ export interface Browser {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -15947,6 +15975,34 @@ export interface BrowserType<Unused = {}> {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -22518,6 +22574,34 @@ export interface Electron {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -23206,6 +23290,34 @@ export interface AndroidDevice {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -24386,6 +24498,34 @@ export interface BrowserContextOptions {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand Down

10 changes: 7 additions & 3 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -544,8 +544,13 @@ async function prepareStorageState(platform: Platform, storageState: string | Se
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
 if (options.extraHTTPHeaders)
 network.validateHeaders(options.extraHTTPHeaders);
 const { recordVideo, ...rest } = options;
 const recordVideoForWire = recordVideo ? {
 ...recordVideo,
 dir: recordVideo.dir ? platform.path().resolve(recordVideo.dir) : recordVideo.dir,
 } : undefined;
 const contextParams: channels.BrowserNewContextParams = {
 ...options,
 ...rest,
 viewport: options.viewport === null ? undefined : options.viewport,
 noDefaultViewport: options.viewport === null,
 extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
Expand All@@ -557,9 +562,8 @@ export async function prepareBrowserContextParams(platform: Platform, options: B
 contrast: options.contrast === null ? 'no-override' : options.contrast,
 acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
 clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
 recordVideo: recordVideoForWire,
 };
 if (contextParams.recordVideo && contextParams.recordVideo.dir)
 contextParams.recordVideo.dir = platform.path().resolve(contextParams.recordVideo.dir);
 return contextParams;
}

Expand Down

20 changes: 20 additions & 0 deletions
packages/playwright-core/src/protocol/validator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,10 @@ scheme.AndroidDeviceLaunchBrowserParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -494,6 +498,10 @@ scheme.BrowserNewContextParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -571,6 +579,10 @@ scheme.BrowserNewContextForReuseParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -670,6 +682,10 @@ scheme.BrowserContextInitializer = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -1074,6 +1090,10 @@ scheme.BrowserTypeLaunchPersistentContextParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand Down

10 changes: 9 additions & 1 deletion
packages/playwright-core/src/server/dispatchers/browserDispatcher.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,8 +60,16 @@ export class BrowserDispatcher extends Dispatcher<Browser, channels.BrowserChann
 }

 async newContext(params: channels.BrowserNewContextParams, progress: Progress): Promise<channels.BrowserNewContextResult> {
 if (params.recordVideo && this._object.attribution.playwright.options.isServer)
 if (params.recordVideo && this._object.attribution.playwright.options.isServer) {
 params.recordVideo.dir = undefined;
 // Same rationale as `dir`: a remote client must not be able to inject
 // arbitrary ffmpeg arguments — or pick an arbitrary executable — on the
 // server (it would allow arbitrary file reads/writes and process
 // invocation via filters / inputs / external binaries).
 params.recordVideo.ffmpegExecutable = undefined;
 params.recordVideo.ffmpegOptions = undefined;
 params.recordVideo.outputExtension = undefined;
 }

 if (!this._options.isolateContexts) {
 const context = await this._object.newContext(progress, params);
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Allow to override ffmpeg path and options#41007

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.

 Sign up for GitHub

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

 Closed

Éloi Rivard (azmeuk)
wants to merge
1
commit into

from

 Closed


Allow to override ffmpeg path and options
#41007
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


36 changes: 36 additions & 0 deletions
docs/src/api/params.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -827,6 +827,10 @@ When set to `minimal`, only record information necessary for routing from HAR. T
 - `duration` ?<[float]> How long each annotation is displayed in milliseconds. Defaults to `500`.
 - `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the action title overlay. Defaults to `"top-right"`.
 - `fontSize` ?<[int]> Font size of the action title in pixels. Defaults to `24`.
 - `ffmpegExecutable` ?<[path]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 - `ffmpegOptions` ?<[string]> Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `fps` differs.
 - `fps` ?<[int]> Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.
 - `outputExtension` ?<[string]> Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

Enables video recording for all pages into `recordVideo.dir` directory. If not specified videos are not recorded. Make
sure to await [`method: BrowserContext.close`] for videos to be saved.
Expand All@@ -851,6 +855,34 @@ Dimensions of the recorded videos. If not specified the size will be equal to `v
scaled down to fit into 800x800. If `viewport` is not configured explicitly the video size defaults to 800x450.
Actual picture of each page will be scaled down if necessary to fit the specified size.

## context-option-recordvideo-ffmpegexecutable
* langs: csharp, java, python
 - alias-python: record_video_ffmpeg_executable
- `recordVideoFfmpegExecutable` <[path]>

Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8 support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.

## context-option-recordvideo-ffmpegoptions
* langs: csharp, java, python
 - alias-python: record_video_ffmpeg_options
- `recordVideoFfmpegOptions` <[string]>

Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg -i pipe:0`), for the `-vf` filter that resizes them to `recordVideoSize`, and for setting `-r <fps>` before `-i pipe:0` to match `recordVideoFps` — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed when `recordVideoFps` differs.

## context-option-recordvideo-fps
* langs: csharp, java, python
 - alias-python: record_video_fps
- `recordVideoFps` <[int]>

Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When `recordVideoFfmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `recordVideoFfmpegOptions`, set `-r <fps>` yourself to match it. Defaults to `25`.

## context-option-recordvideo-outputextension
* langs: csharp, java, python
 - alias-python: record_video_output_extension
- `recordVideoOutputExtension` <[string]>

Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by your ffmpeg binary to record in a different format.

## context-option-proxy
- `proxy` <[Object]>
 * alias: Proxy
Expand DownExpand Up@@ -1075,6 +1107,10 @@ between the same pixel in compared images, between zero (strict) and one (lax),
- %%-context-option-recordvideo-%%
- %%-context-option-recordvideo-dir-%%
- %%-context-option-recordvideo-size-%%
- %%-context-option-recordvideo-ffmpegexecutable-%%
- %%-context-option-recordvideo-ffmpegoptions-%%
- %%-context-option-recordvideo-fps-%%
- %%-context-option-recordvideo-outputextension-%%
- %%-context-option-strict-%%
- %%-context-option-service-worker-policy-%%

Expand Down

4 changes: 4 additions & 0 deletions
docs/src/test-api/class-testoptions.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -648,6 +648,10 @@ export default defineConfig({
 - `level` ?<[TestAnnotationLevel]<"file"|"test"|"step">> Level of the detail to include about the current test.
 - `position` ?<[AnnotatePosition]<"top-left"|"top"|"top-right"|"bottom-left"|"bottom"|"bottom-right">> Position of the test information overlay. Defaults to `"top-left"`.
 - `fontSize` ?<[int]> Font size of the test information in pixels. Defaults to `14`.
 - `ffmpegExecutable` ?<[string]> Path to a system ffmpeg binary to use instead of the one bundled with Playwright.
 - `ffmpegOptions` ?<[string]> Full ffmpeg command line replacing Playwright's default encoder pipeline. See [`option: BrowserType.launchPersistentContext.recordVideo`] for the semantics.
 - `fps` ?<[int]> Frame rate. Defaults to `25`.
 - `outputExtension` ?<[string]> Output container extension without leading `.`. Defaults to `webm`.

Whether to record video for each test. Defaults to `'off'`.
* `'off'`: Do not record video.
Expand Down

140 changes: 140 additions & 0 deletions
packages/playwright-client/types/types.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10499,6 +10499,34 @@ export interface Browser {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -15947,6 +15975,34 @@ export interface BrowserType<Unused = {}> {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -22518,6 +22574,34 @@ export interface Electron {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -23206,6 +23290,34 @@ export interface AndroidDevice {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand DownExpand Up@@ -24386,6 +24498,34 @@ export interface BrowserContextOptions {
 */
 fontSize?: number;
 };

 /**
 * Path to a system ffmpeg binary to use instead of the one bundled with Playwright. The bundled binary ships with VP8
 * support only — provide a system ffmpeg to enable VP9, H264, AV1 and other encoders.
 */
 ffmpegExecutable?: string;

 /**
 * Full ffmpeg command line (everything between the executable and the output file). When set, replaces Playwright's
 * default encoder pipeline entirely. You are responsible for reading raw frames from stdin (`-f image2pipe -c:v mjpeg
 * -i pipe:0`), for the `-vf` filter that resizes them to `size`, and for setting `-r <fps>` before `-i pipe:0` to
 * match the `fps` field — without it ffmpeg defaults image2pipe to 25 fps and your video will play at the wrong speed
 * when `fps` differs.
 */
 ffmpegOptions?: string;

 /**
 * Frame rate used by the internal frame-repetition algorithm that fills gaps between browser screencast events. When
 * `ffmpegOptions` is not set, it is also passed to ffmpeg as `-r`. When you provide `ffmpegOptions`, set `-r <fps>`
 * yourself to match it. Defaults to `25`.
 */
 fps?: number;

 /**
 * Extension of the output file, without leading `.`. Defaults to `webm`. Use `mp4` or another container supported by
 * your ffmpeg binary to record in a different format.
 */
 outputExtension?: string;
 };

 /**
Expand Down

10 changes: 7 additions & 3 deletions
packages/playwright-core/src/client/browserContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -544,8 +544,13 @@ async function prepareStorageState(platform: Platform, storageState: string | Se
export async function prepareBrowserContextParams(platform: Platform, options: BrowserContextOptions): Promise<channels.BrowserNewContextParams> {
 if (options.extraHTTPHeaders)
 network.validateHeaders(options.extraHTTPHeaders);
 const { recordVideo, ...rest } = options;
 const recordVideoForWire = recordVideo ? {
 ...recordVideo,
 dir: recordVideo.dir ? platform.path().resolve(recordVideo.dir) : recordVideo.dir,
 } : undefined;
 const contextParams: channels.BrowserNewContextParams = {
 ...options,
 ...rest,
 viewport: options.viewport === null ? undefined : options.viewport,
 noDefaultViewport: options.viewport === null,
 extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined,
Expand All@@ -557,9 +562,8 @@ export async function prepareBrowserContextParams(platform: Platform, options: B
 contrast: options.contrast === null ? 'no-override' : options.contrast,
 acceptDownloads: toAcceptDownloadsProtocol(options.acceptDownloads),
 clientCertificates: await toClientCertificatesProtocol(platform, options.clientCertificates),
 recordVideo: recordVideoForWire,
 };
 if (contextParams.recordVideo && contextParams.recordVideo.dir)
 contextParams.recordVideo.dir = platform.path().resolve(contextParams.recordVideo.dir);
 return contextParams;
}

Expand Down

20 changes: 20 additions & 0 deletions
packages/playwright-core/src/protocol/validator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,10 @@ scheme.AndroidDeviceLaunchBrowserParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -494,6 +498,10 @@ scheme.BrowserNewContextParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -571,6 +579,10 @@ scheme.BrowserNewContextForReuseParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -670,6 +682,10 @@ scheme.BrowserContextInitializer = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand DownExpand Up@@ -1074,6 +1090,10 @@ scheme.BrowserTypeLaunchPersistentContextParams = tObject({
 fontSize: tOptional(tInt),
 cursor: tOptional(tEnum(['none', 'pointer'])),
 })),
 ffmpegExecutable: tOptional(tString),
 ffmpegOptions: tOptional(tString),
 fps: tOptional(tInt),
 outputExtension: tOptional(tString),
 })),
 strictSelectors: tOptional(tBoolean),
 serviceWorkers: tOptional(tEnum(['allow', 'block'])),
Expand Down

10 changes: 9 additions & 1 deletion
packages/playwright-core/src/server/dispatchers/browserDispatcher.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,8 +60,16 @@ export class BrowserDispatcher extends Dispatcher<Browser, channels.BrowserChann
 }

 async newContext(params: channels.BrowserNewContextParams, progress: Progress): Promise<channels.BrowserNewContextResult> {
 if (params.recordVideo && this._object.attribution.playwright.options.isServer)
 if (params.recordVideo && this._object.attribution.playwright.options.isServer) {
 params.recordVideo.dir = undefined;
 // Same rationale as `dir`: a remote client must not be able to inject
 // arbitrary ffmpeg arguments — or pick an arbitrary executable — on the
 // server (it would allow arbitrary file reads/writes and process
 // invocation via filters / inputs / external binaries).
 params.recordVideo.ffmpegExecutable = undefined;
 params.recordVideo.ffmpegOptions = undefined;
 params.recordVideo.outputExtension = undefined;
 }

 if (!this._options.isolateContexts) {
 const context = await this._object.newContext(progress, params);
Expand Down
Loading
Loading